api-model 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fd7712e1eb0b5faac320b38518575bfbdeaf61b8
-  data.tar.gz: 2ea94f183ad7de875863ff989327dc414d2dc54a
+  metadata.gz: b4468bee16f23aca5211838b3f54b918a0340716
+  data.tar.gz: 27a2004bc4145a4e6c71e3ae87c703b092b0c7d3
 SHA512:
-  metadata.gz: f1e74e2574025ccf61e563ca0631e855211ff6953cb36a2d4986ef8c301c8477cda1913421c66d103dc225db2f10653693feec8706cbbd989dae3a60e351f585
-  data.tar.gz: 68171597b2cb8448a10237485904d3353012196cc911d6c1cf09648e0e0e1d7f84bb5957e29ce51b4648fd995cd095bf9467c70ff26cae40ff1d385be17c4eae
+  metadata.gz: dcfae89dae5eb342dd14c6992efdd94cb2bff77582d2ede112bc3446a129225a1dd0025c4783bb7425bbe95c04518eca6e8f5d53d3a7bc2d177b994adfb45eeb
+  data.tar.gz: 6028927509a5e087babd8ad3f01d37819928a2bc39651c49a16c862bb77ea9b85c861d14560faf6f62d7b74fd69c3ec04cc04d76b35923958386c352488387cf

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    api-model (0.0.4)
+    api-model (0.1.0)
       activemodel
       activesupport
       hashie

data/README.md

@@ -30,7 +30,7 @@ Then, let's say the API endpoint /foo returned JSON which looks like `{ "name":
 Request types and params
 ------------------------
 
-There's a couple of convenience methods to make it simpler to send GET and POST requests, 
+There's a couple of convenience methods to make it simpler to send GET and POST requests,
 or you can send other request types:
 
 ```ruby
@@ -114,11 +114,29 @@ use as a builder should respond to `#build`, with the instance hash as an argume
   MyModel.get_json "/foo", { some_param: "bar" }, builder: MyCustomBuilder.new
 ```
 
+Handling validation errors in responses
+---------------------------------------
+
+ApiModel uses a bunch of Rails' ActiveModel enhancements to make it easy to use things such as validation errors.
+You can define validations in the normal ActiveModel::Validations style and check validity before posting
+to external APIs should you wish to. Or, if an external API returns errors which you would like to convert to
+ActiveModel validations, you can do that, too:
+
+```ruby
+  class Car
+    property :name
+  end
+
+  car = Car.new
+  car.set_errors_from_hash name: "cannot be blank"
+  car.errors[:name] # => ["cannot be blank"]
+```
+
 Configuring API Model
 ---------------------
 
 You can configure API model in a number of places; globally using `ApiModel::Base.api_config`, per-model
-using `MyModel.api_config`, and per-api call by passing in options in the options hash (although some 
+using `MyModel.api_config`, and per-api call by passing in options in the options hash (although some
 configuration options may not be available on the per-api call technique).
 
 ### API Host
@@ -141,7 +159,7 @@ to refer to the full url all the time.
 ```
 
 If the API response which you receive is deeply nested and you want to cut out some levels of nesting, you
-can use `json_root` to set which key objects should be built from. 
+can use `json_root` to set which key objects should be built from.
 
 You can dig down multiple levels by separating keys with a period. With the example above, say the server
 was returning JSON which looked like `{"data":{"posts":{"name":"Foo"}}}`, it would behave as if the
@@ -201,12 +219,12 @@ something like this:
 ```ruby
   class MyCustomCacheStrategy
     attr_accessor :id, :options
-    
+
     def initialize(id, options)
       @id = id
       @options = options
     end
-    
+
     def cache(&block)
       # here you can check whether you want to actually call the api by running
       # block.call, or want to find and return your cached response.

data/api-model.gemspec

@@ -2,7 +2,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "api-model"
-  s.version     = "0.0.4"
+  s.version     = "0.1.0"
   s.authors     = ["Damien Timewell"]
   s.email       = ["mail@damientimewell.com"]
   s.homepage    = "https://github.com/iZettle/api-model"

data/lib/api-model.rb

@@ -8,7 +8,8 @@ require 'ostruct'
 require 'api_model/initializer'
 require 'api_model/http_request'
 require 'api_model/response'
-require 'api_model/rest_methods'
+require 'api_model/class_methods'
+require 'api_model/instance_methods'
 require 'api_model/configuration'
 require 'api_model/cache_stategies/no_cache'
 require 'api_model/response_parser/json'
@@ -36,17 +37,9 @@ module ApiModel
     extend ActiveModel::Naming
     extend ActiveModel::Callbacks
 
-    extend RestMethods
+    extend ClassMethods
     include ConfigurationMethods
-
-    # Overrides Hashie::Trash to catch errors from trying to set properties which have not been defined
-    # and defines it automatically
-    def property_exists?(property_name)
-      super property_name
-    rescue NoMethodError
-      Log.debug "Could not set #{property_name} on #{self.class.name}. Defining it now."
-      self.class.property property_name.to_sym
-    end
+    include InstanceMethods
   end
 
 end

data/lib/api_model/{rest_methods.rb → class_methods.rb}

@@ -1,5 +1,5 @@
 module ApiModel
-  module RestMethods
+  module ClassMethods
 
     def get_json(path, params={}, options={})
       call_api :get, path, options.merge(params: params)

data/lib/api_model/instance_methods.rb

@@ -0,0 +1,28 @@
+module ApiModel
+  module InstanceMethods
+
+    # Overrides Hashie::Trash to catch errors from trying to set properties which have not been defined
+    # and defines it automatically
+    def property_exists?(property_name)
+      super property_name
+    rescue NoMethodError
+      Log.debug "Could not set #{property_name} on #{self.class.name}. Defining it now."
+      self.class.property property_name.to_sym
+    end
+
+    # Convenience method to handle error hashes and set them as ActiveModel errors on instances.
+    # Using the `obj`, you can move the errors on to child classes if needed.
+    def set_errors_from_hash(errors_hash, obj = self)
+      errors_hash.each do |field,messages|
+        if messages.is_a?(Array)
+          messages.each do |message|
+            obj.errors.add field.to_sym, message
+          end
+        else
+          obj.errors.add field.to_sym, messages
+        end
+      end
+    end
+
+  end
+end

data/spec/api-model/api_model_spec.rb

@@ -127,6 +127,27 @@ describe ApiModel do
     end
   end
 
+  describe "setting errors from a hash" do
+    let(:car) { Car.new }
+    let(:blog_post) { BlogPost.new }
+
+    it 'should assign errors from a simple hash using active model errors' do
+      car.set_errors_from_hash name: "Is invalid"
+      car.errors[:name].should eq ["Is invalid"]
+    end
+
+    it 'should assign multiple errors from an array' do
+      car.set_errors_from_hash top_speed: ["is too fast", "would break the sound barrier"]
+      car.errors[:top_speed].size.should eq 2
+    end
+
+    it 'should be possible to assign the errors to other classes' do
+      car.set_errors_from_hash({ name: "is bad" }, blog_post)
+      car.errors.size.should eq 0
+      blog_post.errors[:name].should eq ["is bad"]
+    end
+  end
+
   describe "cache_id" do
     it 'should use options and the request path to create an identifier for the cache' do
       BlogPost.cache_id("/box", params: { foo: "bar" }).should eq "/boxfoobar"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api-model
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Damien Timewell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-21 00:00:00.000000000 Z
+date: 2014-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -140,12 +140,13 @@ files:
 - api-model.gemspec
 - lib/api-model.rb
 - lib/api_model/cache_stategies/no_cache.rb
+- lib/api_model/class_methods.rb
 - lib/api_model/configuration.rb
 - lib/api_model/http_request.rb
 - lib/api_model/initializer.rb
+- lib/api_model/instance_methods.rb
 - lib/api_model/response.rb
 - lib/api_model/response_parser/json.rb
-- lib/api_model/rest_methods.rb
 - spec/api-model/api_model_spec.rb
 - spec/api-model/configuration_spec.rb
 - spec/api-model/http_request_spec.rb