Merge pull request #41 from QuickPay/allow_content_type_json_variation

Allow content type application/json variations

Author: cramt

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 3.0.1
+
+* Fixed bug where variations of Content-Type application/json got scrubbed, fx application/json;charset=UTF-8 (https://github.com/QuickPay/quickpay-ruby-client/pull/41)
+
 ## 3.0.0
 
 ### Breaking changes

README.md

@@ -20,7 +20,7 @@ or install from Rubygems:
 $ gem install quickpay-ruby-client
 ```
 
-It is currently tested with Ruby ( >= 2.5.x)
+It is currently tested with Ruby ( >= 2.6.x)
 
 * MRI
 * Rubinius (2.0)

lib/quickpay/api/client.rb

@@ -11,6 +11,8 @@ class Client
         "Accept-Version" => "v10"
       }.freeze
 
+      CONTENT_TYPE_JSON_REGEX = %r{application/.*json}.freeze
+
       Request = Struct.new(:method, :path, :body, :headers, :query) # rubocop:disable Lint/StructNewOverride
 
       def initialize(username: nil, password: nil, base_uri: "https://api.quickpay.net", options: {})
@@ -32,7 +34,7 @@ def initialize(username: nil, password: nil, base_uri: "https://api.quickpay.net
           headers = DEFAULT_HEADERS.merge(options.fetch(:headers, {}))
           body    = begin
             data = options.fetch(:body, "")
-            if headers["Content-Type"] == "application/json" && data.instance_of?(Hash)
+            if CONTENT_TYPE_JSON_REGEX.match(headers["Content-Type"]) && data.instance_of?(Hash)
               data.to_json
             else
               data
@@ -50,7 +52,7 @@ def initialize(username: nil, password: nil, base_uri: "https://api.quickpay.net
           res = @connection.request(**req.to_h)
           error = QuickPay::API::Error.by_status_code(res.status, res.body, res.headers, req)
 
-          if !options.fetch(:raw, false) && res.headers["Content-Type"] =~ %r{application/json}
+          if !options.fetch(:raw, false) && res.headers["Content-Type"] =~ CONTENT_TYPE_JSON_REGEX
             res.body = JSON.parse(res.body, options[:json_opts] || @connection.data[:json_opts])
           end
 
@@ -72,7 +74,7 @@ def initialize(username: nil, password: nil, base_uri: "https://api.quickpay.net
       def scrub_body(body, content_type)
         return "" if body.to_s.empty?
 
-        if ["application/json", "application/x-www-form-urlencoded"].include?(content_type)
+        if [CONTENT_TYPE_JSON_REGEX, %r{application/x-www-form-urlencoded}].any? { |regex| regex.match(content_type) }
           body
         else
           "<scrubbed for Content-Type #{content_type}>"

lib/quickpay/api/version.rb

@@ -1,5 +1,5 @@
 module QuickPay
   module API
-    VERSION = "3.0.0".freeze
+    VERSION = "3.0.1".freeze
   end
 end

test/client.rb

@@ -116,6 +116,28 @@
         _(response).must_equal({ :foo => "bar" })
       end
     end
+
+    it "returns a ruby Hash if content type is weird application/json" do
+      Excon.stub(
+        { path: "/ping" },
+        lambda do |request_params|
+          {
+            body: request_params[:body],
+            headers: { "Content-Type" => "application/stuff+json" },
+            status: 200
+          }
+        end
+      )
+
+      # client returns Ruby Hash with string keys
+      subject.post(
+        "/ping",
+        body: { "foo" => "bob" },
+        headers: { "Content-Type" => "application/stuff+json" }
+      ).tap do |response,|
+        _(response).must_equal({ "foo" => "bob" })
+      end
+    end
   end
 
   describe "request with block" do