api-resource 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6690fd3a887d05228e41156d7b4896ccba029065
-  data.tar.gz: e44f4accee730e338320003263919368b26ae5a2
+  metadata.gz: 5399345c2d2f04410d0c5d101a341c6118c4f2f3
+  data.tar.gz: b856b7ed659a37531a2c647f6f39d482e73c303e
 SHA512:
-  metadata.gz: fdd55298b58b2dead869554975cec7f7fd081e6f11912f7858bea6d552456320549b0a58d87127a1e4b1252ecb7304305dda9040ed305ee45b7f1176213ec1ff
-  data.tar.gz: 54eb3a96898c86de349ba47e704063747259277cd3bf4190e26d095a5d00be0c6ab6b0febdc1c4f1e3a61f2b3340c2744974fb2c36867414cfb9463a1393c907
+  metadata.gz: 25e9c12ee00a9cb4094dd3b4bd1db79269b21ed9906e0a1f1a55f27fc0a3ec62034dff2db46256f9fe1430cadaeea85640cdc760e6e5ae784cc72f7e6e727ca5
+  data.tar.gz: 40d994e49684c47d585120f109931cb4416caec48ca156f668768ce9ac6667d1d7346df940ca6d311c9a7e4ced0930689863ab1b7f5caad90690d29c3bc86f5b

data/lib/api-resource/resource.rb

@@ -7,6 +7,10 @@ require 'active_support/core_ext/hash/indifferent_access'
 require 'active_support/core_ext/object/to_param'
 
 module ApiResource
+
+  class ResourceError < StandardError
+  end
+
   class Resource
     include ActiveModel::Model
     include ActiveModel::Serializers::JSON
@@ -28,18 +32,30 @@ module ApiResource
       self.attributes = hash if hash
     end
 
+    def self.resource_path
+      @resource_path || resource_name
+    end
+
+    def self.resource_path=(path)
+      @resource_path = path
+    end
+
     def self.resource_name
-      self.to_s.tableize
+      name.to_s.tableize
+    end
+
+    [:resource_name, :resource_path].each do |name|
+      define_method(name) { self.class.public_send(name) }
     end
 
     def self.find(id)
-      result = client(:get, {}, resource_name, id)
+      result = client(:get, {}, resource_path, id)
       json   = JSON.parse(result)
       self.new(json['data'] || json)
     end
 
     def self.all
-      result = client(:get, {}, resource_name)
+      result = client(:get, {}, resource_path)
       create_resource_collection(result)
     end
 
@@ -59,23 +75,31 @@ module ApiResource
     end
 
     def self.where(options, verb=:get)
-      result = client(verb, options, resource_name)
+      result = client(verb, options, resource_path)
       create_resource_collection(result)
     end
 
     def save!
-      if self.id
-        self.class.client(:put, attributes, self.class.resource_name)
+      submit_resource(resource_path, true)
+      self
+    end
+
+    def submit!(options={})
+      path = options.fetch(:path, resource_path)
+      type = options[:type]
+      json = submit_resource(path, false)
+      meta = json['meta']
+      type ||= meta && meta['type']
+      if type
+        returned_type = self.class.load_class(type)
+        returned_type.new(json['data'] || json)
       else
-        result          = self.class.client(:post, attributes, self.class.resource_name)
-        json            = JSON.parse(result)
-        self.attributes = json['data'] || json
+        self
       end
-      self
     end
 
     def destroy!
-      self.class.client(:delete, id, self.class.resource_name) if self.id
+      self.class.client(:delete, id, resource_path) if self.id
       self
     end
 
@@ -85,18 +109,43 @@ module ApiResource
 
     protected
 
+    def submit_resource(path, save_attributes=false)
+      raise ResourceError unless valid?
+      verb = respond_to?(:id) && id ? :put : :post
+      begin
+        result = self.class.client(verb, attributes, path)
+      rescue RestClient::ExceptionWithResponse => e
+        result = e.http_body
+        raise ResourceError, 'Error executing request'
+      ensure
+        json            = parse_and_check_error(result)
+        self.attributes = json['data'] || json if verb == :post && save_attributes
+      end
+      json
+    end
+
+    def parse_and_check_error(result)
+      return nil if result.blank?
+      json        = JSON.parse(result)
+      errors_hash = json['errors']
+      if errors_hash.is_a?(Hash)
+        errors_hash.each { |attr, ary| ary.each { |error| errors.add(attr, error) } }
+        nil
+      else
+        json
+      end
+    end
+
     def attributes=(hash)
       hash.each do |key, value|
         if respond_to? "#{key}="
           send("#{key}=", value)
         else
-          # check for embedded resource
+          # define method for associated embedded resource(s)
           if value.is_a?(Hash)
-            meta = value['meta']
-            data = value['data'] || value
+            meta, data = value['meta'], value['data'] || value
           elsif value.is_a?(Array)
-            meta = nil
-            data = value
+            meta, data = nil, value
           else
             next
           end
@@ -124,7 +173,7 @@ module ApiResource
     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)
+      result = client(:get, {}, parent_resource_name.pluralize, parent_resource_id, resource_path)
       create_resource_collection(result)
     end
 
@@ -139,7 +188,7 @@ module ApiResource
     end
 
     def self.client(verb, params, *paths)
-      raise StandardError.new('Empty base_url') if base_url.blank?
+      raise RuntimeError, 'Empty base_url' if base_url.blank?
       url        = base_url
       url        += '/' unless url.end_with?('/')
       url        += paths.join('/')

data/lib/api-resource/version.rb

@@ -1,3 +1,3 @@
 module ApiResource
-  VERSION = '0.4.1'
+  VERSION = '0.4.2'
 end

data/spec/resource_spec.rb

@@ -30,7 +30,7 @@ RSpec.describe ApiResource::Resource do
   def req(verb, path, resource, status=200)
     stub_request(verb, "#{BlogResource.base_url}#{path}").
         with(headers: { 'Accept' => 'application/json' }).
-        to_return(status: status, body: resource === String ? resource : resource.to_json)
+        to_return(status: status, body: resource.is_a?(String) || resource.blank? ? resource : resource.to_json)
   end
 
   before do
@@ -191,7 +191,7 @@ RSpec.describe ApiResource::Resource do
       expect(blog.id).to be_nil
       expected_value = { data: { id: 325, title: 'hello' } }
 
-      stub = req(:post, '/blogs', expected_value, 201)
+      stub     = req(:post, '/blogs', expected_value, 201)
       returned = blog.save!
       expect(returned).to eq(blog)
       check_returned_object(Blog, expected_value, blog)
@@ -199,9 +199,9 @@ RSpec.describe ApiResource::Resource do
     end
     it 'PUTs data when id is not nil' do
       blog_id = 525
-      blog = Blog.new(id: blog_id, title: 'hello')
+      blog    = Blog.new(id: blog_id, title: 'hello')
 
-      stub = req(:put, '/blogs', '', 204)
+      stub     = req(:put, '/blogs', nil, 204)
       returned = blog.save!
       expect(returned).to eq(blog)
       expect(blog.id).to eq(blog_id)
@@ -211,18 +211,60 @@ RSpec.describe ApiResource::Resource do
 
   context '#destroy!' do
     it 'DELETEs data when id is not nil' do
-      blog = Blog.new(id: 323, title: 'hello')
-      stub = req(:delete, '/blogs', '', 204)
+      blog     = 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')
-      stub = req(:delete, '/blogs', '', 204)
+      blog     = Blog.new(id: nil, title: 'hello')
+      stub     = req(:delete, '/blogs', '', 204)
       returned = blog.destroy!
       expect(returned).to eq(blog)
       expect(stub).to_not have_been_requested
     end
   end
+
+  context '#submit!' do
+
+    class SignUp < BlogResource
+      self.resource_path = 'sign_up'
+      attr_accessor :email, :password, :password_confirmation, :name
+      validates :name, presence: true
+    end
+
+    class User < BlogResource
+      attr_accessor :id, :email, :name
+    end
+
+    let (:sign_up)   { SignUp.new(email: 'user@example.com', password: 'pass', password_confirmation: 'pass', name: 'Joe') }
+
+    before do
+
+    end
+    it 'uses the resource_path and uses the type in meta' do
+      expected_value = { data: { id: 3, email: 'user@example.com', name: 'Jane' }, meta: { type: 'user' } }
+      stub           = req(:post, '/sign_up', expected_value, 200)
+      returned       = sign_up.submit!
+      check_returned_object(User, expected_value, returned)
+      expect(stub).to have_been_requested
+    end
+
+    it 'sets the returned errors' do
+      expected_value = { errors: { password_confrimation: ["can't be blank"], email: ["can't be blank", 'is invalid'] } }
+      stub           = req(:post, '/sign_up', expected_value, 422)
+      expect(proc { sign_up.submit! }).to raise_error(ApiResource::ResourceError)
+      expect(sign_up.errors.messages).to match(expected_value[:errors])
+      expect(stub).to have_been_requested
+    end
+
+    it 'no request if not valid' do
+      sign_up.name = nil
+      stub           = req(:post, '/sign_up', nil, 422)
+      expect(proc { sign_up.submit! }).to raise_error(ApiResource::ResourceError)
+      expect(sign_up.errors[:name]).to be_truthy
+      expect(stub).to_not have_been_requested
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api-resource
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Chaker Nakhli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-20 00:00:00.000000000 Z
+date: 2015-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simple-hmac