-
Notifications
You must be signed in to change notification settings - Fork 66
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #6 from misantron/refactoring
Library refactoring around PSR-2 / PSR-4 code standards
- Loading branch information
Showing
10 changed files
with
380 additions
and
321 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,3 +2,4 @@ | |
| *.lock | ||
| vendor/ | ||
| *.old | ||
| .idea/ | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,174 @@ | ||
| <?php | ||
|
|
||
| /** | ||
| * HTTP Client library | ||
| * | ||
| * PHP version 5.4 | ||
| * | ||
| * @author Matt Bernier <dx@sendgrid.com> | ||
| * @author Elmer Thomas <dx@sendgrid.com> | ||
| * @copyright 2016 SendGrid | ||
| * @license https://opensource.org/licenses/MIT The MIT License | ||
| * @version GIT: <git_id> | ||
| * @link http://packagist.org/packages/sendgrid/php-http-client | ||
| */ | ||
|
|
||
| namespace SendGrid; | ||
|
|
||
| /** | ||
| * Quickly and easily access any REST or REST-like API. | ||
| */ | ||
| class Client | ||
| { | ||
| /** @var string */ | ||
| protected $host; | ||
| /** @var array */ | ||
| protected $headers; | ||
| /** @var string */ | ||
| protected $version; | ||
| /** @var array */ | ||
| protected $path; | ||
| /** @var array */ | ||
| private $methods; | ||
|
|
||
| /** | ||
| * Initialize the client | ||
| * | ||
| * @param string $host the base url (e.g. https://api.sendgrid.com) | ||
| * @param array $headers global request headers | ||
| * @param string $version api version (configurable) | ||
| * @param array $path holds the segments of the url path | ||
| */ | ||
| public function __construct($host, $headers = null, $version = null, $path = null) | ||
| { | ||
| $this->host = $host; | ||
| $this->headers = $headers ?: []; | ||
| $this->version = $version; | ||
| $this->path = $path ?: []; | ||
| // These are the supported HTTP verbs | ||
| $this->methods = ['delete', 'get', 'patch', 'post', 'put']; | ||
| } | ||
|
|
||
| /** | ||
| * Make a new Client object | ||
| * | ||
| * @param string $name name of the url segment | ||
| * | ||
| * @return Client object | ||
| */ | ||
| private function buildClient($name = null) | ||
| { | ||
| if (isset($name)) { | ||
| $this->path[] = $name; | ||
| } | ||
| $client = new Client($this->host, $this->headers, $this->version, $this->path); | ||
| $this->path = []; | ||
| return $client; | ||
| } | ||
|
|
||
| /** | ||
| * Build the final URL to be passed | ||
| * | ||
| * @param array $queryParams an array of all the query parameters | ||
| * | ||
| * @return string | ||
| */ | ||
| private function buildUrl($queryParams = null) | ||
| { | ||
| $path = '/' . implode('/', $this->path); | ||
| if (isset($queryParams)) { | ||
| $path .= '?' . http_build_query($queryParams); | ||
| } | ||
| return sprintf('%s%s%s', $this->host, $this->version ?: '', $path); | ||
| } | ||
|
|
||
| /** | ||
| * Make the API call and return the response. This is separated into | ||
| * it's own function, so we can mock it easily for testing. | ||
| * | ||
| * @param string $method the HTTP verb | ||
| * @param string $url the final url to call | ||
| * @param array $body request body | ||
| * @param array $headers any additional request headers | ||
| * | ||
| * @return Response object | ||
| */ | ||
| public function makeRequest($method, $url, $body = null, $headers = null) | ||
| { | ||
| $curl = curl_init($url); | ||
|
|
||
| curl_setopt_array($curl, [ | ||
| CURLOPT_RETURNTRANSFER => true, | ||
| CURLOPT_HEADER => 1, | ||
| CURLOPT_CUSTOMREQUEST => strtoupper($method), | ||
| CURLOPT_SSL_VERIFYPEER => false, | ||
| ]); | ||
|
|
||
| if (isset($headers)) { | ||
| $this->headers = array_merge($this->headers, $headers); | ||
| } | ||
| if (isset($body)) { | ||
| $encodedBody = json_encode($body); | ||
| curl_setopt($curl, CURLOPT_POSTFIELDS, $encodedBody); | ||
| $this->headers = array_merge($this->headers, ['Content-Type: application/json']); | ||
| } | ||
| curl_setopt($curl, CURLOPT_HTTPHEADER, $this->headers); | ||
|
|
||
| $response = curl_exec($curl); | ||
| $headerSize = curl_getinfo($curl, CURLINFO_HEADER_SIZE); | ||
| $statusCode = curl_getinfo($curl, CURLINFO_HTTP_CODE); | ||
|
|
||
| $responseBody = substr($response, $headerSize); | ||
| $responseHeaders = substr($response, 0, $headerSize); | ||
|
|
||
| $responseHeaders = explode("\n", $responseHeaders); | ||
|
|
||
| curl_close($curl); | ||
|
|
||
| return new Response($statusCode, $responseBody, $responseHeaders); | ||
| } | ||
|
|
||
| /** | ||
| * Add variable values to the url. | ||
| * (e.g. /your/api/{variable_value}/call) | ||
| * Another example: if you have a PHP reserved word, such as and, | ||
| * in your url, you must use this method. | ||
| * | ||
| * @param string $name name of the url segment | ||
| * | ||
| * @return Client object | ||
| */ | ||
| public function _($name = null) | ||
| { | ||
| return $this->buildClient($name); | ||
| } | ||
|
|
||
| /** | ||
| * Dynamically add method calls to the url, then call a method. | ||
| * (e.g. client.name.name.method()) | ||
| * | ||
| * @param string $name name of the dynamic method call or HTTP verb | ||
| * @param array $args parameters passed with the method call | ||
| * | ||
| * @return Client or Response object | ||
| */ | ||
| public function __call($name, $args) | ||
| { | ||
| $name = strtolower($name); | ||
|
|
||
| if ($name === 'version') { | ||
| $this->version = $args[0]; | ||
| return $this->_(); | ||
| } | ||
|
|
||
| if (in_array($name, $this->methods, true)) { | ||
| $body = isset($args[0]) ? $args[0] : null; | ||
| $queryParams = isset($args[1]) ? $args[1] : null; | ||
| $url = $this->buildUrl($queryParams); | ||
| $headers = isset($args[2]) ? $args[2] : null; | ||
| return $this->makeRequest($name, $url, $body, $headers); | ||
| } | ||
|
|
||
| return $this->_($name); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| <?php | ||
|
|
||
| /** | ||
| * HTTP Client library | ||
| * | ||
| * PHP version 5.4 | ||
| * | ||
| * @author Matt Bernier <dx@sendgrid.com> | ||
| * @author Elmer Thomas <dx@sendgrid.com> | ||
| * @copyright 2016 SendGrid | ||
| * @license https://opensource.org/licenses/MIT The MIT License | ||
| * @version GIT: <git_id> | ||
| * @link http://packagist.org/packages/sendgrid/php-http-client | ||
| */ | ||
|
|
||
| namespace SendGrid; | ||
|
|
||
| /** | ||
| * Holds the response from an API call. | ||
| */ | ||
| class Response | ||
| { | ||
| /** @var int */ | ||
| protected $statusCode; | ||
| /** @var string */ | ||
| protected $body; | ||
| /** @var array */ | ||
| protected $headers; | ||
|
|
||
| /** | ||
| * Setup the response data | ||
| * | ||
| * @param int $statusCode the status code. | ||
| * @param string $body the response body. | ||
| * @param array $headers an array of response headers. | ||
| */ | ||
| public function __construct($statusCode = null, $body = null, $headers = null) | ||
| { | ||
| $this->statusCode = $statusCode; | ||
| $this->body = $body; | ||
| $this->headers = $headers; | ||
| } | ||
|
|
||
| /** | ||
| * The status code | ||
| * | ||
| * @return int | ||
| */ | ||
| public function statusCode() | ||
| { | ||
| return $this->statusCode; | ||
| } | ||
|
|
||
| /** | ||
| * The response body | ||
| * | ||
| * @return string | ||
| */ | ||
| public function body() | ||
| { | ||
| return $this->body; | ||
| } | ||
|
|
||
| /** | ||
| * The response headers | ||
| * | ||
| * @return array | ||
| */ | ||
| public function headers() | ||
| { | ||
| return $this->headers; | ||
| } | ||
| } |
Oops, something went wrong.