api-resource 0.5.5 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6e0b3e5f0c0998f062cdd1657844dacc73edb38f
-  data.tar.gz: 6dcbfddbc124e80bd22f047eec0de88c118bcb36
+  metadata.gz: e3dab8e5d2531d7f27d4034f61818e59037d4b23
+  data.tar.gz: b2a85b96d4c0a9bcfdacef705f89bf6c355b626f
 SHA512:
-  metadata.gz: 29a70f2851bf3dce62764ce8ada3bd055e909b028ea470275340d187c8431c8c5853737c6807209390d7178e2785a74e85374cdf99f691fbe0ef157453434331
-  data.tar.gz: e5b8bfb0c3d49809300f25b013d865b9cdb7818dd9ab3a33cc92aba17b2e410dbbd35d01fa351d5b7ebe279d01c57a90229c5134ccc70394346b868a5462d8ac
+  metadata.gz: a8c31ce73a48fbb84b298bf85e1748e428b89a2b668ebc0a0a736c764d25eba665f3b91674146bb1c5b76c93b5087c8d1e55fcfcd464f56565df507b523d5701
+  data.tar.gz: 559e1cae1d406f0fee084820137e6ea5ff74a18eaf889fafcb11bb54e23bc5d60afe024bf2df89fc89fac3a0f14fa711b74b50a271eeff645b9f60259b30e2f3

data/lib/api-resource/resource.rb

@@ -22,8 +22,12 @@ module ApiResource
     class_attribute :api_id
     class_attribute :api_secret
     class_attribute :hmac_options
-    class_attribute :submitted_attributes_filter
-    class_attribute :log
+    class_attribute :pre_submit_filter
+    class_attribute :default_id_attr
+    self.default_id_attr = :id
+    class_attribute :default_per_page
+    self.default_per_page = 500
+    class_attribute :logger
 
     def self.with_hmac(api_id, api_secret, options={})
       self.hmac         = true
@@ -33,7 +37,7 @@ module ApiResource
     end
 
     def self.filter_submitted_attributes(&block)
-      self.submitted_attributes_filter = block if block_given?
+      self.pre_submit_filter = block if block_given?
     end
 
     def initialize(hash=nil)
@@ -52,18 +56,22 @@ module ApiResource
       self.class.resource_path
     end
 
+    def resource_path=(path)
+      self.class.resource_path = path
+    end
+
     def self.find(id)
       result = client(:get, {}, resource_path, id)
       json   = JSON.parse(result)
       self.new(json['data'] || json)
     end
 
-    def self.all
-      self.where({}, :get)
+    def self.all(method=:get)
+      self.where({}, method)
     end
 
     def self.all_pages(options={})
-      options  = { page: 1, per_page: 500 }.merge(options)
+      options  = { page: 1, per_page: default_per_page }.merge(options)
       per_page = options[:per_page].to_i
       page     = options[:page].to_i
       begin
@@ -77,20 +85,20 @@ module ApiResource
       end while true
     end
 
-    def self.where(options, verb=:get)
-      result = client(verb, options, resource_path)
+    def self.where(options, method=:get)
+      result = client(method, options, resource_path)
       create_resource_collection(result)
     end
 
-    def save!
-      submit_resource(resource_path, true)
+    def save!(options={})
+      submit_resource(resource_path, true, options[:id_attr])
       self
     end
 
     def submit!(options={})
       path = options.fetch(:path, resource_path)
       type = options[:type]
-      json = submit_resource(path, false)
+      json = submit_resource(path, false, options[:id_attr])
       meta = json && json['meta']
       type ||= meta && meta['type']
       if type
@@ -101,8 +109,8 @@ module ApiResource
       end
     end
 
-    def destroy!
-      self.class.client(:delete, id, resource_path) if self.id
+    def destroy!(options={})
+      self.submit_resource(resource_path, false, options[:id_attr], :delete)
       self
     end
 
@@ -112,23 +120,6 @@ module ApiResource
 
     protected
 
-    def submit_resource(path, save_attributes=false)
-      raise ResourceError unless valid?
-      verb = respond_to?(:id) && id ? :put : :post
-      begin
-        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 json && verb == :post && save_attributes
-      end
-      json
-    end
-
     def parse_and_check_error(result)
       return nil if result.blank?
       json        = JSON.parse(result)
@@ -171,20 +162,31 @@ module ApiResource
     def self.method_missing(m, *args, &_)
       case (m)
         when /^by_(.+)/
-          with_parent_resource(args[0], $1) unless args.empty?
+          resource_path = self.resource_path
+          Class.new(self) do
+            self.resource_path = build_url($1.pluralize, args[0], resource_path)
+          end
         else
           super
       end
     end
 
-    def self.with_parent_resource(parent_resource_id, parent_resource_name)
-      parent_resource_name = parent_resource_name.pluralize
-      child_resource_path  = resource_path
-      Class.new(self) do
-        self.resource_path = build_url(parent_resource_name, parent_resource_id, child_resource_path)
+    def method_missing(m, *args, &_)
+      case m
+        when /^by_(.+)/
+          begin
+            original_path      = resource_path
+            self.resource_path = self.class.build_url($1, args[0], resource_path)
+            yield(self) if block_given?
+          ensure
+            self.resource_path = original_path
+          end
+        else
+          super
       end
     end
 
+
     def self.create_resource_collection(result)
       json = JSON.parse(result)
       ResourceCollection.new(json['data'], json['meta'], self)
@@ -196,11 +198,37 @@ module ApiResource
       klass if klass && klass < ApiResource::Resource
     end
 
-    def self.client(verb, params, *paths)
+    def submit_resource(path, save_attrs=false, id_attr=nil, method=nil)
+      raise ResourceError unless valid?
+      id_attr  = id_attr || default_id_attr
+      path     = [path]
+      attrs    = attributes
+      id_value = attrs[id_attr]
+      method   = method || (id_value.nil? ? :post : :put)
+
+      if method != :post && id_value
+        path << id_value
+        attrs.delete(id_attr)
+      end
+      attrs = {} if method == :delete
+      attrs = pre_submit_filter[attrs] if pre_submit_filter
+      begin
+        result = self.class.client(method, 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 json && method == :post && save_attrs
+      end
+      json
+    end
+
+    def self.client(method, params, *paths)
       url        = build_url(*paths)
       headers    = { accept: :json }
-      req_params = { url: url, method: verb, headers: headers }
-      if verb == :get
+      req_params = { url: url, method: method, headers: headers }
+      if method == :get
         # using #to_query instead of URI::encode_www_form to comply with rails convention for query string array values
         req_params[:url] = "#{url}?#{params.to_query}" unless params.to_query.blank?
       else
@@ -211,7 +239,7 @@ module ApiResource
         req.sign!(api_id, api_secret, hmac_options)
       end
       result = req.execute
-      logger << result
+      log << result
       result
     end
 
@@ -220,12 +248,12 @@ module ApiResource
       URI::parse(base_url).merge(paths.map { |p| "#{URI.encode p.to_s}" }.join('/')).to_s
     end
 
-    def self.logger=(param)
-      self.log = create_log(param)
+    def self.log=(param)
+      self.logger = create_log(param)
     end
 
-    def self.logger
-      self.log ||= Class.new do
+    def self.log
+      self.logger ||= Class.new do
         def <<(_)
         end
       end.new
@@ -261,6 +289,7 @@ module ApiResource
       end
     end
   end
+
   class ResourceCollection
     include Enumerable
 

data/lib/api-resource/version.rb

@@ -1,3 +1,3 @@
 module ApiResource
-  VERSION = '0.5.5'
+  VERSION = '0.6.0'
 end

data/spec/resource_spec.rb

@@ -10,6 +10,7 @@ RSpec.describe ApiResource::Resource do
 
     class Blog < Resource
       attr_accessor :id, :title
+
       def do_stuff_method
       end
     end
@@ -46,7 +47,7 @@ RSpec.describe ApiResource::Resource 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 } })
+        req(:get, "/blogs?page=#{ i+1 }&per_page=100", { data: objs, meta: { total_count: 223 } })
       end
 
       i = 1
@@ -73,6 +74,7 @@ RSpec.describe ApiResource::Resource do
     it 'creates resource with data rooted json' do
       check_found_resource(data: { id: 1257, title: 'Hello' })
     end
+
     it 'creates resource with un-rooted json' do
       check_found_resource(id: 1257, title: 'Hello')
     end
@@ -202,44 +204,66 @@ RSpec.describe ApiResource::Resource do
   end
 
   context '#save!' do
-    it 'POSTs data when id is nil' do
-      blog = BlogApi::Blog.new(title: 'hello')
-      expect(blog.id).to be_nil
-      expected_value = { data: { id: 32, title: 'hello' } }
+    let(:blog_attrs) { { id: 525, title: 'hello' } }
+    let(:blog_id) { blog_attrs[:id] }
+    let(:expected_value) { { data: blog_attrs } }
 
-      stub     = req(:post, '/blogs', expected_value, 201, { title: 'hello' })
+    it 'POSTs data when id is nil' do
+      blog     = BlogApi::Blog.new(title: 'hello')
+      stub     = req(:post, '/blogs', expected_value, 201, blog_attrs.except(:id))
       returned = blog.save!
-      expect(returned).to eq(blog)
       check_returned_object(BlogApi::Blog, expected_value, blog)
+      expect(returned).to eq(blog)
+      expect(blog.id).to eq(blog_id)
       expect(stub).to have_been_requested
     end
-    it 'PUTs data when id is not nil' do
-      blog_id = 525
-      blog    = BlogApi::Blog.new(id: blog_id, title: 'hello')
 
-      stub     = req(:put, '/blogs', nil, 204, id: blog_id.to_s, title: 'hello')
+    it 'PUTs data when id is not nil' do
+      blog     = BlogApi::Blog.new(id: blog_id, title: 'hello')
+      stub     = req(:put, "/blogs/#{blog_id}", nil, 204, blog_attrs.except(:id))
       returned = blog.save!
       expect(returned).to eq(blog)
       expect(blog.id).to eq(blog_id)
       expect(stub).to have_been_requested
     end
+
+    context '#by_resource' do
+      it 'POSTs data in parent resource context' do
+        blog_id        = 525
+        blog           = BlogApi::Blog.new(title: 'hello')
+        expected_value = { data: { id: blog_id, title: 'hello' } }
+        user_id        = 'ux345'
+
+        stub     = req(:post, "/users/#{user_id}/blogs", expected_value, 201, blog_attrs.except(:id))
+        returned = blog.by_users(user_id, &:save!)
+        check_returned_object(BlogApi::Blog, expected_value, blog)
+        expect(returned).to eq(blog)
+        expect(blog.id).to eq(blog_id)
+        expect(stub).to have_been_requested
+      end
+
+      it 'PUTs data in parent resource context when id is not nil' do
+        blog     = BlogApi::Blog.new(id: blog_id, title: 'hello')
+        user_id        = 'ux345'
+
+        stub     = req(:put, "/users/#{user_id}/blogs/#{blog_id}", nil, 204, blog_attrs.except(:id))
+        returned = blog.by_users(user_id, &:save!)
+        expect(returned).to eq(blog)
+        expect(blog.id).to eq(blog_id)
+        expect(stub).to have_been_requested
+      end
+    end
   end
 
   context '#destroy!' do
     it 'DELETEs data when id is not nil' do
-      blog     = BlogApi::Blog.new(id: 323, title: 'hello')
-      stub     = req(:delete, '/blogs', '', 204)
+      blog = BlogApi::Blog.new(id: 323, title: 'hello')
+      stub = req(:delete, "/blogs/#{blog.id}", '', 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     = BlogApi::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

metadata

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