quiz_api_client 4.8.0 → 4.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 057d0dea94cbf0a0781d3c8144906a8ea7b29790f278f4d4a55891aaf6c3a12b
-  data.tar.gz: c5241135784c367e250fe0fb0a1e6012fc391c2a9d09c1225173f1acfbb3a595
+  metadata.gz: 450aa47af30bde7b962ac76248bde2fa992b4168875f1e8847c48539813576e5
+  data.tar.gz: 73da155fb2da7763ec9a07f557250842e62bd38ddfe570418df8a7eeee7608aa
 SHA512:
-  metadata.gz: 89212f479d1081e38ad2005e5f7b84a4c3c5088b1620c6673cc2538fa719ed73f9eba1df31c5bca786c0efa4c3755d9e5bcd37e2508e7aaec73ee8ad41b1bdc4
-  data.tar.gz: b2be42851612a9fae066ff5dcfdd322e6d66d821ddd03fa53083e8713e90c8d4ad780de177c4f13752919897ffc0e720e8b8aa2db98f27e159c73e3f64e9cd2f
+  metadata.gz: bd2bf29f5d1a2b3d512e8cb75b40479789138551d7fce2438e3a215158b423f174bb19bb5f854f48373f6ea685815ca73dfa0431cbde2e0839c8ae191aeff1f0
+  data.tar.gz: 3a95461f774db17ccb8ed636d6a552c3ea4c50291d648989d44d2f621434c196ef21468de4c8e81d0f3ccf215e6dff132dcd8cfd5c404bceba484316319062a7

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(
@@ -130,7 +138,8 @@ module QuizApiClient
     end
 
     def next_page_link(response, options)
-      return if response.headers['link'].blank?
+      return if response.headers['link'].nil?
+      return if response.headers['link'].empty?
 
       links = LinkHeader.parse(response.headers['link']).links
       next_link = links.find { |link| link['rel'] == 'next' }
@@ -140,7 +149,9 @@ module QuizApiClient
     def next_page_dynamo(response, url, options)
       hash_key = response.headers['x-last-evaluated-hash-key']
       range_key = response.headers['x-last-evaluated-range-key']
-      return unless hash_key.present? && range_key.present?
+
+      return if hash_key.nil? || hash_key.empty?
+      return if range_key.nil? || range_key.empty?
 
       query = (options[:query] || {}).merge(
         last_evaluated_hash_key: hash_key,

data/lib/quiz_api_client/services/analyses_service.rb

@@ -0,0 +1,17 @@
+module QuizApiClient::Services
+  class AnalysesService < BaseApiService
+    def create(params:, token: nil)
+      post_to_quiz_api(params: params, token: token)
+    end
+
+    private
+
+    def post_to_quiz_api(params:, token:)
+      client(token: token).post(
+        "/api/quizzes/#{params[:quiz_id]}/analyses",
+        quiz_session_ids: params[:quiz_session_ids],
+        filter: params[:filter]
+      )
+    end
+  end
+end

data/lib/quiz_api_client/services/bank_entries_service.rb

@@ -0,0 +1,20 @@
+module QuizApiClient::Services
+  class BankEntriesService < BaseApiService
+    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) }.compact
+      get_from_quiz_api(params: params, token: token, pagination_params: pagination_params, all: all)
+    end
+
+    private
+
+    def get_from_quiz_api(params:, token:, pagination_params:, all:)
+      client(token: token).get(
+        "/api/internal_services/banks/#{params[:id]}/bank_entries",
+        query: pagination_params,
+        all: all
+      )
+    end
+  end
+end

data/lib/quiz_api_client/services/bank_service.rb

@@ -0,0 +1,15 @@
+module QuizApiClient::Services
+  class BankService < BaseApiService
+    def show(params:, token: nil)
+      get_from_quiz_api(params: params, token: token)
+    end
+
+    private
+
+    def get_from_quiz_api(params:, token:)
+      client(token: token).get(
+        "/api/internal_services/banks/#{params[:id]}"
+      )
+    end
+  end
+end

data/lib/quiz_api_client/services/content_exports_service.rb

@@ -4,6 +4,12 @@ module QuizApiClient::Services
       post_to_quiz_api(params: params, token: token)
     end
 
+    def show(params:, token: nil)
+      raise 'Content Export Id Required' unless params && params[:id]
+
+      get_from_quiz_api(params: params, token: token)
+    end
+
     private
 
     def post_to_quiz_api(params:, token:)
@@ -12,5 +18,11 @@ module QuizApiClient::Services
         content_export: params
       )
     end
+
+    def get_from_quiz_api(params:, token:)
+      client(token: token).get(
+        "/api/content_exports/#{params[:id]}"
+      )
+    end
   end
 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/items_service.rb

@@ -19,6 +19,12 @@ module QuizApiClient::Services
       put_to_quiz_api(params: params, token: token)
     end
 
+    def media_upload_url(params:, token: nil)
+      raise 'Quiz Id Required' unless params && params[:quiz_id]
+
+      get_media_upload_url_from_quiz_api(params: params, token: token)
+    end
+
     private
 
     def list_from_quiz_api(params:, token:)
@@ -44,5 +50,10 @@ module QuizApiClient::Services
         item: params
       )
     end
+
+    def get_media_upload_url_from_quiz_api(params:, token:)
+      quiz_id = params.delete(:quiz_id)
+      client(token: token).get("/api/quizzes/#{quiz_id}/items/media_upload_url")
+    end
   end
 end

data/lib/quiz_api_client/services/quiz_clone_jobs_service.rb

@@ -4,6 +4,10 @@ module QuizApiClient::Services
       post_to_quiz_api(body: body, params: params, token: token)
     end
 
+    def update(body: {}, params:, token: nil)
+      put_to_quiz_api(body: body, params: params, token: token)
+    end
+
     def create_batch(body:, token: nil)
       batch_post_to_quiz_api(body: body, token: token)
     end
@@ -17,6 +21,13 @@ module QuizApiClient::Services
       )
     end
 
+    def put_to_quiz_api(body:, params:, token:)
+      client(token: token).put(
+        "/api/quiz_clone_jobs/#{params.fetch(:id)}",
+        body
+      )
+    end
+
     def batch_post_to_quiz_api(body:, token:)
       client(token: token).post(
         '/api/quiz_clone_jobs/create_batch',

data/lib/quiz_api_client/services/quiz_entries_service.rb

@@ -15,7 +15,7 @@ module QuizApiClient::Services
 
     def update(params:, token: nil)
       raise 'Quiz Id Required' unless params && params[:quiz_id]
-      raise 'Entry Id Required' unless params[:entry_id]
+      raise 'Entry Id Required' unless params[:id]
 
       put_to_quiz_api(params: params, token: token)
     end
@@ -23,7 +23,8 @@ module QuizApiClient::Services
     def list(params:, token: nil, all: false)
       raise 'Quiz Id Required' unless params && params[:id]
 
-      get_from_quiz_api(params: params, token: token, all: all)
+      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
 
     def destroy(params:, token: nil)
@@ -50,14 +51,15 @@ module QuizApiClient::Services
 
     def put_to_quiz_api(params:, token:)
       client(token: token).put(
-        "/api/quizzes/#{params[:quiz_id]}/quiz_entries/#{params[:entry_id]}",
+        "/api/quizzes/#{params[:quiz_id]}/quiz_entries/#{params[:id]}",
         quiz_entry: params
       )
     end
 
-    def get_from_quiz_api(params:, token:, all:)
+    def get_from_quiz_api(params:, token:, pagination_params:, all:)
       client(token: token).get(
         "/api/quizzes/#{params[:id]}/quiz_entries",
+        query: pagination_params,
         all: all
       )
     end

data/lib/quiz_api_client/services/quiz_session_service.rb

@@ -7,7 +7,10 @@ module QuizApiClient::Services
     def show(params:, token: nil)
       raise 'Quiz Session Id Required' unless params && params[:id]
 
-      get_from_quiz_api(params: params, token: token)
+      access_code_params = {
+        disable_ac_invalidation: params.delete(:disable_ac_invalidation)
+      }.compact
+      get_from_quiz_api(params: params, token: token, access_code_params: access_code_params)
     end
 
     private
@@ -19,9 +22,10 @@ module QuizApiClient::Services
       )
     end
 
-    def get_from_quiz_api(params:, token:)
+    def get_from_quiz_api(params:, token:, access_code_params:)
       client(token: token).get(
-        "/api/quiz_sessions/#{params[:id]}"
+        "/api/quiz_sessions/#{params[:id]}",
+        query: access_code_params
       )
     end
   end

data/lib/quiz_api_client/version.rb

@@ -1,3 +1,3 @@
 module QuizApiClient
-  VERSION = '4.8.0'.freeze
+  VERSION = '4.14.0'.freeze
 end

data/lib/quiz_api_client.rb

@@ -18,6 +18,14 @@ module QuizApiClient
       yield(config) if block_given?
     end
 
+    def bank_service
+      @_bank_service ||= Services::BankService.new(config)
+    end
+
+    def bank_entries_service
+      @_bank_entries_service ||= Services::BankEntriesService.new(config)
+    end
+
     def config
       @_config ||= QuizApiClient::Config.new
     end
@@ -70,6 +78,10 @@ module QuizApiClient
       @_qti_imports_service ||= Services::QtiImportsService.new(config)
     end
 
+    def analyses_service
+      @_analyses_service ||= Services::AnalysesService.new(config)
+    end
+
     def item_analyses_service
       @_item_analyses_service ||= Services::ItemAnalysesService.new(config)
     end
@@ -122,9 +134,12 @@ require 'quiz_api_client/http_request/metrics'
 require 'quiz_api_client/services/jwt_service'
 require 'quiz_api_client/services/base_api_service'
 
+require 'quiz_api_client/services/bank_service'
+require 'quiz_api_client/services/bank_entries_service'
 require 'quiz_api_client/services/content_exports_service'
 require 'quiz_api_client/services/courses_service'
 require 'quiz_api_client/services/interaction_types_service'
+require 'quiz_api_client/services/analyses_service'
 require 'quiz_api_client/services/item_analyses_service'
 require 'quiz_api_client/services/items_service'
 require 'quiz_api_client/services/qti_imports_service'

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

@@ -93,6 +93,13 @@ describe QuizApiClient do
       end
     end
 
+    describe '#analyses_service' do
+      it 'should create the service' do
+        expect(QuizApiClient::Services::AnalysesService).to receive(:new).with(subject.config)
+        subject.analyses_service
+      end
+    end
+
     describe '#item_analyses_service' do
       it 'should create the service' do
         expect(QuizApiClient::Services::ItemAnalysesService).to receive(:new).with(subject.config)
@@ -121,6 +128,34 @@ describe QuizApiClient do
       end
     end
 
+    describe '#quiz_service' do
+      it 'should create the service' do
+        expect(QuizApiClient::Services::QuizService).to receive(:new).with(subject.config)
+        subject.quiz_service
+      end
+    end
+
+    describe '#quiz_entries_service' do
+      it 'should create the service' do
+        expect(QuizApiClient::Services::QuizEntriesService).to receive(:new).with(subject.config)
+        subject.quiz_entries_service
+      end
+    end
+
+    describe '#bank_service' do
+      it 'should create the service' do
+        expect(QuizApiClient::Services::BankService).to receive(:new).with(subject.config)
+        subject.bank_service
+      end
+    end
+
+    describe '#bank_entries_service' do
+      it 'should create the service' do
+        expect(QuizApiClient::Services::BankEntriesService).to receive(:new).with(subject.config)
+        subject.bank_entries_service
+      end
+    end
+
     describe '#interaction_types_service' do
       it 'should create the service' do
         expect(QuizApiClient::Services::InteractionTypesService).to receive(:new).with(subject.config)

data/spec/services/analyses_service_spec.rb

@@ -0,0 +1,28 @@
+describe QuizApiClient::Services::AnalysesService do
+  let(:host) { 'api.host' }
+  let(:config) { QuizApiClient::Config.new { |c| c.host = host } }
+  let(:subject) { described_class.new(config) }
+
+  describe '#create' do
+    let(:params) do
+      { quiz_id: 1, quiz_session_ids: [1, 5, 10], filter: :last_attempt }
+    end
+    let(:stubbed_response) { { 'job_id' => 1 } }
+    let(:expected_url) { "https://#{host}/api/quizzes/#{params[:quiz_id]}/analyses" }
+    let(:status_code) { 200 }
+
+    before do
+      stub_request(:post, expected_url)
+        .to_return(
+          status: status_code,
+          body: stubbed_response.to_json,
+          headers: { 'Content-Type' => 'application/json' }
+        )
+    end
+
+    it 'posts to quiz_api/api/quizzes/{id}/analyses and returns the response' do
+      result = subject.create(params: params, token: 'token')
+      expect(result.parsed_response).to eql(stubbed_response)
+    end
+  end
+end

data/spec/services/bank_entries_service_spec.rb

@@ -0,0 +1,55 @@
+describe QuizApiClient::Services::BankEntriesService do
+  let(:host) { 'api.host' }
+  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(:path) { "/api/internal_services/banks/#{params[:id]}/bank_entries" }
+    let(:expected_url) { "https://#{host}#{path}" }
+
+    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 '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/bank_service_spec.rb

@@ -0,0 +1,26 @@
+describe QuizApiClient::Services::BankService do
+  let(:host) { 'api.host' }
+  let(:config) { QuizApiClient::Config.new { |c| c.host = host } }
+  let(:subject) { described_class.new(config) }
+
+  describe '#show' do
+    let(:params) { { id: 1 } }
+    let(:stubbed_response) { { 'id' => 1, 'title' => 'some title' } }
+    let(:expected_url) { "https://#{host}/api/internal_services/banks/#{params[:id]}" }
+    let(:status_code) { 200 }
+
+    before do
+      stub_request(:get, expected_url)
+        .to_return(
+          status: status_code,
+          body: stubbed_response.to_json,
+          headers: { 'Content-Type' => 'application/json' }
+        )
+    end
+
+    it 'gets from quiz_api/api/banks and returns the response' do
+      result = subject.show(params: params, token: 'token')
+      expect(result.parsed_response).to eql(stubbed_response)
+    end
+  end
+end

data/spec/services/content_exports_service_spec.rb

@@ -3,6 +3,20 @@ describe QuizApiClient::Services::ContentExportsService do
   let(:config) { QuizApiClient::Config.new { |c| c.host = host } }
   let(:subject) { described_class.new(config) }
 
+  let(:stubbed_response) do
+    {
+      'id' => '1',
+      'canvas_content_export_id' => '1234',
+      'export_settings' => {
+        'quizzes' => [10, 11],
+        'everything' => false,
+        'content_export_type' => 'qti'
+      },
+      'created_at' => '2023-02-17T01:00:00.000Z',
+      'updated_at' => '2023-02-17T01:00:00.000Z'
+    }
+  end
+
   describe '#create' do
     let(:params) do
       {
@@ -15,20 +29,6 @@ describe QuizApiClient::Services::ContentExportsService do
       }
     end
 
-    let(:response) do
-      {
-        'id' => '1',
-        'canvas_content_export_id' => '1234',
-        'export_settings' => {
-          'quizzes' => [10, 11],
-          'everything' => false,
-          'content_export_type' => 'qti'
-        },
-        'created_at' => '2023-02-17T01:00:00.000Z',
-        'updated_at' => '2023-02-17T01:00:00.000Z'
-      }
-    end
-
     let(:expected_url) { "https://#{host}/api/content_exports" }
 
     before do
@@ -36,7 +36,7 @@ describe QuizApiClient::Services::ContentExportsService do
         .with(body: { content_export: params }.to_json)
         .to_return(
           status: 201,
-          body: response.to_json,
+          body: stubbed_response.to_json,
           headers: { 'Content-Type' => 'application/json' }
         )
     end
@@ -44,7 +44,27 @@ describe QuizApiClient::Services::ContentExportsService do
     it 'posts to the correct endpoint and returns the response' do
       expect(
         subject.create(params: params, token: 'token').parsed_response
-      ).to eq(response)
+      ).to eq(stubbed_response)
+    end
+  end
+
+  describe '#show' do
+    let(:params) { { id: 1 } }
+    let(:expected_url) { "https://#{host}/api/content_exports/#{params[:id]}" }
+    let(:status_code) { 200 }
+
+    before do
+      stub_request(:get, expected_url)
+        .to_return(
+          status: status_code,
+          body: stubbed_response.to_json,
+          headers: { 'Content-Type' => 'application/json' }
+        )
+    end
+
+    it 'gets from quiz_api/api/content_exports and returns the response' do
+      response = subject.show(params: params, token: 'token')
+      expect(response.parsed_response).to eql(stubbed_response)
     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/items_service_spec.rb

@@ -79,4 +79,25 @@ describe QuizApiClient::Services::ItemsService do
       expect { subject.update(params: { quiz_id: 1 }, token: 'token') }.to raise_error('Item Id Required')
     end
   end
+
+  describe '#media_upload_url' do
+    let(:params) { { quiz_id: 1 } }
+    let(:stubbed_response) { { 'url' => 'awsuploadurl' } }
+    let(:expected_url) { "https://#{host}/api/quizzes/#{params[:quiz_id]}/items/media_upload_url" }
+    let(:status_code) { 200 }
+
+    before do
+      stub_request(:get, expected_url)
+        .to_return(
+          status: status_code,
+          body: stubbed_response.to_json,
+          headers: { 'Content-Type' => 'application/json' }
+        )
+    end
+
+    it 'gets from quiz_api/api/quizzes/{id}/items/media_upload_url and returns the response' do
+      result = subject.media_upload_url(params: params, token: 'token')
+      expect(result.parsed_response).to eql(stubbed_response)
+    end
+  end
 end

data/spec/services/quiz_clone_jobs_service_spec.rb

@@ -40,6 +40,43 @@ describe QuizApiClient::Services::QuizCloneJobsService do
     end
   end
 
+  describe '#update' do
+    let(:body) { { resource_map_url: 'http://foo.bar/123' } }
+    let(:params) { { id: 1 } }
+    let(:expected_url) { "https://#{host}/api/quiz_clone_jobs/#{params.fetch(:id)}" }
+    let(:stubbed_response) { { 'id' => '1' } }
+
+    context 'on success' do
+      before do
+        stub_request(:put, expected_url)
+          .to_return(
+            status: 200,
+            body: stubbed_response.to_json,
+            headers: { 'Content-Type' => 'application/json' }
+          )
+      end
+
+      it 'puts to /api/quiz_clone_jobs/:id' do
+        result = subject.update(body: body, params: params, token: 'token')
+        expect(result.parsed_response).to eql(stubbed_response)
+      end
+    end
+
+    context 'on failure' do
+      let(:status_code) { 401 }
+
+      before do
+        stub_request(:put, expected_url)
+          .to_return(status: status_code)
+      end
+
+      it 'returns a response with the correct code' do
+        response = subject.update(body: body, params: params, token: 'token')
+        expect(response.code).to eq(status_code)
+      end
+    end
+  end
+
   describe '#create_batch' do
     let(:expected_url) { "https://#{host}/api/quiz_clone_jobs/create_batch" }
     let(:body) { { quiz_ids: [1, 2] } }

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" }
-    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
 
@@ -74,9 +103,9 @@ describe QuizApiClient::Services::QuizEntriesService do
   end
 
   describe '#update' do
-    let(:params) { { quiz_id: 1, entry_id: 1, points_possible: 1 } }
+    let(:params) { { quiz_id: 1, id: 1, points_possible: 1 } }
     let(:stubbed_response) { { 'id' => 1, 'entry' => { 'id' => 1 } } }
-    let(:expected_url) { "https://#{host}/api/quizzes/#{params[:quiz_id]}/quiz_entries/#{params[:entry_id]}" }
+    let(:expected_url) { "https://#{host}/api/quizzes/#{params[:quiz_id]}/quiz_entries/#{params[:id]}" }
     let(:status_code) { 200 }
     before do
       stub_request(:put, expected_url)
@@ -87,7 +116,7 @@ describe QuizApiClient::Services::QuizEntriesService do
         )
     end
 
-    it 'puts to quiz_api/api/quizzes/{quiz_id}/quiz_entries/{entry_id} and returns the response' do
+    it 'puts to quiz_api/api/quizzes/{quiz_id}/quiz_entries/{id} and returns the response' do
       result = subject.update(params: params, token: 'token')
       expect(result.parsed_response).to eql(stubbed_response)
     end

data/spec/services/quiz_session_service_spec.rb

@@ -45,5 +45,26 @@ describe QuizApiClient::Services::QuizSessionService do
       response = subject.show(params: params, token: 'token')
       expect(response.parsed_response).to eql(stubbed_response)
     end
+
+    context 'when the query param "disable_ac_invalidation" is given' do
+      let(:params) { { id: 1, disable_ac_invalidation: true } }
+      let(:stubbed_response) { { 'id' => 1, 'time_limit_seconds' => 10 } }
+      let(:expected_url) { "https://#{host}/api/quiz_sessions/#{params[:id]}?disable_ac_invalidation=true" }
+      let(:status_code) { 200 }
+
+      before do
+        stub_request(:get, expected_url)
+          .to_return(
+            status: status_code,
+            body: stubbed_response.to_json,
+            headers: { 'Content-Type' => 'application/json' }
+          )
+      end
+
+      it 'gets from quiz_api/api/quiz_sessions and returns the response' do
+        response = subject.show(params: params, token: 'token')
+        expect(response.parsed_response).to eql(stubbed_response)
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quiz_api_client
 version: !ruby/object:Gem::Version
-  version: 4.8.0
+  version: 4.14.0
 platform: ruby
 authors:
 - Alex Slaughter
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-02-24 00:00:00.000000000 Z
+date: 2023-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -179,6 +179,9 @@ files:
 - lib/quiz_api_client/http_request/failure.rb
 - lib/quiz_api_client/http_request/metrics.rb
 - lib/quiz_api_client/json_formatter.rb
+- lib/quiz_api_client/services/analyses_service.rb
+- lib/quiz_api_client/services/bank_entries_service.rb
+- lib/quiz_api_client/services/bank_service.rb
 - lib/quiz_api_client/services/base_api_service.rb
 - lib/quiz_api_client/services/content_exports_service.rb
 - lib/quiz_api_client/services/courses_service.rb
@@ -209,6 +212,9 @@ files:
 - spec/quiz_api_client/http_request/failure_spec.rb
 - spec/quiz_api_client/http_request/metrics_spec.rb
 - spec/quiz_api_client_spec.rb
+- spec/services/analyses_service_spec.rb
+- spec/services/bank_entries_service_spec.rb
+- spec/services/bank_service_spec.rb
 - spec/services/base_api_service_spec.rb
 - spec/services/content_exports_service_spec.rb
 - spec/services/courses_service_spec.rb
@@ -243,14 +249,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: Ruby client for quiz_api
@@ -261,6 +267,9 @@ test_files:
 - spec/quiz_api_client/http_request/failure_spec.rb
 - spec/quiz_api_client/http_request/metrics_spec.rb
 - spec/quiz_api_client_spec.rb
+- spec/services/analyses_service_spec.rb
+- spec/services/bank_entries_service_spec.rb
+- spec/services/bank_service_spec.rb
 - spec/services/base_api_service_spec.rb
 - spec/services/content_exports_service_spec.rb
 - spec/services/courses_service_spec.rb