bearcat 1.3.55 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2168e1b83a6cea7ae22cd280352d3c5865aae3811800c789cd122b6240e05ebe
-  data.tar.gz: bbd67cb26a64ba4d80f5b69a1d51514a7497b28b5cce86fe58a9a49ad4595857
+  metadata.gz: f18014e61dafe829eb0820bff31d40b886d178ebd4d67241bef32ffe1a550581
+  data.tar.gz: 8908fb0abf898a853546fdeac9211695378487f28b2508deefd5f19923cb297f
 SHA512:
-  metadata.gz: e2f98fb58293a2151fc7920ec482f2527080c0f36e36ddb18e12b828cfbc09e002899d4cc341f55b4fdf323485b89a07988229c52bcde7f0257694a2bbaf7a30
-  data.tar.gz: ee7d9d0fd7cc50ae7d8ca073e2f201cb867c72b077db922ef3607d6e1b90b541c4dda1894f3acae31ac8a1bedbdd36cf0c8cdfeb457a22bdf21a280cb74b9368
+  metadata.gz: c618cfc8ce6dc51b976f4f08bee4e0186dd0d0148dcf39245ca276602ca7260165f5eace1e2be041899a33235847564645b004b5d0a2ef742fa06603ea4b09e8
+  data.tar.gz: eee162c665db7d9edf5f071ecdd3821a26e080cc58adf0b00a4efc7022cc2b885a78803579ea5f219b5bbd416575aef774deab387d9f62e9f7bd77f69d7d3d91

data/lib/bearcat/api_array.rb

@@ -2,7 +2,7 @@ module Bearcat
   class ApiArray
     include Enumerable
 
-    attr_reader :status, :headers, :members
+    attr_reader :raw_response, :members
 
     def self.process_response(response, api_client)
       if response.body.is_a?(Array)
@@ -26,18 +26,23 @@ module Bearcat
 
     def initialize(response, api_client, array_key = nil)
       @api_client = api_client
+      @raw_response = response
       @array_key = array_key
-      @page_count = 100
+      @page_count = nil
+
       case response.status
       when 200..206
         @members = process_body(response)
-        @status = response.status
-        @headers = response.headers
-        @method = response.env[:method]
-        init_pages(@headers['Link'])
+        init_pages(headers[:link])
       end
     end
 
+    delegate :status, :headers, to: :raw_response
+
+    def method
+      raw_response.env[:method]
+    end
+
     def [](i)
       @members[i]
     end
@@ -54,71 +59,37 @@ module Bearcat
       @link_hash['next'] || @link_hash['prev']
     end
 
-    def next_page
-      load_page('next')
-    end
-
-    def prev_page
-      load_page('prev')
-    end
-
-    def first_page
-      load_page('first')
-    end
-
-    def last_page
-      load_page('last')
+    %w[next prev first last].each do |rel|
+      define_method :"#{rel}_page" do
+        load_page(rel)
+      end
     end
 
-    def each_page(page_count = 50, &block)
-      @page_count = page_count
+    def each_page(page_count = nil, &block)
       if pages?
-        response = get_page(@link_hash['first'])
-        @headers = response.headers
-        @status = response.status
-        @method = response.env[:method]
-        init_pages(@headers[:link])
-        @members = process_body(response)
-        block.call(@members)
-        while @link_hash['next'] && @members.present?
-          response = get_page(@link_hash['next'])
-          @headers = response.headers
-          @status = response.status
-          @method = response.env[:method]
+        iterate_pages(page_count) do |page_response|
           @members = process_body(response)
-          init_pages(@headers[:link])
+          break unless @members.present?
           block.call(@members)
         end
-        @link_hash = {}
       else
         block.call(@members)
       end
     end
 
-    def all_pages_each(page_count = 50, &block)
+    def all_pages_each(page_count = nil, &block)
       each_page(page_count) do |page|
         page.each &block
       end
     end
 
-    def all_pages!(page_count = 50)
+    def all_pages!(page_count = nil)
       if pages?
-        @page_count = page_count
-        response = get_page(@link_hash['first'])
-        @headers = response.headers
-        @status = response.status
-        @method = response.env[:method]
-        init_pages(@headers[:link])
-        @members = process_body(response)
-        while @link_hash['next']
-          response = get_page(@link_hash['next'])
-          @headers = response.headers
-          @status = response.status
-          @method = response.env[:method]
-          page_members = process_body(response)
+        @members = []
+        iterate_pages(page_count) do |page_response|
+          page_members = process_body(page_response)
           break unless page_members.present?
           @members.concat(page_members)
-          init_pages(@headers[:link])
         end
         @link_hash = {}
       end
@@ -127,9 +98,10 @@ module Bearcat
 
     private
 
-    def init_pages(link_header)
+    def init_pages(link_header = headers[:link])
       @link_hash = {}
-      if @headers.has_key? 'Link'
+      if headers.has_key? 'Link'
+
         links = link_header.split(/,\s?/)
 
         links.each do |link|
@@ -143,14 +115,11 @@ module Bearcat
 
     def get_page(url, params = {})
       params['per_page'] = @page_count unless params.key?('per_page') || !@page_count
-      query = URI.parse(url).query
-      p = CGI.parse(query)
-      u = url.gsub("?#{query}", '')
 
-      # strip value out of array if value is an array and key doesn't have [] (parameter is not an array parameter)
-      p.each { |k, v| p[k] = v.first if v.is_a?(Array) && k !~ /\[\]$/ }
-      # remove [] from key names, this is copied from rails' {}.transform_keys!
-      p.keys.each { |k| p[k.delete('[]')] = p.delete(k) }
+      parsed_url = URI.parse(url)
+      p = parse_url_params(parsed_url)
+      u = url.gsub("?#{parsed_url.query}", '')
+
       # merge params
       p.merge!(params)
 
@@ -166,6 +135,44 @@ module Bearcat
       end
     end
 
+    def iterate_pages(per_page = @page_count)
+      return to_enum(:iterate_pages, per_page) unless block_given?
+
+      if per_page.present? && per_page != per_page_count && @link_hash['first']
+        @page_count = per_page
+        @raw_response = response = get_page(@link_hash['first'])
+        yield response
+        init_pages(headers[:link])
+      else
+        yield @raw_response
+      end
+
+      while @link_hash['next']
+        @raw_response = response = get_page(@link_hash['next'])
+        yield response
+        init_pages(headers[:link])
+      end
+    end
+
+    def per_page_count
+      url = raw_response.env[:url]
+      query_params = parse_url_params(url)
+      query_params[:per_page]&.to_i
+    end
+
+    def parse_url_params(url)
+      url = URI.parse(url) if url.is_a?(String)
+      p = CGI.parse(url.query || '')
+      p.default = nil
+
+      # strip value out of array if value is an array and key doesn't have [] (parameter is not an array parameter)
+      p.each { |k, v| p[k] = v.first if v.is_a?(Array) && k !~ /\[\]$/ }
+      # remove [] from key names, this is copied from rails' {}.transform_keys!
+      p.keys.each { |k| p[k.delete('[]')] = p.delete(k) }
+
+      p.with_indifferent_access
+    end
+
     #TODO: This is a quick fix for JSONAPI responses if we need to do this for anything else we need to do this a better way
     def self.array_key(response)
       key = nil

data/lib/bearcat/version.rb

@@ -1,3 +1,3 @@
 module Bearcat
-  VERSION = '1.3.55' unless defined?(Bearcat::VERSION)
+  VERSION = '1.4.0' unless defined?(Bearcat::VERSION)
 end

data/spec/bearcat/api_array_spec.rb

@@ -2,8 +2,17 @@ require 'helper'
 
 describe Bearcat::ApiArray do
   let(:api_client) { double }
+  let(:response_headers) { { } }
+  let(:response_env) { { url: "https://fake.com" } }
   let(:response_body) { @response_body || [] }
-  let(:original_response) { double(body: response_body, status: 200, headers: {}, env: {}) }
+  let(:original_response) do
+    double(
+      body: response_body,
+      status: 200,
+      headers: Faraday::Utils::Headers.new(response_headers),
+      env: Faraday::Env.from(response_env)
+    )
+  end
 
   describe 'get_page' do
     let(:api_array) { described_class.process_response(original_response, api_client) }
@@ -55,6 +64,28 @@ describe Bearcat::ApiArray do
     end
   end
 
+  describe '#iterate_pages' do
+    let(:api_array) { described_class.process_response(original_response, api_client) }
+
+    let(:original_response) do
+      super().tap do |s|
+        s.headers['Link'] = [
+          '<https://fake.com?page=1>; rel="first"'
+        ].join(', ')
+      end
+    end
+
+    it 're-requests the first-page if per_page has changed' do
+      expect(api_array).to receive(:get_page).and_return(original_response)
+      api_array.send(:iterate_pages, 10).to_a
+    end
+
+    it 'yields existing first-page if per_page is unchanged' do
+      expect(api_array).not_to receive(:get_page)
+      api_array.send(:iterate_pages, nil).to_a
+    end
+  end
+
   context 'makes returned values indifferent' do
     it 'makes a Hash response indifferent' do
       @response_body = { something: 1 }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bearcat
 version: !ruby/object:Gem::Version
-  version: 1.3.55
+  version: 1.4.0
 platform: ruby
 authors:
 - Nathan Mills, Jake Sorce
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-19 00:00:00.000000000 Z
+date: 2020-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake