typhoeus 0.5.0.rc → 0.5.0

data/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Changelog
 
-## 0.5.0.pre
+## 0.5.0
 
 [Full Changelog](http://github.com/typhoeus/typhoeus/compare/v0.4.2...master)
 
@@ -8,18 +8,13 @@ Major Changes:
 
 * Ethon integration
   * Params are url params and a body is always a body for every request type
-  * Request parameter and body are properly encoded (only POST multiform body is not)
-  * No more header sanitizing
-
-      Before: `:headers => { 'user_agent' => 'Custom' }` was modified to
-        `:headers => { 'User-Agent' => 'Custom' }`
-
   * The options you can set might have a slightly other names, as Ethon sticks to
     libcurl names. See
     [Easy.new](http://rubydoc.info/github/typhoeus/ethon/Ethon/Easy#initialize-instance_method)
     for a description.
-  * The following classes were deleted because they do not seemed to be uesed at all. If that
-    turns out to be wrong, they will be restored: `Typhoeus::Filter`, `Typhoeus::Remote`, `Typhoeus::RemoteMethod`, `Typhoeus::RemoteProxyObject`
+  * Request parameter and body are properly encoded (only POST multiform body is not)
+  * No more header sanitizing. Before: `:headers => { 'user_agent' => 'Custom' }` was modified to
+        `:headers => { 'User-Agent' => 'Custom' }`
   * `Typhoeus::Easy` and `Typhoeus::Multi` are now `Ethon::Easy` and `Ethon::Multi`
 
 * Request shortcuts: `Typhoeus.get("www.google.de")`
@@ -30,20 +25,23 @@ Typhoeus.configure do |config|
   config.memoize = true
 end
 ```
-* No more Response#headers_hash, instead response#header returning the last
+* No more `Response#headers_hash`, instead `Response#headers` returning the last
   header and response#redirections returning the responses with headers
   generated through redirections
 * Instead of defining the same callbacks on every request, you can define global callbacks:
-
 ```ruby
 Typhoeus.on_complete { p "yay" }
 ```
-
 * The stubbing interface changed slightly. You now have the same syntax as for requests:
-
 ```ruby
 Typhoeus.stub(url, options).and_return(response)
 ```
+* The following things were removed because they do not seemed to be used at all. Ping me if you disagree!
+  * `Typhoeus::Filter`
+  * `Typhoeus::Remote`
+  * `Typhoeus::RemoteMethod`
+  * `Typhoeus::RemoteProxyObject`
+  * build in cache interface
 
 Enhancements:
 

data/Gemfile

@@ -8,6 +8,7 @@ group :development, :test do
 
   gem "sinatra", "~> 1.3"
   gem "json"
+  gem "faraday", "~> 0.8.4"
 
   if RUBY_PLATFORM == "java"
     gem "spoon"
@@ -15,5 +16,6 @@ group :development, :test do
 
   unless ENV["CI"]
     gem "guard-rspec", "~> 0.7"
+    gem 'rb-fsevent', '~> 0.9.1'
   end
 end

data/README.md

@@ -7,20 +7,29 @@ Like a modern code version of the mythical beast with 100 serpent heads, Typhoeu
 Single request:
 
 ```ruby
-Typhoeus.get("www.example.com")
+Typhoeus.get("www.example.com", followlocation: true)
 ```
 
 Parallel requests:
 
 ```ruby
 hydra = Typhoeus::Hydra.new
-10.times.map{ hydra.queue(Typhoeus::Request.new("www.example.com")) }
+10.times.map{ hydra.queue(Typhoeus::Request.new("www.example.com", followlocation: true)) }
 hydra.run
 ```
 
+## Installation
+
+```
+gem install typhoeus --pre
+```
+```
+gem "typhoeus", git: "git://github.com/typhoeus/typhoeus.git"
+```
+
 ## Project Tracking
 
-* [Documentation](http://rubydoc.info/github/typhoeus/typhoeus) (github master)
+* [Documentation](http://rubydoc.info/github/typhoeus/typhoeus/frames/Typhoeus) (github master)
 * [Website](http://typhoeus.github.com/) (v0.4.2)
 * [Mailinglist](http://groups.google.com/group/typhoeus)
 

data/lib/typhoeus.rb

@@ -10,13 +10,23 @@ require 'typhoeus/response'
 require 'typhoeus/version'
 
 # Typhoeus is a http client library based on Ethon which
-# wraps libcurl.
+# wraps libcurl. Sitting on top of libcurl make Typhoeus
+# very reliable and fast.
+#
+# There are some gems using Typhoeus like
+# {https://github.com/myronmarston/vcr VCR},
+# {https://github.com/bblimke/webmock Webmock} or
+# {https://github.com/technoweenie/faraday Faraday}. VCR
+# and Webmock are providing their own adapter
+# whereas Faraday relies on {Faraday::Adapter::Typhoeus}
+# since Typhoeus version 0.5.
 #
 # @example (see Typhoeus::Request)
 # @example (see Typhoeus::Hydra)
 #
 # @see Typhoeus::Request
 # @see Typhoeus::Hydra
+# @see Faraday::Adapter::Typhoeus
 #
 # @since 0.5.0
 module Typhoeus

data/lib/typhoeus/adapters/faraday.rb

@@ -0,0 +1,136 @@
+require 'faraday'
+
+module Faraday # :nodoc:
+  class Adapter # :nodoc:
+
+    # Adapter to use Faraday with Typhoeus.
+    #
+    # @example Use Typhoeus.
+    #   require 'faraday'
+    #   require 'typhoeus'
+    #   require 'typhoeus/adapters/faraday'
+    #
+    #   conn = Faraday.new(url: "www.example.com") do |faraday|
+    #     faraday.adapter :typhoeus
+    #   end
+    #
+    #   response = conn.get("/")
+    class Typhoeus < Faraday::Adapter
+      self.supports_parallel = true
+
+      # Setup Hydra with provided options.
+      #
+      # @example Setup Hydra.
+      #   Faraday::Adapter::Typhoeus.setup_parallel_manager
+      #   #=> #<Typhoeus::Hydra ... >
+      #
+      # @param (see Typhoeus::Hydra#initialize)
+      # @option (see Typhoeus::Hydra#initialize)
+      #
+      # @return [ Typhoeus::Hydra ] The hydra.
+      def self.setup_parallel_manager(options = {})
+        ::Typhoeus::Hydra.new(options)
+      end
+
+      dependency 'typhoeus'
+
+      # Hook into Faraday and perform the request with Typhoeus.
+      #
+      # @param [ Hash ] env The environment.
+      #
+      # @return [ void ]
+      def call(env)
+        super
+        perform_request env
+        @app.call env
+      end
+
+      private
+
+      def perform_request(env)
+        if parallel?(env)
+          env[:parallel_manager].queue request(env)
+        else
+          request(env).run
+        end
+      end
+
+      def request(env)
+        read_body env
+
+        req = ::Typhoeus::Request.new(
+          env[:url].to_s,
+          :method  => env[:method],
+          :body    => env[:body],
+          :headers => env[:request_headers]
+        )
+
+        configure_ssl     req, env
+        configure_proxy   req, env
+        configure_timeout req, env
+        configure_socket  req, env
+
+        req.on_complete do |resp|
+          if resp.timed_out?
+            if parallel?(env)
+              # TODO: error callback in async mode
+            else
+              raise Faraday::Error::TimeoutError, "request timed out"
+            end
+          end
+
+          save_response(env, resp.code, resp.body) do |response_headers|
+            response_headers.parse resp.response_headers
+          end
+          # in async mode, :response is initialized at this point
+          env[:response].finish(env) if parallel?(env)
+        end
+
+        req
+      end
+
+      def read_body(env)
+        env[:body] = env[:body].read if env[:body].respond_to? :read
+      end
+
+      def configure_ssl(req, env)
+        ssl = env[:ssl]
+
+        ssl_verifyhost = (ssl && ssl.fetch(:verify, true)) ? 2 : 0
+        req.options[:ssl_verifyhost] = ssl_verifyhost
+        req.options[:sslversion] = ssl[:version]          if ssl[:version]
+        req.options[:sslcert]    = ssl[:client_cert_file] if ssl[:client_cert_file]
+        req.options[:sslkey]     = ssl[:client_key_file]  if ssl[:client_key_file]
+        req.options[:cainfo]     = ssl[:ca_file]          if ssl[:ca_file]
+        req.options[:capath]     = ssl[:ca_path]          if ssl[:ca_path]
+      end
+
+      def configure_proxy(req, env)
+        proxy = env[:request][:proxy]
+        return unless proxy
+
+        req.options[:proxy] = "#{proxy[:uri].host}:#{proxy[:uri].port}"
+
+        if proxy[:username] && proxy[:password]
+          req.options[:proxyuserpwd] = "#{proxy[:username]}:#{proxy[:password]}"
+        end
+      end
+
+      def configure_timeout(req, env)
+        env_req = env[:request]
+        req.options[:timeout_ms] = (env_req[:timeout] * 1000)             if env_req[:timeout]
+        req.options[:connecttimeout_ms] = (env_req[:open_timeout] * 1000) if env_req[:open_timeout]
+      end
+
+      def configure_socket(req, env)
+        if bind = env[:request][:bind]
+          req.options[:interface] = bind[:host]
+        end
+      end
+
+      def parallel?(env)
+        !!env[:parallel_manager]
+      end
+    end
+  end
+end

data/lib/typhoeus/hydra.rb

@@ -35,6 +35,9 @@ module Typhoeus
   #   requests = (0..9).map{ Typhoeus::Request.new("www.example.com") }
   #   requests.each{ |request| hydra.queue(request) }
   #   hydra.run
+  #
+  # @note Callbacks are going to delay the request
+  #   execution.
   class Hydra
     include Hydra::EasyPool
     include Hydra::Queueable
@@ -45,7 +48,7 @@ module Typhoeus
     include Hydra::Before
 
     # @example Set max_concurrency.
-    #   Typhoeus::Hydra.new(:max_concurrency => 20)
+    #   Typhoeus::Hydra.new(max_concurrency: 20)
     attr_reader :max_concurrency
 
     # @api private
@@ -75,7 +78,7 @@ module Typhoeus
     #   Typhoeus::Hydra.new
     #
     # @example Create a hydra with max_concurrency.
-    #   Typhoeus::Hydra.new(:max_concurrency => 20)
+    #   Typhoeus::Hydra.new(max_concurrency: 20)
     #
     # @param [ Hash ] options The options hash.
     #

data/lib/typhoeus/request.rb

@@ -67,26 +67,26 @@ module Typhoeus
     # @example Request with url parameters.
     #   response = Typhoeus::Request.new(
     #     "www.example.com",
-    #     :params => {:a => 1}
+    #     params: {a: 1}
     #   ).run
     #
     # @example Request with a body.
     #   response = Typhoeus::Request.new(
     #     "www.example.com",
-    #     :body => {:b => 2}
+    #     body: {b: 2}
     #   ).run
     #
     # @example Request with parameters and body.
     #   response = Typhoeus::Request.new(
     #     "www.example.com",
-    #     :params => {:a => 1},
-    #     :body => {:b => 2}
+    #     params: {a: 1},
+    #     body: {b: 2}
     #   ).run
     #
     # @example Create a request and allow follow redirections.
     #   response = Typhoeus::Request.new(
     #     "www.example.com",
-    #     :followlocation => true
+    #     followlocation: true
     #   ).run
     #
     # @param [ String ] url The url to request.
@@ -99,7 +99,7 @@ module Typhoeus
     #
     # @return [ Typhoeus::Request ] The request.
     #
-    # @note See {Ethon::Easy#initialize} for more options.
+    # @note See {http://rubydoc.info/github/typhoeus/ethon/Ethon/Easy#initialize-instance_method Ethon::Easy#initialize} for more options.
     #
     # @see Typhoeus::Hydra
     # @see Typhoeus::Response

data/lib/typhoeus/request/actions.rb

@@ -19,7 +19,7 @@ module Typhoeus
       #
       # @note (see Typhoeus::Request#initialize)
       def get(url, options = {})
-        Request.run(url, options.merge(:method => :get))
+        Request.new(url, options.merge(:method => :get)).run
       end
 
       # Make a post request.
@@ -35,7 +35,7 @@ module Typhoeus
       #
       # @note (see Typhoeus::Request#initialize)
       def post(url, options = {})
-        Request.run(url, options.merge(:method => :post))
+        Request.new(url, options.merge(:method => :post)).run
       end
 
       # Make a put request.
@@ -54,7 +54,7 @@ module Typhoeus
       #
       # @note (see Typhoeus::Request#initialize)
       def put(url, options = {})
-        Request.run(url, options.merge(:method => :put))
+        Request.new(url, options.merge(:method => :put)).run
       end
 
       # Make a delete request.
@@ -70,7 +70,7 @@ module Typhoeus
       #
       # @note (see Typhoeus::Request#initialize)
       def delete(url, options = {})
-        Request.run(url, options.merge(:method => :delete))
+        Request.new(url, options.merge(:method => :delete)).run
       end
 
       # Make a head request.
@@ -86,7 +86,7 @@ module Typhoeus
       #
       # @note (see Typhoeus::Request#initialize)
       def head(url, options = {})
-        Request.run(url, options.merge(:method => :head))
+        Request.new(url, options.merge(:method => :head)).run
       end
 
       # Make a patch request.
@@ -102,7 +102,7 @@ module Typhoeus
       #
       # @note (see Typhoeus::Request#initialize)
       def patch(url, options = {})
-        Request.run(url, options.merge(:method => :patch))
+        Request.new(url, options.merge(:method => :patch)).run
       end
 
       # Make a options request.
@@ -118,7 +118,7 @@ module Typhoeus
       #
       # @note (see Typhoeus::Request#initialize)
       def options(url, options = {})
-        Request.run(url, options.merge(:method => :options))
+        Request.new(url, options.merge(:method => :options)).run
       end
     end
   end

data/lib/typhoeus/request/block_connection.rb

@@ -42,9 +42,9 @@ module Typhoeus
       # @return [ Boolean ] True if blocked, false else.
       def blocked?
         if block_connection.nil?
-         Typhoeus::Config.block_connection
+          Typhoeus::Config.block_connection
         else
-         block_connection
+          block_connection
         end
       end
     end

data/lib/typhoeus/request/callbacks.rb

@@ -20,6 +20,10 @@ module Typhoeus
     #   request.on_complete.clear
     #   request.execute_callbacks
     #   #=> []
+    #
+    # @note If you're using the Hydra to execute multiple
+    #   requests, then callbacks are delaying the
+    #   request execution.
     module Callbacks
 
       module Types # :nodoc:

data/lib/typhoeus/request/operations.rb

@@ -5,29 +5,6 @@ module Typhoeus
     # 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.
@@ -36,11 +13,16 @@ module Typhoeus
       # @return [ Response ] The response.
       def run
         easy = Typhoeus.get_easy
-        easy.http_request(
-          url,
-          options.fetch(:method, :get),
-          options.reject{|k,_| k==:method}
-        )
+        begin
+          easy.http_request(
+            url,
+            options.fetch(:method, :get),
+            options.reject{|k,_| k==:method}
+          )
+        rescue Ethon::Errors::InvalidOption => e
+          help = provide_help(e.message.match(/:\s(\w+)/)[1])
+          raise $!, "#{$!}#{help}", $!.backtrace
+        end
         easy.prepare
         easy.perform
         finish(Response.new(easy.to_hash))
@@ -66,6 +48,39 @@ module Typhoeus
         execute_callbacks
         response
       end
+
+      private
+
+      def provide_help(option)
+        renamed = {
+          :connect_timeout => :connecttimeout,
+          :follow_location => :followlocation,
+          :max_redirects => :maxredirs,
+          :proxy_username => :proxyuserpwd,
+          :proxy_password => :proxyuserpwd,
+          :disable_ssl_peer_verification => :ssl_verifypeer,
+          :disable_ssl_host_verification => :ssl_verifyhost,
+          :ssl_cert => :sslcert,
+          :ssl_cert_type => :sslcerttype,
+          :ssl_key => :sslkey,
+          :ssl_key_type => :sslkeytype,
+          :ssl_key_password => :keypasswd,
+          :ssl_cacert => :cainfo,
+          :ssl_capath => :capath,
+          :ssl_version => :sslversion,
+          :username => :userpwd,
+          :password => :userpwd,
+          :auth_method => :httpauth,
+          :proxy_auth_method => :proxyauth,
+          :proxy_type => :proxytype
+        }
+        removed = [:cache_key_basis, :cache_timout, :user_agent]
+        if new_option = renamed[option.to_sym]
+          "\nPlease try #{new_option} instead of #{option}." if new_option
+        elsif removed.include?(option.to_sym)
+          "\nThe option #{option} was removed."
+        end
+      end
     end
   end
 end

data/lib/typhoeus/response.rb

@@ -14,7 +14,7 @@ module Typhoeus
     # @example Get request.
     #   request = Typhoeus::Request.get("www.example.com")
     #   response = request.run
-    #   response == request.response
+    #   request == response.request
     #   #=> true
     #
     # @return [ Typhoeus::Request ]
@@ -42,6 +42,9 @@ module Typhoeus
       @headers = options[:headers]
     end
 
+    # Returns wether this request is mocked
+    # or not.
+    #
     # @api private
     def mock
       defined?(@mock) ? @mock : options[:mock]

data/lib/typhoeus/response/header.rb

@@ -23,23 +23,26 @@ module Typhoeus
       #   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
+          next if header.empty? || header =~ /^HTTP\/1.[01]/
+          process_line(header)
         end
       end
 
       private
 
+      # Processes line and saves the result.
+      #
+      # @return [ void ]
+      def process_line(header)
+        key, value = header.split(':', 2).map(&:strip)
+        if self.has_key?(key)
+          self[key] = [self[key]] unless self[key].is_a? Array
+          self[key] << value
+        else
+          self[key] = value
+        end
+      end
+
       # Returns the raw header or empty string.
       #
       # @example Return raw header.

data/lib/typhoeus/response/status.rb

@@ -20,7 +20,7 @@ module Typhoeus
         # 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
@@ -73,7 +73,13 @@ module Typhoeus
 
       # :nodoc:
       def first_header_line
-        @first_header_line ||= response_headers.to_s.split("\n").first
+        @first_header_line ||= begin
+          if response_headers.to_s.include?("\r\n\r\n")
+            response_headers.to_s.split("\r\n\r\n").last.split("\r\n").first
+          else
+            response_headers.to_s.split("\r\n").first
+          end
+        end
       end
     end
   end

data/lib/typhoeus/version.rb

@@ -1,5 +1,5 @@
 module Typhoeus
 
   # The current Typhoeus version.
-  VERSION = '0.5.0.rc'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: typhoeus
 version: !ruby/object:Gem::Version
-  version: 0.5.0.rc
-  prerelease: 6
+  version: 0.5.0
+  prerelease: 
 platform: ruby
 authors:
 - David Balatero
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-06 00:00:00.000000000 Z
+date: 2012-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ethon
@@ -20,7 +20,7 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.5.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -28,7 +28,7 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.5.2
 description: Like a modern code version of the mythical beast with 100 serpent heads,
   Typhoeus runs HTTP requests in parallel while cleanly encapsulating handling logic.
 email:
@@ -37,6 +37,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/typhoeus/adapters/faraday.rb
 - lib/typhoeus/config.rb
 - lib/typhoeus/errors/no_stub.rb
 - lib/typhoeus/errors/typhoeus_error.rb
@@ -86,7 +87,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3871520876617813232
+      hash: -2522351330136258713
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: