quiz_api_client 4.23.0 → 4.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 530745dd8b2114222d9d503cd841439525f7679384290a71d9313f4fa6fe94a2
-  data.tar.gz: 6e6b594abea72e7f49947a70dd45229ba2948fcba301a8e90ed9be1fa05716ec
+  metadata.gz: 271c4523cdeb2e7861c0292366ce7db0e6f87ab37a1406d5a9bc5fb001ad935e
+  data.tar.gz: 3e290ab1b995fbd19c9b00e0b73a8cea69974a15f77859900a4a8d66f1876c85
 SHA512:
-  metadata.gz: a603aaaa981cf20b625656fda29046a726cd36132b21e872e3dc9616aaeb3220c58b60fa43ad20ea9b9a015b2a6cc46625e83623f404ab8c59c71aa75b07b0e1
-  data.tar.gz: 132bef5130d34e4005845e8af45805de26f882f4b46f6515f61b5f57bdd4a0f47f07d731a99b34a510c59ecec4979d7a54e1200eefca66e4f3cce93bd8afdd49
+  metadata.gz: 2f125d17891e1fddacaaab43282ac302e88668277e00df91cd184358cca2ee5c0303cf97345eb2a592e53d8237d126e13319b6169db5e091548f3434153624e0
+  data.tar.gz: 904d69175eee4889c4c12f17ca57d1306f909fe585171b1d100229e0036c57b9e70686e05a602fb782258dac16d2f1ff8fd041fb8f6f8c8ec8361f0415c1877d

data/README.md

@@ -187,3 +187,37 @@ 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).
+
+## Development with Quiz LTI
+
+Copy this repo inside the Quiz LTI docker container:
+
+```shell
+docker cp . quiz-lti-web:/quiz_api_client_ruby
+```
+
+Tell Quiz LTI to use the gem, find the line containing `gem 'quiz_api_client'` in `app.rb`, update it to:
+
+```shell
+gem 'quiz_api_client', path: '/quiz_api_client_ruby'
+```
+
+Run bundle install the container:
+
+```shell
+docker exec quiz-lti-web bundle install
+```
+
+Restart the container:
+
+```shell
+docker restart quiz-lti-web
+```
+
+Your changes should be reflected in the container!
+
+If you update the code afterwards you'll need to copy and restart the container:
+
+```shell
+docker cp . quiz-lti-web:gems/quiz_api_client_ruby && docker restart quiz-lti-web
+```

data/lib/quiz_api_client/config.rb

@@ -2,7 +2,7 @@ module QuizApiClient
   class Config
     DEFAULT_ALLOWABLE_RESPONSE_CODES = [401, 422].freeze
     DEFAULT_PROTOCOL = 'https'.freeze
-    ERROR_HANDLERS = %i[sentry_raven].freeze
+    ERROR_HANDLERS = %i[sentry_raven sentry_rails].freeze
     METRICS_HANDLERS = %i[inststatsd].freeze
 
     class InvalidErrorHandler < StandardError; end

data/lib/quiz_api_client/http_request/failure.rb

@@ -48,6 +48,10 @@ module QuizApiClient
         when :sentry_raven
           require 'sentry-raven'
           Raven.extra_context(context)
+        when :sentry_rails
+          require 'sentry-ruby'
+          require 'sentry-rails'
+          Sentry.set_extras(context)
         end
       end
 

data/lib/quiz_api_client/services/content_migration_job_service.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module QuizApiClient
+  module Services
+    class ContentMigrationJobService < BaseApiService
+      def create(params:, token: nil)
+        post_to_quiz_api(params: params, token: token)
+      end
+
+      def retry(params:, token: nil)
+        retry_on_quiz_api(params: params, token: token)
+      end
+
+      def show(params:, token: nil)
+        get_from_quiz_api(params: params, token: token)
+      end
+
+      private
+
+      def post_to_quiz_api(params:, token:)
+        client(token: token).post(
+          '/api/content_migration/jobs',
+          course: params
+        )
+      end
+
+      def retry_on_quiz_api(params:, token:)
+        client(token: token).post(
+          '/api/content_migration/jobs/retry',
+          params
+        )
+      end
+
+      def get_from_quiz_api(params:, token:)
+        client(token: token).get(
+          "/api/content_migration/jobs/#{params[:external_content_migration_id]}"
+        )
+      end
+    end
+  end
+end

data/lib/quiz_api_client/version.rb

@@ -1,3 +1,3 @@
 module QuizApiClient
-  VERSION = '4.23.0'.freeze
+  VERSION = '4.25.0'.freeze
 end

data/lib/quiz_api_client.rb

@@ -129,6 +129,10 @@ module QuizApiClient
     def youtube_service
       @_youtube_service ||= Services::YoutubeService.new(config)
     end
+
+    def content_migration_job_service
+      @_content_migration_job_service ||= Services::ContentMigrationJobService.new(config)
+    end
   end
 end
 
@@ -168,3 +172,4 @@ require 'quiz_api_client/services/session_items_service'
 require 'quiz_api_client/services/session_item_results_service'
 require 'quiz_api_client/services/shared_banks'
 require 'quiz_api_client/services/youtube_service'
+require 'quiz_api_client/services/content_migration_job_service'

data/spec/http_client_spec.rb

@@ -360,6 +360,162 @@ describe QuizApiClient::HttpClient do
         expect { client.get('/') }.to raise_error(QuizApiClient::HttpClient::RequestFailed)
       end
 
+      it 'handles an Net::ReadTimeout error' do
+        stub_request(:get, url).to_raise(Net::ReadTimeout)
+        expect_metrics_calls(client.config, :get, 0)
+        expect_raise_error_call(client.config, :get, url_for_path(path), nil, kind_of(Net::ReadTimeout))
+        expect { client.get('/') }.to raise_error(QuizApiClient::HttpClient::RequestFailed)
+      end
+    end
+    context 'with :sentry_rails error handler' do
+      let(:error_handler) { :sentry_rails }
+      let(:path) { '/' }
+      let(:url) { "http://api.quiz.docker#{path}" }
+      let(:error_context) do
+        {
+          quiz_api_client: {
+            request: {
+              method: :get,
+              url: url
+            }
+          }
+        }
+      end
+
+      before do
+        client.config.error_handler = error_handler
+      end
+
+      context 'with non-success responses' do
+        let(:body) { '[2]' }
+        let(:code) { 404 }
+        let(:path) { '/api/quizzes' }
+        let(:context_url) { url }
+        let(:method) { :get }
+        let(:error_context) do
+          {
+            quiz_api_client: {
+              request: {
+                method: method,
+                url: context_url
+              },
+              response: {
+                body: body,
+                code: code
+              }
+            }
+          }
+        end
+        let(:mock_response) do
+          instance_double(
+            'HTTParty::Response',
+            success?: false,
+            body: body,
+            code: code
+          )
+        end
+        let(:success_response) do
+          # rubocop:disable Metrics/LineLength
+          instance_double(
+            'HTTParty::Response',
+            body: body,
+            code: 200,
+            parsed_response: [1],
+            headers: {
+              'link' => '<http://api.quiz.docker/api/quizzes?page=2>; rel="last", <http://api.quiz.docker/api/quizzes?page=2>; rel="next"',
+              'content-type' => ['application/json']
+            }
+          )
+          # rubocop:enable Metrics/LineLength
+        end
+
+        context ':get request' do
+          it 'raises error' do
+            expect(client).to receive(:successful_response?).with(mock_response).and_return(false)
+            expect(client.class).to receive(:get).and_return(mock_response)
+            expect_metrics_calls(client.config, method, code)
+            expect_raise_error_call(client.config, method, url_for_path(path), mock_response, nil)
+            expect { client.get(path, all: false, query: { sort: 'alpha' }) }
+              .to raise_error(QuizApiClient::HttpClient::RequestFailed)
+          end
+        end
+
+        context ':post request' do
+          let(:method) { :post }
+
+          it 'raises error' do
+            expect(client).to receive(:successful_response?).with(mock_response).and_return(false)
+            expect(client.class).to receive(:post).and_return(mock_response)
+            expect_metrics_calls(client.config, method, code)
+            expect_raise_error_call(client.config, method, url_for_path(path), mock_response, nil)
+            expect { client.post(path) }.to raise_error(QuizApiClient::HttpClient::RequestFailed)
+          end
+        end
+
+        context ':put request' do
+          let(:method) { :put }
+
+          it 'raises error' do
+            expect(client).to receive(:successful_response?).with(mock_response).and_return(false)
+            expect(client.class).to receive(:put).and_return(mock_response)
+            expect_metrics_calls(client.config, method, code)
+            expect_raise_error_call(client.config, method, url_for_path(path), mock_response, nil)
+            expect { client.put(path) }.to raise_error(QuizApiClient::HttpClient::RequestFailed)
+          end
+        end
+
+        context ':patch request' do
+          let(:method) { :patch }
+
+          it 'raises error' do
+            expect(client).to receive(:successful_response?).with(mock_response).and_return(false)
+            expect(client.class).to receive(:patch).and_return(mock_response)
+            expect_metrics_calls(client.config, method, code)
+            expect_raise_error_call(client.config, method, url_for_path(path), mock_response, nil)
+            expect { client.patch(path) }.to raise_error(QuizApiClient::HttpClient::RequestFailed)
+          end
+        end
+
+        context ':delete request' do
+          let(:method) { :delete }
+
+          it 'raises error' do
+            expect(client).to receive(:successful_response?).with(mock_response).and_return(false)
+            expect(client.class).to receive(:delete).and_return(mock_response)
+            expect_metrics_calls(client.config, method, code)
+            expect_raise_error_call(client.config, method, url_for_path(path), mock_response, nil)
+            expect { client.delete(path) }.to raise_error(QuizApiClient::HttpClient::RequestFailed)
+          end
+        end
+
+        context 'with pagination' do
+          let(:context_url) { "#{url}?page=2" }
+
+          it 'raises error if one of the linked pages does not return 200 response' do
+            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) }, status: code
+            allow(HTTParty::Response).to receive(:new).and_return(success_response, mock_response)
+            expect(client).to receive(:successful_response?).and_return(true, false).twice
+            expect_raise_error_call(client.config, method, context_url, mock_response, nil)
+            expect { client.get('/api/quizzes', all: true) }.to raise_error(QuizApiClient::HttpClient::RequestFailed)
+          end
+        end
+      end
+
+      it 'handles an HTTParty::Error error' do
+        stub_request(:get, url).to_raise(HTTParty::Error)
+        expect_metrics_calls(client.config, :get, 0)
+        expect_raise_error_call(client.config, :get, url_for_path(path), nil, kind_of(HTTParty::Error))
+        expect { client.get('/') }.to raise_error(QuizApiClient::HttpClient::RequestFailed)
+      end
+
+      it 'handles an Errno::ECONNREFUSED error' do
+        stub_request(:get, url).to_raise(Errno::ECONNREFUSED)
+        expect_metrics_calls(client.config, :get, 0)
+        expect_raise_error_call(client.config, :get, url_for_path(path), nil, kind_of(Errno::ECONNREFUSED))
+        expect { client.get('/') }.to raise_error(QuizApiClient::HttpClient::RequestFailed)
+      end
+
       it 'handles an Net::ReadTimeout error' do
         stub_request(:get, url).to_raise(Net::ReadTimeout)
         expect_metrics_calls(client.config, :get, 0)

data/spec/quiz_api_client_spec.rb

@@ -162,5 +162,12 @@ describe QuizApiClient do
         subject.interaction_types_service
       end
     end
+
+    describe '#content_migration_job_service' do
+      it 'should create the service' do
+        expect(QuizApiClient::Services::ContentMigrationJobService).to receive(:new).with(subject.config)
+        subject.content_migration_job_service
+      end
+    end
   end
 end

data/spec/services/content_migration_job_service_spec.rb

@@ -0,0 +1,125 @@
+describe QuizApiClient::Services::ContentMigrationJobService 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
+      {
+        canvas_course_id: 123,
+        external_content_migration_id: 'abc-123',
+        settings: {
+          import_quizzes_next: true
+        }
+      }
+    end
+
+    let(:expected_url) { "https://#{host}/api/content_migration/jobs" }
+
+    let(:stubbed_response) do
+      {
+        'id' => '1',
+        'external_content_migration_id' => 'abc-123',
+        'status' => 'queued',
+        'created_at' => '2024-01-01T00:00:00.000Z',
+        'updated_at' => '2024-01-01T00:00:00.000Z'
+      }
+    end
+
+    before do
+      stub_request(:post, expected_url)
+        .with(body: { course: params }.to_json)
+        .to_return(
+          status: 201,
+          body: stubbed_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(stubbed_response)
+    end
+  end
+
+  describe '#retry' do
+    let(:params) do
+      {
+        external_content_migration_id: 'abc-123'
+      }
+    end
+
+    let(:expected_url) { "https://#{host}/api/content_migration/jobs/retry" }
+
+    let(:stubbed_response) do
+      {
+        'id' => '1',
+        'external_content_migration_id' => 'abc-123',
+        'status' => 'queued',
+        'created_at' => '2024-01-01T00:00:00.000Z',
+        'updated_at' => '2024-01-01T00:00:00.000Z'
+      }
+    end
+
+    before do
+      stub_request(:post, expected_url)
+        .with(body: params.to_json)
+        .to_return(
+          status: 200,
+          body: stubbed_response.to_json,
+          headers: { 'Content-Type' => 'application/json' }
+        )
+    end
+
+    it 'posts to the correct endpoint and returns the response' do
+      expect(
+        subject.retry(params: params, token: 'token').parsed_response
+      ).to eq(stubbed_response)
+    end
+  end
+
+  describe '#show' do
+    let(:params) { { external_content_migration_id: 'abc-123' } }
+    let(:expected_url) { "https://#{host}/api/content_migration/jobs/#{params[:external_content_migration_id]}" }
+    let(:stubbed_response) do
+      {
+        'id' => '1',
+        'external_content_migration_id' => 'abc-123',
+        'status' => 'completed',
+        'created_at' => '2024-01-01T00:00:00.000Z',
+        'updated_at' => '2024-01-01T00:00:00.000Z'
+      }
+    end
+
+    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/content_migration/jobs/:external_content_migration_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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quiz_api_client
 version: !ruby/object:Gem::Version
-  version: 4.23.0
+  version: 4.25.0
 platform: ruby
 authors:
 - Alex Slaughter
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-09-30 00:00:00.000000000 Z
+date: 2026-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -115,6 +115,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.74.0
+- !ruby/object:Gem::Dependency
+  name: sentry-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.5'
 - !ruby/object:Gem::Dependency
   name: sentry-raven
   requirement: !ruby/object:Gem::Requirement
@@ -129,6 +143,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: sentry-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.5'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -186,6 +214,7 @@ files:
 - 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/content_migration_job_service.rb
 - lib/quiz_api_client/services/courses_service.rb
 - lib/quiz_api_client/services/interaction_types_service.rb
 - lib/quiz_api_client/services/item_analyses_service.rb
@@ -221,6 +250,7 @@ files:
 - spec/services/bank_service_spec.rb
 - spec/services/base_api_service_spec.rb
 - spec/services/content_exports_service_spec.rb
+- spec/services/content_migration_job_service_spec.rb
 - spec/services/courses_service_spec.rb
 - spec/services/interaction_types_service_spec.rb
 - spec/services/item_analyses_service_spec.rb
@@ -278,6 +308,7 @@ test_files:
 - spec/services/bank_service_spec.rb
 - spec/services/base_api_service_spec.rb
 - spec/services/content_exports_service_spec.rb
+- spec/services/content_migration_job_service_spec.rb
 - spec/services/courses_service_spec.rb
 - spec/services/interaction_types_service_spec.rb
 - spec/services/item_analyses_service_spec.rb