johac 0.9.1 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 169a90352f903f25093cb174c60cabd8c592e981
-  data.tar.gz: 8549fe4832fccee67a9d32b968d9def850d6b4e2
+  metadata.gz: 9a61c39d9d7aa0e5b26e26dfb95c3fa939c2ba82
+  data.tar.gz: cb149b3ca883aecb69c3e4254c2972349d09e779
 SHA512:
-  metadata.gz: 3d75e7c155d183c0153259e937f1b7473d7fcc02320742153b9607d1cfe8612f303c00bae85a4d4ac9c157e11ade8ae4f9eeeb91ab889445c05b47f44e9398c8
-  data.tar.gz: 7f8c041c46153d817e6fde4bc20be5d04e2247f9da1c6d62762280207f9d22e02381c916a943dd4e7c4ae233200ba2d3825f1299a83cb815c476f198fb34c443
+  metadata.gz: 9d047090c1859f0219e3460d167f24f87306b29106fb46a2c18b08e430ffe2aa787dffc921fa11f871ece308bfe384e52d8ce44e0e7efc28a1b1cb0bdb4cca51
+  data.tar.gz: 89c2d34a9bacc322a2f6f4b64e053db7e94f987d8c9d68457dbcb66700c082722c91fbc74feba93c59a3bfa0870f569af595866e2a7ae738106a817b541cea6d

data/lib/johac/client.rb

@@ -17,6 +17,7 @@ module Johac
     # @param config [Johac::Config]
     def initialize(config=nil)
       @config = Johac.merged_config(config)
+      @mutex = Mutex.new
     end
 
     # Reference to +base_uri+ set on {Johac.config} in {Johac.configure} or in the constructor.
@@ -34,6 +35,44 @@ module Johac
       config.env
     end
 
+    # Produce curls commands for captured requests made, within the block
+    #
+    # @param [Block] the block which invokes one or more requests
+    # @return [String] requests which were captured as curl commands
+    def curl_capture(&block)
+      capture(&block).map { |env|
+        output = []
+        output << "curl -s -X#{env.method.to_s.upcase}"
+        env.request_headers.each { |name, value|
+          output << "-H'#{name}: #{value}'"
+        }
+        output << "'#{env.url}'"
+        if env.body
+          output << '-d'
+          output << "'#{env.body}'"
+        end
+        output.join(' ')
+      }
+    end
+
+    # Capture requests and prevent them from going to the remote.  Useful
+    # for testing.
+    #
+    # @param [Block] the block which invokes one or more requests
+    # @return [Array] faraday env structs which were captured in the block
+    def capture(&block)
+      result = []
+      @mutex.synchronize {
+        begin
+          connection.options.context = result
+          yield(self)
+        ensure
+          connection.options.context = nil
+        end
+      }
+      result
+    end
+
     protected
 
     def head(path, options={})
@@ -60,6 +99,8 @@ module Johac
       request { connection.patch(path, options[:body], options[:headers]) }
     end
 
+
+
     private
 
     # Wrap the response or error, or raise an exception if configured

data/lib/johac/connection.rb

@@ -22,6 +22,10 @@ module Johac
           faraday.request :request_tap, @config.request_tap
         end
 
+        # Captures requests when client calls are made
+        # within a capture block
+        faraday.request :request_capture
+
         # Retry requests
         faraday.request :retry, {
           max: 2,
@@ -111,6 +115,22 @@ module Johac
 
     end
 
+    # A request middleware that captures the request and halts the request, if
+    # the connections context isn't nil
+    class RequestCaptureMiddleware < Faraday::Middleware
+
+      Faraday::Request.register_middleware :request_capture => self
+
+      def call(env)
+        if env.request.context.kind_of?(Array)
+          env.request.context << env
+          return false
+        end
+        @app.call(env)
+      end
+
+    end
+
     # Write custom user agent to all requests.
     class RequestTapMiddleware < Faraday::Middleware
 

data/lib/johac/response.rb

@@ -1,11 +1,9 @@
 module Johac
   class Response
 
-    attr_reader :response, :exception, :body, :status
+    attr_reader :response, :exception, :body, :status, :chain
 
-    include Enumerable
-
-    def initialize(result)
+    def initialize(result, chain=[])
       if result.kind_of?(Faraday::Response)
         @response = result
       else
@@ -14,6 +12,7 @@ module Johac
 
       @body = result.body if result.respond_to?(:body)
       @status = result.status if result.respond_to?(:status)
+      @chain = chain
     end
 
     # Determine if the request failed
@@ -30,64 +29,48 @@ module Johac
       status
     end
 
-    # @return OpenStruct object of hash
+    # @return OpenStruct object of hash, or empty struct if error
     def object
-      OpenStruct.new(body)
+      if error?
+        OpenStruct.new(body)
+      else
+        OpenStruct.new
+      end
     end
 
-    # Map body hash to another value using a block
+    # Map response body if successful
     #
     # @param block [Block] mapping function block
     #
     # @return result of block
-    def map_object(&block)
-      yield body
-    end
-
-    # Dig for a item in the body
-    #
-    # @param args [Varargs] path of value
-    #
-    # @see {Hash.dig}
-    #
-    # @return value of key path
-    def dig(*args)
-      body.kind_of?(Hash) ? body.dig(*args) : nil
-    end
-
-    # Enumerate over response body object and return
-    # a new Response with a modified body
-    #
-    # @see {Enumerable}
-    # @param block [Block] to invoke
-    def each(&block)
-      if response?
-        body.each(&block)
+    def map(&block)
+      unless error?
+        yield body
       else
-        self
+        nil
       end
     end
 
-    # Invoke a block of code if the response fails, with
-    # the exception as the paramter.
+    # Map the exception if present
     #
     # @param block [Block] to invoke
-    def on_error(&block)
+    def map_error(&block)
       if error?
         yield exception
+      else
+        nil
       end
-      self
     end
 
-    # Invoke a block of code if the response succeeds, with the content
-    # as a parameter
+    # Dig for a item in the body
     #
-    # @param block [Block] to invoke
-    def on_success(&block)
-      unless error?
-        yield body
-      end
-      self
+    # @param args [Varargs] path of value
+    #
+    # @see {Hash.dig}
+    #
+    # @return value of key path
+    def dig(*args)
+      body.kind_of?(Hash) ? body.dig(*args) : nil
     end
 
     # Chain another request to the successful response.  The expected
@@ -104,9 +87,11 @@ module Johac
     def flat_map(&block)
       if response?
         begin
-          yield self
+          result = yield self, chain
+          result.set_chain(chain + [self])
+          result
         rescue => e
-          Response.new(e)
+          Response.new(e, chain + [self])
         end
       else
         self
@@ -120,6 +105,10 @@ module Johac
 
     protected
 
+    def set_chain(chain)
+      @chain = chain
+    end
+
     def response?
       response != nil
     end

data/lib/johac/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: johac
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.3
 platform: ruby
 authors:
 - Dan Simpson
@@ -118,14 +118,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.7.6
+        version: 0.9.11
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.7.6
+        version: 0.9.11
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -183,4 +183,3 @@ signing_key:
 specification_version: 4
 summary: JSON Over HTTP API Client
 test_files: []
-has_rdoc: true