api-blueprint 0.6.5 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4bc23cc364607d2d9fd33fa1280b6368b8cb05e1
-  data.tar.gz: 93988623b8ead4352dffd1c049f10f49e6952755
+  metadata.gz: 9f6f2c0e18a173e006f4a694af709f8839420d06
+  data.tar.gz: 88458d370dfe5ee1ebc14ec619686482e558b00a
 SHA512:
-  metadata.gz: 4703e7ebddf01be27c08edb19a04289b0f273d3c4dbf26837a8c4f4262933e6a4cf51a4aa1ffefe02c69fefe174ba136d58871062e03cfbd6529cac990b581d1
-  data.tar.gz: 0e9633b76babd4de3d3bacbd82a40c9822cea4da1381eab8f5af846ff7f014f1b96c0f8e25ff290f882eea0fa882639e260de32d4693c2225c3cb39bda4c4586
+  metadata.gz: 8d2a2d17f6d6bab0de23514debb8de5f308119b5e9a74076157245e3cd98f03eac1d5fd4d63f3ffffde2779e208e8f92205cd19cb6e88f87e0a4c980c101dc24
+  data.tar.gz: 42c96d768641b2e6be0eaa4dbaba645f0a9fc0823669d06e95c1b0301e6fdb7d0e34a3e44083de0e91b97b5d705a2dfdc68c17f85e25c2fceac364fbc9b41cbd

data/README.md

@@ -224,6 +224,24 @@ blueprint :get, "/endpoint" do |runner, result|
 end
 ```
 
+## Response logging
+
+Response logging can be enabled on a per-blueprint level, or by setting `config.log_responses = true` on an `ApiBlueprint::Model`:
+
+```ruby
+class AstronautsInSpace < ApiBlueprint::Model
+  configure do |config|
+    # enable logging for all blueprints
+    config.log_responses = true
+  end
+
+  def self.fetch
+    # enable logging for just one blueprint
+    blueprint :get, "http://api.open-notify.org/astros.json", log_responses: true
+  end
+end
+```
+
 ## A note on Dry::Struct immutability
 
 Models you create use `Dry::Struct` to handle initialization and assignment. `Dry::Struct` is designed with immutability in mind, so if you need to mutate the objects you have, there are two possibilities; explicitly define an `attr_writer` for the attributes which you want to mutate, or do things the "Dry::Struct way" and use the current instance to initialize a new instance:

data/lib/api-blueprint/blueprint.rb

@@ -10,6 +10,7 @@ module ApiBlueprint
     attribute :replacements, Types::Hash.default(Hash.new)
     attribute :after_build, Types::Instance(Proc).optional
     attribute :builder, Types.Instance(ApiBlueprint::Builder).default(ApiBlueprint::Builder.new)
+    attribute :log_responses, Types::Strict::Bool.default(false)
 
     def all_request_options(options = {})
       {
@@ -38,6 +39,19 @@ module ApiBlueprint
       after_build.present? ? after_build.call(runner, created) : created
     end
 
+    def connection
+      Faraday.new do |conn|
+        conn.use ApiBlueprint::ResponseMiddleware
+        conn.response :json, content_type: /\bjson$/
+        conn.response :logger if log_responses
+
+        conn.adapter Faraday.default_adapter
+        conn.headers = {
+          "User-Agent": "ApiBlueprint"
+        }
+      end
+    end
+
     private
 
     def build(from:, headers: {}, status: nil)
@@ -63,19 +77,6 @@ module ApiBlueprint
       end
     end
 
-    def connection
-      Faraday.new do |conn|
-        conn.use ApiBlueprint::ResponseMiddleware
-        conn.response :json, content_type: /\bjson$/
-        # conn.response :logger
-
-        conn.adapter Faraday.default_adapter
-        conn.headers = {
-          "User-Agent": "ApiBlueprint"
-        }
-      end
-    end
-
     def set_errors(obj, body)
       if obj.respond_to?(:errors) && body.is_a?(Hash)
         errors = body.with_indifferent_access.fetch :errors, {}

data/lib/api-blueprint/model.rb

@@ -12,6 +12,7 @@ module ApiBlueprint
     setting :parser, Parser.new
     setting :builder, Builder.new
     setting :replacements, {}
+    setting :log_responses, false
 
     attribute :response_headers, Types::Hash.optional
     attribute :response_status, Types::Integer.optional
@@ -23,7 +24,8 @@ module ApiBlueprint
         creates: self,
         parser: config.parser,
         replacements: config.replacements,
-        builder: config.builder
+        builder: config.builder,
+        log_responses: config.log_responses
       }.merge(options)
 
       if block_given?

data/lib/api-blueprint/version.rb

@@ -1,3 +1,3 @@
 module ApiBlueprint
-  VERSION = '0.6.5'
+  VERSION = '0.7.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api-blueprint
 version: !ruby/object:Gem::Version
-  version: 0.6.5
+  version: 0.7.0
 platform: ruby
 authors:
 - Damien Timewell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-11 00:00:00.000000000 Z
+date: 2018-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-types