tilia-http 4.1.0.8 → 4.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4fae342980c68080e5bb173384b10dfc4f751a9c
-  data.tar.gz: ed60d41fc6f0f525a6ba3a0c174f8fa5f911ed07
+  metadata.gz: f7b1b04def12b6d6a9f842167374739dd6210e7d
+  data.tar.gz: 71c6a0a0f8c575c91b6feef757f586833e9b12f0
 SHA512:
-  metadata.gz: addf90a65199857930fd93c198098ea8dd416e8ca3df9d5067399d1aea2be9f66ce89bc6bee4b7fd592cb64e9a4a338075f310ee1dbf69d9709c6e5521aef16d
-  data.tar.gz: fd434315dcc26fb9925a12bf21924ba0dc1817cf9fb892c52aaac83c111c94a4a8bce0f261a9261afc74183b5356d715054ca37ff4cf1630e61331cb16c43b67
+  metadata.gz: dc7eace9da8196a66d914e0e337193c236dc5f2fbcfcff1a1d2ea94e8eace45d485050d88417046e12ada16f34321b658f56df3587f74f2ec533836eb9a984de
+  data.tar.gz: 2e6c6e45eb6361ef0b316860f2dcfde64d5372fec663470c4bc2c4d1fe446b056ef01e16b0bd0c87a441ee1345b395242811edb5980401aef227a446dcf620bc

data/CHANGELOG.sabre.md

@@ -1,6 +1,21 @@
 ChangeLog
 =========
 
+4.2.1 (2016-01-06)
+------------------
+
+* #56: `getBodyAsString` now returns at most as many bytes as the contents of
+  the `Content-Length` header. This allows users to pass much larger strings
+  without having to copy and truncate them.
+
+
+4.2.0 (2016-01-04)
+------------------
+
+* This package now supports sabre/event 3.0.
+* The client now sets a default `User-Agent` header identifying this library.
+
+
 4.1.0 (2015-09-04)
 ------------------
 

data/Gemfile

@@ -1,14 +1,6 @@
 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'
+gemspec
 
 # Testing
 gem 'rake'

data/Gemfile.lock

@@ -1,7 +1,18 @@
+PATH
+  remote: .
+  specs:
+    tilia-http (4.2.1)
+      activesupport (>= 4.0)
+      rack (~> 1.6)
+      rchardet (~> 1.6)
+      tilia-event (~> 2.0)
+      tilia-uri (~> 1.0)
+      typhoeus (~> 0.8)
+
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (4.2.5)
+    activesupport (4.2.5.1)
       i18n (~> 0.7)
       json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
@@ -11,7 +22,7 @@ GEM
     astrolabe (1.3.1)
       parser (~> 2.2)
     docile (1.1.5)
-    ethon (0.8.0)
+    ethon (0.8.1)
       ffi (>= 1.3.0)
     ffi (1.9.10)
     i18n (0.7.0)
@@ -40,8 +51,8 @@ GEM
     thread_safe (0.3.5)
     tilia-event (2.0.2)
       activesupport (~> 4.2)
-    tilia-uri (1.0.1)
-      activesupport (~> 4.2)
+    tilia-uri (1.0.1.1)
+      activesupport (>= 4.0)
     tins (1.6.0)
     typhoeus (0.8.0)
       ethon (>= 0.8.0)
@@ -53,16 +64,11 @@ 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)
+  tilia-http!
   yard (~> 0.8)
 
 BUNDLED WITH

data/examples/asyncclient.rb

@@ -3,13 +3,9 @@
 #
 # 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'
+require 'tilia/http'
 
 # This is the request we're repeating a 1000 times.
 request = Tilia::Http::Request.new('GET', 'http://localhost/')

data/examples/basicauth.rb

@@ -1,13 +1,9 @@
 #!/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 'tilia/http'
 require 'rack'
 
 app = proc do |env|

data/examples/client.rb

@@ -1,13 +1,9 @@
 #!/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'
+require 'tilia/http'
 
 # Constructing the request.
 request = Tilia::Http::Request.new('GET', 'http://www.jakobsack.de/')

data/examples/digestauth.rb

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+# This example does not work because of rack ...
+# This example shows how to do Basic authentication.
+
+# Expected to be called "bundle exec examples/basicauth.rb"
+require '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
+
+  digest_auth = Tilia::Http::Auth::Digest.new('Locked down area', request, response)
+  digest_auth.init
+
+  if !(user_name = digest_auth.username)
+    # No username or password given
+    digest_auth.require_login
+  elsif !user_list.key?(user_name) || !digest_auth.validate_password(userlist[user_name])
+    # Username or password are incorrect
+    digest_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/reverseproxy.rb

@@ -11,7 +11,7 @@ my_base_url = ''
 # my_base_url = '/~evert/sabre/http/examples/reverseproxy.php/'
 
 # Expected to be called "bundle exec examples/reverseproxy.rb"
-require './lib/tilia_http'
+require 'tilia/http'
 require 'rack'
 
 app = proc do |env|

data/examples/stringify.rb

@@ -4,13 +4,9 @@ require 'json'
 # serialize themselves as strings.
 #
 # This is mainly useful for debugging purposes.
-#
-# @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/stringify.rb"
-require './lib/tilia_http'
+require 'tilia/http'
 
 request = Tilia::Http::Request.new('POST', '/foo')
 request.update_headers(

data/lib/tilia/http/auth/abstract_auth.rb

@@ -5,25 +5,6 @@ module Tilia
       #
       # This class provides some common functionality for the various base classes.
       class AbstractAuth
-        protected
-
-        # Authentication realm
-        #
-        # @return [String]
-        attr_accessor :realm
-
-        # Request object
-        #
-        # @return [RequestInterface]
-        attr_accessor :request
-
-        # Response object
-        #
-        # @return [ResponseInterface]
-        attr_accessor :response
-
-        public
-
         # Creates the object
         #
         # @param [String] realm

data/lib/tilia/http/auth/aws.rb

@@ -8,20 +8,6 @@ module Tilia
       #
       # Use this class to leverage amazon's AWS authentication header
       class Aws < Tilia::Http::Auth::AbstractAuth
-        protected
-
-        # The signature supplied by the HTTP client
-        #
-        # @return [String]
-        attr_accessor :signature
-
-        # The accesskey supplied by the HTTP client
-        #
-        # @return [String]
-        attr_accessor :access_key
-
-        public
-
         # An error code, if any
         #
         # This value will be filled with one of the ERR_* constants
@@ -45,7 +31,7 @@ module Tilia
           auth_header = auth_header.split(' ')
 
           if auth_header[0] != 'AWS' || auth_header.size < 2
-            @error_code = self.class::ERR_NOAWSHEADER
+            @error_code = ERR_NOAWSHEADER
             return false
           end
 
@@ -66,14 +52,14 @@ module Tilia
         def validate(secret_key)
           content_md5 = @request.header('Content-MD5')
 
-          if content_md5
+          if content_md5.present?
             # We need to validate the integrity of the request
             body = @request.body
             @request.body = body
 
             if content_md5 != Base64.strict_encode64(::Digest::MD5.digest(body.to_s))
               # content-md5 header did not match md5 signature of body
-              @error_code = self.class::ERR_MD5CHECKSUMWRONG
+              @error_code = ERR_MD5CHECKSUMWRONG
               return false
             end
           end
@@ -98,7 +84,7 @@ module Tilia
           )
 
           unless @signature == signature
-            @error_code = self.class::ERR_INVALIDSIGNATURE
+            @error_code = ERR_INVALIDSIGNATURE
             return false
           end
           true
@@ -131,7 +117,7 @@ module Tilia
 
           # Unknown format
           unless date
-            @error_code = self.class::ERR_INVALIDDATEFORMAT
+            @error_code = ERR_INVALIDDATEFORMAT
             return false
           end
 
@@ -140,7 +126,7 @@ module Tilia
 
           # We allow 15 minutes around the current date/time
           if date > max || date < min
-            @error_code = self.class::ERR_REQUESTTIMESKEWED
+            @error_code = ERR_REQUESTTIMESKEWED
             return false
           end
 
@@ -180,7 +166,7 @@ module Tilia
           OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha1'), key, message)
         end
 
-        # TODO: document
+        # Initialize instance variables
         def initialize(realm = 'TiliaTooth', request, response)
           super
           @error_code = 0

data/lib/tilia/http/auth/digest.rb

@@ -23,19 +23,9 @@ module Tilia
         QOP_AUTH = 1
         QOP_AUTHINT = 2
 
-        protected
-
-        attr_accessor :nonce
-        attr_accessor :opaque
-        attr_accessor :digest_parts
-        attr_accessor :a1
-        attr_reader :qop
-
-        public
-
         # Initializes the object
         def initialize(realm = 'TiliaTooth', request, response)
-          @qop = self.class::QOP_AUTH
+          @qop = QOP_AUTH
 
           @nonce = ::Digest::SHA1.hexdigest((Time.now.to_f + rand).to_s)[0..14]
           @opaque = ::Digest::MD5.hexdigest(realm)
@@ -49,7 +39,7 @@ module Tilia
         # @return [void]
         def init
           digest = self.digest || ''
-          @digest_parts = parse_digest(digest)
+          @digest_parts = parse_digest(digest) || {}
         end
 
         # Sets the quality of protection value.
@@ -64,8 +54,7 @@ module Tilia
         # supported by most HTTP clients. QOP_AUTHINT also requires the entire
         # request body to be md5'ed, which can put strains on CPU and memory.
         #
-        # @param int qop
-        # @return [void]
+        # @return [Fixnum]
         attr_writer :qop
 
         # Validates the user.
@@ -73,7 +62,7 @@ module Tilia
         # The A1 parameter should be md5(username . ':' . realm . ':' . password)
         #
         # @param [String] a1
-        # @return bool
+        # @return [Boolean]
         def validate_a1(a1)
           @a1 = a1
           validate
@@ -83,7 +72,7 @@ module Tilia
         # It is strongly recommended not store the password in plain-text and use validateA1 instead.
         #
         # @param [String] password
-        # @return bool
+        # @return [Boolean]
         def validate_password(password)
           return false unless @digest_parts.any? # RUBY
 
@@ -102,7 +91,7 @@ module Tilia
 
         # Validates the digest challenge
         #
-        # @return bool
+        # @return [Boolean]
         def validate
           return false unless @digest_parts.any? # RUBY
 
@@ -110,7 +99,7 @@ module Tilia
 
           if @digest_parts['qop'] == 'auth-int'
             # Making sure we support this qop value
-            return false unless @qop & self.class::QOP_AUTHINT
+            return false unless @qop & QOP_AUTHINT
 
             # We need to add an md5 of the entire request body to the A2 part of the hash
             body = @request.body_as_string
@@ -119,7 +108,7 @@ module Tilia
             a2 << ':' + ::Digest::MD5.hexdigest(body)
           else
             # We need to make sure we support this qop value
-            return false unless @qop & self.class::QOP_AUTH
+            return false unless @qop & QOP_AUTH
           end
 
           a2 = ::Digest::MD5.hexdigest(a2)
@@ -138,11 +127,11 @@ module Tilia
         def require_login
           qop = ''
           case @qop
-          when self.class::QOP_AUTH
+          when QOP_AUTH
             qop = 'auth'
-          when self.class::QOP_AUTHINT
+          when QOP_AUTHINT
             qop = 'auth-int'
-          when self.class::QOP_AUTH | self.class::QOP_AUTHINT
+          when QOP_AUTH | QOP_AUTHINT
             qop = 'auth,auth-int'
           end
 
@@ -156,7 +145,7 @@ module Tilia
         #
         # If the header could not be found, null will be returned
         #
-        # @return mixed
+        # @return [String, nil]
         def digest
           @request.header('Authorization')
         end
@@ -165,10 +154,10 @@ module Tilia
 
         # Parses the different pieces of the digest string into an array.
         #
-        # This method returns false if an incomplete digest was supplied
+        # This method returns nil if an incomplete digest was supplied
         #
         # @param [String] digest
-        # @return mixed
+        # @return [Hash, nil]
         def parse_digest(digest)
           # protect against missing data
           needed_parts = { 'nonce' => 1, 'nc' => 1, 'cnonce' => 1, 'qop' => 1, 'username' => 1, 'uri' => 1, 'response' => 1 }
@@ -179,7 +168,7 @@ module Tilia
             needed_parts.delete m1
           end
 
-          needed_parts.any? ? {} : data
+          needed_parts.any? ? nil : data
         end
       end
     end

data/lib/tilia/http/client.rb

@@ -31,44 +31,26 @@ module Tilia
     # It's also possible to intercept specific http errors, by subscribing to for
     # example 'error:401'.
     class Client < Tilia::Event::EventEmitter
-      protected
-
-      # List of curl settings
-      #
-      # @return array
-      attr_accessor :curl_settings
-
-      # Wether or not exceptions should be thrown when a HTTP error is returned.
-      #
-      # @return bool
-      attr_accessor :throw_exceptions
-
-      # The maximum number of times we'll follow a redirect.
-      #
-      # @return int
-      attr_accessor :max_redirects
-
-      public
-
       # Initializes the client.
       #
       # @return [void]
       def initialize
-        initialize_event_emitter_trait
+        super
 
         @hydra = nil
         @throw_exceptions = false
         @max_redirects = 5
         @curl_settings = {
           header: false, # RUBY otherwise header will be part of response.body
-          nobody: false
+          nobody: false,
+          useragent: "tilia-http/#{Version::VERSION} (http://sabre.io/)"
         }
         @client_map = {}
       end
 
       # Sends a request to a HTTP server, and returns a response.
       #
-      # @param RequestInterface request
+      # @param [RequestInterface] request
       # @return [ResponseInterface]
       def send_request(request)
         emit('beforeRequest', [request])
@@ -149,9 +131,9 @@ module Tilia
       # After calling sendAsync, you must therefore occasionally call the poll
       # method, or wait.
       #
-      # @param RequestInterface request
-      # @param callable success
-      # @param callable error
+      # @param [RequestInterface] request
+      # @param [#call] success
+      # @param [#call] error
       # @return [void]
       def send_async(request, success = nil, error = nil)
         emit('beforeRequest', [request])
@@ -166,7 +148,7 @@ module Tilia
       # This method will return true if there are still requests waiting to
       # return, and false if all the work is done.
       #
-      # @return bool
+      # @return [Boolean]
       def poll
         # nothing to do?
         return false if @client_map.empty?
@@ -186,7 +168,7 @@ module Tilia
           curl_result = parse_curl_result(handler)
           do_retry = false
 
-          if curl_result['status'] == self.class::STATUS_CURLERROR
+          if curl_result['status'] == STATUS_CURLERROR
             e = Exception.new
 
             box = Box.new(do_retry)
@@ -202,7 +184,7 @@ module Tilia
             curl_result['request'] = request
 
             error_callback.call(curl_result) if error_callback
-          elsif curl_result['status'] == self.class::STATUS_HTTPERROR
+          elsif curl_result['status'] == STATUS_HTTPERROR
             box = Box.new(do_retry)
             emit('error', [request, curl_result['response'], box, retry_count])
             emit("error:#{curl_result['http_code']}", [request, curl_result['response'], box, retry_count])
@@ -249,16 +231,15 @@ module Tilia
       # This only works for the send method. Throwing exceptions for
       # send_async is not supported.
       #
-      # @param bool throw_exceptions
-      # @return [void]
+      # @return [Boolean]
       attr_writer :throw_exceptions
 
       # Adds a CURL setting.
       #
       # These settings will be included in every HTTP request.
       #
-      # @param int name
-      # @param mixed value
+      # @param [Symbol] name
+      # @param value
       # @return [void]
       def add_curl_setting(name, value)
         @curl_settings[name] = value
@@ -268,7 +249,7 @@ module Tilia
 
       # This method is responsible for performing a single request.
       #
-      # @param RequestInterface request
+      # @param [RequestInterface] request
       # @return [ResponseInterface]
       def do_request(request)
         client = create_client(request)
@@ -276,36 +257,13 @@ module Tilia
 
         response = parse_curl_result(client)
 
-        if response['status'] == self.class::STATUS_CURLERROR
+        if response['status'] == STATUS_CURLERROR
           fail Tilia::Http::ClientException.new(response['curl_errno']), response['curl_errmsg']
         end
 
         response['response']
       end
 
-      protected
-
-      # Cached curl handle.
-      #
-      # By keeping this resource around for the lifetime of this object, things
-      # like persistent connections are possible.
-      #
-      # @return resource
-      attr_accessor :curl_handle
-
-      # Handler for curl_multi requests.
-      #
-      # The first time sendAsync is used, this will be created.
-      #
-      # @return resource
-      attr_accessor :curl_multi_handle
-
-      # Has a list of curl handles, as well as their associated success and
-      # error callbacks.
-      #
-      # @return array
-      attr_accessor :curl_multi_map
-
       public
 
       STATUS_SUCCESS = 0
@@ -326,14 +284,13 @@ module Tilia
       #   * http_code - HTTP status code, as an int. Only set if Only set if
       #                 status is STATUS_SUCCESS, or STATUS_HTTPERROR
       #
-      # @param [String] response
-      # @param resource curl_handle
-      # @return Response
+      # @param [Typhoeus::Request] client
+      # @return [Response]
       def parse_curl_result(client)
         client_response = client.response
         unless client_response.return_code == :ok
           return {
-            'status'      => self.class::STATUS_CURLERROR,
+            'status'      => STATUS_CURLERROR,
             'curl_errno'  => client_response.return_code,
             'curl_errmsg' => client_response.return_message
           }
@@ -371,7 +328,7 @@ module Tilia
         http_code = response.status.to_i
 
         {
-          'status'    => http_code >= 400 ? self.class::STATUS_HTTPERROR : self.class::STATUS_SUCCESS,
+          'status'    => http_code >= 400 ? STATUS_HTTPERROR : STATUS_SUCCESS,
           'response'  => response,
           'http_code' => http_code
         }
@@ -382,10 +339,10 @@ module Tilia
       # We keep this in a separate method, so we can call it without triggering
       # the beforeRequest event and don't do the poll.
       #
-      # @param RequestInterface request
-      # @param callable success
-      # @param callable error
-      # @param int retry_count
+      # @param [RequestInterface] request
+      # @param [#call] success
+      # @param [#call] error
+      # @param [Fixnum] retry_count
       def send_async_internal(request, success, error, retry_count = 0)
         @hydra = Typhoeus::Hydra.hydra unless @hydra
 

data/lib/tilia/http/client_exception.rb

@@ -2,7 +2,7 @@ module Tilia
   module Http
     # This exception may be emitted by the HTTP\Client class, in case there was a
     # problem emitting the request.
-    class ClientException < Exception
+    class ClientException < StandardError
       # TODO: document
       def initialize(code)
         @code = code.to_i

data/lib/tilia/http/client_http_exception.rb

@@ -5,25 +5,16 @@ module Tilia
     # By default the Client will not emit these, this has to be explicitly enabled
     # with the setThrowExceptions method.
     class ClientHttpException < Tilia::Http::HttpException
-      protected
-
-      # Response object
-      #
-      # @return [ResponseInterface]
-      attr_accessor :response
-
-      public
-
       # Constructor
       #
-      # @param ResponseInterface response
+      # @param [ResponseInterface] response
       def initialize(response)
         @response = response
       end
 
       # The http status code for the error.
       #
-      # @return int
+      # @return [Fixnum]
       def http_status
         @response.status
       end