api-resource 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b9705d238f913f0554c790cfe2958570fac35ba1
-  data.tar.gz: f6038bdafafd1544a5a49bd633ba87e5ff01b9c0
+  metadata.gz: 2f52282f574b5922a5f27ee524075ea79307b3cf
+  data.tar.gz: e713e470bb8e7a4f267c25ca94caf113adcf3ffb
 SHA512:
-  metadata.gz: ec9cd10d4e3e5bc87931e9b9b69bf15f5ca266a706cf21128e5f2e9678ee119c8d82cee0d284d711a0ec457af0a3f2ab041897a584a61c9b3306e6e0c9d53a36
-  data.tar.gz: 4641956e83fcb957bb54319afb7229792eaa863aad170e6b53e23e5969f965fc782c9677cd7509b13a05d093537cc2a1ac26bcd3bf8a9101e9a69e3117c75804
+  metadata.gz: 6a23bdd034f812966a75a8c36ef5fbd5b6496c52c7f3e95971c3a9b01e16742b77acf2d8054ed262f04d3b1b8b8f3db90d12279f80538714c3f3e88e5fe9d8da
+  data.tar.gz: 22ca88e67fb933867c2fc09076b0ef31cf24e2ecab4f1595b6169518952f34b3519ff8908d6912e10445b2629ba7c9acdbaebeec883dc138885a39e3c46cb265

data/lib/api-resource/resource.rb

@@ -7,7 +7,6 @@ require 'active_support/core_ext/object/to_param'
 
 module ApiResource
   class Resource
-
     include ActiveModel::Model
     include ActiveModel::Serializers::JSON
 
@@ -34,19 +33,21 @@ module ApiResource
 
     def self.find(id)
       result = client(:get, {}, resource_name, id)
-      self.new.from_json(result)
+      json   = JSON.parse(result)
+      self.new(json['data'])
     end
 
     def self.all
       result = client(:get, {}, resource_name)
-      array  = JSON.parse(result)
-      array.map { |h| self.new(h) }
+      json  = JSON.parse(result)
+      ResourceCollection.new(json['data'], json['meta'], self)
     end
 
+
     def self.where(options, verb=:get)
       result = client(verb, *(verb==:get ? [{}, "#{resource_name}?#{options.to_param}"] : [options, resource_name]))
-      array  = JSON.parse(result)
-      array.map { |h| self.new(h) }
+      json  = JSON.parse(result)
+      ResourceCollection.new(json['data'], json['meta'], self)
     end
 
     def attributes
@@ -60,15 +61,17 @@ module ApiResource
         if respond_to? "#{key}="
           send("#{key}=", value)
         else
-          child_class = self.class.load_class(key)
-          if child_class && child_class < Resource
-            if value.is_a?(Hash)
-              child_value = child_class.new(value)
-              define_singleton_method(key) { child_value }
-            elsif value.is_a?(Array)
-              child_values = value.map { |h| child_class.new(h) }
-              define_singleton_method(key) { child_values }
-            end
+          # check for embedded resource
+          next unless value.is_a?(Hash) && value['data']
+          child_class = self.class.load_class((value['meta'] && value['meta']['type']) || key)
+          next unless child_class
+          data = value['data']
+          if data.is_a?(Hash)
+            child_value = child_class.new(data)
+            define_singleton_method(key) { child_value }
+          elsif data.is_a?(Array)
+            child_values = ResourceCollection.new(data, value['meta'], child_class)
+            define_singleton_method(key) { child_values }
           end
         end
       end
@@ -84,14 +87,15 @@ module ApiResource
       end
     end
 
-    def self.load_class(plural_resource_name)
-      plural_resource_name.to_s.singularize.classify.constantize rescue nil
-    end
-
     def self.with_parent_resource(parent_resource_id, parent_resource_name)
       result = client(:get, {}, parent_resource_name.pluralize, parent_resource_id, self.resource_name)
-      hashes = JSON.parse(result)
-      hashes.map { |h| self.new(h) }
+      json  = JSON.parse(result)
+      ResourceCollection.new(json['data'], json['meta'], self)
+    end
+
+    def self.load_class(tableized_class)
+      klass = tableized_class && tableized_class.to_s.singularize.classify.constantize rescue nil
+      klass if klass < ApiResource::Resource
     end
 
     def self.client(verb, params, *paths)
@@ -111,5 +115,18 @@ module ApiResource
       end
       req.execute
     end
+
+    class ResourceCollection
+      include Enumerable
+
+      def initialize(data, meta, klass)
+        meta.each { |k, v| self.class.class_eval { define_method(k) { v } } } if meta
+        @resources = data.map { |e| klass.new(e) }
+      end
+
+      def each(&block)
+        @resources.each(&block)
+      end
+    end
   end
 end

data/lib/api-resource/version.rb

@@ -1,3 +1,3 @@
 module ApiResource
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/spec/resource_spec.rb

@@ -16,94 +16,133 @@ RSpec.describe ApiResource::Resource do
     attr_accessor :id, :name
   end
 
+  def check_returned_array(type, expected, actual)
+    expect(actual).to be_a Enumerable
+    actual.each { |e| expect(e).to be_a type }
+    expect(actual.map { |e| e.attributes }).to match (expected[:data])
+  end
+
+  def check_returned_object(type, expected, actual, *except)
+    expect(actual).to be_a(type)
+    expect(actual.attributes).to match(expected[:data].except(*except))
+  end
+
+  before do
+    @expected_resources = { data: [{ id: 1257, title: 'Hello' },
+                                   { id: 33, title: 'World' },
+                                   { id: 38, title: 'Bonjour!' }] }
+  end
   context '#find' do
+
     it 'creates the resource when found' do
-      resource_values = { 'id' => 1257, 'title' => 'Hello' }
-      resource_id     = 3
+      expected_value = { data: { id: 1257, title: 'Hello' } }
+      resource_id    = 3
       stub_request(:get, "#{Blog.base_url}/blogs/#{resource_id}").
           with(headers: { 'Accept' => 'application/json' }).
-          to_return(status: 200, body: resource_values.to_json)
-
+          to_return(status: 200, body: expected_value.to_json)
       result = Blog.find(resource_id)
-      expect(result).to be_a Blog
-      expect(result.attributes).to match (resource_values)
+      check_returned_object(Blog, expected_value, result)
     end
   end
 
   context '#all' do
-    it 'fetches all resourced' do
-      resource_values = [{ id: 1257, title: 'Hello' },
-                         { id: 33, title: 'World' },
-                         { id: 38, title: 'Bonjour!' }]
 
+    it 'fetches all resources' do
       stub_request(:get, "#{Blog.base_url}/blogs").
           with(headers: { 'Accept' => 'application/json' }).
-          to_return(status: 200, body: resource_values.to_json)
+          to_return(status: 200, body: @expected_resources.to_json)
 
-      blogs = Blog.all
-
-      expect(blogs).to be_a Array
-      blogs.each { |e| expect(e).to be_a Blog }
-      expect(blogs.map { |e| e.attributes }).to match (resource_values)
+      result = Blog.all
+      check_returned_array(Blog, @expected_resources, result)
     end
   end
 
   context '#where' do
-    before do
-      @resource_values = [{ id: 1257, title: 'Hello' },
-                          { id: 33, title: 'World' },
-                          { id: 38, title: 'Bonjour!' }]
-    end
+
     it 'fetches resourced filtered by query string with GET' do
       stub_request(:get, "#{Blog.base_url}/blogs?title=hello+world&tags%5B%5D=hello&tags%5B%5D=first&tags%5B%5D=greeting").
           with(headers: { 'Accept' => 'application/json' }).
-          to_return(status: 200, body: @resource_values.to_json)
-
-      blogs = Blog.where(title: 'hello world', tags: ['hello', 'first', 'greeting'])
+          to_return(status: 200, body: @expected_resources.to_json)
 
-      expect(blogs).to be_a Array
-      blogs.each { |e| expect(e).to be_a Blog }
-      expect(blogs.map { |e| e.attributes }).to match (@resource_values)
+      result = Blog.where(title: 'hello world', tags: ['hello', 'first', 'greeting'])
+      check_returned_array(Blog, @expected_resources, result)
     end
 
-    it 'fetches resourced filtered by query string with POST' do
+    it 'fetches resources filtered by query string with POST' do
       stub_request(:post, "#{Blog.base_url}/blogs").
           with(headers: { 'Accept' => 'application/json', 'Content-Type' => 'application/x-www-form-urlencoded' },
                body:    'title=hello%20world&tags[]=hello&tags[]=first&tags[]=greeting').
-          to_return(status: 200, body: @resource_values.to_json)
-
-      blogs = Blog.where({ title: 'hello world', tags: ['hello', 'first', 'greeting'] }, :post)
+          to_return(status: 200, body: @expected_resources.to_json)
 
-      expect(blogs).to be_a Array
-      blogs.each { |e| expect(e).to be_a Blog }
-      expect(blogs.map { |e| e.attributes }).to match (@resource_values)
+      result = Blog.where({ title: 'hello world', tags: ['hello', 'first', 'greeting'] }, :post)
+      check_returned_array(Blog, @expected_resources, result)
     end
   end
 
   context '#by_parent_resource' do
+
     it 'fetches resource nested with parent resource' do
-      resource_values = [{ id: 1257, title: 'Hello' },
-                         { id: 33, title: 'World' }]
-      resource_id     = 3
+      resource_id = 3
 
       stub_request(:get, "#{Blog.base_url}/tags/#{resource_id}/blogs").
           with(headers: { 'Accept' => 'application/json' }).
-          to_return(status: 200, body: resource_values.to_json)
-
-      blogs = Blog.by_tag(resource_id)
+          to_return(status: 200, body: @expected_resources.to_json)
 
-      expect(blogs).to be_a Array
-      blogs.each { |e| expect(e).to be_a Blog }
-      expect(blogs.map { |e| e.attributes }).to match (resource_values)
+      result = Blog.by_tag(resource_id)
+      check_returned_array(Blog, @expected_resources, result)
     end
   end
 
   context '#child_ressources' do
-    it 'has_many association with inlined json' do
-      resource_values = {
-          id:   1257, title: 'Tarte a la creme',
-          tags: [{ id: 33, name: 'food' }, { id: 39, name: 'cuisine' }]
-      }
+    context 'has_many' do
+      it 'defines a method and parses resources from inlined json array' do
+        resource_values = { data: {
+            id:   1257, title: 'Tarte a la creme',
+            tags: { data: [{ id: 33, name: 'food' }, { id: 39, name: 'cuisine' }] }
+        } }
+        resource_id     = 3
+
+        stub_request(:get, "#{Blog.base_url}/blogs/#{resource_id}").
+            with(headers: { 'Accept' => 'application/json' }).
+            to_return(status: 200, body: resource_values.to_json)
+
+        blog = Blog.find(resource_id)
+        check_returned_object(Blog, resource_values, blog, :tags)
+        check_returned_array(Tag, resource_values[:data][:tags], blog.tags)
+      end
+
+      it 'override type and retrieve meta info' do
+        resource_values = {
+            data: {
+                id:            1257,
+                title:         'Tarte a la creme',
+                my_sweet_tags: {
+                    data: [{ id: 33, name: 'food' }, { id: 39, name: 'cuisine' }],
+                    meta: { type: :tags, page: 3, per_page: 50, total: 102 }
+                }
+            }
+        }
+        resource_id     = 3
+
+        stub_request(:get, "#{Blog.base_url}/blogs/#{resource_id}").
+            with(headers: { 'Accept' => 'application/json' }).
+            to_return(status: 200, body: resource_values.to_json)
+
+        blog = Blog.find(resource_id)
+        check_returned_object(Blog, resource_values, blog, :my_sweet_tags)
+        check_returned_array(Tag, resource_values[:data][:my_sweet_tags], blog.my_sweet_tags)
+
+        expect(blog.my_sweet_tags.page).to eq(3)
+        expect(blog.my_sweet_tags.per_page).to eq(50)
+        expect(blog.my_sweet_tags.total).to eq(102)
+      end
+    end
+
+    it 'has_one association with inlined json' do
+      resource_values = { data: {
+          id:       1257, title: 'Tarte a la creme',
+          category: { data: { id: 33, name: 'Hobbies' } }
+      } }
       resource_id     = 3
 
       stub_request(:get, "#{Blog.base_url}/blogs/#{resource_id}").
@@ -111,18 +150,20 @@ RSpec.describe ApiResource::Resource do
           to_return(status: 200, body: resource_values.to_json)
 
       blog = Blog.find(resource_id)
-      expect(blog).to be_a Blog
-      expect(blog.attributes).to match(resource_values.except :tags)
-
-      tags = blog.tags
-      expect(tags).to be_a Array
-      tags.each { |e| expect(e).to be_a Tag }
-      expect(tags.map { |e| e.attributes }).to match (resource_values[:tags])
+      check_returned_object(Blog, resource_values, blog, :category)
+      check_returned_object(Category, resource_values[:data][:category], blog.category)
     end
-    it 'has_one association with inlined json' do
+
+    it 'override type from meta' do
       resource_values = {
-          id:       1257, title: 'Tarte a la creme',
-          category: { id: 33, name: 'Hobbies' }
+          data: {
+              id:            1257,
+              title:         'Tarte a la creme',
+              main_category: {
+                  data: { id: 33, name: 'Hobbies' },
+                  meta: { type: :category }
+              }
+          }
       }
       resource_id     = 3
 
@@ -131,12 +172,8 @@ RSpec.describe ApiResource::Resource do
           to_return(status: 200, body: resource_values.to_json)
 
       blog = Blog.find(resource_id)
-      expect(blog).to be_a Blog
-      expect(blog.attributes).to match(resource_values.except :category)
-
-      category = blog.category
-      expect(category).to be_a Category
-      expect(category.attributes).to match(resource_values[:category])
+      check_returned_object(Blog, resource_values, blog, :main_category)
+      check_returned_object(Category, resource_values[:data][:main_category], blog.main_category)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api-resource
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Chaker Nakhli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-09 00:00:00.000000000 Z
+date: 2015-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simple-hmac