typhoeus 0.1.2

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,48 @@
+module Typhoeus
+  class RemoteProxyObject
+    instance_methods.each { |m| undef_method m unless m =~ /^__/ }
+    
+    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,
+                                  :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,88 @@
+module Typhoeus
+  class Request
+    attr_accessor :method, :params, :body, :headers, :timeout, :user_agent, :response, :cache_timeout
+    attr_reader   :url
+    
+    def initialize(url, options = {})
+      @method           = options[:method] || :get
+      @params           = options[:params]
+      @body             = options[:body]
+      @timeout          = options[:timeout]
+      @headers          = options[:headers] || {}
+      @user_agent       = options[:user_agent] || Typhoeus::USER_AGENT
+      @cache_timeout    = options[:cache_timeout]
+      @url              = @params ? "#{url}?#{params_string}" : url
+      @on_complete      = nil
+      @after_complete   = nil
+      @handled_response = nil
+    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 headers
+      @headers["User-Agent"] = @user_agent
+      @headers
+    end
+    
+    def params_string
+      params.keys.sort.collect do |k|
+        value = params[k]
+        if value.is_a? Hash
+          value.keys.collect {|sk| Rack::Utils.escape("#{k}[#{sk}]") + "=" + Rack::Utils.escape(value[sk].to_s)}
+        elsif value.is_a? Array
+          key = Rack::Utils.escape(k.to_s)
+          value.collect { |v| "#{key}=#{Rack::Utils.escape(v.to_s)}" }.join('&')
+        else
+          "#{Rack::Utils.escape(k.to_s)}=#{Rack::Utils.escape(params[k].to_s)}"
+        end
+      end.flatten.join("&")
+    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 cache_key
+      Digest::SHA1.hexdigest(url)
+    end
+  end
+end

data/lib/typhoeus/response.rb

@@ -0,0 +1,19 @@
+module Typhoeus
+  class Response
+    attr_accessor :request
+    attr_reader :code, :headers, :body, :time,
+                :requested_url, :requested_remote_method,
+                :requested_http_method, :start_time
+    
+    def initialize(params = {})
+      @code                  = params[:code]
+      @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]
+      @request               = params[:request]
+    end
+  end
+end

data/spec/servers/delay_fixture_server.rb

@@ -0,0 +1,66 @@
+# this server simply accepts requests and blocks for a passed in interval before returning a passed in reqeust value to
+# the client
+require 'rubygems'
+require 'eventmachine'
+require 'evma_httpserver'
+ 
+class DelayFixtureServer  < EventMachine::Connection
+  include EventMachine::HttpServer
+ 
+  def process_http_request
+    EventMachine.stop if ENV["PATH_INFO"] == "/die"
+    puts "got a request #{ENV['PATH_INFO']}"
+    resp = EventMachine::DelegatedHttpResponse.new( self )
+    
+    # Block which fulfills the request
+    operation = proc do
+      sleep DelayFixtureServer.response_delay
+
+      resp.status = 200
+      resp.content = "whatever"
+    end
+
+    # Callback block to execute once the request is fulfilled
+    callback = proc do |res|
+      resp.send_response
+    end
+
+    # Let the thread pool (20 Ruby threads) handle request
+    EM.defer(operation, callback)
+  end
+  
+  def self.response_fixture
+    @response_fixture ||= ""
+  end
+  
+  def self.response_fixture=(val)
+    @response_fixture = val
+  end
+
+  def self.response_delay
+    @response_delay ||= 0
+  end
+
+  def self.response_delay=(val)
+    @response_delay = val
+  end
+  
+  def self.reponse_number
+    @response_number
+  end
+  
+  def self.response_number=(val)
+    @response_number = val
+  end
+end
+
+port = (ARGV[0] || 3000).to_i
+
+DelayFixtureServer.response_delay   = 0.5
+DelayFixtureServer.response_number = 0
+#DelayFixtureServer.response_fixture = File.read(File.dirname(__FILE__) + "/../fixtures/result_set.xml")
+
+EventMachine::run {
+  EventMachine.epoll
+  EventMachine::start_server("0.0.0.0", port, DelayFixtureServer)
+}

data/spec/servers/method_server.rb

@@ -0,0 +1,51 @@
+# this server simply is for testing out the different http methods. it echoes back the passed in info
+require 'rubygems'
+require 'eventmachine'
+require 'evma_httpserver'
+ 
+class MethodServer  < EventMachine::Connection
+  include EventMachine::HttpServer
+ 
+  def process_http_request
+    EventMachine.stop if ENV["PATH_INFO"] == "/die"
+    
+    resp = EventMachine::DelegatedHttpResponse.new( self )
+    
+    # Block which fulfills the request
+    operation = proc do
+      sleep MethodServer.sleep_time
+      resp.status = 200
+      resp.content = request_params + "\n#{@http_post_content}"
+    end
+
+    # Callback block to execute once the request is fulfilled
+    callback = proc do |res|
+      resp.send_response
+    end
+
+    # Let the thread pool (20 Ruby threads) handle request
+    EM.defer(operation, callback)
+  end
+  
+  def request_params
+    %w( PATH_INFO QUERY_STRING HTTP_COOKIE IF_NONE_MATCH CONTENT_TYPE REQUEST_METHOD REQUEST_URI ).collect do |param|
+      "#{param}=#{ENV[param]}"
+    end.join("\n")
+  end
+  
+  def self.sleep_time=(val)
+    @sleep_time = val
+  end
+  
+  def self.sleep_time
+    @sleep_time || 0
+  end
+end
+# 
+# port = (ARGV[0] || 3000).to_i
+# #Process.fork do
+#   EventMachine::run {
+#     EventMachine.epoll
+#     EventMachine::start_server("0.0.0.0", port, MethodServer)
+#   }
+# #end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--diff
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+require "rubygems"
+require "spec"
+
+# gem install redgreen for colored test output
+begin require "redgreen" unless ENV['TM_CURRENT_LINE']; rescue LoadError; end
+
+path = File.expand_path(File.dirname(__FILE__) + "/../lib/")
+$LOAD_PATH.unshift(path) unless $LOAD_PATH.include?(path)
+
+require "lib/typhoeus"
+
+# local servers for running tests
+require File.dirname(__FILE__) + "/servers/method_server.rb"
+
+def start_method_server(port, sleep = 0)
+  MethodServer.sleep_time = sleep
+  pid = Process.fork do
+    EventMachine::run {
+      EventMachine.epoll
+      EventMachine::start_server("0.0.0.0", port, MethodServer)
+    }
+  end
+  sleep 0.2
+  pid
+end
+
+def stop_method_server(pid)
+  Process.kill("HUP", pid)
+end

data/spec/typhoeus/easy_spec.rb

@@ -0,0 +1,148 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Typhoeus::Easy do
+  before(:all) do
+    @pid = start_method_server(3002)
+  end
+  
+  after(:all) do
+    stop_method_server(@pid)
+  end
+  
+  describe "options" do
+    it "should allow for following redirects"
+    it "should allow you to set the user agent"
+    it "should provide a timeout in milliseconds" do
+      pid = start_method_server(3001, 5)
+      e = Typhoeus::Easy.new
+      e.url = "http://localhost:3001"
+      e.method = :get
+      e.timeout = 50
+      e.perform
+      puts e.response_code
+      puts e.total_time_taken
+#      e.timed_out?.should == true
+      stop_method_server(pid)
+    end
+  end
+  
+  describe "get" do
+    it "should perform a get" do
+      easy = Typhoeus::Easy.new
+      easy.url    = "http://localhost:3002"
+      easy.method = :get
+      easy.perform
+      easy.response_code.should == 200
+      easy.response_body.should include("REQUEST_METHOD=GET")
+    end
+    
+    it "should send a request body" do
+      easy = Typhoeus::Easy.new
+      easy.url    = "http://localhost:3002"
+      easy.method = :get
+      easy.request_body = "this is a body!"
+      easy.perform
+      easy.response_code.should == 200
+      easy.response_body.should include("this is a body!")
+    end
+  end
+
+  describe "start_time" do
+    it "should be get/settable" do
+      time = Time.now
+      easy = Typhoeus::Easy.new
+      easy.start_time.should be_nil
+      easy.start_time = time
+      easy.start_time.should == time
+    end
+  end
+
+  describe "params=" do
+    it "should handle arrays of params" do
+      easy = Typhoeus::Easy.new
+      easy.url = "http://localhost:3002/index.html"
+      easy.method = :get
+      easy.request_body = "this is a body!"
+      easy.params = {
+        :foo => 'bar',
+        :username => ['dbalatero', 'dbalatero2']
+      }
+      
+      easy.url.should =~ /\?.*username=dbalatero&username=dbalatero2/
+    end
+  end
+
+
+  describe "put" do
+    it "should perform a put" do
+      easy = Typhoeus::Easy.new
+      easy.url    = "http://localhost:3002"
+      easy.method = :put
+      easy.perform
+      easy.response_code.should == 200
+      easy.response_body.should include("REQUEST_METHOD=PUT")      
+    end
+    
+    it "should send a request body" do
+      easy = Typhoeus::Easy.new
+      easy.url    = "http://localhost:3002"
+      easy.method = :put
+      easy.request_body = "this is a body!"
+      easy.perform
+      easy.response_code.should == 200
+      easy.response_body.should include("this is a body!")
+    end
+  end
+  
+  describe "post" do
+    it "should perform a post" do
+      easy = Typhoeus::Easy.new
+      easy.url    = "http://localhost:3002"
+      easy.method = :post
+      easy.perform
+      easy.response_code.should == 200
+      easy.response_body.should include("REQUEST_METHOD=POST")      
+    end
+    
+    it "should send a request body" do
+      easy = Typhoeus::Easy.new
+      easy.url    = "http://localhost:3002"
+      easy.method = :post
+      easy.request_body = "this is a body!"
+      easy.perform
+      easy.response_code.should == 200
+      easy.response_body.should include("this is a body!")
+    end
+    
+    it "should handle params" do
+      easy = Typhoeus::Easy.new
+      easy.url    = "http://localhost:3002"
+      easy.method = :post
+      easy.params = {:foo => "bar"}
+      easy.perform
+      easy.response_code.should == 200
+      easy.response_body.should include("foo=bar")
+    end
+  end
+  
+  describe "delete" do
+    it "should perform a delete" do
+      easy = Typhoeus::Easy.new
+      easy.url    = "http://localhost:3002"
+      easy.method = :delete
+      easy.perform
+      easy.response_code.should == 200
+      easy.response_body.should include("REQUEST_METHOD=DELETE")
+    end
+    
+    it "should send a request body" do
+      easy = Typhoeus::Easy.new
+      easy.url    = "http://localhost:3002"
+      easy.method = :delete
+      easy.request_body = "this is a body!"
+      easy.perform
+      easy.response_code.should == 200
+      easy.response_body.should include("this is a body!")
+    end
+  end  
+end