johac 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c9a6e0cd9ab2cb5c7aba657db7c59a726d7ec85a
-  data.tar.gz: c25864469ee9ace99f7b21fc7982a1bec72a8f69
+  metadata.gz: 169a90352f903f25093cb174c60cabd8c592e981
+  data.tar.gz: 8549fe4832fccee67a9d32b968d9def850d6b4e2
 SHA512:
-  metadata.gz: c6a3065a97f85e39e4a05963b559eb0d9260200c7898953485b58217df614f6c99f44846d9616ce50995fd7d1af9e83fba414ac528818e0cd9f838654d954ac7
-  data.tar.gz: 5bd7feade84a9af0a72e0341bf8ddb048867ce778d6aff22ee0f310d6d9a0ff38500d091c712cc5867d911eda69a4fec8687a96b65a985fc26376be97f021b2b
+  metadata.gz: 3d75e7c155d183c0153259e937f1b7473d7fcc02320742153b9607d1cfe8612f303c00bae85a4d4ac9c157e11ade8ae4f9eeeb91ab889445c05b47f44e9398c8
+  data.tar.gz: 7f8c041c46153d817e6fde4bc20be5d04e2247f9da1c6d62762280207f9d22e02381c916a943dd4e7c4ae233200ba2d3825f1299a83cb815c476f198fb34c443

data/lib/johac/connection.rb

@@ -17,6 +17,11 @@ module Johac
         faraday.request :johac_headers
         faraday.request :johac_auth, @config.auth_scheme, @config.access_key, @config.secret_key
 
+        # Allow caller to tap into the request before it is sent
+        if @config.request_tap
+          faraday.request :request_tap, @config.request_tap
+        end
+
         # Retry requests
         faraday.request :retry, {
           max: 2,
@@ -100,6 +105,24 @@ module Johac
       def call(env)
         env[:request_headers]['User-Agent'] = AgentString
         env[:request_headers]['Accept'] = Accept
+        env[:request_headers]['Content-Type'] = Accept
+        @app.call(env)
+      end
+
+    end
+
+    # Write custom user agent to all requests.
+    class RequestTapMiddleware < Faraday::Middleware
+
+      Faraday::Request.register_middleware :request_tap => self
+
+      def initialize(app, request_tap)
+        @request_tap = request_tap
+        super(app)
+      end
+
+      def call(env)
+        @request_tap.call(env)
         @app.call(env)
       end
 

data/lib/johac/error.rb

@@ -8,15 +8,17 @@ module Johac
     # Exception to be used when dealing with HTTP responses from a Johac API.
     class ResponseError < Error
 
-      attr_reader :code
+      attr_reader :status
       attr_reader :body
+      attr_reader :headers
 
       # Will attempt to decode a response body via JSON, and look for the 'message' key in the resulting (assumed) hash. If response body cannot be parsed via JSON the entire response body is set as the message for the exception.
       #
       # @param body [String] Response body.
       # @param headers [Hash] Response headers.
-      def initialize(code, body, headers)
-        @code = code
+      def initialize(status, body, headers)
+        @status = status
+        @headers = headers
         @body = if headers['Content-Type'] == 'application/json'
           JSON.parse(body) rescue body
         else

data/lib/johac/response.rb

@@ -1,8 +1,7 @@
 module Johac
   class Response
 
-    attr_reader :response
-    attr_reader :exception
+    attr_reader :response, :exception, :body, :status
 
     include Enumerable
 
@@ -12,20 +11,16 @@ module Johac
       else
         @exception = result
       end
+
+      @body = result.body if result.respond_to?(:body)
+      @status = result.status if result.respond_to?(:status)
     end
 
     # Determine if the request failed
     #
     # @return true if response failed (http or expcetion)
     def error?
-      exception != nil || status >= 400
-    end
-
-    # HTTP Status code
-    #
-    # @return response status code
-    def status
-      response_status || exception_status || 0
+      status.nil? || status >= 400
     end
 
     # HTTP Status code
@@ -35,13 +30,6 @@ module Johac
       status
     end
 
-    # HTTP Response body as a JSON parsed object
-    #
-    # @return Hash/Array of the JSON parsed body, or empty hash
-    def body
-      response_body || exception_body || {}
-    end
-
     # @return OpenStruct object of hash
     def object
       OpenStruct.new(body)
@@ -61,19 +49,23 @@ module Johac
     # @param args [Varargs] path of value
     #
     # @see {Hash.dig}
-    # @see {Array.dig}
     #
     # @return value of key path
     def dig(*args)
-      body.dig(*args)
+      body.kind_of?(Hash) ? body.dig(*args) : nil
     end
 
-    # Enumerate over response body opject
+    # Enumerate over response body object and return
+    # a new Response with a modified body
     #
     # @see {Enumerable}
     # @param block [Block] to invoke
     def each(&block)
-      body.each(&block)
+      if response?
+        body.each(&block)
+      else
+        self
+      end
     end
 
     # Invoke a block of code if the response fails, with
@@ -98,27 +90,35 @@ module Johac
       self
     end
 
-    protected
-
-    def response_status
-      response? ? response.status : nil
-    end
-
-    def response_body
-      response? ? response.body : nil
-    end
-
-    def exception_status
-      response_error? ? exception.code : nil
+    # Chain another request to the successful response.  The expected
+    # output of the block is another Johac::Response object.
+    #
+    # This enables request chaining, where an error in the chain will
+    # prevent further processing and return an error response
+    #
+    # response = client.request1(param)
+    #                  .flat_map { |r| client.request2(r.object.value) }
+    #                  .flat_map { |r| client.request3(r.object.value) }
+    #
+    # @param block [Block] to invoke
+    def flat_map(&block)
+      if response?
+        begin
+          yield self
+        rescue => e
+          Response.new(e)
+        end
+      else
+        self
+      end
     end
 
-    def exception_body
-      response_error? ? exception.body : nil
+    # @see flat_map
+    def and_then(&block)
+      flat_map(&block)
     end
 
-    def response_error?
-      exception.kind_of?(Johac::Error::ResponseError)
-    end
+    protected
 
     def response?
       response != nil

data/lib/johac/version.rb

@@ -1,3 +1,3 @@
 module Johac
-  Version = '0.9.0'
+  Version = '0.9.1'
 end

data/lib/johac.rb

@@ -18,7 +18,7 @@ module Johac
     # @attr access_key  [String] Public access key used for authorization of requests.
     # @attr secret_key  [String] Private key used for authorization of requests.
     # @attr env         [String] Environment. 'testing', 'development', or 'production'.
-    Config = Struct.new(:base_uri, :auth_scheme, :access_key, :secret_key, :env, :logger, :raise_exceptions)
+    Config = Struct.new(:base_uri, :auth_scheme, :access_key, :secret_key, :env, :logger, :raise_exceptions, :request_tap)
 
 
     # Configure the global defaults for all clients built.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: johac
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Dan Simpson