summaryrefslogtreecommitdiffstats
path: root/lib
diff options
context:
space:
mode:
authormisantron <misantron@gmail.com>2016-07-09 01:06:33 +0300
committermisantron <misantron@gmail.com>2016-07-09 01:06:33 +0300
commit5af53adbcadf57f3a154e7ae8d8a50b64c414390 (patch)
tree4448d3d1b4fb1819b62a84017f98f1a1561308d2 /lib
parent1c766087ca9e180c37000534c97b43fc8c1d66ad (diff)
downloadphp-http-client-5af53adbcadf57f3a154e7ae8d8a50b64c414390.zip
php-http-client-5af53adbcadf57f3a154e7ae8d8a50b64c414390.tar.gz
php-http-client-5af53adbcadf57f3a154e7ae8d8a50b64c414390.tar.bz2
Bump composer PHP version to 5.4, library refactoring to PSR-2 and PSR-4 standards
Diffstat (limited to 'lib')
-rw-r--r--lib/Client.php174
-rw-r--r--lib/Response.php73
-rw-r--r--lib/SendGrid/Client.php232
3 files changed, 247 insertions, 232 deletions
diff --git a/lib/Client.php b/lib/Client.php
new file mode 100644
index 0000000..c14344a
--- /dev/null
+++ b/lib/Client.php
@@ -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);
+ }
+}
diff --git a/lib/Response.php b/lib/Response.php
new file mode 100644
index 0000000..bc04e1f
--- /dev/null
+++ b/lib/Response.php
@@ -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;
+ }
+} \ No newline at end of file
diff --git a/lib/SendGrid/Client.php b/lib/SendGrid/Client.php
deleted file mode 100644
index e1fbad6..0000000
--- a/lib/SendGrid/Client.php
+++ /dev/null
@@ -1,232 +0,0 @@
-<?php
-/**
- * HTTP Client library
- *
- * PHP version 5.2
- *
- * @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
-{
- /**
- * Setup the response data
- *
- * @param int $status_code the status code.
- * @param array $response_body the response body as an array.
- * @param array $response_headers an array of response headers.
- */
- function __construct($status_code = null, $response_body = null, $response_headers = null)
- {
- $this->_status_code = $status_code;
- $this->_body = $response_body;
- $this->_headers = $response_headers;
- }
-
- /**
- * The status code
- *
- * @return integer
- */
- public function statusCode()
- {
- return $this->_status_code;
- }
-
- /**
- * The response body
- *
- * @return array
- */
- public function body()
- {
- return $this->_body;
- }
-
- /**
- * The response headers
- *
- * @return array
- */
- public function headers()
- {
- return $this->_headers;
- }
-}
-
-/**
- * Quickly and easily access any REST or REST-like API.
- */
-class Client
-{
-
- public
- $host,
- $request_headers,
- $version,
- $url_path,
- $methods;
-
- /**
- * Initialize the client
- *
- * @param string $host the base url (e.g. https://api.sendgrid.com)
- * @param array $request_headers global request headers
- * @param string $version api version (configurable)
- * @param array $url_path holds the segments of the url path
- */
- function __construct($host, $request_headers = null, $version = null, $url_path = null)
- {
- $this->host = $host;
- $this->request_headers = ($request_headers ? $request_headers : []);
- $this->version = $version;
- $this->url_path = ($url_path ? $url_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)) {
- array_push($this->url_path, $name);
- }
- $url_path = $this->url_path;
- $this->url_path = [];
- return new Client($this->host, $this->request_headers, $this->version, $url_path);
- }
-
- /**
- * Subclass this function for your own needs.
- * Or just pass the version as part of the URL
- * (e.g. client._('/v3'))
- *
- * @param string $url URI portion of the full URL being requested
- *
- * @return string
- */
- private function _buildVersionedUrl($url)
- {
- return sprintf("%s%s%s", $this->host, $this->version, $url);
- }
-
- /**
- * Build the final URL to be passed
- *
- * @param array $query_params an array of all the query parameters
- *
- * @return string
- */
- private function _buildUrl($query_params = null)
- {
- $url = '/'.implode('/', $this->url_path);
- if (isset($query_params)) {
- $url_values = http_build_query($query_params);
- $url = sprintf('%s?%s', $url, $url_values);
- }
- if (isset($this->version)) {
- $url = $this->_buildVersionedUrl($url);
- } else {
- $url = sprintf('%s%s', $this->host, $url);;
- }
- return $url;
- }
-
- /**
- * 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 array $method the HTTP verb
- * @param string $url the final url to call
- * @param array $request_body request body
- * @param array $request_headers any additional request headers
- *
- * @return Response object
- */
- public function makeRequest($method, $url, $request_body = null, $request_headers = null)
- {
- $curl = curl_init($url);
- curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
- curl_setopt($curl, CURLOPT_HEADER, 1);
- curl_setopt($curl, CURLOPT_CUSTOMREQUEST, strtoupper($method));
- curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
- if(isset($request_headers)) {
- $this->request_headers = array_merge($this->request_headers, $request_headers);
- }
- if(isset($request_body)) {
- $request_body = json_encode($request_body);
- curl_setopt($curl, CURLOPT_POSTFIELDS, $request_body);
- $content_length = array('Content-Length: ' . strlen($request_body));
- $content_type = array('Content-Type: application/json');
- $this->request_headers = array_merge($this->request_headers, $content_type);
- }
- curl_setopt($curl, CURLOPT_HTTPHEADER, $this->request_headers);
- $curl_response = curl_exec($curl);
- $header_size = curl_getinfo($curl, CURLINFO_HEADER_SIZE);
- $status_code = curl_getinfo($curl, CURLINFO_HTTP_CODE);
- $response_body = substr($curl_response, $header_size);
- $response_header = substr($curl_response, 0, $header_size);
-
- curl_close($curl);
-
- return new Response($status_code, $response_body, $response_header);
- }
-
- /**
- * 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)
- {
- if($name == 'version') {
- $this->version = $args[0];
- return $this->_();
- }
-
- if (in_array($name, $this->methods)) {
- $query_params = ((count($args) >= 2) ? $args[1] : null);
- $url = $this->_buildUrl($query_params);
- $request_body = ($args ? $args[0] : null);
- $request_headers = ((count($args) == 3) ? $args[2] : null);
- return $this->makeRequest($name, $url, $request_body, $request_headers);
- }
-
- return $this->_($name);
- }
-}
-?>