api-blueprint 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 38b1d5ee04125207eb6da5a316050f3a19e69fba
-  data.tar.gz: a2a38cbe4ddf2eb1a608db98d020301195d9358d
+  metadata.gz: 25a22374a6b02d3b5e55d5efc2d1392d8e335a7f
+  data.tar.gz: 6ff27e1836f991f44f76aafc902306c96ca37c9d
 SHA512:
-  metadata.gz: f5fb5e027b1337c7f0b49c0bf991706a020e14ec53f32cce5cb072f09263978e16979e37ee9887b616014b7fb08660f693de1fdbfcd9091074bdd0b30d7aeaed
-  data.tar.gz: a1f2ef8f20b16495744b75912f0ec6b9a71e747a73212c5fb139ccbf9607ae084b50a93032ec6ea3673638e17d5b55df8a7851dfb0d53e87d1ac979e266a6b5c
+  metadata.gz: e8b66d7598ce288c0a792caf45a93f977134c154a7728d1bd9dca890f873a50feb81ba2176571f568833915b63c59a56e357e17aabe92d6d772ebb4f918fccfe
+  data.tar.gz: 367c4b024d79733587c6f26b78b03563a3265aa39850e34b40aec36683aeaa03e646e005849cb09aefd63e9f7b521a7b99e74f46ddf99e0e70f19388c92b34d6

data/README.md

@@ -126,7 +126,7 @@ end
 ### Config.builder
 
 When running a blueprint, after the response is returned and parsed, the result is passed to a builder, which is responsible for initializing objects from the response. The default [ApiBlueprint::Builder](https://github.com/iZettle/api-blueprint/blob/master/lib/api-blueprint/builder.rb)
- will pass the attributes from the response into the initializer for the class the blueprint was defined in.
+will pass the attributes from the response into the initializer for the class the blueprint was defined in.
 
 If you want to change the behavior of the builder, or have a complex response which needs manipulation before it should be passed to the initializer, you can define a custom builder. Custom builders must inherit from the default builder, and can override any combination of the core methods which are used to build responses; `build`, `prepare_item`, and `build_item`. Refer to the [default builder](https://github.com/iZettle/api-blueprint/blob/master/lib/api-blueprint/builder.rb) to see what those methods do.
 
@@ -171,15 +171,15 @@ If an API response includes an `errors` object, ApiBlueprint uses it to assign `
 
 Certain response statuses will also cause ApiBlueprint to behave in different ways:
 
-| HTTP Status range | Behavior |
-| ----------------- | -------- |
-| 200 - 400 | Objects are built normally, no errors raised |
-| 401 | raises `ApiBlueprint::UnauthenticatedError` |
-| 404 | raises `ApiBlueprint::NotFoundError` |
-| 402 - 499 | raises `ApiBlueprint::ClientError` |
-| 500 - 599 | raises `ApiBlueprint::ServerError` |
+| HTTP Status range | Behavior                                     |
+| ----------------- | -------------------------------------------- |
+| 200 - 400         | Objects are built normally, no errors raised |
+| 401               | raises `ApiBlueprint::UnauthenticatedError`  |
+| 404               | raises `ApiBlueprint::NotFoundError`         |
+| 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.
+Additionally, if the request has an error which prevents the request from ever receiving a response, an `ApiBlueprint::ConnectionFailed` error will be raised. If a request times out, an `ApiBlueprint::TimeoutError` error will be raised.
 
 ## Access to response headers and status codes
 

data/lib/api-blueprint.rb

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

data/lib/api-blueprint/blueprint.rb

@@ -40,6 +40,8 @@ module ApiBlueprint
       after_build.present? ? after_build.call(runner, created) : created
     rescue Faraday::ConnectionFailed
       raise ApiBlueprint::ConnectionFailed
+    rescue Faraday::TimeoutError
+      raise ApiBlueprint::TimeoutError
     end
 
     def connection

data/lib/api-blueprint/version.rb

@@ -1,3 +1,3 @@
 module ApiBlueprint
-  VERSION = '0.15.0'
+  VERSION = '0.16.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api-blueprint
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Damien Timewell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-14 00:00:00.000000000 Z
+date: 2019-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-types