rest 2.7.2 → 3.0.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZWJlYTZlYTNkZmFjZGRiNTVlOTgwYmEzY2RmZWUxODU3MzA2MDNiMw==
-  data.tar.gz: !binary |-
-    YzdmYjM5NDBhYzMxZjgyZjMyOGE3ZGRiNDZlODI2N2RlNWNiNTI3MQ==
+SHA1:
+  metadata.gz: 6c689e6d91135dd2ac6e0f4f0f63ad55ad77ecc2
+  data.tar.gz: 70b63a96e8d9f1bfc566207907359d8d2411af63
 SHA512:
-  metadata.gz: !binary |-
-    NTAwZTBkODBhMTg3MmVlMGE0ZWViNjZhMTk2Y2FmZDc5N2QyYzAxYzJmYWE0
-    ZWZlYjk3M2E0OTRlMWQ5ZTE2MDZkMzQ4NWJmNjZiMWJjODhmZWJjMjE0NzAz
-    NjIzMWZhOWRhZDg2MzY3ZDVkMTBiZDI5NGJmZjdmMWFmOTNkZDY=
-  data.tar.gz: !binary |-
-    MjAzNjYxMDljOTljNzQ1Y2RiNTRmMmI2NjlmYjYxN2MxOTM3OTlmZjlmMDFi
-    YWU3YWU2OGZmZWRhMTIyNzBiY2U1ZjE0Njk1MGY2M2FiNmFlMjVhMWNmOWE1
-    NDM3NzYxMDZiNzllZWEzMjM5MTg5N2EyMjBiMjZhZmI0MTA0ZGU=
+  metadata.gz: 3e50465d789d0d1f9628a15365ab78d619aab36d74dfc5c00e2f64622e2d875fe7d622840089da6c6629dcbbc13a12858157bebeb9d3108ac73bc8c03a970f83
+  data.tar.gz: d7c8edf6574d60b6f0209d069f56ce7e77166cb0db7df4f257aae20b417378e0394238df9ccd5f272b627fab00f87d499981d6fb832878d324bf3960dcd9fbd4

data/Gemfile.lock

@@ -1,30 +1,27 @@
 PATH
   remote: .
   specs:
-    rest (2.7.0)
-      net-http-persistent
-      rest_client (>= 1.7.1)
+    rest (2.7.1)
+      net-http-persistent (>= 2.9.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ethon (0.6.2)
+    ethon (0.7.1)
       ffi (>= 1.3.0)
-      mime-types (~> 1.18)
-    excon (0.31.0)
-    ffi (1.9.3)
-    mime-types (1.25.1)
-    minitest (5.2.1)
-    net-http-persistent (2.9)
-    netrc (0.7.7)
+    excon (0.41.0)
+    ffi (1.9.6)
+    minitest (5.4.3)
+    net-http-persistent (2.9.4)
+    netrc (0.9.0)
+    power_assert (0.2.1)
     quicky (0.4.0)
-    rake (10.1.1)
-    rest_client (1.7.2)
-      netrc (~> 0.7.7)
-    test-unit (2.5.5)
-    typhoeus (0.6.7)
-      ethon (~> 0.6.2)
-    uber_config (1.1.0)
+    rake (10.3.2)
+    test-unit (3.0.7)
+      power_assert
+    typhoeus (0.6.9)
+      ethon (>= 0.7.1)
+    uber_config (1.1.1)
 
 PLATFORMS
   ruby
@@ -32,6 +29,7 @@ PLATFORMS
 DEPENDENCIES
   excon
   minitest
+  netrc
   quicky (>= 0.4.0)
   rake
   rest!

data/README.md

@@ -16,6 +16,7 @@ Features
 * Chooses best client you have installed on your system based on what we have found performs the best.
   * Currently net_http_persistent and typhoeus are nearly the same, but since net_http_persistent doesn't have a binary
     dependency, it wins.
+  * You can run performance tests yourself by running: `ruby test/test_performance.rb`, quite a difference between the libs.
 * Handles 503 errors with exponential backoff.
 
 
@@ -39,6 +40,7 @@ Supported http libraries are:
 * rest_client
 * net_http_persistent
 * typhoeus
+* internal - this gem's built in client.
 
 Then use it:
 

data/lib/rest.rb

@@ -13,4 +13,6 @@ if Rest.ruby_major == 1 && Rest.ruby_minor == 8
   gem 'json'
 end
 
-require File.expand_path('rest/client', File.dirname(__FILE__))
+require 'rest/errors'
+require 'rest/wrappers/base_wrapper'
+require 'rest/client'

data/lib/rest/client.rb

@@ -14,8 +14,6 @@ require 'rest/errors'
 
 module Rest
 
-  require 'rest/wrappers/base_wrapper'
-
   @@logger = Logger.new(STDOUT)
   @@logger.level = Logger::INFO
 
@@ -43,6 +41,7 @@ module Rest
   @@backing_gems[:typhoeus] = BackingGem.new(:typhoeus, 'typhoeus')
   @@backing_gems[:rest_client] = BackingGem.new(:rest_client, 'rest_client')
   @@backing_gems[:net_http_persistent] = BackingGem.new(:net_http_persistent, 'net/http/persistent')
+  @@backing_gems[:internal] = BackingGem.new(:internal, 'internal_client')
 
   def self.backing_gems
     @@backing_gems
@@ -77,11 +76,16 @@ module Rest
         require File.expand_path('wrappers/net_http_persistent_wrapper', File.dirname(__FILE__))
         @wrapper = Rest::Wrappers::NetHttpPersistentWrapper.new(self)
         @logger.debug "Using net-http-persistent gem."
-      else
+      elsif @gem == :rest_client
+        require File.expand_path('wrappers/rest_client_wrapper', File.dirname(__FILE__))
         @wrapper = Rest::Wrappers::RestClientWrapper.new
         hint = (options[:gem] ? "" : "NOTICE: Please install 'typhoeus' gem or upgrade to Ruby 2.X for optimal performance.")
         puts hint
         @logger.debug "Using rest-client gem. #{hint}"
+      else # use internal client
+        require File.expand_path('wrappers/internal_client_wrapper', File.dirname(__FILE__))
+        @wrapper = Rest::Wrappers::InternalClientWrapper.new
+        @logger.debug "Using rest internal client. #{hint}"
       end
     end
 
@@ -92,10 +96,12 @@ module Rest
         gems_to_try << :net_http_persistent
         gems_to_try << :typhoeus
         gems_to_try << :rest_client
+        gems_to_try << :internal
       else
         # net-http-persistent has issues with ssl and keep-alive connections on ruby < 1.9.3p327
         gems_to_try << :typhoeus
         gems_to_try << :rest_client
+        gems_to_try << :internal
       end
       gems_to_try.each_with_index do |g, i|
         bg = Rest.backing_gems[g]
@@ -165,11 +171,11 @@ module Rest
             raise ex if current_retry == max_retries - 1
 
             pow = (4 ** (current_retry)) * 100 # milliseconds
-                                               #puts 'pow=' + pow.to_s
+            #puts 'pow=' + pow.to_s
             s = rand * pow
-                                               #puts 's=' + s.to_s
+            #puts 's=' + s.to_s
             sleep_secs = 1.0 * s / 1000.0
-                                               #puts 'sleep for ' + sleep_secs.to_s
+            #puts 'sleep for ' + sleep_secs.to_s
             current_retry += 1
             @logger.debug "#{ex.code} Received. Retrying #{current_retry} out of #{max_retries} max in #{sleep_secs} seconds."
             sleep sleep_secs

data/lib/rest/version.rb

@@ -1,3 +1,3 @@
 module Rest
-  VERSION = "2.7.2"
+  VERSION = "3.0.0"
 end

data/lib/rest/wrappers/base_wrapper.rb

@@ -1,3 +1,5 @@
+# we need client for post_file
+
 module Rest
   class BaseWrapper
 
@@ -15,10 +17,10 @@ module Rest
           req_hash.delete(:headers)
         end
 
-        r2 = RestClient.post(url, req_hash, headers)
-        response = Rest::Wrappers::RestClientResponseWrapper.new(r2)
-      rescue RestClient::Exception => ex
-        raise Rest::Wrappers::RestClientExceptionWrapper.new(ex)
+        r2 = Rest::InternalClient.post(url, req_hash, headers)
+        response = Rest::Wrappers::InternalClientResponseWrapper.new(r2)
+      rescue Rest::InternalClient::Exception => ex
+        raise Rest::Wrappers::InternalClientExceptionWrapper.new(ex)
       end
       response
     end
@@ -40,7 +42,7 @@ module Rest
     # Provide a headers_orig method in your wrapper to allow this to work
     def headers
       new_h = {}
-      headers_orig.each_pair do |k,v|
+      headers_orig.each_pair do |k, v|
         if v.is_a?(Array) && v.size == 1
           v = v[0]
         end
@@ -51,7 +53,3 @@ module Rest
 
   end
 end
-
-# we need it for post_file, ok as gem already depends on it
-require 'rest/wrappers/rest_client_wrapper'
-

data/lib/rest/wrappers/excon_wrapper.rb

@@ -51,7 +51,7 @@ module Rest
           req_hash[:query] = req_hash[:params] if req_hash[:params]
           #p req_hash
           response = excon_request(url, req_hash)
-        rescue RestClient::Exception => ex
+        rescue Rest::RestClient::Exception => ex
           #p ex
           raise ExconExceptionWrapper.new(ex)
         end
@@ -75,7 +75,7 @@ module Rest
           req_hash[:url] = url
           to_json_parts(req_hash)
           response = excon_request(url, req_hash)
-        rescue RestClient::Exception => ex
+        rescue Rest::RestClient::Exception => ex
           raise HttpError.new(ex.response, ex.http_code)
         end
         response
@@ -87,7 +87,7 @@ module Rest
           req_hash[:method] = :put
           req_hash[:url] = url
           response = excon_request(url, req_hash)
-        rescue RestClient::Exception => ex
+        rescue Rest::RestClient::Exception => ex
           raise RestClientExceptionWrapper.new(ex)
         end
         response
@@ -111,7 +111,7 @@ module Rest
           req_hash[:method] = :delete
           req_hash[:url] = url
           response = excon_request(url, req_hash)
-        rescue RestClient::Exception => ex
+        rescue Rest::RestClient::Exception => ex
           raise RestClientExceptionWrapper.new(ex)
         end
         response

data/lib/rest/wrappers/internal_client/internal/abstract_response.rb

@@ -0,0 +1,108 @@
+require 'cgi'
+
+module Rest
+  module InternalClient
+
+    module AbstractResponse
+
+      attr_reader :net_http_res, :args
+
+      # HTTP status code
+      def code
+        @code ||= @net_http_res.code.to_i
+      end
+
+      # A hash of the headers, beautified with symbols and underscores.
+      # e.g. "Content-type" will become :content_type.
+      def headers
+        @headers ||= AbstractResponse.beautify_headers(@net_http_res.to_hash)
+      end
+
+      # The raw headers.
+      def raw_headers
+        @raw_headers ||= @net_http_res.to_hash
+      end
+
+      # Hash of cookies extracted from response headers
+      def cookies
+        @cookies ||= (self.headers[:set_cookie] || {}).inject({}) do |out, cookie_content|
+          out.merge parse_cookie(cookie_content)
+        end
+      end
+
+      # Return the default behavior corresponding to the response code:
+      # the response itself for code in 200..206, redirection for 301, 302 and 307 in get and head cases, redirection for 303 and an exception in other cases
+      def return! request = nil, result = nil, & block
+        if (200..207).include? code
+          self
+        elsif [301, 302, 307].include? code
+          unless [:get, :head].include? args[:method]
+            raise Exceptions::EXCEPTIONS_MAP[code].new(self, code)
+          else
+            follow_redirection(request, result, & block)
+          end
+        elsif code == 303
+          args[:method] = :get
+          args.delete :payload
+          follow_redirection(request, result, & block)
+        elsif Exceptions::EXCEPTIONS_MAP[code]
+          raise Exceptions::EXCEPTIONS_MAP[code].new(self, code)
+        else
+          raise RequestFailed.new(self, code)
+        end
+      end
+
+      def to_i
+        code
+      end
+
+      def description
+        "#{code} #{STATUSES[code]} | #{(headers[:content_type] || '').gsub(/;.*$/, '')} #{size} bytes\n"
+      end
+
+      # Follow a redirection
+      def follow_redirection request = nil, result = nil, & block
+        url = headers[:location]
+        if url !~ /^http/
+          url = URI.parse(args[:url]).merge(url).to_s
+        end
+        args[:url] = url
+        if request
+          if request.max_redirects == 0
+            raise MaxRedirectsReached
+          end
+          args[:password] = request.password
+          args[:user] = request.user
+          args[:headers] = request.headers
+          args[:max_redirects] = request.max_redirects - 1
+          # pass any cookie set in the result
+          if result && result['set-cookie']
+            args[:headers][:cookies] = (args[:headers][:cookies] || {}).merge(parse_cookie(result['set-cookie']))
+          end
+        end
+        Request.execute args, &block
+      end
+
+      def AbstractResponse.beautify_headers(headers)
+        headers.inject({}) do |out, (key, value)|
+          out[key.gsub(/-/, '_').downcase.to_sym] = %w{ set-cookie }.include?(key.downcase) ? value : value.first
+          out
+        end
+      end
+
+      private
+
+      # Parse a cookie value and return its content in an Hash
+      def parse_cookie cookie_content
+        out = {}
+        CGI::Cookie::parse(cookie_content).each do |key, cookie|
+          unless ['expires', 'path'].include? key
+            out[CGI::escape(key)] = cookie.value[0] ? (CGI::escape(cookie.value[0]) || '') : ''
+          end
+        end
+        out
+      end
+    end
+
+  end
+end

data/lib/rest/wrappers/internal_client/internal/exceptions.rb

@@ -0,0 +1,194 @@
+module Rest
+  module InternalClient
+
+    STATUSES = {100 => 'Continue',
+                101 => 'Switching Protocols',
+                102 => 'Processing', #WebDAV
+
+                200 => 'OK',
+                201 => 'Created',
+                202 => 'Accepted',
+                203 => 'Non-Authoritative Information', # http/1.1
+                204 => 'No Content',
+                205 => 'Reset Content',
+                206 => 'Partial Content',
+                207 => 'Multi-Status', #WebDAV
+
+                300 => 'Multiple Choices',
+                301 => 'Moved Permanently',
+                302 => 'Found',
+                303 => 'See Other', # http/1.1
+                304 => 'Not Modified',
+                305 => 'Use Proxy', # http/1.1
+                306 => 'Switch Proxy', # no longer used
+                307 => 'Temporary Redirect', # http/1.1
+
+                400 => 'Bad Request',
+                401 => 'Unauthorized',
+                402 => 'Payment Required',
+                403 => 'Forbidden',
+                404 => 'Resource Not Found',
+                405 => 'Method Not Allowed',
+                406 => 'Not Acceptable',
+                407 => 'Proxy Authentication Required',
+                408 => 'Request Timeout',
+                409 => 'Conflict',
+                410 => 'Gone',
+                411 => 'Length Required',
+                412 => 'Precondition Failed',
+                413 => 'Request Entity Too Large',
+                414 => 'Request-URI Too Long',
+                415 => 'Unsupported Media Type',
+                416 => 'Requested Range Not Satisfiable',
+                417 => 'Expectation Failed',
+                418 => 'I\'m A Teapot',
+                421 => 'Too Many Connections From This IP',
+                422 => 'Unprocessable Entity', #WebDAV
+                423 => 'Locked', #WebDAV
+                424 => 'Failed Dependency', #WebDAV
+                425 => 'Unordered Collection', #WebDAV
+                426 => 'Upgrade Required',
+                449 => 'Retry With', #Microsoft
+                450 => 'Blocked By Windows Parental Controls', #Microsoft
+
+                500 => 'Internal Server Error',
+                501 => 'Not Implemented',
+                502 => 'Bad Gateway',
+                503 => 'Service Unavailable',
+                504 => 'Gateway Timeout',
+                505 => 'HTTP Version Not Supported',
+                506 => 'Variant Also Negotiates',
+                507 => 'Insufficient Storage', #WebDAV
+                509 => 'Bandwidth Limit Exceeded', #Apache
+                510 => 'Not Extended'}
+
+    # Compatibility : make the Response act like a Net::HTTPResponse when needed
+    module ResponseForException
+      def method_missing symbol, *args
+        if net_http_res.respond_to? symbol
+          warn "[warning] The response contained in an InternalClient::Exception is now a InternalClient::Response instead of a Net::HTTPResponse, please update your code"
+          net_http_res.send symbol, *args
+        else
+          super
+        end
+      end
+    end
+
+    # This is the base InternalClient exception class. Rescue it if you want to
+    # catch any exception that your request might raise
+    # You can get the status code by e.http_code, or see anything about the
+    # response via e.response.
+    # For example, the entire result body (which is
+    # probably an HTML error page) is e.response.
+    class Exception < RuntimeError
+      attr_accessor :response
+      attr_writer :message
+
+      def initialize response = nil, initial_response_code = nil
+        @response = response
+        @message = nil
+        @initial_response_code = initial_response_code
+
+        # compatibility: this make the exception behave like a Net::HTTPResponse
+        response.extend ResponseForException if response
+      end
+
+      def http_code
+        # return integer for compatibility
+        if @response
+          @response.code.to_i
+        else
+          @initial_response_code
+        end
+      end
+
+      def http_body
+        @response.body if @response
+      end
+
+      def inspect
+        "#{message}: #{http_body}"
+      end
+
+      def to_s
+        inspect
+      end
+
+      def message
+        @message || self.class.name
+      end
+
+    end
+
+    # Compatibility
+    class ExceptionWithResponse < Exception
+    end
+
+    # The request failed with an error code not managed by the code
+    class RequestFailed < ExceptionWithResponse
+
+      def message
+        "HTTP status code #{http_code}"
+      end
+
+      def to_s
+        message
+      end
+    end
+
+    # We will a create an exception for each status code, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
+    module Exceptions
+      # Map http status codes to the corresponding exception class
+      EXCEPTIONS_MAP = {}
+    end
+
+    STATUSES.each_pair do |code, message|
+
+      # Compatibility
+      superclass = ([304, 401, 404].include? code) ? ExceptionWithResponse : RequestFailed
+      klass = Class.new(superclass) do
+        send(:define_method, :message) { "#{http_code ? "#{http_code} " : ''}#{message}" }
+      end
+      klass_constant = const_set message.delete(' \-\''), klass
+      Exceptions::EXCEPTIONS_MAP[code] = klass_constant
+    end
+
+    # A redirect was encountered; caught by execute to retry with the new url.
+    class Redirect < Exception
+
+      def message
+        'Redirect'
+      end
+
+      attr_accessor :url
+
+      def initialize(url)
+        @url = url
+      end
+    end
+
+    class MaxRedirectsReached < Exception
+      def message
+        'Maximum number of redirect reached'
+      end
+    end
+
+    # The server broke the connection prior to the request completing.  Usually
+    # this means it crashed, or sometimes that your network connection was
+    # severed before it could complete.
+    class ServerBrokeConnection < Exception
+      def initialize(message = 'Server broke connection')
+        super nil, nil
+        self.message = message
+      end
+    end
+
+    class SSLCertificateNotVerified < Exception
+      def initialize(message)
+        super nil, nil
+        self.message = message
+      end
+    end
+  end
+
+end