pandarus 0.6.11 → 0.6.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2804b18d689e7ed8a5751319ca5b5ce58d08156d
-  data.tar.gz: e082d7f449d94767e7a32aeba1a639b6bc0fdb6b
+  metadata.gz: dc52b8c16be9219b4d254f887dce321efb1bb631
+  data.tar.gz: 3b4c28d06d6cb043f8fc0a8f6a930a8c91488941
 SHA512:
-  metadata.gz: 79112e00981e28fb37aa1ee03f31b308afc9be0bcfd0c8f73b8fc64e6d7826242be0456bdccb9fc4faa9189e5b37ed7c225844c45f6628c8386ee1b0a85d3277
-  data.tar.gz: b5095438c2d48fc7504b5317f778138b66ea44104cc68ccfda2df3314b14d28a161ae7d76bf92013a1c10dda0d55ead527c6acd19676fb1ce42542cb4f97d892
+  metadata.gz: bafb0b9104a9bae6ab7250889085fa3b44a79b35cfe706996433b76b797791ce440bffbcf51e25e4d19363d9b51876fafd5e163a75a8fa891e7eb9583756e982
+  data.tar.gz: 9cecc7f837dbafdc4ebded24998749726225e14f796f4910a4ebf99042da3e7a29ec8430676dce6ab8fd08af7fdd02009266e14a34ead6db4c4e4ccddbee78eb

data/lib/pandarus/api_base.rb

@@ -106,7 +106,7 @@ module Pandarus
     end
 
     def select_query_params(params, param_keys)
-      param_keys << :per_page
+      param_keys.concat([:per_page, :cache_pages])
       select_params(params, param_keys)
     end
 

data/lib/pandarus/remote_collection.rb

@@ -6,7 +6,8 @@ module Pandarus
       @http_client = http_client
       @target_class = target_class
       @path = path
-      @query_params = query_params
+      @cache_pages = query_params[:cache_pages].nil? ? true : query_params[:cache_pages]
+      @query_params = query_params.except(:cache_pages)
 
       @pagination_links = []
       @next_page_cache = {}
@@ -39,17 +40,24 @@ module Pandarus
 
     def first_page
       @pagination_links = []
-      @first_response ||= @http_client.get do |request|
+      response = @first_response || @http_client.get do |request|
         request.path = join_paths(base_path, @path)
         request.params = request.params.merge(@query_params) unless @query_params.empty?
       end
-      handle_response(@first_response)
+      @first_response ||= response if @cache_pages
+      handle_response(response)
     end
 
     def next_page
       key = @pagination_links.last.next
-      @next_page_cache[key] ||= @http_client.get(key)
-      handle_response @next_page_cache[key]
+      # cache_pages defaults to true, but for massive remote collections
+      # keeping everything cached will eventually eat all the available memory
+      if @cache_pages
+        @next_page_cache[key] ||= @http_client.get(key)
+        handle_response @next_page_cache[key]
+      else
+        handle_response @http_client.get(key)
+      end
     end
 
     private
@@ -62,11 +70,19 @@ module Pandarus
     def handle_response(response)
       response_links = response.env[:pagination_links]
       if response_links && !@pagination_links.any? {|existing_links| existing_links == response_links }
-        @pagination_links << response.env[:pagination_links]
+        update_pagination_links(response.env[:pagination_links])
       end
       response.body.map{|member| @target_class.new(member) }
     end
 
+    def update_pagination_links(response_pages)
+      if @cache_pages
+        @pagination_links << response_pages
+      else
+        @pagination_links = [response_pages]
+      end
+    end
+
     def base_path
       @http_client.url_prefix.path
     end

data/lib/pandarus/version.rb

@@ -1,3 +1,3 @@
 module Pandarus
-  VERSION = '0.6.11' unless defined?(Pandarus::VERSION)
+  VERSION = '0.6.12' unless defined?(Pandarus::VERSION)
 end

data/spec/lib/pandarus/remote_collection_spec.rb

@@ -40,6 +40,17 @@ module Pandarus
       it 'must fetch the first page' do
         expect(page.all?{|member| User === member}).to be_truthy
       end
+
+      it 'caches the first page by default' do
+        page
+        expect(collection.instance_variable_get(:@first_response)).to be_present
+      end
+
+      it 'does not cache the first page when page caching disabled' do
+        collection.instance_variable_set(:@cache_pages, false)
+        page
+        expect(collection.instance_variable_get(:@first_response)).to be_nil
+      end
     end
 
     describe '#to_a' do
@@ -51,6 +62,19 @@ module Pandarus
         end
       end
 
+      it 'defaults page caching to true' do
+        VCR.use_cassette('remote_collection_single_page') do
+          expect(collection.instance_variable_get(:@cache_pages)).to be_truthy
+        end
+      end
+
+      it 'set page caching to false when the proper arg is passed' do
+        VCR.use_cassette('remote_collection_single_page') do
+          collection = RemoteCollection.new(client, Section, '', {cache_pages: false})
+          expect(collection.instance_variable_get(:@cache_pages)).to be_falsey
+        end
+      end
+
       it 'must happily fetch a collection with a single page' do
         VCR.use_cassette('remote_collection_single_page') do
           collection = RemoteCollection.new(client, Section, '/v1/courses/14/sections', {})
@@ -87,6 +111,25 @@ module Pandarus
 
         expect(collection.to_a.size).to eq 21
       end
+
+      it 'properly caches page links when enabled' do
+        VCR.use_cassette('remote_collection_all_pages') do
+          array = collection.to_a
+          expect(collection.instance_variable_get(:@pagination_links).length).to eq 3
+          expect(collection.instance_variable_get(:@next_page_cache).keys.length).to eq 2
+          expect(array.size).to eq 21
+        end
+      end
+
+      it 'does not cache page links when disabled' do
+        VCR.use_cassette('remote_collection_all_pages') do
+          collection.instance_variable_set(:@cache_pages, false)
+          array = collection.to_a
+          expect(collection.instance_variable_get(:@pagination_links).length).to eq 1
+          expect(collection.instance_variable_get(:@next_page_cache)).to be_empty
+          expect(array.size).to eq 21
+        end
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pandarus
 version: !ruby/object:Gem::Version
-  version: 0.6.11
+  version: 0.6.12
 platform: ruby
 authors:
 - Duane Johnson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-28 00:00:00.000000000 Z
+date: 2017-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake