dcu-typhoeus 0.4.0

data/lib/typhoeus/hydra.rb

@@ -0,0 +1,246 @@
+require 'typhoeus/hydra/callbacks'
+require 'typhoeus/hydra/connect_options'
+require 'typhoeus/hydra/stubbing'
+
+module Typhoeus
+  class Hydra
+    include ConnectOptions
+    include Stubbing
+    extend Callbacks
+
+    def initialize(options = {})
+      @memoize_requests = true
+      @multi       = Multi.new
+      @easy_pool   = []
+      initial_pool_size = options[:initial_pool_size] || 10
+      @max_concurrency = options[:max_concurrency] || 200
+      initial_pool_size.times { @easy_pool << Easy.new }
+      @memoized_requests = {}
+      @retrieved_from_cache = {}
+      @queued_requests = []
+      @running_requests = 0
+
+      self.stubs = []
+      @active_stubs = []
+    end
+
+    def self.hydra
+      @hydra ||= new
+    end
+
+    def self.hydra=(val)
+      @hydra = val
+    end
+
+    #
+    # Abort the run on a best-effort basis.
+    #
+    # It won't abort the current burst of @max_concurrency requests,
+    # however it won't fire the rest of the queued requests so the run
+    # will be aborted as soon as possible...
+    #
+    def abort
+      @queued_requests.clear
+    end
+
+    def clear_cache_callbacks
+      @cache_setter = nil
+      @cache_getter = nil
+    end
+
+    def fire_and_forget
+      @queued_requests.each {|r| queue(r, false)}
+      @multi.fire_and_forget
+    end
+
+    def queue(request, obey_concurrency_limit = true)
+      return if assign_to_stub(request)
+
+      # At this point, we are running over live HTTP. Make sure we haven't
+      # disabled live requests.
+      check_allow_net_connect!(request)
+
+      if @running_requests >= @max_concurrency && obey_concurrency_limit
+        @queued_requests << request
+      else
+        if request.method == :get
+          if @memoize_requests && @memoized_requests.key?(request.url)
+            if response = @retrieved_from_cache[request.url]
+              request.response = response
+              request.call_handlers
+            else
+              @memoized_requests[request.url] << request
+            end
+          else
+            @memoized_requests[request.url] = [] if @memoize_requests
+            get_from_cache_or_queue(request)
+          end
+        else
+          get_from_cache_or_queue(request)
+        end
+      end
+    end
+
+    def run
+      while !@active_stubs.empty?
+        m = @active_stubs.first
+        while request = m.requests.shift
+          response = m.response
+          response.request = request
+          handle_request(request, response)
+        end
+        @active_stubs.delete(m)
+      end
+
+      @multi.perform
+    ensure
+      @multi.reset_easy_handles{|easy| release_easy_object(easy)}
+      @memoized_requests = {}
+      @retrieved_from_cache = {}
+      @running_requests = 0
+    end
+
+    def disable_memoization
+      @memoize_requests = false
+    end
+
+    def cache_getter(&block)
+      @cache_getter = block
+    end
+
+    def cache_setter(&block)
+      @cache_setter = block
+    end
+
+    def on_complete(&block)
+      @on_complete = block
+    end
+
+    def on_complete=(proc)
+      @on_complete = proc
+    end
+
+    private
+
+    def get_from_cache_or_queue(request)
+      if @cache_getter
+        val = @cache_getter.call(request)
+        if val
+          @retrieved_from_cache[request.url] = val
+          queue_next
+          handle_request(request, val, false)
+        else
+          @multi.add(get_easy_object(request))
+        end
+      else
+        @multi.add(get_easy_object(request))
+      end
+    end
+
+    def get_easy_object(request)
+      @running_requests += 1
+
+      easy = @easy_pool.pop || Easy.new
+      easy.verbose          = request.verbose
+      if request.username || request.password
+        auth = { :username => request.username, :password => request.password }
+        auth[:method] = request.auth_method if request.auth_method
+        easy.auth = auth
+      end
+
+      if request.proxy
+        proxy = { :server => request.proxy }
+        proxy[:type] = request.proxy_type if request.proxy_type
+        easy.proxy = proxy if request.proxy
+      end
+
+      if request.proxy_username || request.proxy_password
+        auth = { :username => request.proxy_username, :password => request.proxy_password }
+        auth[:method] = request.proxy_auth_method if request.proxy_auth_method
+        easy.proxy_auth = auth
+      end
+
+      easy.url          = request.url
+      easy.method       = request.method
+      easy.params       = request.params  if request.method == :post && request.params.present?
+      easy.headers      = request.headers if request.headers
+      easy.request_body = request.body    if request.method == :post && request.body.present?
+      easy.timeout      = request.timeout if request.timeout
+      easy.connect_timeout = request.connect_timeout if request.connect_timeout
+      easy.interface       = request.interface if request.interface
+      easy.follow_location = request.follow_location if request.follow_location
+      easy.max_redirects = request.max_redirects if request.max_redirects
+      easy.disable_ssl_peer_verification if request.disable_ssl_peer_verification
+      easy.disable_ssl_host_verification if request.disable_ssl_host_verification
+      easy.ssl_cert         = request.ssl_cert
+      easy.ssl_cert_type    = request.ssl_cert_type
+      easy.ssl_key          = request.ssl_key
+      easy.ssl_key_type     = request.ssl_key_type
+      easy.ssl_key_password = request.ssl_key_password
+      easy.ssl_cacert       = request.ssl_cacert
+      easy.ssl_capath       = request.ssl_capath
+      easy.ssl_version      = request.ssl_version || :default
+      easy.verbose          = request.verbose
+
+      easy.on_success do |easy|
+        queue_next
+        handle_request(request, response_from_easy(easy, request))
+        release_easy_object(easy)
+      end
+      easy.on_failure do |easy|
+        queue_next
+        handle_request(request, response_from_easy(easy, request))
+        release_easy_object(easy)
+      end
+      easy.set_headers
+      easy
+    end
+
+    def queue_next
+      @running_requests -= 1
+      queue(@queued_requests.shift) unless @queued_requests.empty?
+    end
+
+    def release_easy_object(easy)
+      easy.reset
+      @easy_pool.push easy
+    end
+
+    def handle_request(request, response, live_request = true)
+      request.response = response
+
+      self.class.run_global_hooks_for(:after_request_before_on_complete,
+                                      request)
+
+      if live_request && request.cache_timeout && @cache_setter
+        @cache_setter.call(request)
+      end
+      @on_complete.call(response) if @on_complete
+
+      request.call_handlers
+      if requests = @memoized_requests[request.url]
+        requests.each do |r|
+          r.response = response
+          r.call_handlers
+        end
+      end
+    end
+
+    def response_from_easy(easy, request)
+      Response.new(:code                => easy.response_code,
+                   :headers             => easy.response_header,
+                   :body                => easy.response_body,
+                   :time                => easy.total_time_taken,
+                   :start_transfer_time => easy.start_transfer_time,
+                   :app_connect_time    => easy.app_connect_time,
+                   :pretransfer_time    => easy.pretransfer_time,
+                   :connect_time        => easy.connect_time,
+                   :name_lookup_time    => easy.name_lookup_time,
+                   :effective_url       => easy.effective_url,
+                   :primary_ip          => easy.primary_ip,
+                   :curl_return_code => easy.curl_return_code,
+                   :curl_error_message => easy.curl_error_message,
+                   :request             => request)
+    end
+  end
+end

data/lib/typhoeus/hydra_mock.rb

@@ -0,0 +1,131 @@
+module Typhoeus
+  class HydraMock
+    attr_reader :url, :method, :requests, :uri
+
+    def initialize(url, method, options = {})
+      @url      = url
+      @uri      = URI.parse(url) if url.kind_of?(String)
+      @method   = method
+      @requests = []
+      @options = options
+      if @options[:headers]
+        @options[:headers] = Typhoeus::Header.new(@options[:headers])
+      end
+
+      @current_response_index = 0
+    end
+
+    def body
+      @options[:body]
+    end
+
+    def body?
+      @options.has_key?(:body)
+    end
+
+    def headers
+      @options[:headers]
+    end
+
+    def headers?
+      @options.has_key?(:headers)
+    end
+
+    def add_request(request)
+      @requests << request
+    end
+
+    def and_return(val)
+      if val.respond_to?(:each)
+        @responses = val
+      else
+        @responses = [val]
+      end
+
+      # make sure to mark them as a mock.
+      @responses.each { |r| r.mock = true }
+
+      val
+    end
+
+    def response
+      if @current_response_index == (@responses.length - 1)
+        @responses.last
+      else
+        value = @responses[@current_response_index]
+        @current_response_index += 1
+        value
+      end
+    end
+
+    def matches?(request)
+      if !method_matches?(request) or !url_matches?(request)
+        return false
+      end
+
+      if body?
+        return false unless body_matches?(request)
+      end
+
+      if headers?
+        return false unless headers_match?(request)
+      end
+
+      true
+    end
+
+  private
+    def method_matches?(request)
+      self.method == :any or self.method == request.method
+    end
+
+    def url_matches?(request)
+      if url.kind_of?(String)
+        request_uri = URI.parse(request.url)
+        request_uri == self.uri
+      else
+        self.url =~ request.url
+      end
+    end
+
+    def body_matches?(request)
+      !request.body.nil? && !request.body.empty? && request.body == self.body
+    end
+
+    def headers_match?(request)
+      request_headers = Header.new(request.headers)
+
+      if empty_headers?(self.headers)
+        empty_headers?(request_headers)
+      else
+        return false if empty_headers?(request_headers)
+
+        headers.each do |key, value|
+          return false unless header_value_matches?(value, request_headers[key])
+        end
+
+        true
+      end
+    end
+
+    def header_value_matches?(mock_value, request_value)
+      mock_arr = mock_value.is_a?(Array) ? mock_value : [mock_value]
+      request_arr = request_value.is_a?(Array) ? request_value : [request_value]
+
+      return false unless mock_arr.size == request_arr.size
+      mock_arr.all? do |value|
+        request_arr.any? { |a| value === a }
+      end
+    end
+
+    def empty_headers?(headers)
+      # We consider the default User-Agent header to be empty since
+      # Typhoeus always adds that.
+      headers.nil? || headers.empty? || default_typhoeus_headers?(headers)
+    end
+
+    def default_typhoeus_headers?(headers)
+      headers.size == 1 && headers['User-Agent'] == Typhoeus::USER_AGENT
+    end
+  end
+end

data/lib/typhoeus/multi.rb

@@ -0,0 +1,146 @@
+module Typhoeus
+  class Multi
+    attr_reader :easy_handles
+
+    def initialize
+      Curl.init
+
+      @handle = Curl.multi_init
+      @active = 0
+      @running = 0
+      @easy_handles = []
+
+      @timeout = ::FFI::MemoryPointer.new(:long)
+      @timeval = Curl::Timeval.new
+      @fd_read = Curl::FDSet.new
+      @fd_write = Curl::FDSet.new
+      @fd_excep = Curl::FDSet.new
+      @max_fd = ::FFI::MemoryPointer.new(:int)
+
+      ObjectSpace.define_finalizer(self, self.class.finalizer(self))
+    end
+
+    def self.finalizer(multi)
+      proc { Curl.multi_cleanup(multi.handle) }
+    end
+
+    def add(easy)
+      raise "trying to add easy handle twice" if @easy_handles.include?(easy)
+      easy.set_headers() if easy.headers.empty?
+
+      code = Curl.multi_add_handle(@handle, easy.handle)
+      raise RuntimeError.new("An error occured adding the handle: #{code}: #{Curl.multi_strerror(code)}") if code != :call_multi_perform and code != :ok
+
+      do_perform if code == :call_multi_perform
+
+      @active += 1
+      @easy_handles << easy
+      easy
+    end
+
+    def remove(easy)
+      if @easy_handles.include?(easy)
+        @active -= 1
+        Curl.multi_remove_handle(@handle, easy.handle)
+        @easy_handles.delete(easy)
+      end
+    end
+
+    def perform
+      while @active > 0
+        run
+        while @running > 0
+          # get the curl-suggested timeout
+          code = Curl.multi_timeout(@handle, @timeout)
+          raise RuntimeError.new("an error occured getting the timeout: #{code}: #{Curl.multi_strerror(code)}") if code != :ok
+          timeout = @timeout.read_long
+          if timeout == 0 # no delay
+            run
+            next
+          elsif timeout < 0
+            timeout = 1
+          end
+
+          # load the fd sets from the multi handle
+          @fd_read.clear
+          @fd_write.clear
+          @fd_excep.clear
+          code = Curl.multi_fdset(@handle, @fd_read, @fd_write, @fd_excep, @max_fd)
+          raise RuntimeError.new("an error occured getting the fdset: #{code}: #{Curl.multi_strerror(code)}") if code != :ok
+
+          max_fd = @max_fd.read_int
+          if max_fd == -1
+            # curl is doing something special so let it run for a moment
+            sleep(0.001)
+          else
+            @timeval[:sec] = timeout / 1000
+            @timeval[:usec] = (timeout * 1000) % 1000000
+
+            code = Curl.select(max_fd + 1, @fd_read, @fd_write, @fd_excep, @timeval)
+            raise RuntimeError.new("error on thread select: #{::FFI.errno}") if code < 0
+          end
+
+          run
+        end
+      end
+      reset_easy_handles
+    end
+
+    def fire_and_forget
+      run
+    end
+
+    # check for finished easy handles and remove from the multi handle
+    def read_info
+      msgs_left = ::FFI::MemoryPointer.new(:int)
+      while not (msg = Curl.multi_info_read(@handle, msgs_left)).null?
+        next if msg[:code] != :done
+
+        easy = @easy_handles.find {|easy| easy.handle == msg[:easy_handle] }
+        next if not easy
+
+        response_code = ::FFI::MemoryPointer.new(:long)
+        response_code.write_long(-1)
+        Curl.easy_getinfo(easy.handle, :response_code, response_code)
+        response_code = response_code.read_long
+        remove(easy)
+
+        easy.curl_return_code = msg[:data][:code]
+        if easy.curl_return_code != 0 then easy.failure
+        elsif (200..299).member?(response_code) or response_code == 0 then easy.success
+        else easy.failure
+        end
+      end
+    end
+
+    def cleanup
+      Curl.multi_cleanup(@handle)
+      @active = 0
+      @running = 0
+      @easy_handles = []
+    end
+
+    def reset_easy_handles
+      @easy_handles.dup.each do |easy|
+        remove(easy)
+        yield easy if block_given?
+      end
+    end
+
+    private
+
+    # called by perform and fire_and_forget
+    def run
+      begin code = do_perform end while code == :call_multi_perform
+      raise RuntimeError.new("an error occured while running perform: #{code}: #{Curl.multi_strerror(code)}") if code != :ok
+      read_info
+    end
+
+    def do_perform
+      running = ::FFI::MemoryPointer.new(:int)
+      code = Curl.multi_perform(@handle, running)
+      @running = running.read_int
+      code
+    end
+  end
+end

data/lib/typhoeus/param_processor.rb

@@ -0,0 +1,43 @@
+require 'tempfile'
+
+module Typhoeus
+  class ParamProcessor
+    class << self
+      def traverse_params_hash(hash, result = nil, current_key = nil)
+        result ||= { :files => [], :params => [] }
+
+        hash.keys.sort { |a, b| a.to_s <=> b.to_s }.collect do |key|
+          new_key = (current_key ? "#{current_key}[#{key}]" : key).to_s
+          current_value = hash[key]
+          process_value current_value, :result => result, :new_key => new_key
+        end
+        result
+      end
+
+      def process_value(current_value, options)
+        result = options[:result]
+        new_key = options[:new_key]
+
+        case current_value
+        when Hash
+          traverse_params_hash(current_value, result, new_key)
+        when Array
+          current_value.each do |v|
+            result[:params] << [new_key, v.to_s]
+          end
+        when File, Tempfile
+          filename = File.basename(current_value.path)
+          types = MIME::Types.type_for(filename)
+          result[:files] << [
+            new_key,
+            filename,
+            types.empty? ? 'application/octet-stream' : types[0].to_s,
+            File.expand_path(current_value.path)
+          ]
+        else
+          result[:params] << [new_key, current_value.to_s]
+        end
+      end
+    end
+  end
+end