shutl_resource 0.9.3 → 0.9.4

data/lib/shutl/resource/rest_class_methods.rb

@@ -2,12 +2,12 @@ module Shutl::Resource
   module RestClassMethods
     def find(args, params = {})
       unless args.kind_of?(Hash)
-        id = args
+        id   = args
         args = { resource_id_name => id }
       end
       auth_options = { auth: params.delete(:auth), from: params.delete(:from) }
-      url = member_url args.dup, params
-      response = get url, headers_with_auth(auth_options)
+      url          = member_url args.dup, params
+      response     = get url, headers_with_auth(auth_options)
 
 
       check_fail response, "Failed to find #{name} with the id #{id}"
@@ -24,21 +24,20 @@ module Shutl::Resource
       attributes.delete "response"
 
       response = post(
-          url,
-          {body: {@resource_name => attributes}.to_json}.
-          merge(headers_with_auth(options))
-        )
+        url,
+        { body: { @resource_name => attributes }.to_json }.merge(headers_with_auth(options))
+      )
 
       check_fail response, "Create failed"
 
-      parsed = response.parsed_response || {}
-
+      parsed     = response.parsed_response || {}
       attributes = parsed[@resource_name] || {}
+
       new_object attributes, response
     end
 
     def destroy instance, options = {}
-      message =  "Failed to destroy #{name.downcase.pluralize}"
+      message = "Failed to destroy #{name.downcase.pluralize}"
 
       perform_action(
         instance,
@@ -52,9 +51,12 @@ module Shutl::Resource
       #TODO: this is sometimes a hash and sometimes a Rest - need to rethink this
       attributes = instance.attributes rescue instance
 
-      response = perform_action instance, :put,
-        {body: {@resource_name => convert_new_id(attributes)}.to_json}.merge(headers_with_auth options),
-      "Save failed"
+      payload = {
+        body: { @resource_name => convert_new_id(attributes) }.to_json
+      }
+
+      payload_with_headers = payload.merge(headers_with_auth options)
+      response             = perform_action(instance, :put, payload, "Save failed")
 
       response.success?
     end
@@ -66,12 +68,12 @@ module Shutl::Resource
 
     def all(args = {})
       auth_options = { auth: args.delete(:auth), from: args.delete(:from) }
-      partition = args.partition {|key,value| !remote_collection_url.index(":#{key}").nil? }
+      partition    = args.partition { |key, value| !remote_collection_url.index(":#{key}").nil? }
 
-      url_args = partition.first.inject({}) { |h,pair| h[pair.first] = pair.last ; h }
-      params   = partition.last. inject({}) { |h,pair| h[pair.first] = pair.last ; h }
+      url_args = partition.first.inject({}) { |h, pair| h[pair.first] = pair.last; h }
+      params   = partition.last.inject({}) { |h, pair| h[pair.first] = pair.last; h }
 
-      url = generate_collection_url url_args, params
+      url      = generate_collection_url url_args, params
       response = get url, headers_with_auth(auth_options)
 
       check_fail response, "Failed to find all #{name.downcase.pluralize}"
@@ -94,13 +96,18 @@ module Shutl::Resource
 
       delegate :each, to: :collection
 
-      class Pagination < Struct.new(:page, :size, :total); end
+      class Pagination < Struct.new(:page,
+                                    :items_on_page,
+                                    :total_count,
+                                    :number_of_pages)
+      end
 
       def pagination
-        return unless @pagination
+        return unless @pagination.present?
         Pagination.new(@pagination['page'],
-                       @pagination['size'],
-                       @pagination['total'])
+                       @pagination['items_on_page'],
+                       @pagination['total_count'],
+                       @pagination['number_of_pages'])
       end
     end
 
@@ -134,7 +141,7 @@ module Shutl::Resource
 
     def convert_new_id attributes
       if attributes[:new_id]
-        attributes = attributes.clone.tap {|h| h[:id] = h[:new_id]; h.delete(:new_id)}
+        attributes = attributes.clone.tap { |h| h[:id] = h[:new_id]; h.delete(:new_id) }
       end
 
       attributes
@@ -143,7 +150,7 @@ module Shutl::Resource
     def add_resource_id_to args={}
       args = args.dup.with_indifferent_access
       unless args.has_key? "id"
-        args.merge!({"id" => args[resource_id_name]})
+        args.merge!({ "id" => args[resource_id_name] })
       end
       args
     end
@@ -168,17 +175,17 @@ module Shutl::Resource
 
     def headers_with_auth options = {}
       headers.tap do |h|
-       h['Authorization'] = "Bearer #{options[:auth]}" if options[:auth]
-       h['From']          = "#{options[:from]}"        if options[:from]
+        h['Authorization'] = "Bearer #{options[:auth]}" if options[:auth]
+        h['From'] = "#{options[:from]}" if options[:from]
       end
       { headers: headers }
     end
 
     def perform_action instance, verb, args, failure_message
-      attributes = instance.is_a?(Hash) ?  instance : instance.attributes
+      attributes = instance.is_a?(Hash) ? instance : instance.attributes
       attributes.delete "response" #used in debugging requests/responses
 
-      url = member_url attributes
+      url      = member_url attributes
       response = send verb, url, args
 
       check_fail response, failure_message
@@ -199,7 +206,7 @@ module Shutl::Resource
     end
 
     def check_fail response, message
-      c = response.code
+      c             = response.code
       failure_klass = case c
                       when 299 then Shutl::NoQuotesGenerated
                       when 400 then Shutl::BadRequest
@@ -250,7 +257,7 @@ module Shutl::Resource
 
     private
     def replace_args_from_pattern! args, url
-      args = args.reject! do |key,value|
+      args = args.reject! do |key, value|
         if s = url[":#{key}"]
           url.gsub!(s, value.to_s)
         end

data/lib/shutl/resource/version.rb

@@ -1,5 +1,5 @@
 module Shutl
   module Resource
-    VERSION = '0.9.3'
+    VERSION = '0.9.4'
   end
 end

data/spec/rest_resource_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe Shutl::Resource::Rest do
   let(:headers) do
-    {'Accept'=>'application/json', 'Content-Type'=>'application/json'}
+    { 'Accept' => 'application/json', 'Content-Type' => 'application/json' }
   end
 
   it 'should include the REST verb' do
@@ -12,14 +12,14 @@ describe Shutl::Resource::Rest do
     TestRest.should respond_to :delete
   end
 
-  let(:resource) { TestRest.new(a: 'a', b: 2)  }
+  let(:resource) { TestRest.new(a: 'a', b: 2) }
 
   describe '#find' do
     context 'with no arguments' do
       before do
         @request = stub_request(:get, 'http://host/test_rests/a').
-          to_return(:status => 200,
-                    :body => '{"test_rest": { "a": "a", "b": 2 }}',
+          to_return(:status  => 200,
+                    :body    => '{"test_rest": { "a": "a", "b": 2 }}',
                     :headers => headers)
       end
 
@@ -45,14 +45,14 @@ describe Shutl::Resource::Rest do
 
       Shutl::Resource.raise_exceptions_on_validation = true
       {
-        400 => Shutl::BadRequest,
-        401 => Shutl::UnauthorizedAccess,
-        403 => Shutl::ForbiddenAccess,
-        404 => Shutl::ResourceNotFound,
-        409 => Shutl::ResourceConflict,
-        410 => Shutl::ResourceGone,
-        422 => Shutl::ResourceInvalid,
-        503 => Shutl::ServiceUnavailable,
+        400      => Shutl::BadRequest,
+        401      => Shutl::UnauthorizedAccess,
+        403      => Shutl::ForbiddenAccess,
+        404      => Shutl::ResourceNotFound,
+        409      => Shutl::ResourceConflict,
+        410      => Shutl::ResourceGone,
+        422      => Shutl::ResourceInvalid,
+        503      => Shutl::ServiceUnavailable,
         501..502 => Shutl::ServerError,
         504..599 => Shutl::ServerError
       }.each do |status, exception|
@@ -62,7 +62,7 @@ describe Shutl::Resource::Rest do
               stub_request(:get, 'http://host/test_rests/b').
                 to_return(status: s.to_i)
 
-              expect(->{TestRest.find('b')}).to raise_error(exception)
+              expect(-> { TestRest.find('b') }).to raise_error(exception)
             end
           else
             stub_request(:get, 'http://host/test_rests/b').
@@ -83,7 +83,7 @@ describe Shutl::Resource::Rest do
 
     it 'should encode the url to support spaces' do
       request = stub_request(:get, 'http://host/test_rests/new%20resource').
-        to_return(:status => 200, :body => '{"test_rest": {}}',
+        to_return(:status  => 200, :body => '{"test_rest": {}}',
                   :headers => headers)
 
       TestRest.find('new resource')
@@ -110,9 +110,9 @@ describe Shutl::Resource::Rest do
 
     context 'with no arguments' do
       before do
-        body = '{
+        body     = '{
           "test_rests": [{ "a": "a", "b": 2 }],
-          "pagination":{"page": 0,"size": 1,"total": 3}
+          "pagination":{"page": 0,"items_on_page": 1,"total_count": 3, "number_of_pages": 3}
         }'
         @request = stub_request(:get, 'http://host/test_rests').
           to_return(:status => 200, :body => body, :headers => headers)
@@ -139,16 +139,17 @@ describe Shutl::Resource::Rest do
 
       it 'should provide accessor to pagination' do
         resource = TestRest.all
-        resource.pagination.page .should == 0
-        resource.pagination.size .should == 1
-        resource.pagination.total.should == 3
+        resource.pagination.page.should            == 0
+        resource.pagination.items_on_page.should   == 1
+        resource.pagination.total_count.should     == 3
+        resource.pagination.number_of_pages.should == 3
       end
 
       it 'should raise an error of the request fails' do
         stub_request(:get, 'http://host/test_rests').
           to_return(:status => 403)
 
-        lambda { TestRest.all}.should raise_error(Shutl::ForbiddenAccess)
+        lambda { TestRest.all }.should raise_error(Shutl::ForbiddenAccess)
 
       end
     end
@@ -178,13 +179,13 @@ describe Shutl::Resource::Rest do
         Shutl::Resource.raise_exceptions_on_validation = true
       end
       specify do
-        errors = {"base" => "invalid", "some_field" => "some field is invalid"}
-        body = {"errors" => errors}.to_json
+        errors = { "base" => "invalid", "some_field" => "some field is invalid" }
+        body   = { "errors" => errors }.to_json
 
         @request = stub_request(:post, 'http://host/test_rests').
           to_return(:status => 422, body: body, :headers => headers)
 
-        expect{@instance = TestRest.create}.to_not raise_error Shutl::ResourceInvalid
+        expect { @instance = TestRest.create }.to_not raise_error Shutl::ResourceInvalid
 
         @request.should have_been_requested
         @instance.should_not be_valid
@@ -208,7 +209,7 @@ describe Shutl::Resource::Rest do
 
     it 'should raise error if the remote server returns an error' do
       request = stub_post 403
-      expect(->{TestRest.create}).to raise_error Shutl::ForbiddenAccess
+      expect(-> { TestRest.create }).to raise_error Shutl::ForbiddenAccess
 
       request.should have_been_requested
     end
@@ -216,7 +217,7 @@ describe Shutl::Resource::Rest do
 
     it 'should post the header content-type: json' do
       request = stub_request(:post, 'http://host/test_rests').
-        with(:body => "{\"test_rest\":{}}", :headers => headers )
+        with(:body => "{\"test_rest\":{}}", :headers => headers)
 
       TestRest.create
 
@@ -227,13 +228,13 @@ describe Shutl::Resource::Rest do
       request = stub_request(:post, 'http://host/test_rests').
         to_return(:status => 400)
 
-      expect(->{ TestRest.create}).to raise_error(Shutl::BadRequest)
+      expect(-> { TestRest.create }).to raise_error(Shutl::BadRequest)
     end
 
 
     it 'shoud create a new ressource with the attributes' do
       request = stub_request(:post, "http://host/test_rests").
-        with(body: '{"test_rest":{"a":"a","b":"b"}}',
+        with(body:    '{"test_rest":{"a":"a","b":"b"}}',
              headers: headers)
 
       TestRest.create(a: 'a', b: 'b')
@@ -264,7 +265,7 @@ describe Shutl::Resource::Rest do
       stub_request(:delete, 'http://host/test_rests/a').
         to_return(status: 400)
 
-      expect(->{TestRest.destroy(id: 'a')}).to raise_error Shutl::BadRequest
+      expect(-> { TestRest.destroy(id: 'a') }).to raise_error Shutl::BadRequest
     end
   end
 
@@ -288,7 +289,7 @@ describe Shutl::Resource::Rest do
       stub_request(:put, 'http://host/test_rests/a').
         to_return(status: 400)
 
-      ->{resource.save}.should raise_error Shutl::BadRequest
+      -> { resource.save }.should raise_error Shutl::BadRequest
     end
 
 
@@ -307,15 +308,15 @@ describe Shutl::Resource::Rest do
       stub_request(:put, 'http://host/test_rests/a').
         to_return(status: 400)
 
-      expect(->{ resource.save }).to raise_error(Shutl::BadRequest)
+      expect(-> { resource.save }).to raise_error(Shutl::BadRequest)
     end
   end
 
   describe '#update!' do
     it 'should post the new json representation' do
       request = stub_request(:put, "http://host/test_rests/a").
-        with(:body => {test_rest:{a:"a",b:"b",id:"a"}},
-             :headers => {'Accept'=>'application/json', 'Content-Type'=>'application/json'}).
+        with(:body    => { test_rest: { a: "a", b: "b", id: "a" } },
+             :headers => { 'Accept' => 'application/json', 'Content-Type' => 'application/json' }).
         to_return(:status => 200, :body => "", :headers => {})
 
       test_resource = TestRest.new
@@ -327,8 +328,8 @@ describe Shutl::Resource::Rest do
 
     it 'should convert new_id to id in attributes' do
       request = stub_request(:put, "http://host/test_rests/a").
-        with(:body => {test_rest:{a:"a",b:"b",id:"xxx"}},
-             :headers => {'Accept'=>'application/json', 'Content-Type'=>'application/json'}).
+        with(:body    => { test_rest: { a: "a", b: "b", id: "xxx" } },
+             :headers => { 'Accept' => 'application/json', 'Content-Type' => 'application/json' }).
         to_return(:status => 200, :body => "", :headers => {})
 
       test_resource = TestRest.new
@@ -340,5 +341,4 @@ describe Shutl::Resource::Rest do
   end
 
 
-
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shutl_resource
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 0.9.4
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-12 00:00:00.000000000 Z
+date: 2013-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -171,7 +171,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2302729883022750132
+      hash: 988710357628793965
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -180,10 +180,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2302729883022750132
+      hash: 988710357628793965
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Manage Shutl Rest resource. Parse/Serialize JSON