ddy_remote_resource 0.4.4 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ccdea576090cd3a3332da5e68b203a6e2aeb3a6a
-  data.tar.gz: 26504a0d4c77d806db2a956285db344cbe0773c9
+  metadata.gz: 81623623abfc2c02eca8ba86097669fe5228e691
+  data.tar.gz: d6d96b4787ab3c8fbbc9489025da6b8fa680c3b0
 SHA512:
-  metadata.gz: d3453c43a446bdd4eb61e19524814a60fa3c0c4cd48ae69acc5a06b7968aa9303146ab7dfd7ac65be925708ef6cefa77e332aa7ed94067263d57dc3287df00cf
-  data.tar.gz: 26d4188cc4f6aab90740074fe8e48c6dfc7c3b23785efb395878456077ca366d11e40f39bec4c4091aac16bc6158bc4d5bef23c20a2d9effb1ca919e94c084d6
+  metadata.gz: 5891d80cd394f2682b5df1f1962ac676d42966d50153637a9250c0e096ae3ddce3dd1fffd979224561669c6e02bfda14ddf2da50bd1ef86575e416c024e32257
+  data.tar.gz: 93d0f8606a690a56b8fe2f319beac338735810772ba4af8d6b9179947799dd12d06cdb6d645fdc1b1399c13575413d25ec9a4880ed0986bf647254231648321e

data/lib/remote_resource/builder.rb

@@ -27,7 +27,7 @@ module RemoteResource
       private
 
       def response_hash(response_object)
-        { _response: response_object }
+        { _response: response_object, meta: response_object.sanitized_response_meta }
       end
     end
 

data/lib/remote_resource/collection.rb

@@ -4,18 +4,28 @@ module RemoteResource
 
     delegate :[], :at, :reverse, :size, to: :to_a
 
-    attr_reader :resource_klass, :resources_collection, :_response
+    attr_reader :resource_klass, :resources_collection, :meta, :_response
 
     def initialize(resource_klass, resources_collection, response_hash)
       @resource_klass       = resource_klass
       @resources_collection = resources_collection
       @response_hash        = response_hash
+      @meta                 = response_hash[:meta] || {}
       @_response            = response_hash[:_response]
     end
 
-    def each
+    def each(&block)
       if resources_collection.is_a? Array
-        resources_collection.each { |element| yield resource_klass.new element.merge(@response_hash) }
+        if defined?(@collection)
+          @collection.each(&block)
+        else
+          @collection = []
+          resources_collection.each do |element|
+            record = resource_klass.new element.merge(@response_hash)
+            @collection << record
+            yield(record)
+          end
+        end
       end
     end
 

data/lib/remote_resource/response.rb

@@ -33,6 +33,15 @@ module RemoteResource
       unpacked_parsed_response_body
     end
 
+    def sanitized_response_meta
+      return empty_hash if response_body.blank?
+      return empty_hash if parsed_response_body.blank?
+
+      return parsed_response_body['meta'] if parsed_response_body.try :has_key?, 'meta'
+
+      empty_hash
+    end
+
     def error_messages_response_body
       return empty_hash if response_body.blank?
       return empty_hash if parsed_response_body.blank?

data/lib/remote_resource/version.rb

@@ -1,3 +1,3 @@
 module RemoteResource
-  VERSION = '0.4.4'
+  VERSION = '0.4.5'
 end

data/spec/lib/remote_resource/builder_spec.rb

@@ -21,11 +21,17 @@ describe RemoteResource::Builder do
     let(:sanitized_response_body) do
       { "id" => "12", "username" => "foobar" }
     end
+    let(:sanitized_response_meta) do
+      { 'total' => '1'}
+    end
 
-    before { allow(response).to receive(:sanitized_response_body) { sanitized_response_body } }
+    before do
+      allow(response).to receive(:sanitized_response_body) { sanitized_response_body }
+      allow(response).to receive(:sanitized_response_meta) { sanitized_response_meta }
+    end
 
     it 'calls the .build_resource' do
-      expect(dummy_class).to receive(:build_resource).with sanitized_response_body, { _response: an_instance_of(RemoteResource::Response) }
+      expect(dummy_class).to receive(:build_resource).with sanitized_response_body, { _response: an_instance_of(RemoteResource::Response), meta: sanitized_response_meta }
       dummy_class.build_resource_from_response response
     end
   end
@@ -80,11 +86,17 @@ describe RemoteResource::Builder do
         { "id" => "12", "username" => "aapmies" }
       ]
     end
+    let(:sanitized_response_meta) do
+      { 'total' => '3'}
+    end
 
-    before { allow(response).to receive(:sanitized_response_body) { sanitized_response_body } }
+    before do
+      allow(response).to receive(:sanitized_response_body) { sanitized_response_body }
+      allow(response).to receive(:sanitized_response_meta) { sanitized_response_meta }
+    end
 
     it 'calls the .build_collection' do
-      expect(dummy_class).to receive(:build_collection).with sanitized_response_body, { _response: an_instance_of(RemoteResource::Response) }
+      expect(dummy_class).to receive(:build_collection).with sanitized_response_body, { _response: an_instance_of(RemoteResource::Response), meta: sanitized_response_meta }
       dummy_class.build_collection_from_response response
     end
   end
@@ -141,11 +153,17 @@ describe RemoteResource::Builder do
     let(:sanitized_response_body) do
       { "id" => "12", "username" => "foobar" }
     end
+    let(:sanitized_response_meta) do
+      { 'total' => '1'}
+    end
 
-    before { allow(response).to receive(:sanitized_response_body) { sanitized_response_body } }
+    before do
+      allow(response).to receive(:sanitized_response_body) { sanitized_response_body }
+      allow(response).to receive(:sanitized_response_meta) { sanitized_response_meta }
+    end
 
     it 'calls the #rebuild_resource' do
-      expect(dummy).to receive(:rebuild_resource).with sanitized_response_body, { _response: an_instance_of(RemoteResource::Response) }
+      expect(dummy).to receive(:rebuild_resource).with sanitized_response_body, { _response: an_instance_of(RemoteResource::Response), meta: sanitized_response_meta }
       dummy.rebuild_resource_from_response response
     end
   end

data/spec/lib/remote_resource/collection_spec.rb

@@ -16,8 +16,9 @@ describe RemoteResource::Collection do
   let(:dummy)       { dummy_class.new }
 
   let(:response) { RemoteResource::Response.new double.as_null_object }
+  let(:response_meta) { { total: '1' } }
   let(:response_hash) do
-    { _response: response }
+    { _response: response, meta: response_meta }
   end
 
   let(:resources_collection) do
@@ -91,6 +92,16 @@ describe RemoteResource::Collection do
           expect(collection[1]._response).to eql response
         end
       end
+
+      it 'returns the same objects each time' do
+        expected = collection.collect(&:object_id)
+        actual = collection.collect(&:object_id)
+
+        aggregate_failures do
+          expect(expected.length).to eq(2)
+          expect(expected).to eql(actual)
+        end
+      end
     end
 
     context 'when the resources_collection is NOT an Array' do
@@ -144,5 +155,10 @@ describe RemoteResource::Collection do
     end
   end
 
+  describe '#meta' do
+    it 'returns :meta' do
+      expect(collection.meta).to eql(response_meta)
+    end
+  end
 
 end

data/spec/lib/remote_resource/response_spec.rb

@@ -112,6 +112,59 @@ describe RemoteResource::Response do
     end
   end
 
+  describe '#sanitized_response_meta' do
+    let(:response) { described_class.new double.as_null_object }
+
+    before { allow(response).to receive(:response_body) { response_body } }
+
+    context 'when response_body is nil' do
+      let(:response_body) { nil }
+
+      it 'returns an empty Hash' do
+        expect(response.sanitized_response_meta).to eql({})
+      end
+    end
+
+    context 'when response_body is empty' do
+      let(:response_body) { '' }
+
+      it 'returns an empty Hash' do
+        expect(response.sanitized_response_meta).to eql({})
+      end
+    end
+
+    context 'when response_body is NOT parseable' do
+      let(:response_body) { 'foo' }
+
+      before { allow(JSON).to receive(:parse).and_raise JSON::ParserError }
+
+      it 'returns an empty Hash' do
+        expect(response.sanitized_response_meta).to eql({})
+      end
+    end
+
+    context 'when response_body is parseable' do
+      context 'and the connection_options contain a root_element' do
+        let(:connection_options) { { root_element: :foobar } }
+        let(:response)           { described_class.new double.as_null_object, connection_options }
+
+        let(:response_body)      { '{"foobar":{"id":"12"},"meta":{"total":"1"}}' }
+
+        it 'returns the parsed meta from root' do
+          expect(response.sanitized_response_meta).to match({ 'total' => '1' })
+        end
+      end
+
+      context 'and the connection_options do NOT contain a root_element' do
+        let(:response_body) { '{"id":"12","meta":{"total":"1"}}' }
+
+        it 'returns the parsed meta from root' do
+          expect(response.sanitized_response_meta).to match({ 'total' => '1' })
+        end
+      end
+    end
+  end
+
   describe '#error_messages_response_body' do
     let(:response) { described_class.new double.as_null_object }
 

data/spec/lib/remote_resource/version_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe RemoteResource::VERSION do
 
-  it { should eql '0.4.4' }
+  it { should eql '0.4.5' }
 end
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ddy_remote_resource
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.4.5
 platform: ruby
 authors:
 - Jan van der Pas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-30 00:00:00.000000000 Z
+date: 2016-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler