quiz_api_client 4.24.0 → 4.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7e14132240ede40616dabc2feac9400fe84262ba29cf2d2aacbdedddcded259
-  data.tar.gz: 745e10dfc3a5e4917ad9e0000a66022c31cd16fc4f8dfb7c386eb9a09846267d
+  metadata.gz: 182251d8d198f02d1428d74caf6b3216ca7f5a919a6b2eeec7ac2c4c932df208
+  data.tar.gz: e8ec9ef5a7b469d01a246417705ffb4cb80bbe82b69786ccd6635a789bc60efe
 SHA512:
-  metadata.gz: 2d62d169bf07dad6adfcf0fbc43d850ebaf705cccd9db6bc848d74268501769b98a983fed9028e12d0dbffb67d9e0bcfa73d1f721c5a4f83220c4ee1d1323589
-  data.tar.gz: 2a4b338ae4b34b16fcfbe36b2e99ed13fec4b8ea9e08e636b830dec0215e9d01300973ded39e25907dcc7457c1961b33b265eb60f2b8adbb55aa000d32156791
+  metadata.gz: 1c5ef1655f96677079f022b6f014a244795702708e3ec48d88b16f7982c72a2d35fe3e755d6e509f0dab7e2e8e50ae71145d93dc5384ef304b5a69f48d4561e6
+  data.tar.gz: f700f9a028f4ecbcc7fd34866e6690093a4af5b084cfb999f9873269c56f3d970c76ed380a4d53f5895a46517f8a58a623ffdcc693f2d89784f97d0a314d18b1

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,8 @@ module QuizApiClient
   class Config
     DEFAULT_ALLOWABLE_RESPONSE_CODES = [401, 422].freeze
     DEFAULT_PROTOCOL = 'https'.freeze
-    ERROR_HANDLERS = %i[sentry_raven].freeze
+    DEFAULT_USER_AGENT = "QuizApiClient/#{QuizApiClient::VERSION} (Ruby)".freeze
+    ERROR_HANDLERS = %i[sentry_raven sentry_rails].freeze
     METRICS_HANDLERS = %i[inststatsd].freeze
 
     class InvalidErrorHandler < StandardError; end
@@ -10,7 +11,7 @@ module QuizApiClient
     class InvalidMetricsNamespace < StandardError; end
 
     attr_reader :error_handler, :metrics_handler, :metrics_namespace
-    attr_writer :protocol, :allowable_response_codes
+    attr_writer :protocol, :allowable_response_codes, :user_agent
     attr_accessor :consumer_key, :consumer_request_id, :host, :shared_secret
 
     def initialize
@@ -39,6 +40,10 @@ module QuizApiClient
       @allowable_response_codes || DEFAULT_ALLOWABLE_RESPONSE_CODES
     end
 
+    def user_agent
+      @user_agent || DEFAULT_USER_AGENT
+    end
+
     private
 
     def validate_error_handler!(handler)

data/lib/quiz_api_client/http_client.rb

@@ -123,7 +123,8 @@ module QuizApiClient
           'Authorization' => jwt,
           'AuthType' => 'Signature',
           'Accept' => 'application/json',
-          'Content-Type' => 'application/json'
+          'Content-Type' => 'application/json',
+          'User-Agent' => config.user_agent
         }
       }
 

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

@@ -1,3 +1,3 @@
 module QuizApiClient
-  VERSION = '4.24.0'.freeze
+  VERSION = '4.26.0'.freeze
 end

data/spec/config_spec.rb

@@ -30,6 +30,18 @@ describe QuizApiClient::Config do
     end
   end
 
+  describe '#user_agent' do
+    it 'returns the default when not set' do
+      config = described_class.new
+      expect(config.user_agent).to eq QuizApiClient::Config::DEFAULT_USER_AGENT
+    end
+
+    it 'returns the configured value when set' do
+      config = described_class.new { |c| c.user_agent = 'canvas-lms/2026.05.0' }
+      expect(config.user_agent).to eq 'canvas-lms/2026.05.0'
+    end
+  end
+
   describe '#setup_metrics' do
     let(:valid_handler) { :inststatsd }
     let(:invalid_handler) { :invalid_handler }

data/spec/http_client_spec.rb

@@ -188,6 +188,7 @@ describe QuizApiClient::HttpClient do
         'AuthType' => 'Signature',
         'Accept' => 'application/json',
         'Content-Type' => 'application/json',
+        'User-Agent' => QuizApiClient::Config::DEFAULT_USER_AGENT,
         'X-Consumer-Request-Id' => 'hi'
       )
     end
@@ -360,6 +361,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)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quiz_api_client
 version: !ruby/object:Gem::Version
-  version: 4.24.0
+  version: 4.26.0
 platform: ruby
 authors:
 - Alex Slaughter
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-12-02 00:00:00.000000000 Z
+date: 2026-05-08 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