marnen-typhoeus 0.3.4

data/lib/typhoeus/remote_method.rb

@@ -0,0 +1,108 @@
+module Typhoeus
+  class RemoteMethod
+    attr_accessor :http_method, :options, :base_uri, :path, :on_success, :on_failure, :cache_ttl
+    
+    def initialize(options = {})
+      @http_method       = options.delete(:method) || :get
+      @options           = options
+      @base_uri          = options.delete(:base_uri)
+      @path              = options.delete(:path)
+      @on_success        = options[:on_success]
+      @on_failure        = options[:on_failure]
+      @cache_responses   = options.delete(:cache_responses)
+      @memoize_responses = options.delete(:memoize_responses) || @cache_responses
+      @cache_ttl         = @cache_responses == true ? 0 : @cache_responses
+      @keys              = nil
+      
+      clear_cache
+    end
+    
+    def cache_responses?
+      @cache_responses
+    end
+    
+    def memoize_responses?
+      @memoize_responses
+    end
+    
+    def args_options_key(args, options)
+      "#{args.to_s}+#{options.to_s}"
+    end
+    
+    def calling(args, options)
+      @called_methods[args_options_key(args, options)] = true
+    end
+    
+    def already_called?(args, options)
+      @called_methods.has_key? args_options_key(args, options)
+    end
+    
+    def add_response_block(block, args, options)
+      @response_blocks[args_options_key(args, options)] << block
+    end
+    
+    def call_response_blocks(result, args, options)
+      key = args_options_key(args, options)
+      @response_blocks[key].each {|block| block.call(result)}
+      @response_blocks.delete(key)
+      @called_methods.delete(key)
+    end
+    
+    def clear_cache
+      @response_blocks  = Hash.new {|h, k| h[k] = []}
+      @called_methods   = {}      
+    end
+    
+    def merge_options(new_options)
+      merged = options.merge(new_options)
+      if options.has_key?(:params) && new_options.has_key?(:params)
+        merged[:params] = options[:params].merge(new_options[:params])
+      end
+      argument_names.each {|a| merged.delete(a)}
+      merged.delete(:on_success) if merged[:on_success].nil?
+      merged.delete(:on_failure) if merged[:on_failure].nil?
+      merged
+    end
+    
+    def interpolate_path_with_arguments(args)
+      interpolated_path = @path
+      argument_names.each do |arg|
+        interpolated_path = interpolated_path.gsub(":#{arg}", args[arg].to_s)
+      end
+      interpolated_path
+    end
+    
+    def argument_names
+      return @keys if @keys
+      pattern, keys = compile(@path)
+      @keys = keys.collect {|k| k.to_sym}
+    end
+    
+    # rippped from Sinatra. clean up stuff we don't need later
+    def compile(path)
+      path ||= ""
+      keys = []
+      if path.respond_to? :to_str
+        special_chars = %w{. + ( )}
+        pattern =
+          path.gsub(/((:\w+)|[\*#{special_chars.join}])/) do |match|
+            case match
+            when "*"
+              keys << 'splat'
+              "(.*?)"
+            when *special_chars
+              Regexp.escape(match)
+            else
+              keys << $2[1..-1]
+              "([^/?&#]+)"
+            end
+          end
+        [/^#{pattern}$/, keys]
+      elsif path.respond_to? :match
+        [path, keys]
+      else
+        raise TypeError, path
+      end
+    end
+  end
+end

data/lib/typhoeus/remote_proxy_object.rb

@@ -0,0 +1,50 @@
+module Typhoeus
+  class RemoteProxyObject
+    instance_methods.each { |m| undef_method m unless m =~ /^__|object_id/ }
+
+    def initialize(clear_memoized_store_proc, easy, options = {})
+      @clear_memoized_store_proc = clear_memoized_store_proc
+      @easy      = easy
+      @success   = options[:on_success]
+      @failure   = options[:on_failure]
+      @cache     = options.delete(:cache)
+      @cache_key = options.delete(:cache_key)
+      @timeout   = options.delete(:cache_timeout)
+      Typhoeus.add_easy_request(@easy)
+    end
+
+    def method_missing(sym, *args, &block)
+      unless @proxied_object
+        if @cache && @cache_key
+          @proxied_object = @cache.get(@cache_key) rescue nil
+        end
+
+        unless @proxied_object
+          Typhoeus.perform_easy_requests
+          response = Response.new(:code => @easy.response_code,
+                                  :curl_return_code => @easy.curl_return_code,
+                                  :curl_error_message => @easy.curl_error_message,
+                                  :headers => @easy.response_header,
+                                  :body => @easy.response_body,
+                                  :time => @easy.total_time_taken,
+                                  :requested_url => @easy.url,
+                                  :requested_http_method => @easy.method,
+                                  :start_time => @easy.start_time)
+          if @easy.response_code >= 200 && @easy.response_code < 300
+            Typhoeus.release_easy_object(@easy)
+            @proxied_object = @success.nil? ? response : @success.call(response)
+
+            if @cache && @cache_key
+              @cache.set(@cache_key, @proxied_object, @timeout)
+            end
+          else
+            @proxied_object = @failure.nil? ? response : @failure.call(response)
+          end
+         @clear_memoized_store_proc.call
+       end
+      end
+
+      @proxied_object.__send__(sym, *args, &block)
+    end
+  end
+end

data/lib/typhoeus/request.rb

@@ -0,0 +1,269 @@
+require 'uri'
+
+module Typhoeus
+  class Request
+    ACCESSOR_OPTIONS = [
+      :method,
+      :params,
+      :body,
+      :headers,
+      :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,
+      :user_agent,
+      :proxy_auth_method,
+      :proxy_type
+    ]
+
+    attr_reader   :url
+    attr_accessor *ACCESSOR_OPTIONS
+
+    # Initialize a new Request
+    #
+    # 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
+    # ** +:user_agent+ : user agent (string) - DEPRECATED
+    #
+    def initialize(url, options = {})
+      @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] || {}
+
+      if options.has_key?(:user_agent)
+        self.user_agent = options[:user_agent]
+      end
+
+      @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]
+
+      if @method == :post
+        @url = url
+      else
+        @url = @params ? "#{url}?#{params_string}" : url
+      end
+
+      @parsed_uri = URI.parse(@url)
+
+      @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
+
+    def user_agent
+      headers['User-Agent']
+    end
+
+    def user_agent=(value)
+      puts "DEPRECATED: Typhoeus::Request#user_agent=(value). This will be removed in a later version."
+      headers['User-Agent'] = value
+    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
+      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
+
+    def after_complete=(proc)
+      @after_complete = proc
+    end
+
+    def call_handlers
+      if @on_complete
+        @handled_response = @on_complete.call(response)
+        call_after_complete
+      end
+    end
+
+    def call_after_complete
+      @after_complete.call(@handled_response) if @after_complete
+    end
+
+    def handled_response=(val)
+      @handled_response = val
+    end
+
+    def handled_response
+      @handled_response || response
+    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
+
+      if self.headers and !self.headers.empty?
+        result << ",\n\t:headers => #{self.headers.inspect}"
+      end
+
+      result
+    end
+
+    def cache_key
+      Digest::SHA1.hexdigest(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)]
+      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
+    end
+  end
+end

data/lib/typhoeus/response.rb

@@ -0,0 +1,122 @@
+module Typhoeus
+  class Response
+    attr_accessor :request, :mock
+    attr_reader :code, :headers, :body, :time,
+                :requested_url, :requested_remote_method,
+                :requested_http_method, :start_time,
+                :effective_url, :start_transfer_time,
+                :app_connect_time, :pretransfer_time,
+                :connect_time, :name_lookup_time,
+                :curl_return_code, :curl_error_message,
+                :primary_ip
+
+    attr_writer :headers_hash
+
+    def initialize(params = {})
+      @code                  = params[:code]
+      @curl_return_code      = params[:curl_return_code]
+      @curl_error_message    = params[:curl_error_message]
+      @status_message        = params[:status_message]
+      @http_version          = params[:http_version]
+      @headers               = params[:headers]
+      @body                  = params[:body]
+      @time                  = params[:time]
+      @requested_url         = params[:requested_url]
+      @requested_http_method = params[:requested_http_method]
+      @start_time            = params[:start_time]
+      @start_transfer_time   = params[:start_transfer_time]
+      @app_connect_time      = params[:app_connect_time]
+      @pretransfer_time      = params[:pretransfer_time]
+      @connect_time          = params[:connect_time]
+      @name_lookup_time      = params[:name_lookup_time]
+      @request               = params[:request]
+      @effective_url         = params[:effective_url]
+      @primary_ip            = params[:primary_ip]
+      @mock                  = params[:mock] || false  # default
+      @headers_hash          = NormalizedHeaderHash.new(params[:headers_hash]) if params[:headers_hash]
+    end
+
+    # Returns true if this is a mock response.
+    def mock?
+      @mock
+    end
+
+    def headers
+      @headers ||= @headers_hash ? construct_header_string : ''
+    end
+
+    def headers_hash
+      @headers_hash ||= begin
+        headers.split("\n").map {|o| o.strip}.inject(Typhoeus::NormalizedHeaderHash.new) do |hash, o|
+          if o.empty? || o =~ /^HTTP\/[\d\.]+/
+            hash
+          else
+            i = o.index(":") || o.size
+            key = o.slice(0, i)
+            value = o.slice(i + 1, o.size)
+            value = value.strip unless value.nil?
+            if hash.has_key? key
+              hash[key] = [hash[key], value].flatten
+            else
+              hash[key] = value
+            end
+
+            hash
+          end
+        end
+      end
+    end
+
+    def status_message
+      return @status_message if @status_message != nil
+
+      # HTTP servers can choose not to include the explanation to HTTP codes. The RFC
+      # states this (http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4):
+      # Except when responding to a HEAD request, the server SHOULD include an entity containing
+      # an explanation of the error situation [...]
+      # This means 'HTTP/1.1 404' is as valid as 'HTTP/1.1 404 Not Found' and we have to handle it.
+
+      # Regexp doc: http://rubular.com/r/eAr1oVYsVa
+      if first_header_line != nil and first_header_line[/\d{3} (.*)$/, 1] != nil
+        @status_message = first_header_line[/\d{3} (.*)$/, 1].chomp
+      else
+        @status_message = nil
+      end
+    end
+
+    def http_version
+      @http_version ||= first_header_line ? first_header_line[/HTTP\/(\S+)/, 1] : nil
+    end
+
+    def success?
+      @code >= 200 && @code < 300
+    end
+
+    def modified?
+      @code != 304
+    end
+
+    def timed_out?
+      curl_return_code == 28
+    end
+
+    private
+
+      def first_header_line
+        @first_header_line ||= @headers.to_s.split("\n").first
+      end
+
+      def construct_header_string
+        lines = ["HTTP/#{http_version} #{code} #{status_message}"]
+
+        @headers_hash.each do |key, values|
+          [values].flatten.each do |value|
+            lines << "#{key}: #{value}"
+          end
+        end
+
+        lines << '' << ''
+        lines.join("\r\n")
+      end
+  end
+end