manticore 0.4.3-java → 0.4.4-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e663f9b19e305371f23a33ca105cf960255b53a
-  data.tar.gz: 6c0dd62a760f11460cf565949632e8dbfa77d117
+  metadata.gz: e35496eb223648d01aea2dbe4132d88102b599f6
+  data.tar.gz: d87ffe86b45313d8836354c9df4419e3c91c9fd9
 SHA512:
-  metadata.gz: f0f65941a497dfa2254d4859bf8528cfc0b299f280a6564556aa3a9f08de4d634a1ef3f488ac467b12ace46a5637a793a65a63ffa290300551019f7b49fd0d1f
-  data.tar.gz: 3e5766be83ff90fc7bab9b5becdc5801156a1fe06ead3f3dd679ee686c8b9c1994ba12c04f7bb450f6758b9d21b21f7e67f41f979b083ce421feecf721b8880e
+  metadata.gz: e03381476da9b771bf8961c0767312639147d4bc15435879144f4d37960dcac693bc07c43ab9c963fefe846df76163569483040230d852e1038dcff58157fd7a
+  data.tar.gz: 011f97038fd79f71cb3b734639fa468f3395073efe5697d838543ecbe38f26da94ee005726379fedd54cfac9789d9271169a168b0930b1096568d8d98e5a4901

data/CHANGELOG.md

@@ -1,9 +1,20 @@
 ## v0.5
 
-### v0.5.0 (pending)
+### v0.5.0 (pending, hc-4.5 branch)
+
+* Upgrade to HTTPClient and HTTPCore 4.5
 
 ## v0.4
 
+## v0.4.5 (pending, master branch)
+
+## v0.4.4
+
+* Manticore now treats post bodies with binary encodings as binary byte lists rather than strings with an encoding
+* Manticore now treats :params as :query for GET, HEAD, and DELETE requests, where :query is not specified, in order to minimize confusion.
+* Deprecated dependency on the Addressable gem. URI building is now done with HTTPClient's utils package instead.
+* Manticore no longer always sets a body and content-length for stubbed responses
+
 ### v0.4.3
 
 * Manticore no longer automatically retries all request types. Only non-idempotent requests will be automatically retried by default.

data/README.md

@@ -46,11 +46,12 @@ Or install it yourself as:
 If you don't want to worry about setting up and maintaining client pools, Manticore comes with a facade that you can use to start making requests right away:
 
 ```ruby
-document_body = Manticore.get("http://www.google.com/").body
+get_body  = Manticore.get("http://www.google.com/",  query:  {q: "kittens"}).body
+post_body = Manticore.post("http://www.google.com/", params: {q: "kittens"}).body
 
 # Or
 
-document_body = Manticore.http(:get, "http://www.google.com/").body
+get_body = Manticore.http(:get, "http://www.google.com/").body
 ```
 
 This is threadsafe and automatically backed with a pool, so you can execute `Manticore.get` in multiple threads without harming performance.

data/lib/manticore.rb

@@ -17,7 +17,6 @@ require_relative "./jar/manticore-ext"
 org.manticore.Manticore.new.load(JRuby.runtime, false)
 
 require_relative "./manticore/version"
-require "addressable/uri"
 
 # HTTP client with the body of a lion and the head of a man. Or more simply, the power of Java
 # with the beauty of Ruby.

data/lib/manticore/client.rb

@@ -6,7 +6,9 @@ module Manticore
   # @!macro [new] http_method_shared
   #   @param  url [String] URL to request
   #   @param  options [Hash]
-  #   @option options [Hash]     params             Hash of options to pass as request parameters
+  #   @option options [Hash]     query              Hash of options to be added to the URL as part of the query string
+  #   @option options [Hash]     params             Hash of options to pass as a request body. For GET, HEAD, and DELETE requests,
+  #                                                   :params will be treated as :query if :query is not present.
   #   @option options [Hash]     headers            Hash of options to pass as additional request headers
   #   @option options [String]   proxy              Proxy host in form: http://proxy.org:1234
   #   @option options [Hash]     proxy              Proxy host in form: {host: 'proxy.org'[, port: 80[, scheme: 'http']]}
@@ -81,6 +83,7 @@ module Manticore
     include_package "java.security.cert"
     include_package "java.security.spec"
     include_package "java.security"
+    include_package "org.apache.http.client.utils"
     java_import "org.apache.http.HttpHost"
     java_import "javax.net.ssl.SSLContext"
     java_import "org.manticore.HttpGetWithEntity"
@@ -219,6 +222,7 @@ module Manticore
     # Perform a HTTP GET request
     # @macro http_method_shared_sync
     def get(url, options = {}, &block)
+      options = treat_params_as_query(options)
       request HttpGetWithEntity, url, options, &block
     end
 
@@ -231,6 +235,7 @@ module Manticore
     # Perform a HTTP HEAD request
     # @macro http_method_shared_sync
     def head(url, options = {}, &block)
+      options = treat_params_as_query(options)
       request HttpHead, url, options, &block
     end
 
@@ -243,6 +248,7 @@ module Manticore
     # Perform a HTTP DELETE request
     # @macro http_method_shared_sync
     def delete(url, options = {}, &block)
+      options = treat_params_as_query(options)
       request HttpDelete, url, options, &block
     end
 
@@ -406,19 +412,10 @@ module Manticore
     end
 
     def uri_from_url_and_options(url, options)
-      uri = Addressable::URI.parse url
-      if options[:query]
-        v = uri.query_values || {}
-        case options[:query]
-        when Hash
-          uri.query_values = v.merge options[:query]
-        when String
-          uri.query_values = v.merge CGI.parse(options[:query])
-        else
-          raise "Queries must be hashes or strings"
-        end
-      end
-      uri
+      builder = URIBuilder.new(url)
+      pairs = struct_to_name_value_pairs(options[:query])
+      builder.add_parameters pairs unless pairs.empty?
+      builder.to_string
     end
 
     def request_from_options(klass, url, options)
@@ -427,9 +424,15 @@ module Manticore
       if ( options[:params] || options[:body] || options[:entity]) &&
          ( req.instance_of?(HttpPost) || req.instance_of?(HttpPatch) || req.instance_of?(HttpPut) || req.instance_of?(HttpGetWithEntity))
         if options[:params]
-          req.set_entity hash_to_entity(options[:params])
+          pairs = struct_to_name_value_pairs(options[:params])
+          encoding = minimum_encoding_for options[:params].to_s
+          req.set_entity UrlEncodedFormEntity.new(pairs, encoding)
         elsif options[:body]
-          req.set_entity StringEntity.new(options[:body], minimum_encoding_for(options[:body]))
+          if options[:body].encoding == Encoding::ASCII_8BIT
+            req.set_entity ByteArrayEntity.new(options[:body].to_java_bytes)
+          else
+            req.set_entity StringEntity.new(options[:body], minimum_encoding_for(options[:body]))
+          end
         elsif options[:entity]
           req.set_entity options[:entity]
         end
@@ -520,14 +523,17 @@ module Manticore
       end
     end
 
-    def hash_to_entity(hash)
-      # This is a really stupid way to get the "lowest common denominator" encoding for the options hash
-      # Is there a better way?
-      encoding = minimum_encoding_for hash.to_a.flatten.join
-      pairs = hash.map do |key, val|
-        BasicNameValuePair.new(key, val)
+    def struct_to_name_value_pairs(value, namespace = nil)
+      case value
+      when nil
+        []
+      when Hash
+        value.flat_map {|key, val| struct_to_name_value_pairs val, namespace ? "#{namespace}[#{key}]" : key }
+      when Array
+        value.flat_map {|val| struct_to_name_value_pairs val, namespace }
+      else
+        BasicNameValuePair.new(namespace, value.to_s)
       end
-      UrlEncodedFormEntity.new(pairs, encoding)
     end
 
     # Apache HTTP assumes ISO_8859_1 for StringEntities; we'll try to be nice and pass that when possible
@@ -640,6 +646,14 @@ module Manticore
         KeyStore.get_default_type
       end
     end
+
+    def treat_params_as_query(options)
+      if options.key?(:params) && !options.key?(:query)
+        options.dup.tap {|o| o[:query] = o.delete(:params) }
+      else
+        options
+      end
+    end
   end
 
   class LoggingStandardRetryHandler < Java::OrgApacheHttpImplClient::StandardHttpRequestRetryHandler

data/lib/manticore/stubbed_response.rb

@@ -36,11 +36,11 @@ module Manticore
         stubs[:cookies].keys.each {|key| stubs[:cookies][key] = Array(stubs[:cookies][key]) }
       end
       stubs[:code] ||= 200
-      stubs[:body] ||= "" if stubs[:code] == 200
 
       stubs[:headers] ||= {}
       stubs[:headers] = Hash[*stubs[:headers].flat_map {|k, v| [k.downcase, v] }]
-      stubs[:headers]["content-length"] = stubs[:body].length.to_s if stubs.key?(:body)
+      stubs[:headers]["content-length"] ||= stubs[:body].length.to_s if stubs.key?(:body)
+
       @stubs = stubs
 
       self

data/lib/manticore/version.rb

@@ -1,3 +1,3 @@
 module Manticore
-  VERSION = "0.4.3"
+  VERSION = "0.4.4"
 end

data/manticore.gemspec

@@ -25,7 +25,6 @@ Gem::Specification.new do |spec|
     spec.cert_chain  = ['gem-public_cert.pem']
   end
 
-  spec.add_dependency "addressable", "~> 2.3"
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
 end

data/spec/manticore/client_spec.rb

@@ -377,6 +377,32 @@ describe Manticore::Client do
       response = client.get(local_server, body: "This is a post body")
       expect(JSON.load(response.body)["body"]).to eq "This is a post body"
     end
+
+    it "can send an array of parameters as :params" do
+      response = client.get(local_server, params: {"foo" => ["baz", "bar"], "bar" => {"baz" => ["bin", 1, :b]}})
+      j = JSON.load(response.body)
+      expect(j["body"]).to eq ""
+      expect(j["uri"]["query"]).to include("foo=baz")
+    end
+
+    it "can send an array of parameters as :query" do
+      response = client.get(local_server, query: {"foo" => ["baz", "bar"]})
+      j = JSON.load(response.body)
+      expect(j["body"]).to eq ""
+      expect(j["uri"]["query"]).to include("foo=baz")
+    end
+
+    it "sends non-ASCII params" do
+      response = client.get(local_server, query: {"∑" => "√"})
+      j = JSON.load(response.body)
+      expect(CGI.unescape j["uri"]["query"]).to eq "∑=√"
+    end
+
+    it "merges implicit query parameters with explicit ones" do
+      response = client.get(local_server + "?foo=bar", query: {"baz" => "bin"})
+      j = JSON.load(response.body)
+      expect(CGI.parse j["uri"]["query"]).to eq({"foo" => ["bar"], "baz" => ["bin"]})
+    end
   end
 
   describe "#post" do
@@ -405,6 +431,12 @@ describe Manticore::Client do
       expect(CGI.unescape(JSON.load(response.body)["body"])).to eq "∑=√"
     end
 
+    it "sends a binary body" do
+      bytes = [145, 167, 116, 101, 115, 116, 49, 50, 51].pack("c*").encode("binary")
+      response = client.post(local_server, body: bytes, headers: {"X-Base64" => "1"})
+      expect(Base64.decode64(JSON.load(response.body)["body"])).to eq bytes
+    end
+
     it "sends an arbitrary entity" do
       f = open(__FILE__, "r").to_inputstream
       multipart_entity = MultipartEntityBuilder.create.add_text_body("foo", "bar").add_binary_body("whatever", f , ContentType::TEXT_PLAIN, __FILE__)

data/spec/spec_helper.rb

@@ -72,6 +72,9 @@ def start_server(port = PORT)
         if request[:headers]["Accept-Encoding"] && request[:headers]["Accept-Encoding"].match("gzip")
           out = StringIO.new('', "w")
           io = Zlib::GzipWriter.new(out, 2)
+         
+          request[:body] = Base64.encode64(request[:body]) if request[:headers]["X-Base64"]
+          
           io.write JSON.dump(request)
           io.close
           payload = out.string

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: manticore
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
 platform: java
 authors:
 - Chris Heald
@@ -30,22 +30,8 @@ cert_chain:
   cnyabLOcGIKZNxvnSfwOuCBnjgoSOyJi/n48n1s+OPB/OmPJoWmhKu2DO4sUb4+K
   /3Mhp5UWSl9SmDR1
   -----END CERTIFICATE-----
-date: 2015-08-07 00:00:00.000000000 Z
+date: 2015-08-20 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.3'
-  name: addressable
-  prerelease: false
-  type: :runtime
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.3'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -150,3 +136,4 @@ test_files:
 - spec/manticore/stubbed_response_spec.rb
 - spec/spec_helper.rb
 - spec/ssl/.keepme
+has_rdoc: