quiz_api_client 4.13.0 → 4.13.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b00457ab08c111b3cbed96f2581a0491cfbc1aaa8444228bb171754db5d302a6
-  data.tar.gz: da4deb0cb2166b04d3c293eb7ab10891ece8efab5c12485e2c14b4802767435e
+  metadata.gz: 5a3731bc74410110bbb5ebcd49a1810b4609e77a39d0f415a66b2add1c588c83
+  data.tar.gz: c00017a51dd925c73ec1f6a957ba830b2762a1da20ba949ff42090d244188f86
 SHA512:
-  metadata.gz: 1b0fe620b198f56743e58a19414906d1b42d9b1b26181824a4d3ffa5df8d4ba9cdd5f9f69ffb116b72dfe1efbbace4919781c87608f9801cfa368b5de4cb24ee
-  data.tar.gz: ac18907b4a8454d2d9c0309b61ab2aff3439358678b04ad8754555d0c6c3caba2e4437eede06f5d51345e7b044af63deb5cdad8205bfdb789e3a1923cd656219
+  metadata.gz: 7c0b3d1876135ab671d33a9156d6c56ad7f51103691de92f6a093d91e5f1a1d01c160f5017585572afd88b2bd245df34e043ff8f1e3516b75e87a3e96344bdca
+  data.tar.gz: d41fde3e160e5b9d57b242810ae29657183516e88586f1afb4a0c86f7171ee447603282b43058f3feb7aff8897c06c74cdf2adec23b0dfcdbb54c423a09e12e4

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/courses_service.rb

@@ -26,6 +26,13 @@ module QuizApiClient::Services
       )
     end
 
+    def associate_courses(params:, token: nil)
+      client(token: token).patch(
+        "/api/courses/#{params[:canvas_id]}/associate_courses",
+        course_canvas_ids: params[:course_canvas_ids]
+      )
+    end
+
     private
 
     def post_to_quiz_api(params:, token:)

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.0'.freeze
+  VERSION = '4.13.2'.freeze
 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/courses_service_spec.rb

@@ -174,4 +174,39 @@ describe QuizApiClient::Services::CoursesService do
       ).to eq(response)
     end
   end
+
+  describe '#associate_courses' do
+    let(:params) { { canvas_id: 1, course_canvas_ids: [2, 3, 4] } }
+    let(:response) do
+      {
+        'course' => {
+          'id' => '4',
+          'title' => 'foo',
+          'canvas_id' => '2',
+          'is_blueprint' => true,
+          'created_at' => '2022-06-22T18:59:27.577Z',
+          'updated_at' => '2022-06-22T18:59:27.577Z'
+        },
+        'courses_synced' => params[:course_canvas_ids]
+      }
+    end
+
+    let(:expected_url) { "https://#{host}/api/courses/1/associate_courses" }
+
+    before do
+      stub_request(:patch, expected_url)
+        .with(body: { course_canvas_ids: params[:course_canvas_ids] }.to_json)
+        .to_return(
+          status: 200,
+          body: response.to_json,
+          headers: { 'Content-Type' => 'application/json' }
+        )
+    end
+
+    it 'patches to the correct endpoint and returns the response' do
+      expect(
+        subject.associate_courses(params: params, token: 'token').parsed_response
+      ).to eq(response)
+    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.0
+  version: 4.13.2
 platform: ruby
 authors:
 - Alex Slaughter
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-07-17 00:00:00.000000000 Z
+date: 2023-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty