quiz_api_client 4.2.1 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2f68d04f56475db3135d3b6f74e36d19a3300c213622c6829cad7066c7f77a2
-  data.tar.gz: ddea88d65b109c9b5c685c4c5f54c7de741d27fe236ce6164e6a6f5a01a180a1
+  metadata.gz: 11e55f74ad6fd90e5f09e214394d3d44103e7027d83ce03299f5670cbc79111d
+  data.tar.gz: 836308804ec45f08806c57bf63c6d7b9167e03eee52d955e7bca38b310f75305
 SHA512:
-  metadata.gz: 4605af70971e585e3086828448d81903e180cacc99287003471f8c99863b940e719c5bb8735cf48c4bbf9aefb4486ab2ed72139c1d331b8fa8d5b73fdfab8a8f
-  data.tar.gz: f6fc9e7840d04d4ff65f5c442ccbc45b2314b565f801dc6a707c1ba8b13989e0aa57b43d9bd9cb39a947ad3eae08134e09cf82c9189a2d55a52c5bb0792b756f
+  metadata.gz: 9ed1d073d41458ff170b5767eec5d37e560af8211f6fa5da0906d7d644411a9a4e589c7d644b807300dd76400374e0e9bcd58d4595bd2e4004d65d228e4afb9f
+  data.tar.gz: 26d1ce56705ad6a1ba18c93175ae572e4ab54e95438513095c663c6a3d6efda3a57cce29ff432ac6885b5bf139305f954bab53890360b89945fdc0c48878b123

data/lib/quiz_api_client/services/quiz_clone_jobs_service.rb

@@ -4,6 +4,10 @@ module QuizApiClient::Services
       post_to_quiz_api(params: params, token: token)
     end
 
+    def create_batch(body:, token: nil)
+      batch_post_to_quiz_api(body: body, token: token)
+    end
+
     private
 
     def post_to_quiz_api(params:, token:)
@@ -11,5 +15,12 @@ module QuizApiClient::Services
         "/api/quizzes/#{params.fetch(:quiz_id)}/quiz_clone_jobs"
       )
     end
+
+    def batch_post_to_quiz_api(body:, token:)
+      client(token: token).post(
+        '/api/quiz_clone_jobs/create_batch',
+        body
+      )
+    end
   end
 end

data/lib/quiz_api_client/services/quiz_sync_job_service.rb

@@ -0,0 +1,17 @@
+module QuizApiClient::Services
+  class QuizSyncJobService < BaseApiService
+    def show(params:, token: nil)
+      raise 'Quiz Sync Job Id Required' unless params && params[:id]
+
+      get_from_quiz_api(params: params, token: token)
+    end
+
+    private
+
+    def get_from_quiz_api(params:, token:)
+      client(token: token).get(
+        "/api/quiz_sync_jobs/#{params.fetch(:id)}"
+      )
+    end
+  end
+end

data/lib/quiz_api_client/services/quiz_sync_jobs_service.rb

@@ -0,0 +1,16 @@
+module QuizApiClient::Services
+  class QuizSyncJobsService < BaseApiService
+    def create_batch(body:, token: nil)
+      batch_post_to_quiz_api(body: body, token: token)
+    end
+
+    private
+
+    def batch_post_to_quiz_api(body:, token:)
+      client(token: token).post(
+        '/api/quiz_sync_jobs/create_batch',
+        body
+      )
+    end
+  end
+end

data/lib/quiz_api_client/version.rb

@@ -1,3 +1,3 @@
 module QuizApiClient
-  VERSION = '4.2.1'.freeze
+  VERSION = '4.3.0'.freeze
 end

data/lib/quiz_api_client.rb

@@ -50,6 +50,14 @@ module QuizApiClient
       @_quiz_clone_jobs_service ||= Services::QuizCloneJobsService.new(config)
     end
 
+    def quiz_sync_job_service
+      @_quiz_sync_job_service ||= Services::QuizSyncJobService.new(config)
+    end
+
+    def quiz_sync_jobs_service
+      @_quiz_sync_jobs_service ||= Services::QuizSyncJobsService.new(config)
+    end
+
     def qti_imports_service
       @_qti_imports_service ||= Services::QtiImportsService.new(config)
     end
@@ -120,6 +128,8 @@ require 'quiz_api_client/services/quizzes_service'
 require 'quiz_api_client/services/quiz_session_result_service'
 require 'quiz_api_client/services/quiz_clone_job_service'
 require 'quiz_api_client/services/quiz_clone_jobs_service'
+require 'quiz_api_client/services/quiz_sync_job_service'
+require 'quiz_api_client/services/quiz_sync_jobs_service'
 require 'quiz_api_client/services/session_items_service'
 require 'quiz_api_client/services/session_item_results_service'
 require 'quiz_api_client/services/shared_banks'

data/spec/contracts/quiz_sync_job_service_spec.rb

@@ -0,0 +1,21 @@
+describe QuizApiClient::Services::QuizSyncJobService, :pact do
+  include PactHelper
+
+  it_behaves_like 'a http get request to quiz_api' do
+    let(:request_description) { 'a request to retrieve a quiz sync job' }
+    let(:quizzes_api_path) { "/api/quiz_sync_jobs/#{resource_id}" }
+    let(:provider_state) { 'a quiz sync job' }
+    let(:scope) { 'quiz_sync_job.show' }
+    let(:params) { { id: resource_id } }
+    let(:resource_id) { '1' }
+    let(:response_body) do
+      {
+        id: Pact.like('1'),
+        original_quiz_id: Pact.like('1'),
+        cloned_quiz_id: Pact.like('2'),
+        status: Pact.like('scheduled')
+      }
+    end
+    let(:service_name) { :quiz_sync_job_service }
+  end
+end

data/spec/contracts/quiz_sync_jobs_service_spec.rb

@@ -0,0 +1,21 @@
+describe QuizApiClient::Services::QuizSyncJobsService, :pact do
+  include PactHelper
+
+  it_behaves_like 'a http post request to quiz_api' do
+    let(:batch) { true }
+    let(:request_description) { 'a request to sync many quizzes' }
+    let(:quizzes_api_path) { '/api/quiz_sync_jobs/create_batch' }
+    let(:provider_state) { 'a completed quiz clone job' }
+    let(:scope) { 'quiz_sync_job.create_batch' }
+    let(:params) { { quiz_ids: ['1'] } }
+    let(:body) { { quiz_ids: ['1'] } }
+    let(:response_body) do
+      [
+        {
+          id: Pact.like('1')
+        }
+      ]
+    end
+    let(:service_name) { :quiz_sync_jobs_service }
+  end
+end

data/spec/contracts/shared_examples/http_post_example.rb

@@ -14,6 +14,7 @@ shared_examples 'a http post request to quiz_api' do
   let(:params) { raise 'Override in spec' }
   let(:body) { raise 'Override in spec' }
   let(:request_description) { raise 'Override in spec (must be unique!)' }
+  let(:batch) { false }
 
   let(:client) do
     QuizApiClient::Client.new(
@@ -53,7 +54,14 @@ shared_examples 'a http post request to quiz_api' do
     end
 
     it 'verifies the request is valid' do
-      result = client.send(service_name).create(token: token, params: params)
+      service = client.send(service_name)
+
+      result = if batch
+        service.create_batch(token: token, body: params)
+      else
+        service.create(token: token, params: params)
+      end
+
       expect(result).to be_truthy
     end
   end

data/spec/services/quiz_clone_jobs_service_spec.rb

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

data/spec/services/quiz_sync_job_service_spec.rb

@@ -0,0 +1,41 @@
+describe QuizApiClient::Services::QuizSyncJobService do
+  let(:host) { 'api.host' }
+  let(:config) { QuizApiClient::Config.new { |c| c.host = host } }
+  let(:subject) { described_class.new(config) }
+
+  describe '#show' do
+    let(:expected_url) { "https://#{host}/api/quiz_sync_jobs/#{params[:id]}" }
+    let(:params) { { id: 1 } }
+    let(:stubbed_response) { { 'id' => 1, 'original_quiz_id' => 666, 'status' => 'completed' } }
+
+    context 'on success' do
+      before do
+        stub_request(:get, expected_url)
+          .to_return(
+            status: 200,
+            body: stubbed_response.to_json,
+            headers: { 'Content-Type' => 'application/json' }
+          )
+      end
+
+      it 'gets from /api/quiz_sync_jobs/:id' do
+        result = subject.show(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(:get, expected_url)
+          .to_return(status: status_code)
+      end
+
+      it 'returns a response with the correct code' do
+        response = subject.show(params: params, token: 'token')
+        expect(response.code).to eq(status_code)
+      end
+    end
+  end
+end

data/spec/services/quiz_sync_jobs_service_spec.rb

@@ -0,0 +1,77 @@
+describe QuizApiClient::Services::QuizCloneJobsService do
+  let(:host) { 'api.host' }
+  let(:config) { QuizApiClient::Config.new { |c| c.host = host } }
+  let(:subject) { described_class.new(config) }
+
+  describe '#create' do
+    let(:expected_url) { "https://#{host}/api/quizzes/#{params[:quiz_id]}/quiz_clone_jobs" }
+    let(:params) { { quiz_id: 1 } }
+    let(:stubbed_response) { { 'id' => '1' } }
+
+    context 'on success' do
+      before do
+        stub_request(:post, expected_url)
+          .to_return(
+            status: 200,
+            body: stubbed_response.to_json,
+            headers: { 'Content-Type' => 'application/json' }
+          )
+      end
+
+      it 'posts to /api/quizzes/:quiz_id/quiz_clone_job' do
+        result = subject.create(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(:post, expected_url)
+          .to_return(status: status_code)
+      end
+
+      it 'returns a response with the correct code' do
+        response = subject.create(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] } }
+    let(:stubbed_response) { { 'id' => '1' } }
+
+    context 'on success' do
+      before do
+        stub_request(:post, expected_url)
+          .to_return(
+            status: 200,
+            body: stubbed_response.to_json,
+            headers: { 'Content-Type' => 'application/json' }
+          )
+      end
+
+      it 'posts to /api/quiz_clone_jobs/create_batch' do
+        result = subject.create_batch(body: body, token: 'token')
+        expect(result.parsed_response).to eql(stubbed_response)
+      end
+    end
+
+    context 'on failure' do
+      let(:status_code) { 401 }
+
+      before do
+        stub_request(:post, expected_url)
+          .to_return(status: status_code)
+      end
+
+      it 'returns a response with the correct code' do
+        response = subject.create_batch(body: body, token: 'token')
+        expect(response.code).to eq(status_code)
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quiz_api_client
 version: !ruby/object:Gem::Version
-  version: 4.2.1
+  version: 4.3.0
 platform: ruby
 authors:
 - Alex Slaughter
@@ -11,10 +11,10 @@ authors:
 - Michael Hargiss
 - Robin Kuss
 - Ryan Taylor
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-26 00:00:00.000000000 Z
+date: 2022-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -184,7 +184,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - aslaughter@instructure.com
 - jhiggins@instructure.com
@@ -220,6 +220,8 @@ files:
 - lib/quiz_api_client/services/quiz_session_result_service.rb
 - lib/quiz_api_client/services/quiz_session_service.rb
 - lib/quiz_api_client/services/quiz_sessions_service.rb
+- lib/quiz_api_client/services/quiz_sync_job_service.rb
+- lib/quiz_api_client/services/quiz_sync_jobs_service.rb
 - lib/quiz_api_client/services/quizzes_service.rb
 - lib/quiz_api_client/services/session_item_results_service.rb
 - lib/quiz_api_client/services/session_items_service.rb
@@ -238,6 +240,8 @@ files:
 - spec/contracts/quiz_session_result_service_spec.rb
 - spec/contracts/quiz_session_service_spec.rb
 - spec/contracts/quiz_sessions_service_spec.rb
+- spec/contracts/quiz_sync_job_service_spec.rb
+- spec/contracts/quiz_sync_jobs_service_spec.rb
 - spec/contracts/quizzes_service_spec.rb
 - spec/contracts/session_item_results_service_spec.rb
 - spec/contracts/session_items_service_spec.rb
@@ -267,16 +271,18 @@ files:
 - spec/services/quiz_session_result_service_spec.rb
 - spec/services/quiz_session_service_spec.rb
 - spec/services/quiz_sessions_service_spec.rb
+- spec/services/quiz_sync_job_service_spec.rb
+- spec/services/quiz_sync_jobs_service_spec.rb
 - spec/services/quizzes_service_spec.rb
 - spec/services/session_item_results_service_spec.rb
 - spec/services/session_items_service_spec.rb
 - spec/spec_helper.rb
 - spec/support/pact_config.rb
 - spec/support/pact_helper.rb
-homepage: 
+homepage:
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -291,8 +297,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Ruby client for quiz_api
 test_files:
@@ -309,6 +315,8 @@ test_files:
 - spec/contracts/quiz_session_result_service_spec.rb
 - spec/contracts/quiz_session_service_spec.rb
 - spec/contracts/quiz_sessions_service_spec.rb
+- spec/contracts/quiz_sync_job_service_spec.rb
+- spec/contracts/quiz_sync_jobs_service_spec.rb
 - spec/contracts/quizzes_service_spec.rb
 - spec/contracts/session_item_results_service_spec.rb
 - spec/contracts/session_items_service_spec.rb
@@ -338,6 +346,8 @@ test_files:
 - spec/services/quiz_session_result_service_spec.rb
 - spec/services/quiz_session_service_spec.rb
 - spec/services/quiz_sessions_service_spec.rb
+- spec/services/quiz_sync_job_service_spec.rb
+- spec/services/quiz_sync_jobs_service_spec.rb
 - spec/services/quizzes_service_spec.rb
 - spec/services/session_item_results_service_spec.rb
 - spec/services/session_items_service_spec.rb