kookaburra 1.0.0 → 1.1.0

data/README.markdown

@@ -5,7 +5,7 @@ order to keep acceptance tests maintainable.
 
 ## Requirements ##
 
-Requires Ruby 1.9. Tested with both MRI and JRUBY (not that you must run
+Requires Ruby 1.9. Tested with both MRI and JRuby (note that you must run
 JRuby in 1.9 compatability mode.)
 
 ## Installation ##

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

data/kookaburra.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "kookaburra"
-  s.version = "1.0.0"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Wilger", "Sam Livingston-Gray", "Ravi Gadad"]
-  s.date = "2012-10-14"
+  s.date = "2012-12-14"
   s.description = "Cucumber + Capybara = Kookaburra? It made sense at the time."
   s.email = "johnwilger@gmail.com"
   s.extra_rdoc_files = [
@@ -28,6 +28,8 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "kookaburra.gemspec",
+    "lib/core_ext/object/to_param.rb",
+    "lib/core_ext/object/to_query.rb",
     "lib/kookaburra.rb",
     "lib/kookaburra/api_driver.rb",
     "lib/kookaburra/assertion.rb",

data/lib/core_ext/object/to_param.rb

@@ -0,0 +1,81 @@
+# If ActiveSupport is available, use the #to_param method it provides,
+# otherwise, use our own. The code is taken from ActiveSupport 3.2.8.
+begin
+  require 'active_support/core_ext/object/to_param'
+rescue LoadError
+  # Copyright (c) 2005-2012 David Heinemeier Hansson
+  # 
+  # Permission is hereby granted, free of charge, to any person obtaining
+  # a copy of this software and associated documentation files (the
+  # "Software"), to deal in the Software without restriction, including
+  # without limitation the rights to use, copy, modify, merge, publish,
+  # distribute, sublicense, and/or sell copies of the Software, and to
+  # permit persons to whom the Software is furnished to do so, subject to
+  # the following conditions:
+  # 
+  # The above copyright notice and this permission notice shall be
+  # included in all copies or substantial portions of the Software.
+  # 
+  # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+  # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+  # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+  # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+  # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+  # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+  # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+  class Object
+    # Alias of <tt>to_s</tt>.
+    def to_param
+      to_s
+    end
+  end
+
+  class NilClass
+    def to_param
+      self
+    end
+  end
+
+  class TrueClass
+    def to_param
+      self
+    end
+  end
+
+  class FalseClass
+    def to_param
+      self
+    end
+  end
+
+  class Array
+    # Calls <tt>to_param</tt> on all its elements and joins the result with
+    # slashes. This is used by <tt>url_for</tt> in Action Pack.
+    def to_param
+      collect { |e| e.to_param }.join '/'
+    end
+  end
+
+  class Hash
+    # Returns a string representation of the receiver suitable for use as a URL
+    # query string:
+    #
+    #   {:name => 'David', :nationality => 'Danish'}.to_param
+    #   # => "name=David&nationality=Danish"
+    #
+    # An optional namespace can be passed to enclose the param names:
+    #
+    #   {:name => 'David', :nationality => 'Danish'}.to_param('user')
+    #   # => "user[name]=David&user[nationality]=Danish"
+    #
+    # The string pairs "key=value" that conform the query string
+    # are sorted lexicographically in ascending order.
+    #
+    # This method is also aliased as +to_query+.
+    def to_param(namespace = nil)
+      collect do |key, value|
+        value.to_query(namespace ? "#{namespace}[#{key}]" : key)
+      end.sort * '&'
+    end
+  end
+end

data/lib/core_ext/object/to_query.rb

@@ -0,0 +1,53 @@
+# If ActiveSupport is available, use the #to_query method it provides,
+# otherwise, use our own. The code is taken from ActiveSupport 3.2.8.
+begin
+  require 'active_support/core_ext/object/to_query'
+rescue LoadError
+  # Copyright (c) 2005-2012 David Heinemeier Hansson
+  #
+  # Permission is hereby granted, free of charge, to any person obtaining
+  # a copy of this software and associated documentation files (the
+  # "Software"), to deal in the Software without restriction, including
+  # without limitation the rights to use, copy, modify, merge, publish,
+  # distribute, sublicense, and/or sell copies of the Software, and to
+  # permit persons to whom the Software is furnished to do so, subject to
+  # the following conditions:
+  #
+  # The above copyright notice and this permission notice shall be
+  # included in all copies or substantial portions of the Software.
+  #
+  # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+  # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+  # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+  # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+  # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+  # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+  # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+  require 'core_ext/object/to_param'
+
+  class Object
+    # Converts an object into a string suitable for use as a URL query string, using the given <tt>key</tt> as the
+    # param name.
+    #
+    # Note: This method is defined as a default implementation for all Objects for Hash#to_query to work.
+    def to_query(key)
+      require 'cgi' unless defined?(CGI) && defined?(CGI::escape)
+      "#{CGI.escape(key.to_param)}=#{CGI.escape(to_param.to_s)}"
+    end
+  end
+
+  class Array
+    # Converts an array into a string suitable for use as a URL query string,
+    # using the given +key+ as the param name.
+    #
+    #   ['Rails', 'coding'].to_query('hobbies') # => "hobbies%5B%5D=Rails&hobbies%5B%5D=coding"
+    def to_query(key)
+      prefix = "#{key}[]"
+      collect { |value| value.to_query(prefix) }.join '&'
+    end
+  end
+
+  class Hash
+    alias_method :to_query, :to_param
+  end
+end

data/lib/kookaburra/api_driver.rb

@@ -1,4 +1,5 @@
 require 'restclient'
+require 'core_ext/object/to_query'
 require 'kookaburra/exceptions'
 
 class Kookaburra
@@ -99,29 +100,31 @@ class Kookaburra
     # Convenience method to make a POST request
     #
     # @see APIDriver#request
-    def post(path, data)
-      request(:post, path, data)
+    def post(path, data = nil, headers = {})
+      request(:post, path, data, headers)
     end
 
     # Convenience method to make a PUT request
     #
     # @see APIDriver#request
-    def put(path, data)
-      request(:put, path, data)
+    def put(path, data = nil, headers = {})
+      request(:put, path, data, headers)
     end
 
     # Convenience method to make a GET request
     #
     # @see APIDriver#request
-    def get(path)
-      request(:get, path)
+    def get(path, data = nil, headers = {})
+      path = add_querystring_to_path(path, data)
+      request(:get, path, nil, headers)
     end
 
     # Convenience method to make a DELETE request
     #
     # @see APIDriver#request
-    def delete(path)
-      request(:delete, path)
+    def delete(path, data = nil, headers = {})
+      path = add_querystring_to_path(path, data)
+      request(:delete, path, nil, headers)
     end
 
     # Make an HTTP request
@@ -161,8 +164,9 @@ class Kookaburra
     #
     # @raise [Kookaburra::UnexpectedResponse] Raised if the HTTP
     #        response received is not in the 2XX-3XX range.
-    def request(method, path, data = nil)
+    def request(method, path, data, headers)
       data = encode(data)
+      headers = global_headers.merge(headers)
       response = @http_client.send(method, url_for(path), *[data, headers].compact)
       decode(response.body)
     rescue RestClient::Exception => e
@@ -171,7 +175,12 @@ class Kookaburra
 
     private
 
-    def headers
+    def add_querystring_to_path(path, data)
+      return path if data.nil? || data == {}
+      "#{path}?#{data.to_query}"
+    end
+
+    def global_headers
       self.class.headers
     end
 

data/spec/kookaburra/api_driver_spec.rb

@@ -13,90 +13,153 @@ describe Kookaburra::APIDriver do
 
   let(:client) { stub('RestClient') }
 
-  it 'sends POST requests to the server and returns the response body' do
-    client.should_receive(:post).with(url_for('/foo'), 'bar', {}) \
-      .and_return(response)
-    api.post('/foo', 'bar').should == 'foo'
-  end
-
-  it 'sends PUT requests to the server and returns the response body' do
-    client.should_receive(:put).with(url_for('/foo'), 'bar', {}) \
-      .and_return(response)
-    api.put('/foo', 'bar').should == 'foo'
-  end
+  shared_examples_for 'any type of HTTP request' do |http_verb|
+    context "(#{http_verb})" do
+      before(:each) do
+        client.stub!(http_verb => response)
+      end
 
-  it 'sends GET requests to the server and returns the response body' do
-    client.should_receive(:get).with(url_for('/foo'), {}) \
-      .and_return(response)
-    api.get('/foo').should == 'foo'
-  end
+      it 'returns the response body' do
+        api.send(http_verb, '/foo').should == 'foo'
+      end
 
-  it 'sends DELETE requests to the server and returns the response body' do
-    client.should_receive(:delete).with(url_for('/foo'), {}) \
-      .and_return(response)
-    api.delete('/foo').should == 'foo'
-  end
+      it 'raises an UnexpectedResponse if the request is not successful' do
+        response.stub!(code: 500)
+        client.stub!(http_verb).and_raise(RestClient::Exception.new(response))
+        lambda { api.send(http_verb, '/foo') } \
+          .should raise_error(Kookaburra::UnexpectedResponse)
+      end
 
-  describe 'any type of HTTP request' do
-    before(:each) do
-      client.stub!(:http_verb => response)
-    end
+      let(:expect_client_to_receive_headers) { ->(expected_headers) {
+        # Some HTTP verb methods pass data, some don't, and their arity
+        # is different
+        client.should_receive(http_verb) do |path, data_or_headers, headers|
+          headers ||= data_or_headers
+          expect(headers).to eq(expected_headers)
+          response
+        end
+      }}
+
+      context 'when custom global headers are specified' do
+        let(:api) {
+          klass = Class.new(Kookaburra::APIDriver) do
+            header 'Header-Foo', 'Baz'
+            header 'Header-Bar', 'Bam'
+          end
+          klass.new(configuration, client)
+        }
+
+        it "sets global headers on requests" do
+          expect_client_to_receive_headers.call('Header-Foo' => 'Baz', 'Header-Bar' => 'Bam')
+          api.send(http_verb, '/foo')
+        end
 
-    it 'returns the response body' do
-      api.request(:http_verb, '/foo', 'bar').should == 'foo'
-    end
+        context "and additional headers are specified on a single call" do
+          it 'sets both the global and additional headers on the request' do
+            expect_client_to_receive_headers.call('Header-Foo' => 'Baz', 'Header-Bar' => 'Bam', 'Yak' => 'Shaved')
+            api.send(http_verb, '/foo', nil, 'Yak' => 'Shaved')
+          end
 
-    it 'raises an UnexpectedResponse if the request is not successful' do
-      response.stub!(code: 500)
-      client.stub!(:http_verb).and_raise(RestClient::Exception.new(response))
-      lambda { api.request(:http_verb, '/foo') } \
-        .should raise_error(Kookaburra::UnexpectedResponse)
-    end
+          it 'only sets the global headers on subsequent requests' do
+            api.send(http_verb, '/foo', nil, 'Yak' => 'Shaved')
 
-    context 'when custom headers are specified' do
-      let(:api) {
-        klass = Class.new(Kookaburra::APIDriver) do
-          header 'Header-Foo', 'Baz'
-          header 'Header-Bar', 'Bam'
+            expect_client_to_receive_headers.call('Header-Foo' => 'Baz', 'Header-Bar' => 'Bam')
+            api.send(http_verb, '/foo')
+          end
         end
-        klass.new(configuration, client)
-      }
 
-      it "sets headers on requests" do
-        client.should_receive(:http_verb).with(url_for('/foo'), {}, 'Header-Foo' => 'Baz', 'Header-Bar' => 'Bam')
-        api.request(:http_verb, '/foo', {})
+        context 'and global header values are overriden by a single call' do
+          it 'uses the override value for the the request' do
+            expect_client_to_receive_headers.call('Header-Foo' => 'Baz', 'Header-Bar' => 'Yak')
+            api.send(http_verb, '/foo', nil, 'Header-Bar' => 'Yak')
+          end
+
+          it 'uses the global value for subsequent requests' do
+            api.send(http_verb, '/foo', nil, 'Header-Bar' => 'Yak')
+
+            expect_client_to_receive_headers.call('Header-Foo' => 'Baz', 'Header-Bar' => 'Bam')
+            api.send(http_verb, '/foo')
+          end
+        end
       end
-    end
 
-    context 'when a custom encoder is specified' do
-      let(:api) {
-        klass = Class.new(Kookaburra::APIDriver) do
-          encode_with { |data| :some_encoded_data }
+      context 'when headers are specified' do
+        it 'sets the headers on the request' do
+          expected_headers = {'Foo' => 'Bar', 'Baz' => 'Bam'}
+          expect_client_to_receive_headers.call(expected_headers)
+          api.send(http_verb, '/foo', nil, expected_headers)
         end
-        klass.new(configuration, client)
-      }
 
-      it "encodes input to requests" do
-        client.should_receive(:http_verb) do |_, data, _|
-          data.should == :some_encoded_data
-          response
+        it 'does not set the headers on subsequent requests' do
+          api.send(http_verb, '/foo', nil, :foo => :bar)
+
+          expect_client_to_receive_headers.call({})
+          api.send(http_verb, '/foo')
         end
+      end
 
-        api.request(:http_verb, '/foo', :ruby_data)
+      context 'when a custom decoder is specified' do
+        let(:api) {
+          klass = Class.new(Kookaburra::APIDriver) do
+          decode_with { |data| :some_decoded_data }
+          end
+        klass.new(configuration, client)
+        }
+
+        it "decodes response bodies from requests" do
+          api.send(http_verb, '/foo').should == :some_decoded_data
+        end
       end
     end
+  end
 
-    context 'when a custom decoder is specified' do
-      let(:api) {
-        klass = Class.new(Kookaburra::APIDriver) do
-        decode_with { |data| :some_decoded_data }
+  shared_examples_for 'it encodes request data' do |http_verb|
+    context "(#{http_verb})" do
+      before(:each) do
+        client.stub!(http_verb => response)
+      end
+
+      context 'when a custom encoder is specified' do
+        let(:api) {
+          klass = Class.new(Kookaburra::APIDriver) do
+            encode_with { |data|
+              data.should == :some_ruby_data
+              :some_encoded_data
+            }
+          end
+          klass.new(configuration, client)
+        }
+
+        it "encodes input to requests" do
+          client.should_receive(http_verb) do |_, data, _|
+            data.should == :some_encoded_data
+            response
+          end
+
+          api.send(http_verb, '/foo', :some_ruby_data)
         end
-        klass.new(configuration, client)
-      }
+      end
+    end
+  end
 
-      it "decodes response bodies from requests" do
-        api.request(:http_verb, '/foo').should == :some_decoded_data
+  shared_examples_for 'it encodes data as a querystring' do |http_verb|
+    context "(#{http_verb})" do
+      it 'adds data as querystirng params' do
+        client.should_receive(http_verb).with(url_for('/foo?bar=baz&yak=shaved'), {}) \
+          .and_return(response)
+        api.send(http_verb, '/foo', bar: 'baz', yak: 'shaved')
       end
     end
   end
+
+  it_behaves_like 'any type of HTTP request', :get
+  it_behaves_like 'any type of HTTP request', :post
+  it_behaves_like 'any type of HTTP request', :put
+  it_behaves_like 'any type of HTTP request', :delete
+
+  it_behaves_like 'it encodes data as a querystring', :get
+  it_behaves_like 'it encodes data as a querystring', :delete
+
+  it_behaves_like 'it encodes request data', :post
+  it_behaves_like 'it encodes request data', :put
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kookaburra
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-14 00:00:00.000000000 Z
+date: 2012-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -208,6 +208,8 @@ files:
 - Rakefile
 - VERSION
 - kookaburra.gemspec
+- lib/core_ext/object/to_param.rb
+- lib/core_ext/object/to_query.rb
 - lib/kookaburra.rb
 - lib/kookaburra/api_driver.rb
 - lib/kookaburra/assertion.rb
@@ -252,7 +254,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1361909781639378810
+      hash: -3075821559668997121
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: