quiz_api_client 4.2.1 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2f68d04f56475db3135d3b6f74e36d19a3300c213622c6829cad7066c7f77a2
-  data.tar.gz: ddea88d65b109c9b5c685c4c5f54c7de741d27fe236ce6164e6a6f5a01a180a1
+  metadata.gz: 20c474d0431dbdf5c2cf34902592b90336b535e1d5d9197570fa727b5d6cbb00
+  data.tar.gz: c029697bd27fae184dd98e524cfe94fdc4525b3fea9fb8163ae0d06e4d8a719e
 SHA512:
-  metadata.gz: 4605af70971e585e3086828448d81903e180cacc99287003471f8c99863b940e719c5bb8735cf48c4bbf9aefb4486ab2ed72139c1d331b8fa8d5b73fdfab8a8f
-  data.tar.gz: f6fc9e7840d04d4ff65f5c442ccbc45b2314b565f801dc6a707c1ba8b13989e0aa57b43d9bd9cb39a947ad3eae08134e09cf82c9189a2d55a52c5bb0792b756f
+  metadata.gz: c333252cda2aac00b2704651253493fb2fc0e8a50c4a9687605b54ea8bd6fb8da1ebbbda039daa019fec9f5b726cab6b1566ced7e72e9970830950f697195577
+  data.tar.gz: 66c6aafb605ccc6c54fc8d7f7c3c3d3055d017984ac4dba6fb5c1be8f085abb72bdb3bf8e8b531da3a1cbc2a3db7aea3648b38e6f31644ba98bc0df4e5615c0f

data/README.md

@@ -187,51 +187,3 @@ Then, run `bundle exec rake spec` to run the tests.
 You can also run `bundle exec rake console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-When you add or modify a service, be sure to add or modify contract tests!
-
-## Contract Tests
-
-We use [Pact](https://docs.pact.io/) for our contract testing. To generate
-a Pact file, run `bin/contracts-generate`. The script will generate the Pact
-file and place it in the pacts/ directory. It will also attempt to publish the
-Pact file to a local Pact Broker.
-
-### Development Workflow:
-
-1. In the quiz_api repo, spin up the Quiz API service with `bin/dev-setup`
-2. In the quiz_pact_broker repo, spin up a Pact Broker with `bin/dev-setup`
-3. In the quiz_api repo, write Pact provider states in the
-spec/service_consumers/api/quiz_api_client_ruby/ directory as needed
-4. In this repo's spec/contracts/ directory, write or modify a contract test
-5. In this repo, run `bin/contracts-generate` to generate a Pact file and
-publish it to the Pact Broker
-6. In the quiz_api repo, run `bin/contracts` to pull the new Pact file from
-the Pact Broker and run the updated contract tests against the Quiz API service
-
-Bonus: You can view your Pact file in the Pact Broker at http://pact-broker.docker
-along with some cool goodies!
-
-### Debugging Failures
-
-Pact has some basic RSpec output for failed specs. It also keeps a log in
-`log/pact.log` and offers general pointers for debugging.
-
-Above all, learn the Pact [basics](https://docs.pact.io/documentation/matching.html).
-
-### What should contract tests cover?
-
-The aim of contract testing here is *not* to test all functional requirements
-of the Quiz API service. Rather, the goal is to ensure changes to the Quiz API
-service don't break its clients. We can best accomplish this with the
-following contract test coverage:
-
-- Basic happy path requests for all endpoints (POST, GET, PUT, DELETE)
-- Basic error paths for all endpoints (verify the error messages and/or HTTP
-response codes are accurate)
-- Resource state management; for example, when a quiz attempt is submitted but
-not yet graded
-- Special edge case errors
-
-Again, what *not* to test: the functional behavior of the service; for
-example, a series of sequential API calls to test a full user scenario.

data/Rakefile

@@ -1,7 +1,5 @@
 require 'bundler/gem_tasks'
-require 'pact_broker/client/tasks'
 require 'rspec/core/rake_task'
-require_relative './spec/support/pact_config'
 
 RSpec::Core::RakeTask.new(:spec)
 
@@ -19,30 +17,3 @@ task :console do
   ARGV.clear
   Pry.start
 end
-
-# see https://github.com/pact-foundation/pact_broker-client/blob/master/README.md
-namespace :broker do
-  PactBroker::Client::PublicationTask.new(:local) do |task|
-    prepare_pact_files_for_publishing(task)
-  end
-
-  PactBroker::Client::PublicationTask.new(:jenkins_post_merge) do |task|
-    prepare_pact_files_for_publishing(task)
-  end
-
-  def prepare_pact_files_for_publishing(task)
-    task.pattern = 'pacts/*.json'
-
-    task.pact_broker_base_url = PactConfig.broker_host
-    task.pact_broker_basic_auth = {
-      username: PactConfig.broker_username,
-      password: PactConfig.broker_password
-    }
-
-    task.consumer_version = PactConfig.consumer_version
-    puts "Consumer version: #{task.consumer_version}"
-
-    task.tag = PactConfig.consumer_tag
-    puts "Pact file tagged with: #{task.tag}"
-  end
-end

data/lib/quiz_api_client/services/courses_service.rb

@@ -0,0 +1,37 @@
+module QuizApiClient::Services
+  class CoursesService < BaseApiService
+    def create(params:, token: nil)
+      post_to_quiz_api(params: params, token: token)
+    end
+
+    def update(params:, token: nil)
+      patch_to_quiz_api(params: params, token: token)
+    end
+
+    def destroy(params:, token: nil)
+      delete_from_quiz_api(params: params, token: token)
+    end
+
+    private
+
+    def post_to_quiz_api(params:, token:)
+      client(token: token).post(
+        '/api/courses',
+        course: params
+      )
+    end
+
+    def patch_to_quiz_api(params:, token:)
+      client(token: token).patch(
+        "/api/courses/#{params[:canvas_id]}",
+        course: params.tap { |p| p.delete(:canvas_id) }
+      )
+    end
+
+    def delete_from_quiz_api(params:, token:)
+      client(token: token).delete(
+        "/api/courses/#{params[:canvas_id]}"
+      )
+    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(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.5.0'.freeze
 end

data/lib/quiz_api_client.rb

@@ -22,6 +22,10 @@ module QuizApiClient
       @_config ||= QuizApiClient::Config.new
     end
 
+    def courses_service
+      @_courses_service ||= Services::CoursesService.new(config)
+    end
+
     def jwt_service
       @_jwt_service ||= QuizApiClient::Services::JwtService.new(config)
     end
@@ -50,6 +54,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
@@ -106,6 +118,7 @@ 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/courses_service'
 require 'quiz_api_client/services/interaction_types_service'
 require 'quiz_api_client/services/item_analyses_service'
 require 'quiz_api_client/services/items_service'
@@ -120,6 +133,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/quiz_api_client_spec.rb

@@ -51,6 +51,13 @@ describe QuizApiClient do
       end
     end
 
+    describe '#courses_service' do
+      it 'creates the service' do
+        expect(QuizApiClient::Services::CoursesService).to receive(:new).with(subject.config)
+        subject.courses_service
+      end
+    end
+
     describe '#quizzes_service' do
       it 'should create the service' do
         expect(QuizApiClient::Services::QuizzesService).to receive(:new).with(subject.config)

data/spec/services/courses_service_spec.rb

@@ -0,0 +1,98 @@
+describe QuizApiClient::Services::CoursesService 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
+      {
+        title: 'foo',
+        canvas_id: 2,
+        is_blueprint: true
+      }
+    end
+
+    let(:response) do
+      {
+        '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'
+      }
+    end
+
+    let(:expected_url) { "https://#{host}/api/courses" }
+
+    before do
+      stub_request(:post, expected_url)
+        .with(body: { course: params }.to_json)
+        .to_return(
+          status: 201,
+          body: response.to_json,
+          headers: { 'Content-Type' => 'application/json' }
+        )
+    end
+
+    it 'posts to the correct endpoint and returns the response' do
+      expect(
+        subject.create(params: params, token: 'token').parsed_response
+      ).to eq(response)
+    end
+  end
+
+  describe '#update' do
+    let(:params) do
+      {
+        canvas_id: 4,
+        title: 'foo',
+        is_blueprint: true
+      }
+    end
+
+    let(:response) do
+      {
+        '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'
+      }
+    end
+
+    let(:expected_url) { "https://#{host}/api/courses/4" }
+
+    before do
+      stub_request(:patch, expected_url)
+        .with(body: { course: params.slice(:title, :is_blueprint) }.to_json)
+        .to_return(
+          status: 200,
+          body: response.to_json,
+          headers: { 'Content-Type' => 'application/json' }
+        )
+    end
+
+    it 'pathces to the correct endpoint and returns the response' do
+      expect(
+        subject.update(params: params, token: 'token').parsed_response
+      ).to eq(response)
+    end
+  end
+
+  describe '#destroy' do
+    let(:params) { { canvas_id: 1 } }
+    let(:expected_url) { "https://#{host}/api/courses/1" }
+
+    before do
+      stub_request(:delete, expected_url).to_return(status: 204)
+    end
+
+    it 'deletes to the correct endpoint and returns the response' do
+      response = subject.destroy(params: params, token: 'token')
+      expect(response.code).to eq 204
+      expect(response.body).to be_nil
+    end
+  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

data/spec/spec_helper.rb

@@ -1,4 +1,3 @@
-require 'pact/consumer/rspec'
 require 'pry'
 require 'simplecov'
 require 'webmock/rspec'
@@ -10,33 +9,10 @@ end
 $LOAD_PATH.unshift File.expand_path('../lib', __dir__)
 require 'quiz_api_client'
 
-Dir[File.dirname(__FILE__) + '/support/*.rb'].each { |f| require f }
-Dir[File.dirname(__FILE__) + '/contracts/shared_examples/*.rb'].each { |f| require f }
-
 WebMock.disable_net_connect!(
-  allow_localhost: true,
-  allow: [PactConfig.broker_host]
+  allow_localhost: true
 )
 
-# see https://github.com/realestate-com-au/pact/blob/master/documentation/configuration.md
-Pact.configure do |config|
-  config.diff_formatter = :list
-  config.logger.level = Logger::DEBUG
-  config.pact_dir = 'pacts'
-  config.pactfile_write_mode = :overwrite
-  config.pactfile_write_order = :chronological
-end
-
-Pact.service_consumer PactConfig::QUIZ_API_CLIENT_RUBY do
-  has_pact_with PactConfig::Providers::QUIZ_API do
-    mock_service :quiz_api do
-      port 1234
-      pact_specification_version '2.0.0'
-    end
-  end
-end
-
 RSpec.configure do |config|
-  config.filter_run_excluding :pact
   config.before { allow_any_instance_of(::Logger).to receive(:info) }
 end