zephyr 1.1.3 → 1.1.5

data/Gemfile

@@ -8,5 +8,5 @@ group :development do
   gem "bundler", "~> 1.0.0"
   gem "jeweler", "~> 1.6.4"
   gem "shoulda", "~> 2.11.3"
-end
-
+  gem "mocha",   "~> 0.12.0", :require => false
+end

data/Gemfile.lock

@@ -6,7 +6,10 @@ GEM
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
+    metaclass (0.0.1)
     mime-types (1.16)
+    mocha (0.12.0)
+      metaclass (~> 0.0.1)
     rake (0.9.2)
     shoulda (2.11.3)
     typhoeus (0.2.4)
@@ -20,6 +23,7 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.0.0)
   jeweler (~> 1.6.4)
+  mocha (~> 0.12.0)
   shoulda (~> 2.11.3)
   typhoeus (>= 0.2.4)
   yajl-ruby

data/VERSION

@@ -1 +1 @@
-1.1.3
+1.1.5

data/lib/ext/typhoeus_ext.rb

@@ -0,0 +1,16 @@
+module Typhoeus
+  module Utils
+    def escape(s)
+      Zephyr.percent_encode(s, s.bytesize)
+    end
+    module_function :escape
+  end
+end
+
+module Typhoeus
+  class Request
+    def params_string
+      Zephyr.build_query_string(params)
+    end
+  end
+end

data/lib/zephyr.rb

@@ -1,6 +1,7 @@
 require 'logger'
 require 'net/http'
 require 'typhoeus'
+require 'ext/typhoeus_ext'
 require 'yajl'
 
 # Stolen with a fair bit of modification from the riak-client gem, which is
@@ -58,7 +59,7 @@ class Zephyr
 
   class << self
     @debug_mode = false
-    
+
     def logger
       @@logger
     end
@@ -74,6 +75,30 @@ class Zephyr
     def debug_mode=(mode)
       @debug_mode = mode
     end
+
+    def percent_encode(value)
+      typhoeus_easy.send(:easy_escape, value.to_s, value.to_s.bytesize)
+    end
+
+    def build_query_string(params)
+      params.map do |k, v|
+        if v.kind_of? Array
+          build_query_string(v.map { |x| [k, x] })
+        else
+          "#{percent_encode(k)}=#{percent_encode(v)}"
+        end
+      end.sort.join '&'
+    end
+
+  private
+
+    # NOTE: This is here only because it provides a binding to
+    # Curb's 'easy_escape' function, which does what we want.
+    # Don't use it to perform requests. Ever.
+    #
+    def typhoeus_easy
+      @_typhoeus_easy ||= Typhoeus::Easy.new.freeze
+    end
   end
 
   @@logger = Logger.new(STDOUT)
@@ -218,20 +243,6 @@ class Zephyr
     Typheous::Hydra.hydra.cleanup
   end
 
-  def percent_encode(value)
-    typhoeus_easy.send(:easy_escape, value.to_s, value.to_s.bytesize)
-  end
-
-  private
-
-  # NOTE: This is here only because it provides a binding to
-  # Curb's 'easy_escape' function, which does what we want.
-  # Don't use it to perform requests. Ever.
-  #
-  def typhoeus_easy
-    @_typhoeus_easy ||= Typhoeus::Easy.new.freeze
-  end
-
   def verify_path_and_entity!(path_components, entity)
     begin
       verify_path!(path_components)
@@ -280,7 +291,7 @@ class Zephyr
     http_end   = Time.now.to_f
 
     Zephyr.logger.info "[zephyr:#{$$}:#{Time.now.to_f}] \"%s %s\" %s %0.4f" % [
-      method.to_s.upcase, uri(path_components).to_s, response.code, (http_end - http_start)
+      method.to_s.upcase, response.request.url, response.code, (http_end - http_start)
     ]
 
     # be consistent with what came before
@@ -298,7 +309,7 @@ class Zephyr
       result
     else
       failed_request = FailedRequest.new(:method        => method,
-                                         :uri           => uri(path_components),
+                                         :uri           => response.request.url,
                                          :expected_code => expect,
                                          :timeout       => timeout,
                                          :response      => response)

data/test/helper.rb

@@ -8,8 +8,8 @@ rescue Bundler::BundlerError => e
   exit e.status_code
 end
 require 'test/unit'
+require 'mocha'
 require 'shoulda'
-require 'typhoeus'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))

data/test/test_zephyr.rb

@@ -11,59 +11,56 @@ class TestZephyr < Test::Unit::TestCase
   end
 
   context "query string parameters" do
-    should "be sorted" do 
-      zephyr   = Zephyr.new
+    should "be sorted" do
       duples   = ('a'..'z').zip('A'..'Z') # [ [ 'a', 'A' ], [ 'b', 'B' ], ... ]
       expected = duples.map { |l,u| '%s=%s' % [ l, u ] }.sort.join('&')
 
-      assert_equal expected, zephyr.build_query_string(Hash[duples.shuffle])
+      assert_equal expected, Zephyr.build_query_string(Hash[duples.shuffle])
     end
 
     should "be constructed for arrays" do
       zephyr = Zephyr.new
-      assert_equal 'a=1&a=2', zephyr.build_query_string(:a => [ 2, 1 ])
+      assert_equal 'a=1&a=2', Zephyr.build_query_string(:a => [ 2, 1 ])
     end
   end
 
   context "percent encoding" do
     should "be correct" do
-      zephyr = Zephyr.new
-
       # RFC 3986 Reserved Characters
-      assert_equal '%21', zephyr.percent_encode('!')
-      assert_equal '%2A', zephyr.percent_encode('*')
-      assert_equal '%27', zephyr.percent_encode("'")
-      assert_equal '%28', zephyr.percent_encode('(')
-      assert_equal '%29', zephyr.percent_encode(')')
-      assert_equal '%3B', zephyr.percent_encode(';')
-      assert_equal '%3A', zephyr.percent_encode(':')
-      assert_equal '%40', zephyr.percent_encode('@')
-      assert_equal '%26', zephyr.percent_encode('&')
-      assert_equal '%3D', zephyr.percent_encode('=')
-      assert_equal '%2B', zephyr.percent_encode('+')
-      assert_equal '%24', zephyr.percent_encode('$')
-      assert_equal '%2C', zephyr.percent_encode(',')
-      assert_equal '%2F', zephyr.percent_encode('/')
-      assert_equal '%3F', zephyr.percent_encode('?')
-      assert_equal '%23', zephyr.percent_encode('#')
-      assert_equal '%5B', zephyr.percent_encode('[')
-      assert_equal '%5D', zephyr.percent_encode(']')
+      assert_equal '%21', Zephyr.percent_encode('!')
+      assert_equal '%2A', Zephyr.percent_encode('*')
+      assert_equal '%27', Zephyr.percent_encode("'")
+      assert_equal '%28', Zephyr.percent_encode('(')
+      assert_equal '%29', Zephyr.percent_encode(')')
+      assert_equal '%3B', Zephyr.percent_encode(';')
+      assert_equal '%3A', Zephyr.percent_encode(':')
+      assert_equal '%40', Zephyr.percent_encode('@')
+      assert_equal '%26', Zephyr.percent_encode('&')
+      assert_equal '%3D', Zephyr.percent_encode('=')
+      assert_equal '%2B', Zephyr.percent_encode('+')
+      assert_equal '%24', Zephyr.percent_encode('$')
+      assert_equal '%2C', Zephyr.percent_encode(',')
+      assert_equal '%2F', Zephyr.percent_encode('/')
+      assert_equal '%3F', Zephyr.percent_encode('?')
+      assert_equal '%23', Zephyr.percent_encode('#')
+      assert_equal '%5B', Zephyr.percent_encode('[')
+      assert_equal '%5D', Zephyr.percent_encode(']')
 
       # Common Percent Encodings
-      assert_equal '%3C', zephyr.percent_encode('<')
-      assert_equal '%3E', zephyr.percent_encode('>')
-      assert_equal '%22', zephyr.percent_encode('"')
-      assert_equal '%7B', zephyr.percent_encode('{')
-      assert_equal '%7D', zephyr.percent_encode('}')
-      assert_equal '%7C', zephyr.percent_encode('|')
-      assert_equal '%5C', zephyr.percent_encode('\\')
-      assert_equal '%60', zephyr.percent_encode('`')
-      assert_equal '%5E', zephyr.percent_encode('^')
-      assert_equal '%25', zephyr.percent_encode('%')
-      assert_equal '%20', zephyr.percent_encode(' ')
+      assert_equal '%3C', Zephyr.percent_encode('<')
+      assert_equal '%3E', Zephyr.percent_encode('>')
+      assert_equal '%22', Zephyr.percent_encode('"')
+      assert_equal '%7B', Zephyr.percent_encode('{')
+      assert_equal '%7D', Zephyr.percent_encode('}')
+      assert_equal '%7C', Zephyr.percent_encode('|')
+      assert_equal '%5C', Zephyr.percent_encode('\\')
+      assert_equal '%60', Zephyr.percent_encode('`')
+      assert_equal '%5E', Zephyr.percent_encode('^')
+      assert_equal '%25', Zephyr.percent_encode('%')
+      assert_equal '%20', Zephyr.percent_encode(' ')
 
       # Should test for \n as %0A or %0D or %0D%0A
-      assert_contains ['%0A', '%0D', '%0D%0A'], zephyr.percent_encode("\n")
+      assert_contains ['%0A', '%0D', '%0D%0A'], Zephyr.percent_encode("\n")
 
       # Should figure out why the will not be percent encoded by libcurl
       #assert_equal '%2E', zephyr.percent_encode('.')
@@ -72,7 +69,21 @@ class TestZephyr < Test::Unit::TestCase
       #assert_equal '%7E', zephyr.percent_encode('~')
 
       # Fancy
-      assert_equal '%E3%81%BE%E3%81%A4%E3%82%82%E3%81%A8', zephyr.percent_encode('まつもと')
+      assert_equal '%E3%81%BE%E3%81%A4%E3%82%82%E3%81%A8', Zephyr.percent_encode('まつもと')
+    end
+  end
+
+  context "using Typhoeus extensions" do
+    should "use Zephyr for escaping" do
+      z = Zephyr.new("http://www.google.com")
+      Zephyr.expects(:percent_encode).times(4)
+      z.get(200, 1000, [{:query => ["test string", "again"]}])
+    end
+
+    should "use Zephyr for building query string" do
+      z = Zephyr.new("http://www.google.com")
+      Zephyr.expects(:build_query_string).times(1)
+      z.get(200, 1000, [{:query => ["test string", "again"]}])
     end
   end
 end

data/zephyr.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "zephyr"
-  s.version = "1.1.3"
+  s.version = "1.1.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Matt Knopp"]
-  s.date = "2012-07-05"
+  s.date = "2012-07-06"
   s.description = "Simple HTTP client using Typheous, derived from the Riak client"
   s.email = "matt.knopp@gmail.com"
   s.extra_rdoc_files = [
@@ -26,6 +26,7 @@ Gem::Specification.new do |s|
     "VERSION",
     "lib/zephyr.rb",
     "lib/zephyr/failed_request.rb",
+    "lib/ext/typhoeus_ext.rb",
     "test/helper.rb",
     "test/test_zephyr.rb",
     "zephyr.gemspec"
@@ -45,6 +46,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
       s.add_development_dependency(%q<shoulda>, ["~> 2.11.3"])
+      s.add_development_dependency(%q<mocha>, ["~> 0.12.0"])
     else
       s.add_dependency(%q<typhoeus>, [">= 0.2.4"])
       s.add_dependency(%q<yajl-ruby>, [">= 0"])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zephyr
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.1.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-05 00:00:00.000000000 Z
+date: 2012-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -91,6 +91,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.11.3
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.12.0
 description: Simple HTTP client using Typheous, derived from the Riak client
 email: matt.knopp@gmail.com
 executables: []
@@ -108,6 +124,7 @@ files:
 - VERSION
 - lib/zephyr.rb
 - lib/zephyr/failed_request.rb
+- lib/ext/typhoeus_ext.rb
 - test/helper.rb
 - test/test_zephyr.rb
 - zephyr.gemspec
@@ -132,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Simple HTTP client using Typheous, derived from the Riak client