jeff 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3867d229eb05451a032899de8e28246d02498e6d
-  data.tar.gz: 3d03ba5a26edb20d7528c323e2526ff11293e0cd
+  metadata.gz: 26d4ecc099e2a707deb20d81eb0e99c146f4e4a4
+  data.tar.gz: c3c7d33f9cad57ec5bcfe55dacb7cc44f1175bfb
 SHA512:
-  metadata.gz: e513eb4d6bbbf3653362fcaf1d5afc458ee7281509711a95d8d379af208b21686a6dc3aed1e62cfb81e3562a32d59f24dc7ed1b251d37427d4ae2390f12c785e
-  data.tar.gz: 7b3f7c9ad65ecea40f25d666099929e85e5c2476c3cd078412e9df44c1335f75915af0a845d8b31e9a054d9a7fd49cb2211581094aaee9638df9f2051e4c360e
+  metadata.gz: dd29ac1f134dd1a98c841e63e7c1f17e1a8a82282abde2ccc0e694daf1dc347d853d477e87a929f2f4982e49acaaea88cf41c59b22f3f3bef30389cb6c9b5281
+  data.tar.gz: bbab285296bf3ddee692e21337ea04540af2104c9bfe6eb98d0b6939fdc20e0f93a19002845355b89f4b91031d2a1f8d3d7c2aefeb11a8868a968c31ea021cf4

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 1.3.0 15/4/2015
+
+- Handle overly long request queries
+
 # 1.2.0 23/1/2015
 
 - Discard parameters with nil values

data/lib/jeff.rb

@@ -20,7 +20,9 @@ module Jeff
     end
 
     def to_s
-      values.sort.map { |k, v| "#{k}=#{ Utils.escape(v) }" }.join("&")
+      values
+        .sort { |a, b| a[0].to_s <=> b[0].to_s }
+        .map { |k, v| "#{k}=#{ Utils.escape(v) }" }.join("&")
     end
   end
 
@@ -126,20 +128,29 @@ module Jeff
     eval <<-DEF
       def #{method}(options = {})
         options.store(:method, :#{method})
-        connection.request(build_options(options))
+        add_md5_digest options
+        sign options
+
+        begin
+          connection.request(options)
+        rescue Excon::Errors::RequestURITooLong
+          raise if options[:body] || options[:method] != :post
+          move_query_to_body options
+          retry
+        end
       end
     DEF
   end
 
   private
 
-  def build_options(options)
-    # Add Content-MD5 header if uploading a file.
-    if options.has_key?(:body)
-      md5 = Content.new(options[:body]).md5
-      (options[:headers] ||= {}).store("Content-MD5", md5)
-    end
+  def add_md5_digest(options)
+    return unless options.has_key?(:body)
+    md5 = Content.new(options[:body]).md5
+    (options[:headers] ||= {}).store("Content-MD5", md5)
+  end
 
+  def sign(options)
     # Build query string.
     query_values = default_query_values.merge(options.fetch(:query, {}))
     query_string = Query.new(query_values).to_s
@@ -149,8 +160,13 @@ module Jeff
       .new(options[:method], connection.data[:host], options[:path] || connection.data[:path], query_string)
       .sign_with(aws_secret_access_key)
 
-    # Return options after appending an escaped signature to query.
-    options.merge(query: "#{query_string}&Signature=#{Utils.escape(signature)}")
+    # Append escaped signature to query.
+    options.store(:query, "#{query_string}&Signature=#{Utils.escape(signature)}")
+  end
+
+  def move_query_to_body(options)
+    (options[:headers] ||= {}).store("Content-Type", "application/x-www-form-urlencoded")
+    options.store(:body, options.delete(:query))
   end
 
   def default_query_values

data/lib/jeff/version.rb

@@ -1,3 +1,3 @@
 module Jeff
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

data/test/test_jeff.rb

@@ -54,6 +54,11 @@ class TestJeff < Minitest::Test
     assert_equal "A1=1&A10=1", query.to_s
   end
 
+  def test_handles_symbol_keys
+    query = Jeff::Query.new(foo: 1, bar: 2)
+    assert_equal "bar=2&foo=1", query.to_s
+  end
+
   def test_sets_user_agent_header
     client = @klass.new
     client.aws_endpoint = "http://example.com/"
@@ -70,37 +75,55 @@ class TestJeff < Minitest::Test
   def test_does_not_escape_tilde
     assert_equal "~%2C", Jeff::Utils.escape("~,")
   end
+end
+
+class TestJeffInAction < Minitest::Test
+  def setup
+    klass = Class.new { include Jeff }
+    @client = klass.new
+    @client.aws_endpoint = "http://example.com/"
+    @client.aws_access_key_id = "foo"
+    @client.aws_secret_access_key = "bar"
+  end
+
+  def teardown
+    Excon.stubs.clear
+  end
 
   Excon::HTTP_VERBS.each do |method|
     define_method "test_makes_#{method}_request" do
-      Excon.stub({ }, { status: 200 })
-      client = @klass.new
-      client.aws_endpoint = "http://example.com/"
-      client.aws_access_key_id = "foo"
-      client.aws_secret_access_key = "bar"
-      assert_equal 200, client.send(method, mock: true).status
-      Excon.stubs.clear
+      Excon.stub({}, { status: 200 })
+      assert_equal 200, @client.send(method, mock: true).status
     end
   end
 
   def test_adds_content_md5_request_header_if_given_a_request_body
-    Excon.stub({ }) do |params|
-      { body: params[:headers]["Content-MD5"] }
+    Excon.stub({}) do |request_params|
+      { body: request_params[:headers]["Content-MD5"] }
     end
-    client = @klass.new
-    client.aws_endpoint = "http://example.com/"
-    client.aws_access_key_id = "foo"
-    client.aws_secret_access_key = "bar"
-    refute_empty client.post(body: "foo", mock: true).body
-    Excon.stubs.clear
+    refute_empty @client.post(body: "foo", mock: true).body
   end
 
-  def test_integration
-    client = @klass.new
-    client.aws_access_key_id = "foo"
-    client.aws_secret_access_key = "bar"
-    client.aws_endpoint = "https://mws.amazonservices.com/Sellers/2011-07-01"
-    res = client.post(query: { "Action" => "GetServiceStatus"})
+  def test_moves_query_to_body_if_uri_is_too_long
+    Excon.stub({}) do |request_params|
+      { status: request_params[:query] ? 414 : 200 }
+    end
+
+    res = @client.post(query: { foo: "bar" }, mock: true)
+    assert_equal 200, res.status
+
+    assert_raises(Excon::Errors::RequestURITooLong) do
+      @client.post(query: { foo: "bar" }, body: "baz", mock: true)
+    end
+
+    assert_raises(Excon::Errors::RequestURITooLong) do
+      @client.get(query: { foo: "bar" }, mock: true)
+    end
+  end
+
+  def test_gets_from_an_actual_endpoint
+    @client.aws_endpoint = "https://mws.amazonservices.com/Sellers/2011-07-01"
+    res = @client.post(query: { "Action" => "GetServiceStatus"})
     assert_equal 200, res.status
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jeff
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Hakan Ensari
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-23 00:00:00.000000000 Z
+date: 2015-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon