quiz_api_client 4.13.1 → 4.13.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ba12e6decb1a28b9587740a754e454a58c5345d28cf72632b267484bc82eab0
-  data.tar.gz: 7f7773f75f5f586abf61542bb32b013cba0c25e70feb498d709b6682b6f65f2a
+  metadata.gz: ba3c7ef7577c2eb514a0ba86c804c2b3f98ffcbad90bae29e6a0e505ab987bb4
+  data.tar.gz: 96a6091a6c5b5811bd7776871b9b0af664f3a330306a614f6b0d17662a54c6f9
 SHA512:
-  metadata.gz: 3820e1479d10ed16e76f278a741b359334af9c494fd06d3d4db93f597f7209201a4a43b7492d7c90e5d84187e12f69ca56fb0deff1e404dac91bb95a15c5ef82
-  data.tar.gz: fdc87d815718c2a0585cbe1bcc50b93c9aadcf0b18e384ab0dd000f9e619e83e89a881b70db478732e1f44d949eabcfbb5f4b4b99d9de4e9462caa36b699b6ac
+  metadata.gz: 679f371890c6fa8bbcde89b60f7eaa8bee1e379c666a7fd7e53b6869f69f9e337b45b715a2d469f2fd9f8b2e31aac6b6d7575fddee1e419c1a0b37c87bbb3922
+  data.tar.gz: ebb6c033080207b63e7d3da0d0668057e9b845c95cf43b1ffd70ec8c3da2639c2ae237ef6a1cc36db0a08244d1b92e5c1e69097aecd1c53805e4b7ed7b40009e

data/lib/quiz_api_client/http_client.rb

@@ -31,7 +31,7 @@ module QuizApiClient
     def get(path, all: false, query: {})
       return make_request :get, url_for(path), query: query unless all
 
-      make_paginated_request :get, url_for(path), query: query
+      make_paginated_request :get, url_for(path), query: sanitized_query(query, all)
     end
 
     def post(path, body = {})
@@ -52,6 +52,14 @@ module QuizApiClient
 
     private
 
+    def sanitized_query(query, all)
+      query.delete(:page) if query.key?(:page) && query[:page].nil? || all
+
+      query.delete(:per_page) if query.key?(:per_page) && query[:per_page].nil?
+
+      query
+    end
+
     def initialize_logger(log_level)
       HTTParty::Logger.add_formatter('quiz_api_client_json_formatter', QuizApiClient::JSONFormatter)
       @logger = ::Logger.new(

data/lib/quiz_api_client/services/bank_entries_service.rb

@@ -3,7 +3,7 @@ module QuizApiClient::Services
     def list(params:, token: nil, all: false)
       raise 'Bank Id Required' unless params && params[:id]
 
-      pagination_params = { page: params.delete(:page), per_page: params.delete(:per_page) }
+      pagination_params = { page: params.delete(:page), per_page: params.delete(:per_page) }.compact
       get_from_quiz_api(params: params, token: token, pagination_params: pagination_params, all: all)
     end
 

data/lib/quiz_api_client/services/quiz_entries_service.rb

@@ -23,7 +23,7 @@ module QuizApiClient::Services
     def list(params:, token: nil, all: false)
       raise 'Quiz Id Required' unless params && params[:id]
 
-      pagination_params = { page: params.delete(:page), per_page: params.delete(:per_page) }
+      pagination_params = { page: params.delete(:page), per_page: params.delete(:per_page) }.compact
       get_from_quiz_api(params: params, token: token, pagination_params: pagination_params, all: all)
     end
 

data/lib/quiz_api_client/version.rb

@@ -1,3 +1,3 @@
 module QuizApiClient
-  VERSION = '4.13.1'.freeze
+  VERSION = '4.13.3'.freeze
 end

data/spec/http_client_spec.rb

@@ -81,7 +81,17 @@ describe QuizApiClient::HttpClient do
           path = '/api/quizzes'
           stub_quiz_api path, headers: { link: link_header(path, 1, 2) }
           stub_quiz_api path, item: 2, query: { page: 2 }, headers: { link: link_header(path, 2, 2) }
-          expect(client.get('/api/quizzes', all: true)).to eq [1, 2]
+          expect(client.get('/api/quizzes', query: { page: 2 }, all: true)).to eq [1, 2]
+        end
+
+        it 'sanitizies the query param if page is nil' do
+          stub_quiz_api '/api/quizzes'
+          expect(client.get('/api/quizzes', query: { page: nil }, all: true)).to eq [1]
+        end
+
+        it 'sanitizies the query param if per_page is nil' do
+          stub_quiz_api '/api/quizzes'
+          expect(client.get('/api/quizzes', query: { per_page: nil }, all: true)).to eq [1]
         end
       end
 
@@ -102,6 +112,20 @@ describe QuizApiClient::HttpClient do
           stub_quiz_api path, item: 2, query: { my_id: 12, **dynamo_params }
           expect(client.get('/api/quizzes', query: { my_id: 12 }, all: true)).to eq [1, 2]
         end
+
+        it 'retrieves subsequent pages when all is true and sanitizes query if page is nil' do
+          path = '/api/quizzes'
+          stub_quiz_api path, query: { my_id: 12 }, headers: dynamo_headers
+          stub_quiz_api path, item: 2, query: { my_id: 12, **dynamo_params }
+          expect(client.get('/api/quizzes', query: { my_id: 12, page: nil }, all: true)).to eq [1, 2]
+        end
+
+        it 'retrieves subsequent pages when all is true and sanitizes query if per_page is nil' do
+          path = '/api/quizzes'
+          stub_quiz_api path, query: { my_id: 12 }, headers: dynamo_headers
+          stub_quiz_api path, item: 2, query: { my_id: 12, **dynamo_params }
+          expect(client.get('/api/quizzes', query: { my_id: 12, per_page: nil }, all: true)).to eq [1, 2]
+        end
       end
     end
   end

data/spec/services/bank_entries_service_spec.rb

@@ -3,24 +3,53 @@ describe QuizApiClient::Services::BankEntriesService do
   let(:config) { QuizApiClient::Config.new { |c| c.host = host } }
   let(:subject) { described_class.new(config) }
 
+  def link_header(host, path, page, last_page)
+    link_header = "<https://#{host}#{path}?page=#{last_page}>; rel=\"last\""
+    link_header += ", <https://#{host}#{path}?page=#{page + 1}>; rel=\"next\"" if page < last_page
+    link_header += ", <https://#{host}#{path}?page=#{page - 1}>; rel=\"prev\"" if page > 1
+    link_header += ", <https://#{host}#{path}?page=1>; rel=\"first\"" if page > 1
+    { link: link_header }
+  end
+
+  def stub_quiz_api(url, body, query: {}, headers: {}, status: 200)
+    stub_request(:get, url)
+      .with(query: query)
+      .to_return(
+        body: body.to_json,
+        status: status,
+        headers: headers.merge(
+          'Content-Type' => 'application/json'
+        )
+      )
+  end
+
   describe '#list' do
     let(:params) { { id: 1 } }
-    let(:stubbed_response) { { 'id' => 1, 'entry' => { 'id' => 1 } } }
-    let(:expected_url) { "https://#{host}/api/internal_services/banks/#{params[:id]}/bank_entries?page=&per_page=" }
-    let(:status_code) { 200 }
+    let(:path) { "/api/internal_services/banks/#{params[:id]}/bank_entries" }
+    let(:expected_url) { "https://#{host}#{path}" }
 
-    before do
-      stub_request(:get, expected_url)
-        .to_return(
-          status: status_code,
-          body: stubbed_response.to_json,
-          headers: { 'Content-Type' => 'application/json' }
-        )
+    def page(page_num)
+      [{ 'id' => page_num, 'entry' => { 'id' => page_num } }]
+    end
+
+    it 'single page' do
+      stub_quiz_api(expected_url, page(1), headers: link_header(host, path, 1, 1))
+      result = subject.list(params: params, token: 'token', all: true)
+      expect(result).to eql([{ 'id' => 1, 'entry' => { 'id' => 1 } }])
     end
 
-    it 'gets from quiz_api/api/banks/{id}/bank_entries and returns the response' do
-      result = subject.list(params: params, token: 'token')
-      expect(result.parsed_response).to eql(stubbed_response)
+    it 'paginated response' do
+      expected_result = [
+        { 'id' => 1, 'entry' => { 'id' => 1 } },
+        { 'id' => 2, 'entry' => { 'id' => 2 } },
+        { 'id' => 3, 'entry' => { 'id' => 3 } }
+      ]
+
+      stub_quiz_api(expected_url, page(1), headers: link_header(host, path, 1, 3))
+      stub_quiz_api(expected_url, page(2), query: { page: 2 }, headers: link_header(host, path, 2, 3))
+      stub_quiz_api(expected_url, page(3), query: { page: 3 }, headers: link_header(host, path, 3, 3))
+      result = subject.list(params: params, token: 'token', all: true)
+      expect(result).to eql(expected_result)
     end
   end
 end

data/spec/services/quiz_entries_service_spec.rb

@@ -3,24 +3,53 @@ describe QuizApiClient::Services::QuizEntriesService do
   let(:config) { QuizApiClient::Config.new { |c| c.host = host } }
   let(:subject) { described_class.new(config) }
 
+  def link_header(host, path, page, last_page)
+    link_header = "<https://#{host}#{path}?page=#{last_page}>; rel=\"last\""
+    link_header += ", <https://#{host}#{path}?page=#{page + 1}>; rel=\"next\"" if page < last_page
+    link_header += ", <https://#{host}#{path}?page=#{page - 1}>; rel=\"prev\"" if page > 1
+    link_header += ", <https://#{host}#{path}?page=1>; rel=\"first\"" if page > 1
+    { link: link_header }
+  end
+
+  def stub_quiz_api(url, body, query: {}, headers: {}, status: 200)
+    stub_request(:get, url)
+      .with(query: query)
+      .to_return(
+        body: body.to_json,
+        status: status,
+        headers: headers.merge(
+          'Content-Type' => 'application/json'
+        )
+      )
+  end
+
   describe '#list' do
     let(:params) { { id: 1 } }
-    let(:stubbed_response) { { 'id' => 1, 'entry' => { 'id' => 1 } } }
-    let(:expected_url) { "https://#{host}/api/quizzes/#{params[:id]}/quiz_entries?page=&per_page=" }
-    let(:status_code) { 200 }
+    let(:path) { "/api/quizzes/#{params[:id]}/quiz_entries" }
+    let(:expected_url) { "https://#{host}#{path}" }
 
-    before do
-      stub_request(:get, expected_url)
-        .to_return(
-          status: status_code,
-          body: stubbed_response.to_json,
-          headers: { 'Content-Type' => 'application/json' }
-        )
+    def page(page_num)
+      [{ 'id' => page_num, 'entry' => { 'id' => page_num } }]
     end
 
-    it 'gets from quiz_api/api/quizzes/{id}/quiz_entries and returns the response' do
-      result = subject.list(params: params, token: 'token')
-      expect(result.parsed_response).to eql(stubbed_response)
+    it 'single page' do
+      stub_quiz_api(expected_url, page(1), headers: link_header(host, path, 1, 1))
+      result = subject.list(params: params, token: 'token', all: true)
+      expect(result).to eql([{ 'id' => 1, 'entry' => { 'id' => 1 } }])
+    end
+
+    it 'paginated response' do
+      expected_result = [
+        { 'id' => 1, 'entry' => { 'id' => 1 } },
+        { 'id' => 2, 'entry' => { 'id' => 2 } },
+        { 'id' => 3, 'entry' => { 'id' => 3 } }
+      ]
+
+      stub_quiz_api(expected_url, page(1), headers: link_header(host, path, 1, 3))
+      stub_quiz_api(expected_url, page(2), query: { page: 2 }, headers: link_header(host, path, 2, 3))
+      stub_quiz_api(expected_url, page(3), query: { page: 3 }, headers: link_header(host, path, 3, 3))
+      result = subject.list(params: params, token: 'token', all: true)
+      expect(result).to eql(expected_result)
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quiz_api_client
 version: !ruby/object:Gem::Version
-  version: 4.13.1
+  version: 4.13.3
 platform: ruby
 authors:
 - Alex Slaughter
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-08-23 00:00:00.000000000 Z
+date: 2023-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty