quiz_api_client 4.4.0 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e1f12f936c33b3cf09fe4f8475aa40dfc7dbde37e65ed81b7d62ef07d23c86c
-  data.tar.gz: 9b4895c5dedd2d56fb64a79d2d03e5c6a8989832a9a51f912920fd71aa67582b
+  metadata.gz: 20c474d0431dbdf5c2cf34902592b90336b535e1d5d9197570fa727b5d6cbb00
+  data.tar.gz: c029697bd27fae184dd98e524cfe94fdc4525b3fea9fb8163ae0d06e4d8a719e
 SHA512:
-  metadata.gz: '009317d5880a188a2ba3ed14f1b937fc34b35f169ab819aaedfd57c09550b5a9acea19db12d6ca8591c13cd41b252e200d82022a236cfdd6f6271a682496ee38'
-  data.tar.gz: 5f8059807154051560b72466ad20452f4f42b771e528ed1a9235d3eca12e0e802af9ca7fe5434dcd740dd808908181357474659bd6c66af25d9ff0072d0ee949
+  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/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

@@ -4,6 +4,10 @@ module QuizApiClient::Services
       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
@@ -17,6 +21,13 @@ module QuizApiClient::Services
       )
     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]}"

data/lib/quiz_api_client/version.rb

@@ -1,3 +1,3 @@
 module QuizApiClient
-  VERSION = '4.4.0'.freeze
+  VERSION = '4.5.0'.freeze
 end

data/spec/services/courses_service_spec.rb

@@ -42,6 +42,45 @@ describe QuizApiClient::Services::CoursesService do
     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" }

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quiz_api_client
 version: !ruby/object:Gem::Version
-  version: 4.4.0
+  version: 4.5.0
 platform: ruby
 authors:
 - Alex Slaughter
@@ -14,7 +14,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-06-23 00:00:00.000000000 Z
+date: 2022-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -72,34 +72,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: pact
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.41'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.41'
-- !ruby/object:Gem::Dependency
-  name: pact_broker-client
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.19'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.19'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -229,29 +201,6 @@ files:
 - lib/quiz_api_client/services/shared_banks.rb
 - lib/quiz_api_client/version.rb
 - spec/config_spec.rb
-- spec/contracts/interaction_types_service_spec.rb
-- spec/contracts/item_analyses_service_spec.rb
-- spec/contracts/items_service_spec.rb
-- spec/contracts/qti_imports_service_spec.rb
-- spec/contracts/quiz_clone_job_service_spec.rb
-- spec/contracts/quiz_clone_jobs_service_spec.rb
-- spec/contracts/quiz_entries_service_spec.rb
-- spec/contracts/quiz_service_spec.rb
-- spec/contracts/quiz_session_events_service_spec.rb
-- 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
-- spec/contracts/shared_banks_spec.rb
-- spec/contracts/shared_examples/http_delete_example.rb
-- spec/contracts/shared_examples/http_get_example.rb
-- spec/contracts/shared_examples/http_patch_example.rb
-- spec/contracts/shared_examples/http_post_example.rb
-- spec/contracts/shared_examples/http_put_example.rb
 - spec/http_client_spec.rb
 - spec/json_formatter_spec.rb
 - spec/quiz_api_client/http_request/failure_spec.rb
@@ -279,8 +228,6 @@ files:
 - 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: 
 licenses: []
 metadata: {}
@@ -305,29 +252,6 @@ specification_version: 4
 summary: Ruby client for quiz_api
 test_files:
 - spec/config_spec.rb
-- spec/contracts/interaction_types_service_spec.rb
-- spec/contracts/item_analyses_service_spec.rb
-- spec/contracts/items_service_spec.rb
-- spec/contracts/qti_imports_service_spec.rb
-- spec/contracts/quiz_clone_job_service_spec.rb
-- spec/contracts/quiz_clone_jobs_service_spec.rb
-- spec/contracts/quiz_entries_service_spec.rb
-- spec/contracts/quiz_service_spec.rb
-- spec/contracts/quiz_session_events_service_spec.rb
-- 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
-- spec/contracts/shared_banks_spec.rb
-- spec/contracts/shared_examples/http_delete_example.rb
-- spec/contracts/shared_examples/http_get_example.rb
-- spec/contracts/shared_examples/http_patch_example.rb
-- spec/contracts/shared_examples/http_post_example.rb
-- spec/contracts/shared_examples/http_put_example.rb
 - spec/http_client_spec.rb
 - spec/json_formatter_spec.rb
 - spec/quiz_api_client/http_request/failure_spec.rb
@@ -355,5 +279,3 @@ test_files:
 - 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

data/spec/contracts/interaction_types_service_spec.rb

@@ -1,22 +0,0 @@
-describe QuizApiClient::Services::InteractionTypesService, :pact do
-  include PactHelper
-
-  it_behaves_like 'a http get request to quiz_api collection endpoint' do
-    let(:provider_state) { 'a set of interaction types' }
-    let(:request_description) { 'a request to retrieve a list of interaction types' }
-    let(:quizzes_api_path) { '/api/interaction_types' }
-    let(:scope) { 'quiz.build' }
-    let(:params) { nil }
-    let(:response_body) do
-      Pact.each_like(
-        id: '1',
-        slug: 'choice',
-        name: 'Multiple Choice',
-        properties_schema: {},
-        scoring_algorithm_default: 'Equivalence',
-        user_response_type_options: ['Uuid']
-      )
-    end
-    let(:service_name) { :interaction_types_service }
-  end
-end

data/spec/contracts/item_analyses_service_spec.rb

@@ -1,59 +0,0 @@
-describe QuizApiClient::Services::ItemAnalysesService, :pact do
-  include PactHelper
-
-  it_behaves_like 'a http get request to quiz_api collection endpoint', testrail_id: %w[3402546] do
-    let(:request_description) { 'a request to retrieve item analyses all quiz_id items' }
-    let(:quiz_id) { 1 }
-    let(:quizzes_api_path) { "/api/quizzes/#{quiz_id}/stats/item_analyses" }
-    let(:provider_state) { 'quiz with item analysis' }
-    let(:resource_id) { '1' }
-    let(:scope) { 'quiz.analysis' }
-    let(:params) { { quiz_id: '1' } }
-    let(:response_body) do
-      [
-        {
-          item_id: Pact.like('1'),
-          points_possible: Pact.like(1.0),
-          item_body: Pact.like('item body'),
-          interaction_type: 'choice',
-          item_analysis: {},
-          batch_timestamp: Pact.like('2017-06-15T22:14:51.215Z'),
-          outcome_alignment_set_guid: Pact.like('cbedd9b0-d1ab-43a9-a3b2-89c3134a722a')
-        },
-        {
-          item_id: Pact.like('1'),
-          points_possible: Pact.like(1.0),
-          item_body: Pact.like('item body'),
-          interaction_type: 'choice',
-          item_analysis: {},
-          batch_timestamp: Pact.like('2017-06-15T22:14:51.215Z'),
-          outcome_alignment_set_guid: Pact.like('cbedd9b0-d1ab-43a9-a3b2-89c3134a722a')
-        }
-      ]
-    end
-    let(:service_name) { :item_analyses_service }
-  end
-
-  it_behaves_like 'a http get only request to quiz_api', testrail_id: %w[3402547] do
-    let(:request_description) { 'a request to retrieve item analyses for a quiz item' }
-    let(:quiz_id) { 1 }
-    let(:id) { 1 }
-    let(:quizzes_api_path) { "/api/quizzes/#{quiz_id}/stats/item_analyses/#{id}" }
-    let(:provider_state) { 'quiz with item analysis' }
-    let(:resource_id) { '1' }
-    let(:scope) { 'quiz.analysis' }
-    let(:params) { { quiz_id: '1', id: '1' } }
-    let(:response_body) do
-      {
-        item_id: Pact.like('1'),
-        points_possible: Pact.like(1.0),
-        item_body: Pact.like('item body'),
-        interaction_type: 'choice',
-        item_analysis: {},
-        batch_timestamp: Pact.like('2017-06-15T22:14:51.215Z'),
-        outcome_alignment_set_guid: Pact.like('cbedd9b0-d1ab-43a9-a3b2-89c3134a722a')
-      }
-    end
-    let(:service_name) { :item_analyses_service }
-  end
-end

data/spec/contracts/items_service_spec.rb

@@ -1,59 +0,0 @@
-describe QuizApiClient::Services::ItemsService, :pact do
-  include PactHelper
-
-  it_behaves_like 'a http post request to quiz_api' do
-    let(:provider_state) { 'a quiz and a multiple choice interaction type' }
-    let(:request_description) { 'a request to create an item' }
-    let(:quizzes_api_path) { "/api/quizzes/#{quiz_id}/items" }
-    let(:resource_id) { '1' }
-    let(:scope) { 'quiz.build' }
-    let(:quiz_id) { 1 }
-    let(:params) do
-      {
-        quiz_id: quiz_id,
-        interaction_data: {
-          choices: [{
-            id: 'guid',
-            itemBody: '<p>Choice</p>',
-            position: 1
-          }]
-        },
-        interaction_type_id: 1, # we'll seed InteractionType::MultipleChoice
-        item_body: 'Some kind of stem',
-        properties: {},
-        scoring_algorithm: 'Equivalence',
-        scoring_data: {
-          value: 'another guid'
-        },
-        title: 'A perfectly cromulent title',
-        user_response_type: 'Uuid'
-      }
-    end
-    let(:item_params) { params.clone.tap { |p| p.delete(:quiz_id) } }
-    let(:body) { { quiz_id: quiz_id, item: item_params } }
-    let(:response_body) do
-      {
-        id: Pact.like('1'),
-        interaction_data: {
-          choices: Pact.each_like(
-            id: 'a guid',
-            item_body: 'choice description',
-            position: 1
-          )
-        },
-        item_body: Pact.like(''),
-        properties: Pact.like({}),
-        status: Pact.like(''),
-        title: Pact.like(''),
-        user_response_type: Pact.like(''),
-        stimulus_id: Pact.like(''),
-        interaction_type: Pact.like({}),
-        scoring_data: {
-          value: Pact.like('')
-        },
-        scoring_algorithm: Pact.like('')
-      }
-    end
-    let(:service_name) { :items_service }
-  end
-end

data/spec/contracts/qti_imports_service_spec.rb

@@ -1,34 +0,0 @@
-describe QuizApiClient::Services::QtiImportsService, :pact do
-  include PactHelper
-
-  it_behaves_like 'a http post request to quiz_api', testrail_id: %w[3402548] do
-    let(:request_description) { 'a request to import a QTI' }
-    let(:provider_state) { 'a quiz' }
-    let(:quiz_id) { 1 }
-    let(:url) { 'http://fake.url' }
-    let(:quizzes_api_path) { "/api/quizzes/#{quiz_id}/qti_imports" }
-    let(:scope) { 'qti_import.create' }
-    let(:resource_id) { quiz_id }
-    let(:params) do
-      {
-        quiz_id: quiz_id,
-        url: url
-      }
-    end
-    let(:body) { { qti_import: params } }
-    let(:response_body) do
-      {
-        id: Pact.like('1'),
-        parent_id: quiz_id.to_s,
-        parent_type: Pact.like('Quiz'),
-        status: 'scheduled',
-        url: url,
-        message: Pact.like(''),
-        created_at: Pact.like(''),
-        updated_at: Pact.like(''),
-        progress: Pact.like(0.0)
-      }
-    end
-    let(:service_name) { :qti_imports_service }
-  end
-end

data/spec/contracts/quiz_clone_job_service_spec.rb

@@ -1,20 +0,0 @@
-describe QuizApiClient::Services::QuizCloneJobService, :pact do
-  include PactHelper
-
-  it_behaves_like 'a http get request to quiz_api' do
-    let(:request_description) { 'a request to retrieve a quiz clone job' }
-    let(:quizzes_api_path) { "/api/quiz_clone_jobs/#{resource_id}" }
-    let(:provider_state) { 'a quiz clone job' }
-    let(:scope) { 'quiz_clone_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'),
-        status: Pact.like('scheduled')
-      }
-    end
-    let(:service_name) { :quiz_clone_job_service }
-  end
-end

data/spec/contracts/quiz_clone_jobs_service_spec.rb

@@ -1,21 +0,0 @@
-describe QuizApiClient::Services::QuizCloneJobsService, :pact do
-  include PactHelper
-
-  it_behaves_like 'a http post request to quiz_api' do
-    let(:request_description) { 'a request to clone a quiz' }
-    let(:quizzes_api_path) { "/api/quizzes/#{resource_id}/quiz_clone_jobs" }
-    let(:provider_state) { 'a quiz' }
-    let(:scope) { 'quiz.clone' }
-    let(:params) { { quiz_id: resource_id } }
-    let(:body) { {} }
-    let(:resource_id) { '1' }
-    let(:response_body) do
-      {
-        id: Pact.like('1'),
-        original_quiz_id: Pact.like('1'),
-        status: Pact.like('scheduled')
-      }
-    end
-    let(:service_name) { :quiz_clone_jobs_service }
-  end
-end