chimera_http_client 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a58fb6d4a20a8a2bef43186a46663abc494844ccc30cf6f2e467dd043519861
-  data.tar.gz: '08c871044cb14bfbe9de820547ec7531a2719302f30d84e8aa9d658ed9ebf197'
+  metadata.gz: 01402cd235d413d16acc9adb72267b7a244898b5913d14d07e039ad6b1bd830b
+  data.tar.gz: 3909459cb620e544da67ee5864f39ab7ea51a6c33b6dd1b3fcddda5a56ec4dd5
 SHA512:
-  metadata.gz: 28b48b1d2fe9b723a9b567b30be1dabdd2bdc76313f9392e4ebe30bf3a8568f729a00f7b0dbdc362099196dd5aea62ddfcceb09db15481b67ada604271a75546
-  data.tar.gz: c211bc5978a7623c8f9ddaf1a069bd4f7d0aeb8bd680b2c8e61e6f9e4b32b281768da1b3bfa364b6ef69382763ae2f03324b37fa54d5277b1ae68e1468bc5b73
+  metadata.gz: 655127ba58b327eb2bc9f2ff6342ad3c93bd84c9cfa08fc262a4628005643e2562ae76ee68378331a92edb11cd9fb91fe0cf942f45d4ce911f176bfae8392c02
+  data.tar.gz: b3b282c08dc802b187ee95e974deb996ee833d3350f86ef4d6c89818ef1b182bedee2f043aaad50f392157829559b18b579480d7d50beef154617bb744e6cf9e

data/.travis.yml

@@ -4,7 +4,6 @@ rvm:
   - ruby-head
   - 2.6
   - 2.5
-  - 2.4
   - jruby
   - truffleruby
 

data/README.markdown

@@ -14,7 +14,13 @@ The `chimera_http_client` gem is wrapping the **libcurl** wrapper [**Typhoeus**]
 
 The only other runtime dependency is Ruby's latest code loader [**zeitwerk**](https://github.com/fxn/zeitwerk) which is also part of Rails 6.
 
-All Ruby versions newer than **2.4** are supported.
+### Ruby version
+
+| Chimera version | Ruby version |
+|:----------------|:-------------|
+| >= 1.1          | >= 2.5       |
+| =  1.0          | >= 2.4       |
+| <= 0.5          | >= 2.1       |
 
 ### ENV variables
 
@@ -81,6 +87,19 @@ The optional parameters are:
 * `user_agent` - if you would like your calls to identify with a specific user agent
 * `verbose` - the default is `false`, set it to true while debugging issues
 * `cache` - an instance of your cache solution, can be overwritten in any request
+* `deserializers` - custom methods to deserialize the response body, below more details
+
+##### Custom deserializers
+
+In case the API you are connecting to does not return JSON, you can pass custom deserializers to `Connection.new` or `Queue.new`:
+
+    deserializers: { error: your_error_deserializer, response: your_response_deserializer }
+
+A Deserializer has to be an object on which the method `call` with the parameter `body` can be called:
+
+    custom_deserializer.call(body)
+
+where `body` is the response body (in the default case a JSON object). The class `Deserializer` contains the default objects that are used. They might help you creating your own. Don't forget to make requests with another header than the default `"Content-Type" => "application/json"`, when the API you connect to does not support JSON.
 
 ### Request methods
 
@@ -263,10 +282,6 @@ Usually it does not have to be used directly. It is the class that executes the
 
 The `body` which it receives from the `Connection` class has to be in the in the (serialized) form in which the endpoint expects it. Usually this means you have to pass a JSON string to the `body` (it will **not** be serialized automatically).
 
-> Upcoming feature:
->
-> It will be expanded by a `.queue` method, that will queue (sic) calls and run them in parallel and not run every call directly, like the `.run` method does.
-
 ## The Response class
 
 The `ChimeraHttpClient::Response` objects have the following interface:
@@ -276,9 +291,9 @@ The `ChimeraHttpClient::Response` objects have the following interface:
     * time             (for monitoring)
     * response         (the full response object, including the request)
     * error?           (returns false)
-    * parsed_body      (returns the result of JSON.parse(body))
+    * parsed_body      (returns the result of `deserializer[:response].call(body)`)
 
-If your API does not use JSON, but a different format e.g. XML, you can either monkey patch a `parsed_xml` method to the Response class, or let your wrapper handle the parsing of `body`.
+If your API does not use JSON, but a different format e.g. XML, you can pass a custom deserializer to the Connection.
 
 ## Error classes
 
@@ -358,7 +373,7 @@ To inspect the requests waiting for execution, call `queue.queued_requests`.
 
 Add this line to your application's Gemfile:
 
-    gem 'chimera_http_client', '~> 0.5'
+    gem 'chimera_http_client', '~> 1.1'
 
 And then execute:
 

data/TODO.markdown

@@ -17,9 +17,9 @@ _none known_
 
 ### Custom De-serializer
 
-* [ ] allow to pass custom deserializer
-* [ ] use custom deserializer in #parsed_body instead of default JSON parsing
-* [ ] add example to README
+* [x] ~~allow to pass custom deserializer~~
+* [x] ~~use custom deserializer in #parsed_body instead of default JSON parsing~~
+* [x] ~~add example to README~~
 
 ### Queueing / running in parallel
 

data/lib/chimera_http_client/base.rb

@@ -2,17 +2,18 @@ module ChimeraHttpClient
   class Base
     USER_AGENT = "ChimeraHttpClient (by mediafinger)".freeze
 
-    def initialize(base_url:, logger: nil, timeout: nil, user_agent: USER_AGENT, verbose: false, cache: nil)
-      fail(ChimeraHttpClient::ParameterMissingError, "base_url expected, but not given") if base_url.nil?
+    def initialize(options = {})
+      fail(ChimeraHttpClient::ParameterMissingError, "base_url expected, but not given") if options[:base_url].nil?
 
-      @base_url = base_url
-      @logger = logger
-      @timeout = timeout
+      @base_url = options.fetch(:base_url)
+      @deserializer = default_deserializer.merge(options.fetch(:deserializer, {}))
+      @logger = options[:logger]
+      @timeout = options[:timeout]
 
-      Typhoeus::Config.cache = cache
+      Typhoeus::Config.cache = options[:cache]
       Typhoeus::Config.memoize = false # hydra setting, prevents a possible memory leak
-      Typhoeus::Config.user_agent = user_agent
-      Typhoeus::Config.verbose = verbose
+      Typhoeus::Config.user_agent = options.fetch(:user_agent, USER_AGENT)
+      Typhoeus::Config.verbose = options.fetch(:verbose, false)
     end
 
     private
@@ -42,6 +43,10 @@ module ChimeraHttpClient
       { "Content-Type" => "application/json" }
     end
 
+    def default_deserializer
+      { error: ::ChimeraHttpClient::Deserializer.json_error, response: ::ChimeraHttpClient::Deserializer.json_response }
+    end
+
     # Build URL out of @base_url and endpoint given as String or Array, while trimming redundant "/"
     def url(endpoint)
       trimmed_endpoint = Array(endpoint).map { |e| trim(e) }

data/lib/chimera_http_client/connection.rb

@@ -11,7 +11,12 @@ module ChimeraHttpClient
     end
 
     def request
-      @request ||= Request.new(logger: @logger)
+      options = {
+        logger: @logger,
+        deserializer: @deserializer,
+      }
+
+      @request ||= Request.new(options)
     end
 
     private

data/lib/chimera_http_client/deserializer.rb

@@ -0,0 +1,31 @@
+# This two JSON deserializers are the default ones
+#
+# To use custom deserializers, pass them as param to Connection.new or Queue.new:
+# `deserializers: { error: your_error_deserializer, response: your_response_deserializer }`
+# (you might be able to use the same for both cases)
+#
+# a Deserializer has to be an object on which the method `call` with the parameter `body` can be called:
+# `custom_deserializer.call(body)`
+# where `body` is the response body (in the default case a JSON object)
+#
+module ChimeraHttpClient
+  class Deserializer
+    class << self
+      def json_error
+        proc do |body|
+          JSON.parse(body)
+        rescue JSON::ParserError
+          { "non_json_body" => body }
+        end
+      end
+
+      def json_response
+        proc do |body|
+          JSON.parse(body)
+        rescue JSON::ParserError => e
+          raise ::ChimeraHttpClient::JsonParserError, "Could not parse body as JSON: #{body}, error: #{e.message}"
+        end
+      end
+    end
+  end
+end

data/lib/chimera_http_client/error.rb

@@ -1,14 +1,15 @@
 module ChimeraHttpClient
   class Error < StandardError
-    attr_reader :body, :code, :time, :response
+    attr_reader :body, :code, :time, :response, :deserializer
     alias message body
 
-    def initialize(response)
+    def initialize(response, options = {})
       @body     = response.body
       @code     = response.code
       @time     = response.options&.fetch(:total_time, nil)
       @response = response # contains the request
-      super
+
+      @deserializer = options[:deserializer][:error]
     end
 
     def error?
@@ -16,9 +17,7 @@ module ChimeraHttpClient
     end
 
     def parsed_body
-      JSON.parse(body)
-    rescue JSON::ParserError
-      { "non_json_body" => body }
+      deserializer.call(body)
     end
 
     def to_s

data/lib/chimera_http_client/queue.rb

@@ -38,7 +38,12 @@ module ChimeraHttpClient
     private
 
     def create_request(method:, url:, body:, headers:, options:)
-      Request.new(logger: @logger).create(
+      class_options = {
+        logger: @logger,
+        deserializer: @deserializer,
+      }
+
+      Request.new(class_options).create(
         method: method,
         url: url,
         body: body,

data/lib/chimera_http_client/request.rb

@@ -4,8 +4,9 @@ module ChimeraHttpClient
 
     attr_reader :request, :result
 
-    def initialize(logger: nil)
-      @logger = logger
+    def initialize(options = {})
+      @logger = options[:logger]
+      @options = options
     end
 
     def run(url:, method:, body: nil, options: {}, headers: {})
@@ -50,39 +51,39 @@ module ChimeraHttpClient
     private
 
     def on_complete_handler(response)
-      return Response.new(response) if response.success?
+      return Response.new(response, @options) if response.success?
 
       exception_for(response)
     end
 
     def exception_for(response)
-      return TimeoutError.new(response) if response.timed_out?
+      return TimeoutError.new(response, @options) if response.timed_out?
 
       case response.code.to_i
       when 301, 302, 303, 307
-        RedirectionError.new(response)
+        RedirectionError.new(response, @options)
       when 200..399
         nil
       when 400
-        BadRequestError.new(response)
+        BadRequestError.new(response, @options)
       when 401
-        UnauthorizedError.new(response)
+        UnauthorizedError.new(response, @options)
       when 403
-        ForbiddenError.new(response)
+        ForbiddenError.new(response, @options)
       when 404
-        NotFoundError.new(response)
+        NotFoundError.new(response, @options)
       when 405
-        MethodNotAllowedError.new(response)
+        MethodNotAllowedError.new(response, @options)
       when 409
-        ResourceConflictError.new(response)
+        ResourceConflictError.new(response, @options)
       when 422
-        UnprocessableEntityError.new(response)
+        UnprocessableEntityError.new(response, @options)
       when 400..499
-        ClientError.new(response)
+        ClientError.new(response, @options)
       when 500..599
-        ServerError.new(response)
+        ServerError.new(response, @options)
       else # response.code.zero?
-        ConnectionError.new(response)
+        ConnectionError.new(response, @options)
       end
     end
   end

data/lib/chimera_http_client/response.rb

@@ -1,18 +1,18 @@
 module ChimeraHttpClient
   class Response
-    attr_reader :body, :code, :time, :response
+    attr_reader :body, :code, :time, :response, :deserializer
 
-    def initialize(response)
+    def initialize(response, options = {})
       @body     = response.body
       @code     = response.code
       @time     = response.total_time
       @response = response # contains the request
+
+      @deserializer = options[:deserializer][:response]
     end
 
     def parsed_body
-      JSON.parse(body)
-    rescue JSON::ParserError => e
-      raise ChimeraHttpClient::JsonParserError, "Could not parse body as JSON: #{body}, error: #{e.message}"
+      deserializer.call(body)
     end
 
     def error?

data/lib/chimera_http_client/version.rb

@@ -1,3 +1,3 @@
 module ChimeraHttpClient
-  VERSION = "1.0.0".freeze
+  VERSION = "1.1.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chimera_http_client
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Andreas Finger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-14 00:00:00.000000000 Z
+date: 2019-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -171,6 +171,7 @@ files:
 - lib/chimera_http_client.rb
 - lib/chimera_http_client/base.rb
 - lib/chimera_http_client/connection.rb
+- lib/chimera_http_client/deserializer.rb
 - lib/chimera_http_client/error.rb
 - lib/chimera_http_client/queue.rb
 - lib/chimera_http_client/request.rb