api-model 2.5.1 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3d7d95d480605f33ce43a9218cbe26cef96f73e7
-  data.tar.gz: 49eb448b3c170f71b93d0f987012df51250071f7
+  metadata.gz: c94f2b66c8f85cf256adbf1dfd4a3725e4ac22ab
+  data.tar.gz: c83649ded772f0f02b420d2021cfb1cce13f6ec5
 SHA512:
-  metadata.gz: 0b3e9784c55ba0d165b23b40f3d8ff5afa4be9861d09cee0ff2698c5442eccc7a910e15d1ec3c2d55fc17ad470476d36793dfcce35b2747ae0904ab6b9471721
-  data.tar.gz: c64ca14dbde963cf0e949b3ff75235119cf83a43c82e0efd6ffd2bf5f1e042bcf035344246398f172591d4acd230885cc24ab0f241c164af5ad9beb5757e98ed
+  metadata.gz: a27cd7390f3c73ac46689f45624a295f8511aa05393e656817ad20db76cea717a522c6bdf75a3b9ee2c8b48e774da75c85541dc096168eb2ea0daf0eb403d3b1
+  data.tar.gz: 3799f90cc7cae5f731689caf61765b2d060b39716c6c2bb5d972ec48f190fbf582597caa1b15cfdb61f7b16db4d89daf2f0a9a1d911f677d14b0fbd6afdb0c30

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    api-model (2.5.1)
+    api-model (2.6.0)
       activemodel (~> 4.1)
       activesupport (~> 4.1)
       hash-pipe (~> 0.0)
@@ -12,10 +12,10 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (4.2.1)
-      activesupport (= 4.2.1)
+    activemodel (4.2.2)
+      activesupport (= 4.2.2)
       builder (~> 3.1)
-    activesupport (4.2.1)
+    activesupport (4.2.2)
       i18n (~> 0.7)
       json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
@@ -38,7 +38,7 @@ GEM
     domain_name (0.5.24)
       unf (>= 0.0.5, < 1.0.0)
     equalizer (0.0.11)
-    ethon (0.7.3)
+    ethon (0.7.4)
       ffi (>= 1.3.0)
     ffi (1.9.8)
     hash-pipe (0.3.0)
@@ -47,9 +47,9 @@ GEM
       domain_name (~> 0.5)
     i18n (0.7.0)
     ice_nine (0.11.1)
-    json (1.8.2)
+    json (1.8.3)
     method_source (0.8.2)
-    minitest (5.6.1)
+    minitest (5.7.0)
     pry (0.9.12.2)
       coderay (~> 1.0.5)
       method_source (~> 0.8)
@@ -65,8 +65,8 @@ GEM
     safe_yaml (0.9.7)
     slop (3.4.6)
     thread_safe (0.3.5)
-    typhoeus (0.7.1)
-      ethon (>= 0.7.1)
+    typhoeus (0.7.2)
+      ethon (>= 0.7.4)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
     unf (0.1.4)

data/README.md

@@ -95,6 +95,22 @@ 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
 ```
 
+It is also possible to create slightly more advanced builders which can access the entire response object,
+so that they can modify the return result more directly, or add to the `metadata` object on the response.
+
+```ruby
+  class MyCustomBuilder
+    def build(response, hash)
+      response.metadata.pagination = hash["pagination"]
+      MyModel.new name: hash["name"]
+    end
+  end
+
+  result = MyModel.get_json "/foo", { some_param: "bar" }, builder: MyCustomBuilder.new
+  result.name # => whatever was in hash["name"]
+  result.metadata # => OpenStruct of values
+```
+
 Handling validation errors in responses
 ---------------------------------------
 
@@ -113,6 +129,12 @@ ActiveModel validations, you can do that, too:
   car.errors[:name] # => ["cannot be blank"]
 ```
 
+Metadata
+--------
+
+Metadata can be stored directly on the response object, even when it contains an array. By using custom builders,
+you can leverage this to store useful data such as pagination metadata (see the builders section for an example).
+
 Configuring API Model
 ---------------------
 

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     = "2.5.1"
+  s.version     = "2.6.0"
   s.authors     = ["Damien Timewell", "Erik Rothoff Andersson"]
   s.email       = ["mail@damientimewell.com", "erik.rothoff@gmail.com"]
   s.licenses    = ['MIT']

data/lib/api_model/response.rb

@@ -35,7 +35,11 @@ module ApiModel
 
     def build(builder, hash)
       if builder.respond_to? :build
-        builder.build hash
+        if builder.method(:build).arity == 2
+          builder.build self, hash
+        else
+          builder.build hash
+        end
       else
         builder.new hash
       end

data/spec/api-model/api_model_spec.rb

@@ -65,6 +65,20 @@ describe ApiModel do
         custom_built_blog_post.title.should eq "FOOBAR"
       end
     end
+
+    describe "with an advanced custom builder" do
+      let(:custom_built_blog_post) do
+        VCR.use_cassette('posts') do
+          BlogPost.get_json "http://api-model-specs.com/single_post", {}, builder: BlogPost::AdvancedCustomBuilder.new
+        end
+      end
+
+      it "should use the response object when building" do
+        custom_built_blog_post.should be_a(BlogPost)
+        custom_built_blog_post.metadata.custom_attr.should eq "Hello"
+        custom_built_blog_post.name.should eq "foo"
+      end
+    end
   end
 
   describe "using Virtus to build with attribute coercion" do

data/spec/support/mock_models/blog_post.rb

@@ -8,4 +8,11 @@ class BlogPost < ApiModel::Base
     end
   end
 
+  class AdvancedCustomBuilder
+    def build(response, hash)
+      response.metadata.custom_attr = "Hello"
+      BlogPost.new hash
+    end
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api-model
 version: !ruby/object:Gem::Version
-  version: 2.5.1
+  version: 2.6.0
 platform: ruby
 authors:
 - Damien Timewell
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-11 00:00:00.000000000 Z
+date: 2015-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport