From e5ab6e0e867f58452dbdd03ee0469c48c9c841fe Mon Sep 17 00:00:00 2001 From: Elmer Thomas Date: Sat, 19 Mar 2016 21:23:33 -0700 Subject: Add Tests --- .env_sample | 4 + .gitignore | 4 +- composer.json | 38 ++++++++ examples/example.php | 8 +- lib/client.php | 198 +++++++++++++++++++++++++++++++++++++++++ lib/config.php | 12 +++ php_http_client/client.php | 215 --------------------------------------------- php_http_client/config.php | 11 --- test/unit/ClientTest.php | 75 ++++++++++++++++ test/unit/ConfigTest.php | 24 +++++ test/unit/bootstrap.php | 17 ++++ 11 files changed, 375 insertions(+), 231 deletions(-) create mode 100644 .env_sample create mode 100644 composer.json create mode 100644 lib/client.php create mode 100644 lib/config.php delete mode 100644 php_http_client/client.php delete mode 100644 php_http_client/config.php create mode 100644 test/unit/ClientTest.php create mode 100644 test/unit/ConfigTest.php create mode 100644 test/unit/bootstrap.php diff --git a/.env_sample b/.env_sample new file mode 100644 index 0000000..f1a63f3 --- /dev/null +++ b/.env_sample @@ -0,0 +1,4 @@ +HOST= +MOCK_HOST= +LOCAL_HOST= +SENDGRID_API_KEY= \ No newline at end of file diff --git a/.gitignore b/.gitignore index 2eea525..0c1e887 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,3 @@ -.env \ No newline at end of file +.env +*.lock +vendor/ \ No newline at end of file diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..bf4d4bd --- /dev/null +++ b/composer.json @@ -0,0 +1,38 @@ + +{ + "name": "sendgrid/php-http-client", + "description": "HTTP REST client, simplified for Python", + "type": "library", + "version": "1.0.0", + "homepage": "http://github.com/sendgrid/php-http-client", + "license": "MIT", + "keywords": ["SendGrid", "HTTP", "REST", "API", "Fluent"], + "require": { + "php": ">=5.3" + }, + "authors": [ + { + "name": "Matt Bernier", + "email": "dx@sendgrid.com", + "homepage": "https://www.sendgrid.com", + "role": "Product Manager" + }, + { + "name": "Elmer Thomas", + "email": "dx@sendgrid.com", + "homepage": "https://www.sendgrid.com", + "role": "Developer" + } + ], + "support": { + "email": "dx@sendgrid.com", + "issues": "https://github.com/sendgrid/php-http-client/issues", + "source": "https://github.com/php-http-client" + }, + "require-dev": { + "phpunit/phpunit": "~4.4" + }, + "autoload": { + "psr-0": {"SendGrid": "lib/"} + } +} \ No newline at end of file diff --git a/examples/example.php b/examples/example.php index 05fe5eb..48fcf61 100644 --- a/examples/example.php +++ b/examples/example.php @@ -1,13 +1,13 @@ 100, 'offset' => 0); diff --git a/lib/client.php b/lib/client.php new file mode 100644 index 0000000..602d53b --- /dev/null +++ b/lib/client.php @@ -0,0 +1,198 @@ +_status_code = $status_code; + $this->_response_body = $response_body; + $this->_response_headers = $response_headers; + } + + /** + * @return: integer, status code of API call + */ + public function status_code() { + return $this->_status_code; + } + + /** + * @return: response from the API + */ + public function response_body() { + return $this->_response_body; + } + + /** + * @return: dict of response headers + */ + public function response_headers() { + return $this->_response_headers; + } +} + +class Client { + + public + $host, + $request_headers, + $version, + $url_path, + $methods; + + function __construct($host, $request_headers = null, $version = null, $url_path = null){ + /* + @param host: Base URL for the api. (e.g. https://api.sendgrid.com) + @type host: string + + @param request_headers: A dictionary of the headers you want applied on all calls + @type request_headers: dictionary + + @param version: The version number of the API. + @type integer: + */ + + $this->host = $host; + $this->request_headers = ($request_headers ? $request_headers : []); + $this->version = $version; + # url_path keeps track of the dynamically built url + $this->url_path = ($url_path ? $url_path : []); + # These are the supported HTTP verbs + $this->methods = ['delete', 'get', 'patch', 'post', 'put']; + } + + /** + * Takes the method chained call and adds to the url path. + * @param name: The name of the method call + * @type name: string + */ + private function _build_client($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); + } + + /** + * Add the version to the path + */ + public function version($version) { + $this->version = $version; + return $this->_(null); + } + + public function get_version() { + return $this->version; + } + + /** + * Subclass this function for your own needs. + * Or just pass the version as part of the URL + * (e.g. client._('/v3')) + * @param url: URI portion of the full URL being requested + * @type url: string + * @return: string + */ + private function _build_versioned_url($url) { + return sprintf("%s/v%d%s", $this->host, $this->get_version(), $url); + } + + /** + * Build the final URL to be passed + * @param query_params: A dictionary of all the query parameters + * @type query_params: dictionary + * @return: + */ + private function _build_url($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 (null != $this->get_version()) { + $url = $this->_build_versioned_url($url); + } else { + $url = sprintf('%s%s', $this->host, $url);; + } + + return $url; + } + + /** + * Build the headers for the request + * @param request_headers: headers to set for the API call + * @type response: dict + * @return: + */ + private function _set_headers($request_headers) { + $this->request_headers = array_merge($this->request_headers, $request_headers); + } + + /** + * 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 opener: + * @type opener: + * @param request: url payload to request + * @type request: urllib.Request object + * @return: + */ + public function _make_request($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) + */ + public function _($name){ + return $this->_build_client($name); + } + + /** + * Dynamically add method calls to the url, then call a method. + * (e.g. client.name.name.method()) + */ + public function __call($name, $args){ + + if($name == 'version'){ + return version($name); + } + + if (in_array($name, $this->methods)) { + $query_params = ((count($args) >= 2) ? $args[1] : null); + $url = $this->_build_url($query_params); + $request_body = ($args ? $args[0] : null); + $request_headers = ((count($args) == 3) ? $args[2] : null); + return $this->_make_request($name, $url, $request_body, $request_headers); + } + + return $this->_($name); + } +} +?> diff --git a/lib/config.php b/lib/config.php new file mode 100644 index 0000000..2608700 --- /dev/null +++ b/lib/config.php @@ -0,0 +1,12 @@ + diff --git a/php_http_client/client.php b/php_http_client/client.php deleted file mode 100644 index 77ca629..0000000 --- a/php_http_client/client.php +++ /dev/null @@ -1,215 +0,0 @@ -_status_code = $status_code; - $this->_response_body = $response_body; - $this->_response_headers = $response_headers; - } - - /** - * @return: integer, status code of API call - */ - public function status_code() { - return $this->_status_code; - } - - /** - * @return: response from the API - */ - public function response_body() { - return $this->_response_body; - } - - /** - * @return: dict of response headers - */ - public function response_headers() { - return $this->_response_headers; - } -} - -class Client { - - function __construct($host, $request_headers = null, $version = null, $url_path = null){ - /* - @param host: Base URL for the api. (e.g. https://api.sendgrid.com) - @type host: string - - @param request_headers: A dictionary of the headers you want applied on all calls - @type request_headers: dictionary - - @param version: The version number of the API. - @type integer: - */ - - $this->host = $host; - $this->request_headers = ($request_headers ? $request_headers : []); - $this->_version = $version; - # _url_path keeps track of the dynamically built url - $this->_url_path = ($url_path ? $url_path : []); - # These are the supported HTTP verbs - $this->_methods = ['delete', 'get', 'patch', 'post', 'put']; - } - - /** - * Takes the method chained call and adds to the url path. - * @param name: The name of the method call - * @type name: string - */ - private function _build_client($name = null) { - if($name != null){ - 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 url: URI portion of the full URL being requested - * @type url: string - * @return: string - */ - private function _build_versioned_url($url) { - return sprintf("%s/v%d%s", $this->host, $this->_get_version(), $url); - } - - /** - * Build the final URL to be passed - * @param query_params: A dictionary of all the query parameters - * @type query_params: dictionary - * @return: - */ - private function _build_url($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 (null != $this->_get_version()) { - $url = $this->_build_versioned_url($url); - } else { - $url = sprintf('%s%s', $this->host, $url);; - } - - return $url; - } - - /** - * Build the headers for the request - * @param request_headers: headers to set for the API call - * @type response: dict - * @return: - */ - private function _set_headers($request_headers) { - $this->request_headers = array_merge($this->request_headers, $request_headers); - } - - /** - * 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 opener: - * @type opener: - * @param request: url payload to request - * @type request: urllib.Request object - * @return: - */ - private function _make_request($method, $url, $request_body = null, $request_headers = null) { - $curl = curl_init($url); - curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); - curl_setopt($curl, CURLOPT_HEADER, 1); - switch($method){ - case 'get': - curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET'); - break; - case 'post': - curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'POST'); - $request_body = json_encode($request_body); - curl_setopt($curl, CURLOPT_POSTFIELDS, $request_body); - $content_length = array('Content-Length: ' . strlen($request_body)); - $this->request_headers = array_merge($this->request_headers, $content_length); - break; - case 'patch': - curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'PATCH'); - $request_body = json_encode($request_body); - curl_setopt($curl, CURLOPT_POSTFIELDS, $request_body); - $content_length = array('Content-Length: ' . strlen($request_body)); - $this->request_headers = array_merge($this->request_headers, $content_length); - break; - case 'put': - curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'PUT'); - $request_body = json_encode($request_body); - curl_setopt($curl, CURLOPT_POSTFIELDS, $request_body); - $content_length = array('Content-Length: ' . strlen($request_body)); - $this->request_headers = array_merge($this->request_headers, $content_length); - break; - case 'delete': - curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'DELETE'); - break; - default: - curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET'); - break; - } - curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false); - 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); - $response_header = substr($curl_response, 0, $header_size); - $response_body = substr($curl_response, $header_size); - $status_code = curl_getinfo($curl, CURLINFO_HTTP_CODE); - 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) - */ - public function _($name){ - return $this->_build_client($name); - } - - /** - * Dynamically add method calls to the url, then call a method. - * (e.g. client.name.name.method()) - */ - public function __call($name, $args){ - - if($name == 'version'){ - return version($name); - } - - if (in_array($name, $this->_methods)) { - $request_body = ($args ? $args[0] : null); - $query_params = ((count($args) >= 2) ? $args[1] : null); - $url = $this->_build_url($query_params); - $request_headers = ((count($args) == 3) ? $args[2] : null); - return $this->_make_request($name, $url, $request_body, $request_headers); - } - - return $this->_($name); - } - - /** - * Add the version to the path - */ - public function version($version) { - $this->_version = $version; - return $this->_(null); - } - - private function _get_version() { - return $this->_version; - } - -} -?> diff --git a/php_http_client/config.php b/php_http_client/config.php deleted file mode 100644 index ba33bef..0000000 --- a/php_http_client/config.php +++ /dev/null @@ -1,11 +0,0 @@ - diff --git a/test/unit/ClientTest.php b/test/unit/ClientTest.php new file mode 100644 index 0000000..3781668 --- /dev/null +++ b/test/unit/ClientTest.php @@ -0,0 +1,75 @@ +request_body = $request_body; + $this->request_headers = $request_headers; + $this->url = $url; + return $this; + } +} + +class ClientTest_Client extends PHPUnit_Framework_TestCase +{ + protected + $client, + $host, + $headers; + + protected function setUp() + { + $this->host = "https://localhost:4010"; + $this->headers = array( + 'Content-Type: application/json', + 'Authorization: Bearer SG.XXXX' + ); + $this->client = new MockClient($this->host, $this->headers, "3", null); + } + + public function testInitialization() + { + $this->assertEquals($this->client->host, $this->host); + $this->assertEquals($this->client->request_headers, $this->headers); + $this->assertEquals($this->client->version, "3"); + $this->assertEquals($this->client->url_path, []); + $this->assertEquals($this->client->methods, ['delete', 'get', 'patch', 'post', 'put']); + } + + public function test_() + { + $client = $this->client->_("test"); + $this->assertEquals($client->url_path, array("test")); + } + + public function test__call() + { + $client = $this->client->get(); + $this->assertEquals($client->url, "https://localhost:4010/v3/"); + + $query_params = array('limit' => 100, 'offset' => 0); + $client = $this->client->get(null, $query_params); + $this->assertEquals($client->url, "https://localhost:4010/v3/?limit=100&offset=0"); + + $request_body = array('name' => 'A New Hope'); + $client = $this->client->get($request_body); + $this->assertEquals($client->request_body, $request_body); + + $request_headers = array('X-Mock: 200'); + $client = $this->client->get(null, null, $request_headers); + $this->assertEquals($client->request_headers, $request_headers); + + $client = $this->client->version("4"); + $this->assertEquals($client->version, "4"); + + $client = $this->client->path_to_endpoint(); + $this->assertEquals($client->url_path, array("path_to_endpoint")); + $client = $client->one_more_segment(); + $this->assertEquals($client->url_path, array("path_to_endpoint", "one_more_segment")); + } +} +?> \ No newline at end of file diff --git a/test/unit/ConfigTest.php b/test/unit/ConfigTest.php new file mode 100644 index 0000000..569d915 --- /dev/null +++ b/test/unit/ConfigTest.php @@ -0,0 +1,24 @@ +base_path = dirname(".."); + $this->config_filename = '.env_sample'; + $this->config = new SendGrid\Config($this->base_path, $this->config_filename); + } + + public function testInitialization() + { + $this->assertEquals($api_key = getenv('SENDGRID_API_KEY'), ""); + $this->assertEquals($api_key = getenv('HOST'), ""); + $this->assertEquals($api_key = getenv('MOCK_HOST'), ""); + $this->assertEquals($api_key = getenv('LOCAL_HOST'), ""); + } +} +?> \ No newline at end of file diff --git a/test/unit/bootstrap.php b/test/unit/bootstrap.php new file mode 100644 index 0000000..af10b46 --- /dev/null +++ b/test/unit/bootstrap.php @@ -0,0 +1,17 @@ + \ No newline at end of file -- cgit v1.1