api-resource 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 23cbaeb15eab2892df46438827daafa4fab93168
-  data.tar.gz: 2a6bc12c082d02bd7938d7b57091a08afc97e05b
+  metadata.gz: 7fb25fa5e1a25eec2eca37948e5c8638d2ac17b2
+  data.tar.gz: 112ad65c7f8b3d611ac2e8e1a5781adc82736efa
 SHA512:
-  metadata.gz: 005bb30e8ab91f0aaead583e085e4468e29a7b481705ca99de2de49a19b78402ecf722cf005b91169fe0c5b665cae9ae60447a7d8b22ae111b02b668620d9c51
-  data.tar.gz: 3a8d3545b5d6ac2c4bc70ac1741d8359446686fafb762074880a27538dc7ee7ea34a30cd44ea7f14a9cf9d178bfd7247dde939a5d7e2dbd2f8605d0b22d736e0
+  metadata.gz: f4b7f563692b808b8120f3e88d5ca01b100601b354a869b9265fcdd84cf2b7661d8f2292b9950fb21bff0f06b9b16d804978e54e7966e80886ec629ae42f7edb
+  data.tar.gz: 7ebc0f1b6768180cac7fa13465e56d7acbfa20f70dc1a1d7bbc0ec6d94ea26403ba5063fd7c1e7de261f28da1a1f4b9cba1917cdb654b2cf9489151965672652

data/lib/api-resource/resource.rb

@@ -6,6 +6,7 @@ require 'active_model/model'
 require 'active_model/serializers/json'
 require 'active_support/core_ext/hash/indifferent_access'
 require 'active_support/core_ext/object/to_param'
+require 'active_support/core_ext/module/remove_method'
 
 module ApiResource
 
@@ -40,7 +41,7 @@ module ApiResource
     end
 
     def self.resource_path
-      @resource_path || name.to_s.tableize
+      @resource_path || name.to_s.tableize.split('/').last
     end
 
     def self.resource_path=(path)
@@ -148,20 +149,21 @@ module ApiResource
           # define method for associated embedded resource(s)
           if value.is_a?(Hash)
             meta, data = value['meta'], value['data'] || value
-          elsif value.is_a?(Array)
-            meta, data = nil, value
           else
-            next
+            meta, data = nil, value
           end
+
           child_class = self.class.load_class((meta && meta['type']) || key)
-          next unless child_class
-          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, meta, child_class)
-            define_singleton_method(key) { child_values }
-          end
+          child_value = if child_class && data.is_a?(Hash)
+                          child_class.new(data)
+                        elsif child_class && data.is_a?(Array)
+                          ResourceCollection.new(data, meta, child_class)
+                        else
+                          data
+                        end
+
+          self.class.remove_possible_method(key)
+          define_singleton_method(key) { child_value }
         end
       end
     end
@@ -177,7 +179,7 @@ module ApiResource
 
     def self.with_parent_resource(parent_resource_id, parent_resource_name)
       parent_resource_name = parent_resource_name.pluralize
-      child_resource_path =  resource_path
+      child_resource_path  = resource_path
       Class.new(self) do
         self.resource_path = build_url(parent_resource_name, parent_resource_id, child_resource_path)
       end
@@ -189,6 +191,7 @@ module ApiResource
     end
 
     def self.load_class(tableized_class)
+      tableized_class = name.to_s.tableize.split('/')[0...-1].push(tableized_class).join('/')
       klass = tableized_class && tableized_class.to_s.singularize.classify.constantize rescue nil
       klass if klass && klass < ApiResource::Resource
     end

data/lib/api-resource/version.rb

@@ -1,3 +1,3 @@
 module ApiResource
-  VERSION = '0.5.0'
+  VERSION = '0.5.1'
 end

data/spec/resource_spec.rb

@@ -1,19 +1,22 @@
 RSpec.describe ApiResource::Resource do
+  module BlogApi
+    class Resource < ApiResource::Resource
+      self.base_url = 'http://api.example.com'
+    end
 
-  class BlogResource < ApiResource::Resource
-    self.base_url = 'http://api.example.com'
-  end
-
-  class Category < BlogResource
-    attr_accessor :id, :name
-  end
+    class Category < Resource
+      attr_accessor :id, :name
+    end
 
-  class Blog < BlogResource
-    attr_accessor :id, :title
-  end
+    class Blog < Resource
+      attr_accessor :id, :title
+      def do_stuff_method
+      end
+    end
 
-  class Tag < BlogResource
-    attr_accessor :id, :name
+    class Tag < Resource
+      attr_accessor :id, :name
+    end
   end
 
   def check_returned_array(type, expected, actual)
@@ -24,11 +27,11 @@ RSpec.describe ApiResource::Resource do
 
   def check_returned_object(type, expected, actual, *except)
     expect(actual).to be_a(type)
-    expect(actual.attributes).to match((expected[:data] || expected).except(*except))
+    expect(actual.try(:attributes) || actual).to match((expected[:data] || expected).except(*except))
   end
 
   def req(verb, path, resource, status=200, params=nil)
-    stub_request(verb, "#{BlogResource.base_url}#{path}").
+    stub_request(verb, "#{BlogApi::Resource.base_url}#{path}").
         with(headers: { 'Accept' => 'application/json' }, body: params).
         to_return(status: status, body: resource.is_a?(String) || resource.blank? ? resource : resource.to_json)
   end
@@ -40,18 +43,18 @@ RSpec.describe ApiResource::Resource do
   end
 
   context '::all_pages' do
-    it 'retreive all pages' do
+    it 'retrieves all pages' do
       expected_values = (1..223).map { |i| { id: i, title: "Hello #{i}" } }.each_slice(100).to_a
       expected_values.each_with_index do |objs, i|
         req(:get, "/blogs?page=#{i+1}&per_page=100", { data: objs, meta: { total_count: 223 } })
       end
 
       i = 1
-      Blog.all_pages(per_page: 100) do |elts, page, per_page, total_count|
+      BlogApi::Blog.all_pages(per_page: 100) do |elts, page, per_page, total_count|
         expect(total_count).to eq(223)
         expect(page).to eq(i)
         expect(per_page).to eq(100)
-        check_returned_array(Blog, expected_values[i-1], elts)
+        check_returned_array(BlogApi::Blog, expected_values[i-1], elts)
         i += 1
         false
       end
@@ -63,8 +66,8 @@ RSpec.describe ApiResource::Resource do
     def check_found_resource(expected_value)
       resource_id = 3
       req(:get, "/blogs/#{resource_id}", expected_value)
-      result = Blog.find(resource_id)
-      check_returned_object(Blog, expected_value, result)
+      result = BlogApi::Blog.find(resource_id)
+      check_returned_object(BlogApi::Blog, expected_value, result)
     end
 
     it 'creates resource with data rooted json' do
@@ -79,8 +82,8 @@ RSpec.describe ApiResource::Resource do
 
     it 'fetches all resources' do
       req(:get, '/blogs', @expected_resources)
-      result = Blog.all
-      check_returned_array(Blog, @expected_resources, result)
+      result = BlogApi::Blog.all
+      check_returned_array(BlogApi::Blog, @expected_resources, result)
     end
   end
 
@@ -88,24 +91,24 @@ RSpec.describe ApiResource::Resource do
 
     it 'fetches resourced filtered by query string with GET' do
       req(:get, '/blogs?title=hello+world&tags%5B%5D=hello&tags%5B%5D=first&tags%5B%5D=greeting', @expected_resources)
-      result = Blog.where(title: 'hello world', tags: ['hello', 'first', 'greeting'])
-      check_returned_array(Blog, @expected_resources, result)
+      result = BlogApi::Blog.where(title: 'hello world', tags: ['hello', 'first', 'greeting'])
+      check_returned_array(BlogApi::Blog, @expected_resources, result)
     end
 
     it 'fetches resources filtered by query string with POST' do
-      stub_request(:post, "#{Blog.base_url}/blogs").
+      stub_request(:post, "#{BlogApi::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: @expected_resources.to_json)
 
-      result = Blog.where({ title: 'hello world', tags: ['hello', 'first', 'greeting'] }, :post)
-      check_returned_array(Blog, @expected_resources, result)
+      result = BlogApi::Blog.where({ title: 'hello world', tags: ['hello', 'first', 'greeting'] }, :post)
+      check_returned_array(BlogApi::Blog, @expected_resources, result)
     end
 
     it 'not add query string for empty array parameter values on GET' do
       req(:get, '/blogs', @expected_resources)
-      result = Blog.where({ tags: [] })
-      check_returned_array(Blog, @expected_resources, result)
+      result = BlogApi::Blog.where({ tags: [] })
+      check_returned_array(BlogApi::Blog, @expected_resources, result)
     end
   end
 
@@ -114,8 +117,8 @@ RSpec.describe ApiResource::Resource do
     it 'fetches resource nested with parent resource' do
       resource_id = 3
       req(:get, "/tags/#{resource_id}/blogs", @expected_resources)
-      result = Blog.by_tag(resource_id).all
-      check_returned_array(Blog, @expected_resources, result)
+      result = BlogApi::Blog.by_tag(resource_id).all
+      check_returned_array(BlogApi::Blog, @expected_resources, result)
     end
   end
 
@@ -130,10 +133,10 @@ RSpec.describe ApiResource::Resource do
         resource_values = @blog.merge(data: { relation_name => relation_values })
         resource_id     = 3
         req(:get, "/blogs/#{resource_id}", resource_values)
-        blog = Blog.find(resource_id)
-        check_returned_object(Blog, resource_values, blog, relation_name)
+        blog = BlogApi::Blog.find(resource_id)
+        check_returned_object(BlogApi::Blog, resource_values, blog, relation_name)
         expect(blog).to respond_to(relation_name)
-        check_returned_array(Tag, relation_values, blog.send(relation_name))
+        check_returned_array(BlogApi::Tag, relation_values, blog.send(relation_name))
         yield blog if block_given?
       end
 
@@ -155,25 +158,38 @@ RSpec.describe ApiResource::Resource do
       end
     end
     context 'has_one' do
-      def check_has_one(relation_name, relation_values)
-        resource_values = @blog.merge(data: { relation_name => relation_values })
-        resource_id     = 3
-        req(:get, "/blogs/#{resource_id}", resource_values)
-        blog = Blog.find(resource_id)
-        check_returned_object(Blog, resource_values, blog, relation_name)
+      let(:raw_data) { { 'foo' => 'bar', 'baz' => 3 } }
+
+      def check_has_one(relation_name, relation_values, relation_type=BlogApi::Category)
+        @blog[:data].merge!(relation_name => relation_values)
+        resource_id = 3
+        stub        = req(:get, "/blogs/#{resource_id}", @blog)
+        blog        = BlogApi::Blog.find(resource_id)
+        check_returned_object(BlogApi::Blog, @blog, blog, relation_name)
         expect(blog).to respond_to(relation_name)
-        check_returned_object(Category, relation_values, blog.send(relation_name))
+        check_returned_object(relation_type, relation_values, blog.send(relation_name))
+        expect(stub).to have_been_requested
       end
 
       it 'gets data rooted inlined json' do
         check_has_one(:category, data: @category_data)
       end
+
       it 'gets un-rooted inlined json' do
         check_has_one(:category, @category_data)
       end
+
       it 'override type from meta' do
         check_has_one(:main_category, data: { id: 33, name: 'Hobbies' }, meta: { type: :category })
       end
+
+      it 'creates method for raw types' do
+        check_has_one(:raw_attr, raw_data, Hash)
+      end
+
+      it 'replaces method with raw types' do
+        check_has_one(:do_stuff_method, raw_data, Hash)
+      end
     end
   end
 
@@ -187,19 +203,19 @@ RSpec.describe ApiResource::Resource do
 
   context '#save!' do
     it 'POSTs data when id is nil' do
-      blog = Blog.new(title: 'hello')
+      blog = BlogApi::Blog.new(title: 'hello')
       expect(blog.id).to be_nil
       expected_value = { data: { id: 32, title: 'hello' } }
 
       stub     = req(:post, '/blogs', expected_value, 201, { title: 'hello' })
       returned = blog.save!
       expect(returned).to eq(blog)
-      check_returned_object(Blog, expected_value, blog)
+      check_returned_object(BlogApi::Blog, expected_value, blog)
       expect(stub).to have_been_requested
     end
     it 'PUTs data when id is not nil' do
       blog_id = 525
-      blog    = Blog.new(id: blog_id, title: 'hello')
+      blog    = BlogApi::Blog.new(id: blog_id, title: 'hello')
 
       stub     = req(:put, '/blogs', nil, 204, id: blog_id.to_s, title: 'hello')
       returned = blog.save!
@@ -211,14 +227,14 @@ RSpec.describe ApiResource::Resource do
 
   context '#destroy!' do
     it 'DELETEs data when id is not nil' do
-      blog     = Blog.new(id: 323, title: 'hello')
+      blog     = BlogApi::Blog.new(id: 323, title: 'hello')
       stub     = req(:delete, '/blogs', '', 204)
       returned = blog.destroy!
       expect(returned).to eq(blog)
       expect(stub).to have_been_requested
     end
     it 'not DELETE data when id is nil' do
-      blog     = Blog.new(id: nil, title: 'hello')
+      blog     = BlogApi::Blog.new(id: nil, title: 'hello')
       stub     = req(:delete, '/blogs', '', 204)
       returned = blog.destroy!
       expect(returned).to eq(blog)
@@ -228,13 +244,13 @@ RSpec.describe ApiResource::Resource do
 
   context '#submit!' do
 
-    class SignUp < BlogResource
+    class SignUp < BlogApi::Resource
       self.resource_path = 'sign_up'
       attr_accessor :email, :password, :password_confirmation, :name
       validates :name, presence: true
     end
 
-    class User < BlogResource
+    class User < BlogApi::Resource
       attr_accessor :id, :email, :name
     end
 
@@ -268,8 +284,9 @@ RSpec.describe ApiResource::Resource do
       expect(stub).to_not have_been_requested
     end
   end
+
   context '::filter_submit_params' do
-    class Purchase < BlogResource
+    class Purchase < BlogApi::Resource
       filter_submitted_attributes do |attrs|
         address_attrs = [:name, :street, :zip_code]
         attrs.except(*address_attrs).merge(address: attrs.slice(*address_attrs))

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api-resource
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Chaker Nakhli