typhoeus 0.4.2 → 0.5.0.rc

data/lib/typhoeus/request/operations.rb

@@ -0,0 +1,71 @@
+module Typhoeus
+  class Request
+
+    # This module contains everything what is necessary
+    # to make a single request.
+    module Operations
+
+      # :nodoc:
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods # :nodoc:
+
+        # Shortcut to perform a single request.
+        #
+        # @example Perform request.
+        #   Request.run("www.example.com")
+        #
+        # @param [ String ] url The url to request.
+        # @param [ Hash ] options The options hash.
+        #
+        # @return [ Response ] The response.
+        #
+        # @deprecated
+        def run(url, options = {})
+          new(url, options).run
+        end
+      end
+
+      # Run a request.
+      #
+      # @example Run a request.
+      #  Typhoeus::Request.new("www.example.com").run
+      #
+      # @return [ Response ] The response.
+      def run
+        easy = Typhoeus.get_easy
+        easy.http_request(
+          url,
+          options.fetch(:method, :get),
+          options.reject{|k,_| k==:method}
+        )
+        easy.prepare
+        easy.perform
+        finish(Response.new(easy.to_hash))
+        Typhoeus.release_easy(easy)
+        response
+      end
+
+      # Sets a response, the request on the response
+      # and executes the callbacks.
+      #
+      # @param [Typhoeus::Response] response The response.
+      # @param [Boolean] bypass_memoization Wether to bypass
+      #   memoization or not. Decides how the response is set.
+      #
+      # @return [Typhoeus::Response] The response.
+      def finish(response, bypass_memoization = nil)
+        if bypass_memoization
+          @response = response
+        else
+          self.response = response
+        end
+        self.response.request = self
+        execute_callbacks
+        response
+      end
+    end
+  end
+end

data/lib/typhoeus/request/responseable.rb

@@ -0,0 +1,29 @@
+module Typhoeus
+  class Request
+
+    # This module contains logic for having a reponse
+    # getter and setter.
+    module Responseable
+
+      # Set the response.
+      #
+      # @example Set response.
+      #  request.response = response
+      #
+      # @param [ Response ] value The response to set.
+      def response=(value)
+        @response = value
+      end
+
+      # Return the response.
+      #
+      # @example Return response.
+      #   request.response
+      #
+      # @return [ Response ] The response.
+      def response
+        @response ||= nil
+      end
+    end
+  end
+end

data/lib/typhoeus/request/stubbable.rb

@@ -0,0 +1,28 @@
+module Typhoeus
+  class Request
+
+    # This module handles stubbing on the request side.
+    # It plays well with the block_connection configuration,
+    # which raises when you make a request which is not stubbed.
+    #
+    # @api private
+    module Stubbable
+
+      # Override run in order to check for matching expecations.
+      # When an expecation is found, super is not called. Instead a
+      # canned response is assigned to the request.
+      #
+      # @example Run the request.
+      #   request.run
+      #
+      # @return [ Response ] The response.
+      def run
+        if expectation = Expectation.find_by(self)
+          finish(expectation.response)
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/typhoeus/request.rb

@@ -1,266 +1,169 @@
-require 'uri'
+require 'typhoeus/request/actions'
+require 'typhoeus/request/before'
+require 'typhoeus/request/block_connection'
+require 'typhoeus/request/callbacks'
+require 'typhoeus/request/marshal'
+require 'typhoeus/request/memoizable'
+require 'typhoeus/request/operations'
+require 'typhoeus/request/responseable'
+require 'typhoeus/request/stubbable'
 
 module Typhoeus
+
+  # This class represents a request.
+  #
+  # @example (see #initialize)
+  #
+  # @example Make a request with the shortcut.
+  #   response = Typhoeus.get("www.example.com")
+  #
+  # @see (see #initialize)
   class Request
-    ACCESSOR_OPTIONS = [
-      :method,
-      :params,
-      :body,
-      :headers,
-      :cache_key_basis,
-      :connect_timeout,
-      :timeout,
-      :user_agent,
-      :response,
-      :cache_timeout,
-      :follow_location,
-      :max_redirects,
-      :proxy,
-      :proxy_username,
-      :proxy_password,
-      :disable_ssl_peer_verification,
-      :disable_ssl_host_verification,
-      :interface,
-      :ssl_cert,
-      :ssl_cert_type,
-      :ssl_key,
-      :ssl_key_type,
-      :ssl_key_password,
-      :ssl_cacert,
-      :ssl_capath,
-      :ssl_version,
-      :verbose,
-      :username,
-      :password,
-      :auth_method,
-      :proxy_auth_method,
-      :proxy_type
-    ]
+    extend  Request::Actions
+    include Request::Callbacks::Types
+    include Request::Callbacks
+    include Request::Marshal
+    include Request::Operations
+    include Request::Responseable
+    include Request::Memoizable
+    include Request::BlockConnection
+    include Request::Stubbable
+    include Request::Before
+
+    # Returns the provided url.
+    #
+    # @return [ String ]
+    attr_accessor :url
 
-    attr_accessor *ACCESSOR_OPTIONS
+    # Returns options, which includes default parameters.
+    #
+    # @return [ Hash ]
+    attr_accessor :options
 
-    # Initialize a new Request
+    # Returns the hydra the request ran into if any.
     #
-    # Options:
-    # * +url+ : Endpoint (URL) of the request
-    # * +options+   : A hash containing options among :
-    # ** +:method+  : :get (default) / :post / :put
-    # ** +:params+  : params as a Hash
-    # ** +:body+
-    # ** +:timeout+ : timeout (ms)
-    # ** +:interface+ : interface or ip address (string)
-    # ** +:connect_timeout+ : connect timeout (ms)
-    # ** +:headers+  : headers as Hash
-    # ** +:cache_timeout+ : cache timeout (ms)
-    # ** +:follow_location
-    # ** +:max_redirects
-    # ** +:proxy
-    # ** +:disable_ssl_peer_verification
-    # ** +:disable_ssl_host_verification
-    # ** +:ssl_cert
-    # ** +:ssl_cert_type
-    # ** +:ssl_key
-    # ** +:ssl_key_type
-    # ** +:ssl_key_password
-    # ** +:ssl_cacert
-    # ** +:ssl_capath
-    # ** +:verbose
-    # ** +:username
-    # ** +:password
-    # ** +:auth_method
+    # @return [ Typhoeus::Hydra ]
     #
-    def initialize(url, options = {})
-      @url = url
-      @method           = options[:method] || :get
-      @params           = options[:params]
-      @body             = options[:body]
-      @timeout          = safe_to_i(options[:timeout])
-      @connect_timeout  = safe_to_i(options[:connect_timeout])
-      @interface        = options[:interface]
-      @headers          = options[:headers] || {}
-
-      @cache_timeout    = safe_to_i(options[:cache_timeout])
-      @follow_location  = options[:follow_location]
-      @max_redirects    = options[:max_redirects]
-      @proxy            = options[:proxy]
-      @proxy_type       = options[:proxy_type]
-      @proxy_username   = options[:proxy_username]
-      @proxy_password   = options[:proxy_password]
-      @proxy_auth_method = options[:proxy_auth_method]
-      @disable_ssl_peer_verification = options[:disable_ssl_peer_verification]
-      @disable_ssl_host_verification = options[:disable_ssl_host_verification]
-      @ssl_cert         = options[:ssl_cert]
-      @ssl_cert_type    = options[:ssl_cert_type]
-      @ssl_key          = options[:ssl_key]
-      @ssl_key_type     = options[:ssl_key_type]
-      @ssl_key_password = options[:ssl_key_password]
-      @ssl_cacert       = options[:ssl_cacert]
-      @ssl_capath       = options[:ssl_capath]
-      @ssl_version      = options[:ssl_version]
-      @verbose          = options[:verbose]
-      @username         = options[:username]
-      @password         = options[:password]
-      @auth_method      = options[:auth_method]
-
-      @on_complete      = nil
-      @after_complete   = nil
-      @handled_response = nil
-    end
-
-    LOCALHOST_ALIASES = %w[ localhost 127.0.0.1 0.0.0.0 ]
-
-    def localhost?
-      LOCALHOST_ALIASES.include?(parsed_uri.host)
-    end
+    # @api private
+    attr_accessor :hydra
 
-    def user_agent
-      headers['User-Agent']
-    end
-
-    def url
-      if [:post, :put].include?(@method)
-        @url
-      else
-        url = "#{@url}?#{params_string}"
-        url += "&#{URI.escape(@body)}" if @body
-        url.gsub("?&", "?").gsub(/\?$/, '')
-      end
-    end
-
-    def parsed_uri
-      @parsed_uri ||= URI.parse(@url)
-    end
-
-    def host
-      slash_location = @url.index('/', 8)
-      if slash_location
-        @url.slice(0, slash_location)
-      else
-        query_string_location = @url.index('?')
-        return query_string_location ? @url.slice(0, query_string_location) : @url
-      end
-    end
-
-    def host_domain
-      parsed_uri.host
-    end
-
-    def params_string
-      return nil unless params
-      traversal = Typhoeus::Utils.traverse_params_hash(params)
-      Typhoeus::Utils.traversal_to_param_string(traversal)
-    end
-
-    def on_complete(&block)
-      @on_complete = block
-    end
-
-    def on_complete=(proc)
-      @on_complete = proc
-    end
-
-    def after_complete(&block)
-      @after_complete = block
-    end
+    # Returns the original options provided.
+    #
+    # @return [ Hash ]
+    #
+    # @api private
+    attr_accessor :original_options
 
-    def after_complete=(proc)
-      @after_complete = proc
-    end
+    # @return [ Boolean ]
+    #
+    # @api private
+    attr_accessor :block_connection
 
-    def call_handlers
-      if @on_complete
-        @handled_response = @on_complete.call(response)
-        call_after_complete
-      end
-    end
+    # Create a new request.
+    #
+    # @example Simplest request.
+    #   response = Typhoeus::Request.new("www.example.com").run
+    #
+    # @example Request with url parameters.
+    #   response = Typhoeus::Request.new(
+    #     "www.example.com",
+    #     :params => {:a => 1}
+    #   ).run
+    #
+    # @example Request with a body.
+    #   response = Typhoeus::Request.new(
+    #     "www.example.com",
+    #     :body => {:b => 2}
+    #   ).run
+    #
+    # @example Request with parameters and body.
+    #   response = Typhoeus::Request.new(
+    #     "www.example.com",
+    #     :params => {:a => 1},
+    #     :body => {:b => 2}
+    #   ).run
+    #
+    # @example Create a request and allow follow redirections.
+    #   response = Typhoeus::Request.new(
+    #     "www.example.com",
+    #     :followlocation => true
+    #   ).run
+    #
+    # @param [ String ] url The url to request.
+    # @param [ options ] options The options.
+    #
+    # @option options [ Hash ] :params Translated
+    #   into url parameters.
+    # @option options [ Hash ] :body Translated
+    #   into HTTP POST request body.
+    #
+    # @return [ Typhoeus::Request ] The request.
+    #
+    # @note See {Ethon::Easy#initialize} for more options.
+    #
+    # @see Typhoeus::Hydra
+    # @see Typhoeus::Response
+    # @see Typhoeus::Request::Actions
+    def initialize(url, options = {})
+      @url = url
+      @original_options = options
+      @options = options.dup
 
-    def call_after_complete
-      @after_complete.call(@handled_response) if @after_complete
+      set_defaults
     end
 
-    def handled_response=(val)
-      @handled_response = val
+    # Returns wether other is equal to self.
+    #
+    # @example Are request equal?
+    #   request.eql?(other_request)
+    #
+    # @param [ Object ] other The object to check.
+    #
+    # @return [ Boolean ] Returns true if equals, else false.
+    #
+    # @api private
+    def eql?(other)
+      self.class == other.class &&
+        self.url == other.url &&
+        fuzzy_hash_eql?(self.options, other.options)
     end
 
-    def handled_response
-      @handled_response || response
+    # Overrides Object#hash.
+    #
+    # @return [ Integer ] The integer representing the request.
+    #
+    # @api private
+    def hash
+      [ self.class, self.url, self.options ].hash
     end
 
-    def inspect
-      result = ":method => #{self.method.inspect},\n" <<
-               "\t:url => #{URI.parse(self.url).to_s}"
-      if self.body and !self.body.empty?
-        result << ",\n\t:body => #{self.body.inspect}"
-      end
-
-      if self.params and !self.params.empty?
-        result << ",\n\t:params => #{self.params.inspect}"
-      end
+    private
 
-      if self.headers and !self.headers.empty?
-        result << ",\n\t:headers => #{self.headers.inspect}"
+    # Checks if two hashes are equal or not, discarding
+    # first-level hash order.
+    #
+    # @param [ Hash ] left
+    # @param [ Hash ] right hash to check for equality
+    #
+    # @return [ Boolean ] Returns true if hashes have
+    #   same values for same keys and same length,
+    #   even if the keys are given in a different order.
+    def fuzzy_hash_eql?(left, right)
+      return true if (left == right)
+
+      (left.count == right.count) && left.inject(true) do |res, kvp|
+        res && (kvp[1] == right[kvp[0]])
       end
-
-      result
-    end
-
-    def cache_key
-      Digest::SHA1.hexdigest(cache_key_basis || url)
     end
 
-    def self.run(url, params)
-      r = new(url, params)
-      Typhoeus::Hydra.hydra.queue r
-      Typhoeus::Hydra.hydra.run
-      r.response
-    end
-
-    def self.get(url, params = {})
-      run(url, params.merge(:method => :get))
-    end
-
-    def self.post(url, params = {})
-      run(url, params.merge(:method => :post))
-    end
-
-    def self.put(url, params = {})
-      run(url, params.merge(:method => :put))
-    end
-
-    def self.delete(url, params = {})
-      run(url, params.merge(:method => :delete))
-    end
-
-    def self.head(url, params = {})
-      run(url, params.merge(:method => :head))
-    end
-
-  protected
-
-    # Return the important data needed to serialize this Request, except the
-    # `on_complete` and `after_complete` handlers, since they cannot be
-    # marshalled.
-    def marshal_dump
-      (instance_variables - ['@on_complete', '@after_complete', :@on_complete, :@after_complete]).map do |name|
-        [name, instance_variable_get(name)]
+    # Sets default header and verbose when turned on.
+    def set_defaults
+      if @options[:headers]
+        @options[:headers] = {'User-Agent' => Typhoeus::USER_AGENT}.merge(options[:headers])
+      else
+        @options[:headers] = {'User-Agent' => Typhoeus::USER_AGENT}
       end
-    end
-
-    def marshal_load(attributes)
-      attributes.each { |name, value| instance_variable_set(name, value) }
-    end
-
-    def self.options
-      ACCESSOR_OPTIONS
-    end
-
-  private
-
-    def safe_to_i(value)
-      return value if value.is_a?(Fixnum)
-      return nil if value.nil?
-      return nil if value.respond_to?(:empty?) && value.empty?
-      value.to_i
+      @options[:verbose] = Typhoeus::Config.verbose if @options[:verbose].nil? && !Typhoeus::Config.verbose.nil?
     end
   end
 end

data/lib/typhoeus/response/header.rb

@@ -0,0 +1,54 @@
+module Typhoeus
+  class Response
+
+    # This class represents the response header.
+    # It can be accessed like a hash.
+    #
+    # @api private
+    class Header < Hash
+      # Create a new header.
+      #
+      # @example Create new header.
+      #   Header.new(raw)
+      #
+      # @param [ String ] raw The raw header.
+      def initialize(raw)
+        @raw = raw
+        parse
+      end
+
+      # Parses the raw header.
+      #
+      # @example Parse header.
+      #   header.parse
+      def parse
+        raw.lines.each do |header|
+          unless header =~ /^HTTP\/1.[01]/
+            parts = header.split(':', 2)
+            unless parts.empty?
+              parts.map(&:strip!)
+              if self.has_key?(parts[0])
+                self[parts[0]] = [self[parts[0]]] unless self[parts[0]].kind_of? Array
+                self[parts[0]] << parts[1]
+              else
+                self[parts[0]] = parts[1]
+              end
+            end
+          end
+        end
+      end
+
+      private
+
+      # Returns the raw header or empty string.
+      #
+      # @example Return raw header.
+      #   header.raw
+      #
+      # @return [ String ] The raw header.
+      def raw
+        @raw ||= ''
+      end
+    end
+  end
+end