summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorElmer Thomas <elmer@thinkingserious.com>2016-05-11 12:32:50 -0700
committerElmer Thomas <elmer@thinkingserious.com>2016-05-11 12:32:50 -0700
commitd130a8e7102f7cbfc52c1f02d8a481e1fe898857 (patch)
tree10ce234bf9690a1829724682adea1649a8ea6fea
parent680ef8aa15d7b5636cb045bfb40546ac142b3728 (diff)
downloadphp-http-client-d130a8e7102f7cbfc52c1f02d8a481e1fe898857.zip
php-http-client-d130a8e7102f7cbfc52c1f02d8a481e1fe898857.tar.gz
php-http-client-d130a8e7102f7cbfc52c1f02d8a481e1fe898857.tar.bz2
Version Bump 2.0.2
-rw-r--r--CHANGELOG.md4
-rw-r--r--composer.json2
-rw-r--r--lib/SendGrid/Client.php230
-rw-r--r--lib/SendGrid/Config.php36
4 files changed, 271 insertions, 1 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 897a7f9..ad6bb25 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -2,6 +2,10 @@
All notable changes to this project will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).
+## [2.0.2] - 2016-02-29
+### Fixed
+- Renaming files to conform to PSR-0, git ignored the case in 2.0.1
+
## [2.0.1] - 2016-02-29
### Fixed
- Renaming files to conform to PSR-0
diff --git a/composer.json b/composer.json
index d8daa29..62f80da 100644
--- a/composer.json
+++ b/composer.json
@@ -2,7 +2,7 @@
"name": "sendgrid/php-http-client",
"description": "HTTP REST client, simplified for PHP",
"type": "library",
- "version": "2.0.1",
+ "version": "2.0.2",
"require-dev": {
"phpunit/phpunit": "~4.4",
"squizlabs/php_codesniffer": "2.*"
diff --git a/lib/SendGrid/Client.php b/lib/SendGrid/Client.php
new file mode 100644
index 0000000..805ff45
--- /dev/null
+++ b/lib/SendGrid/Client.php
@@ -0,0 +1,230 @@
+<?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->_response_body = $response_body;
+ $this->_response_headers = $response_headers;
+ }
+
+ /**
+ * The status code
+ *
+ * @return integer
+ */
+ public function statusCode()
+ {
+ return $this->_status_code;
+ }
+
+ /**
+ * The response body
+ *
+ * @return array
+ */
+ public function responseBody()
+ {
+ return $this->_response_body;
+ }
+
+ /**
+ * The response headers
+ *
+ * @return array
+ */
+ public function responseHeaders()
+ {
+ return $this->_response_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_body)) {
+ $request_body = json_encode($request_body);
+ curl_setopt($curl, CURLOPT_POSTFIELDS, $request_body);
+ $content_length = array('Content-Length: ' . strlen($request_body));
+ }
+ if(isset($request_headers)) {
+ $this->request_headers = array_merge($this->request_headers, $request_headers);
+ }
+ 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);
+ }
+}
+?>
diff --git a/lib/SendGrid/Config.php b/lib/SendGrid/Config.php
new file mode 100644
index 0000000..5c4383e
--- /dev/null
+++ b/lib/SendGrid/Config.php
@@ -0,0 +1,36 @@
+<?php
+/**
+ * Environment Variable Configuration
+ *
+ * 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;
+
+/**
+ * Sets environment variables.
+ */
+class Config
+{
+ /**
+ * Setup the environment variables
+ *
+ * @param string $base_path path to your config file.
+ * @param string $config_filename name of the config file.
+ */
+ function __construct($base_path, $config_filename)
+ {
+ $handle = fopen($base_path.'/'.$config_filename, "r");
+ while (($line = fgets($handle)) !== false) {
+ putenv(trim(preg_replace('/\s+/', ' ', $line)));
+ }
+ fclose($handle);
+ }
+}
+?>