tilia-http 4.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: df3c33252c3cc85f15f3f9e6acea2826940586a3
+  data.tar.gz: 56395b01fc8257318fded5fc26f3e1850ca4c116
+SHA512:
+  metadata.gz: df86049b2ae6d5b492addf9a2d0c49682b2696280e42bb6b7aa1e12be21531c5eb28c07f28f823d8cf8a57d28332bb1b25eb4ed9c43d789b760af6166e471831
+  data.tar.gz: 7e7655183e6859a16ad274fd455fc75d24e52645a83a1c8a279ecde95629d1d40709557b43ec180be46ad59976c0ee2bae23b65ac354495b8fe6a634d0910acc

data/.gitignore

@@ -0,0 +1,19 @@
+# Gem files
+/*.gem
+
+# backup files
+*~
+
+# swap files
+*.swp
+*.kate-swp
+
+# file manager files
+*.directory
+
+# coverage
+/coverage
+
+# documentation
+/doc
+/.yardoc

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rubocop.yml

@@ -0,0 +1,35 @@
+# Disable metrics - we stick to the sabre coding
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Style/OptionalArguments:
+  Enabled: false
+
+# ['word', 'array'] looks better when aligned with other arrays that can't use
+# %w() syntax
+Style/WordArray:
+  Enabled: false

data/.simplecov

@@ -0,0 +1,4 @@
+SimpleCov.start do
+  add_filter "/spec/"
+end
+

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.3

data/CHANGELOG.sabre.md

@@ -0,0 +1,235 @@
+ChangeLog
+=========
+
+4.1.0 (2015-09-04)
+------------------
+
+* The async client wouldn't `wait()` for new http requests being started
+  after the (previous) last request in the queue was resolved.
+* Added `Sabre\HTTP\Auth\Bearer`, to easily extract a OAuth2 bearer token.
+
+
+4.0.0 (2015-05-20)
+------------------
+
+* Deprecated: All static functions from `Sabre\HTTP\URLUtil` and
+  `Sabre\HTTP\Util` moved to a separate `functions.php`, which is also
+  autoloaded. The old functions are still there, but will be removed in a
+  future version. (#49)
+
+
+4.0.0-alpha3 (2015-05-19)
+-------------------------
+
+* Added a parser for the HTTP `Prefer` header, as defined in [RFC7240][rfc7240].
+* Deprecated `Sabre\HTTP\Util::parseHTTPDate`, use `Sabre\HTTP\parseDate()`.
+* Deprecated `Sabre\HTTP\Util::toHTTPDate` use `Sabre\HTTP\toDate()`.
+
+
+4.0.0-alpha2 (2015-05-18)
+-------------------------
+
+* #45: Don't send more data than what is promised in the HTTP content-length.
+  (@dratini0).
+* #43: `getCredentials` returns null if incomplete. (@Hywan)
+* #48: Now using php-cs-fixer to make our CS consistent (yay!)
+* This includes fixes released in version 3.0.5.
+
+
+4.0.0-alpha1 (2015-02-25)
+-------------------------
+
+* #41: Fixing bugs related to comparing URLs in `Request::getPath()`.
+* #41: This library now uses the `sabre/uri` package for uri handling.
+* Added `421 Misdirected Request` from the HTTP/2.0 spec.
+
+
+3.0.5 (2015-05-11)
+------------------
+
+* #47 #35: When re-using the client and doing any request after a `HEAD`
+  request, the client discards the body.
+
+
+3.0.4 (2014-12-10)
+------------------
+
+* #38: The Authentication helpers no longer overwrite any existing
+  `WWW-Authenticate` headers, but instead append new headers. This ensures
+  that multiple authentication systems can exist in the same environment.
+
+
+3.0.3 (2014-12-03)
+------------------
+
+* Hiding `Authorization` header value from `Request::__toString`.
+
+
+3.0.2 (2014-10-09)
+------------------
+
+* When parsing `Accept:` headers, we're ignoring invalid parts. Before we
+  would throw a PHP E_NOTICE.
+
+
+3.0.1 (2014-09-29)
+------------------
+
+* Minor change in unittests.
+
+
+3.0.0 (2014-09-23)
+------------------
+
+* `getHeaders()` now returns header values as an array, just like psr/http.
+* Added `hasHeader()`.
+
+
+2.1.0-alpha1 (2014-09-15)
+-------------------------
+
+* Changed: Copied most of the header-semantics for the PSR draft for
+  representing HTTP messages. [Reference here][psr-http].
+* This means that `setHeaders()` does not wipe out every existing header
+  anymore.
+* We also support multiple headers with the same name.
+* Use `Request::getHeaderAsArray()` and `Response::getHeaderAsArray()` to
+  get a hold off multiple headers with the same name.
+* If you use `getHeader()`, and there's more than 1 header with that name, we
+  concatenate all these with a comma.
+* `addHeader()` will now preserve an existing header with that name, and add a
+  second header with the same name.
+* The message class should be a lot faster now for looking up headers. No more
+  array traversal, because we maintain a tiny index.
+* Added: `URLUtil::resolve()` to make resolving relative urls super easy.
+* Switched to PSR-4.
+* #12: Circumventing CURL's FOLLOW_LOCATION and doing it in PHP instead. This
+  fixes compatibility issues with people that have open_basedir turned on.
+* Added: Content negotiation now correctly support mime-type parameters such as
+  charset.
+* Changed: `Util::negotiate()` is now deprecated. Use
+  `Util::negotiateContentType()` instead.
+* #14: The client now only follows http and https urls.
+
+
+2.0.4 (2014-07-14)
+------------------
+
+* Changed: No longer escaping @ in urls when it's not needed.
+* Fixed: #7: Client now correctly deals with responses without a body.
+
+
+2.0.3 (2014-04-17)
+------------------
+
+* Now works on hhvm!
+* Fixed: Now throwing an error when a Request object is being created with
+  arguments that were valid for sabre/http 1.0. Hopefully this will aid with
+  debugging for upgraders.
+
+
+2.0.2 (2014-02-09)
+------------------
+
+* Fixed: Potential security problem in the client.
+
+
+2.0.1 (2014-01-09)
+------------------
+
+* Fixed: getBodyAsString on an empty body now works.
+* Fixed: Version string
+
+
+2.0.0 (2014-01-08)
+------------------
+
+* Removed: Request::createFromPHPRequest. This is now handled by
+  Sapi::getRequest.
+
+
+2.0.0alpha6 (2014-01-03)
+------------------------
+
+* Added: Asynchronous HTTP client. See examples/asyncclient.php.
+* Fixed: Issue #4: Don't escape colon (:) when it's not needed.
+* Fixed: Fixed a bug in the content negotation script.
+* Fixed: Fallback for when CURLOPT_POSTREDIR is not defined (mainly for hhvm).
+* Added: The Request and Response object now have a `__toString()` method that
+  serializes the objects into a standard HTTP message. This is mainly for
+  debugging purposes.
+* Changed: Added Response::getStatusText(). This method returns the
+  human-readable HTTP status message. This part has been removed from
+  Response::getStatus(), which now always returns just the status code as an
+  int.
+* Changed: Response::send() is now Sapi::sendResponse($response).
+* Changed: Request::createFromPHPRequest is now Sapi::getRequest().
+* Changed: Message::getBodyAsStream and Message::getBodyAsString were added. The
+  existing Message::getBody changed it's behavior, so be careful.
+
+
+2.0.0alpha5 (2013-11-07)
+------------------------
+
+* Added: HTTP Status 451 Unavailable For Legal Reasons. Fight government
+  censorship!
+* Added: Ability to catch and retry http requests in the client when a curl
+  error occurs.
+* Changed: Request::getPath does not return the query part of the url, so
+  everything after the ? is stripped.
+* Added: a reverse proxy example.
+
+
+2.0.0alpha4 (2013-08-07)
+------------------------
+
+* Fixed: Doing a GET request with the client uses the last used HTTP method
+  instead.
+* Added: HttpException
+* Added: The Client class can now automatically emit exceptions when HTTP errors
+  occurred.
+
+
+2.0.0alpha3 (2013-07-24)
+------------------------
+
+* Changed: Now depends on sabre/event package.
+* Changed: setHeaders() now overwrites any existing http headers.
+* Added: getQueryParameters to RequestInterface.
+* Added: Util::negotiate.
+* Added: RequestDecorator, ResponseDecorator.
+* Added: A very simple HTTP client.
+* Added: addHeaders() to append a list of new headers.
+* Fixed: Not erroring on unknown HTTP status codes.
+* Fixed: Throwing exceptions on invalid HTTP status codes (not 3 digits).
+* Fixed: Much better README.md
+* Changed: getBody() now uses a bitfield to specify what type to return.
+
+
+2.0.0alpha2 (2013-07-02)
+------------------------
+
+* Added: Digest & AWS Authentication.
+* Added: Message::getHttpVersion and Message::setHttpVersion.
+* Added: Request::setRawServerArray, getRawServerValue.
+* Added: Request::createFromPHPRequest
+* Added: Response::send
+* Added: Request::getQueryParameters
+* Added: Utility for dealing with HTTP dates.
+* Added: Request::setPostData and Request::getPostData.
+* Added: Request::setAbsoluteUrl and Request::getAbsoluteUrl.
+* Added: URLUtil, methods for calculation relative and base urls.
+* Removed: Response::sendBody
+
+
+2.0.0alpha1 (2012-10-07)
+------------------------
+
+* Fixed: Lots of small naming improvements
+* Added: Introduction of Message, MessageInterface, Response, ResponseInterface.
+
+Before 2.0.0, this package was built-into SabreDAV, where it first appeared in
+January 2009.
+
+[psr-http]: https://github.com/php-fig/fig-standards/blob/master/proposed/http-message.md
+[rfc-7240]: http://tools.ietf.org/html/rfc7240

data/CONTRIBUTING.md

@@ -0,0 +1,25 @@
+# Contributing
+
+This project adheres to the [Open Code of Conduct][code-of-conduct]. By participating, you are expected to honor this code.
+[code-of-conduct]: http://todogroup.org/opencodeofconduct/#tilia-http/tilia@jakobsack.de
+
+This library is a port of [sabre/http](http://github.com/fruux/sabre-http). The ruby code should match the php code as good as possible. For more information refer to the [coding guidelines](https://tilia.github.io/coding_guidelines).
+
+If you are having an issue [search the open issues](https://github.com/tilia/tilia-http/issues) or create an issue and we'll help point you in the right direction.
+
+## Submitting a Pull Request
+
+* Fork the project on Github
+* Install development dependencies (`bundle install`)
+* Create a topic branch for your changes
+* Ensure that you provide *documentation* and *test coverage* for your changes (patches won't be accepted without)
+* Ensure that all tests pass (`bundle exec rake`)
+* Create a [pull request](https://github.com/tilia/tilia-http/pulls) on Github (these are also a great place to start a conversation around a patch as early as possible)
+
+## Testing
+
+To run the tests:
+
+    $ rake
+
+If nothing complains, congratulations!

data/Gemfile

@@ -0,0 +1,18 @@
+source 'https://rubygems.org'
+
+# Internal dependencies
+gem 'tilia-event', '~> 2.0'
+gem 'tilia-uri', '~> 1.0'
+
+# External dependencies
+gem 'activesupport', '~> 4.2'
+gem 'typhoeus', '~> 0.8'
+gem 'rchardet', '~>1.6'
+gem 'rack', '~> 1.6'
+
+# Testing
+gem 'rake'
+gem 'minitest', '~> 5.8'
+gem 'simplecov', '~> 0.10'
+gem 'rubocop', '~> 0.34'
+gem 'yard', '~> 0.8'

data/Gemfile.lock

@@ -0,0 +1,69 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.2.5)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    ast (2.1.0)
+    astrolabe (1.3.1)
+      parser (~> 2.2)
+    docile (1.1.5)
+    ethon (0.8.0)
+      ffi (>= 1.3.0)
+    ffi (1.9.10)
+    i18n (0.7.0)
+    json (1.8.3)
+    minitest (5.8.3)
+    parser (2.2.3.0)
+      ast (>= 1.1, < 3.0)
+    powerpack (0.1.1)
+    rack (1.6.4)
+    rainbow (2.0.0)
+    rake (10.4.2)
+    rchardet (1.6.1)
+    rubocop (0.35.1)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.3.0, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      tins (<= 1.6.0)
+    ruby-progressbar (1.7.5)
+    simplecov (0.11.1)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    thread_safe (0.3.5)
+    tilia-event (2.0.2)
+      activesupport (~> 4.2)
+    tilia-uri (1.0.1)
+      activesupport (~> 4.2)
+    tins (1.6.0)
+    typhoeus (0.8.0)
+      ethon (>= 0.8.0)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    yard (0.8.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (~> 4.2)
+  minitest (~> 5.8)
+  rack (~> 1.6)
+  rake
+  rchardet (~> 1.6)
+  rubocop (~> 0.34)
+  simplecov (~> 0.10)
+  tilia-event (~> 2.0)
+  tilia-uri (~> 1.0)
+  typhoeus (~> 0.8)
+  yard (~> 0.8)
+
+BUNDLED WITH
+   1.10.6

data/LICENSE

@@ -0,0 +1,27 @@
+Copyright (C) 2015 Jakob Sack (tilia@jakobsack.de)
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name Tilia nor the names of its contributors
+      may be used to endorse or promote products derived from this software
+      without specific prior written permission.
+
+    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+    ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+    LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+    POSSIBILITY OF SUCH DAMAGE.

data/LICENSE.sabre

@@ -0,0 +1,27 @@
+Copyright (C) 2009-2015 fruux GmbH (https://fruux.com/)
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name Sabre nor the names of its contributors
+      may be used to endorse or promote products derived from this software
+      without specific prior written permission.
+
+    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+    ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+    LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+    POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,68 @@
+tilia/http
+=========
+
+[![Build Status](https://travis-ci.org/tilia/tilia-http.svg?branch=master)](https://travis-ci.org/tilia/tilia-http)
+
+**tilia/http is a port of [sabre/http](https://github.com/fruux/sabre-http)**
+
+The sabre/http library provides a toolkit to make working with the HTTP protocol easier.
+
+Most PHP scripts run within a HTTP request but accessing information about the
+HTTP request is cumbersome at least.
+
+There's bad practices, inconsistencies and confusion. This library is
+effectively a wrapper around the following PHP constructs:
+
+For Input:
+
+* `$_GET`,
+* `$_POST`,
+* `$_SERVER`,
+* `php://input` or `$HTTP_RAW_POST_DATA`.
+
+For output:
+
+* `php://output` or `echo`,
+* `header()`.
+
+What this library provides, is a `Request` object, and a `Response` object.
+
+The objects are extendable and easily mockable.
+
+
+Installation
+------------
+
+Simply add tilia-http to your Gemfile and bundle it up:
+
+```ruby
+  gem 'tilia-http', '~> 4.1'
+```
+
+
+Changes to sabre/http
+---------------------
+
+```php
+  Sabre\HTTP\Message#setHeader($name, $value)
+  Sabre\HTTP\Message#setHeader(array $headers)
+```
+
+are replaced by
+
+```ruby
+  Tilia::Http::Message#update_header(name, value)
+  Tilia::Http::Message#update_headers(headers)
+```
+
+
+Contributing
+------------
+
+See [Contributing](CONTRIBUTING.md)
+
+
+License
+-------
+
+tilia-http is licensed under the terms of the [three-clause BSD-license](LICENSE).

data/Rakefile

@@ -0,0 +1,17 @@
+require 'rake'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+require 'yard'
+
+Rake::TestTask.new do |t|
+  t.test_files = Dir.glob('test/**/*_test.rb')
+  t.libs << 'test'
+end
+RuboCop::RakeTask.new do |t|
+  t.options = ['--format', 'html', '--out', 'coverage/rubocop.html']
+end
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb', '-', 'README.md']
+end
+
+task(default: :test)

data/examples/asyncclient.rb

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+# This example demonstrates the ability for clients to work asynchronously.
+#
+# By default up to 10 requests will be executed in paralel. HTTP connections
+# are re-used and DNS is cached, all thanks to the power of curl.
+#
+# @copyright Copyright (C) 2009-2015 fruux GmbH (https://fruux.com/).
+# @author Evert Pot (http://evertpot.com/)
+# @license http://sabre.io/license/ Modified BSD License
+
+# Expected to be called "bundle exec examples/asyncclient.rb"
+require './lib/tilia/http'
+
+# This is the request we're repeating a 1000 times.
+request = Tilia::Http::Request.new('GET', 'http://localhost/')
+client = Tilia::Http::Client.new
+
+1000.times do |i|
+  puts "#{i}\tsending"
+
+  # This is the 'success' callback
+  success = lambda do |response|
+    puts "#{i}\t#{response.status}"
+  end
+
+  # This is the 'error' callback. It is called for general connection
+  # problems (such as not being able to connect to a host, dns errors,
+  # etc.) and also cases where a response was returned, but it had a
+  # status code of 400 or higher.
+  exception = lambda do |error|
+    if error['status'] == Tilia::Http::Client::STATUS_CURLERROR
+      # Curl errors
+      puts "#{i}\tcurl error: #{error['curl_errmsg']}"
+    else
+      # HTTP errors
+      puts "#{i}\t#{error['response'].status}"
+    end
+  end
+
+  client.send_async(request, success, exception)
+end
+
+# After everything is done, we call 'wait'. This causes the client to wait for
+# all outstanding http requests to complete.
+client.wait

data/examples/basicauth.rb

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+# This example does not work because of rack ...
+# This example shows how to do Basic authentication.
+# *
+# @copyright Copyright (C) 2009-2015 fruux GmbH (https://fruux.com/).
+# @author Evert Pot (http://evertpot.com/)
+# @license http://sabre.io/license/ Modified BSD License
+
+# Expected to be called "bundle exec examples/basicauth.rb"
+require './lib/tilia_http'
+require 'rack'
+
+app = proc do |env|
+  user_list = {
+    'user1' => 'password',
+    'user2' => 'password'
+  }
+
+  sapi = Tilia::Http::Sapi.new(env)
+  request = sapi.request
+  response = Tilia::Http::Response.new
+
+  basic_auth = Tilia::Http::Auth::Basic.new('Locked down area', request, response)
+  if !(user_pass = basic_auth.credentials)
+    # No username or password given
+    basic_auth.require_login
+  elsif !user_list.key?(user_pass[0]) || user_list[user_pass[0]] != user_pass[1]
+    # Username or password are incorrect
+    basic_auth.require_login
+  else
+    # Success !
+    response.body = 'You are logged in!'
+  end
+
+  # Sending the response
+  sapi.send_response(response)
+end
+
+Rack::Handler::WEBrick.run app

data/examples/client.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+# This example shows how to make a HTTP request with the Request and Response
+# objects.
+#
+# @copyright Copyright (C) 2009-2015 fruux GmbH (https://fruux.com/).
+# @author Evert Pot (http://evertpot.com/)
+# @license http://sabre.io/license/ Modified BSD License
+
+# Expected to be called "bundle exec examples/client.rb"
+require './lib/tilia_http'
+
+# Constructing the request.
+request = Tilia::Http::Request.new('GET', 'http://www.jakobsack.de/')
+
+client = Tilia::Http::Client.new
+# client.add_curl_setting(proxy: 'localhost:8888')
+response = client.send(request)
+
+puts 'Response:'
+puts response.to_s