api-blueprint 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c71a6912bd0d28aacda1dcc3e9270f589c27bd1a
-  data.tar.gz: c1a7c264ad6a56025a7a92bde195dc450c0a188b
+  metadata.gz: 562502f7f7f1db1dce275f3387dad4f4d5ec4443
+  data.tar.gz: 71241b573762d13fedeca6a3a2ca2e5e4fe76a45
 SHA512:
-  metadata.gz: 62c236b537499de0c80d39489c61ae7bdc86235279000a14f86aa0d3db66cacab2eada10b40b38733648263653ce7341c7aa73f75f27d00999f24484ac8169ff
-  data.tar.gz: 6142c601a95a4fa9eefb25653d1e9fc8b459591d8128241ff3ac5d1cf240189bc795a261d2d8ee9e2258fd2012af59c6a2c0e00a0080b5185fa5797dd2d28601
+  metadata.gz: 3c5e3aa626d930c43fe997dd0f80b5aa58f98c6ff11a99e43007875a72b2228b89488e0f803bdec8999812024321bbaee31ca97b2ab1889c8589099c8c2d7a9a
+  data.tar.gz: c2e8018eeb9c49f6f5b69f7a85ac5432abaad29a97e4f5385252dc502eeff8c436b24c5795a3600cafd583e1d869c7e19eb584bb21756cc57cfa658fe7b18df9

data/README.md

@@ -177,6 +177,8 @@ Certain response statuses will also cause ApiBlueprint to behave in different wa
 | 402 - 499 | raises `ApiBlueprint::ClientError` |
 | 500 - 599 | raises `ApiBlueprint::ServerError` |
 
+Additionally, if the request timesout or some other error occurs which prevents the request from ever receiving a response, an `ApiBlueprint::ConnectionFailed` error will be raised.
+
 ## Access to response headers and status codes
 
 By default, ApiBlueprint tries to set `response_headers` and `response_status` on the model which is created from an API response. `ApiBlueprint::Model` also has a convenience method `api_request_success?` which can be used to easily assert whether a response was in the 200-399 range. This makes it simple to render different responses in controllers. For example:
@@ -278,6 +280,14 @@ class AstronautsInSpace < ApiBlueprint::Model
 end
 ```
 
+## Timeouts
+
+The default request timeout is set to 5 seconds. You can change this on a per-blueprint basis by passing the `timeout` option to the blueprint:
+
+```ruby
+blueprint :get, "/endpoint", timeout: 10.seconds
+```
+
 ## 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.rb

@@ -38,6 +38,7 @@ module ApiBlueprint
 
   class DefinitionError < StandardError; end
   class BuilderError < StandardError; end
+  class ConnectionFailed < StandardError; end
   class ServerError < ResponseError; end
   class UnauthenticatedError < ResponseError; end
   class ClientError < ResponseError; end

data/lib/api-blueprint/blueprint.rb

@@ -11,6 +11,7 @@ module ApiBlueprint
     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)
+    attribute :timeout, Types::Strict::Integer.default(5)
 
     def all_request_options(options = {})
       {
@@ -37,6 +38,8 @@ module ApiBlueprint
       end
 
       after_build.present? ? after_build.call(runner, created) : created
+    rescue Faraday::ConnectionFailed
+      raise ApiBlueprint::ConnectionFailed
     end
 
     def connection
@@ -78,6 +81,7 @@ module ApiBlueprint
         req.headers.merge!({ "Content-Type": "application/json" }.merge(options[:headers]))
         req.params = options[:params]
         req.body = options[:body].to_json
+        req.options.timeout = timeout.to_i
       end
     end
 

data/lib/api-blueprint/version.rb

@@ -1,3 +1,3 @@
 module ApiBlueprint
-  VERSION = '0.10.0'
+  VERSION = '0.11.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api-blueprint
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Damien Timewell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-04 00:00:00.000000000 Z
+date: 2018-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-types