quiz_api_client 4.25.0 → 4.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 271c4523cdeb2e7861c0292366ce7db0e6f87ab37a1406d5a9bc5fb001ad935e
-  data.tar.gz: 3e290ab1b995fbd19c9b00e0b73a8cea69974a15f77859900a4a8d66f1876c85
+  metadata.gz: 10ceea5a7b48cb12714e234faec4cdfc7bc1cf9f21534b3681dd5184869801d6
+  data.tar.gz: 86aa04c57d79dfb8604b87632376643cc5a14063bcad654053fd9c47306d8b6b
 SHA512:
-  metadata.gz: 2f125d17891e1fddacaaab43282ac302e88668277e00df91cd184358cca2ee5c0303cf97345eb2a592e53d8237d126e13319b6169db5e091548f3434153624e0
-  data.tar.gz: 904d69175eee4889c4c12f17ca57d1306f909fe585171b1d100229e0036c57b9e70686e05a602fb782258dac16d2f1ff8fd041fb8f6f8c8ec8361f0415c1877d
+  metadata.gz: fcd4be13012bc3eed170e292c2d11c63e58a79417fe94f1d81a10a9b665d382f66dd7aadf13ad1c1e0ed497b9499cf4b3b9713174243aed4b37879ba591506c8
+  data.tar.gz: 59763294f14c72eba1c9acb0a1ac134592e687b4e7f65ba02164fe4dd1fcbd198c3d7a0850babff21e5367f4f0ad632835dcb4144a10c34b9429699a0391f461

data/README.md

@@ -188,6 +188,15 @@ You can also run `bundle exec rake console` for an interactive prompt that will
 
 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 Docker
+
+1. Install Docker
+2. Use the following command to start a temporary container and run a bash shell:
+
+```shell
+ docker compose -f docker-compose.yml -f docker-compose.dev.override.yml run --rm app /bin/bash
+ ```
+
 ## Development with Quiz LTI
 
 Copy this repo inside the Quiz LTI docker container:

data/lib/quiz_api_client/config.rb

@@ -2,6 +2,7 @@ module QuizApiClient
   class Config
     DEFAULT_ALLOWABLE_RESPONSE_CODES = [401, 422].freeze
     DEFAULT_PROTOCOL = 'https'.freeze
+    DEFAULT_USER_AGENT = "QuizApiClient/#{QuizApiClient::VERSION} (Ruby)".freeze
     ERROR_HANDLERS = %i[sentry_raven sentry_rails].freeze
     METRICS_HANDLERS = %i[inststatsd].freeze
 
@@ -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/version.rb

@@ -1,3 +1,3 @@
 module QuizApiClient
-  VERSION = '4.25.0'.freeze
+  VERSION = '4.27.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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quiz_api_client
 version: !ruby/object:Gem::Version
-  version: 4.25.0
+  version: 4.27.0
 platform: ruby
 authors:
 - Alex Slaughter
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2026-04-29 00:00:00.000000000 Z
+date: 2026-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -35,16 +35,22 @@ dependencies:
   name: jwt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: link_header
   requirement: !ruby/object:Gem::Requirement