GSoC Idea: Newman Request

I am Raghav Bhatia, undergrad student from BITS Pilani. I want to apply for GSOC 2021 with Postman. I saw Idea list and one of the ideas is to create newman request .

Goal is Replacing curl with newman request in a curl command should run the send the request using Newman.

I have carried out a proof of concept to create newman request according to following expected output:

  1. Users can send a single request with Newman and show the request/response using a reporter of their choice.
  2. Replacing curl with newman request in a curl command should run the send the request using Newman.

This is the link to my PR: (Newman Command for Single Request by raghavbhatia336 · Pull Request #2657 · postmanlabs/newman · GitHub )

Github Issue : #2548

While researching about the topic, I feel one of the best solutions would be to get all curl options from the command and and create a Postman collection through curl-to-postmanv2.

Here is how i plan to implement it:

  1. Add a new command newman request
  2. Newman request will invoke a newman.request() function with curl options and newman run options. (To be done)
  3. It will pass curl to curl-to-postmanv2 convert function, and create a Postman collection with single item (To be moved to configLoaders )
  4. Use created postman collection and newman options to run the request using postman-runtime

Let me know if this approach looks good to you @Sharath_Iyengar, @hannah.neil @lukasz.gornicki. Also, can you please connect me with the GSoC mentor for this project since I am already long way through the POC and I have got a thumbs up from Shamasis Bhattacharya for the same. I would like to discuss my ideas with the GSoC mentor and get them reviewed.

My email ID: raghavbhatia05@gmail.com

3 Likes

@research-astronomer Thank you so much for writing in.

I have notified the mentors and they will look into this asap and respond shortly.

Do keep an eye on the PR request too

Cheers

Sure, thank you. I have updated the PR as well, after making some commits.

@Sharath_Iyengar should I share the doc here as well? I have attached it in the email I sent, to the GSoC team. All the information is available in the PR as well.

@research-astronomer as mentioned in the guideline please stick to sharing your project ideas via google documents whereas your community contributions can be by solving existing issues.

Please don’t mix both of these, although we would love to see a brief implementation or effort towards the project idea, considering that to be community contribution would not be the right approach.

Please share the doc link with gsoc@postman.com with editor access.

Cheers,

Hi @Sharath_Iyengar,
I started working on this PR before I joined the GSoC community forum. That is why I was unaware of the guidelines. After reading the guidelines, I will be using PR comments only to give details about new commits and updates that I make to that PR. :slight_smile:

I agree with you that I have put more effort towards the project idea and its implementation and it isn’t good to mix it with the community contribution component that in my opinion, is a separate thing. That is why I am also working on other existing issues and will raise PR for them, when ready, and I will update the document.

Having said that, it would be really helpful if I can get early feedback about my direction and ideas, as I am already long way through the POC. It would be great if you can introduce me to my mentor and I am looking forward to work with him/her. As you suggested, here is my draft proposal: https://docs.google.com/document/d/1E_qRZpcl6TcrTjs8YujHxXJKsCLbuBqjz2h7go0X5Kg/edit

I have included my project summary which can be reviewed by the mentor. I have also given editor access to gsoc@postman.com.

1 Like

Thank you so much for expressing your views so clearly. Appreciate it :slight_smile:

The document has been received and will be circulated with the mentors shortly. For now tagging the mentors @utkarsh.maheshwari @pranav-singhal @raghav.garg

Please do rename it as per the convention shared here – GSoC 2021 Guidelines - #7 by Sharath_Iyengar

Cheers and best of luck

1 Like

@Sharath_Iyengar Hi,
I am yet to hear from a GSoC mentor.
@utkarsh.maheshwari, @pranav-singhal, @raghav.garg @udit.vasu , would be really helpful if someone could review the project summary on high level, so that I can know I am in the right direction and can complete my proposal for submission.
Doc:
https://docs.google.com/document/d/1E_qRZpcl6TcrTjs8YujHxXJKsCLbuBqjz2h7go0X5Kg/edit 11

Thank you so much for the followup. The mentors will definitely look into this.

Request your patience.

Cheers

@research-astronomer Thanks for submitting a good proposal! I’ve left a few comments. Let me know when you’re ready for a second round of review. :slight_smile:

1 Like

@utkarsh.maheshwari Thanks for your valuable feedback! As per your suggestions in the comment, I have added some details in the ‘Description of Work’ topic of the proposal. The doc is ready for a second round of review. Please let me know if the description of work is complete or is there something more to be added or modified. :slight_smile:
Doc link: https://docs.google.com/document/d/1E_qRZpcl6TcrTjs8YujHxXJKsCLbuBqjz2h7go0X5Kg/edit

@utkarsh.maheshwari @pranav-singhal @raghav.garg I have further updated the schedule/timeline for the project in the doc, along with the detailed description of project. Kindly check it and please suggest any modifications, if any.
Doc link: https://docs.google.com/document/d/1E_qRZpcl6TcrTjs8YujHxXJKsCLbuBqjz2h7go0X5Kg/edit

@research-astronomer The proposal looks good. Added a few comments. :slight_smile:

@utkarsh.maheshwari Thanks a lot for your valuable feedback. I have thoroughly gone through your comments and replied to them, and made some updates in the proposal. Kindly check and let me know what you think. Will make the necessary updates/modifications as per your further suggestions. :slight_smile:
Doc: https://docs.google.com/document/d/1E_qRZpcl6TcrTjs8YujHxXJKsCLbuBqjz2h7go0X5Kg/edit

Hello @Sharath_Iyengar ,
I want to implement the idea of Newman Request feature, it seems convincing to me:
I will be able to provide all the three expected outcomes for this feature, a detailed description of how I will implement is is given in the proposal I have mailed to gsoc@postman.com and have given editor access.

Please have a look at the proposal, I will be highly greatful to you.
Here is the draft proposal:
https://docs.google.com/document/d/1n-V_Hvwn9rwgbNGdgzgfIWsxQQyh4QE0dI3Gnz-lHFs/edit?usp=sharing

@utkarsh.maheshwari @Sharath_Iyengar @raghav.garg @pranav-singhal @udit.vasu ,
I have updated my proposal as your suggestions. Today is the last day of application. Kindly please have a final look then I would apply tonight. :slight_smile:
Doc: https://docs.google.com/document/d/1E_qRZpcl6TcrTjs8YujHxXJKsCLbuBqjz2h7go0X5Kg/edit

Thank you so much for writing in. The mentors have been added to the document and notified.

Cheers

The mentors have been requested for a followup review but as the deadline is close by and we have a ton of requests coming in, cannot guarantee a review and in the timeframe you would expect but we will try our very best

Thank you for understanding

1 Like

@utkarsh.maheshwari @pranav-singhal @raghav.garg @Sharath_Iyengar @udit.vasu
Thank you for your feedback in the last few days. It was great to discuss ideas with each other. It really helped me improve my proposal. I have submitted the final proposal on the GSoC website. Looking forward to working on this project under your mentorship. I will use this community post thread to further update if there is any progress in this project and if there are more ideas. :smiley:

2 Likes

@utkarsh.maheshwari @Sharath_Iyengar hope you’re safe and doing well. :slight_smile:
As a part of my proposal, I request you to include my new community contribution as well.
Issue: [Feature Request] Include more request information under the `--verbose` flag · Issue #2725 · postmanlabs/newman · GitHub
My PR: Add request and response header in verbose by raghavbhatia336 · Pull Request #2730 · postmanlabs/newman · GitHub