aptible-resource 0.3.5 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8fe1293ad299a7eccf1b4138383c225b9957437d
-  data.tar.gz: 9c7ca8e1b928ee4518b213cbf3869c02d68e24a3
+  metadata.gz: 31f491541f4e8330accd97a53c1896fe7fca26e2
+  data.tar.gz: fa2f72d22a0736be3d38d61d4731e7582ef64c78
 SHA512:
-  metadata.gz: d97541a3c1e762fae33810ac916f8143b759730f12edd809a4218e9cdfd5a10c37ae0fbd0e9a3a48b1afa63072ae759c0afde9092068b93d4f4b9f4cb34590bc
-  data.tar.gz: 4ba7510ecde1e02264c534f7ac0b448f74349e26d4fcb37a964da5b31dcbde90b0b5215355006d7a52d103f94510403bbe8fe66ab6d288b0ce0c230efc1aedfb
+  metadata.gz: ea9ed96d16623b924cc4bbd463e128bab5d8ce1463a10451faa3de64be1b079c88aec56efad7ad079b7fea3877cd906c9bae5b24b2048d08ad99bdfa5f23a4a0
+  data.tar.gz: 406299c0d2a4cff3faca28f86c736374a27f38cde09ea6d050a127f74853e6d5916477d4bf03cc5feb228a4ee9cc7c8151151dbace303c8f44fab0a847c8333b

data/.travis.yml

@@ -2,4 +2,6 @@ sudo: false
 
 rvm:
   - 2.0.0
-  - jruby
+  - 2.1.0
+  - 2.2.0
+  - jruby-9.0.5.0

data/lib/aptible/resource/base.rb

@@ -38,18 +38,29 @@ module Aptible
         name.split('::').last.underscore.pluralize
       end
 
-      # rubocop:disable AbcSize
-      def self.all(options = {})
-        resource = find_by_url(options[:href] || collection_href, options)
-        return [] unless resource
-        if resource.links.key?('next')
-          options[:href] = resource.links['next'].href
-          resource.entries + all(options)
-        else
-          resource.entries
+      def self.each_page(options = {})
+        return unless block_given?
+        href = options[:href] || collection_href
+        while href
+          # TODO: Breaking here is consistent with the existing behavior of
+          # .all, but it essentially swallows an error if the page you're
+          # hitting happens to 404. This should probably be addressed in an
+          # effort to make this API client more strict.
+          resource = find_by_url(href, options)
+          break if resource.nil?
+
+          yield resource.entries
+
+          next_link = resource.links['next']
+          href = next_link ? next_link.href : nil
         end
       end
-      # rubocop: enable AbcSize
+
+      def self.all(options = {})
+        out = []
+        each_page(options) { |page| out.concat page }
+        out
+      end
 
       def self.where(options = {})
         params = options.except(:token, :root, :namespace, :headers)
@@ -89,7 +100,7 @@ module Aptible
 
       # rubocop:disable PredicateName
       def self.has_many(relation)
-        define_has_many_getter(relation)
+        define_has_many_getters(relation)
         define_has_many_setter(relation)
       end
       # rubocop:enable PredicateName
@@ -126,7 +137,9 @@ module Aptible
       end
       # rubocop:enable PredicateName
 
-      def self.define_has_many_getter(relation)
+      # rubocop:disable MethodLength
+      # rubocop:disable AbcSize
+      def self.define_has_many_getters(relation)
         define_method relation do
           get unless loaded
           if (memoized = instance_variable_get("@#{relation}"))
@@ -137,7 +150,17 @@ module Aptible
             instance_variable_set("@#{relation}", depaginated)
           end
         end
+
+        define_method "each_#{relation.to_s.singularize}" do |&block|
+          return if block.nil?
+          self.class.each_page(href: links[relation].base_href,
+                               headers: headers) do |page|
+            page.each { |entry| block.call entry }
+          end
+        end
       end
+      # rubocop:enable AbcSize
+      # rubocop:enable MethodLength
 
       def self.embeds_one(relation)
         define_method relation do

data/lib/aptible/resource/version.rb

@@ -1,5 +1,5 @@
 module Aptible
   module Resource
-    VERSION = '0.3.5'
+    VERSION = '0.3.6'
   end
 end

data/spec/aptible/resource/base_spec.rb

@@ -9,6 +9,39 @@ describe Aptible::Resource::Base do
     error_response.stub(:status) { 403 }
   end
 
+  shared_context 'paginated collection' do
+    let(:urls) { ['/mainframes', '/mainframes?page=1'] }
+    let(:calls) { [] }
+
+    before do
+      pages = {}
+
+      urls.each_with_index do |url, idx|
+        collection = double("Collection for #{url}")
+        links = {}
+
+        allow(collection).to receive(:entries).and_return(["At #{url}"])
+        allow(collection).to receive(:links).and_return(links)
+
+        next_url = urls[idx + 1]
+        if next_url
+          links['next'] = HyperResource::Link.new(nil, 'href' => next_url)
+        end
+
+        pages[url] = collection
+      end
+
+      [Api, Api::Mainframe].each do |klass|
+        allow_any_instance_of(klass).to receive(:find_by_url) do |u, _|
+          calls << u
+          page = pages[u]
+          fail "Accessed unexpected URL #{u}" if page.nil?
+          page
+        end
+      end
+    end
+  end
+
   subject { Api.new }
 
   describe '.collection_href' do
@@ -33,47 +66,72 @@ describe Aptible::Resource::Base do
   end
 
   describe '.all' do
-    let(:mainframe) { double 'Mainframe' }
-    let(:collection) { double 'Api' }
+    context 'when not paginated' do
+      let(:mainframe) { double 'Mainframe' }
+      let(:collection) { double 'Api' }
 
-    before do
-      collection.stub(:entries) { [mainframe] }
-      collection.stub(:links) { Hash.new }
-      Api::Mainframe.any_instance.stub(:find_by_url) { collection }
-    end
+      before do
+        collection.stub(:entries) { [mainframe] }
+        collection.stub(:links) { Hash.new }
+        Api::Mainframe.any_instance.stub(:find_by_url) { collection }
+      end
 
-    it 'should be an array' do
-      expect(Api::Mainframe.all).to be_a Array
-    end
+      it 'should be an array' do
+        expect(Api::Mainframe.all).to be_a Array
+      end
 
-    it 'should return the root collection' do
-      expect(Api::Mainframe.all).to eq [mainframe]
-    end
+      it 'should return the root collection' do
+        expect(Api::Mainframe.all).to eq [mainframe]
+      end
 
-    it 'should pass options to the HyperResource initializer' do
-      klass = Api::Mainframe
-      options = { token: 'token' }
-      expect(klass).to receive(:new).with(options).and_return klass.new
-      Api::Mainframe.all(options)
+      it 'should pass options to the HyperResource initializer' do
+        klass = Api::Mainframe
+        options = { token: 'token' }
+        expect(klass).to receive(:new).with(options).and_return klass.new
+        Api::Mainframe.all(options)
+      end
     end
 
     context 'when paginated' do
-      before do
-        page = double('page')
-        allow(page).to receive(:href).and_return(
-          '/next/page', '/next/page', '/next/page'
-        )
-        allow(collection).to receive(:links).and_return(
-          { 'next' => page }, { 'next' => page }, {}
-        )
+      include_context 'paginated collection'
+
+      it 'should collect entries from all pages' do
+        records = Api::Mainframe.all
+        expect(records.size).to eq(2)
+        expect(records.first).to eq('At /mainframes')
+        expect(records.second).to eq('At /mainframes?page=1')
+        expect(calls).to eq(urls)
       end
 
-      it 'should collect entries on all pages' do
-        expect(Api::Mainframe.all).to eq [mainframe] + [mainframe]
+      it "should return an empty list for a URL that doesn't exist" do
+        allow_any_instance_of(Api::Mainframe).to receive(:find_by_url) { nil }
+        expect(Api::Mainframe.all).to eq([])
       end
     end
   end
 
+  describe '.each_page' do
+    include_context 'paginated collection'
+
+    it 'should iterate over all pages' do
+      pages = 0
+      Api::Mainframe.each_page { pages += 1 }
+      expect(pages).to eq(2)
+      expect(calls).to eq(urls)
+    end
+
+    it 'should find all records' do
+      records = ['At /mainframes', 'At /mainframes?page=1']
+      Api::Mainframe.each_page { |p| expect(p).to eq([records.shift]) }
+      expect(calls).to eq(urls)
+    end
+
+    it 'should not access more URLs if the consumer breaks' do
+      Api::Mainframe.each_page { break }
+      expect(calls).to eq(['/mainframes'])
+    end
+  end
+
   describe '.create' do
     let(:mainframe) { Api::Mainframe.new }
     let(:mainframes_link) { HyperResource::Link.new(href: '/mainframes') }
@@ -263,10 +321,38 @@ describe Aptible::Resource::Base do
     end
 
     describe '#{relation}s' do
-      it 'should defer to self.class.all' do
-        expect(subject.class).to receive(:all).with(href: '/mainframes',
-                                                    headers: subject.headers)
-        subject.mainframes
+      include_context 'paginated collection'
+
+      it 'should return all records' do
+        records = subject.mainframes
+
+        expect(records.size).to eq(2)
+        expect(records.first).to eq('At /mainframes')
+        expect(records.second).to eq('At /mainframes?page=1')
+        expect(calls).to eq(urls)
+      end
+    end
+
+    describe 'each_#{relation}' do
+      include_context 'paginated collection'
+
+      it 'should iterate over all records' do
+        records = []
+        subject.each_mainframe { |mainframe| records << mainframe }
+
+        expect(records.size).to eq(2)
+        expect(records.first).to eq('At /mainframes')
+        expect(records.second).to eq('At /mainframes?page=1')
+        expect(calls).to eq(urls)
+      end
+
+      it 'should stop iterating when the consumer breaks' do
+        subject.each_mainframe { |_| break }
+        expect(calls).to eq([urls[0]])
+      end
+
+      it 'should not fail if not passed a block' do
+        subject.each_mainframe
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aptible-resource
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.6
 platform: ruby
 authors:
 - Frank Macreery
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-24 00:00:00.000000000 Z
+date: 2016-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uri_template
@@ -225,7 +225,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: Foundation classes for Aptible resource server gems