quiz_api_client 3.2.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d21ef77c677faced1f5decda500ca2e4e32dbd5e163e3a313c3d68f699de6f38
-  data.tar.gz: 1614220681706baad9693a638ff0bb9d27622708af4e82ff7a570a47617a1fe5
+  metadata.gz: 48279a4ca7eeb3d7fc50e493733f5718c2960b2267d70db68b2956b0b11c99c1
+  data.tar.gz: cbd66f799b72273b23b2e7a208fc10336bee5cf2cb93656987d0fdc5d1c173a7
 SHA512:
-  metadata.gz: 2e618dca3ed741dddf0d325d7ab77c418fcd9c0a7088b3c4613d137f873efc5b5829f9a1011d57de42dea88edfefe5203debf4c512b5f84e7699b1d5b5594271
-  data.tar.gz: b20220626d0cc582a0a72fb4bdab8d12a81da5884438357b98695a493e1b4c6c1ef225413430a5b2a7a4ac67cd9b9b1956ff47c7ecdfede673ef4feb1d6c61cd
+  metadata.gz: d448acbf4ac471f2c8f55cda52191d35ade2d0e107546946e9cee8f6712556ac402160150555d8e3f978034843240deeeb4cec0a658a5fdf8ce2b2b8d3e1a452
+  data.tar.gz: c73951b3bc89f5ff17b08ac1199aff03f3fd2a7e9cf701d5b2d9fffcc31d4bc76ddd2cc4384622584479ab32f2abf85abc3993554fb8a872a4b961eb8b23b4a3

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.6
 
 Metrics/ClassLength:
   Max: 200 # Default: 100

data/Dockerfile

@@ -4,8 +4,9 @@ RUN mkdir -p coverage log pacts
 
 COPY --chown=docker:docker quiz_api_client.gemspec Gemfile ./
 COPY --chown=docker:docker lib/quiz_api_client/version.rb lib/quiz_api_client/version.rb
-RUN /bin/bash -l -c "rvm-exec 2.4 bundle install --jobs 5"
+RUN /bin/bash -l -c "rvm-exec 2.6 gem install bundler -v 2.1.4"
+RUN /bin/bash -l -c "rvm-exec 2.6 bundle install --jobs 5"
 
 COPY --chown=docker:docker . .
 
-CMD /bin/bash -l -c "rvm-exec 2.4 bundle exec rspec"
+CMD /bin/bash -l -c "rvm-exec 2.6 bundle exec rspec"

data/Jenkinsfile

@@ -1,4 +1,4 @@
-def buildMatrix = ['2.4', '2.5', '2.6'].collectEntries { ruby ->
+def buildMatrix = ['2.6', '2.7'].collectEntries { ruby ->
   ["Ruby ${ruby}": {
     sh """
       docker-compose run --name "${env.BUILD_ID}-ruby-${ruby}" \
@@ -25,7 +25,7 @@ pipeline {
       steps {
         sh '''
         docker-compose run --rm app /bin/bash -lc \
-          "rvm-exec 2.4 bundle exec rubocop --fail-level autocorrect"
+          "rvm-exec 2.6 bundle exec rubocop --fail-level autocorrect"
         '''
       }
     }
@@ -34,7 +34,7 @@ pipeline {
     }
     stage('Contract Tests') {
       steps {
-        sh 'docker-compose run app /bin/bash -l -c "rvm-exec 2.4 bundle exec rspec -t pact"'
+        sh 'docker-compose run app /bin/bash -l -c "rvm-exec 2.6 bundle exec rspec -t pact"'
       }
     }
     stage ('Publish') {
@@ -58,7 +58,7 @@ pipeline {
             -e PACT_BROKER_PASSWORD="${PACT_BROKER_PASSWORD}" \
             -e PACT_CONSUMER_TAG="${PACT_CONSUMER_TAG}" \
             -e SHA="${sha}" \
-            app /bin/bash -l -c "rvm-exec 2.4 bundle exec rake broker:pact:publish:jenkins_post_merge"
+            app /bin/bash -l -c "rvm-exec 2.6 bundle exec rake broker:pact:publish:jenkins_post_merge"
           '''
         }
       }
@@ -67,7 +67,7 @@ pipeline {
 
   post {
     success {
-      sh "docker cp \"${env.BUILD_ID}-ruby-2.4:/usr/src/app/coverage\" ."
+      sh "docker cp \"${env.BUILD_ID}-ruby-2.6:/usr/src/app/coverage\" ."
       publishHTML target: [
                   allowMissing: false,
                   alwaysLinkToLastBuild: false,

data/README.md

@@ -37,6 +37,10 @@ client = QuizApiClient::Client.new(
 )
 ```
 
+### Error Handler
+
+In order to set addition error information in your error handling system, you can set the `error_hander` property of the config.  The list of valid values can be found in the `QuizApiClient::Config::ERROR_HANDLERS` constant.
+
 ### Creation of Tokens
 
 JWTs are created without hitting quiz_api and and they are validated on quiz_api. Tokens are created for a given scope, expiration, and an optional resource_id.

data/lib/quiz_api_client/config.rb

@@ -0,0 +1,38 @@
+module QuizApiClient
+  class Config
+    DEFAULT_PROTOCOL = 'https'.freeze
+    ERROR_HANDLERS = %i[sentry_raven].freeze
+
+    class InvalidErrorHandler < StandardError; end
+
+    attr_reader :error_handler
+    attr_writer :protocol
+    attr_accessor :consumer_key, :consumer_request_id, :host, :shared_secret
+
+    def initialize
+      yield(self) if block_given?
+    end
+
+    def protocol
+      @protocol || DEFAULT_PROTOCOL
+    end
+
+    def error_handler=(handler)
+      validate_error_hander!(handler)
+
+      @error_handler = handler
+    end
+
+    private
+
+    def validate_error_hander!(handler)
+      return unless handler
+
+      unless ERROR_HANDLERS.include?(handler)
+        raise InvalidErrorHandler, "It must be one of the following: #{ERROR_HANDLERS.inspect}"
+      end
+
+      @error_handler = handler.to_sym
+    end
+  end
+end

data/lib/quiz_api_client/http_client.rb

@@ -6,12 +6,12 @@ module QuizApiClient
 
     class RequestFailed < StandardError; end
 
-    attr_reader :jwt, :uri
+    attr_reader :jwt, :uri, :config
 
-    def initialize(uri:, jwt:, consumer_request_id: nil, logging: true, log_level: :info)
+    def initialize(uri:, jwt:, config:, logging: true, log_level: :info)
       @uri = uri
       @jwt = jwt
-      @consumer_request_id = consumer_request_id
+      @config = config
       initialize_logger(log_level) if logging
     end
 
@@ -49,7 +49,7 @@ module QuizApiClient
       HTTParty::Logger.add_formatter('quiz_api_client_json_formatter', QuizApiClient::JSONFormatter)
       @logger = ::Logger.new(
         STDOUT,
-        formatter: proc { |_, _, _, msg| msg.merge(consumer_request_id: @consumer_request_id).to_json },
+        formatter: proc { |_, _, _, msg| msg.merge(consumer_request_id: config.consumer_request_id).to_json },
         level: unfriendly_logger_level(log_level)
       )
       @logger_config = {
@@ -81,7 +81,7 @@ module QuizApiClient
         default_request_data.merge(request_options)
       )
     rescue HTTParty::Error, Errno::ECONNREFUSED, Net::ReadTimeout => e
-      raise RequestFailed, e.message
+      raise_error(method, url, current_error: e)
     end
 
     def make_paginated_request(method, url, options)
@@ -91,7 +91,7 @@ module QuizApiClient
 
       until request_url.nil?
         resp = make_request(method, request_url, request_options)
-        raise RequestFailed, "#{url} responded #{resp.body} (#{resp.code})" unless resp.code == 200
+        raise_error(method, url, response: resp) unless resp.code == 200
 
         entities.concat(resp.parsed_response)
         request_url, request_options = next_page(resp, url, options)
@@ -109,7 +109,7 @@ module QuizApiClient
         }
       }
 
-      initial_hash[:headers]['X-Consumer-Request-Id'] = @consumer_request_id if @consumer_request_id
+      initial_hash[:headers]['X-Consumer-Request-Id'] = config.consumer_request_id if config.consumer_request_id
 
       initial_hash.merge!(@logger_config) if @logger_config
       initial_hash
@@ -138,5 +138,51 @@ module QuizApiClient
       )
       [url, options.merge(query: query)]
     end
+
+    def generate_error_context(method, url, response = nil)
+      context = {
+        quiz_api_client: {
+          request: {
+            method: method,
+            url: url
+          }
+        }
+      }
+
+      if response
+        context[:quiz_api_client][:response] = {
+          body: response.body,
+          code: response.code
+        }
+      end
+
+      context
+    end
+
+    def record_error_context(context)
+      case config.error_handler
+      when :sentry_raven
+        require 'sentry-raven'
+        Raven.extra_context(context)
+      end
+    end
+
+    def error_message(current_error, url, response)
+      if current_error && response
+        "#{current_error.message}: #{url} responded #{response.body} (#{response.code})"
+      elsif current_error
+        current_error.message
+      elsif response
+        "#{url} responded #{response.body} (#{response.code})"
+      end
+    end
+
+    def raise_error(method, url, response: nil, current_error: nil, error_class: RequestFailed)
+      context = generate_error_context(method, url, response)
+
+      record_error_context(context)
+
+      raise error_class, error_message(current_error, url, response)
+    end
   end
 end

data/lib/quiz_api_client/services/base_api_service.rb

@@ -1,29 +1,23 @@
 module QuizApiClient::Services
   class BaseApiService
-    attr_reader :consumer_key, :errors, :host, :protocol, :shared_secret
+    attr_reader :config
 
-    def initialize(
-      consumer_key:, consumer_request_id: nil, host:, protocol: 'https', shared_secret:
-    )
-      @consumer_key = consumer_key
-      @consumer_request_id = consumer_request_id
-      @host = host
-      @protocol = protocol
-      @shared_secret = shared_secret
+    def initialize(config)
+      @config = config
       @errors = []
     end
 
     private
 
     def uri
-      URI.parse("#{protocol}://#{host}").to_s
+      URI.parse("#{config.protocol}://#{config.host}").to_s
     end
 
     def client(token:)
       QuizApiClient::HttpClient.new(
         uri: uri,
         jwt: token,
-        consumer_request_id: @consumer_request_id
+        config: config
       )
     end
   end

data/lib/quiz_api_client/services/jwt_service.rb

@@ -1,15 +1,14 @@
 module QuizApiClient::Services
   class JwtService
+    extend Forwardable
+
     HASHING_ALGORITHM = 'HS512'.freeze
 
-    attr_reader :consumer_key, :host, :shared_secret, :protocol
+    attr_reader :config
+    def_delegators :config, :host, :protocol, :consumer_key
 
-    def initialize(consumer_key: nil, consumer_request_id: nil, shared_secret:, host:, protocol: 'https')
-      @consumer_key = consumer_key
-      @host = host
-      @shared_secret = shared_secret
-      @protocol = protocol
-      @consumer_request_id = consumer_request_id
+    def initialize(config)
+      @config = config
     end
 
     def grant_permission(scope:, exp: nil, uuid: nil, **additional_fields)
@@ -26,7 +25,7 @@ module QuizApiClient::Services
         payload[:user][:uuid] = uuid
       end
 
-      JWT.encode(payload, shared_secret, HASHING_ALGORITHM)
+      JWT.encode(payload, config.shared_secret, HASHING_ALGORITHM)
     end
   end
 end

data/lib/quiz_api_client/version.rb

@@ -1,3 +1,3 @@
 module QuizApiClient
-  VERSION = '3.2.0'.freeze
+  VERSION = '4.0.0'.freeze
 end

data/lib/quiz_api_client.rb

@@ -4,104 +4,101 @@ require 'link_header'
 
 module QuizApiClient
   class Client
-    attr_reader :consumer_key, :consumer_request_id, :host, :protocol, :shared_secret
+    extend Forwardable
+
+    def_delegators :config, :consumer_key, :consumer_request_id, :host, :protocol, :shared_secret
 
     def initialize(consumer_key:, host:, shared_secret:, protocol: 'https', consumer_request_id: nil)
-      @consumer_key = consumer_key
-      @host = host
-      @shared_secret = shared_secret
-      @protocol = protocol
-      @consumer_request_id = consumer_request_id
+      config.consumer_key = consumer_key
+      config.host = host
+      config.shared_secret = shared_secret
+      config.protocol = protocol
+      config.consumer_request_id = consumer_request_id
+
+      yield(config) if block_given?
+    end
+
+    def config
+      @_config ||= QuizApiClient::Config.new
     end
 
     def jwt_service
-      @_jwt_service ||= QuizApiClient::Services::JwtService.new(service_params)
+      @_jwt_service ||= QuizApiClient::Services::JwtService.new(config)
     end
 
     def quiz_service
-      @_quiz_service ||= Services::QuizService.new(service_params)
+      @_quiz_service ||= Services::QuizService.new(config)
     end
 
     def quizzes_service
-      @_quizzes_service ||= Services::QuizzesService.new(service_params)
+      @_quizzes_service ||= Services::QuizzesService.new(config)
     end
 
     def quiz_session_service
-      @_quiz_session_service ||= Services::QuizSessionService.new(service_params)
+      @_quiz_session_service ||= Services::QuizSessionService.new(config)
     end
 
     def quiz_sessions_service
-      @_quiz_sessions_service ||= Services::QuizSessionsService.new(service_params)
+      @_quiz_sessions_service ||= Services::QuizSessionsService.new(config)
     end
 
     def quiz_clone_job_service
-      @_quiz_clone_job_service ||= Services::QuizCloneJobService.new(service_params)
+      @_quiz_clone_job_service ||= Services::QuizCloneJobService.new(config)
     end
 
     def quiz_clone_jobs_service
-      @_quiz_clone_jobs_service ||= Services::QuizCloneJobsService.new(service_params)
+      @_quiz_clone_jobs_service ||= Services::QuizCloneJobsService.new(config)
     end
 
     def qti_imports_service
-      @_qti_imports_service ||= Services::QtiImportsService.new(service_params)
+      @_qti_imports_service ||= Services::QtiImportsService.new(config)
     end
 
     def item_analyses_service
-      @_item_analyses_service ||= Services::ItemAnalysesService.new(service_params)
+      @_item_analyses_service ||= Services::ItemAnalysesService.new(config)
     end
 
     def quiz_analyses_service
-      @_quiz_analyses_service ||= Services::QuizAnalysesService.new(service_params)
+      @_quiz_analyses_service ||= Services::QuizAnalysesService.new(config)
     end
 
     def quiz_session_events_service
-      @_quiz_session_events_service ||= Services::QuizSessionEventsService.new(service_params)
+      @_quiz_session_events_service ||= Services::QuizSessionEventsService.new(config)
     end
 
     def quiz_session_result_service
-      @_quiz_session_result_service ||= Services::QuizSessionResultService.new(service_params)
+      @_quiz_session_result_service ||= Services::QuizSessionResultService.new(config)
     end
 
     def quiz_entries_service
-      @_quiz_entries_service ||= Services::QuizEntriesService.new(service_params)
+      @_quiz_entries_service ||= Services::QuizEntriesService.new(config)
     end
 
     def session_items_service
-      @_session_items_service ||= Services::SessionItemsService.new(service_params)
+      @_session_items_service ||= Services::SessionItemsService.new(config)
     end
 
     def session_item_results_service
-      @_session_item_results_service ||= Services::SessionItemResultsService.new(service_params)
+      @_session_item_results_service ||= Services::SessionItemResultsService.new(config)
     end
 
     def items_service
-      @_items_service ||= QuizApiClient::Services::ItemsService.new(service_params)
+      @_items_service ||= QuizApiClient::Services::ItemsService.new(config)
     end
 
     def interaction_types_service
-      @_interaction_types_service ||= QuizApiClient::Services::InteractionTypesService.new(service_params)
+      @_interaction_types_service ||= QuizApiClient::Services::InteractionTypesService.new(config)
     end
 
     def shared_banks
-      @_shared_banks ||= QuizApiClient::Services::SharedBanks.new(service_params)
-    end
-
-    private
-
-    def service_params
-      {
-        consumer_key: consumer_key,
-        consumer_request_id: consumer_request_id,
-        host: host,
-        protocol: protocol,
-        shared_secret: shared_secret
-      }
+      @_shared_banks ||= QuizApiClient::Services::SharedBanks.new(config)
     end
   end
 end
 
 require 'quiz_api_client/version'
 
+require 'quiz_api_client/config'
 require 'quiz_api_client/http_client'
 require 'quiz_api_client/json_formatter'
 require 'quiz_api_client/services/jwt_service'

data/quiz_api_client.gemspec

@@ -13,6 +13,7 @@ Gem::Specification.new do |spec|
     'Han Yan',
     'Jayce Higgins',
     'Marc Alan Phillips',
+    'Mark Starkman',
     'Michael Brewer-Davis',
     'Michael Hargiss',
     'Omar Khan',
@@ -26,6 +27,7 @@ Gem::Specification.new do |spec|
     'hyan@instructure.com',
     'jhiggins@instructure.com',
     'mphillips@instructure.com',
+    'mark.starkman@instructure.com',
     'mbd@instructure.com',
     'mhargiss@instructure.com',
     'okhan@instructure.com',
@@ -40,7 +42,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.4'
+  spec.required_ruby_version = '>= 2.6'
 
   spec.add_dependency 'httparty', '~> 0.17'
   spec.add_dependency 'jwt', '~> 2.2'
@@ -51,6 +53,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 12.3'
   spec.add_development_dependency 'rspec', '~> 3.8'
   spec.add_development_dependency 'rubocop', '~> 0.74.0'
+  spec.add_development_dependency 'sentry-raven', '~> 3.1'
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'webmock'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quiz_api_client
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Chris Wang
@@ -11,15 +11,16 @@ authors:
 - Han Yan
 - Jayce Higgins
 - Marc Alan Phillips
+- Mark Starkman
 - Michael Brewer-Davis
 - Michael Hargiss
 - Omar Khan
 - Robin Kuss
 - Ryan Taylor
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-19 00:00:00.000000000 Z
+date: 2021-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -133,6 +134,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.74.0
+- !ruby/object:Gem::Dependency
+  name: sentry-raven
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -161,7 +176,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - acallejas@instructure.com
 - bpetty@instructure.com
@@ -169,6 +184,7 @@ email:
 - hyan@instructure.com
 - jhiggins@instructure.com
 - mphillips@instructure.com
+- mark.starkman@instructure.com
 - mbd@instructure.com
 - mhargiss@instructure.com
 - okhan@instructure.com
@@ -195,6 +211,7 @@ files:
 - docker-compose.dev.override.yml
 - docker-compose.yml
 - lib/quiz_api_client.rb
+- lib/quiz_api_client/config.rb
 - lib/quiz_api_client/http_client.rb
 - lib/quiz_api_client/json_formatter.rb
 - lib/quiz_api_client/services/base_api_service.rb
@@ -218,10 +235,10 @@ files:
 - lib/quiz_api_client/services/shared_banks.rb
 - lib/quiz_api_client/version.rb
 - quiz_api_client.gemspec
-homepage: 
+homepage:
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -229,15 +246,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Ruby client for quiz_api
 test_files: []