bitmotor/unirest-php
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Composer-compatiblity; PHPDoc

Browse Source
This commit is contained in:
Nikko Bautista
2013-04-24 16:05:06 -07:00
parent 0ab2c583db
commit 8d875f3d02
9 changed files with 308 additions and 300 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
.gitignore vendored
View File

@@ -1 +1,4 @@
.DS_Store
/vendor
composer.lock
composer.phar

28
composer.json Normal file
View File

@@ -0,0 +1,28 @@
{
"name" : "mashape/unirest-php",
"description" : "Unirest PHP",
"keywords" : ["rest", "curl"],
"type" : "library",
"homepage" : "http://unireset.io#php",
"license" : "MIT",
"authors" : [
{
"name" : "Mashape",
"email" : "hey@mashape.com",
"homepage" : "http://mashape.com"
}
],
"require" : {
"php" : ">=5.3.0",
"ext-curl" : "*",
"ext-json" : "*"
},
"autoload" : {
"psr-0" : {
"Unirest" : "lib"
}
},
"support" : {
"email" : "hey@mashape.com"
}
}

71
lib/Chunked.php
View File

@@ -1,71 +0,0 @@
<?php
/*
The MIT License
Copyright (c) 2013 Mashape (http://mashape.com)
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:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
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.
*/
if (!function_exists('http_chunked_decode')) {
/**
* dechunk an http 'transfer-encoding: chunked' message
*
* @param string $chunk the encoded message
* @return string the decoded message. If $chunk wasn't encoded properly it will be returned unmodified.
*/
function http_chunked_decode($chunk) {
$pos = 0;
$len = strlen($chunk);
$dechunk = null;
while(($pos < $len)
&& ($chunkLenHex = substr($chunk,$pos, ($newlineAt = strpos($chunk,"\n",$pos+1))-$pos)))
{
if (! is_hex($chunkLenHex)) {
trigger_error('Value is not properly chunk encoded', E_USER_WARNING);
return $chunk;
}
$pos = $newlineAt + 1;
$chunkLen = hexdec(rtrim($chunkLenHex,"\r\n"));
$dechunk .= substr($chunk, $pos, $chunkLen);
$pos = strpos($chunk, "\n", $pos + $chunkLen) + 1;
}
return $dechunk;
}
}
/**
* determine if a string can represent a number in hexadecimal
*
* @param string $hex
* @return boolean true if the string is a hex, otherwise false
*/
function is_hex($hex) {
// regex is for weenies
$hex = strtolower(trim(ltrim($hex,"0")));
if (empty($hex)) { $hex = 0; };
$dec = hexdec($hex);
return ($hex == dechex($dec));
}
?>

37
lib/HttpMethod.php
View File

@@ -1,37 +0,0 @@
<?php
/*
The MIT License
Copyright (c) 2013 Mashape (http://mashape.com)
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:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
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.
*/
class HttpMethod
{
const DELETE = "DELETE";
const GET = "GET";
const POST = "POST";
const PUT = "PUT";
const PATCH = "PATCH";
}
?>

73
lib/HttpResponse.php
View File

@@ -1,73 +0,0 @@
<?php
/*
The MIT License
Copyright (c) 2013 Mashape (http://mashape.com)
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:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
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.
*/
class HttpResponse {
private $code;
private $raw_body;
private $body;
private $headers;
function __construct($code, $raw_body, $headers) {
$this->code = $code;
$this->headers = $this->get_headers_from_curl_response($headers);
$this->raw_body = $raw_body;
$this->body = $raw_body;
$json = json_decode($raw_body);
if (json_last_error() == JSON_ERROR_NONE) {
$this->body = $json;
}
}
public function __get($property) {
if (property_exists($this, $property)) {
return $this->$property;
}
}
public function __set($property, $value) {
if (property_exists($this, $property)) {
$this->$property = $value;
}
return $this;
}
private function get_headers_from_curl_response($headers)
{
foreach (explode("\r\n", $headers) as $i => $line) {
if ($i !== 0) {
if (!empty($key) && substr($key, 0, 4) != "HTTP") {
$result[$key] = $value;
} else {
list ($key, $value) = explode(': ', $line);
}
}
}
return $result;
}
}
?>

119
lib/Unirest.php
View File

@@ -1,119 +0,0 @@
<?php
/*
The MIT License
Copyright (c) 2013 Mashape (http://mashape.com)
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:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
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.
*/
require_once(dirname(__FILE__) . "/Chunked.php");
require_once(dirname(__FILE__) . "/HttpResponse.php");
require_once(dirname(__FILE__) . "/HttpMethod.php");
class Unirest {
public static function get($url, $headers = array()) {
return Unirest::request(HttpMethod::GET, $url, NULL, $headers);
}
public static function post($url, $headers = array(), $body = NULL) {
return Unirest::request(HttpMethod::POST, $url, $body, $headers);
}
public static function delete($url, $headers = array()) {
return Unirest::request(HttpMethod::DELETE, $url, NULL, $headers);
}
public static function put($url, $headers = array(), $body = NULL) {
return Unirest::request(HttpMethod::PUT, $url, $body, $headers);
}
public static function patch($url, $headers = array(), $body = NULL) {
return Unirest::request(HttpMethod::PATCH, $url, $body, $headers);
}
private static function request($httpMethod, $url, $body = NULL, $headers = array()) {
$lowercaseHeaders = array();
foreach ($headers as $key => $val) {
$key = trim(strtolower($key));
if ($key == "user-agent" || key == "expect") continue;
$lowercaseHeaders[] = $key . ": " . $val;
}
$lowercaseHeaders[] = "user-agent: unirest-php/1.0";
$lowercaseHeaders[] = "expect:";
$ch = curl_init();
if ($httpMethod != HttpMethod::GET) {
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, $httpMethod);
curl_setopt ($ch, CURLOPT_POSTFIELDS, $body);
}
curl_setopt ($ch, CURLOPT_URL , Unirest::encodeUrl($url));
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt ($ch, CURLOPT_FOLLOWLOCATION, true);
curl_setopt ($ch, CURLOPT_MAXREDIRS, 10);
curl_setopt ($ch, CURLOPT_HTTPHEADER, $lowercaseHeaders);
curl_setopt ($ch, CURLOPT_HEADER, true);
curl_setopt ($ch, CURLOPT_SSL_VERIFYPEER, false);
$response = curl_exec($ch);
$error = curl_error($ch);
if ($error) {
throw new Exception($error);
}
// Split the full response in its headers and body
$curl_info = curl_getinfo($ch);
$header_size = $curl_info["header_size"];
$header = substr($response, 0, $header_size);
$body = substr($response, $header_size);
$httpCode = $curl_info["http_code"];
return new HttpResponse($httpCode, $body, $header);
}
private static function encodeUrl($url) {
// Parse URL into pieces
$url_parsed = parse_url($url);
// Build the basics bypassing notices
$scheme = $url_parsed['scheme'] . '://';
$host = $url_parsed['host'];
$port = ( isset($url_parsed['port']) ? $url_parsed['port'] : null );
$path = ( isset($url_parsed['path']) ? $url_parsed['path'] : null );
$query = ( isset($url_parsed['query']) ? $url_parsed['query'] : null );
// Do we need to encode anything?
if ($query != null) {
// Break up the query into an array
parse_str($url_parsed['query'], $query_parsed);
// Encode and build query based on RFC 1738
$query = '?'.http_build_query($query_parsed);
}
// Return the completed URL
$result = $scheme . $host . $port . $path . $query;
return $result;
}
}
?>

11
lib/Unirest/HttpMethod.php Normal file
View File

@@ -0,0 +1,11 @@
<?php
namespace Unirest;
class HttpMethod
{
const DELETE = "DELETE";
const GET = "GET";
const POST = "POST";
const PUT = "PUT";
const PATCH = "PATCH";
}

79
lib/Unirest/HttpResponse.php Normal file
View File

@@ -0,0 +1,79 @@
<?php
namespace Unirest;
class HttpResponse
{
private $code;
private $raw_body;
private $body;
private $headers;
/**
* HttpResponse constructor
* @param int $code Response code of the cURL request
* @param string $raw_body The raw body of the cURL response
* @param string $headers Raw header string from cURL response
*/
function __construct($code, $raw_body, $headers)
{
$this->code = $code;
$this->headers = $this->get_headers_from_curl_response($headers);
$this->raw_body = $raw_body;
$this->body = $raw_body;
$json = json_decode($raw_body);
if (json_last_error() == JSON_ERROR_NONE) {
$this->body = $json;
}
}
/**
* Return a property of the response if it exists
* Possibilities include:
* - code
* - raw_body
* - body (if the response is json-decodable)
* - headers
* @param [type] $property [description]
* @return [type] [description]
*/
public function __get($property)
{
if (property_exists($this, $property)) {
return $this->$property;
}
}
/**
* Set the properties of this object
* @param string $property The property name
* @param mixed $value The property value
*/
public function __set($property, $value)
{
if (property_exists($this, $property)) {
$this->$property = $value;
}
return $this;
}
/**
* Retrieve the cURL response headers from the
* header string and convert it into an array
* @param string $headers header string from cURL response
* @return array headers in array form
*/
private function get_headers_from_curl_response($headers)
{
foreach (explode("\r\n", $headers) as $i => $line) {
if ($i !== 0) {
if (!empty($key) && substr($key, 0, 4) != "HTTP") {
$result[$key] = $value;
} else {
list ($key, $value) = explode(': ', $line);
}
}
}
return $result;
}
}

187
lib/Unirest/Unirest.php Normal file
View File

@@ -0,0 +1,187 @@
<?php
namespace Unirest;
class Unirest
{
/**
* Send a GET request to a URL
* @param string $url URL to send the GET request to
* @param array $headers Additional headers to send
* @return string|stdObj Response string or stdObj if response is json-decodable
*/
public static function get($url, $headers = array())
{
return Unirest::request(HttpMethod::GET, $url, NULL, $headers);
}
/**
* Send POST request to a URL
* @param string $url URL to send the POST request to
* @param array $headers Additional headers to send
* @param mixed $body POST body data
* @return string|stdObj Response string or stdObj if response is json-decodable
*/
public static function post($url, $headers = array(), $body = NULL)
{
return Unirest::request(HttpMethod::POST, $url, $body, $headers);
}
/**
* Send DELETE request to a URL
* @param string $url URL to send the DELETE request to
* @param array $headers Additional headers to send
* @return string|stdObj Response string or stdObj if response is json-decodable
*/
public static function delete($url, $headers = array())
{
return Unirest::request(HttpMethod::DELETE, $url, NULL, $headers);
}
/**
* Send PUT request to a URL
* @param string $url URL to send the PUT request to
* @param array $headers Additional headers to send
* @param mixed $body PUT body data
* @return string|stdObj Response string or stdObj if response is json-decodable
*/
public static function put($url, $headers = array(), $body = NULL)
{
return Unirest::request(HttpMethod::PUT, $url, $body, $headers);
}
/**
* Send PATCH request to a URL
* @param string $url URL to send the PATCH request to
* @param array $headers Additional headers to send
* @param mixed $body PATCH body data
* @return string|stdObj Response string or stdObj if response is json-decodable
*/
public static function patch($url, $headers = array(), $body = NULL)
{
return Unirest::request(HttpMethod::PATCH, $url, $body, $headers);
}
/**
* Send a cURL request
* @param string $httpMethod HTTP Method to use (based off \Unirest\HttpMethod constants)
* @param string $url URL to send the request to
* @param mixed $body Request body
* @param array $headers Additional headers to send
* @throws Exception If a cURL error occurs
* @return \Unireset\HttpResponse \Unirest\HttpResponse object
*/
private static function request($httpMethod, $url, $body = NULL, $headers = array())
{
$lowercaseHeaders = array();
foreach ($headers as $key => $val) {
$key = trim(strtolower($key));
if ($key == "user-agent" || key == "expect") continue;
$lowercaseHeaders[] = $key . ": " . $val;
}
$lowercaseHeaders[] = "user-agent: unirest-php/1.0";
$lowercaseHeaders[] = "expect:";
$ch = curl_init();
if ($httpMethod != HttpMethod::GET) {
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, $httpMethod);
curl_setopt ($ch, CURLOPT_POSTFIELDS, $body);
}
curl_setopt ($ch, CURLOPT_URL , Unirest::encodeUrl($url));
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt ($ch, CURLOPT_FOLLOWLOCATION, true);
curl_setopt ($ch, CURLOPT_MAXREDIRS, 10);
curl_setopt ($ch, CURLOPT_HTTPHEADER, $lowercaseHeaders);
curl_setopt ($ch, CURLOPT_HEADER, true);
curl_setopt ($ch, CURLOPT_SSL_VERIFYPEER, false);
$response = curl_exec($ch);
$error = curl_error($ch);
if ($error) {
throw new \Exception($error);
}
// Split the full response in its headers and body
$curl_info = curl_getinfo($ch);
$header_size = $curl_info["header_size"];
$header = substr($response, 0, $header_size);
$body = substr($response, $header_size);
$httpCode = $curl_info["http_code"];
return new HttpResponse($httpCode, $body, $header);
}
/**
* Ensure that a URL is encoded and safe to use with cURL
* @param string $url URL to encode
* @return string Encoded URL
*/
private static function encodeUrl($url)
{
// Parse URL into pieces
$url_parsed = parse_url($url);
// Build the basics bypassing notices
$scheme = $url_parsed['scheme'] . '://';
$host = $url_parsed['host'];
$port = (isset($url_parsed['port']) ? $url_parsed['port'] : null );
$path = (isset($url_parsed['path']) ? $url_parsed['path'] : null );
$query = (isset($url_parsed['query']) ? $url_parsed['query'] : null );
// Do we need to encode anything?
if ($query != null) {
// Break up the query into an array
parse_str($url_parsed['query'], $query_parsed);
// Encode and build query based on RFC 1738
$query = '?'.http_build_query($query_parsed);
}
// Return the completed URL
$result = $scheme . $host . $port . $path . $query;
return $result;
}
}
if (!function_exists('http_chunked_decode')) {
/**
* dechunk an http 'transfer-encoding: chunked' message
*
* @param string $chunk the encoded message
* @return string the decoded message. If $chunk wasn't encoded properly it will be returned unmodified.
*/
function http_chunked_decode($chunk) {
$pos = 0;
$len = strlen($chunk);
$dechunk = null;
while(($pos < $len)
&& ($chunkLenHex = substr($chunk,$pos, ($newlineAt = strpos($chunk,"\n",$pos+1))-$pos))
) {
if (!is_hex($chunkLenHex)) {
trigger_error('Value is not properly chunk encoded', E_USER_WARNING);
return $chunk;
}
$pos = $newlineAt + 1;
$chunkLen = hexdec(rtrim($chunkLenHex,"\r\n"));
$dechunk .= substr($chunk, $pos, $chunkLen);
$pos = strpos($chunk, "\n", $pos + $chunkLen) + 1;
}
return $dechunk;
}
}
/**
* determine if a string can represent a number in hexadecimal
*
* @param string $hex
* @return boolean true if the string is a hex, otherwise false
*/
function is_hex($hex) {
// regex is for weenies
$hex = strtolower(trim(ltrim($hex,"0")));
if (empty($hex)) { $hex = 0; };
$dec = hexdec($hex);
return ($hex == dechex($dec));
}