typhoeus 0.6.7 → 0.6.8

data/CHANGELOG.md

@@ -1,8 +1,34 @@
 # Changelog
 
-## Master
+## 0.6.8
 
-[Full Changelog](http://github.com/typhoeus/typhoeus/compare/v0.6.6...master)
+[Full Changelog](http://github.com/typhoeus/typhoeus/compare/v0.6.7...v0.6.8)
+
+Bugfixes:
+
+* Fix Faraday 0.9 compatibility.
+  ([Gleb Mazovetskiy](https://github.com/glebm), [\#357](https://github.com/typhoeus/typhoeus/pull/357)
+* Fix Request#hash for different key orders.
+  ([Matthew Schulkind](https://github.com/mschulkind), [\#344](https://github.com/typhoeus/typhoeus/pull/344))
+
+Enhancements:
+
+* Use SVG for status badges in README.
+  7[Sean Linsley](https://github.com/seanlinsley), [\#353](https://github.com/typhoeus/typhoeus/pull/353))
+* Missing quotes in README example code.
+  ([Jason R. Clark](https://github.com/jasonrclark), [\#351](https://github.com/typhoeus/typhoeus/pull/351))
+* Specs for Faraday adapter.
+  ([michaelavila](https://github.com/michaelavila), [\#348](https://github.com/typhoeus/typhoeus/pull/348))
+* Clarify wording in README.
+  ([Sean Linsley](https://github.com/seanlinsley), [\#347](https://github.com/typhoeus/typhoeus/pull/347))
+* Make caching easier for non-memory caches.
+  ([Matthew Schulkind](https://github.com/mschulkind), [\#345](https://github.com/typhoeus/typhoeus/pull/345))
+* Spec refactoring.
+  ([Matthew Schulkind](https://github.com/mschulkind), [\#343](https://github.com/typhoeus/typhoeus/pull/343))
+
+## 0.6.7
+
+[Full Changelog](http://github.com/typhoeus/typhoeus/compare/v0.6.6...v0.6.7)
 
 Enhancements:
 

data/Gemfile

@@ -8,7 +8,7 @@ group :development, :test do
 
   gem "sinatra", "~> 1.3"
   gem "json"
-  gem "faraday", "~> 0.8.4"
+  gem "faraday", ">= 0.9"
 
   if RUBY_PLATFORM == "java"
     gem "spoon"

data/LICENSE

@@ -1,6 +1,6 @@
 Copyright (c) 2009-2010 Paul Dix
 Copyright (c) 2011 David Balatero
-Copyright (c) 2012 Hans Hasselberg
+Copyright (c) 2012-2014 Hans Hasselberg
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,4 +1,4 @@
-# Typhoeus [![Build Status](https://secure.travis-ci.org/typhoeus/typhoeus.png)](http://travis-ci.org/typhoeus/typhoeus) [![Code Climate](https://codeclimate.com/github/typhoeus/typhoeus.png)](https://codeclimate.com/github/typhoeus/typhoeus) [![Gem Version](https://badge.fury.io/rb/typhoeus.png)](http://badge.fury.io/rb/typhoeus)
+# Typhoeus [![Build Status](https://img.shields.io/travis/typhoeus/typhoeus/master.svg)](https://travis-ci.org/typhoeus/typhoeus) [![Code Climate](https://img.shields.io/codeclimate/github/typhoeus/typhoeus.svg)](https://codeclimate.com/github/typhoeus/typhoeus) [![Gem Version](https://img.shields.io/gem/v/typhoeus.svg)](https://rubygems.org/gems/typhoeus)
 
 Like a modern code version of the mythical beast with 100 serpent heads, Typhoeus runs HTTP requests in parallel while cleanly encapsulating handling logic.
 
@@ -50,7 +50,7 @@ request = Typhoeus::Request.new(
 ```
 
 We can see from this that the first argument is the url. The second is a set of options.
-The options are all optional. The default for `:method` is `:get`. 
+The options are all optional. The default for `:method` is `:get`.
 
 When you want to send URL parameters, you can use `:params` hash to do so. Please note that in case of you should send a request via `x-www-form-urlencoded` parameters, you need to use `:body` hash instead. `params` are for URL parameters and `:body` is for the request body.
 
@@ -172,7 +172,7 @@ hydra = Typhoeus::Hydra.hydra
 
 first_request = Typhoeus::Request.new("www.example.com/posts/1.json")
 first_request.on_complete do |response|
-  third_request = Typhoeus::Request.new(www.example.com/posts/3.json)
+  third_request = Typhoeus::Request.new("www.example.com/posts/3.json")
   hydra.queue third_request
 end
 second_request = Typhoeus::Request.new("www.example.com/posts/2.json")
@@ -208,7 +208,7 @@ end
 hydra.run
 ```
 
-This will result in a two requests.
+This will result in two requests.
 
 ```ruby
 Typhoeus::Config.memoize = false
@@ -226,27 +226,63 @@ Typhoeus includes built in support for caching. In the following example, if the
 
 ```ruby
 class Cache
-  attr_accessor :memory
-
   def initialize
     @memory = {}
   end
 
   def get(request)
-    memory[request]
+    @memory[request]
   end
 
   def set(request, response)
-    memory[request] = response
+    @memory[request] = response
   end
 end
 
 Typhoeus::Config.cache = Cache.new
 
-Typhoeus.get("www.example.com") == Typhoeus.get("www.example.com")
+Typhoeus.get("www.example.com").cached?
+#=> false
+Typhoeus.get("www.example.com").cached?
 #=> true
 ```
 
+For use with [Dalli](https://github.com/mperham/dalli):
+
+```ruby
+class Cache
+  def initialize
+    @client = Dalli::Client.new
+  end
+
+  def get(request)
+    @client.get(request.cache_key)
+  end
+
+  def set(request, response)
+    @client.set(request.cache_key, response)
+  end
+end
+
+Typhoeus::Config.cache = Cache.new
+```
+
+For use with Rails:
+
+```ruby
+class Cache
+  def get(request)
+    Rails.cache.read(request)
+  end
+
+  def set(request, response)
+    Rails.cache.write(request, response)
+  end
+end
+
+Typhoeus::Config.cache = Cache.new
+```
+
 ### Direct Stubbing
 
 Hydra allows you to stub out specific urls and patterns to avoid hitting
@@ -288,10 +324,10 @@ No exceptions are raised on HTTP timeouts. You can check whether a request timed
 Typhoeus.get("www.example.com").timed_out?
 ```
 
-There are two different timeouts available: [`timeout`](http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTTIMEOUT) 
+There are two different timeouts available: [`timeout`](http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTTIMEOUT)
 and [`connecttimeout`](http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTCONNECTTIMEOUT). `timeout` is the
-maximum time in seconds that you allow the libcurl transfer operation to take and `connecttimeout` is the maximum 
-time in seconds that you allow the connection to the server to take. These two are always available, while `timeout_ms` ond 
+maximum time in seconds that you allow the libcurl transfer operation to take and `connecttimeout` is the maximum
+time in seconds that you allow the connection to the server to take. These two are always available, while `timeout_ms` ond
 `connecttimeout_ms` accept milliseconds but only an option when curl is build with `c-ares`, it will use `timout` or `connecttimeout` otherwise.
 
 ### Following Redirections
@@ -314,8 +350,8 @@ Typhoeus::Request.get("www.example.com", userpwd: "user:password")
 Typhoeus::Request.get("www.example.com", cookiefile: "/path/to/file", cookiejar: "/path/to/file")
 ```
 
-Here, `cookiefile` is a file to read cookies to send from, and `cookiejar` is a file to write received cookies to.
-So, if you just want cookies enabled, you need to pass in a same filename in both options.
+Here, `cookiefile` is a file to read cookies from, and `cookiejar` is a file to write received cookies to.
+If you just want cookies enabled, you need to pass the same filename for both options.
 
 ### Other CURL options
 
@@ -352,13 +388,13 @@ Typhoeus.get("https://www.example.com", ssl_verifyhost: 2)
 
 ### Verbose debug output
 
-Sometime it’s useful to see verbose output from curl. You may now enable it on a per request basis:
+It’s sometimes useful to see verbose output from curl. You can enable it on a per-request basis:
 
 ```ruby
 Typhoeus.get("http://example.com", verbose: true)
 ```
 
-or global:
+or globally:
 
 ```ruby
 Typhoeus::Config.verbose = true
@@ -384,7 +420,7 @@ Copyright © 2009-2010 [Paul Dix](http://www.pauldix.net/)
 
 Copyright © 2011-2012 [David Balatero](https://github.com/dbalatero/)
 
-Copyright © 2012-2013 [Hans Hasselberg](http://github.com/i0rek/)
+Copyright © 2012-2014 [Hans Hasselberg](http://github.com/i0rek/)
 
 Permission is hereby granted, free of charge, to any person obtaining a
 copy of this software and associated documentation files (the "Software"),

data/lib/typhoeus/adapters/faraday.rb

@@ -120,7 +120,8 @@ module Faraday # :nodoc:
         req.options[:sslkey]     = ssl[:client_key]  if ssl[:client_key]
         req.options[:cainfo]     = ssl[:ca_file]     if ssl[:ca_file]
         req.options[:capath]     = ssl[:ca_path]     if ssl[:ca_path]
-        req.options[:keypasswd]  = ssl[:client_cert_passwd] if ssl[:client_cert_passwd]
+        client_cert_passwd_key   = [:client_cert_passwd, :client_certificate_password].detect { |name| ssl.key?(name) }
+        req.options[:keypasswd]  = ssl[client_cert_passwd_key] if client_cert_passwd_key
       end
 
       def configure_proxy(req, env)

data/lib/typhoeus/request.rb

@@ -154,7 +154,15 @@ module Typhoeus
     #
     # @api private
     def hash
-      Zlib.crc32 "#{self.class.name}#{base_url}#{options}"
+      Zlib.crc32 cache_key
+    end
+
+    # Returns a cache key for use with caching methods that required a string
+    # for a key. Will get used by ActiveSupport::Cache stores automatically.
+    #
+    # @return [ String ] The cache key.
+    def cache_key
+      "#{self.class.name}#{base_url}#{hashable_string_for(options)}"
     end
 
     # Mimics libcurls POST body generation. This is not accurate, but good
@@ -187,6 +195,17 @@ module Typhoeus
       end
     end
 
+    def hashable_string_for(obj)
+      case obj
+      when Hash
+        hashable_string_for(obj.sort_by {|sub_obj| sub_obj.first.to_s})
+      when Array
+        obj.map {|sub_obj| hashable_string_for(sub_obj)}.to_s
+      else
+        obj.to_s
+      end
+    end
+
     # Sets default header and verbose when turned on.
     def set_defaults
       if @options[:headers]

data/lib/typhoeus/version.rb

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

data/spec/spec_helper.rb

@@ -6,13 +6,7 @@ Bundler.setup
 require "typhoeus"
 require "rspec"
 
-if defined? require_relative
-  require_relative 'support/localhost_server.rb'
-  require_relative 'support/server.rb'
-else
-  require 'support/localhost_server.rb'
-  require 'support/server.rb'
-end
+Dir[File.join(File.dirname(__FILE__), "support/**/*.rb")].each { |f| require f }
 
 RSpec.configure do |config|
   config.order = :rand

data/spec/support/memory_cache.rb

@@ -0,0 +1,15 @@
+class MemoryCache
+  attr_reader :memory
+
+  def initialize
+    @memory = {}
+  end
+
+  def get(request)
+    memory[request]
+  end
+
+  def set(request, response)
+    memory[request] = response
+  end
+end

data/spec/typhoeus/adapters/faraday_spec.rb

@@ -224,6 +224,30 @@ describe Faraday::Adapter::Typhoeus do
       end
     end
 
+    context "when client_cert_passwd" do
+      let(:env) { { :ssl => { :client_cert_passwd => "a" } } }
+
+      it "sets keypasswd to the value of client_cert_passwd" do
+        expect(request.options[:keypasswd]).to eq("a")
+      end
+    end
+
+    context "when client_certificate_password" do
+      let(:env) { { :ssl => { :client_certificate_password => "a" } } }
+
+      it "sets keypasswd to the value of client_cert_passwd" do
+        expect(request.options[:keypasswd]).to eq("a")
+      end
+    end
+
+    context "when no client_cert_passwd" do
+      let(:env) { { :ssl => { } } }
+
+      it "does not set keypasswd on options" do
+        expect(request.options).not_to have_key :keypasswd
+      end
+    end
+
     context "when verify is false" do
       let(:env) { { :ssl => { :verify => false } } }
 

data/spec/typhoeus/hydra/cacheable_spec.rb

@@ -4,23 +4,7 @@ describe Typhoeus::Hydra::Cacheable do
   let(:base_url) { "localhost:3001" }
   let(:hydra) { Typhoeus::Hydra.new() }
   let(:request) { Typhoeus::Request.new(base_url, {:method => :get}) }
-  let(:cache) {
-    Class.new do
-      attr_reader :memory
-
-      def initialize
-        @memory = {}
-      end
-
-      def get(request)
-        memory[request]
-      end
-
-      def set(request, response)
-        memory[request] = response
-      end
-    end.new
-  }
+  let(:cache) { MemoryCache.new }
 
   describe "add" do
     context "when cache activated" do

data/spec/typhoeus/request/cacheable_spec.rb

@@ -1,23 +1,7 @@
 require 'spec_helper'
 
 describe Typhoeus::Request::Cacheable do
-  let(:cache) {
-    Class.new do
-      attr_reader :memory
-
-      def initialize
-        @memory = {}
-      end
-
-      def get(request)
-        memory[request]
-      end
-
-      def set(request, response)
-        memory[request] = response
-      end
-    end.new
-  }
+  let(:cache) { MemoryCache.new }
   let(:options) { {} }
   let(:request) { Typhoeus::Request.new("http://localhost:3001", options) }
   let(:response) { Typhoeus::Response.new }
@@ -27,7 +11,7 @@ describe Typhoeus::Request::Cacheable do
 
   describe "#response=" do
     context "when cache activated" do
-      context "when nequest new" do
+      context "when request new" do
         it "caches response" do
           request.response = response
           expect(cache.memory[request]).to be
@@ -57,9 +41,6 @@ describe Typhoeus::Request::Cacheable do
 
   describe "#run" do
     context "when cache activated" do
-      before { Typhoeus::Config.cache = cache }
-      after { Typhoeus::Config.cache = false }
-
       context "when request new" do
         it "fetches response" do
           expect(request.response).to_not be(response)
@@ -67,7 +48,6 @@ describe Typhoeus::Request::Cacheable do
       end
 
       context "when request in memory" do
-        let(:response) { Typhoeus::Response.new }
         before { cache.memory[request] = response }
 
         it "finishes request" do

data/spec/typhoeus/request_spec.rb

@@ -143,15 +143,37 @@ describe Typhoeus::Request do
 
   describe "#hash" do
     context "when request.eql?(other)" do
-      let(:other) { Typhoeus::Request.new(base_url, options) }
+      context "when different order" do
+        let(:other_options) {
+          {:headers => { 'User-Agent' => "Fubar" }, :verbose => true }
+        }
+        let(:other) { Typhoeus::Request.new(base_url, other_options)}
+
+        it "has same hashes" do
+          expect(request.hash).to eq(other.hash)
+        end
+      end
 
-      it "has same hashes" do
-        expect(request.hash).to eq(other.hash)
+      context "when same order" do
+        let(:other) { Typhoeus::Request.new(base_url, options) }
+
+        it "has same hashes" do
+          expect(request.hash).to eq(other.hash)
+        end
+      end
+
+      context "when hashes with different orders are contained in arrays" do
+        let(:request) { Typhoeus::Request.new(base_url, :params => [{:b => 2, :a => 1}]) }
+        let(:other) { Typhoeus::Request.new(base_url, :params => [{:a => 1, :b => 2}]) }
+        it "has different hashes" do
+          expect(request.hash).to eq(other.hash)
+        end
       end
     end
 
     context "when not request.eql?(other)" do
-      let(:other) { Typhoeus::Request.new("base_url", {}) }
+      let(:request) { Typhoeus::Request.new(base_url, :params => {:foo => 'bar'}) }
+      let(:other) { Typhoeus::Request.new(base_url, :params => {:foo => 'baz'}) }
 
       it "has different hashes" do
         expect(request.hash).to_not eq(other.hash)

data/typhoeus.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = ">= 1.3.6"
   s.license = 'MIT'
 
-  s.add_dependency('ethon', ["~> 0.6.2"])
+  s.add_dependency('ethon', [">= 0.7.0"])
 
   s.files        = `git ls-files`.split("\n")
   s.test_files   = `git ls-files -- spec/*`.split("\n")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: typhoeus
 version: !ruby/object:Gem::Version
-  version: 0.6.7
+  version: 0.6.8
   prerelease: 
 platform: ruby
 authors:
@@ -11,24 +11,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-19 00:00:00.000000000 Z
+date: 2014-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ethon
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: 0.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: 0.7.0
 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:
@@ -94,6 +94,7 @@ files:
 - spec/rack/typhoeus/middleware/params_decoder_spec.rb
 - spec/spec_helper.rb
 - spec/support/localhost_server.rb
+- spec/support/memory_cache.rb
 - spec/support/server.rb
 - spec/typhoeus/adapters/faraday_spec.rb
 - spec/typhoeus/config_spec.rb
@@ -142,7 +143,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1737493821567630899
+      hash: 1782230934011170024
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -160,6 +161,7 @@ test_files:
 - spec/rack/typhoeus/middleware/params_decoder_spec.rb
 - spec/spec_helper.rb
 - spec/support/localhost_server.rb
+- spec/support/memory_cache.rb
 - spec/support/server.rb
 - spec/typhoeus/adapters/faraday_spec.rb
 - spec/typhoeus/config_spec.rb