api_client_base 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2d4ac34888af5202ce65d67d0611455fd1bbe786
-  data.tar.gz: 2c7f6b11e8ad2eb056a7b2399be312ad834f8800
+  metadata.gz: b02da06373fedf97739a9ecec7942d83f7d68d1a
+  data.tar.gz: 95cfcde547f877f1699b07bc6643bcd98ede53ad
 SHA512:
-  metadata.gz: bcc5bd5089efd35cbc15146fab4dc7f48fc38ecf6b84ce41e292c827a84fca5915d7df27535add568b01ac706f52df68e1e8c921d5da47a4445d90a64c77a378
-  data.tar.gz: eba55cbe3023f372036c6b7251df20da26a0d9786ba43e6cf28c5b94b7d5a3d9065a9bb428e279bf5a37d01bbf303ad52def5c97bd85aa9ebd52b1f288fad5c8
+  metadata.gz: 90ffc1144c2886f1815cfc42e9a6dc415c0d67a33a66df07bf52ba0e8ffa6fababd5d1d5de76bb6ffdf0696681aa65ed38550a0f16d3143014e9397fa53cd1ff
+  data.tar.gz: 8efbc3bc34e4ea3d0fdd54bf7e95e82696c815d117dcdf450e1ca10a9fbeeed32ec52a265d200a4bf37adf0c3d448da8a17fc4a10c28d426f21e712756b4516d

data/CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [1.2.0] - 2017-02-22
+### Added
+- raise ArgumentError when validation schema is available and it has errors
+
 ## [1.1.0] - 2017-02-17
 ### Added
 - `Client` inherits attributes from gem namespace. No need to specify these attributes again.

data/README.md

@@ -158,6 +158,37 @@ module MyGem
 end
 ```
 
+##### Validation
+
+APIClientBase supports validation so that your calls fail early before even hitting the server. The validation library that this supports (by default, and the only one) is dry-validations.
+
+Given this request:
+
+```ruby
+module MyGem
+  class GetUserRequest
+    attribute :user_id, Integer
+  end
+end
+```
+
+Create a dry-validations schema following this pattern:
+
+```ruby
+module MyGem
+  GetUserRequestSchema = Dry::Validation.Schema do
+    required(:user_id).filled(:int?)
+  end
+end
+```
+
+This will raise an error when you call the method:
+
+```
+client = MyGem::Client.new #...
+client.get_user(user_id: nil) # -> this raises an ArgumentError "[user_id: 'must be filled']"
+```
+
 #### Responses
 
 ```ruby

data/api_client_base.gemspec

@@ -40,4 +40,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "virtus-matchers"
   spec.add_development_dependency "vcr", "~> 3.0"
   spec.add_development_dependency "webmock"
+  spec.add_development_dependency "dry-validation"
 end

data/lib/api_client_base.rb

@@ -5,6 +5,7 @@ require "active_support/inflector"
 require "gem_config"
 require "virtus"
 require "api_client_base/version"
+require "api_client_base/services/validate"
 require "api_client_base/base"
 require "api_client_base/base/class_methods"
 require "api_client_base/client"

data/lib/api_client_base/client/class_methods.rb

@@ -13,17 +13,20 @@ module APIClientBase
           response_class = namespace.const_get(response_class_name)
 
           if opts[:args].is_a?(Array)
-            request_args = opts[:args].each_with_object({}).
+            request_partial_args = opts[:args].each_with_object({}).
               with_index { |(arg, hash), i| hash[arg] = args[i] }
           else
-            request_args = args.first || {}
+            request_partial_args = args.first || {}
           end
 
           default_request_opts_method =
             self.class.api_client_base_client_options[:default_opts]
           default_request_opts = send(default_request_opts_method)
+          request_args = default_request_opts.merge(request_partial_args)
 
-          request = request_class.new(default_request_opts.merge(request_args))
+          Validate.(request_class, request_args)
+
+          request = request_class.new(request_args)
           raw_response = request.()
           response_class.new(raw_response: raw_response)
         end

data/lib/api_client_base/services/validate.rb

@@ -0,0 +1,23 @@
+module APIClientBase
+  class Validate
+
+    def self.call(klass, attrs)
+      errors = errors_of(klass, attrs)
+      fail(ArgumentError, errors.to_json) if errors.any?
+    end
+
+    private
+
+    def self.errors_of(klass, attrs)
+      schema = schema_of(klass)
+      return [] if schema.nil?
+      schema.(attrs).errors
+    end
+
+    def self.schema_of(klass)
+      "#{klass.name}Schema".constantize
+    rescue NameError
+    end
+
+  end
+end

data/lib/api_client_base/version.rb

@@ -1,3 +1,3 @@
 module APIClientBase
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_client_base
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Ramon Tayag
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-17 00:00:00.000000000 Z
+date: 2017-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -136,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-validation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Abstractions to help author API wrappers in Ruby.
 email:
 - ramon.tayag@gmail.com
@@ -163,6 +177,7 @@ files:
 - lib/api_client_base/client/class_methods.rb
 - lib/api_client_base/request.rb
 - lib/api_client_base/response.rb
+- lib/api_client_base/services/validate.rb
 - lib/api_client_base/version.rb
 homepage: https://github.com/imacchiato/api_client-ruby
 licenses: