This repository was archived by the owner on Nov 19, 2024. It is now read-only.

magento/devdocs#: Layout instructions. Adding more information about cURL [GITBUG] #6823

Merged

dobooth merged 7 commits into magento:master from DenisSaltanahmedov:improvement-cURL-topics

Apr 14, 2020

Contributor

DenisSaltanahmedov commented Mar 10, 2020 •

edited by dobooth

Loading

Purpose of this pull request

This pull request (PR) adding more information about using cURL in the Magento in the "Use cURL to run the request".
I think the topic should contain the examples, It will be helpful for developers.

Affected DevDocs pages

https://devdocs.magento.com/guides/v2.3/get-started/gs-curl.html

Links to Magento source code

https://github.com/magento/devdocs/blob/master/src/guides/v2.3/get-started/gs-curl.md

whatsnew
Added the 'Using cUrl in Magento' section to the Use cURL to run the request topic.


          magento/devdocs#: Layout instructions. Adding more information about …

6eea044

…using cURL

magento-engcom-team added Partner: Atwix partners-contribution labels

Collaborator

devops-devdocs commented Mar 10, 2020

An admin must run tests on this PR before it can be merged.

rogyar self-assigned this

m2-community-project bot added the Progress: review label

rogyar suggested changes

View reviewed changes

Contributor

rogyar left a comment

Hi @DenisSaltanahmedov. Thanks a lot for the great examples. Please, check some minor recommendations below

src/guides/v2.3/get-started/gs-curl.md Outdated

@@ @@ -28,6 +28,119 @@ Option | Description @@
               `-T` | Transfers the specified local file to the remote URL.
               `-X` | Specifies the request method to use when communicating with the HTTP server. The specified request method is used instead of the default GET method.
+              ### Using cUrl in Magento
+              Magento provides native functionality for cURL instead of using default php cURL. The class ``Magento\Framework\HTTP\Client\Curl`` can be used to work with HTTP protocol using curl library.

Contributor

rogyar Mar 10, 2020

I wouldn't say it's "native functionality". Rather than that, let's mention that

Magento provides its own service-wrapper for using cURL.

src/guides/v2.3/get-started/gs-curl.md Outdated

@@ @@ -28,6 +28,119 @@ Option | Description @@
               `-T` | Transfers the specified local file to the remote URL.
               `-X` | Specifies the request method to use when communicating with the HTTP server. The specified request method is used instead of the default GET method.
+              ### Using cUrl in Magento
+              Magento provides native functionality for cURL instead of using default php cURL. The class ``Magento\Framework\HTTP\Client\Curl`` can be used to work with HTTP protocol using curl library.

Contributor

rogyar Mar 10, 2020

Suggested change

      
            Magento provides native functionality for cURL instead of using default php cURL. The class ``Magento\Framework\HTTP\Client\Curl`` can be used to work with HTTP protocol using curl library.
          
            Magento provides native functionality for cURL instead of using default php cURL. The class ``Magento\Framework\HTTP\Client\Curl`` can be used to work with HTTP protocol using cURL library.

src/guides/v2.3/get-started/gs-curl.md Outdated

+              public function __construct(
+                 Magento\Framework\HTTP\Client\Curl $curl
+              ) {
+                 $this->_curl = $curl;

Contributor

rogyar Mar 10, 2020

Please, remove the underscore from the property name, so we have $this->curl. PSR-2 is really strict about that:

Property names SHOULD NOT be prefixed with a single underscore to indicate protected or private visibility.

Contributor

rogyar Mar 10, 2020

This recommendation also applies to all other examples

src/guides/v2.3/get-started/gs-curl.md Outdated

+              $result = $this->_curl->getBody();
+              ```
+              Where the ``$url`` is the endpoint url, ``$params`` an array, the extra parameters can be added in the url.

Contributor

rogyar Mar 10, 2020

We may extend the $params argument description. Instead of saying that it's just an "array" I would say that it's an array of data that is being sent via the POST request.

src/guides/v2.3/get-started/gs-curl.md Outdated


		#### Set curl header using setHeaders method

		The ``setHeaders`` method accepts a parameter as an array.

Contributor

rogyar Mar 10, 2020

Please, reverse the statements here:

Suggested change

      
            The ``setHeaders`` method accepts a parameter as an array.
          
            The ``setHeaders`` method accepts an array as a parameter.

src/guides/v2.3/get-started/gs-curl.md Outdated


		It is equivalent to setting CURLOPT_HTTPHEADER value

		```text

Contributor

rogyar Mar 10, 2020

Suggested change

      
            ```text
          
            ```php

src/guides/v2.3/get-started/gs-curl.md Outdated

+              It is equivalent to setting CURLOPT_HTTPHEADER value
+              ```text
+              “Authorization : “. “Basic “.base64_encode($userName.”:”.$password)

Contributor

rogyar Mar 10, 2020

Suggested change

      
            “Authorization : “. “Basic “.base64_encode($userName.”:”.$password)
          
            "Authorization : " . "Basic " . base64_encode($userName . ":" . $password)

src/guides/v2.3/get-started/gs-curl.md Outdated


		#### Set curl option using setOption method

		The ``setOption`` method accepts two parameters. The curl option name and the curl option value.

Contributor

rogyar Mar 10, 2020

Please, make sure that the cURL spelling is the same for the entire doc.

Suggested change

      
            The ``setOption`` method accepts two parameters. The curl option name and the curl option value.
          
            The ``setOption`` method accepts two parameters. The cURL option name and the curl option value.

src/guides/v2.3/get-started/gs-curl.md Outdated


		#### Set curl option using setOptions method

		The ``setOptions`` method accepts a parameter as an array.

Contributor

rogyar Mar 10, 2020

Suggested change

      
            The ``setOptions`` method accepts a parameter as an array.
          
            The ``setOptions`` method accepts an array as a parameter.

Contributor

rogyar Mar 12, 2020

Take a look at this one, please

src/guides/v2.3/get-started/gs-curl.md Outdated


		#### Set curl cookies using setCookies method

		The ``setCookies`` method accepts a parameter as an array.

Contributor

rogyar Mar 10, 2020

Suggested change

      
            The ``setCookies`` method accepts a parameter as an array.
          
            The ``setCookies`` method accepts an array as a parameter.

rogyar added 2.3.x Major Update labels


          magento#6823 minor fixes

db1dfc1

Contributor Author

DenisSaltanahmedov commented Mar 10, 2020

Hi @rogyar, thanks for your help.
I have fixed the recommendations.

rogyar reviewed

View reviewed changes

src/guides/v2.3/get-started/gs-curl.md Outdated


		#### Set curl option using setOption method

		The ``setOption`` method accepts two parameters. The curl option name and the cURL option value.

Contributor

rogyar Mar 12, 2020

Suggested change

      
            The ``setOption`` method accepts two parameters. The curl option name and the cURL option value.
          
            The ``setOption`` method accepts two parameters. The cURL option name and the cURL option value.

Contributor

rogyar Mar 12, 2020

Please, make sure that we use the same spelling for the entire document. So we don't have Curl, curl, cURL.

Thank you.

rogyar reviewed

View reviewed changes

src/guides/v2.3/get-started/gs-curl.md Outdated

+              $result = $this->curl->getBody();
+              ```
+              Where the ``$url`` is the endpoint url, ``$params`` is an array of data that is being sent via the POST request, the extra parameters can be added in the url.

Contributor

rogyar Mar 12, 2020

Since URL is an abbreviation, I would suggest using the upper case everywhere. The same suggestion applies to other places of this document.

Suggested change

      
            Where the ``$url`` is the endpoint url, ``$params`` is an array of data that is being sent via the POST request, the extra parameters can be added in the url.
          
            Where the ``$url`` is the endpoint URL, ``$params`` is an array of data that is being sent via the POST request, the extra parameters can be added in the URL.

rogyar reviewed

View reviewed changes

src/guides/v2.3/get-started/gs-curl.md Outdated

+              It is equivalent to setting CURLOPT_HTTPHEADER value
+              ```php
+              "Authorization : ". "Basic ".base64_encode($userName.":".$password)

Contributor

rogyar Mar 12, 2020

Please, make sure you follow PSR-1 in your examples

Suggested change

      
            "Authorization : ". "Basic ".base64_encode($userName.":".$password)
          
            "Authorization : " . "Basic " . base64_encode($userName . ":" . $password)


          magento#6823 minor review fixes

1a1322d

Contributor Author

DenisSaltanahmedov commented Mar 12, 2020

Hi @rogyar, thanks for your review.
I have fixed the recommendations.

Contributor

rogyar commented Mar 15, 2020

Hi @DenisSaltanahmedov. Thanks a lot. The only thing left here is the following:

https://github.com/magento/devdocs/pull/6823/files#diff-31d74dc11c9cb7d5599974a83deefd61R128


          magento#6823 minor review fixes

0fe7152

Contributor Author

DenisSaltanahmedov commented Mar 16, 2020

Hi @rogyar, fixed.
Thanks.


          linting and grammar

cc71806

dobooth suggested changes

View reviewed changes

Contributor

dobooth left a comment

Thanks Denis, for this nice update. So far, it is a good, generic cURL how-to guide. I would like to see some Magento-specific examples, if possible. What situations would Magento users use cURL?

m2-community-project bot assigned dobooth

m2-community-project bot added Progress: changes requested and removed Progress: review labels

Contributor Author

DenisSaltanahmedov commented Mar 17, 2020

HI @dobooth.
The main reason to use the cURL is requests to some external service.
for example, we can use the "Magento\Marketplace\Model\Partners" class.
Could you clarify, what will be the bast place where we can add the Magento example.
Maybe at the end of document as an example section.

DenisSaltanahmedov requested review from rogyar and dobooth

March 17, 2020 14:42

Contributor

dobooth commented Mar 17, 2020

Yes, I use it frequently. I was hoping there there were some common Magento tasks that we could use as the actual example code. That would help change this topic from "How to use cURL" to "How to use cURL with Magento". How are you currently using cURL in your Magento work?

Contributor

dobooth commented Mar 18, 2020

Here's one: https://devdocs.magento.com/guides/v2.3/config-guide/elasticsearch/es-config-apache.html#use-a-curl-command-to-verify-cluster-status


          magento#6823 adding example of using cURL by Magento

4cb5d8d

Contributor Author

DenisSaltanahmedov commented Mar 19, 2020

Hi @dobooth thank you for your help.
I added the example.

dobooth changed the title ~~magento/devdocs#: Layout instructions. Adding more information about cURL~~ magento/devdocs#: Layout instructions. Adding more information about cURL [GITBUG]

Contributor

dobooth commented Mar 19, 2020

Just a note that we have a strange bug in our repo that is causing some PRs to not update. We will merge as soon as we get it solved.

rogyar approved these changes

View reviewed changes

Contributor Author

DenisSaltanahmedov commented Mar 26, 2020

Hi @dobooth, any updates about the issue? Thanks.

Contributor

jeff-matthews commented Mar 26, 2020

@DenisSaltanahmedov, the Update branch button isn't working. We've opened a ticket with GitHub support to fix it. If we can't get support to help us by next week, we'll start using workarounds to merge all affected PRs.

Contributor Author

DenisSaltanahmedov commented Apr 6, 2020

Hi, if we still have the problem with merge in the PR, I can recreate the changes to new PR from the current master branch. Thanks.

dobooth approved these changes

View reviewed changes

m2-community-project bot added Progress: approved and removed Progress: changes requested labels


          Merge branch 'master' into improvement-cURL-topics

c2b7776

Contributor

dobooth commented Apr 14, 2020

running tests

dobooth merged commit ebdc0ca into magento:master

ghost commented Apr 14, 2020

Hi @DenisSaltanahmedov, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.

m2-community-project bot removed the Progress: approved label

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

2.3.x Major Update Partner: Atwix partners-contribution