api-blueprint 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3d23a188a9076e091b9ce710bad84b2bafd27723
-  data.tar.gz: e3cd015fb4cc6b563113515cb8a00f1387fe4345
+  metadata.gz: ec684c45d9e4a9a68fff3a249ccf2a55867fe871
+  data.tar.gz: a3d9ae3d1a9cb681122a854f8f71b6e1860d8cf7
 SHA512:
-  metadata.gz: 4dd0313e92b043c835515e9e970313c79d452167604560de4a988cd7a9aee672629412e990a16fc9c783039eba73bc05e8b50df3e0e735ba41143164a12500dd
-  data.tar.gz: 708aad91e765f722ad8c9fa34b47aa71887d92a3b04fa34a67564bb4d2fb1feecce368283e3e76c3cff47a95c8bd9db15179f70718ad9ddfe375f70f4ff8cb14
+  metadata.gz: 29850f1231fb34be81d8efcd579ca995741fe896ad2b0d91e4b9372c7c5d4d7e92e82d9b915bea884bafcb4b73fbbe879cb07f2c64481a7395e0158ad344516e
+  data.tar.gz: aceaf3b5c6ce9e8b052fd0968947042922701e8b05e6c29b8bea29205115ba7d4a8fa521b859c69406c9fe5692629170bf7830520ec0c5bee85beb3026b0968f

data/README.md

@@ -99,6 +99,25 @@ config.replacements = {
 }
 ```
 
+## Validation
+
+You can use [active model validations](http://guides.rubyonrails.org/active_record_validations.html) on models to validate body payloads. This is useful to pre-check user input before sending API requests. It is disabled by default, but to enable, you just need to set `validate: true` on your blueprint definitions:
+
+```ruby
+class Astronaut < ApiBlueprint::Model
+  attribute :name, Types::String
+  validates :name, presence: true
+
+  def self.send_to_space(name)
+    blueprint :post, "/space", body: { name: name }, validate: true
+  end
+end
+
+Astronaut.send_to_space(nil) # => <ActiveModel::Errors ...>
+```
+
+Behind the scenes, ApiBlueprint uses the body hash to initialize a new instance of your model, and then runs validations. If there are any errors, the API request is not run and the errors object is returned.
+
 ## Blueprint options
 
 When defining a blueprint in a model, you can pass it a number of options to set request headers, params, body, or to run code after an instance of the model has been initialized. Here's some examples:

data/lib/api-blueprint.rb

@@ -4,6 +4,7 @@ require 'dry-initializer'
 require 'faraday'
 require 'faraday_middleware'
 require 'active_model'
+require 'active_support/core_ext/hash'
 require 'addressable'
 
 require 'api-blueprint/cache'
@@ -18,4 +19,5 @@ require 'api-blueprint/collection'
 
 module ApiBlueprint
   class DefinitionError < StandardError; end
+  class BuilderError < StandardError; end
 end

data/lib/api-blueprint/blueprint.rb

@@ -24,17 +24,15 @@ module ApiBlueprint
     end
 
     def run(options = {}, runner = nil)
+      if options.delete :validate
+        result = build from: options[:body]
+        return result.errors if result.invalid?
+      end
+
       response = call_api all_request_options(options)
 
       if creates.present?
-        builder_options = {
-          body: parser.parse(response.body),
-          headers: response.headers,
-          replacements: replacements,
-          creates: creates
-        }
-
-        created = builder.new(builder_options).build
+        created = build from: response.body, headers: response.headers
       else
         created = response
       end
@@ -44,6 +42,17 @@ module ApiBlueprint
 
     private
 
+    def build(from:, headers: {})
+      builder_options = {
+        body: parser.parse(from),
+        headers: headers,
+        replacements: replacements,
+        creates: creates
+      }
+
+      builder.new(builder_options).build
+    end
+
     def call_api(options)
       connection.send options[:http_method] do |req|
         req.url options[:url]

data/lib/api-blueprint/builder.rb

@@ -22,7 +22,11 @@ module ApiBlueprint
     end
 
     def build_item(item)
-      creates.new item
+      if creates.present?
+        creates.new item
+      else
+        raise BuilderError, "To build an object, you must set #creates"
+      end
     end
 
     private

data/lib/api-blueprint/version.rb

@@ -1,3 +1,3 @@
 module ApiBlueprint
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api-blueprint
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Damien Timewell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-06 00:00:00.000000000 Z
+date: 2018-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-types
@@ -109,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: addressable
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,27 +123,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 5.1.5
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 5.1.5
-- !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: addressable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements: