api-resource 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5399345c2d2f04410d0c5d101a341c6118c4f2f3
-  data.tar.gz: b856b7ed659a37531a2c647f6f39d482e73c303e
+  metadata.gz: 75454aa3ecbcf1e99126cbfad6d289de2b134268
+  data.tar.gz: 85cd9a9492a38e315998ae2a1df4d3b4dfea64a7
 SHA512:
-  metadata.gz: 25e9c12ee00a9cb4094dd3b4bd1db79269b21ed9906e0a1f1a55f27fc0a3ec62034dff2db46256f9fe1430cadaeea85640cdc760e6e5ae784cc72f7e6e727ca5
-  data.tar.gz: 40d994e49684c47d585120f109931cb4416caec48ca156f668768ce9ac6667d1d7346df940ca6d311c9a7e4ced0930689863ab1b7f5caad90690d29c3bc86f5b
+  metadata.gz: bcaeb7fda2107f869d38c16e2ee037342dc2885388b248afd40b33bb7796ec4e6b25ab0e53f224da0d952fcb049151d1cb3c2e00ceb4ed31daa0beb158259f8d
+  data.tar.gz: 5cde687ca57ec77b89c673f93375d57f7037373e1f157664844b4823d4f18702eed854122112a561257c12af166eb33f2fe5d7d483d84e4db4bb0806d14e5e99

data/lib/api-resource/resource.rb

@@ -20,6 +20,8 @@ module ApiResource
     class_attribute :api_id
     class_attribute :api_secret
     class_attribute :hmac_options
+    class_attribute :submitted_attributes_filter
+
 
     def self.with_hmac(api_id, api_secret, options={})
       self.hmac         = true
@@ -28,24 +30,24 @@ module ApiResource
       self.hmac_options = options
     end
 
+    def self.filter_submitted_attributes(&block)
+      self.submitted_attributes_filter = block if block_given?
+    end
+
     def initialize(hash=nil)
       self.attributes = hash if hash
     end
 
     def self.resource_path
-      @resource_path || resource_name
+      @resource_path || name.to_s.tableize
     end
 
     def self.resource_path=(path)
       @resource_path = path
     end
 
-    def self.resource_name
-      name.to_s.tableize
-    end
-
-    [:resource_name, :resource_path].each do |name|
-      define_method(name) { self.class.public_send(name) }
+    def resource_path
+      self.class.resource_path
     end
 
     def self.find(id)
@@ -88,7 +90,7 @@ module ApiResource
       path = options.fetch(:path, resource_path)
       type = options[:type]
       json = submit_resource(path, false)
-      meta = json['meta']
+      meta = json && json['meta']
       type ||= meta && meta['type']
       if type
         returned_type = self.class.load_class(type)
@@ -104,7 +106,7 @@ module ApiResource
     end
 
     def attributes
-      instance_values.with_indifferent_access
+      instance_values.with_indifferent_access.except(:errors, :validation_context)
     end
 
     protected
@@ -113,13 +115,15 @@ module ApiResource
       raise ResourceError unless valid?
       verb = respond_to?(:id) && id ? :put : :post
       begin
-        result = self.class.client(verb, attributes, path)
+        attrs = attributes
+        attrs = submitted_attributes_filter[attrs] if submitted_attributes_filter
+        result = self.class.client(verb, attrs, 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
+        self.attributes = json['data'] || json if json && verb == :post && save_attributes
       end
       json
     end

data/lib/api-resource/version.rb

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

data/spec/resource_spec.rb

@@ -27,9 +27,9 @@ RSpec.describe ApiResource::Resource do
     expect(actual.attributes).to match((expected[:data] || expected).except(*except))
   end
 
-  def req(verb, path, resource, status=200)
+  def req(verb, path, resource, status=200, params=nil)
     stub_request(verb, "#{BlogResource.base_url}#{path}").
-        with(headers: { 'Accept' => 'application/json' }).
+        with(headers: { 'Accept' => 'application/json' }, body: params).
         to_return(status: status, body: resource.is_a?(String) || resource.blank? ? resource : resource.to_json)
   end
 
@@ -189,9 +189,9 @@ RSpec.describe ApiResource::Resource do
     it 'POSTs data when id is nil' do
       blog = Blog.new(title: 'hello')
       expect(blog.id).to be_nil
-      expected_value = { data: { id: 325, title: 'hello' } }
+      expected_value = { data: { id: 32, title: 'hello' } }
 
-      stub     = req(:post, '/blogs', expected_value, 201)
+      stub     = req(:post, '/blogs', expected_value, 201, { title: 'hello' })
       returned = blog.save!
       expect(returned).to eq(blog)
       check_returned_object(Blog, expected_value, blog)
@@ -201,7 +201,7 @@ RSpec.describe ApiResource::Resource do
       blog_id = 525
       blog    = Blog.new(id: blog_id, title: 'hello')
 
-      stub     = req(:put, '/blogs', nil, 204)
+      stub     = req(:put, '/blogs', nil, 204, id: blog_id.to_s, title: 'hello')
       returned = blog.save!
       expect(returned).to eq(blog)
       expect(blog.id).to eq(blog_id)
@@ -238,14 +238,15 @@ RSpec.describe ApiResource::Resource do
       attr_accessor :id, :email, :name
     end
 
-    let (:sign_up)   { SignUp.new(email: 'user@example.com', password: 'pass', password_confirmation: 'pass', name: 'Joe') }
+    let(:sign_up_data) { { email: 'user@example.com', password: 'pass', password_confirmation: 'pass', name: 'Joe' } }
+    let (:sign_up) { SignUp.new(sign_up_data) }
 
     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)
+      stub           = req(:post, '/sign_up', expected_value, 200, sign_up_data)
       returned       = sign_up.submit!
       check_returned_object(User, expected_value, returned)
       expect(stub).to have_been_requested
@@ -253,7 +254,7 @@ RSpec.describe ApiResource::Resource do
 
     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)
+      stub           = req(:post, '/sign_up', expected_value, 422, sign_up.attributes)
       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
@@ -261,10 +262,25 @@ RSpec.describe ApiResource::Resource do
 
     it 'no request if not valid' do
       sign_up.name = nil
-      stub           = req(:post, '/sign_up', nil, 422)
+      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
+  context '::filter_submit_params' do
+    class Purchase < BlogResource
+      filter_submitted_attributes do |attrs|
+        address_attrs = [:name, :street, :zip_code]
+        attrs.except(*address_attrs).merge(address: attrs.slice(*address_attrs))
+      end
+      attr_accessor :amount, :name, :street, :zip_code
+    end
+    it 'submit! filters params before being submitted' do
+      comment = Purchase.new(amount: 30, name: 'Jane', street: 'Old Street', zip_code: 'EC1Y 1BE')
+      stub    = req(:post, '/purchases', nil, 200, { amount: '30', address: { name: 'Jane', street: 'Old Street', zip_code: 'EC1Y 1BE' } })
+      comment.submit!
+      expect(stub).to 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.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Chaker Nakhli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-25 00:00:00.000000000 Z
+date: 2015-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simple-hmac