-4

externals/httpful/.gitignore

reviewed

··· 1 1 - .DS_Store 2 2 - composer.lock 3 3 - vendor 4 4 - downloads

-5

externals/httpful/.travis.yml

reviewed

··· 1 1 - language: php 2 2 - before_script: cd tests 3 3 - php: 4 4 - - 5.3 5 5 - - 5.4

-7

externals/httpful/LICENSE.txt

reviewed

··· 1 1 - Copyright (c) 2012 Nate Good <me@nategood.com> 2 2 - 3 3 - Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: 4 4 - 5 5 - The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. 6 6 - 7 7 - THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

-137

externals/httpful/README.md

reviewed

··· 1 1 - # Httpful 2 2 - 3 3 - [](http://travis-ci.org/nategood/httpful) 4 4 - 5 5 - [Httpful](http://phphttpclient.com) is a simple Http Client library for PHP 5.3+. There is an emphasis of readability, simplicity, and flexibility – basically provide the features and flexibility to get the job done and make those features really easy to use. 6 6 - 7 7 - Features 8 8 - 9 9 - - Readable HTTP Method Support (GET, PUT, POST, DELETE, HEAD, PATCH and OPTIONS) 10 10 - - Custom Headers 11 11 - - Automatic "Smart" Parsing 12 12 - - Automatic Payload Serialization 13 13 - - Basic Auth 14 14 - - Client Side Certificate Auth 15 15 - - Request "Templates" 16 16 - 17 17 - # Sneak Peak 18 18 - 19 19 - Here's something to whet your appetite. Search the twitter API for tweets containing "#PHP". Include a trivial header for the heck of it. Notice that the library automatically interprets the response as JSON (can override this if desired) and parses it as an array of objects. 20 20 - 21 21 - $url = "http://search.twitter.com/search.json?q=" . urlencode('#PHP'); 22 22 - $response = Request::get($url) 23 23 - ->withXTrivialHeader('Just as a demo') 24 24 - ->send(); 25 25 - 26 26 - foreach ($response->body->results as $tweet) { 27 27 - echo "@{$tweet->from_user} tweets \"{$tweet->text}\"\n"; 28 28 - } 29 29 - 30 30 - # Installation 31 31 - 32 32 - ## Phar 33 33 - 34 34 - A [PHP Archive](http://php.net/manual/en/book.phar.php) (or .phar) file is available for [downloading](https://github.com/nategood/httpful/downloads). Simply [download](https://github.com/nategood/httpful/downloads) the .phar, drop it into your project, and include it like you would any other php file. _This method is ideal smaller projects, one off scripts, and quick API hacking_. 35 35 - 36 36 - <?php 37 37 - include('httpful.phar'); 38 38 - $r = \Httpful\Request::get($uri)->sendIt(); 39 39 - ... 40 40 - 41 41 - ## Composer 42 42 - 43 43 - Httpful is PSR-0 compliant and can be installed using [composer](http://getcomposer.org/). Simply add `nategood/httpful` to your composer.json file. _Composer is the sane alternative to PEAR. It is excellent for managing dependancies in larger projects_. 44 44 - 45 45 - { 46 46 - "require": { 47 47 - "nategood/httpful": "*" 48 48 - } 49 49 - } 50 50 - 51 51 - ## Install from Source 52 52 - 53 53 - Because Httpful is PSR-0 compliant, you can also just clone the Httpful repository and use a PSR-0 compatible autoloader to load the library, like [Symfony's](http://symfony.com/doc/current/components/class_loader.html). Alternatively you can use the PSR-0 compliant autoloader included with the Httpful (simply `require("bootstrap.php")`). 54 54 - 55 55 - # Show Me More! 56 56 - 57 57 - You can checkout the [Httpful Landing Page](http://phphttpclient.com) for more info including many examples and [documentation](http:://phphttpclient.com/docs). 58 58 - 59 59 - # Contributing 60 60 - 61 61 - Httpful highly encourages sending in pull requests. When submitting a pull request please: 62 62 - 63 63 - - All pull requests should target the `dev` branch (not `master`) 64 64 - - Make sure your code follows the [coding conventions](http://pear.php.net/manual/en/standards.php) 65 65 - - Please use soft tabs (four spaces) instead of hard tabs 66 66 - - Make sure you add appropriate test coverage for your changes 67 67 - - Run all unit tests in the test directory via `phpunit ./tests` 68 68 - - Include commenting where appropriate and add a descriptive pull request message 69 69 - 70 70 - # Changelog 71 71 - 72 72 - ## 0.2.3 73 73 - 74 74 - - FIX Overriding default Mime Handlers 75 75 - - FIX [PR #73](https://github.com/nategood/httpful/pull/73) Parsing http status codes 76 76 - 77 77 - ## 0.2.2 78 78 - 79 79 - - FEATURE Add support for parsing JSON responses as associative arrays instead of objects 80 80 - - FEATURE Better support for setting constructor arguments on Mime Handlers 81 81 - 82 82 - ## 0.2.1 83 83 - 84 84 - - FEATURE [PR #72](https://github.com/nategood/httpful/pull/72) Allow support for custom Accept header 85 85 - 86 86 - ## 0.2.0 87 87 - 88 88 - - REFACTOR [PR #49](https://github.com/nategood/httpful/pull/49) Broke headers out into their own class 89 89 - - REFACTOR [PR #54](https://github.com/nategood/httpful/pull/54) Added more specific Exceptions 90 90 - - FIX [PR #58](https://github.com/nategood/httpful/pull/58) Fixes throwing an error on an empty xml response 91 91 - - FEATURE [PR #57](https://github.com/nategood/httpful/pull/57) Adds support for digest authentication 92 92 - 93 93 - ## 0.1.6 94 94 - 95 95 - - Ability to set the number of max redirects via overloading `followRedirects(int max_redirects)` 96 96 - - Standards Compliant fix to `Accepts` header 97 97 - - Bug fix for bootstrap process when installed via Composer 98 98 - 99 99 - ## 0.1.5 100 100 - 101 101 - - Use `DIRECTORY_SEPARATOR` constant [PR #33](https://github.com/nategood/httpful/pull/32) 102 102 - - [PR #35](https://github.com/nategood/httpful/pull/35) 103 103 - - Added the raw\_headers property reference to response. 104 104 - - Compose request header and added raw\_header to Request object. 105 105 - - Fixed response has errors and added more comments for clarity. 106 106 - - Fixed header parsing to allow the minimum (status line only) and also cater for the actual CRLF ended headers as per RFC2616. 107 107 - - Added the perfect test Accept: header for all Acceptable scenarios see @b78e9e82cd9614fbe137c01bde9439c4e16ca323 for details. 108 108 - - Added default User-Agent header 109 109 - - `User-Agent: Httpful/0.1.5` + curl version + server software + PHP version 110 110 - - To bypass this "default" operation simply add a User-Agent to the request headers even a blank User-Agent is sufficient and more than simple enough to produce me thinks. 111 111 - - Completed test units for additions. 112 112 - - Added phpunit coverage reporting and helped phpunit auto locate the tests a bit easier. 113 113 - 114 114 - ## 0.1.4 115 115 - 116 116 - - Add support for CSV Handling [PR #32](https://github.com/nategood/httpful/pull/32) 117 117 - 118 118 - ## 0.1.3 119 119 - 120 120 - - Handle empty responses in JsonParser and XmlParser 121 121 - 122 122 - ## 0.1.2 123 123 - 124 124 - - Added support for setting XMLHandler configuration options 125 125 - - Added examples for overriding XmlHandler and registering a custom parser 126 126 - - Removed the httpful.php download (deprecated in favor of httpful.phar) 127 127 - 128 128 - ## 0.1.1 129 129 - 130 130 - - Bug fix serialization default case and phpunit tests 131 131 - 132 132 - ## 0.1.0 133 133 - 134 134 - - Added Support for Registering Mime Handlers 135 135 - - Created AbstractMimeHandler type that all Mime Handlers must extend 136 136 - - Pulled out the parsing/serializing logic from the Request/Response classes into their own MimeHandler classes 137 137 - - Added ability to register new mime handlers for mime types

-4

externals/httpful/bootstrap.php

reviewed

··· 1 1 - <?php 2 2 - 3 3 - require(__DIR__ . '/src/Httpful/Bootstrap.php'); 4 4 - \Httpful\Bootstrap::init();

-51

externals/httpful/build

reviewed

··· 1 1 - #!/usr/bin/php 2 2 - <?php 3 3 - 4 4 - /** 5 5 - * Build the whole library into a single file 6 6 - * as an easy drop in solution as opposed to 7 7 - * relying on autoloader. Sometimes we just 8 8 - * want to hack with an API as a one off thing. 9 9 - * Httpful should make this easy. 10 10 - */ 11 11 - 12 12 - function exit_unless($condition, $msg = null) { 13 13 - if ($condition) 14 14 - return; 15 15 - echo "[FAIL]\n$msg\n"; 16 16 - exit(1); 17 17 - } 18 18 - 19 19 - // Create the Httpful Phar 20 20 - echo "Building Phar... "; 21 21 - $base_dir = dirname(__FILE__); 22 22 - $source_dir = $base_dir . '/src/Httpful/'; 23 23 - $phar_path = $base_dir . '/downloads/httpful.phar'; 24 24 - $phar = new Phar($phar_path, 0, 'httpful.phar'); 25 25 - $stub = <<<HEREDOC 26 26 - <?php 27 27 - // Phar Stub File 28 28 - Phar::mapPhar('httpful.phar'); 29 29 - include('phar://httpful.phar/Httpful/Bootstrap.php'); 30 30 - \Httpful\Bootstrap::pharInit(); 31 31 - 32 32 - __HALT_COMPILER(); 33 33 - HEREDOC; 34 34 - try { 35 35 - $phar->setStub($stub); 36 36 - } catch(Exception $e) { 37 37 - $phar = false; 38 38 - } 39 39 - exit_unless($phar, "Unable to create a phar. Make certain you have phar.readonly=0 set in your ini file."); 40 40 - $phar->buildFromDirectory(dirname($source_dir)); 41 41 - echo "[ OK ]\n"; 42 42 - 43 43 - 44 44 - 45 45 - // Add it to git! 46 46 - echo "Adding httpful.phar to the repo... "; 47 47 - $return_code = 0; 48 48 - passthru("git add $phar_path", $return_code); 49 49 - exit_unless($return_code === 0, "Unable to add download files to git."); 50 50 - echo "[ OK ]\n"; 51 51 - echo "\nBuild completed sucessfully.\n\n";

-24

externals/httpful/composer.json

reviewed

··· 1 1 - { 2 2 - "name": "nategood/httpful", 3 3 - "description": "A Readable, Chainable, REST friendly, PHP HTTP Client", 4 4 - "homepage": "http://github.com/nategood/httpful", 5 5 - "license": "MIT", 6 6 - "keywords": ["http", "curl", "rest", "restful", "api", "requests"], 7 7 - "version": "0.2.3", 8 8 - "authors": [ 9 9 - { 10 10 - "name": "Nate Good", 11 11 - "email": "me@nategood.com", 12 12 - "homepage": "http://nategood.com" 13 13 - } 14 14 - ], 15 15 - "require": { 16 16 - "php": ">=5.3", 17 17 - "ext-curl": "*" 18 18 - }, 19 19 - "autoload": { 20 20 - "psr-0": { 21 21 - "Httpful": "src/" 22 22 - } 23 23 - } 24 24 - }

-12

externals/httpful/examples/freebase.php

reviewed

··· 1 1 - <?php 2 2 - /** 3 3 - * Grab some The Dead Weather albums from Freebase 4 4 - */ 5 5 - require(__DIR__ . '/../bootstrap.php'); 6 6 - 7 7 - $uri = "https://www.googleapis.com/freebase/v1/mqlread?query=%7B%22type%22:%22/music/artist%22%2C%22name%22:%22The%20Dead%20Weather%22%2C%22album%22:%5B%5D%7D"; 8 8 - $response = \Httpful\Request::get($uri) 9 9 - ->expectsJson() 10 10 - ->sendIt(); 11 11 - 12 12 - echo 'The Dead Weather has ' . count($response->body->result->album) . " albums.\n";

-9

externals/httpful/examples/github.php

reviewed

··· 1 1 - <?php 2 2 - // XML Example from GitHub 3 3 - require(__DIR__ . '/../bootstrap.php'); 4 4 - use \Httpful\Request; 5 5 - 6 6 - $uri = 'https://github.com/api/v2/xml/user/show/nategood'; 7 7 - $request = Request::get($uri)->send(); 8 8 - 9 9 - echo "{$request->body->name} joined GitHub on " . date('M jS', strtotime($request->body->{'created-at'})) ."\n";

-44

externals/httpful/examples/override.php

reviewed

··· 1 1 - <?php 2 2 - require(__DIR__ . '/../bootstrap.php'); 3 3 - 4 4 - // We can override the default parser configuration options be registering 5 5 - // a parser with different configuration options for a particular mime type 6 6 - 7 7 - // Example setting a namespace for the XMLHandler parser 8 8 - $conf = array('namespace' => 'http://example.com'); 9 9 - \Httpful\Httpful::register(\Httpful\Mime::XML, new \Httpful\Handlers\XmlHandler($conf)); 10 10 - 11 11 - // We can also add the parsers with our own... 12 12 - class SimpleCsvHandler extends \Httpful\Handlers\MimeHandlerAdapter 13 13 - { 14 14 - /** 15 15 - * Takes a response body, and turns it into 16 16 - * a two dimensional array. 17 17 - * 18 18 - * @param string $body 19 19 - * @return mixed 20 20 - */ 21 21 - public function parse($body) 22 22 - { 23 23 - return str_getcsv($body); 24 24 - } 25 25 - 26 26 - /** 27 27 - * Takes a two dimensional array and turns it 28 28 - * into a serialized string to include as the 29 29 - * body of a request 30 30 - * 31 31 - * @param mixed $payload 32 32 - * @return string 33 33 - */ 34 34 - public function serialize($payload) 35 35 - { 36 36 - $serialized = ''; 37 37 - foreach ($payload as $line) { 38 38 - $serialized .= '"' . implode('","', $line) . '"' . "\n"; 39 39 - } 40 40 - return $serialized; 41 41 - } 42 42 - } 43 43 - 44 44 - \Httpful\Httpful::register('text/csv', new SimpleCsvHandler());

-24

externals/httpful/examples/showclix.php

reviewed

··· 1 1 - <?php 2 2 - 3 3 - require(__DIR__ . '/../bootstrap.php'); 4 4 - 5 5 - use \Httpful\Request; 6 6 - 7 7 - // Get event details for a public event 8 8 - $uri = "http://api.showclix.com/Event/8175"; 9 9 - $response = Request::get($uri) 10 10 - ->expectsType('json') 11 11 - ->sendIt(); 12 12 - 13 13 - // Print out the event details 14 14 - echo "The event {$response->body->event} will take place on {$response->body->event_start}\n"; 15 15 - 16 16 - // Example overriding the default JSON handler with one that encodes the response as an array 17 17 - \Httpful\Httpful::register(\Httpful\Mime::JSON, new \Httpful\Handlers\JsonHandler(array('decode_as_array' => true))); 18 18 - 19 19 - $response = Request::get($uri) 20 20 - ->expectsType('json') 21 21 - ->sendIt(); 22 22 - 23 23 - // Print out the event details 24 24 - echo "The event {$response->body['event']} will take place on {$response->body['event_start']}\n";

-13

externals/httpful/examples/twitter.php

reviewed

··· 1 1 - <?php 2 2 - require(__DIR__ . '/../bootstrap.php'); 3 3 - 4 4 - $query = urlencode('#PHP'); 5 5 - $response = \Httpful\Request::get("http://search.twitter.com/search.json?q=$query")->send(); 6 6 - 7 7 - if (!$response->hasErrors()) { 8 8 - foreach ($response->body->results as $tweet) { 9 9 - echo "@{$tweet->from_user} tweets \"{$tweet->text}\"\n"; 10 10 - } 11 11 - } else { 12 12 - echo "Uh oh. Twitter gave us the old {$response->code} status.\n"; 13 13 - }

-97

externals/httpful/src/Httpful/Bootstrap.php

reviewed

··· 1 1 - <?php 2 2 - 3 3 - namespace Httpful; 4 4 - 5 5 - /** 6 6 - * Bootstrap class that facilitates autoloading. A naive 7 7 - * PSR-0 autoloader. 8 8 - * 9 9 - * @author Nate Good <me@nategood.com> 10 10 - */ 11 11 - class Bootstrap 12 12 - { 13 13 - 14 14 - const DIR_GLUE = DIRECTORY_SEPARATOR; 15 15 - const NS_GLUE = '\\'; 16 16 - 17 17 - public static $registered = false; 18 18 - 19 19 - /** 20 20 - * Register the autoloader and any other setup needed 21 21 - */ 22 22 - public static function init() 23 23 - { 24 24 - spl_autoload_register(array('\Httpful\Bootstrap', 'autoload')); 25 25 - self::registerHandlers(); 26 26 - } 27 27 - 28 28 - /** 29 29 - * The autoload magic (PSR-0 style) 30 30 - * 31 31 - * @param string $classname 32 32 - */ 33 33 - public static function autoload($classname) 34 34 - { 35 35 - self::_autoload(dirname(dirname(__FILE__)), $classname); 36 36 - } 37 37 - 38 38 - /** 39 39 - * Register the autoloader and any other setup needed 40 40 - */ 41 41 - public static function pharInit() 42 42 - { 43 43 - spl_autoload_register(array('\Httpful\Bootstrap', 'pharAutoload')); 44 44 - self::registerHandlers(); 45 45 - } 46 46 - 47 47 - /** 48 48 - * Phar specific autoloader 49 49 - * 50 50 - * @param string $classname 51 51 - */ 52 52 - public static function pharAutoload($classname) 53 53 - { 54 54 - self::_autoload('phar://httpful.phar', $classname); 55 55 - } 56 56 - 57 57 - /** 58 58 - * @param string base 59 59 - * @param string classname 60 60 - */ 61 61 - private static function _autoload($base, $classname) 62 62 - { 63 63 - $parts = explode(self::NS_GLUE, $classname); 64 64 - $path = $base . self::DIR_GLUE . implode(self::DIR_GLUE, $parts) . '.php'; 65 65 - 66 66 - if (file_exists($path)) { 67 67 - require_once($path); 68 68 - } 69 69 - } 70 70 - /** 71 71 - * Register default mime handlers. Is idempotent. 72 72 - */ 73 73 - public static function registerHandlers() 74 74 - { 75 75 - if (self::$registered === true) { 76 76 - return; 77 77 - } 78 78 - 79 79 - // @todo check a conf file to load from that instead of 80 80 - // hardcoding into the library? 81 81 - $handlers = array( 82 82 - \Httpful\Mime::JSON => new \Httpful\Handlers\JsonHandler(), 83 83 - \Httpful\Mime::XML => new \Httpful\Handlers\XmlHandler(), 84 84 - \Httpful\Mime::FORM => new \Httpful\Handlers\FormHandler(), 85 85 - \Httpful\Mime::CSV => new \Httpful\Handlers\CsvHandler(), 86 86 - ); 87 87 - 88 88 - foreach ($handlers as $mime => $handler) { 89 89 - // Don't overwrite if the handler has already been registered 90 90 - if (Httpful::hasParserRegistered($mime)) 91 91 - continue; 92 92 - Httpful::register($mime, $handler); 93 93 - } 94 94 - 95 95 - self::$registered = true; 96 96 - } 97 97 - }

-7

externals/httpful/src/Httpful/Exception/ConnectionErrorException.php

reviewed

··· 1 1 - <?php 2 2 - 3 3 - namespace Httpful\Exception; 4 4 - 5 5 - class ConnectionErrorException extends \Exception 6 6 - { 7 7 - }

-50

externals/httpful/src/Httpful/Handlers/CsvHandler.php

reviewed

··· 1 1 - <?php 2 2 - /** 3 3 - * Mime Type: text/csv 4 4 - * @author Raja Kapur <rajak@twistedthrottle.com> 5 5 - */ 6 6 - 7 7 - namespace Httpful\Handlers; 8 8 - 9 9 - class CsvHandler extends MimeHandlerAdapter 10 10 - { 11 11 - /** 12 12 - * @param string $body 13 13 - * @return mixed 14 14 - */ 15 15 - public function parse($body) 16 16 - { 17 17 - if (empty($body)) 18 18 - return null; 19 19 - 20 20 - $parsed = array(); 21 21 - $fp = fopen('data://text/plain;base64,' . base64_encode($body), 'r'); 22 22 - while (($r = fgetcsv($fp)) !== FALSE) { 23 23 - $parsed[] = $r; 24 24 - } 25 25 - 26 26 - if (empty($parsed)) 27 27 - throw new \Exception("Unable to parse response as CSV"); 28 28 - return $parsed; 29 29 - } 30 30 - 31 31 - /** 32 32 - * @param mixed $payload 33 33 - * @return string 34 34 - */ 35 35 - public function serialize($payload) 36 36 - { 37 37 - $fp = fopen('php://temp/maxmemory:'. (6*1024*1024), 'r+'); 38 38 - $i = 0; 39 39 - foreach ($payload as $fields) { 40 40 - if($i++ == 0) { 41 41 - fputcsv($fp, array_keys($fields)); 42 42 - } 43 43 - fputcsv($fp, $fields); 44 44 - } 45 45 - rewind($fp); 46 46 - $data = stream_get_contents($fp); 47 47 - fclose($fp); 48 48 - return $data; 49 49 - } 50 50 - }

-30

externals/httpful/src/Httpful/Handlers/FormHandler.php

reviewed

··· 1 1 - <?php 2 2 - /** 3 3 - * Mime Type: application/x-www-urlencoded 4 4 - * @author Nathan Good <me@nategood.com> 5 5 - */ 6 6 - 7 7 - namespace Httpful\Handlers; 8 8 - 9 9 - class FormHandler extends MimeHandlerAdapter 10 10 - { 11 11 - /** 12 12 - * @param string $body 13 13 - * @return mixed 14 14 - */ 15 15 - public function parse($body) 16 16 - { 17 17 - $parsed = array(); 18 18 - parse_str($body, $parsed); 19 19 - return $parsed; 20 20 - } 21 21 - 22 22 - /** 23 23 - * @param mixed $payload 24 24 - * @return string 25 25 - */ 26 26 - public function serialize($payload) 27 27 - { 28 28 - return http_build_query($payload, null, '&'); 29 29 - } 30 30 - }

-40

externals/httpful/src/Httpful/Handlers/JsonHandler.php

reviewed

··· 1 1 - <?php 2 2 - /** 3 3 - * Mime Type: application/json 4 4 - * @author Nathan Good <me@nategood.com> 5 5 - */ 6 6 - 7 7 - namespace Httpful\Handlers; 8 8 - 9 9 - class JsonHandler extends MimeHandlerAdapter 10 10 - { 11 11 - private $decode_as_array = false; 12 12 - 13 13 - public function init(array $args) 14 14 - { 15 15 - $this->decode_as_array = !!(array_key_exists('decode_as_array', $args) ? $args['decode_as_array'] : false); 16 16 - } 17 17 - 18 18 - /** 19 19 - * @param string $body 20 20 - * @return mixed 21 21 - */ 22 22 - public function parse($body) 23 23 - { 24 24 - if (empty($body)) 25 25 - return null; 26 26 - $parsed = json_decode($body, $this->decode_as_array); 27 27 - if (is_null($parsed)) 28 28 - throw new \Exception("Unable to parse response as JSON"); 29 29 - return $parsed; 30 30 - } 31 31 - 32 32 - /** 33 33 - * @param mixed $payload 34 34 - * @return string 35 35 - */ 36 36 - public function serialize($payload) 37 37 - { 38 38 - return json_encode($payload); 39 39 - } 40 40 - }

-43

externals/httpful/src/Httpful/Handlers/MimeHandlerAdapter.php

reviewed

··· 1 1 - <?php 2 2 - 3 3 - /** 4 4 - * Handlers are used to parse and serialize payloads for specific 5 5 - * mime types. You can register a custom handler via the register 6 6 - * method. You can also override a default parser in this way. 7 7 - */ 8 8 - 9 9 - namespace Httpful\Handlers; 10 10 - 11 11 - class MimeHandlerAdapter 12 12 - { 13 13 - public function __construct(array $args = array()) 14 14 - { 15 15 - $this->init($args); 16 16 - } 17 17 - 18 18 - /** 19 19 - * Initial setup of 20 20 - * @param array $args 21 21 - */ 22 22 - public function init(array $args) 23 23 - { 24 24 - } 25 25 - 26 26 - /** 27 27 - * @param string $body 28 28 - * @return mixed 29 29 - */ 30 30 - public function parse($body) 31 31 - { 32 32 - return $body; 33 33 - } 34 34 - 35 35 - /** 36 36 - * @param mixed $payload 37 37 - * @return string 38 38 - */ 39 39 - function serialize($payload) 40 40 - { 41 41 - return (string) $payload; 42 42 - } 43 43 - }

-44

externals/httpful/src/Httpful/Handlers/README.md

reviewed

··· 1 1 - # Handlers 2 2 - 3 3 - Handlers are simple classes that are used to parse response bodies and serialize request payloads. All Handlers must extend the `MimeHandlerAdapter` class and implement two methods: `serialize($payload)` and `parse($response)`. Let's build a very basic Handler to register for the `text/csv` mime type. 4 4 - 5 5 - <?php 6 6 - 7 7 - class SimpleCsvHandler extends \Httpful\Handlers\MimeHandlerAdapter 8 8 - { 9 9 - /** 10 10 - * Takes a response body, and turns it into 11 11 - * a two dimensional array. 12 12 - * 13 13 - * @param string $body 14 14 - * @return mixed 15 15 - */ 16 16 - public function parse($body) 17 17 - { 18 18 - return str_getcsv($body); 19 19 - } 20 20 - 21 21 - /** 22 22 - * Takes a two dimensional array and turns it 23 23 - * into a serialized string to include as the 24 24 - * body of a request 25 25 - * 26 26 - * @param mixed $payload 27 27 - * @return string 28 28 - */ 29 29 - public function serialize($payload) 30 30 - { 31 31 - $serialized = ''; 32 32 - foreach ($payload as $line) { 33 33 - $serialized .= '"' . implode('","', $line) . '"' . "\n"; 34 34 - } 35 35 - return $serialized; 36 36 - } 37 37 - } 38 38 - 39 39 - 40 40 - Finally, you must register this handler for a particular mime type. 41 41 - 42 42 - Httpful::register('text/csv', new SimpleCsvHandler()); 43 43 - 44 44 - After this registering the handler in your source code, by default, any responses with a mime type of text/csv should be parsed by this handler.

-15

externals/httpful/src/Httpful/Handlers/XHtmlHandler.php

reviewed

··· 1 1 - <?php 2 2 - /** 3 3 - * Mime Type: text/html 4 4 - * Mime Type: application/html+xml 5 5 - * 6 6 - * @author Nathan Good <me@nategood.com> 7 7 - */ 8 8 - 9 9 - namespace Httpful\Handlers; 10 10 - 11 11 - class XHtmlHandler extends MimeHandlerAdapter 12 12 - { 13 13 - // @todo add html specific parsing 14 14 - // see DomDocument::load http://docs.php.net/manual/en/domdocument.loadhtml.php 15 15 - }

-120

externals/httpful/src/Httpful/Handlers/XmlHandler.php

reviewed

··· 1 1 - <?php 2 2 - /** 3 3 - * Mime Type: application/xml 4 4 - * 5 5 - * @author Zack Douglas <zack@zackerydouglas.info> 6 6 - * @author Nathan Good <me@nategood.com> 7 7 - */ 8 8 - 9 9 - namespace Httpful\Handlers; 10 10 - 11 11 - class XmlHandler extends MimeHandlerAdapter 12 12 - { 13 13 - /** 14 14 - * @var string $namespace xml namespace to use with simple_load_string 15 15 - */ 16 16 - private $namespace; 17 17 - 18 18 - /** 19 19 - * @var int $libxml_opts see http://www.php.net/manual/en/libxml.constants.php 20 20 - */ 21 21 - private $libxml_opts; 22 22 - 23 23 - /** 24 24 - * @param array $conf sets configuration options 25 25 - */ 26 26 - public function __construct(array $conf = array()) 27 27 - { 28 28 - $this->namespace = isset($conf['namespace']) ? $conf['namespace'] : ''; 29 29 - $this->libxml_opts = isset($conf['libxml_opts']) ? $conf['libxml_opts'] : 0; 30 30 - } 31 31 - 32 32 - /** 33 33 - * @param string $body 34 34 - * @return mixed 35 35 - * @throws Exception if unable to parse 36 36 - */ 37 37 - public function parse($body) 38 38 - { 39 39 - if (empty($body)) 40 40 - return null; 41 41 - $parsed = simplexml_load_string($body, null, $this->libxml_opts, $this->namespace); 42 42 - if ($parsed === false) 43 43 - throw new \Exception("Unable to parse response as XML"); 44 44 - return $parsed; 45 45 - } 46 46 - 47 47 - /** 48 48 - * @param mixed $payload 49 49 - * @return string 50 50 - * @throws Exception if unable to serialize 51 51 - */ 52 52 - public function serialize($payload) 53 53 - { 54 54 - list($_, $dom) = $this->_future_serializeAsXml($payload); 55 55 - return $dom->saveXml(); 56 56 - } 57 57 - 58 58 - /** 59 59 - * @author Zack Douglas <zack@zackerydouglas.info> 60 60 - */ 61 61 - private function _future_serializeAsXml($value, $node = null, $dom = null) 62 62 - { 63 63 - if (!$dom) { 64 64 - $dom = new \DOMDocument; 65 65 - } 66 66 - if (!$node) { 67 67 - if (!is_object($value)) { 68 68 - $node = $dom->createElement('response'); 69 69 - $dom->appendChild($node); 70 70 - } else { 71 71 - $node = $dom; 72 72 - } 73 73 - } 74 74 - if (is_object($value)) { 75 75 - $objNode = $dom->createElement(get_class($value)); 76 76 - $node->appendChild($objNode); 77 77 - $this->_future_serializeObjectAsXml($value, $objNode, $dom); 78 78 - } else if (is_array($value)) { 79 79 - $arrNode = $dom->createElement('array'); 80 80 - $node->appendChild($arrNode); 81 81 - $this->_future_serializeArrayAsXml($value, $arrNode, $dom); 82 82 - } else if (is_bool($value)) { 83 83 - $node->appendChild($dom->createTextNode($value?'TRUE':'FALSE')); 84 84 - } else { 85 85 - $node->appendChild($dom->createTextNode($value)); 86 86 - } 87 87 - return array($node, $dom); 88 88 - } 89 89 - /** 90 90 - * @author Zack Douglas <zack@zackerydouglas.info> 91 91 - */ 92 92 - private function _future_serializeArrayAsXml($value, &$parent, &$dom) 93 93 - { 94 94 - foreach ($value as $k => &$v) { 95 95 - $n = $k; 96 96 - if (is_numeric($k)) { 97 97 - $n = "child-{$n}"; 98 98 - } 99 99 - $el = $dom->createElement($n); 100 100 - $parent->appendChild($el); 101 101 - $this->_future_serializeAsXml($v, $el, $dom); 102 102 - } 103 103 - return array($parent, $dom); 104 104 - } 105 105 - /** 106 106 - * @author Zack Douglas <zack@zackerydouglas.info> 107 107 - */ 108 108 - private function _future_serializeObjectAsXml($value, &$parent, &$dom) 109 109 - { 110 110 - $refl = new \ReflectionObject($value); 111 111 - foreach ($refl->getProperties() as $pr) { 112 112 - if (!$pr->isPrivate()) { 113 113 - $el = $dom->createElement($pr->getName()); 114 114 - $parent->appendChild($el); 115 115 - $this->_future_serializeAsXml($pr->getValue($value), $el, $dom); 116 116 - } 117 117 - } 118 118 - return array($parent, $dom); 119 119 - } 120 120 - }

-86

externals/httpful/src/Httpful/Http.php

reviewed

··· 1 1 - <?php 2 2 - 3 3 - namespace Httpful; 4 4 - 5 5 - /** 6 6 - * @author Nate Good <me@nategood.com> 7 7 - */ 8 8 - class Http 9 9 - { 10 10 - const HEAD = 'HEAD'; 11 11 - const GET = 'GET'; 12 12 - const POST = 'POST'; 13 13 - const PUT = 'PUT'; 14 14 - const DELETE = 'DELETE'; 15 15 - const PATCH = 'PATCH'; 16 16 - const OPTIONS = 'OPTIONS'; 17 17 - const TRACE = 'TRACE'; 18 18 - 19 19 - /** 20 20 - * @return array of HTTP method strings 21 21 - */ 22 22 - public static function safeMethods() 23 23 - { 24 24 - return array(self::HEAD, self::GET, self::OPTIONS, self::TRACE); 25 25 - } 26 26 - 27 27 - /** 28 28 - * @return bool 29 29 - * @param string HTTP method 30 30 - */ 31 31 - public static function isSafeMethod($method) 32 32 - { 33 33 - return in_array($method, self::safeMethods()); 34 34 - } 35 35 - 36 36 - /** 37 37 - * @return bool 38 38 - * @param string HTTP method 39 39 - */ 40 40 - public static function isUnsafeMethod($method) 41 41 - { 42 42 - return !in_array($method, self::safeMethods()); 43 43 - } 44 44 - 45 45 - /** 46 46 - * @return array list of (always) idempotent HTTP methods 47 47 - */ 48 48 - public static function idempotentMethods() 49 49 - { 50 50 - // Though it is possible to be idempotent, POST 51 51 - // is not guarunteed to be, and more often than 52 52 - // not, it is not. 53 53 - return array(self::HEAD, self::GET, self::PUT, self::DELETE, self::OPTIONS, self::TRACE, self::PATCH); 54 54 - } 55 55 - 56 56 - /** 57 57 - * @return bool 58 58 - * @param string HTTP method 59 59 - */ 60 60 - public static function isIdempotent($method) 61 61 - { 62 62 - return in_array($method, self::safeidempotentMethodsMethods()); 63 63 - } 64 64 - 65 65 - /** 66 66 - * @return bool 67 67 - * @param string HTTP method 68 68 - */ 69 69 - public static function isNotIdempotent($method) 70 70 - { 71 71 - return !in_array($method, self::idempotentMethods()); 72 72 - } 73 73 - 74 74 - /** 75 75 - * @deprecated Technically anything *can* have a body, 76 76 - * they just don't have semantic meaning. So say's Roy 77 77 - * http://tech.groups.yahoo.com/group/rest-discuss/message/9962 78 78 - * 79 79 - * @return array of HTTP method strings 80 80 - */ 81 81 - public static function canHaveBody() 82 82 - { 83 83 - return array(self::POST, self::PUT, self::PATCH, self::OPTIONS); 84 84 - } 85 85 - 86 86 - }

-46

externals/httpful/src/Httpful/Httpful.php

reviewed

··· 1 1 - <?php 2 2 - 3 3 - namespace Httpful; 4 4 - 5 5 - class Httpful { 6 6 - const VERSION = '0.1.7'; 7 7 - 8 8 - private static $mimeRegistrar = array(); 9 9 - private static $default = null; 10 10 - 11 11 - /** 12 12 - * @param string $mime_type 13 13 - * @param MimeHandlerAdapter $handler 14 14 - */ 15 15 - public static function register($mimeType, \Httpful\Handlers\MimeHandlerAdapter $handler) 16 16 - { 17 17 - self::$mimeRegistrar[$mimeType] = $handler; 18 18 - } 19 19 - 20 20 - /** 21 21 - * @param string $mime_type defaults to MimeHandlerAdapter 22 22 - * @return MimeHandlerAdapter 23 23 - */ 24 24 - public static function get($mimeType = null) 25 25 - { 26 26 - if (isset(self::$mimeRegistrar[$mimeType])) { 27 27 - return self::$mimeRegistrar[$mimeType]; 28 28 - } 29 29 - 30 30 - if (empty(self::$default)) { 31 31 - self::$default = new \Httpful\Handlers\MimeHandlerAdapter(); 32 32 - } 33 33 - 34 34 - return self::$default; 35 35 - } 36 36 - 37 37 - /** 38 38 - * Does this particular Mime Type have a parser registered 39 39 - * for it? 40 40 - * @return bool 41 41 - */ 42 42 - public static function hasParserRegistered($mimeType) 43 43 - { 44 44 - return isset(self::$mimeRegistrar[$mimeType]); 45 45 - } 46 46 - }

-58

externals/httpful/src/Httpful/Mime.php

reviewed

··· 1 1 - <?php 2 2 - 3 3 - namespace Httpful; 4 4 - 5 5 - /** 6 6 - * Class to organize the Mime stuff a bit more 7 7 - * @author Nate Good <me@nategood.com> 8 8 - */ 9 9 - class Mime 10 10 - { 11 11 - const JSON = 'application/json'; 12 12 - const XML = 'application/xml'; 13 13 - const XHTML = 'application/html+xml'; 14 14 - const FORM = 'application/x-www-form-urlencoded'; 15 15 - const PLAIN = 'text/plain'; 16 16 - const JS = 'text/javascript'; 17 17 - const HTML = 'text/html'; 18 18 - const YAML = 'application/x-yaml'; 19 19 - const CSV = 'text/csv'; 20 20 - 21 21 - /** 22 22 - * Map short name for a mime type 23 23 - * to a full proper mime type 24 24 - */ 25 25 - public static $mimes = array( 26 26 - 'json' => self::JSON, 27 27 - 'xml' => self::XML, 28 28 - 'form' => self::FORM, 29 29 - 'plain' => self::PLAIN, 30 30 - 'text' => self::PLAIN, 31 31 - 'html' => self::HTML, 32 32 - 'xhtml' => self::XHTML, 33 33 - 'js' => self::JS, 34 34 - 'javascript'=> self::JS, 35 35 - 'yaml' => self::YAML, 36 36 - 'csv' => self::CSV, 37 37 - ); 38 38 - 39 39 - /** 40 40 - * Get the full Mime Type name from a "short name". 41 41 - * Returns the short if no mapping was found. 42 42 - * @return string full mime type (e.g. application/json) 43 43 - * @param string common name for mime type (e.g. json) 44 44 - */ 45 45 - public static function getFullMime($short_name) 46 46 - { 47 47 - return array_key_exists($short_name, self::$mimes) ? self::$mimes[$short_name] : $short_name; 48 48 - } 49 49 - 50 50 - /** 51 51 - * @return bool 52 52 - * @param string $short_name 53 53 - */ 54 54 - public static function supportsMimeType($short_name) 55 55 - { 56 56 - return array_key_exists($short_name, self::$mimes); 57 57 - } 58 58 - }

-984

externals/httpful/src/Httpful/Request.php

reviewed

··· 1 1 - <?php 2 2 - 3 3 - namespace Httpful; 4 4 - 5 5 - use Httpful\Exception\ConnectionErrorException; 6 6 - 7 7 - /** 8 8 - * Clean, simple class for sending HTTP requests 9 9 - * in PHP. 10 10 - * 11 11 - * There is an emphasis of readability without loosing concise 12 12 - * syntax. As such, you will notice that the library lends 13 13 - * itself very nicely to "chaining". You will see several "alias" 14 14 - * methods: more readable method definitions that wrap 15 15 - * their more concise counterparts. You will also notice 16 16 - * no public constructor. This two adds to the readability 17 17 - * and "chainabilty" of the library. 18 18 - * 19 19 - * @author Nate Good <me@nategood.com> 20 20 - */ 21 21 - class Request 22 22 - { 23 23 - 24 24 - // Option constants 25 25 - const SERIALIZE_PAYLOAD_NEVER = 0; 26 26 - const SERIALIZE_PAYLOAD_ALWAYS = 1; 27 27 - const SERIALIZE_PAYLOAD_SMART = 2; 28 28 - 29 29 - const MAX_REDIRECTS_DEFAULT = 25; 30 30 - 31 31 - public $uri, 32 32 - $method = Http::GET, 33 33 - $headers = array(), 34 34 - $raw_headers = '', 35 35 - $strict_ssl = false, 36 36 - $content_type, 37 37 - $expected_type, 38 38 - $additional_curl_opts = array(), 39 39 - $auto_parse = true, 40 40 - $serialize_payload_method = self::SERIALIZE_PAYLOAD_SMART, 41 41 - $username, 42 42 - $password, 43 43 - $serialized_payload, 44 44 - $payload, 45 45 - $parse_callback, 46 46 - $error_callback, 47 47 - $follow_redirects = false, 48 48 - $max_redirects = self::MAX_REDIRECTS_DEFAULT, 49 49 - $payload_serializers = array(); 50 50 - 51 51 - // Options 52 52 - // private $_options = array( 53 53 - // 'serialize_payload_method' => self::SERIALIZE_PAYLOAD_SMART 54 54 - // 'auto_parse' => true 55 55 - // ); 56 56 - 57 57 - // Curl Handle 58 58 - public $_ch, 59 59 - $_debug; 60 60 - 61 61 - // Template Request object 62 62 - private static $_template; 63 63 - 64 64 - /** 65 65 - * We made the constructor private to force the factory style. This was 66 66 - * done to keep the syntax cleaner and better the support the idea of 67 67 - * "default templates". Very basic and flexible as it is only intended 68 68 - * for internal use. 69 69 - * @param array $attrs hash of initial attribute values 70 70 - */ 71 71 - private function __construct($attrs = null) 72 72 - { 73 73 - if (!is_array($attrs)) return; 74 74 - foreach ($attrs as $attr => $value) { 75 75 - $this->$attr = $value; 76 76 - } 77 77 - } 78 78 - 79 79 - // Defaults Management 80 80 - 81 81 - /** 82 82 - * Let's you configure default settings for this 83 83 - * class from a template Request object. Simply construct a 84 84 - * Request object as much as you want to and then pass it to 85 85 - * this method. It will then lock in those settings from 86 86 - * that template object. 87 87 - * The most common of which may be default mime 88 88 - * settings or strict ssl settings. 89 89 - * Again some slight memory overhead incurred here but in the grand 90 90 - * scheme of things as it typically only occurs once 91 91 - * @param Request $template 92 92 - */ 93 93 - public static function ini(Request $template) 94 94 - { 95 95 - self::$_template = clone $template; 96 96 - } 97 97 - 98 98 - /** 99 99 - * Reset the default template back to the 100 100 - * library defaults. 101 101 - */ 102 102 - public static function resetIni() 103 103 - { 104 104 - self::_initializeDefaults(); 105 105 - } 106 106 - 107 107 - /** 108 108 - * Get default for a value based on the template object 109 109 - * @return mixed default value 110 110 - * @param string|null $attr Name of attribute (e.g. mime, headers) 111 111 - * if null just return the whole template object; 112 112 - */ 113 113 - public static function d($attr) 114 114 - { 115 115 - return isset($attr) ? self::$_template->$attr : self::$_template; 116 116 - } 117 117 - 118 118 - // Accessors 119 119 - 120 120 - /** 121 121 - * @return bool does the request have a timeout? 122 122 - */ 123 123 - public function hasTimeout() 124 124 - { 125 125 - return isset($this->timeout); 126 126 - } 127 127 - 128 128 - /** 129 129 - * @return bool has the internal curl request been initialized? 130 130 - */ 131 131 - public function hasBeenInitialized() 132 132 - { 133 133 - return isset($this->_ch); 134 134 - } 135 135 - 136 136 - /** 137 137 - * @return bool Is this request setup for basic auth? 138 138 - */ 139 139 - public function hasBasicAuth() 140 140 - { 141 141 - return isset($this->password) && isset($this->username); 142 142 - } 143 143 - 144 144 - /** 145 145 - * @return bool Is this request setup for digest auth? 146 146 - */ 147 147 - public function hasDigestAuth() 148 148 - { 149 149 - return isset($this->password) && isset($this->username) && $this->additional_curl_opts['CURLOPT_HTTPAUTH'] = CURLAUTH_DIGEST; 150 150 - } 151 151 - 152 152 - /** 153 153 - * Specify a HTTP timeout 154 154 - * @return Request $this 155 155 - * @param |int $timeout seconds to timeout the HTTP call 156 156 - */ 157 157 - public function timeout($timeout) 158 158 - { 159 159 - $this->timeout = $timeout; 160 160 - return $this; 161 161 - } 162 162 - 163 163 - /** 164 164 - * If the response is a 301 or 302 redirect, automatically 165 165 - * send off another request to that location 166 166 - * @return Request $this 167 167 - * @param bool|int $follow follow or not to follow or maximal number of redirects 168 168 - */ 169 169 - public function followRedirects($follow = true) 170 170 - { 171 171 - $this->max_redirects = $follow === true ? self::MAX_REDIRECTS_DEFAULT : max(0, $follow); 172 172 - $this->follow_redirects = (bool) $follow; 173 173 - return $this; 174 174 - } 175 175 - 176 176 - /** 177 177 - * @return Request $this 178 178 - * @see Request::followRedirects() 179 179 - */ 180 180 - public function doNotFollowRedirects() 181 181 - { 182 182 - return $this->followRedirects(false); 183 183 - } 184 184 - 185 185 - /** 186 186 - * Actually send off the request, and parse the response 187 187 - * @return string|associative array of parsed results 188 188 - * @throws ConnectionErrorException when unable to parse or communicate w server 189 189 - */ 190 190 - public function send() 191 191 - { 192 192 - if (!$this->hasBeenInitialized()) 193 193 - $this->_curlPrep(); 194 194 - 195 195 - $result = curl_exec($this->_ch); 196 196 - 197 197 - if ($result === false) { 198 198 - $this->_error(curl_error($this->_ch)); 199 199 - throw new ConnectionErrorException('Unable to connect.'); 200 200 - } 201 201 - 202 202 - $info = curl_getinfo($this->_ch); 203 203 - $response = explode("\r\n\r\n", $result, 2 + $info['redirect_count']); 204 204 - 205 205 - $body = array_pop($response); 206 206 - $headers = array_pop($response); 207 207 - 208 208 - return new Response($body, $headers, $this); 209 209 - } 210 210 - public function sendIt() 211 211 - { 212 212 - return $this->send(); 213 213 - } 214 214 - 215 215 - // Setters 216 216 - 217 217 - /** 218 218 - * @return Request this 219 219 - * @param string $uri 220 220 - */ 221 221 - public function uri($uri) 222 222 - { 223 223 - $this->uri = $uri; 224 224 - return $this; 225 225 - } 226 226 - 227 227 - /** 228 228 - * User Basic Auth. 229 229 - * Only use when over SSL/TSL/HTTPS. 230 230 - * @return Request this 231 231 - * @param string $username 232 232 - * @param string $password 233 233 - */ 234 234 - public function basicAuth($username, $password) 235 235 - { 236 236 - $this->username = $username; 237 237 - $this->password = $password; 238 238 - return $this; 239 239 - } 240 240 - // @alias of basicAuth 241 241 - public function authenticateWith($username, $password) 242 242 - { 243 243 - return $this->basicAuth($username, $password); 244 244 - } 245 245 - // @alias of basicAuth 246 246 - public function authenticateWithBasic($username, $password) 247 247 - { 248 248 - return $this->basicAuth($username, $password); 249 249 - } 250 250 - 251 251 - /** 252 252 - * User Digest Auth. 253 253 - * @return Request this 254 254 - * @param string $username 255 255 - * @param string $password 256 256 - */ 257 257 - public function digestAuth($username, $password) 258 258 - { 259 259 - $this->addOnCurlOption(CURLOPT_HTTPAUTH, CURLAUTH_DIGEST); 260 260 - return $this->basicAuth($username, $password); 261 261 - } 262 262 - 263 263 - // @alias of digestAuth 264 264 - public function authenticateWithDigest($username, $password) 265 265 - { 266 266 - return $this->digestAuth($username, $password); 267 267 - } 268 268 - 269 269 - /** 270 270 - * @return is this request setup for client side cert? 271 271 - */ 272 272 - public function hasClientSideCert() { 273 273 - return isset($this->client_cert) && isset($this->client_key); 274 274 - } 275 275 - 276 276 - /** 277 277 - * Use Client Side Cert Authentication 278 278 - * @return Response $this 279 279 - * @param string $key file path to client key 280 280 - * @param string $cert file path to client cert 281 281 - * @param string $passphrase for client key 282 282 - * @param string $encoding default PEM 283 283 - */ 284 284 - public function clientSideCert($cert, $key, $passphrase = null, $encoding = 'PEM') 285 285 - { 286 286 - $this->client_cert = $cert; 287 287 - $this->client_key = $key; 288 288 - $this->client_passphrase = $passphrase; 289 289 - $this->client_encoding = $encoding; 290 290 - 291 291 - return $this; 292 292 - } 293 293 - // @alias of basicAuth 294 294 - public function authenticateWithCert($cert, $key, $passphrase = null, $encoding = 'PEM') 295 295 - { 296 296 - return $this->clientSideCert($cert, $key, $passphrase, $encoding); 297 297 - } 298 298 - 299 299 - /** 300 300 - * Set the body of the request 301 301 - * @return Request this 302 302 - * @param mixed $payload 303 303 - * @param string $mimeType 304 304 - */ 305 305 - public function body($payload, $mimeType = null) 306 306 - { 307 307 - $this->mime($mimeType); 308 308 - $this->payload = $payload; 309 309 - // Iserntentially don't call _serializePayload yet. Wait until 310 310 - // we actually send off the request to convert payload to string. 311 311 - // At that time, the `serialized_payload` is set accordingly. 312 312 - return $this; 313 313 - } 314 314 - 315 315 - /** 316 316 - * Helper function to set the Content type and Expected as same in 317 317 - * one swoop 318 318 - * @return Request this 319 319 - * @param string $mime mime type to use for content type and expected return type 320 320 - */ 321 321 - public function mime($mime) 322 322 - { 323 323 - if (empty($mime)) return $this; 324 324 - $this->content_type = $this->expected_type = Mime::getFullMime($mime); 325 325 - return $this; 326 326 - } 327 327 - // @alias of mime 328 328 - public function sendsAndExpectsType($mime) 329 329 - { 330 330 - return $this->mime($mime); 331 331 - } 332 332 - // @alias of mime 333 333 - public function sendsAndExpects($mime) 334 334 - { 335 335 - return $this->mime($mime); 336 336 - } 337 337 - 338 338 - /** 339 339 - * Set the method. Shouldn't be called often as the preferred syntax 340 340 - * for instantiation is the method specific factory methods. 341 341 - * @return Request this 342 342 - * @param string $method 343 343 - */ 344 344 - public function method($method) 345 345 - { 346 346 - if (empty($method)) return $this; 347 347 - $this->method = $method; 348 348 - return $this; 349 349 - } 350 350 - 351 351 - /** 352 352 - * @return Request this 353 353 - * @param string $mime 354 354 - */ 355 355 - public function expects($mime) 356 356 - { 357 357 - if (empty($mime)) return $this; 358 358 - $this->expected_type = Mime::getFullMime($mime); 359 359 - return $this; 360 360 - } 361 361 - // @alias of expects 362 362 - public function expectsType($mime) 363 363 - { 364 364 - return $this->expects($mime); 365 365 - } 366 366 - 367 367 - /** 368 368 - * @return Request this 369 369 - * @param string $mime 370 370 - */ 371 371 - public function contentType($mime) 372 372 - { 373 373 - if (empty($mime)) return $this; 374 374 - $this->content_type = Mime::getFullMime($mime); 375 375 - return $this; 376 376 - } 377 377 - // @alias of contentType 378 378 - public function sends($mime) 379 379 - { 380 380 - return $this->contentType($mime); 381 381 - } 382 382 - // @alias of contentType 383 383 - public function sendsType($mime) 384 384 - { 385 385 - return $this->contentType($mime); 386 386 - } 387 387 - 388 388 - /** 389 389 - * Do we strictly enforce SSL verification? 390 390 - * @return Request this 391 391 - * @param bool $strict 392 392 - */ 393 393 - public function strictSSL($strict) 394 394 - { 395 395 - $this->strict_ssl = $strict; 396 396 - return $this; 397 397 - } 398 398 - public function withoutStrictSSL() 399 399 - { 400 400 - return $this->strictSSL(false); 401 401 - } 402 402 - public function withStrictSSL() 403 403 - { 404 404 - return $this->strictSSL(true); 405 405 - } 406 406 - 407 407 - /** 408 408 - * Determine how/if we use the built in serialization by 409 409 - * setting the serialize_payload_method 410 410 - * The default (SERIALIZE_PAYLOAD_SMART) is... 411 411 - * - if payload is not a scalar (object/array) 412 412 - * use the appropriate serialize method according to 413 413 - * the Content-Type of this request. 414 414 - * - if the payload IS a scalar (int, float, string, bool) 415 415 - * than just return it as is. 416 416 - * When this option is set SERIALIZE_PAYLOAD_ALWAYS, 417 417 - * it will always use the appropriate 418 418 - * serialize option regardless of whether payload is scalar or not 419 419 - * When this option is set SERIALIZE_PAYLOAD_NEVER, 420 420 - * it will never use any of the serialization methods. 421 421 - * Really the only use for this is if you want the serialize methods 422 422 - * to handle strings or not (e.g. Blah is not valid JSON, but "Blah" 423 423 - * is). Forcing the serialization helps prevent that kind of error from 424 424 - * happening. 425 425 - * @return Request $this 426 426 - * @param int $mode 427 427 - */ 428 428 - public function serializePayload($mode) 429 429 - { 430 430 - $this->serialize_payload_method = $mode; 431 431 - return $this; 432 432 - } 433 433 - 434 434 - /** 435 435 - * @see Request::serializePayload() 436 436 - * @return Request 437 437 - */ 438 438 - public function neverSerializePayload() 439 439 - { 440 440 - return $this->serializePayload(self::SERIALIZE_PAYLOAD_NEVER); 441 441 - } 442 442 - 443 443 - /** 444 444 - * This method is the default behavior 445 445 - * @see Request::serializePayload() 446 446 - * @return Request 447 447 - */ 448 448 - public function smartSerializePayload() 449 449 - { 450 450 - return $this->serializePayload(self::SERIALIZE_PAYLOAD_SMART); 451 451 - } 452 452 - 453 453 - /** 454 454 - * @see Request::serializePayload() 455 455 - * @return Request 456 456 - */ 457 457 - public function alwaysSerializePayload() 458 458 - { 459 459 - return $this->serializePayload(self::SERIALIZE_PAYLOAD_ALWAYS); 460 460 - } 461 461 - 462 462 - /** 463 463 - * Add an additional header to the request 464 464 - * Can also use the cleaner syntax of 465 465 - * $Request->withMyHeaderName($my_value); 466 466 - * @see Request::__call() 467 467 - * 468 468 - * @return Request this 469 469 - * @param string $header_name 470 470 - * @param string $value 471 471 - */ 472 472 - public function addHeader($header_name, $value) 473 473 - { 474 474 - $this->headers[$header_name] = $value; 475 475 - return $this; 476 476 - } 477 477 - 478 478 - /** 479 479 - * Add group of headers all at once. Note: This is 480 480 - * here just as a convenience in very specific cases. 481 481 - * The preferred "readable" way would be to leverage 482 482 - * the support for custom header methods. 483 483 - * @return Response $this 484 484 - * @param array $headers 485 485 - */ 486 486 - public function addHeaders(array $headers) 487 487 - { 488 488 - foreach ($headers as $header => $value) { 489 489 - $this->addHeader($header, $value); 490 490 - } 491 491 - return $this; 492 492 - } 493 493 - 494 494 - /** 495 495 - * @return Request 496 496 - * @param bool $auto_parse perform automatic "smart" 497 497 - * parsing based on Content-Type or "expectedType" 498 498 - * If not auto parsing, Response->body returns the body 499 499 - * as a string. 500 500 - */ 501 501 - public function autoParse($auto_parse = true) 502 502 - { 503 503 - $this->auto_parse = $auto_parse; 504 504 - return $this; 505 505 - } 506 506 - 507 507 - /** 508 508 - * @see Request::autoParse() 509 509 - * @return Request 510 510 - */ 511 511 - public function withoutAutoParsing() 512 512 - { 513 513 - return $this->autoParse(false); 514 514 - } 515 515 - 516 516 - /** 517 517 - * @see Request::autoParse() 518 518 - * @return Request 519 519 - */ 520 520 - public function withAutoParsing() 521 521 - { 522 522 - return $this->autoParse(true); 523 523 - } 524 524 - 525 525 - /** 526 526 - * Use a custom function to parse the response. 527 527 - * @return Request this 528 528 - * @param \Closure $callback Takes the raw body of 529 529 - * the http response and returns a mixed 530 530 - */ 531 531 - public function parseWith(\Closure $callback) 532 532 - { 533 533 - $this->parse_callback = $callback; 534 534 - return $this; 535 535 - } 536 536 - 537 537 - /** 538 538 - * @see Request::parseResponsesWith() 539 539 - * @return Request $this 540 540 - * @param \Closure $callback 541 541 - */ 542 542 - public function parseResponsesWith(\Closure $callback) 543 543 - { 544 544 - return $this->parseWith($callback); 545 545 - } 546 546 - 547 547 - /** 548 548 - * Register a callback that will be used to serialize the payload 549 549 - * for a particular mime type. When using "*" for the mime 550 550 - * type, it will use that parser for all responses regardless of the mime 551 551 - * type. If a custom '*' and 'application/json' exist, the custom 552 552 - * 'application/json' would take precedence over the '*' callback. 553 553 - * 554 554 - * @return Request $this 555 555 - * @param string $mime mime type we're registering 556 556 - * @param Closure $callback takes one argument, $payload, 557 557 - * which is the payload that we'll be 558 558 - */ 559 559 - public function registerPayloadSerializer($mime, \Closure $callback) 560 560 - { 561 561 - $this->payload_serializers[Mime::getFullMime($mime)] = $callback; 562 562 - return $this; 563 563 - } 564 564 - 565 565 - /** 566 566 - * @see Request::registerPayloadSerializer() 567 567 - * @return Request $this 568 568 - * @param Closure $callback 569 569 - */ 570 570 - public function serializePayloadWith(\Closure $callback) 571 571 - { 572 572 - return $this->regregisterPayloadSerializer('*', $callback); 573 573 - } 574 574 - 575 575 - /** 576 576 - * Magic method allows for neatly setting other headers in a 577 577 - * similar syntax as the other setters. This method also allows 578 578 - * for the sends* syntax. 579 579 - * @return Request this 580 580 - * @param string $method "missing" method name called 581 581 - * the method name called should be the name of the header that you 582 582 - * are trying to set in camel case without dashes e.g. to set a 583 583 - * header for Content-Type you would use contentType() or more commonly 584 584 - * to add a custom header like X-My-Header, you would use xMyHeader(). 585 585 - * To promote readability, you can optionally prefix these methods with 586 586 - * "with" (e.g. withXMyHeader("blah") instead of xMyHeader("blah")). 587 587 - * @param array $args in this case, there should only ever be 1 argument provided 588 588 - * and that argument should be a string value of the header we're setting 589 589 - */ 590 590 - public function __call($method, $args) 591 591 - { 592 592 - // This method supports the sends* methods 593 593 - // like sendsJSON, sendsForm 594 594 - //!method_exists($this, $method) && 595 595 - if (substr($method, 0, 5) === 'sends') { 596 596 - $mime = strtolower(substr($method, 5)); 597 597 - if (Mime::supportsMimeType($mime)) { 598 598 - $this->sends(Mime::getFullMime($mime)); 599 599 - return $this; 600 600 - } 601 601 - // else { 602 602 - // throw new \Exception("Unsupported Content-Type $mime"); 603 603 - // } 604 604 - } 605 605 - if (substr($method, 0, 7) === 'expects') { 606 606 - $mime = strtolower(substr($method, 7)); 607 607 - if (Mime::supportsMimeType($mime)) { 608 608 - $this->expects(Mime::getFullMime($mime)); 609 609 - return $this; 610 610 - } 611 611 - // else { 612 612 - // throw new \Exception("Unsupported Content-Type $mime"); 613 613 - // } 614 614 - } 615 615 - 616 616 - // This method also adds the custom header support as described in the 617 617 - // method comments 618 618 - if (count($args) === 0) 619 619 - return; 620 620 - 621 621 - // Strip the sugar. If it leads with "with", strip. 622 622 - // This is okay because: No defined HTTP headers begin with with, 623 623 - // and if you are defining a custom header, the standard is to prefix it 624 624 - // with an "X-", so that should take care of any collisions. 625 625 - if (substr($method, 0, 4) === 'with') 626 626 - $method = substr($method, 4); 627 627 - 628 628 - // Precede upper case letters with dashes, uppercase the first letter of method 629 629 - $header = ucwords(implode('-', preg_split('/([A-Z][^A-Z]*)/', $method, -1, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY))); 630 630 - $this->addHeader($header, $args[0]); 631 631 - return $this; 632 632 - } 633 633 - 634 634 - // Internal Functions 635 635 - 636 636 - /** 637 637 - * This is the default template to use if no 638 638 - * template has been provided. The template 639 639 - * tells the class which default values to use. 640 640 - * While there is a slight overhead for object 641 641 - * creation once per execution (not once per 642 642 - * Request instantiation), it promotes readability 643 643 - * and flexibility within the class. 644 644 - */ 645 645 - private static function _initializeDefaults() 646 646 - { 647 647 - // This is the only place you will 648 648 - // see this constructor syntax. It 649 649 - // is only done here to prevent infinite 650 650 - // recusion. Do not use this syntax elsewhere. 651 651 - // It goes against the whole readability 652 652 - // and transparency idea. 653 653 - self::$_template = new Request(array('method' => Http::GET)); 654 654 - 655 655 - // This is more like it... 656 656 - self::$_template 657 657 - ->withoutStrictSSL(); 658 658 - } 659 659 - 660 660 - /** 661 661 - * Set the defaults on a newly instantiated object 662 662 - * Doesn't copy variables prefixed with _ 663 663 - * @return Request this 664 664 - */ 665 665 - private function _setDefaults() 666 666 - { 667 667 - if (!isset(self::$_template)) 668 668 - self::_initializeDefaults(); 669 669 - foreach (self::$_template as $k=>$v) { 670 670 - if ($k[0] != '_') 671 671 - $this->$k = $v; 672 672 - } 673 673 - return $this; 674 674 - } 675 675 - 676 676 - private function _error($error) 677 677 - { 678 678 - // Default actions write to error log 679 679 - // TODO add in support for various Loggers 680 680 - error_log($error); 681 681 - } 682 682 - 683 683 - /** 684 684 - * Factory style constructor works nicer for chaining. This 685 685 - * should also really only be used internally. The Request::get, 686 686 - * Request::post syntax is preferred as it is more readable. 687 687 - * @return Request 688 688 - * @param string $method Http Method 689 689 - * @param string $mime Mime Type to Use 690 690 - */ 691 691 - public static function init($method = null, $mime = null) 692 692 - { 693 693 - // Setup our handlers, can call it here as it's idempotent 694 694 - Bootstrap::init(); 695 695 - 696 696 - // Setup the default template if need be 697 697 - if (!isset(self::$_template)) 698 698 - self::_initializeDefaults(); 699 699 - 700 700 - $request = new Request(); 701 701 - return $request 702 702 - ->_setDefaults() 703 703 - ->method($method) 704 704 - ->sendsType($mime) 705 705 - ->expectsType($mime); 706 706 - } 707 707 - 708 708 - /** 709 709 - * Does the heavy lifting. Uses de facto HTTP 710 710 - * library cURL to set up the HTTP request. 711 711 - * Note: It does NOT actually send the request 712 712 - * @return Request $this; 713 713 - */ 714 714 - public function _curlPrep() 715 715 - { 716 716 - // Check for required stuff 717 717 - if (!isset($this->uri)) 718 718 - throw new \Exception('Attempting to send a request before defining a URI endpoint.'); 719 719 - 720 720 - $ch = curl_init($this->uri); 721 721 - 722 722 - curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $this->method); 723 723 - 724 724 - if ($this->hasBasicAuth()) { 725 725 - curl_setopt($ch, CURLOPT_USERPWD, $this->username . ':' . $this->password); 726 726 - } 727 727 - 728 728 - if ($this->hasClientSideCert()) { 729 729 - 730 730 - if (!file_exists($this->client_key)) 731 731 - throw new \Exception('Could not read Client Key'); 732 732 - 733 733 - if (!file_exists($this->client_cert)) 734 734 - throw new \Exception('Could not read Client Certificate'); 735 735 - 736 736 - curl_setopt($ch, CURLOPT_SSLCERTTYPE, $this->client_encoding); 737 737 - curl_setopt($ch, CURLOPT_SSLKEYTYPE, $this->client_encoding); 738 738 - curl_setopt($ch, CURLOPT_SSLCERT, $this->client_cert); 739 739 - curl_setopt($ch, CURLOPT_SSLKEY, $this->client_key); 740 740 - curl_setopt($ch, CURLOPT_SSLKEYPASSWD, $this->client_passphrase); 741 741 - // curl_setopt($ch, CURLOPT_SSLCERTPASSWD, $this->client_cert_passphrase); 742 742 - } 743 743 - 744 744 - if ($this->hasTimeout()) { 745 745 - curl_setopt($ch, CURLOPT_TIMEOUT, $this->timeout); 746 746 - } 747 747 - 748 748 - if ($this->follow_redirects) { 749 749 - curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true); 750 750 - curl_setopt($ch, CURLOPT_MAXREDIRS, $this->max_redirects); 751 751 - } 752 752 - 753 753 - curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, $this->strict_ssl); 754 754 - curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); 755 755 - 756 756 - $headers = array(); 757 757 - // https://github.com/nategood/httpful/issues/37 758 758 - // Except header removes any HTTP 1.1 Continue from response headers 759 759 - $headers[] = 'Expect:'; 760 760 - 761 761 - if (!isset($this->headers['User-Agent'])) { 762 762 - $headers[] = $this->buildUserAgent(); 763 763 - } 764 764 - 765 765 - $headers[] = "Content-Type: {$this->content_type}"; 766 766 - 767 767 - // allow custom Accept header if set 768 768 - if (!isset($this->headers['Accept'])) { 769 769 - // http://pretty-rfc.herokuapp.com/RFC2616#header.accept 770 770 - $accept = 'Accept: */*; q=0.5, text/plain; q=0.8, text/html;level=3;'; 771 771 - 772 772 - if (!empty($this->expected_type)) { 773 773 - $accept .= "q=0.9, {$this->expected_type}"; 774 774 - } 775 775 - 776 776 - $headers[] = $accept; 777 777 - } 778 778 - 779 779 - foreach ($this->headers as $header => $value) { 780 780 - $headers[] = "$header: $value"; 781 781 - } 782 782 - 783 783 - $url = \parse_url($this->uri); 784 784 - $path = (isset($url['path']) ? $url['path'] : '/').(isset($url['query']) ? '?'.$url['query'] : ''); 785 785 - $this->raw_headers = "{$this->method} $path HTTP/1.1\r\n"; 786 786 - $host = (isset($url['host']) ? $url['host'] : 'localhost').(isset($url['port']) ? ':'.$url['port'] : ''); 787 787 - $this->raw_headers .= "Host: $host\r\n"; 788 788 - $this->raw_headers .= \implode("\r\n", $headers); 789 789 - $this->raw_headers .= "\r\n"; 790 790 - 791 791 - curl_setopt($ch, CURLOPT_HTTPHEADER, $headers); 792 792 - 793 793 - if (isset($this->payload)) { 794 794 - $this->serialized_payload = $this->_serializePayload($this->payload); 795 795 - curl_setopt($ch, CURLOPT_POSTFIELDS, $this->serialized_payload); 796 796 - } 797 797 - 798 798 - if ($this->_debug) { 799 799 - curl_setopt($ch, CURLOPT_VERBOSE, true); 800 800 - } 801 801 - 802 802 - curl_setopt($ch, CURLOPT_HEADER, 1); 803 803 - 804 804 - // If there are some additional curl opts that the user wants 805 805 - // to set, we can tack them in here 806 806 - foreach ($this->additional_curl_opts as $curlopt => $curlval) { 807 807 - curl_setopt($ch, $curlopt, $curlval); 808 808 - } 809 809 - 810 810 - $this->_ch = $ch; 811 811 - 812 812 - return $this; 813 813 - } 814 814 - 815 815 - public function buildUserAgent() { 816 816 - $user_agent = 'User-Agent: Httpful/' . Httpful::VERSION . ' (cURL/'; 817 817 - $curl = \curl_version(); 818 818 - 819 819 - if (isset($curl['version'])) { 820 820 - $user_agent .= $curl['version']; 821 821 - } else { 822 822 - $user_agent .= '?.?.?'; 823 823 - } 824 824 - 825 825 - $user_agent .= ' PHP/'. PHP_VERSION . ' (' . PHP_OS . ')'; 826 826 - 827 827 - if (isset($_SERVER['SERVER_SOFTWARE'])) { 828 828 - $user_agent .= ' ' . \preg_replace('~PHP/[\d\.]+~U', '', 829 829 - $_SERVER['SERVER_SOFTWARE']); 830 830 - } else { 831 831 - if (isset($_SERVER['TERM_PROGRAM'])) { 832 832 - $user_agent .= " {$_SERVER['TERM_PROGRAM']}"; 833 833 - } 834 834 - 835 835 - if (isset($_SERVER['TERM_PROGRAM_VERSION'])) { 836 836 - $user_agent .= "/{$_SERVER['TERM_PROGRAM_VERSION']}"; 837 837 - } 838 838 - } 839 839 - 840 840 - if (isset($_SERVER['HTTP_USER_AGENT'])) { 841 841 - $user_agent .= " {$_SERVER['HTTP_USER_AGENT']}"; 842 842 - } 843 843 - 844 844 - $user_agent .= ')'; 845 845 - 846 846 - return $user_agent; 847 847 - } 848 848 - 849 849 - /** 850 850 - * Semi-reluctantly added this as a way to add in curl opts 851 851 - * that are not otherwise accessible from the rest of the API. 852 852 - * @return Request $this 853 853 - * @param string $curlopt 854 854 - * @param mixed $curloptval 855 855 - */ 856 856 - public function addOnCurlOption($curlopt, $curloptval) 857 857 - { 858 858 - $this->additional_curl_opts[$curlopt] = $curloptval; 859 859 - return $this; 860 860 - } 861 861 - 862 862 - /** 863 863 - * Turn payload from structured data into 864 864 - * a string based on the current Mime type. 865 865 - * This uses the auto_serialize option to determine 866 866 - * it's course of action. See serialize method for more. 867 867 - * Renamed from _detectPayload to _serializePayload as of 868 868 - * 2012-02-15. 869 869 - * 870 870 - * Added in support for custom payload serializers. 871 871 - * The serialize_payload_method stuff still holds true though. 872 872 - * @see Request::registerPayloadSerializer() 873 873 - * 874 874 - * @return string 875 875 - * @param mixed $payload 876 876 - */ 877 877 - private function _serializePayload($payload) 878 878 - { 879 879 - if (empty($payload) || $this->serialize_payload_method === self::SERIALIZE_PAYLOAD_NEVER) 880 880 - return $payload; 881 881 - 882 882 - // When we are in "smart" mode, don't serialize strings/scalars, assume they are already serialized 883 883 - if ($this->serialize_payload_method === self::SERIALIZE_PAYLOAD_SMART && is_scalar($payload)) 884 884 - return $payload; 885 885 - 886 886 - // Use a custom serializer if one is registered for this mime type 887 887 - if (isset($this->payload_serializers['*']) || isset($this->payload_serializers[$this->content_type])) { 888 888 - $key = isset($this->payload_serializers[$this->content_type]) ? $this->content_type : '*'; 889 889 - return call_user_func($this->payload_serializers[$key], $payload); 890 890 - } 891 891 - 892 892 - return Httpful::get($this->content_type)->serialize($payload); 893 893 - } 894 894 - 895 895 - /** 896 896 - * HTTP Method Get 897 897 - * @return Request 898 898 - * @param string $uri optional uri to use 899 899 - * @param string $mime expected 900 900 - */ 901 901 - public static function get($uri, $mime = null) 902 902 - { 903 903 - return self::init(Http::GET)->uri($uri)->mime($mime); 904 904 - } 905 905 - 906 906 - 907 907 - /** 908 908 - * Like Request:::get, except that it sends off the request as well 909 909 - * returning a response 910 910 - * @return Response 911 911 - * @param string $uri optional uri to use 912 912 - * @param string $mime expected 913 913 - */ 914 914 - public static function getQuick($uri, $mime = null) 915 915 - { 916 916 - return self::get($uri, $mime)->send(); 917 917 - } 918 918 - 919 919 - /** 920 920 - * HTTP Method Post 921 921 - * @return Request 922 922 - * @param string $uri optional uri to use 923 923 - * @param string $payload data to send in body of request 924 924 - * @param string $mime MIME to use for Content-Type 925 925 - */ 926 926 - public static function post($uri, $payload = null, $mime = null) 927 927 - { 928 928 - return self::init(Http::POST)->uri($uri)->body($payload, $mime); 929 929 - } 930 930 - 931 931 - /** 932 932 - * HTTP Method Put 933 933 - * @return Request 934 934 - * @param string $uri optional uri to use 935 935 - * @param string $payload data to send in body of request 936 936 - * @param string $mime MIME to use for Content-Type 937 937 - */ 938 938 - public static function put($uri, $payload = null, $mime = null) 939 939 - { 940 940 - return self::init(Http::PUT)->uri($uri)->body($payload, $mime); 941 941 - } 942 942 - 943 943 - /** 944 944 - * HTTP Method Patch 945 945 - * @return Request 946 946 - * @param string $uri optional uri to use 947 947 - * @param string $payload data to send in body of request 948 948 - * @param string $mime MIME to use for Content-Type 949 949 - */ 950 950 - public static function patch($uri, $payload = null, $mime = null) 951 951 - { 952 952 - return self::init(Http::PATCH)->uri($uri)->body($payload, $mime); 953 953 - } 954 954 - 955 955 - /** 956 956 - * HTTP Method Delete 957 957 - * @return Request 958 958 - * @param string $uri optional uri to use 959 959 - */ 960 960 - public static function delete($uri, $mime = null) 961 961 - { 962 962 - return self::init(Http::DELETE)->uri($uri)->mime($mime); 963 963 - } 964 964 - 965 965 - /** 966 966 - * HTTP Method Head 967 967 - * @return Request 968 968 - * @param string $uri optional uri to use 969 969 - */ 970 970 - public static function head($uri) 971 971 - { 972 972 - return self::init(Http::HEAD)->uri($uri); 973 973 - } 974 974 - 975 975 - /** 976 976 - * HTTP Method Options 977 977 - * @return Request 978 978 - * @param string $uri optional uri to use 979 979 - */ 980 980 - public static function options($uri) 981 981 - { 982 982 - return self::init(Http::OPTIONS)->uri($uri); 983 983 - } 984 984 - }

-189

externals/httpful/src/Httpful/Response.php

reviewed

··· 1 1 - <?php 2 2 - 3 3 - namespace Httpful; 4 4 - 5 5 - /** 6 6 - * Models an HTTP response 7 7 - * 8 8 - * @author Nate Good <me@nategood.com> 9 9 - */ 10 10 - class Response 11 11 - { 12 12 - 13 13 - public $body, 14 14 - $raw_body, 15 15 - $headers, 16 16 - $raw_headers, 17 17 - $request, 18 18 - $code = 0, 19 19 - $content_type, 20 20 - $parent_type, 21 21 - $charset, 22 22 - $is_mime_vendor_specific = false, 23 23 - $is_mime_personal = false; 24 24 - 25 25 - private $parsers; 26 26 - /** 27 27 - * @param string $body 28 28 - * @param string $headers 29 29 - * @param Request $request 30 30 - */ 31 31 - public function __construct($body, $headers, Request $request) 32 32 - { 33 33 - $this->request = $request; 34 34 - $this->raw_headers = $headers; 35 35 - $this->raw_body = $body; 36 36 - 37 37 - $this->code = $this->_parseCode($headers); 38 38 - $this->headers = Response\Headers::fromString($headers); 39 39 - 40 40 - $this->_interpretHeaders(); 41 41 - 42 42 - $this->body = $this->_parse($body); 43 43 - } 44 44 - 45 45 - /** 46 46 - * Status Code Definitions 47 47 - * 48 48 - * Informational 1xx 49 49 - * Successful 2xx 50 50 - * Redirection 3xx 51 51 - * Client Error 4xx 52 52 - * Server Error 5xx 53 53 - * 54 54 - * http://pretty-rfc.herokuapp.com/RFC2616#status.codes 55 55 - * 56 56 - * @return bool Did we receive a 4xx or 5xx? 57 57 - */ 58 58 - public function hasErrors() 59 59 - { 60 60 - return $this->code >= 400; 61 61 - } 62 62 - 63 63 - /** 64 64 - * @return return bool 65 65 - */ 66 66 - public function hasBody() 67 67 - { 68 68 - return !empty($this->body); 69 69 - } 70 70 - 71 71 - /** 72 72 - * Parse the response into a clean data structure 73 73 - * (most often an associative array) based on the expected 74 74 - * Mime type. 75 75 - * @return array|string|object the response parse accordingly 76 76 - * @param string Http response body 77 77 - */ 78 78 - public function _parse($body) 79 79 - { 80 80 - // If the user decided to forgo the automatic 81 81 - // smart parsing, short circuit. 82 82 - if (!$this->request->auto_parse) { 83 83 - return $body; 84 84 - } 85 85 - 86 86 - // If provided, use custom parsing callback 87 87 - if (isset($this->request->parse_callback)) { 88 88 - return call_user_func($this->request->parse_callback, $body); 89 89 - } 90 90 - 91 91 - // Decide how to parse the body of the response in the following order 92 92 - // 1. If provided, use the mime type specifically set as part of the `Request` 93 93 - // 2. If a MimeHandler is registered for the content type, use it 94 94 - // 3. If provided, use the "parent type" of the mime type from the response 95 95 - // 4. Default to the content-type provided in the response 96 96 - $parse_with = $this->request->expected_type; 97 97 - if (empty($this->request->expected_type)) { 98 98 - $parse_with = Httpful::hasParserRegistered($this->content_type) 99 99 - ? $this->content_type 100 100 - : $this->parent_type; 101 101 - } 102 102 - 103 103 - return Httpful::get($parse_with)->parse($body); 104 104 - } 105 105 - 106 106 - /** 107 107 - * Parse text headers from response into 108 108 - * array of key value pairs 109 109 - * @return array parse headers 110 110 - * @param string $headers raw headers 111 111 - */ 112 112 - public function _parseHeaders($headers) 113 113 - { 114 114 - $headers = preg_split("/(\r|\n)+/", $headers, -1, \PREG_SPLIT_NO_EMPTY); 115 115 - $parse_headers = array(); 116 116 - for ($i = 1; $i < count($headers); $i++) { 117 117 - list($key, $raw_value) = explode(':', $headers[$i], 2); 118 118 - $key = trim($key); 119 119 - $value = trim($raw_value); 120 120 - if (array_key_exists($key, $parse_headers)) { 121 121 - // See HTTP RFC Sec 4.2 Paragraph 5 122 122 - // http://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.2 123 123 - // If a header appears more than once, it must also be able to 124 124 - // be represented as a single header with a comma-separated 125 125 - // list of values. We transform accordingly. 126 126 - $parse_headers[$key] .= ',' . $value; 127 127 - } else { 128 128 - $parse_headers[$key] = $value; 129 129 - } 130 130 - } 131 131 - return $parse_headers; 132 132 - } 133 133 - 134 134 - public function _parseCode($headers) 135 135 - { 136 136 - $parts = explode(' ', substr($headers, 0, strpos($headers, "\r\n"))); 137 137 - if (count($parts) < 2 || !is_numeric($parts[1])) { 138 138 - throw new \Exception("Unable to parse response code from HTTP response due to malformed response"); 139 139 - } 140 140 - return intval($parts[1]); 141 141 - } 142 142 - 143 143 - /** 144 144 - * After we've parse the headers, let's clean things 145 145 - * up a bit and treat some headers specially 146 146 - */ 147 147 - public function _interpretHeaders() 148 148 - { 149 149 - // Parse the Content-Type and charset 150 150 - $content_type = isset($this->headers['Content-Type']) ? $this->headers['Content-Type'] : ''; 151 151 - $content_type = explode(';', $content_type); 152 152 - 153 153 - $this->content_type = $content_type[0]; 154 154 - if (count($content_type) == 2 && strpos($content_type[1], '=') !== false) { 155 155 - list($nill, $this->charset) = explode('=', $content_type[1]); 156 156 - } 157 157 - 158 158 - // RFC 2616 states "text/*" Content-Types should have a default 159 159 - // charset of ISO-8859-1. "application/*" and other Content-Types 160 160 - // are assumed to have UTF-8 unless otherwise specified. 161 161 - // http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.7.1 162 162 - // http://www.w3.org/International/O-HTTP-charset.en.php 163 163 - if (!isset($this->charset)) { 164 164 - $this->charset = substr($this->content_type, 5) === 'text/' ? 'iso-8859-1' : 'utf-8'; 165 165 - } 166 166 - 167 167 - // Is vendor type? Is personal type? 168 168 - if (strpos($this->content_type, '/') !== false) { 169 169 - list($type, $sub_type) = explode('/', $this->content_type); 170 170 - $this->is_mime_vendor_specific = substr($sub_type, 0, 4) === 'vnd.'; 171 171 - $this->is_mime_personal = substr($sub_type, 0, 4) === 'prs.'; 172 172 - } 173 173 - 174 174 - // Parent type (e.g. xml for application/vnd.github.message+xml) 175 175 - $this->parent_type = $this->content_type; 176 176 - if (strpos($this->content_type, '+') !== false) { 177 177 - list($vendor, $this->parent_type) = explode('+', $this->content_type, 2); 178 178 - $this->parent_type = Mime::getFullMime($this->parent_type); 179 179 - } 180 180 - } 181 181 - 182 182 - /** 183 183 - * @return string 184 184 - */ 185 185 - public function __toString() 186 186 - { 187 187 - return $this->raw_body; 188 188 - } 189 189 - }

-58

externals/httpful/src/Httpful/Response/Headers.php

reviewed

··· 1 1 - <?php 2 2 - 3 3 - namespace Httpful\Response; 4 4 - 5 5 - final class Headers implements \ArrayAccess, \Countable { 6 6 - 7 7 - private $headers; 8 8 - 9 9 - private function __construct($headers) 10 10 - { 11 11 - $this->headers = $headers; 12 12 - } 13 13 - 14 14 - public static function fromString($string) 15 15 - { 16 16 - $lines = preg_split("/(\r|\n)+/", $string, -1, PREG_SPLIT_NO_EMPTY); 17 17 - array_shift($lines); // HTTP HEADER 18 18 - $headers = array(); 19 19 - foreach ($lines as $line) { 20 20 - list($name, $value) = explode(':', $line, 2); 21 21 - $headers[strtolower(trim($name))] = trim($value); 22 22 - } 23 23 - return new self($headers); 24 24 - } 25 25 - 26 26 - public function offsetExists($offset) 27 27 - { 28 28 - return isset($this->headers[strtolower($offset)]); 29 29 - } 30 30 - 31 31 - public function offsetGet($offset) 32 32 - { 33 33 - if (isset($this->headers[$name = strtolower($offset)])) { 34 34 - return $this->headers[$name]; 35 35 - } 36 36 - } 37 37 - 38 38 - public function offsetSet($offset, $value) 39 39 - { 40 40 - throw new \Exception("Headers are read-only."); 41 41 - } 42 42 - 43 43 - public function offsetUnset($offset) 44 44 - { 45 45 - throw new \Exception("Headers are read-only."); 46 46 - } 47 47 - 48 48 - public function count() 49 49 - { 50 50 - return count($this->headers); 51 51 - } 52 52 - 53 53 - public function toArray() 54 54 - { 55 55 - return $this->headers; 56 56 - } 57 57 - 58 58 - }

-458

externals/httpful/tests/Httpful/HttpfulTest.php

reviewed

··· 1 1 - <?php 2 2 - /** 3 3 - * Port over the original tests into a more traditional PHPUnit 4 4 - * format. Still need to hook into a lightweight HTTP server to 5 5 - * better test some things (e.g. obscure cURL settings). I've moved 6 6 - * the old tests and node.js server to the tests/.legacy directory. 7 7 - * 8 8 - * @author Nate Good <me@nategood.com> 9 9 - */ 10 10 - namespace Httpful\Test; 11 11 - 12 12 - require(dirname(dirname(dirname(__FILE__))) . '/bootstrap.php'); 13 13 - \Httpful\Bootstrap::init(); 14 14 - 15 15 - use Httpful\Httpful; 16 16 - use Httpful\Request; 17 17 - use Httpful\Mime; 18 18 - use Httpful\Http; 19 19 - use Httpful\Response; 20 20 - 21 21 - class HttpfulTest extends \PHPUnit_Framework_TestCase 22 22 - { 23 23 - const TEST_SERVER = '127.0.0.1:8008'; 24 24 - const TEST_URL = 'http://127.0.0.1:8008'; 25 25 - const TEST_URL_400 = 'http://127.0.0.1:8008/400'; 26 26 - 27 27 - const SAMPLE_JSON_HEADER = 28 28 - "HTTP/1.1 200 OK 29 29 - Content-Type: application/json 30 30 - Connection: keep-alive 31 31 - Transfer-Encoding: chunked\r\n"; 32 32 - const SAMPLE_JSON_RESPONSE = '{"key":"value","object":{"key":"value"},"array":[1,2,3,4]}'; 33 33 - const SAMPLE_CSV_HEADER = 34 34 - "HTTP/1.1 200 OK 35 35 - Content-Type: text/csv 36 36 - Connection: keep-alive 37 37 - Transfer-Encoding: chunked\r\n"; 38 38 - const SAMPLE_CSV_RESPONSE = 39 39 - "Key1,Key2 40 40 - Value1,Value2 41 41 - \"40.0\",\"Forty\""; 42 42 - const SAMPLE_XML_RESPONSE = '<stdClass><arrayProp><array><k1><myClass><intProp>2</intProp></myClass></k1></array></arrayProp><stringProp>a string</stringProp><boolProp>TRUE</boolProp></stdClass>'; 43 43 - const SAMPLE_XML_HEADER = 44 44 - "HTTP/1.1 200 OK 45 45 - Content-Type: application/xml 46 46 - Connection: keep-alive 47 47 - Transfer-Encoding: chunked\r\n"; 48 48 - const SAMPLE_VENDOR_HEADER = 49 49 - "HTTP/1.1 200 OK 50 50 - Content-Type: application/vnd.nategood.message+xml 51 51 - Connection: keep-alive 52 52 - Transfer-Encoding: chunked\r\n"; 53 53 - const SAMPLE_VENDOR_TYPE = "application/vnd.nategood.message+xml"; 54 54 - const SAMPLE_MULTI_HEADER = 55 55 - "HTTP/1.1 200 OK 56 56 - Content-Type: application/json 57 57 - Connection: keep-alive 58 58 - Transfer-Encoding: chunked 59 59 - X-My-Header:Value1 60 60 - X-My-Header:Value2\r\n"; 61 61 - function testInit() 62 62 - { 63 63 - $r = Request::init(); 64 64 - // Did we get a 'Request' object? 65 65 - $this->assertEquals('Httpful\Request', get_class($r)); 66 66 - } 67 67 - 68 68 - function testMethods() 69 69 - { 70 70 - $valid_methods = array('get', 'post', 'delete', 'put', 'options', 'head'); 71 71 - $url = 'http://example.com/'; 72 72 - foreach ($valid_methods as $method) { 73 73 - $r = call_user_func(array('Httpful\Request', $method), $url); 74 74 - $this->assertEquals('Httpful\Request', get_class($r)); 75 75 - $this->assertEquals(strtoupper($method), $r->method); 76 76 - } 77 77 - } 78 78 - 79 79 - function testDefaults() 80 80 - { 81 81 - // Our current defaults are as follows 82 82 - $r = Request::init(); 83 83 - $this->assertEquals(Http::GET, $r->method); 84 84 - $this->assertFalse($r->strict_ssl); 85 85 - } 86 86 - 87 87 - function testShortMime() 88 88 - { 89 89 - // Valid short ones 90 90 - $this->assertEquals(Mime::JSON, Mime::getFullMime('json')); 91 91 - $this->assertEquals(Mime::XML, Mime::getFullMime('xml')); 92 92 - $this->assertEquals(Mime::HTML, Mime::getFullMime('html')); 93 93 - $this->assertEquals(Mime::CSV, Mime::getFullMime('csv')); 94 94 - 95 95 - // Valid long ones 96 96 - $this->assertEquals(Mime::JSON, Mime::getFullMime(Mime::JSON)); 97 97 - $this->assertEquals(Mime::XML, Mime::getFullMime(Mime::XML)); 98 98 - $this->assertEquals(Mime::HTML, Mime::getFullMime(Mime::HTML)); 99 99 - $this->assertEquals(Mime::CSV, Mime::getFullMime(Mime::CSV)); 100 100 - 101 101 - // No false positives 102 102 - $this->assertNotEquals(Mime::XML, Mime::getFullMime(Mime::HTML)); 103 103 - $this->assertNotEquals(Mime::JSON, Mime::getFullMime(Mime::XML)); 104 104 - $this->assertNotEquals(Mime::HTML, Mime::getFullMime(Mime::JSON)); 105 105 - $this->assertNotEquals(Mime::XML, Mime::getFullMime(Mime::CSV)); 106 106 - } 107 107 - 108 108 - function testSettingStrictSsl() 109 109 - { 110 110 - $r = Request::init() 111 111 - ->withStrictSsl(); 112 112 - 113 113 - $this->assertTrue($r->strict_ssl); 114 114 - 115 115 - $r = Request::init() 116 116 - ->withoutStrictSsl(); 117 117 - 118 118 - $this->assertFalse($r->strict_ssl); 119 119 - } 120 120 - 121 121 - function testSendsAndExpectsType() 122 122 - { 123 123 - $r = Request::init() 124 124 - ->sendsAndExpectsType(Mime::JSON); 125 125 - $this->assertEquals(Mime::JSON, $r->expected_type); 126 126 - $this->assertEquals(Mime::JSON, $r->content_type); 127 127 - 128 128 - $r = Request::init() 129 129 - ->sendsAndExpectsType('html'); 130 130 - $this->assertEquals(Mime::HTML, $r->expected_type); 131 131 - $this->assertEquals(Mime::HTML, $r->content_type); 132 132 - 133 133 - $r = Request::init() 134 134 - ->sendsAndExpectsType('form'); 135 135 - $this->assertEquals(Mime::FORM, $r->expected_type); 136 136 - $this->assertEquals(Mime::FORM, $r->content_type); 137 137 - 138 138 - $r = Request::init() 139 139 - ->sendsAndExpectsType('application/x-www-form-urlencoded'); 140 140 - $this->assertEquals(Mime::FORM, $r->expected_type); 141 141 - $this->assertEquals(Mime::FORM, $r->content_type); 142 142 - 143 143 - $r = Request::init() 144 144 - ->sendsAndExpectsType(Mime::CSV); 145 145 - $this->assertEquals(Mime::CSV, $r->expected_type); 146 146 - $this->assertEquals(Mime::CSV, $r->content_type); 147 147 - } 148 148 - 149 149 - function testIni() 150 150 - { 151 151 - // Test setting defaults/templates 152 152 - 153 153 - // Create the template 154 154 - $template = Request::init() 155 155 - ->method(Http::POST) 156 156 - ->withStrictSsl() 157 157 - ->expectsType(Mime::HTML) 158 158 - ->sendsType(Mime::FORM); 159 159 - 160 160 - Request::ini($template); 161 161 - 162 162 - $r = Request::init(); 163 163 - 164 164 - $this->assertTrue($r->strict_ssl); 165 165 - $this->assertEquals(Http::POST, $r->method); 166 166 - $this->assertEquals(Mime::HTML, $r->expected_type); 167 167 - $this->assertEquals(Mime::FORM, $r->content_type); 168 168 - 169 169 - // Test the default accessor as well 170 170 - $this->assertTrue(Request::d('strict_ssl')); 171 171 - $this->assertEquals(Http::POST, Request::d('method')); 172 172 - $this->assertEquals(Mime::HTML, Request::d('expected_type')); 173 173 - $this->assertEquals(Mime::FORM, Request::d('content_type')); 174 174 - 175 175 - Request::resetIni(); 176 176 - } 177 177 - 178 178 - function testAccept() 179 179 - { 180 180 - $r = Request::get('http://example.com/') 181 181 - ->expectsType(Mime::JSON); 182 182 - 183 183 - $this->assertEquals(Mime::JSON, $r->expected_type); 184 184 - $r->_curlPrep(); 185 185 - $this->assertContains('application/json', $r->raw_headers); 186 186 - } 187 187 - 188 188 - function testCustomAccept() 189 189 - { 190 190 - $accept = 'application/api-1.0+json'; 191 191 - $r = Request::get('http://example.com/') 192 192 - ->addHeader('Accept', $accept); 193 193 - 194 194 - $r->_curlPrep(); 195 195 - $this->assertContains($accept, $r->raw_headers); 196 196 - $this->assertEquals($accept, $r->headers['Accept']); 197 197 - } 198 198 - 199 199 - function testUserAgent() 200 200 - { 201 201 - $r = Request::get('http://example.com/') 202 202 - ->withUserAgent('ACME/1.2.3'); 203 203 - 204 204 - $this->assertArrayHasKey('User-Agent', $r->headers); 205 205 - $r->_curlPrep(); 206 206 - $this->assertContains('User-Agent: ACME/1.2.3', $r->raw_headers); 207 207 - $this->assertNotContains('User-Agent: HttpFul/1.0', $r->raw_headers); 208 208 - 209 209 - $r = Request::get('http://example.com/') 210 210 - ->withUserAgent(''); 211 211 - 212 212 - $this->assertArrayHasKey('User-Agent', $r->headers); 213 213 - $r->_curlPrep(); 214 214 - $this->assertContains('User-Agent:', $r->raw_headers); 215 215 - $this->assertNotContains('User-Agent: HttpFul/1.0', $r->raw_headers); 216 216 - } 217 217 - 218 218 - function testAuthSetup() 219 219 - { 220 220 - $username = 'nathan'; 221 221 - $password = 'opensesame'; 222 222 - 223 223 - $r = Request::get('http://example.com/') 224 224 - ->authenticateWith($username, $password); 225 225 - 226 226 - $this->assertEquals($username, $r->username); 227 227 - $this->assertEquals($password, $r->password); 228 228 - $this->assertTrue($r->hasBasicAuth()); 229 229 - } 230 230 - 231 231 - function testDigestAuthSetup() 232 232 - { 233 233 - $username = 'nathan'; 234 234 - $password = 'opensesame'; 235 235 - 236 236 - $r = Request::get('http://example.com/') 237 237 - ->authenticateWithDigest($username, $password); 238 238 - 239 239 - $this->assertEquals($username, $r->username); 240 240 - $this->assertEquals($password, $r->password); 241 241 - $this->assertTrue($r->hasDigestAuth()); 242 242 - } 243 243 - 244 244 - function testJsonResponseParse() 245 245 - { 246 246 - $req = Request::init()->sendsAndExpects(Mime::JSON); 247 247 - $response = new Response(self::SAMPLE_JSON_RESPONSE, self::SAMPLE_JSON_HEADER, $req); 248 248 - 249 249 - $this->assertEquals("value", $response->body->key); 250 250 - $this->assertEquals("value", $response->body->object->key); 251 251 - $this->assertInternalType('array', $response->body->array); 252 252 - $this->assertEquals(1, $response->body->array[0]); 253 253 - } 254 254 - 255 255 - function testXMLResponseParse() 256 256 - { 257 257 - $req = Request::init()->sendsAndExpects(Mime::XML); 258 258 - $response = new Response(self::SAMPLE_XML_RESPONSE, self::SAMPLE_XML_HEADER, $req); 259 259 - $sxe = $response->body; 260 260 - $this->assertEquals("object", gettype($sxe)); 261 261 - $this->assertEquals("SimpleXMLElement", get_class($sxe)); 262 262 - $bools = $sxe->xpath('/stdClass/boolProp'); 263 263 - list( , $bool ) = each($bools); 264 264 - $this->assertEquals("TRUE", (string) $bool); 265 265 - $ints = $sxe->xpath('/stdClass/arrayProp/array/k1/myClass/intProp'); 266 266 - list( , $int ) = each($ints); 267 267 - $this->assertEquals("2", (string) $int); 268 268 - $strings = $sxe->xpath('/stdClass/stringProp'); 269 269 - list( , $string ) = each($strings); 270 270 - $this->assertEquals("a string", (string) $string); 271 271 - } 272 272 - 273 273 - function testCsvResponseParse() 274 274 - { 275 275 - $req = Request::init()->sendsAndExpects(Mime::CSV); 276 276 - $response = new Response(self::SAMPLE_CSV_RESPONSE, self::SAMPLE_CSV_HEADER, $req); 277 277 - 278 278 - $this->assertEquals("Key1", $response->body[0][0]); 279 279 - $this->assertEquals("Value1", $response->body[1][0]); 280 280 - $this->assertInternalType('string', $response->body[2][0]); 281 281 - $this->assertEquals("40.0", $response->body[2][0]); 282 282 - } 283 283 - 284 284 - function testParsingContentTypeCharset() 285 285 - { 286 286 - $req = Request::init()->sendsAndExpects(Mime::JSON); 287 287 - // $response = new Response(SAMPLE_JSON_RESPONSE, "", $req); 288 288 - // // Check default content type of iso-8859-1 289 289 - $response = new Response(self::SAMPLE_JSON_RESPONSE, "HTTP/1.1 200 OK 290 290 - Content-Type: text/plain; charset=utf-8\r\n", $req); 291 291 - $this->assertInstanceOf('Httpful\Response\Headers', $response->headers); 292 292 - $this->assertEquals($response->headers['Content-Type'], 'text/plain; charset=utf-8'); 293 293 - $this->assertEquals($response->content_type, 'text/plain'); 294 294 - $this->assertEquals($response->charset, 'utf-8'); 295 295 - } 296 296 - 297 297 - function testEmptyResponseParse() 298 298 - { 299 299 - $req = Request::init()->sendsAndExpects(Mime::JSON); 300 300 - $response = new Response("", self::SAMPLE_JSON_HEADER, $req); 301 301 - $this->assertEquals(null, $response->body); 302 302 - 303 303 - $reqXml = Request::init()->sendsAndExpects(Mime::XML); 304 304 - $responseXml = new Response("", self::SAMPLE_XML_HEADER, $reqXml); 305 305 - $this->assertEquals(null, $responseXml->body); 306 306 - } 307 307 - 308 308 - function testNoAutoParse() 309 309 - { 310 310 - $req = Request::init()->sendsAndExpects(Mime::JSON)->withoutAutoParsing(); 311 311 - $response = new Response(self::SAMPLE_JSON_RESPONSE, self::SAMPLE_JSON_HEADER, $req); 312 312 - $this->assertInternalType('string', $response->body); 313 313 - $req = Request::init()->sendsAndExpects(Mime::JSON)->withAutoParsing(); 314 314 - $response = new Response(self::SAMPLE_JSON_RESPONSE, self::SAMPLE_JSON_HEADER, $req); 315 315 - $this->assertInternalType('object', $response->body); 316 316 - } 317 317 - 318 318 - function testParseHeaders() 319 319 - { 320 320 - $req = Request::init()->sendsAndExpects(Mime::JSON); 321 321 - $response = new Response(self::SAMPLE_JSON_RESPONSE, self::SAMPLE_JSON_HEADER, $req); 322 322 - $this->assertEquals('application/json', $response->headers['Content-Type']); 323 323 - } 324 324 - 325 325 - function testRawHeaders() 326 326 - { 327 327 - $req = Request::init()->sendsAndExpects(Mime::JSON); 328 328 - $response = new Response(self::SAMPLE_JSON_RESPONSE, self::SAMPLE_JSON_HEADER, $req); 329 329 - $this->assertContains('Content-Type: application/json', $response->raw_headers); 330 330 - } 331 331 - 332 332 - function testHasErrors() 333 333 - { 334 334 - $req = Request::init()->sendsAndExpects(Mime::JSON); 335 335 - $response = new Response('', "HTTP/1.1 100 Continue\r\n", $req); 336 336 - $this->assertFalse($response->hasErrors()); 337 337 - $response = new Response('', "HTTP/1.1 200 OK\r\n", $req); 338 338 - $this->assertFalse($response->hasErrors()); 339 339 - $response = new Response('', "HTTP/1.1 300 Multiple Choices\r\n", $req); 340 340 - $this->assertFalse($response->hasErrors()); 341 341 - $response = new Response('', "HTTP/1.1 400 Bad Request\r\n", $req); 342 342 - $this->assertTrue($response->hasErrors()); 343 343 - $response = new Response('', "HTTP/1.1 500 Internal Server Error\r\n", $req); 344 344 - $this->assertTrue($response->hasErrors()); 345 345 - } 346 346 - 347 347 - function test_parseCode() 348 348 - { 349 349 - $req = Request::init()->sendsAndExpects(Mime::JSON); 350 350 - $response = new Response(self::SAMPLE_JSON_RESPONSE, self::SAMPLE_JSON_HEADER, $req); 351 351 - $code = $response->_parseCode("HTTP/1.1 406 Not Acceptable\r\n"); 352 352 - $this->assertEquals(406, $code); 353 353 - } 354 354 - 355 355 - function testToString() 356 356 - { 357 357 - $req = Request::init()->sendsAndExpects(Mime::JSON); 358 358 - $response = new Response(self::SAMPLE_JSON_RESPONSE, self::SAMPLE_JSON_HEADER, $req); 359 359 - $this->assertEquals(self::SAMPLE_JSON_RESPONSE, (string)$response); 360 360 - } 361 361 - 362 362 - function test_parseHeaders() 363 363 - { 364 364 - $parse_headers = Response\Headers::fromString(self::SAMPLE_JSON_HEADER); 365 365 - $this->assertCount(3, $parse_headers); 366 366 - $this->assertEquals('application/json', $parse_headers['Content-Type']); 367 367 - $this->assertTrue(isset($parse_headers['Connection'])); 368 368 - } 369 369 - 370 370 - function testMultiHeaders() 371 371 - { 372 372 - $req = Request::init(); 373 373 - $response = new Response(self::SAMPLE_JSON_RESPONSE, self::SAMPLE_MULTI_HEADER, $req); 374 374 - $parse_headers = $response->_parseHeaders(self::SAMPLE_MULTI_HEADER); 375 375 - $this->assertEquals('Value1,Value2', $parse_headers['X-My-Header']); 376 376 - } 377 377 - 378 378 - function testDetectContentType() 379 379 - { 380 380 - $req = Request::init(); 381 381 - $response = new Response(self::SAMPLE_JSON_RESPONSE, self::SAMPLE_JSON_HEADER, $req); 382 382 - $this->assertEquals('application/json', $response->headers['Content-Type']); 383 383 - } 384 384 - 385 385 - function testMissingBodyContentType() 386 386 - { 387 387 - $body = 'A string'; 388 388 - $request = Request::post(HttpfulTest::TEST_URL, $body)->_curlPrep(); 389 389 - $this->assertEquals($body, $request->serialized_payload); 390 390 - } 391 391 - 392 392 - function testParentType() 393 393 - { 394 394 - // Parent type 395 395 - $request = Request::init()->sendsAndExpects(Mime::XML); 396 396 - $response = new Response('<xml><name>Nathan</name></xml>', self::SAMPLE_VENDOR_HEADER, $request); 397 397 - 398 398 - $this->assertEquals("application/xml", $response->parent_type); 399 399 - $this->assertEquals(self::SAMPLE_VENDOR_TYPE, $response->content_type); 400 400 - $this->assertTrue($response->is_mime_vendor_specific); 401 401 - 402 402 - // Make sure we still parsed as if it were plain old XML 403 403 - $this->assertEquals("Nathan", $response->body->name->__toString()); 404 404 - } 405 405 - 406 406 - function testMissingContentType() 407 407 - { 408 408 - // Parent type 409 409 - $request = Request::init()->sendsAndExpects(Mime::XML); 410 410 - $response = new Response('<xml><name>Nathan</name></xml>', 411 411 - "HTTP/1.1 200 OK 412 412 - Connection: keep-alive 413 413 - Transfer-Encoding: chunked\r\n", $request); 414 414 - 415 415 - $this->assertEquals("", $response->content_type); 416 416 - } 417 417 - 418 418 - function testCustomMimeRegistering() 419 419 - { 420 420 - // Register new mime type handler for "application/vnd.nategood.message+xml" 421 421 - Httpful::register(self::SAMPLE_VENDOR_TYPE, new DemoMimeHandler()); 422 422 - 423 423 - $this->assertTrue(Httpful::hasParserRegistered(self::SAMPLE_VENDOR_TYPE)); 424 424 - 425 425 - $request = Request::init(); 426 426 - $response = new Response('<xml><name>Nathan</name></xml>', self::SAMPLE_VENDOR_HEADER, $request); 427 427 - 428 428 - $this->assertEquals(self::SAMPLE_VENDOR_TYPE, $response->content_type); 429 429 - $this->assertEquals('custom parse', $response->body); 430 430 - } 431 431 - 432 432 - public function testShorthandMimeDefinition() 433 433 - { 434 434 - $r = Request::init()->expects('json'); 435 435 - $this->assertEquals(Mime::JSON, $r->expected_type); 436 436 - 437 437 - $r = Request::init()->expectsJson(); 438 438 - $this->assertEquals(Mime::JSON, $r->expected_type); 439 439 - } 440 440 - 441 441 - public function testOverrideXmlHandler() 442 442 - { 443 443 - // Lazy test... 444 444 - $prev = \Httpful\Httpful::get(\Httpful\Mime::XML); 445 445 - $this->assertEquals($prev, new \Httpful\Handlers\XmlHandler()); 446 446 - $conf = array('namespace' => 'http://example.com'); 447 447 - \Httpful\Httpful::register(\Httpful\Mime::XML, new \Httpful\Handlers\XmlHandler($conf)); 448 448 - $new = \Httpful\Httpful::get(\Httpful\Mime::XML); 449 449 - $this->assertNotEquals($prev, $new); 450 450 - } 451 451 - } 452 452 - 453 453 - class DemoMimeHandler extends \Httpful\Handlers\MimeHandlerAdapter { 454 454 - public function parse($body) { 455 455 - return 'custom parse'; 456 456 - } 457 457 - } 458 458 -

-9

externals/httpful/tests/phpunit.xml

reviewed

··· 1 1 - <phpunit> 2 2 - <testsuite name="Httpful"> 3 3 - <directory>.</directory> 4 4 - </testsuite> 5 5 - <logging> 6 6 - <log type="coverage-text" target="php://stdout" showUncoveredFiles="false"/> 7 7 - </logging> 8 8 - </phpunit> 9 9 -

-12

externals/restful/.gitignore

reviewed

··· 1 1 - # composer 2 2 - .buildpath 3 3 - composer.lock 4 4 - composer.phar 5 5 - vendor 6 6 - 7 7 - # phar 8 8 - *.phar 9 9 - 10 10 - # eclipse-pdt 11 11 - .settings 12 12 - .project

-8

externals/restful/.travis.yml

reviewed

··· 1 1 - language: php 2 2 - before_script: 3 3 - - curl -s http://getcomposer.org/installer | php 4 4 - - php composer.phar install --prefer-source 5 5 - script: phpunit --bootstrap vendor/autoload.php tests/ 6 6 - php: 7 7 - - 5.3 8 8 - - 5.4

-22

externals/restful/LICENSE

reviewed

··· 1 1 - Copyright (c) 2012 Noone 2 2 - 3 3 - MIT License 4 4 - 5 5 - Permission is hereby granted, free of charge, to any person obtaining 6 6 - a copy of this software and associated documentation files (the 7 7 - "Software"), to deal in the Software without restriction, including 8 8 - without limitation the rights to use, copy, modify, merge, publish, 9 9 - distribute, sublicense, and/or sell copies of the Software, and to 10 10 - permit persons to whom the Software is furnished to do so, subject to 11 11 - the following conditions: 12 12 - 13 13 - The above copyright notice and this permission notice shall be 14 14 - included in all copies or substantial portions of the Software. 15 15 - 16 16 - THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 17 17 - EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 18 18 - MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 19 19 - NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE 20 20 - LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 21 21 - OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION 22 22 - WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

-111

externals/restful/README.md

reviewed

··· 1 1 - # RESTful 2 2 - 3 3 - Library for writing RESTful PHP clients. 4 4 - 5 5 - [](http://travis-ci.org/bninja/restful) 6 6 - 7 7 - The design of this library was heavily influenced by [Httpful](https://github.com/nategood/httpful). 8 8 - 9 9 - ## Requirements 10 10 - 11 11 - - [PHP](http://www.php.net) >= 5.3 **with** [cURL](http://www.php.net/manual/en/curl.installation.php) 12 12 - - [Httpful](https://github.com/nategood/httpful) >= 0.1 13 13 - 14 14 - ## Issues 15 15 - 16 16 - Please use appropriately tagged github [issues](https://github.com/bninja/restful/issues) to request features or report bugs. 17 17 - 18 18 - ## Installation 19 19 - 20 20 - You can install using [composer](#composer), a [phar](#phar) package or from [source](#source). Note that RESTful is [PSR-0](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-0.md) compliant: 21 21 - 22 22 - ### Composer 23 23 - 24 24 - If you don't have Composer [install](http://getcomposer.org/doc/00-intro.md#installation) it: 25 25 - 26 26 - $ curl -s https://getcomposer.org/installer | php 27 27 - 28 28 - Add this to your `composer.json`: 29 29 - 30 30 - { 31 31 - "require": { 32 32 - "bninja/restful": "*" 33 33 - } 34 34 - } 35 35 - 36 36 - Refresh your dependencies: 37 37 - 38 38 - $ php composer.phar update 39 39 - 40 40 - 41 41 - Then make sure to `require` the autoloader and initialize both: 42 42 - 43 43 - <?php 44 44 - require(__DIR__ . '/vendor/autoload.php'); 45 45 - 46 46 - Httpful\Bootstrap::init(); 47 47 - RESTful\Bootstrap::init(); 48 48 - ... 49 49 - 50 50 - ### Phar 51 51 - 52 52 - Download an Httpful [phar](http://php.net/manual/en/book.phar.php) file, which are all [here](https://github.com/nategood/httpful/downloads): 53 53 - 54 54 - $ curl -s -L -o httpful.phar https://github.com/downloads/nategood/httpful/httpful.phar 55 55 - 56 56 - Download a RESTful [phar](http://php.net/manual/en/book.phar.php) file, which are all [here](https://github.com/bninja/restful/downloads): 57 57 - 58 58 - $ curl -s -L -o restful.phar https://github.com/bninja/restful/downloads/restful-{VERSION}.phar 59 59 - 60 60 - And then `include` both: 61 61 - 62 62 - <?php 63 63 - include(__DIR__ . '/httpful.phar'); 64 64 - include(__DIR__ . '/restful.phar'); 65 65 - ... 66 66 - 67 67 - ### Source 68 68 - 69 69 - Download [Httpful](https://github.com/nategood/httpful) source: 70 70 - 71 71 - $ curl -s -L -o httpful.zip https://github.com/nategood/httpful/zipball/master; 72 72 - $ unzip httpful.zip; mv nategood-httpful* httpful; rm httpful.zip 73 73 - 74 74 - Download the RESTful source: 75 75 - 76 76 - $ curl -s -L -o restful.zip https://github.com/bninja/restful/zipball/master 77 77 - $ unzip restful.zip; mv bninja-restful-* restful; rm restful.zip 78 78 - 79 79 - And then `require` both bootstrap files: 80 80 - 81 81 - <?php 82 82 - require(__DIR__ . "/httpful/bootstrap.php") 83 83 - require(__DIR__ . "/restful/bootstrap.php") 84 84 - ... 85 85 - 86 86 - ## Usage 87 87 - 88 88 - TODO 89 89 - 90 90 - ## Testing 91 91 - 92 92 - $ phpunit --bootstrap vendor/autoload.php tests/ 93 93 - 94 94 - ## Publishing 95 95 - 96 96 - 1. Ensure that **all** [tests](#testing) pass 97 97 - 2. Increment minor `VERSION` in `src/RESTful/Settings` and `composer.json` (`git commit -am 'v{VERSION} release'`) 98 98 - 3. Tag it (`git tag -a v{VERSION} -m 'v{VERSION} release'`) 99 99 - 4. Push the tag (`git push --tag`) 100 100 - 5. [Packagist](http://packagist.org/packages/bninja/restful) will see the new tag and take it from there 101 101 - 6. Build (`build-phar`) and upload a [phar](http://php.net/manual/en/book.phar.php) file 102 102 - 103 103 - ## Contributing 104 104 - 105 105 - 1. Fork it 106 106 - 2. Create your feature branch (`git checkout -b my-new-feature`) 107 107 - 3. Write your code **and [tests](#testing)** 108 108 - 4. Ensure all tests still pass (`phpunit --bootstrap vendor/autoload.php tests/`) 109 109 - 5. Commit your changes (`git commit -am 'Add some feature'`) 110 110 - 6. Push to the branch (`git push origin my-new-feature`) 111 111 - 7. Create new pull request

-4

externals/restful/bootstrap.php

reviewed

··· 1 1 - <?php 2 2 - 3 3 - require(__DIR__ . '/src/RESTful/Bootstrap.php'); 4 4 - \RESTful\Bootstrap::init();

-36

externals/restful/build-phar

reviewed

··· 1 1 - #!/usr/bin/php 2 2 - <?php 3 3 - include('src/RESTful/Settings.php'); 4 4 - 5 5 - function exit_unless($condition, $msg = null) { 6 6 - if ($condition) 7 7 - return; 8 8 - echo "[FAIL] $msg"; 9 9 - exit(1); 10 10 - } 11 11 - 12 12 - echo "Building Phar... "; 13 13 - $base_dir = dirname(__FILE__); 14 14 - $source_dir = $base_dir . '/src/RESTful/'; 15 15 - $phar_name = 'restful.phar'; 16 16 - $phar_path = $base_dir . '/' . $phar_name; 17 17 - $phar = new Phar($phar_path, 0, $phar_name); 18 18 - $stub = <<<HEREDOC 19 19 - <?php 20 20 - // Phar Stub File 21 21 - Phar::mapPhar('restful.phar'); 22 22 - include('phar://restful.phar/RESTful/Bootstrap.php'); 23 23 - \RESTful\Bootstrap::pharInit(); 24 24 - 25 25 - __HALT_COMPILER(); 26 26 - HEREDOC; 27 27 - $phar->setStub($stub); 28 28 - exit_unless($phar, "Unable to create a phar. Make sure you have phar.readonly=0 set in your ini file."); 29 29 - $phar->buildFromDirectory(dirname($source_dir)); 30 30 - echo "[ OK ]\n"; 31 31 - 32 32 - echo "Renaming Phar... "; 33 33 - $phar_versioned_name = 'restful-' . \RESTful\Settings::VERSION . '.phar'; 34 34 - $phar_versioned_path = $base_dir . '/' . $phar_versioned_name; 35 35 - rename($phar_path, $phar_versioned_path); 36 36 - echo "[ OK ]\n";

-18

externals/restful/composer.json

reviewed

··· 1 1 - { 2 2 - "name": "bninja/restful", 3 3 - "description": "Library for writing RESTful PHP clients.", 4 4 - "homepage": "http://github.com/bninja/restful", 5 5 - "license": "MIT", 6 6 - "keywords": ["http", "api", "client", "rest"], 7 7 - "version": "0.1.7", 8 8 - "authors": [ 9 9 - ], 10 10 - "require": { 11 11 - "nategood/httpful": "*" 12 12 - }, 13 13 - "autoload": { 14 14 - "psr-0": { 15 15 - "RESTful": "src/" 16 16 - } 17 17 - } 18 18 - }

-44

externals/restful/src/RESTful/Bootstrap.php

reviewed

··· 1 1 - <?php 2 2 - 3 3 - namespace RESTful; 4 4 - 5 5 - /** 6 6 - * Bootstrapper for RESTful does autoloading. 7 7 - */ 8 8 - class Bootstrap 9 9 - { 10 10 - const DIR_SEPARATOR = DIRECTORY_SEPARATOR; 11 11 - const NAMESPACE_SEPARATOR = '\\'; 12 12 - 13 13 - public static $initialized = false; 14 14 - 15 15 - 16 16 - public static function init() 17 17 - { 18 18 - spl_autoload_register(array('\RESTful\Bootstrap', 'autoload')); 19 19 - } 20 20 - 21 21 - public static function autoload($classname) 22 22 - { 23 23 - self::_autoload(dirname(dirname(__FILE__)), $classname); 24 24 - } 25 25 - 26 26 - public static function pharInit() 27 27 - { 28 28 - spl_autoload_register(array('\RESTful\Bootstrap', 'pharAutoload')); 29 29 - } 30 30 - 31 31 - public static function pharAutoload($classname) 32 32 - { 33 33 - self::_autoload('phar://restful.phar', $classname); 34 34 - } 35 35 - 36 36 - private static function _autoload($base, $classname) 37 37 - { 38 38 - $parts = explode(self::NAMESPACE_SEPARATOR, $classname); 39 39 - $path = $base . self::DIR_SEPARATOR . implode(self::DIR_SEPARATOR, $parts) . '.php'; 40 40 - if (file_exists($path)) { 41 41 - require_once($path); 42 42 - } 43 43 - } 44 44 - }

-78

externals/restful/src/RESTful/Client.php

reviewed

··· 1 1 - <?php 2 2 - 3 3 - namespace RESTful; 4 4 - 5 5 - use RESTful\Exceptions\HTTPError; 6 6 - use RESTful\Settings; 7 7 - 8 8 - class Client 9 9 - { 10 10 - public function __construct($settings_class, $request_class = null, $convert_error = null) 11 11 - { 12 12 - $this->request_class = $request_class == null ? '\Httpful\Request' : $request_class; 13 13 - $this->settings_class = $settings_class; 14 14 - $this->convert_error = $convert_error; 15 15 - } 16 16 - 17 17 - public function get($uri) 18 18 - { 19 19 - $settings_class = $this->settings_class; 20 20 - $url = $settings_class::$url_root . $uri; 21 21 - $request_class = $this->request_class; 22 22 - $request = $request_class::get($url); 23 23 - 24 24 - return $this->_op($request); 25 25 - } 26 26 - 27 27 - public function post($uri, $payload) 28 28 - { 29 29 - $settings_class = $this->settings_class; 30 30 - $url = $settings_class::$url_root . $uri; 31 31 - $request_class = $this->request_class; 32 32 - $request = $request_class::post($url, $payload, 'json'); 33 33 - 34 34 - return $this->_op($request); 35 35 - } 36 36 - 37 37 - public function put($uri, $payload) 38 38 - { 39 39 - $settings_class = $this->settings_class; 40 40 - $url = $settings_class::$url_root . $uri; 41 41 - $request_class = $this->request_class; 42 42 - $request = $request_class::put($url, $payload, 'json'); 43 43 - 44 44 - return $this->_op($request); 45 45 - } 46 46 - 47 47 - public function delete($uri) 48 48 - { 49 49 - $settings_class = $this->settings_class; 50 50 - $url = $settings_class::$url_root . $uri; 51 51 - $request_class = $this->request_class; 52 52 - $request = $request_class::delete($url); 53 53 - 54 54 - return $this->_op($request); 55 55 - } 56 56 - 57 57 - private function _op($request) 58 58 - { 59 59 - $settings_class = $this->settings_class; 60 60 - $user_agent = $settings_class::$agent . '/' . $settings_class::$version; 61 61 - $request->headers['User-Agent'] = $user_agent; 62 62 - if ($settings_class::$api_key != null) { 63 63 - $request = $request->authenticateWith($settings_class::$api_key, ''); 64 64 - } 65 65 - $request->expects('json'); 66 66 - $response = $request->sendIt(); 67 67 - if ($response->hasErrors() || $response->code == 300) { 68 68 - if ($this->convert_error != null) { 69 69 - $error = call_user_func($this->convert_error, $response); 70 70 - } else { 71 71 - $error = new HTTPError($response); 72 72 - } 73 73 - throw $error; 74 74 - } 75 75 - 76 76 - return $response; 77 77 - } 78 78 - }

-49

externals/restful/src/RESTful/Collection.php

reviewed

··· 1 1 - <?php 2 2 - 3 3 - namespace RESTful; 4 4 - 5 5 - class Collection extends Itemization 6 6 - { 7 7 - public function __construct($resource, $uri, $data = null) 8 8 - { 9 9 - parent::__construct($resource, $uri, $data); 10 10 - $this->_parseUri(); 11 11 - } 12 12 - 13 13 - private function _parseUri() 14 14 - { 15 15 - $parsed = parse_url($this->uri); 16 16 - $this->_uri = $parsed['path']; 17 17 - if (array_key_exists('query', $parsed)) { 18 18 - foreach (explode('&', $parsed['query']) as $param) { 19 19 - $param = explode('=', $param); 20 20 - $key = urldecode($param[0]); 21 21 - $val = (count($param) == 1) ? null : urldecode($param[1]); 22 22 - 23 23 - // size 24 24 - if ($key == 'limit') { 25 25 - $this->_size = $val; 26 26 - } 27 27 - } 28 28 - } 29 29 - } 30 30 - 31 31 - public function create($payload) 32 32 - { 33 33 - $class = $this->resource; 34 34 - $client = $class::getClient(); 35 35 - $response = $client->post($this->uri, $payload); 36 36 - 37 37 - return new $this->resource($response->body); 38 38 - } 39 39 - 40 40 - public function query() 41 41 - { 42 42 - return new Query($this->resource, $this->uri); 43 43 - } 44 44 - 45 45 - public function paginate() 46 46 - { 47 47 - return new Pagination($this->resource, $this->uri); 48 48 - } 49 49 - }

-10

externals/restful/src/RESTful/Exceptions/Base.php

reviewed

··· 1 1 - <?php 2 2 - 3 3 - namespace RESTful\Exceptions; 4 4 - 5 5 - /** 6 6 - * Base class for all RESTful\Exceptions. 7 7 - */ 8 8 - class Base extends \Exception 9 9 - { 10 10 - }

-28

externals/restful/src/RESTful/Exceptions/HTTPError.php

reviewed

··· 1 1 - <?php 2 2 - 3 3 - namespace RESTful\Exceptions; 4 4 - 5 5 - /** 6 6 - * Indicates an HTTP level error has occurred. The underlying HTTP response is 7 7 - * stored as response member. The response payload fields if any are stored as 8 8 - * members of the same name. 9 9 - * 10 10 - * @see \Httpful\Response 11 11 - */ 12 12 - class HTTPError extends Base 13 13 - { 14 14 - public $response; 15 15 - 16 16 - public function __construct($response) 17 17 - { 18 18 - $this->response = $response; 19 19 - $this->_objectify($this->response->body); 20 20 - } 21 21 - 22 22 - protected function _objectify($fields) 23 23 - { 24 24 - foreach ($fields as $key => $val) { 25 25 - $this->$key = $val; 26 26 - } 27 27 - } 28 28 - }

-11

externals/restful/src/RESTful/Exceptions/MultipleResultsFound.php

reviewed

··· 1 1 - <?php 2 2 - 3 3 - namespace RESTful\Exceptions; 4 4 - 5 5 - /** 6 6 - * Indicates that a query unexpectedly returned multiple results when at most 7 7 - * one was expected. 8 8 - */ 9 9 - class MultipleResultsFound extends Base 10 10 - { 11 11 - }

-10

externals/restful/src/RESTful/Exceptions/NoResultFound.php

reviewed

··· 1 1 - <?php 2 2 - 3 3 - namespace RESTful\Exceptions; 4 4 - 5 5 - /** 6 6 - * Indicates that a query unexpectedly returned no results. 7 7 - */ 8 8 - class NoResultFound extends Base 9 9 - { 10 10 - }

-85

externals/restful/src/RESTful/Field.php

reviewed

··· 1 1 - <?php 2 2 - 3 3 - namespace RESTful; 4 4 - 5 5 - class Field 6 6 - { 7 7 - public $name; 8 8 - 9 9 - public function __construct($name) 10 10 - { 11 11 - $this->name = $name; 12 12 - } 13 13 - 14 14 - public function __get($name) 15 15 - { 16 16 - return new Field($this->name . '.' . $name); 17 17 - } 18 18 - 19 19 - public function in($vals) 20 20 - { 21 21 - return new FilterExpression($this->name, 'in', $vals, '!in'); 22 22 - } 23 23 - 24 24 - public function startswith($prefix) 25 25 - { 26 26 - if (!is_string($prefix)) { 27 27 - throw new \InvalidArgumentException('"startswith" prefix must be a string'); 28 28 - } 29 29 - 30 30 - return new FilterExpression($this->name, 'contains', $prefix); 31 31 - } 32 32 - 33 33 - public function endswith($suffix) 34 34 - { 35 35 - if (!is_string($suffix)) { 36 36 - throw new \InvalidArgumentException('"endswith" suffix must be a string'); 37 37 - } 38 38 - 39 39 - return new FilterExpression($this->name, 'contains', $suffix); 40 40 - } 41 41 - 42 42 - public function contains($fragment) 43 43 - { 44 44 - if (!is_string($fragment)) { 45 45 - throw new \InvalidArgumentException('"contains" fragment must be a string'); 46 46 - } 47 47 - 48 48 - return new FilterExpression($this->name, 'contains', $fragment, '!contains'); 49 49 - } 50 50 - 51 51 - public function eq($val) 52 52 - { 53 53 - return new FilterExpression($this->name, '=', $val, '!eq'); 54 54 - } 55 55 - 56 56 - public function lt($val) 57 57 - { 58 58 - return new FilterExpression($this->name, '<', $val, '>='); 59 59 - } 60 60 - 61 61 - public function lte($val) 62 62 - { 63 63 - return new FilterExpression($this->name, '<=', $val, '>'); 64 64 - } 65 65 - 66 66 - public function gt($val) 67 67 - { 68 68 - return new FilterExpression($this->name, '>', $val, '<='); 69 69 - } 70 70 - 71 71 - public function gte($val) 72 72 - { 73 73 - return new FilterExpression($this->name, '>=', $val, '<'); 74 74 - } 75 75 - 76 76 - public function asc() 77 77 - { 78 78 - return new SortExpression($this->name, true); 79 79 - } 80 80 - 81 81 - public function desc() 82 82 - { 83 83 - return new SortExpression($this->name, false); 84 84 - } 85 85 - }

-11

externals/restful/src/RESTful/Fields.php

reviewed

··· 1 1 - <?php 2 2 - 3 3 - namespace RESTful; 4 4 - 5 5 - class Fields 6 6 - { 7 7 - public function __get($name) 8 8 - { 9 9 - return new Field($name); 10 10 - } 11 11 - }

-31

externals/restful/src/RESTful/FilterExpression.php

reviewed

··· 1 1 - <?php 2 2 - 3 3 - namespace RESTful; 4 4 - 5 5 - class FilterExpression 6 6 - { 7 7 - public $field, 8 8 - $op, 9 9 - $val, 10 10 - $not_op; 11 11 - 12 12 - public function __construct($field, $op, $val, $not_op = null) 13 13 - { 14 14 - $this->field = $field; 15 15 - $this->op = $op; 16 16 - $this->val = $val; 17 17 - $this->not_op = $not_op; 18 18 - } 19 19 - 20 20 - public function not() 21 21 - { 22 22 - if (null === $this->not_op) { 23 23 - throw new \LogicException(sprintf('Filter cannot be inverted')); 24 24 - } 25 25 - $temp = $this->op; 26 26 - $this->op = $this->not_op; 27 27 - $this->not_op = $temp; 28 28 - 29 29 - return $this; 30 30 - } 31 31 - }

-99

externals/restful/src/RESTful/Itemization.php

reviewed

··· 1 1 - <?php 2 2 - 3 3 - namespace RESTful; 4 4 - 5 5 - class Itemization implements \IteratorAggregate, \ArrayAccess 6 6 - { 7 7 - public $resource, 8 8 - $uri; 9 9 - 10 10 - protected $_page, 11 11 - $_offset = 0, 12 12 - $_size = 25; 13 13 - 14 14 - public function __construct($resource, $uri, $data = null) 15 15 - { 16 16 - $this->resource = $resource; 17 17 - $this->uri = $uri; 18 18 - if ($data != null) { 19 19 - $this->_page = new Page($resource, $uri, $data); 20 20 - } else { 21 21 - $this->_page = null; 22 22 - } 23 23 - } 24 24 - 25 25 - protected function _getPage($offset = null) 26 26 - { 27 27 - if ($this->_page == null) { 28 28 - $this->_offset = ($offset == null) ? 0 : $offset * $this->_size; 29 29 - $uri = $this->_buildUri(); 30 30 - $this->_page = new Page($this->resource, $uri); 31 31 - } elseif ($offset != null) { 32 32 - $offset = $offset * $this->_size; 33 33 - if ($offset != $this->_offset) { 34 34 - $this->_offset = $offset; 35 35 - $uri = $this->_buildUri(); 36 36 - $this->_page = new Page($this->resource, $uri); 37 37 - } 38 38 - } 39 39 - 40 40 - return $this->_page; 41 41 - } 42 42 - 43 43 - protected function _getItem($offset) 44 44 - { 45 45 - $page_offset = floor($offset / $this->_size); 46 46 - $page = $this->_getPage($page_offset); 47 47 - 48 48 - return $page->items[$offset - $page->offset]; 49 49 - } 50 50 - 51 51 - public function total() 52 52 - { 53 53 - return $this->_getPage()->total; 54 54 - } 55 55 - 56 56 - protected function _buildUri($offset = null) 57 57 - { 58 58 - # TODO: hacky but works for now 59 59 - $offset = ($offset == null) ? $this->_offset : $offset; 60 60 - if (strpos($this->uri, '?') === false) { 61 61 - $uri = $this->uri . '?'; 62 62 - } else { 63 63 - $uri = $this->uri . '&'; 64 64 - } 65 65 - $uri = $uri . 'offset=' . strval($offset); 66 66 - 67 67 - return $uri; 68 68 - } 69 69 - 70 70 - // IteratorAggregate 71 71 - public function getIterator() 72 72 - { 73 73 - $uri = $this->_buildUri($offset = 0); 74 74 - $uri = $this->_buildUri($offset = 0); 75 75 - 76 76 - return new ItemizationIterator($this->resource, $uri); 77 77 - } 78 78 - 79 79 - // ArrayAccess 80 80 - public function offsetSet($offset, $value) 81 81 - { 82 82 - throw new \BadMethodCallException(get_class($this) . ' array access is read-only'); 83 83 - } 84 84 - 85 85 - public function offsetExists($offset) 86 86 - { 87 87 - return (0 <= $offset && $offset < $this->total()); 88 88 - } 89 89 - 90 90 - public function offsetUnset($offset) 91 91 - { 92 92 - throw new \BadMethodCallException(get_class($this) . ' array access is read-only'); 93 93 - } 94 94 - 95 95 - public function offsetGet($offset) 96 96 - { 97 97 - return $this->_getItem($offset); 98 98 - } 99 99 - }

-45

externals/restful/src/RESTful/ItemizationIterator.php

reviewed

··· 1 1 - <?php 2 2 - 3 3 - namespace RESTful; 4 4 - 5 5 - class ItemizationIterator implements \Iterator 6 6 - { 7 7 - protected $_page, 8 8 - $_offset = 0; 9 9 - 10 10 - public function __construct($resource, $uri, $data = null) 11 11 - { 12 12 - $this->_page = new Page($resource, $uri, $data); 13 13 - } 14 14 - 15 15 - // Iterator 16 16 - public function current() 17 17 - { 18 18 - return $this->_page->items[$this->_offset]; 19 19 - } 20 20 - 21 21 - public function key() 22 22 - { 23 23 - return $this->_page->offset + $this->_offset; 24 24 - } 25 25 - 26 26 - public function next() 27 27 - { 28 28 - $this->_offset += 1; 29 29 - if ($this->_offset >= count($this->_page->items)) { 30 30 - $this->_offset = 0; 31 31 - $this->_page = $this->_page->next(); 32 32 - } 33 33 - } 34 34 - 35 35 - public function rewind() 36 36 - { 37 37 - $this->_page = $this->_page->first(); 38 38 - $this->_offset = 0; 39 39 - } 40 40 - 41 41 - public function valid() 42 42 - { 43 43 - return ($this->_page != null && $this->_offset < count($this->_page->items)); 44 44 - } 45 45 - }

-72

externals/restful/src/RESTful/Page.php

reviewed

··· 1 1 - <?php 2 2 - 3 3 - namespace RESTful; 4 4 - 5 5 - class Page 6 6 - { 7 7 - public $resource, 8 8 - $total, 9 9 - $items, 10 10 - $offset, 11 11 - $limit; 12 12 - 13 13 - private $_first_uri, 14 14 - $_previous_uri, 15 15 - $_next_uri, 16 16 - $_last_uri; 17 17 - 18 18 - public function __construct($resource, $uri, $data = null) 19 19 - { 20 20 - $this->resource = $resource; 21 21 - if ($data == null) { 22 22 - $client = $resource::getClient(); 23 23 - $data = $client->get($uri)->body; 24 24 - } 25 25 - $this->total = $data->total; 26 26 - $this->items = array_map( 27 27 - function ($x) use ($resource) { 28 28 - return new $resource($x); 29 29 - }, 30 30 - $data->items); 31 31 - $this->offset = $data->offset; 32 32 - $this->limit = $data->limit; 33 33 - $this->_first_uri = property_exists($data, 'first_uri') ? $data->first_uri : null; 34 34 - $this->_previous_uri = property_exists($data, 'previous_uri') ? $data->previous_uri : null; 35 35 - $this->_next_uri = property_exists($data, 'next_uri') ? $data->next_uri : null; 36 36 - $this->_last_uri = property_exists($data, 'last_uri') ? $data->last_uri : null; 37 37 - } 38 38 - 39 39 - public function first() 40 40 - { 41 41 - return new Page($this->resource, $this->_first_uri); 42 42 - } 43 43 - 44 44 - public function next() 45 45 - { 46 46 - if (!$this->hasNext()) { 47 47 - return null; 48 48 - } 49 49 - 50 50 - return new Page($this->resource, $this->_next_uri); 51 51 - } 52 52 - 53 53 - public function hasNext() 54 54 - { 55 55 - return $this->_next_uri != null; 56 56 - } 57 57 - 58 58 - public function previous() 59 59 - { 60 60 - return new Page($this->resource, $this->_previous_uri); 61 61 - } 62 62 - 63 63 - public function hasPrevious() 64 64 - { 65 65 - return $this->_previous_uri != null; 66 66 - } 67 67 - 68 68 - public function last() 69 69 - { 70 70 - return new Page($this->resource, $this->_last_uri); 71 71 - } 72 72 - }

-90

externals/restful/src/RESTful/Pagination.php

reviewed

··· 1 1 - <?php 2 2 - 3 3 - namespace RESTful; 4 4 - 5 5 - class Pagination implements \IteratorAggregate, \ArrayAccess 6 6 - { 7 7 - public $resource, 8 8 - $uri; 9 9 - 10 10 - protected $_page, 11 11 - $_offset = 0, 12 12 - $_size = 25; 13 13 - 14 14 - public function __construct($resource, $uri, $data = null) 15 15 - { 16 16 - $this->resource = $resource; 17 17 - $this->uri = $uri; 18 18 - if ($data != null) { 19 19 - $this->_page = new Page($resource, $uri, $data); 20 20 - } else { 21 21 - $this->_page = null; 22 22 - } 23 23 - } 24 24 - 25 25 - protected function _getPage($offset = null) 26 26 - { 27 27 - if ($this->_page == null) { 28 28 - $this->_offset = ($offset == null) ? 0 : $offset * $this->_size; 29 29 - $uri = $this->_buildUri(); 30 30 - $this->_page = new Page($this->resource, $uri); 31 31 - } elseif ($offset != null) { 32 32 - $offset = $offset * $this->_size; 33 33 - if ($offset != $this->_offset) { 34 34 - $this->_offset = $offset; 35 35 - $uri = $this->_buildUri(); 36 36 - $this->_page = new Page($this->resource, $uri); 37 37 - } 38 38 - } 39 39 - 40 40 - return $this->_page; 41 41 - } 42 42 - 43 43 - public function total() 44 44 - { 45 45 - return floor($this->_getPage()->total / $this->_size); 46 46 - } 47 47 - 48 48 - protected function _buildUri($offset = null) 49 49 - { 50 50 - # TODO: hacky but works for now 51 51 - $offset = ($offset == null) ? $this->_offset : $offset; 52 52 - if (strpos($this->uri, '?') === false) { 53 53 - $uri = $this->uri . '?'; 54 54 - } else { 55 55 - $uri = $this->uri . '&'; 56 56 - } 57 57 - $uri = $uri . 'offset=' . strval($offset); 58 58 - 59 59 - return $uri; 60 60 - } 61 61 - 62 62 - // IteratorAggregate 63 63 - public function getIterator() 64 64 - { 65 65 - $uri = $this->_buildUri($offset = 0); 66 66 - 67 67 - return new PaginationIterator($this->resource, $uri); 68 68 - } 69 69 - 70 70 - // ArrayAccess 71 71 - public function offsetSet($offset, $value) 72 72 - { 73 73 - throw new \BadMethodCallException(get_class($this) . ' array access is read-only'); 74 74 - } 75 75 - 76 76 - public function offsetExists($offset) 77 77 - { 78 78 - return (0 <= $offset && $offset < $this->total()); 79 79 - } 80 80 - 81 81 - public function offsetUnset($offset) 82 82 - { 83 83 - throw new \BadMethodCallException(get_class($this) . ' array access is read-only'); 84 84 - } 85 85 - 86 86 - public function offsetGet($offset) 87 87 - { 88 88 - return $this->_getPage($offset); 89 89 - } 90 90 - }

-37

externals/restful/src/RESTful/PaginationIterator.php

reviewed

··· 1 1 - <?php 2 2 - 3 3 - namespace RESTful; 4 4 - 5 5 - class PaginationIterator implements \Iterator 6 6 - { 7 7 - public function __construct($resource, $uri, $data = null) 8 8 - { 9 9 - $this->_page = new Page($resource, $uri, $data); 10 10 - } 11 11 - 12 12 - // Iterator 13 13 - public function current() 14 14 - { 15 15 - return $this->_page; 16 16 - } 17 17 - 18 18 - public function key() 19 19 - { 20 20 - return $this->_page->index; 21 21 - } 22 22 - 23 23 - public function next() 24 24 - { 25 25 - $this->_page = $this->_page->next(); 26 26 - } 27 27 - 28 28 - public function rewind() 29 29 - { 30 30 - $this->_page = $this->_page->first(); 31 31 - } 32 32 - 33 33 - public function valid() 34 34 - { 35 35 - return $this->_page != null; 36 36 - } 37 37 - }

-161

externals/restful/src/RESTful/Query.php

reviewed

··· 1 1 - <?php 2 2 - 3 3 - namespace RESTful; 4 4 - 5 5 - use RESTful\Exceptions\NoResultFound; 6 6 - use RESTful\Exceptions\MultipleResultsFound; 7 7 - 8 8 - class Query extends Itemization 9 9 - { 10 10 - public $filters = array(), 11 11 - $sorts = array(), 12 12 - $size; 13 13 - 14 14 - public function __construct($resource, $uri) 15 15 - { 16 16 - parent::__construct($resource, $uri); 17 17 - $this->size = $this->_size; 18 18 - $this->_parseUri($uri); 19 19 - } 20 20 - 21 21 - private function _parseUri($uri) 22 22 - { 23 23 - $parsed = parse_url($uri); 24 24 - $this->uri = $parsed['path']; 25 25 - if (array_key_exists('query', $parsed)) { 26 26 - foreach (explode('&', $parsed['query']) as $param) { 27 27 - $param = explode('=', $param); 28 28 - $key = urldecode($param[0]); 29 29 - $val = (count($param) == 1) ? null : urldecode($param[1]); 30 30 - 31 31 - // limit 32 32 - if ($key == 'limit') { 33 33 - $this->size = $this->_size = $val; 34 34 - } // sorts 35 35 - else if ($key == 'sort') { 36 36 - array_push($this->sorts, $val); 37 37 - } // everything else 38 38 - else { 39 39 - if (!array_key_exists($key, $this->filters)) { 40 40 - $this->filters[$key] = array(); 41 41 - } 42 42 - if (!is_array($val)) { 43 43 - $val = array($val); 44 44 - } 45 45 - $this->filters[$key] = array_merge($this->filters[$key], $val); 46 46 - } 47 47 - } 48 48 - } 49 49 - } 50 50 - 51 51 - protected function _buildUri($offset = null) 52 52 - { 53 53 - // params 54 54 - $params = array_merge( 55 55 - $this->filters, 56 56 - array( 57 57 - 'sort' => $this->sorts, 58 58 - 'limit' => $this->_size, 59 59 - 'offset' => ($offset == null) ? $this->_offset : $offset 60 60 - ) 61 61 - ); 62 62 - $getSingle = function ($v) { 63 63 - if (is_array($v) && count($v) == 1) 64 64 - return $v[0]; 65 65 - return $v; 66 66 - }; 67 67 - $params = array_map($getSingle, $params); 68 68 - 69 69 - // url encode params 70 70 - // NOTE: http://stackoverflow.com/a/8171667/1339571 71 71 - $qs = http_build_query($params); 72 72 - $qs = preg_replace('/%5B(?:[0-9]|[1-9][0-9]+)%5D=/', '=', $qs); 73 73 - 74 74 - return $this->uri . '?' . $qs; 75 75 - } 76 76 - 77 77 - private function _reset() 78 78 - { 79 79 - $this->_page = null; 80 80 - } 81 81 - 82 82 - public function filter($expression) 83 83 - { 84 84 - if ($expression->op == '=') { 85 85 - $field = $expression->field; 86 86 - } else { 87 87 - $field = $expression->field . '[' . $expression->op . ']'; 88 88 - } 89 89 - if (is_array($expression->val)) { 90 90 - $val = implode(',', $expression->val); 91 91 - } else { 92 92 - $val = $expression->val; 93 93 - } 94 94 - if (!array_key_exists($field, $this->filters)) { 95 95 - $this->filters[$field] = array(); 96 96 - } 97 97 - array_push($this->filters[$field], $val); 98 98 - $this->_reset(); 99 99 - 100 100 - return $this; 101 101 - } 102 102 - 103 103 - public function sort($expression) 104 104 - { 105 105 - $dir = $expression->ascending ? 'asc' : 'desc'; 106 106 - array_push($this->sorts, $expression->field . ',' . $dir); 107 107 - $this->_reset(); 108 108 - 109 109 - return $this; 110 110 - } 111 111 - 112 112 - public function limit($limit) 113 113 - { 114 114 - $this->size = $this->_size = $limit; 115 115 - $this->_reset(); 116 116 - 117 117 - return $this; 118 118 - } 119 119 - 120 120 - public function all() 121 121 - { 122 122 - $items = array(); 123 123 - foreach ($this as $item) { 124 124 - array_push($items, $item); 125 125 - } 126 126 - 127 127 - return $items; 128 128 - } 129 129 - 130 130 - public function first() 131 131 - { 132 132 - $prev_size = $this->_size; 133 133 - $this->_size = 1; 134 134 - $page = new Page($this->resource, $this->_buildUri()); 135 135 - $this->_size = $prev_size; 136 136 - $item = count($page->items) != 0 ? $page->items[0] : null; 137 137 - 138 138 - return $item; 139 139 - } 140 140 - 141 141 - public function one() 142 142 - { 143 143 - $prev_size = $this->_size; 144 144 - $this->_size = 2; 145 145 - $page = new Page($this->resource, $this->_buildUri()); 146 146 - $this->_size = $prev_size; 147 147 - if (count($page->items) == 1) { 148 148 - return $page->items[0]; 149 149 - } 150 150 - if (count($page->items) == 0) { 151 151 - throw new NoResultFound(); 152 152 - } 153 153 - 154 154 - throw new MultipleResultsFound(); 155 155 - } 156 156 - 157 157 - public function paginate() 158 158 - { 159 159 - return new Pagination($this->resource, $this->_buildUri()); 160 160 - } 161 161 - }

-29

externals/restful/src/RESTful/Registry.php

reviewed

··· 1 1 - <?php 2 2 - 3 3 - namespace RESTful; 4 4 - 5 5 - class Registry 6 6 - { 7 7 - protected $_resources = array(); 8 8 - 9 9 - public function add($resource) 10 10 - { 11 11 - array_push($this->_resources, $resource); 12 12 - } 13 13 - 14 14 - public function match($uri) 15 15 - { 16 16 - foreach ($this->_resources as $resource) { 17 17 - $spec = $resource::getURISpec(); 18 18 - $result = $spec->match($uri); 19 19 - if ($result == null) { 20 20 - continue; 21 21 - } 22 22 - $result['class'] = $resource; 23 23 - 24 24 - return $result; 25 25 - } 26 26 - 27 27 - return null; 28 28 - } 29 29 - }

-205

externals/restful/src/RESTful/Resource.php

reviewed

··· 1 1 - <?php 2 2 - 3 3 - namespace RESTful; 4 4 - 5 5 - abstract class Resource 6 6 - { 7 7 - protected $_collection_uris, 8 8 - $_member_uris; 9 9 - 10 10 - public static function getClient() 11 11 - { 12 12 - $class = get_called_class(); 13 13 - 14 14 - return $class::$_client; 15 15 - } 16 16 - 17 17 - public static function getRegistry() 18 18 - { 19 19 - $class = get_called_class(); 20 20 - 21 21 - return $class::$_registry; 22 22 - } 23 23 - 24 24 - public static function getURISpec() 25 25 - { 26 26 - $class = get_called_class(); 27 27 - 28 28 - return $class::$_uri_spec; 29 29 - } 30 30 - 31 31 - public function __construct($fields = null) 32 32 - { 33 33 - if ($fields == null) { 34 34 - $fields = array(); 35 35 - } 36 36 - $this->_objectify($fields); 37 37 - } 38 38 - 39 39 - public function __get($name) 40 40 - { 41 41 - // collection uri 42 42 - if (array_key_exists($name, $this->_collection_uris)) { 43 43 - $result = $this->_collection_uris[$name]; 44 44 - $this->$name = new Collection($result['class'], $result['uri']); 45 45 - 46 46 - return $this->$name; 47 47 - } // member uri 48 48 - else if (array_key_exists($name, $this->_member_uris)) { 49 49 - $result = $this->$_collection_uris[$name]; 50 50 - $response = self::getClient() . get($result['uri']); 51 51 - $class = $result['class']; 52 52 - $this->$name = new $class($response->body); 53 53 - 54 54 - return $this->$name; 55 55 - } 56 56 - 57 57 - // unknown 58 58 - $trace = debug_backtrace(); 59 59 - trigger_error( 60 60 - sprintf('Undefined property via __get(): %s in %s on line %s', $name, $trace[0]['file'], $trace[0]['line']), 61 61 - E_USER_NOTICE 62 62 - ); 63 63 - 64 64 - return null; 65 65 - } 66 66 - 67 67 - public function __isset($name) 68 68 - { 69 69 - if (array_key_exists($name, $this->_collection_uris) || array_key_exists($name, $this->_member_uris)) { 70 70 - return true; 71 71 - } 72 72 - 73 73 - return false; 74 74 - } 75 75 - 76 76 - protected function _objectify($fields) 77 77 - { 78 78 - // initialize uris 79 79 - $this->_collection_uris = array(); 80 80 - $this->_member_uris = array(); 81 81 - 82 82 - foreach ($fields as $key => $val) { 83 83 - // nested uri 84 84 - if ((strlen($key) - 3) == strrpos($key, 'uri', 0) && $key != 'uri') { 85 85 - $result = self::getRegistry()->match($val); 86 86 - if ($result != null) { 87 87 - $name = substr($key, 0, -4); 88 88 - $class = $result['class']; 89 89 - if ($result['collection']) { 90 90 - $this->_collection_uris[$name] = array( 91 91 - 'class' => $class, 92 92 - 'uri' => $val, 93 93 - ); 94 94 - } else { 95 95 - $this->_member_uris[$name] = array( 96 96 - 'class' => $class, 97 97 - 'uri' => $val, 98 98 - ); 99 99 - } 100 100 - 101 101 - continue; 102 102 - } 103 103 - } elseif (is_object($val) && property_exists($val, 'uri')) { 104 104 - // nested 105 105 - $result = self::getRegistry()->match($val->uri); 106 106 - if ($result != null) { 107 107 - $class = $result['class']; 108 108 - if ($result['collection']) { 109 109 - $this->$key = new Collection($class, $val['uri'], $val); 110 110 - } else { 111 111 - $this->$key = new $class($val); 112 112 - } 113 113 - 114 114 - continue; 115 115 - } 116 116 - } elseif (is_array($val) && array_key_exists('uri', $val)) { 117 117 - $result = self::getRegistry()->match($val['uri']); 118 118 - if ($result != null) { 119 119 - $class = $result['class']; 120 120 - if ($result['collection']) { 121 121 - $this->$key = new Collection($class, $val['uri'], $val); 122 122 - } else { 123 123 - $this->$key = new $class($val); 124 124 - } 125 125 - 126 126 - continue; 127 127 - } 128 128 - } 129 129 - 130 130 - // default 131 131 - $this->$key = $val; 132 132 - } 133 133 - } 134 134 - 135 135 - public static function query() 136 136 - { 137 137 - $uri_spec = self::getURISpec(); 138 138 - if ($uri_spec == null || $uri_spec->collection_uri == null) { 139 139 - $msg = sprintf('Cannot directly query %s resources', get_called_class()); 140 140 - throw new \LogicException($msg); 141 141 - } 142 142 - 143 143 - return new Query(get_called_class(), $uri_spec->collection_uri); 144 144 - } 145 145 - 146 146 - public static function get($uri) 147 147 - { 148 148 - # id 149 149 - if (strncmp($uri, '/', 1)) { 150 150 - $uri_spec = self::getURISpec(); 151 151 - if ($uri_spec == null || $uri_spec->collection_uri == null) { 152 152 - $msg = sprintf('Cannot get %s resources by id %s', $class, $uri); 153 153 - throw new \LogicException($msg); 154 154 - } 155 155 - $uri = $uri_spec->collection_uri . '/' . $uri; 156 156 - } 157 157 - 158 158 - $response = self::getClient()->get($uri); 159 159 - $class = get_called_class(); 160 160 - 161 161 - return new $class($response->body); 162 162 - } 163 163 - 164 164 - public function save() 165 165 - { 166 166 - // payload 167 167 - $payload = array(); 168 168 - foreach ($this as $key => $val) { 169 169 - if ($key[0] == '_' || is_object($val)) { 170 170 - continue; 171 171 - } 172 172 - $payload[$key] = $val; 173 173 - } 174 174 - 175 175 - // update 176 176 - if (array_key_exists('uri', $payload)) { 177 177 - $uri = $payload['uri']; 178 178 - unset($payload['uri']); 179 179 - $response = self::getClient()->put($uri, $payload); 180 180 - } else { 181 181 - // create 182 182 - $class = get_class($this); 183 183 - if ($class::$_uri_spec == null || $class::$_uri_spec->collection_uri == null) { 184 184 - $msg = sprintf('Cannot directly create %s resources', $class); 185 185 - throw new \LogicException($msg); 186 186 - } 187 187 - $response = self::getClient()->post($class::$_uri_spec->collection_uri, $payload); 188 188 - } 189 189 - 190 190 - // re-objectify 191 191 - foreach ($this as $key => $val) { 192 192 - unset($this->$key); 193 193 - } 194 194 - $this->_objectify($response->body); 195 195 - 196 196 - return $this; 197 197 - } 198 198 - 199 199 - public function delete() 200 200 - { 201 201 - self::getClient()->delete($this->uri); 202 202 - 203 203 - return $this; 204 204 - } 205 205 - }

-12

externals/restful/src/RESTful/Settings.php

reviewed

··· 1 1 - <?php 2 2 - 3 3 - namespace RESTful; 4 4 - 5 5 - /** 6 6 - * Settings. 7 7 - * 8 8 - */ 9 9 - class Settings 10 10 - { 11 11 - const VERSION = '0.1.7'; 12 12 - }

-15

externals/restful/src/RESTful/SortExpression.php

reviewed

··· 1 1 - <?php 2 2 - 3 3 - namespace RESTful; 4 4 - 5 5 - class SortExpression 6 6 - { 7 7 - public $name, 8 8 - $ascending; 9 9 - 10 10 - public function __construct($field, $ascending = true) 11 11 - { 12 12 - $this->field = $field; 13 13 - $this->ascending = $ascending; 14 14 - } 15 15 - }

-58

externals/restful/src/RESTful/URISpec.php

reviewed

··· 1 1 - <?php 2 2 - 3 3 - namespace RESTful; 4 4 - 5 5 - class URISpec 6 6 - { 7 7 - public $collection_uri = null, 8 8 - $name, 9 9 - $idNames; 10 10 - 11 11 - public function __construct($name, $idNames, $root = null) 12 12 - { 13 13 - $this->name = $name; 14 14 - if (!is_array($idNames)) { 15 15 - $idNames = array($idNames); 16 16 - } 17 17 - $this->idNames = $idNames; 18 18 - if ($root != null) { 19 19 - if ($root == '' || substr($root, -1) == '/') { 20 20 - $this->collection_uri = $root . $name; 21 21 - } else { 22 22 - $this->collection_uri = $root . '/' . $name; 23 23 - } 24 24 - } 25 25 - } 26 26 - 27 27 - public function match($uri) 28 28 - { 29 29 - $parts = explode('/', rtrim($uri, "/")); 30 30 - 31 31 - // collection 32 32 - if ($parts[count($parts) - 1] == $this->name) { 33 33 - 34 34 - return array( 35 35 - 'collection' => true, 36 36 - ); 37 37 - } 38 38 - 39 39 - // non-member 40 40 - if (count($parts) < count($this->idNames) + 1 || 41 41 - $parts[count($parts) - 1 - count($this->idNames)] != $this->name 42 42 - ) { 43 43 - return null; 44 44 - } 45 45 - 46 46 - // member 47 47 - $ids = array_combine( 48 48 - $this->idNames, 49 49 - array_slice($parts, -count($this->idNames)) 50 50 - ); 51 51 - $result = array( 52 52 - 'collection' => false, 53 53 - 'ids' => $ids, 54 54 - ); 55 55 - 56 56 - return $result; 57 57 - } 58 58 - }

-241

externals/restful/tests/RESTful/CoreTest.php

reviewed

··· 1 1 - <?php 2 2 - 3 3 - namespace RESTful\Test; 4 4 - 5 5 - \RESTful\Bootstrap::init(); 6 6 - \Httpful\Bootstrap::init(); 7 7 - 8 8 - use RESTful\URISpec; 9 9 - use RESTful\Client; 10 10 - use RESTful\Registry; 11 11 - use RESTful\Fields; 12 12 - use RESTful\Query; 13 13 - use RESTful\Page; 14 14 - 15 15 - class Settings 16 16 - { 17 17 - public static $url_root = 'http://api.example.com'; 18 18 - 19 19 - public static $agent = 'example-php'; 20 20 - 21 21 - public static $version = '0.1.0'; 22 22 - 23 23 - public static $api_key = null; 24 24 - } 25 25 - 26 26 - class Resource extends \RESTful\Resource 27 27 - { 28 28 - public static $fields, $f; 29 29 - 30 30 - protected static $_client, $_registry, $_uri_spec; 31 31 - 32 32 - public static function init() 33 33 - { 34 34 - self::$_client = new Client('Settings'); 35 35 - self::$_registry = new Registry(); 36 36 - self::$f = self::$fields = new Fields(); 37 37 - } 38 38 - 39 39 - public static function getClient() 40 40 - { 41 41 - $class = get_called_class(); 42 42 - return $class::$_client; 43 43 - } 44 44 - 45 45 - public static function getRegistry() 46 46 - { 47 47 - $class = get_called_class(); 48 48 - return $class::$_registry; 49 49 - } 50 50 - 51 51 - public static function getURISpec() 52 52 - { 53 53 - $class = get_called_class(); 54 54 - return $class::$_uri_spec; 55 55 - } 56 56 - } 57 57 - 58 58 - Resource::init(); 59 59 - 60 60 - class A extends Resource 61 61 - { 62 62 - protected static $_uri_spec = null; 63 63 - 64 64 - public static function init() 65 65 - { 66 66 - self::$_uri_spec = new URISpec('as', 'id', '/'); 67 67 - self::$_registry->add(get_called_class()); 68 68 - } 69 69 - } 70 70 - 71 71 - A::init(); 72 72 - 73 73 - class B extends Resource 74 74 - { 75 75 - protected static $_uri_spec = null; 76 76 - 77 77 - public static function init() 78 78 - { 79 79 - self::$_uri_spec = new URISpec('bs', 'id', '/'); 80 80 - self::$_registry->add(get_called_class()); 81 81 - } 82 82 - } 83 83 - 84 84 - B::init(); 85 85 - 86 86 - class URISpecTest extends \PHPUnit_Framework_TestCase 87 87 - { 88 88 - public function testNoRoot() 89 89 - { 90 90 - $uri_spec = new URISpec('grapes', 'seed'); 91 91 - $this->assertEquals($uri_spec->collection_uri, null); 92 92 - 93 93 - $result = $uri_spec->match('/some/raisins'); 94 94 - $this->assertEquals($result, null); 95 95 - 96 96 - $result = $uri_spec->match('/some/grapes'); 97 97 - $this->assertEquals($result, array('collection' => true)); 98 98 - 99 99 - $result = $uri_spec->match('/some/grapes/1234'); 100 100 - $expected = array( 101 101 - 'collection' => false, 102 102 - 'ids' => array('seed' => '1234') 103 103 - ); 104 104 - $this->assertEquals($expected, $result); 105 105 - } 106 106 - 107 107 - public function testSingleId() 108 108 - { 109 109 - $uri_spec = new URISpec('tomatoes', 'stem', '/v1'); 110 110 - $this->assertNotEquals($uri_spec->collection_uri, null); 111 111 - 112 112 - $result = $uri_spec->match('/some/tomatoes/that/are/green'); 113 113 - $this->assertEquals($result, null); 114 114 - 115 115 - $result = $uri_spec->match('/some/tomatoes'); 116 116 - $this->assertEquals($result, array('collection' => true)); 117 117 - 118 118 - $result = $uri_spec->match('/some/tomatoes/4321'); 119 119 - $expected = array( 120 120 - 'collection' => false, 121 121 - 'ids' => array('stem' => '4321') 122 122 - ); 123 123 - $this->assertEquals($expected, $result); 124 124 - } 125 125 - 126 126 - public function testMultipleIds() 127 127 - { 128 128 - $uri_spec = new URISpec('tomatoes', array('stem', 'root'), '/v1'); 129 129 - $this->assertNotEquals($uri_spec->collection_uri, null); 130 130 - 131 131 - $result = $uri_spec->match('/some/tomatoes/that/are/green'); 132 132 - $this->assertEquals($result, null); 133 133 - 134 134 - $result = $uri_spec->match('/some/tomatoes'); 135 135 - $this->assertEquals($result, array('collection' => true)); 136 136 - 137 137 - $result = $uri_spec->match('/some/tomatoes/4321/1234'); 138 138 - $expected = array( 139 139 - 'collection' => false, 140 140 - 'ids' => array('stem' => '4321', 'root' => '1234') 141 141 - ); 142 142 - $this->assertEquals($expected, $result); 143 143 - } 144 144 - } 145 145 - 146 146 - class QueryTest extends \PHPUnit_Framework_TestCase 147 147 - { 148 148 - public function testParse() 149 149 - { 150 150 - $uri = '/some/uri?field2=123&sort=field5%2Cdesc&limit=101&field3.field4%5Bcontains%5D=hi'; 151 151 - $query = new Query('Resource', $uri); 152 152 - $expected = array( 153 153 - 'field2' => array('123'), 154 154 - 'field3.field4[contains]' => array('hi') 155 155 - ); 156 156 - $this->assertEquals($query->filters, $expected); 157 157 - $expected = array('field5,desc'); 158 158 - $this->assertEquals($query->sorts, $expected); 159 159 - $this->assertEquals($query->size, 101); 160 160 - } 161 161 - 162 162 - public function testBuild() 163 163 - { 164 164 - $query = new Query('Resource', '/some/uri'); 165 165 - $query->filter(Resource::$f->name->eq('Wonka Chocs')) 166 166 - ->filter(Resource::$f->support_email->endswith('gmail.com')) 167 167 - ->filter(Resource::$f->variable_fee_percentage->gte(3.5)) 168 168 - ->sort(Resource::$f->name->asc()) 169 169 - ->sort(Resource::$f->variable_fee_percentage->desc()) 170 170 - ->limit(101); 171 171 - $this->assertEquals( 172 172 - $query->filters, 173 173 - array( 174 174 - 'name' => array('Wonka Chocs'), 175 175 - 'support_email[contains]' => array('gmail.com'), 176 176 - 'variable_fee_percentage[>=]'=> array(3.5) 177 177 - ) 178 178 - ); 179 179 - $this->assertEquals( 180 180 - $query->sorts, 181 181 - array('name,asc', 'variable_fee_percentage,desc') 182 182 - ); 183 183 - $this->assertEquals( 184 184 - $query->size, 185 185 - 101 186 186 - ); 187 187 - } 188 188 - } 189 189 - 190 190 - class PageTest extends \PHPUnit_Framework_TestCase 191 191 - { 192 192 - public function testConstruct() 193 193 - { 194 194 - $data = new \stdClass(); 195 195 - $data->first_uri = 'some/first/uri'; 196 196 - $data->previous_uri = 'some/previous/uri'; 197 197 - $data->next_uri = null; 198 198 - $data->last_uri = 'some/last/uri'; 199 199 - $data->limit= 25; 200 200 - $data->offset = 0; 201 201 - $data->total = 101; 202 202 - $data->items = array(); 203 203 - 204 204 - $page = new Page( 205 205 - 'Resource', 206 206 - '/some/uri', 207 207 - $data 208 208 - ); 209 209 - 210 210 - $this->assertEquals($page->resource, 'Resource'); 211 211 - $this->assertEquals($page->total, 101); 212 212 - $this->assertEquals($page->items, array()); 213 213 - $this->assertTrue($page->hasPrevious()); 214 214 - $this->assertFalse($page->hasNext()); 215 215 - } 216 216 - } 217 217 - 218 218 - class ResourceTest extends \PHPUnit_Framework_TestCase 219 219 - { 220 220 - public function testQuery() 221 221 - { 222 222 - $query = A::query(); 223 223 - $this->assertEquals(get_class($query), 'RESTful\Query'); 224 224 - } 225 225 - 226 226 - public function testObjectify() 227 227 - { 228 228 - $a = new A(array( 229 229 - 'uri' => '/as/123', 230 230 - 'field1' => 123, 231 231 - 'b' => array( 232 232 - 'uri' => '/bs/321', 233 233 - 'field2' => 321 234 234 - )) 235 235 - ); 236 236 - $this->assertEquals(get_class($a), 'RESTful\Test\A'); 237 237 - $this->assertEquals($a->field1, 123); 238 238 - $this->assertEquals(get_class($a->b), 'RESTful\Test\B'); 239 239 - $this->assertEquals($a->b->field2, 321); 240 240 - } 241 241 - }

-8

externals/restful/tests/phpunit.xml

reviewed

··· 1 1 - <phpunit> 2 2 - <testsuite name="RESTful"> 3 3 - <directory>.</directory> 4 4 - </testsuite> 5 5 - <logging> 6 6 - <log type="coverage-text" target="php://stdout" showUncoveredFiles="false"/> 7 7 - </logging> 8 8 - </phpunit>

-21

externals/wepay/LICENSE

reviewed

··· 1 1 - MIT License 2 2 - 3 3 - Copyright (C) 2013, WePay, Inc. <api at wepay dot com> 4 4 - 5 5 - Permission is hereby granted, free of charge, to any person obtaining a copy of 6 6 - this software and associated documentation files (the "Software"), to deal in 7 7 - the Software without restriction, including without limitation the rights to 8 8 - use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies 9 9 - of the Software, and to permit persons to whom the Software is furnished to do 10 10 - so, subject to the following conditions: 11 11 - 12 12 - The above copyright notice and this permission notice shall be included in all 13 13 - copies or substantial portions of the Software. 14 14 - 15 15 - THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 16 - IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 17 - FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 18 - AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 19 - LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 20 - OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 21 - SOFTWARE.

-85

externals/wepay/README.md

reviewed

··· 1 1 - WePay PHP SDK 2 2 - ============= 3 3 - 4 4 - WePay's API allows you to easily add payments into your application. 5 5 - 6 6 - For full documentation, see [WePay's developer documentation](https://www.wepay.com/developer) 7 7 - 8 8 - Usage 9 9 - ----- 10 10 - 11 11 - In addition to the samples below, we have included a very basic demo application in the `demoapp` directory. See its README file for additional information. 12 12 - 13 13 - ### Configuration ### 14 14 - 15 15 - For all requests, you must initialize the SDK with your Client ID and Client Secret, into either Staging or Production mode. All API calls made against WePay's staging environment mirror production in functionality, but do not actually move money. This allows you to develop your application and test the checkout experience from the perspective of your users without spending any money on payments. Our [full documentation](https://www.wepay.com/developer) contains additional information on test account numbers you can use in addition to "magic" amounts you can use to trigger payment failures and reversals (helpful for testing IPNs). 16 16 - 17 17 - **Note:** Staging and Production are two completely independent environments and share NO data with each other. This means that in order to use staging, you must register at [stage.wepay.com](https://stage.wepay.com/developer) and get a set of API keys for your Staging application, and must do the same on Production when you are ready to go live. API keys and access tokens granted on stage *can not* be used on Production, and vice-versa. 18 18 - 19 19 - <?php 20 20 - require './wepay.php'; 21 21 - WePay::useProduction('YOUR CLIENT ID', 'YOUR CLIENT SECRET'); // To initialize staging, use WePay::useStaging('ID','SECRET'); instead. 22 22 - 23 23 - ### Authentication ### 24 24 - 25 25 - To obtain an access token for your user, you must redirect the user to WePay for authentication. WePay uses OAuth2 for authorization, which is detailed [in our documentation](https://www.wepay.com/developer/reference/oauth2). To generate the URI to which you must redirect your user, the SDK contains `WePay::getAuthorizationUri($scope, $redirect_uri)`. `$scope` should be an array of scope strings detailed in the documentation. To request full access (most useful for testing, since users may be weary of granting permission to your application if it wants to do too much), you pay pass in `WePay::getAllScopes()`. `$redirect_uri` must be a fully qualified URI where we will send the user after permission is granted (or not granted), and the domain must match your application settings. 26 26 - 27 27 - If the user grants permission, he or she will be redirected to your `$redirect_uri` with `code=XXXX` appended to the query string. If permission is not granted, we will instead put `error=XXXX` in the query string. If `code` is present, the following will exchange it for an access token. Note that codes are only valid for several minutes, so you should do this immediately after the user is redirected back to your website or application. 28 28 - 29 29 - <?php 30 30 - if (!empty($_GET['error'])) { 31 31 - // user did not grant permissions 32 32 - } 33 33 - elseif (empty($_GET['code'])) { 34 34 - // set $scope and $redirect_uri before doing this 35 35 - // this will send the user to WePay to authenticate 36 36 - $uri = WePay::getAuthorizationUri($scope, $redirect_uri); 37 37 - header("Location: $uri"); 38 38 - exit; 39 39 - } 40 40 - else { 41 41 - $info = WePay::getToken($_GET['code'], $redirect_uri); 42 42 - if ($info) { 43 43 - // YOUR ACCESS TOKEN IS HERE 44 44 - $access_token = $info->access_token; 45 45 - } 46 46 - else { 47 47 - // Unable to obtain access token 48 48 - } 49 49 - } 50 50 - 51 51 - Full details on the access token response are [here](https://www.wepay.com/developer/reference/oauth2#token). 52 52 - 53 53 - **Note:** If you only need access for yourself (e.g., for a personal storefront), the application settings page automatically creates an access token for you. Simply copy and paste it into your code rather than manually going through the authentication flow. 54 54 - 55 55 - ### Making API Calls ### 56 56 - 57 57 - With the `$access_token` from above, get a new SDK object: 58 58 - 59 59 - <?php 60 60 - $wepay = new WePay($access_token); 61 61 - 62 62 - Then you can make a simple API call. This will list the user's accounts available to your application: 63 63 - 64 64 - // (continued from above) 65 65 - try { 66 66 - $accounts = $wepay->request('account/find'); 67 67 - foreach ($accounts as $account) { 68 68 - echo "<a href=\"$account->account_uri\">$account->name</a>: $account->description <br />"; 69 69 - } 70 70 - } 71 71 - catch (WePayException $e) { 72 72 - // Something went wrong - normally you would log 73 73 - // this and give your user a more informative message 74 74 - echo $e->getMessage(); 75 75 - } 76 76 - 77 77 - And that's it! For more detail on what API calls are available, their parameters and responses, and what permissions they require, please see [our documentation](https://www.wepay.com/developer/reference). For some more detailed examples, look in the `demoapp` directory and check the README. Dropping the entire directory in a web-accessible location and adding your API keys should allow you to be up and running in just a few seconds. 78 78 - 79 79 - ### SSL Certificate ### 80 80 - 81 81 - If making an API call causes the following problem: 82 82 - 83 83 - Uncaught exception 'Exception' with message 'cURL error while making API call to WePay: SSL certificate problem, verify that the CA cert is OK. Details: error:14090086:SSL routines:SSL3_GET_SERVER_CERTIFICATE:certificate verify failed' 84 84 - 85 85 - You can read the solution here: https://support.wepay.com/entries/21095813-problem-with-ssl-certificate-verification

-13

externals/wepay/composer.json

reviewed

··· 1 1 - { 2 2 - "name": "wepay/php-sdk", 3 3 - "description": "WePay APIv2 SDK for PHP", 4 4 - "authors": [ 5 5 - { 6 6 - "name": "WePay", 7 7 - "email": "api@wepay.com" 8 8 - } 9 9 - ], 10 10 - "autoload": { 11 11 - "files": ["wepay.php"] 12 12 - } 13 13 - }

-19

externals/wepay/demoapp/README

reviewed

··· 1 1 - After registering your application at wepay.com (or stage.wepay.com), you 2 2 - need to make two updates to this application: 3 3 - 4 4 - 1 - set your client_id and client_secret in _shared.php 5 5 - 2 - set the redirect_uri in login.php 6 6 - 7 7 - That should be enough to start making API calls against WePay's API. While 8 8 - this is by no means a production-ready example, it should provide you a 9 9 - couple ideas on how to get running. 10 10 - 11 11 - It also defaults to requesting all possible scope fields in the 12 12 - authentication request. We suggest limiting the request to the minimum 13 13 - your application requires, which will maximize the chance the user 14 14 - grants permissions to your application. You can customize this in 15 15 - login.php. 16 16 - 17 17 - If you have any questions, please contact the API team: api@wepay.com 18 18 - 19 19 - - WePay

-4

externals/wepay/demoapp/_shared.php

reviewed

··· 1 1 - <?php 2 2 - require '../wepay.php'; 3 3 - Wepay::useStaging('YOUR CLIENT ID', 'YOUR CLIENT SECRET'); 4 4 - session_start();

-20

externals/wepay/demoapp/accountlist.php

reviewed

··· 1 1 - <?php 2 2 - require './_shared.php'; 3 3 - ?> 4 4 - <h1>WePay Demo App: Account List</h1> 5 5 - <a href="index.php">Back</a> 6 6 - <br /> 7 7 - 8 8 - <?php 9 9 - try { 10 10 - $wepay = new WePay($_SESSION['wepay_access_token']); 11 11 - $accounts = $wepay->request('account/find'); 12 12 - foreach ($accounts as $account) { 13 13 - echo "<a href=\"$account->account_uri\">$account->name</a>: $account->description <br />"; 14 14 - } 15 15 - } 16 16 - catch (WePayException $e) { 17 17 - // Something went wrong - normally you would log 18 18 - // this and give your user a more informative message 19 19 - echo $e->getMessage(); 20 20 - }

-20

externals/wepay/demoapp/index.php

reviewed

··· 1 1 - <?php 2 2 - require './_shared.php'; 3 3 - ?> 4 4 - 5 5 - <h1>WePay Demo App</h1> 6 6 - <?php if (empty($_SESSION['wepay_access_token'])): ?> 7 7 - 8 8 - <a href="login.php">Log in with WePay</a> 9 9 - 10 10 - <?php else: ?> 11 11 - 12 12 - <a href="user.php">User info</a> 13 13 - <br /> 14 14 - <a href="openaccount.php">Open new account</a> 15 15 - <br /> 16 16 - <a href="accountlist.php">Account list</a> 17 17 - <br /> 18 18 - <a href="logout.php">Log out</a> 19 19 - 20 20 - <?php endif; ?>

-41

externals/wepay/demoapp/login.php

reviewed

··· 1 1 - <?php 2 2 - require './_shared.php'; 3 3 - 4 4 - // ** YOU MUST CHANGE THIS FOR THE SAMPLE APP TO WORK ** 5 5 - $redirect_uri = 'http://YOUR SERVER NAME/login.php'; 6 6 - $scope = WePay::getAllScopes(); 7 7 - 8 8 - // If we are already logged in, send the user home 9 9 - if (!empty($_SESSION['wepay_access_token'])) { 10 10 - header('Location: index.php'); 11 11 - exit; 12 12 - } 13 13 - 14 14 - // If the authentication dance returned an error, catch it to avoid a 15 15 - // redirect loop. This usually indicates some sort of application issue, 16 16 - // like a domain mismatch on your redirect_uri 17 17 - if (!empty($_GET['error'])) { 18 18 - echo 'Error during user authentication: '; 19 19 - echo htmlentities($_GET['error_description']); 20 20 - exit; 21 21 - } 22 22 - 23 23 - // If we don't have a code from being redirected back here, 24 24 - // send the user to WePay to grant permissions. 25 25 - if (empty($_GET['code'])) { 26 26 - $uri = WePay::getAuthorizationUri($scope, $redirect_uri); 27 27 - header("Location: $uri"); 28 28 - } 29 29 - else { 30 30 - $info = WePay::getToken($_GET['code'], $redirect_uri); 31 31 - if ($info) { 32 32 - // Normally you'd integrate this into your existing auth system 33 33 - $_SESSION['wepay_access_token'] = $info->access_token; 34 34 - // If desired, you can also store $info->user_id somewhere 35 35 - header('Location: index.php'); 36 36 - } 37 37 - else { 38 38 - // Unable to obtain access token 39 39 - echo 'Unable to obtain access token from WePay.'; 40 40 - } 41 41 - }

-6

externals/wepay/demoapp/logout.php

reviewed

··· 1 1 - <?php 2 2 - session_start(); 3 3 - $_SESSION = array(); 4 4 - session_destroy(); 5 5 - header('Location: index.php'); 6 6 - exit;

-50

externals/wepay/demoapp/openaccount.php

reviewed

··· 1 1 - <?php 2 2 - require './_shared.php'; 3 3 - ?> 4 4 - <h1>WePay Demo App: Open Account</h1> 5 5 - <a href="index.php">Back</a> 6 6 - <br /> 7 7 - 8 8 - <?php 9 9 - if ($_SERVER['REQUEST_METHOD'] == 'POST') { 10 10 - if (isset($_POST['account_name']) && isset($_POST['account_description'])) { 11 11 - // WePay sanitizes its own data, but displaying raw POST data on your own site is a XSS security hole. 12 12 - $name = htmlentities($_POST['account_name']); 13 13 - $desc = htmlentities($_POST['account_description']); 14 14 - try { 15 15 - $wepay = new WePay($_SESSION['wepay_access_token']); 16 16 - $account = $wepay->request('account/create', array( 17 17 - 'name' => $name, 18 18 - 'description' => $desc, 19 19 - )); 20 20 - echo "Created account $name for '$desc'! View on WePay at <a href=\"$account->account_uri\">$account->account_uri</a>. See all of your accounts <a href=\"accountlist.php\">here</a>."; 21 21 - } 22 22 - catch (WePayException $e) { 23 23 - // Something went wrong - normally you would log 24 24 - // this and give your user a more informative message 25 25 - echo $e->getMessage(); 26 26 - } 27 27 - } 28 28 - else { 29 29 - echo 'Account name and description are both required.'; 30 30 - } 31 31 - } 32 32 - ?> 33 33 - 34 34 - <form method="post"> 35 35 - <fieldset> 36 36 - <legend>Account Info</legend> 37 37 - 38 38 - <label for="account_name">Account Name:</label><br /> 39 39 - <input type="text" id="account_name" name="account_name" placeholder="Ski Trip Savings"/> 40 40 - 41 41 - <br /><br /> 42 42 - 43 43 - <label for="account_description">Account Description: </label><br /> 44 44 - <textarea name="account_description" rows="10" cols="40" placeholder="Saving up some dough for our ski trip!"></textarea> 45 45 - 46 46 - <br /><br /> 47 47 - 48 48 - <input type="submit" value="Open account" /> 49 49 - </fieldset> 50 50 - </form>

-22

externals/wepay/demoapp/user.php

reviewed

··· 1 1 - <?php 2 2 - require './_shared.php'; 3 3 - ?> 4 4 - <h1>WePay Demo App: User Info</h1> 5 5 - <a href="index.php">Back</a> 6 6 - <br /> 7 7 - 8 8 - <?php 9 9 - try { 10 10 - $wepay = new WePay($_SESSION['wepay_access_token']); 11 11 - $user = $wepay->request('user'); 12 12 - echo '<dl>'; 13 13 - foreach ($user as $key => $value) { 14 14 - echo "<dt>$key</dt><dd>$value</dd>"; 15 15 - } 16 16 - echo '</dl>'; 17 17 - } 18 18 - catch (WePayException $e) { 19 19 - // Something went wrong - normally you would log 20 20 - // this and give your user a more informative message 21 21 - echo $e->getMessage(); 22 22 - }

-69

externals/wepay/iframe_demoapp/checkout.php

reviewed

··· 1 1 - <?php 2 2 - /** 3 3 - * This PHP script helps you do the iframe checkout 4 4 - * 5 5 - */ 6 6 - 7 7 - 8 8 - /** 9 9 - * Put your API credentials here: 10 10 - * Get these from your API app details screen 11 11 - * https://stage.wepay.com/app 12 12 - */ 13 13 - $client_id = "PUT YOUR CLIENT_ID HERE"; 14 14 - $client_secret = "PUT YOUR CLIENT_SECRET HERE"; 15 15 - $access_token = "PUT YOUR ACCESS TOKEN HERE"; 16 16 - $account_id = "PUT YOUR ACCOUNT_ID HERE"; // you can find your account ID via list_accounts.php which users the /account/find call 17 17 - 18 18 - /** 19 19 - * Initialize the WePay SDK object 20 20 - */ 21 21 - require '../wepay.php'; 22 22 - Wepay::useStaging($client_id, $client_secret); 23 23 - $wepay = new WePay($access_token); 24 24 - 25 25 - /** 26 26 - * Make the API request to get the checkout_uri 27 27 - * 28 28 - */ 29 29 - try { 30 30 - $checkout = $wepay->request('/checkout/create', array( 31 31 - 'account_id' => $account_id, // ID of the account that you want the money to go to 32 32 - 'amount' => 100, // dollar amount you want to charge the user 33 33 - 'short_description' => "this is a test payment", // a short description of what the payment is for 34 34 - 'type' => "GOODS", // the type of the payment - choose from GOODS SERVICE DONATION or PERSONAL 35 35 - 'mode' => "iframe", // put iframe here if you want the checkout to be in an iframe, regular if you want the user to be sent to WePay 36 36 - ) 37 37 - ); 38 38 - } catch (WePayException $e) { // if the API call returns an error, get the error message for display later 39 39 - $error = $e->getMessage(); 40 40 - } 41 41 - 42 42 - ?> 43 43 - 44 44 - <html> 45 45 - <head> 46 46 - </head> 47 47 - 48 48 - <body> 49 49 - 50 50 - <h1>Checkout:</h1> 51 51 - 52 52 - <p>The user will checkout here:</p> 53 53 - 54 54 - <?php if (isset($error)): ?> 55 55 - <h2 style="color:red">ERROR: <?php echo $error ?></h2> 56 56 - <?php else: ?> 57 57 - <div id="checkout_div"></div> 58 58 - 59 59 - <script type="text/javascript" src="https://stage.wepay.com/js/iframe.wepay.js"> 60 60 - </script> 61 61 - 62 62 - <script type="text/javascript"> 63 63 - WePay.iframe_checkout("checkout_div", "<?php echo $checkout->checkout_uri ?>"); 64 64 - </script> 65 65 - <?php endif; ?> 66 66 - 67 67 - </body> 68 68 - 69 69 - </html>

-74

externals/wepay/iframe_demoapp/list_accounts.php

reviewed

··· 1 1 - <?php 2 2 - /** 3 3 - * This PHP script helps you find your account_id 4 4 - * 5 5 - */ 6 6 - 7 7 - 8 8 - 9 9 - /** 10 10 - * Put your API credentials here: 11 11 - * Get these from your API app details screen 12 12 - * https://stage.wepay.com/app 13 13 - */ 14 14 - $client_id = "PUT YOUR CLIENT_ID HERE"; 15 15 - $client_secret = "PUT YOUR CLIENT_SECRET HERE"; 16 16 - $access_token = "PUT YOUR ACCESS TOKEN HERE"; 17 17 - 18 18 - /** 19 19 - * Initialize the WePay SDK object 20 20 - */ 21 21 - require '../wepay.php'; 22 22 - Wepay::useStaging($client_id, $client_secret); 23 23 - $wepay = new WePay($access_token); 24 24 - 25 25 - /** 26 26 - * Make the API request to get a list of all accounts this user owns 27 27 - * 28 28 - */ 29 29 - try { 30 30 - $accounts = $wepay->request('/account/find'); 31 31 - } catch (WePayException $e) { // if the API call returns an error, get the error message for display later 32 32 - $error = $e->getMessage(); 33 33 - } 34 34 - 35 35 - ?> 36 36 - 37 37 - <html> 38 38 - <head> 39 39 - </head> 40 40 - 41 41 - <body> 42 42 - 43 43 - <h1>List all accounts:</h1> 44 44 - 45 45 - <p>The following is a list of all accounts that this user owns</p> 46 46 - 47 47 - <?php if (isset($error)): ?> 48 48 - <h2 style="color:red">ERROR: <?php echo $error ?></h2> 49 49 - <?php elseif (empty($accounts)) : ?> 50 50 - <h2>You do not have any accounts. Go to <a href="https://stage.wepay.com.com">https://stage.wepay.com</a> to open an account.<h2> 51 51 - <?php else: ?> 52 52 - <table border="1"> 53 53 - <thead> 54 54 - <tr> 55 55 - <td>Account ID</td> 56 56 - <td>Account Name</td> 57 57 - <td>Account Description</td> 58 58 - </tr> 59 59 - </thead> 60 60 - <tbody> 61 61 - <?php foreach ($accounts as $a): ?> 62 62 - <tr> 63 63 - <td><?php echo $a->account_id ?></td> 64 64 - <td><?php echo $a->name ?></td> 65 65 - <td><?php echo $a->description ?></td> 66 66 - </tr> 67 67 - <?php endforeach;?> 68 68 - </tbody> 69 69 - </table> 70 70 - <?php endif; ?> 71 71 - 72 72 - </body> 73 73 - 74 74 - </html>

-291

externals/wepay/wepay.php

reviewed

··· 1 1 - <?php 2 2 - 3 3 - class WePay { 4 4 - 5 5 - /** 6 6 - * Version number - sent in user agent string 7 7 - */ 8 8 - const VERSION = '0.1.4'; 9 9 - 10 10 - /** 11 11 - * Scope fields 12 12 - * Passed into Wepay::getAuthorizationUri as array 13 13 - */ 14 14 - const SCOPE_MANAGE_ACCOUNTS = 'manage_accounts'; // Open and interact with accounts 15 15 - const SCOPE_VIEW_BALANCE = 'view_balance'; // View account balances 16 16 - const SCOPE_COLLECT_PAYMENTS = 'collect_payments'; // Create and interact with checkouts 17 17 - const SCOPE_VIEW_USER = 'view_user'; // Get details about authenticated user 18 18 - const SCOPE_PREAPPROVE_PAYMENTS = 'preapprove_payments'; // Create and interact with preapprovals 19 19 - const SCOPE_SEND_MONEY = 'send_money'; // For withdrawals 20 20 - 21 21 - /** 22 22 - * Application's client ID 23 23 - */ 24 24 - private static $client_id; 25 25 - 26 26 - /** 27 27 - * Application's client secret 28 28 - */ 29 29 - private static $client_secret; 30 30 - 31 31 - /** 32 32 - * @deprecated Use WePay::getAllScopes() instead. 33 33 - */ 34 34 - public static $all_scopes = array( 35 35 - self::SCOPE_MANAGE_ACCOUNTS, 36 36 - self::SCOPE_VIEW_BALANCE, 37 37 - self::SCOPE_COLLECT_PAYMENTS, 38 38 - self::SCOPE_PREAPPROVE_PAYMENTS, 39 39 - self::SCOPE_VIEW_USER, 40 40 - self::SCOPE_SEND_MONEY, 41 41 - ); 42 42 - 43 43 - /** 44 44 - * Determines whether to use WePay's staging or production servers 45 45 - */ 46 46 - private static $production = null; 47 47 - 48 48 - /** 49 49 - * cURL handle 50 50 - */ 51 51 - private static $ch = NULL; 52 52 - 53 53 - /** 54 54 - * Authenticated user's access token 55 55 - */ 56 56 - private $token; 57 57 - 58 58 - /** 59 59 - * Pass WePay::getAllScopes() into getAuthorizationUri if your application desires full access 60 60 - */ 61 61 - public static function getAllScopes() { 62 62 - return array( 63 63 - self::SCOPE_MANAGE_ACCOUNTS, 64 64 - self::SCOPE_VIEW_BALANCE, 65 65 - self::SCOPE_COLLECT_PAYMENTS, 66 66 - self::SCOPE_PREAPPROVE_PAYMENTS, 67 67 - self::SCOPE_VIEW_USER, 68 68 - self::SCOPE_SEND_MONEY, 69 69 - ); 70 70 - } 71 71 - 72 72 - /** 73 73 - * Generate URI used during oAuth authorization 74 74 - * Redirect your user to this URI where they can grant your application 75 75 - * permission to make API calls 76 76 - * @link https://www.wepay.com/developer/reference/oauth2 77 77 - * @param array $scope List of scope fields for which your application wants access 78 78 - * @param string $redirect_uri Where user goes after logging in at WePay (domain must match application settings) 79 79 - * @param array $options optional user_name,user_email which will be pre-filled on login form, state to be returned in querystring of redirect_uri 80 80 - * @return string URI to which you must redirect your user to grant access to your application 81 81 - */ 82 82 - public static function getAuthorizationUri(array $scope, $redirect_uri, array $options = array()) { 83 83 - // This does not use WePay::getDomain() because the user authentication 84 84 - // domain is different than the API call domain 85 85 - if (self::$production === null) { 86 86 - throw new RuntimeException('You must initialize the WePay SDK with WePay::useStaging() or WePay::useProduction()'); 87 87 - } 88 88 - $domain = self::$production ? 'https://www.wepay.com' : 'https://stage.wepay.com'; 89 89 - $uri = $domain . '/v2/oauth2/authorize?'; 90 90 - $uri .= http_build_query(array( 91 91 - 'client_id' => self::$client_id, 92 92 - 'redirect_uri' => $redirect_uri, 93 93 - 'scope' => implode(',', $scope), 94 94 - 'state' => empty($options['state']) ? '' : $options['state'], 95 95 - 'user_name' => empty($options['user_name']) ? '' : $options['user_name'], 96 96 - 'user_email' => empty($options['user_email']) ? '' : $options['user_email'], 97 97 - ), '', '&'); 98 98 - return $uri; 99 99 - } 100 100 - 101 101 - private static function getDomain() { 102 102 - if (self::$production === true) { 103 103 - return 'https://wepayapi.com/v2/'; 104 104 - } 105 105 - elseif (self::$production === false) { 106 106 - return 'https://stage.wepayapi.com/v2/'; 107 107 - } 108 108 - else { 109 109 - throw new RuntimeException('You must initialize the WePay SDK with WePay::useStaging() or WePay::useProduction()'); 110 110 - } 111 111 - } 112 112 - 113 113 - /** 114 114 - * Exchange a temporary access code for a (semi-)permanent access token 115 115 - * @param string $code 'code' field from query string passed to your redirect_uri page 116 116 - * @param string $redirect_uri Where user went after logging in at WePay (must match value from getAuthorizationUri) 117 117 - * @return StdClass|false 118 118 - * user_id 119 119 - * access_token 120 120 - * token_type 121 121 - */ 122 122 - public static function getToken($code, $redirect_uri) { 123 123 - $params = (array( 124 124 - 'client_id' => self::$client_id, 125 125 - 'client_secret' => self::$client_secret, 126 126 - 'redirect_uri' => $redirect_uri, 127 127 - 'code' => $code, 128 128 - 'state' => '', // do not hardcode 129 129 - )); 130 130 - $result = self::make_request('oauth2/token', $params); 131 131 - return $result; 132 132 - } 133 133 - 134 134 - /** 135 135 - * Configure SDK to run against WePay's production servers 136 136 - * @param string $client_id Your application's client id 137 137 - * @param string $client_secret Your application's client secret 138 138 - * @return void 139 139 - * @throws RuntimeException 140 140 - */ 141 141 - public static function useProduction($client_id, $client_secret) { 142 142 - if (self::$production !== null) { 143 143 - throw new RuntimeException('API mode has already been set.'); 144 144 - } 145 145 - self::$production = true; 146 146 - self::$client_id = $client_id; 147 147 - self::$client_secret = $client_secret; 148 148 - } 149 149 - 150 150 - /** 151 151 - * Configure SDK to run against WePay's staging servers 152 152 - * @param string $client_id Your application's client id 153 153 - * @param string $client_secret Your application's client secret 154 154 - * @return void 155 155 - * @throws RuntimeException 156 156 - */ 157 157 - public static function useStaging($client_id, $client_secret) { 158 158 - if (self::$production !== null) { 159 159 - throw new RuntimeException('API mode has already been set.'); 160 160 - } 161 161 - self::$production = false; 162 162 - self::$client_id = $client_id; 163 163 - self::$client_secret = $client_secret; 164 164 - } 165 165 - 166 166 - /** 167 167 - * Create a new API session 168 168 - * @param string $token - access_token returned from WePay::getToken 169 169 - */ 170 170 - public function __construct($token) { 171 171 - if ($token && !is_string($token)) { 172 172 - throw new InvalidArgumentException('$token must be a string, ' . gettype($token) . ' provided'); 173 173 - } 174 174 - $this->token = $token; 175 175 - } 176 176 - 177 177 - /** 178 178 - * Clean up cURL handle 179 179 - */ 180 180 - public function __destruct() { 181 181 - if (self::$ch) { 182 182 - curl_close(self::$ch); 183 183 - self::$ch = NULL; 184 184 - } 185 185 - } 186 186 - 187 187 - /** 188 188 - * create the cURL request and execute it 189 189 - */ 190 190 - private static function make_request($endpoint, $values, $headers = array()) 191 191 - { 192 192 - self::$ch = curl_init(); 193 193 - $headers = array_merge(array("Content-Type: application/json"), $headers); // always pass the correct Content-Type header 194 194 - curl_setopt(self::$ch, CURLOPT_USERAGENT, 'WePay v2 PHP SDK v' . self::VERSION); 195 195 - curl_setopt(self::$ch, CURLOPT_RETURNTRANSFER, true); 196 196 - curl_setopt(self::$ch, CURLOPT_HTTPHEADER, $headers); 197 197 - curl_setopt(self::$ch, CURLOPT_TIMEOUT, 30); // 30-second timeout, adjust to taste 198 198 - curl_setopt(self::$ch, CURLOPT_POST, !empty($values)); // WePay's API is not strictly RESTful, so all requests are sent as POST unless there are no request values 199 199 - 200 200 - $uri = self::getDomain() . $endpoint; 201 201 - curl_setopt(self::$ch, CURLOPT_URL, $uri); 202 202 - 203 203 - if (!empty($values)) { 204 204 - curl_setopt(self::$ch, CURLOPT_POSTFIELDS, json_encode($values)); 205 205 - } 206 206 - 207 207 - $raw = curl_exec(self::$ch); 208 208 - if ($errno = curl_errno(self::$ch)) { 209 209 - // Set up special handling for request timeouts 210 210 - if ($errno == CURLE_OPERATION_TIMEOUTED) { 211 211 - throw new WePayServerException("Timeout occurred while trying to connect to WePay"); 212 212 - } 213 213 - throw new Exception('cURL error while making API call to WePay: ' . curl_error(self::$ch), $errno); 214 214 - } 215 215 - $result = json_decode($raw); 216 216 - $httpCode = curl_getinfo(self::$ch, CURLINFO_HTTP_CODE); 217 217 - if ($httpCode >= 400) { 218 218 - if (!isset($result->error_code)) { 219 219 - throw new WePayServerException("WePay returned an error response with no error_code, please alert api@wepay.com. Original message: $result->error_description", $httpCode, $result, 0); 220 220 - } 221 221 - if ($httpCode >= 500) { 222 222 - throw new WePayServerException($result->error_description, $httpCode, $result, $result->error_code); 223 223 - } 224 224 - switch ($result->error) { 225 225 - case 'invalid_request': 226 226 - throw new WePayRequestException($result->error_description, $httpCode, $result, $result->error_code); 227 227 - case 'access_denied': 228 228 - default: 229 229 - throw new WePayPermissionException($result->error_description, $httpCode, $result, $result->error_code); 230 230 - } 231 231 - } 232 232 - 233 233 - return $result; 234 234 - } 235 235 - 236 236 - /** 237 237 - * Make API calls against authenticated user 238 238 - * @param string $endpoint - API call to make (ex. 'user', 'account/find') 239 239 - * @param array $values - Associative array of values to send in API call 240 240 - * @return StdClass 241 241 - * @throws WePayException on failure 242 242 - * @throws Exception on catastrophic failure (non-WePay-specific cURL errors) 243 243 - */ 244 244 - public function request($endpoint, array $values = array()) { 245 245 - $headers = array(); 246 246 - 247 247 - if ($this->token) { // if we have an access_token, add it to the Authorization header 248 248 - $headers[] = "Authorization: Bearer $this->token"; 249 249 - } 250 250 - 251 251 - $result = self::make_request($endpoint, $values, $headers); 252 252 - 253 253 - return $result; 254 254 - } 255 255 - } 256 256 - 257 257 - /** 258 258 - * Different problems will have different exception types so you can 259 259 - * catch and handle them differently. 260 260 - * 261 261 - * WePayServerException indicates some sort of 500-level error code and 262 262 - * was unavoidable from your perspective. You may need to re-run the 263 263 - * call, or check whether it was received (use a "find" call with your 264 264 - * reference_id and make a decision based on the response) 265 265 - * 266 266 - * WePayRequestException indicates a development error - invalid endpoint, 267 267 - * erroneous parameter, etc. 268 268 - * 269 269 - * WePayPermissionException indicates your authorization token has expired, 270 270 - * was revoked, or is lacking in scope for the call you made 271 271 - */ 272 272 - class WePayException extends Exception { 273 273 - public function __construct($description = '', $http_code = FALSE, $response = FALSE, $code = 0, $previous = NULL) 274 274 - { 275 275 - $this->response = $response; 276 276 - 277 277 - if (!defined('PHP_VERSION_ID')) { 278 278 - $version = explode('.', PHP_VERSION); 279 279 - define('PHP_VERSION_ID', ($version[0] * 10000 + $version[1] * 100 + $version[2])); 280 280 - } 281 281 - 282 282 - if (PHP_VERSION_ID < 50300) { 283 283 - parent::__construct($description, $code); 284 284 - } else { 285 285 - parent::__construct($description, $code, $previous); 286 286 - } 287 287 - } 288 288 - } 289 289 - class WePayRequestException extends WePayException {} 290 290 - class WePayPermissionException extends WePayException {} 291 291 - class WePayServerException extends WePayException {}

-2

src/__phutil_library_map__.php

reviewed

··· 5248 5248 'PhortuneSubscriptionViewController' => 'applications/phortune/controller/subscription/PhortuneSubscriptionViewController.php', 5249 5249 'PhortuneSubscriptionWorker' => 'applications/phortune/worker/PhortuneSubscriptionWorker.php', 5250 5250 'PhortuneTestPaymentProvider' => 'applications/phortune/provider/PhortuneTestPaymentProvider.php', 5251 5251 - 'PhortuneWePayPaymentProvider' => 'applications/phortune/provider/PhortuneWePayPaymentProvider.php', 5252 5251 'PhragmentBrowseController' => 'applications/phragment/controller/PhragmentBrowseController.php', 5253 5252 'PhragmentCanCreateCapability' => 'applications/phragment/capability/PhragmentCanCreateCapability.php', 5254 5253 'PhragmentConduitAPIMethod' => 'applications/phragment/conduit/PhragmentConduitAPIMethod.php', ··· 11697 11696 'PhortuneSubscriptionViewController' => 'PhortuneController', 11698 11697 'PhortuneSubscriptionWorker' => 'PhabricatorWorker', 11699 11698 'PhortuneTestPaymentProvider' => 'PhortunePaymentProvider', 11700 11700 - 'PhortuneWePayPaymentProvider' => 'PhortunePaymentProvider', 11701 11699 'PhragmentBrowseController' => 'PhragmentController', 11702 11700 'PhragmentCanCreateCapability' => 'PhabricatorPolicyCapability', 11703 11701 'PhragmentConduitAPIMethod' => 'ConduitAPIMethod',

-405

src/applications/phortune/provider/PhortuneWePayPaymentProvider.php

reviewed

··· 1 1 - <?php 2 2 - 3 3 - final class PhortuneWePayPaymentProvider extends PhortunePaymentProvider { 4 4 - 5 5 - const WEPAY_CLIENT_ID = 'wepay.client-id'; 6 6 - const WEPAY_CLIENT_SECRET = 'wepay.client-secret'; 7 7 - const WEPAY_ACCESS_TOKEN = 'wepay.access-token'; 8 8 - const WEPAY_ACCOUNT_ID = 'wepay.account-id'; 9 9 - 10 10 - public function isAcceptingLivePayments() { 11 11 - return preg_match('/^PRODUCTION_/', $this->getWePayAccessToken()); 12 12 - } 13 13 - 14 14 - public function getName() { 15 15 - return pht('WePay'); 16 16 - } 17 17 - 18 18 - public function getConfigureName() { 19 19 - return pht('Add WePay Payments Account'); 20 20 - } 21 21 - 22 22 - public function getConfigureDescription() { 23 23 - return pht( 24 24 - 'Allows you to accept credit or debit card payments with a '. 25 25 - 'wepay.com account.'); 26 26 - } 27 27 - 28 28 - public function getConfigureProvidesDescription() { 29 29 - return pht('This merchant accepts credit and debit cards via WePay.'); 30 30 - } 31 31 - 32 32 - public function getConfigureInstructions() { 33 33 - return pht( 34 34 - "To configure WePay, register or log in to an existing account on ". 35 35 - "[[https://wepay.com | wepay.com]] (for live payments) or ". 36 36 - "[[https://stage.wepay.com | stage.wepay.com]] (for testing). ". 37 37 - "Once logged in:\n\n". 38 38 - " - Create an API application if you don't already have one.\n". 39 39 - " - Click the API application name to go to the detail page.\n". 40 40 - " - Copy **Client ID**, **Client Secret**, **Access Token** and ". 41 41 - " **AccountID** from that page to the fields above.\n\n". 42 42 - "You can either use `stage.wepay.com` to retrieve test credentials, ". 43 43 - "or `wepay.com` to retrieve live credentials for accepting live ". 44 44 - "payments."); 45 45 - } 46 46 - 47 47 - public function canRunConfigurationTest() { 48 48 - return true; 49 49 - } 50 50 - 51 51 - public function runConfigurationTest() { 52 52 - $this->loadWePayAPILibraries(); 53 53 - 54 54 - WePay::useStaging( 55 55 - $this->getWePayClientID(), 56 56 - $this->getWePayClientSecret()); 57 57 - 58 58 - $wepay = new WePay($this->getWePayAccessToken()); 59 59 - $params = array( 60 60 - 'client_id' => $this->getWePayClientID(), 61 61 - 'client_secret' => $this->getWePayClientSecret(), 62 62 - ); 63 63 - 64 64 - $wepay->request('app', $params); 65 65 - } 66 66 - 67 67 - public function getAllConfigurableProperties() { 68 68 - return array( 69 69 - self::WEPAY_CLIENT_ID, 70 70 - self::WEPAY_CLIENT_SECRET, 71 71 - self::WEPAY_ACCESS_TOKEN, 72 72 - self::WEPAY_ACCOUNT_ID, 73 73 - ); 74 74 - } 75 75 - 76 76 - public function getAllConfigurableSecretProperties() { 77 77 - return array( 78 78 - self::WEPAY_CLIENT_SECRET, 79 79 - ); 80 80 - } 81 81 - 82 82 - public function processEditForm( 83 83 - AphrontRequest $request, 84 84 - array $values) { 85 85 - 86 86 - $errors = array(); 87 87 - $issues = array(); 88 88 - 89 89 - if (!strlen($values[self::WEPAY_CLIENT_ID])) { 90 90 - $errors[] = pht('WePay Client ID is required.'); 91 91 - $issues[self::WEPAY_CLIENT_ID] = pht('Required'); 92 92 - } 93 93 - 94 94 - if (!strlen($values[self::WEPAY_CLIENT_SECRET])) { 95 95 - $errors[] = pht('WePay Client Secret is required.'); 96 96 - $issues[self::WEPAY_CLIENT_SECRET] = pht('Required'); 97 97 - } 98 98 - 99 99 - if (!strlen($values[self::WEPAY_ACCESS_TOKEN])) { 100 100 - $errors[] = pht('WePay Access Token is required.'); 101 101 - $issues[self::WEPAY_ACCESS_TOKEN] = pht('Required'); 102 102 - } 103 103 - 104 104 - if (!strlen($values[self::WEPAY_ACCOUNT_ID])) { 105 105 - $errors[] = pht('WePay Account ID is required.'); 106 106 - $issues[self::WEPAY_ACCOUNT_ID] = pht('Required'); 107 107 - } 108 108 - 109 109 - return array($errors, $issues, $values); 110 110 - } 111 111 - 112 112 - public function extendEditForm( 113 113 - AphrontRequest $request, 114 114 - AphrontFormView $form, 115 115 - array $values, 116 116 - array $issues) { 117 117 - 118 118 - $form 119 119 - ->appendChild( 120 120 - id(new AphrontFormTextControl()) 121 121 - ->setName(self::WEPAY_CLIENT_ID) 122 122 - ->setValue($values[self::WEPAY_CLIENT_ID]) 123 123 - ->setError(idx($issues, self::WEPAY_CLIENT_ID, true)) 124 124 - ->setLabel(pht('WePay Client ID'))) 125 125 - ->appendChild( 126 126 - id(new AphrontFormTextControl()) 127 127 - ->setName(self::WEPAY_CLIENT_SECRET) 128 128 - ->setValue($values[self::WEPAY_CLIENT_SECRET]) 129 129 - ->setError(idx($issues, self::WEPAY_CLIENT_SECRET, true)) 130 130 - ->setLabel(pht('WePay Client Secret'))) 131 131 - ->appendChild( 132 132 - id(new AphrontFormTextControl()) 133 133 - ->setName(self::WEPAY_ACCESS_TOKEN) 134 134 - ->setValue($values[self::WEPAY_ACCESS_TOKEN]) 135 135 - ->setError(idx($issues, self::WEPAY_ACCESS_TOKEN, true)) 136 136 - ->setLabel(pht('WePay Access Token'))) 137 137 - ->appendChild( 138 138 - id(new AphrontFormTextControl()) 139 139 - ->setName(self::WEPAY_ACCOUNT_ID) 140 140 - ->setValue($values[self::WEPAY_ACCOUNT_ID]) 141 141 - ->setError(idx($issues, self::WEPAY_ACCOUNT_ID, true)) 142 142 - ->setLabel(pht('WePay Account ID'))); 143 143 - 144 144 - } 145 145 - 146 146 - public function getPaymentMethodDescription() { 147 147 - return pht('Credit or Debit Card'); 148 148 - } 149 149 - 150 150 - public function getPaymentMethodIcon() { 151 151 - return 'WePay'; 152 152 - } 153 153 - 154 154 - public function getPaymentMethodProviderDescription() { 155 155 - return 'WePay'; 156 156 - } 157 157 - 158 158 - protected function executeCharge( 159 159 - PhortunePaymentMethod $payment_method, 160 160 - PhortuneCharge $charge) { 161 161 - throw new Exception('!'); 162 162 - } 163 163 - 164 164 - private function getWePayClientID() { 165 165 - return $this 166 166 - ->getProviderConfig() 167 167 - ->getMetadataValue(self::WEPAY_CLIENT_ID); 168 168 - } 169 169 - 170 170 - private function getWePayClientSecret() { 171 171 - return $this 172 172 - ->getProviderConfig() 173 173 - ->getMetadataValue(self::WEPAY_CLIENT_SECRET); 174 174 - } 175 175 - 176 176 - private function getWePayAccessToken() { 177 177 - return $this 178 178 - ->getProviderConfig() 179 179 - ->getMetadataValue(self::WEPAY_ACCESS_TOKEN); 180 180 - } 181 181 - 182 182 - private function getWePayAccountID() { 183 183 - return $this 184 184 - ->getProviderConfig() 185 185 - ->getMetadataValue(self::WEPAY_ACCOUNT_ID); 186 186 - } 187 187 - 188 188 - protected function executeRefund( 189 189 - PhortuneCharge $charge, 190 190 - PhortuneCharge $refund) { 191 191 - $wepay = $this->loadWePayAPILibraries(); 192 192 - 193 193 - $checkout_id = $this->getWePayCheckoutID($charge); 194 194 - 195 195 - $params = array( 196 196 - 'checkout_id' => $checkout_id, 197 197 - 'refund_reason' => pht('Refund'), 198 198 - 'amount' => $refund->getAmountAsCurrency()->negate()->formatBareValue(), 199 199 - ); 200 200 - 201 201 - $wepay->request('checkout/refund', $params); 202 202 - } 203 203 - 204 204 - public function updateCharge(PhortuneCharge $charge) { 205 205 - $wepay = $this->loadWePayAPILibraries(); 206 206 - 207 207 - $params = array( 208 208 - 'checkout_id' => $this->getWePayCheckoutID($charge), 209 209 - ); 210 210 - $wepay_checkout = $wepay->request('checkout', $params); 211 211 - 212 212 - // TODO: Deal with disputes / chargebacks / surprising refunds. 213 213 - } 214 214 - 215 215 - 216 216 - /* -( One-Time Payments )-------------------------------------------------- */ 217 217 - 218 218 - public function canProcessOneTimePayments() { 219 219 - return true; 220 220 - } 221 221 - 222 222 - 223 223 - /* -( Controllers )-------------------------------------------------------- */ 224 224 - 225 225 - 226 226 - public function canRespondToControllerAction($action) { 227 227 - switch ($action) { 228 228 - case 'checkout': 229 229 - case 'charge': 230 230 - case 'cancel': 231 231 - return true; 232 232 - } 233 233 - return parent::canRespondToControllerAction(); 234 234 - } 235 235 - 236 236 - /** 237 237 - * @phutil-external-symbol class WePay 238 238 - */ 239 239 - public function processControllerRequest( 240 240 - PhortuneProviderActionController $controller, 241 241 - AphrontRequest $request) { 242 242 - $wepay = $this->loadWePayAPILibraries(); 243 243 - 244 244 - $viewer = $request->getUser(); 245 245 - 246 246 - $cart = $controller->loadCart($request->getInt('cartID')); 247 247 - if (!$cart) { 248 248 - return new Aphront404Response(); 249 249 - } 250 250 - 251 251 - $charge = $controller->loadActiveCharge($cart); 252 252 - switch ($controller->getAction()) { 253 253 - case 'checkout': 254 254 - if ($charge) { 255 255 - throw new Exception(pht('Cart is already charging!')); 256 256 - } 257 257 - break; 258 258 - case 'charge': 259 259 - case 'cancel': 260 260 - if (!$charge) { 261 261 - throw new Exception(pht('Cart is not charging yet!')); 262 262 - } 263 263 - break; 264 264 - } 265 265 - 266 266 - switch ($controller->getAction()) { 267 267 - case 'checkout': 268 268 - $return_uri = $this->getControllerURI( 269 269 - 'charge', 270 270 - array( 271 271 - 'cartID' => $cart->getID(), 272 272 - )); 273 273 - 274 274 - $cancel_uri = $this->getControllerURI( 275 275 - 'cancel', 276 276 - array( 277 277 - 'cartID' => $cart->getID(), 278 278 - )); 279 279 - 280 280 - $price = $cart->getTotalPriceAsCurrency(); 281 281 - 282 282 - $params = array( 283 283 - 'account_id' => $this->getWePayAccountID(), 284 284 - 'short_description' => $cart->getName(), 285 285 - 'type' => 'SERVICE', 286 286 - 'amount' => $price->formatBareValue(), 287 287 - 'long_description' => $cart->getName(), 288 288 - 'reference_id' => $cart->getPHID(), 289 289 - 'app_fee' => 0, 290 290 - 'fee_payer' => 'Payee', 291 291 - 'redirect_uri' => $return_uri, 292 292 - 'fallback_uri' => $cancel_uri, 293 293 - 294 294 - // NOTE: If we don't `auto_capture`, we might get a result back in 295 295 - // either an "authorized" or a "reserved" state. We can't capture 296 296 - // an "authorized" result, so just autocapture. 297 297 - 298 298 - 'auto_capture' => true, 299 299 - 'require_shipping' => 0, 300 300 - 'shipping_fee' => 0, 301 301 - 'charge_tax' => 0, 302 302 - 'mode' => 'regular', 303 303 - 304 304 - // TODO: We could accept bank accounts but the hold/capture rules 305 305 - // are not quite clear. Just accept credit cards for now. 306 306 - 'funding_sources' => 'cc', 307 307 - ); 308 308 - 309 309 - $charge = $cart->willApplyCharge($viewer, $this); 310 310 - $result = $wepay->request('checkout/create', $params); 311 311 - 312 312 - $cart->setMetadataValue('provider.checkoutURI', $result->checkout_uri); 313 313 - $cart->save(); 314 314 - 315 315 - $charge->setMetadataValue('wepay.checkoutID', $result->checkout_id); 316 316 - $charge->save(); 317 317 - 318 318 - $uri = new PhutilURI($result->checkout_uri); 319 319 - return id(new AphrontRedirectResponse()) 320 320 - ->setIsExternal(true) 321 321 - ->setURI($uri); 322 322 - case 'charge': 323 323 - if ($cart->getStatus() !== PhortuneCart::STATUS_PURCHASING) { 324 324 - return id(new AphrontRedirectResponse()) 325 325 - ->setURI($cart->getCheckoutURI()); 326 326 - } 327 327 - 328 328 - $checkout_id = $request->getInt('checkout_id'); 329 329 - $params = array( 330 330 - 'checkout_id' => $checkout_id, 331 331 - ); 332 332 - 333 333 - $checkout = $wepay->request('checkout', $params); 334 334 - if ($checkout->reference_id != $cart->getPHID()) { 335 335 - throw new Exception( 336 336 - pht('Checkout reference ID does not match cart PHID!')); 337 337 - } 338 338 - 339 339 - $unguarded = AphrontWriteGuard::beginScopedUnguardedWrites(); 340 340 - switch ($checkout->state) { 341 341 - case 'authorized': 342 342 - case 'reserved': 343 343 - case 'captured': 344 344 - // TODO: Are these all really "done" states, and not "hold" 345 345 - // states? Cards and bank accounts both come back as "authorized" 346 346 - // on the staging environment. Figure out what happens in 347 347 - // production? 348 348 - 349 349 - $cart->didApplyCharge($charge); 350 350 - 351 351 - $response = id(new AphrontRedirectResponse())->setURI( 352 352 - $cart->getCheckoutURI()); 353 353 - break; 354 354 - default: 355 355 - // It's not clear if we can ever get here on the web workflow, 356 356 - // WePay doesn't seem to return back to us after a failure (the 357 357 - // workflow dead-ends instead). 358 358 - 359 359 - $cart->didFailCharge($charge); 360 360 - 361 361 - $response = $controller 362 362 - ->newDialog() 363 363 - ->setTitle(pht('Charge Failed')) 364 364 - ->appendParagraph( 365 365 - pht( 366 366 - 'Unable to make payment (checkout state is "%s").', 367 367 - $checkout->state)) 368 368 - ->addCancelButton($cart->getCheckoutURI(), pht('Continue')); 369 369 - break; 370 370 - } 371 371 - unset($unguarded); 372 372 - 373 373 - return $response; 374 374 - case 'cancel': 375 375 - // TODO: I don't know how it's possible to cancel out of a WePay 376 376 - // charge workflow. 377 377 - throw new Exception( 378 378 - pht('How did you get here? WePay has no cancel flow in its UI...?')); 379 379 - break; 380 380 - } 381 381 - 382 382 - throw new Exception( 383 383 - pht('Unsupported action "%s".', $controller->getAction())); 384 384 - } 385 385 - 386 386 - private function loadWePayAPILibraries() { 387 387 - $root = dirname(phutil_get_library_root('phabricator')); 388 388 - require_once $root.'/externals/wepay/wepay.php'; 389 389 - 390 390 - WePay::useStaging( 391 391 - $this->getWePayClientID(), 392 392 - $this->getWePayClientSecret()); 393 393 - 394 394 - return new WePay($this->getWePayAccessToken()); 395 395 - } 396 396 - 397 397 - private function getWePayCheckoutID(PhortuneCharge $charge) { 398 398 - $checkout_id = $charge->getMetadataValue('wepay.checkoutID'); 399 399 - if ($checkout_id === null) { 400 400 - throw new Exception(pht('No WePay Checkout ID present on charge!')); 401 401 - } 402 402 - return $checkout_id; 403 403 - } 404 404 - 405 405 - }