quiz_api_client 2.9.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8e9117e1b2cc22ef6f530c9ffdc08bc0660c068a51b808b53db9e6cb7e4bd53
-  data.tar.gz: 880060748ab051cf51ea29e7b568c30ae49aac9577bb81c7c6eb55aba2e74f23
+  metadata.gz: 48279a4ca7eeb3d7fc50e493733f5718c2960b2267d70db68b2956b0b11c99c1
+  data.tar.gz: cbd66f799b72273b23b2e7a208fc10336bee5cf2cb93656987d0fdc5d1c173a7
 SHA512:
-  metadata.gz: f5312c786cdd9e0e5a30f5adc487989fdd7fb65d4e3a6dc8c2dc3e44eb150bbdf9e692722deff4716637b88d00c13dc8fabb7b3e196c3518b431341f62fe4d9d
-  data.tar.gz: 3900c41dd19f1c7991f213629d771df77073ab3094e9a7209e0bfd150b40ecff4ac2d7ce822f7c3f3a16b150295a6c68921ba378a725598f3e81e0f74e744fb6
+  metadata.gz: d448acbf4ac471f2c8f55cda52191d35ade2d0e107546946e9cee8f6712556ac402160150555d8e3f978034843240deeeb4cec0a658a5fdf8ce2b2b8d3e1a452
+  data.tar.gz: c73951b3bc89f5ff17b08ac1199aff03f3fd2a7e9cf701d5b2d9fffcc31d4bc76ddd2cc4384622584479ab32f2abf85abc3993554fb8a872a4b961eb8b23b4a3

data/.dockerignore

@@ -1,4 +1,7 @@
+/.gitignore
+/.ruby-version
 /coverage
 /docker-compose.*
 /Dockerfile*
+/Gemfile.lock
 /**/*.gem

data/.gitignore

@@ -1,5 +1,6 @@
 /.bundle/
 /.yardoc
+/.ruby-version
 /_yardoc/
 /coverage/
 /doc/

data/.rspec

@@ -1,2 +1,3 @@
+--require spec_helper
 --format documentation
 --color

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.6
 
 Metrics/ClassLength:
   Max: 200 # Default: 100
@@ -16,6 +16,9 @@ Metrics/BlockLength:
     - quiz_api_client.gemspec
     - spec/**/*.rb
 
+Naming/MemoizedInstanceVariableName:
+  EnforcedStyleForLeadingUnderscores: required
+
 Layout/AlignParameters:
   # Alignment of parameters in multi-line method calls.
   #
@@ -29,7 +32,7 @@ Layout/AlignParameters:
 Layout/CaseIndentation:
   EnforcedStyle: end
 
-Lint/EndAlignment:
+Layout/EndAlignment:
   EnforcedStyleAlignWith: variable
 
 Style/ClassAndModuleChildren:
@@ -59,13 +62,11 @@ Style/Documentation:
   Enabled: false
 
 Style/FrozenStringLiteralComment:
-  # `when_needed` will add the frozen string literal comment to files
-  # only when the `TargetRubyVersion` is set to 2.3+.
   # `always` will always add the frozen string literal comment to a file
   # regardless of the Ruby version or if `freeze` or `<<` are called on a
   # string literal. If you run code against multiple versions of Ruby, it is
   # possible that this will create errors in Ruby 2.3.0+.
   #
   # See: https://wyeworks.com/blog/2015/12/1/immutable-strings-in-ruby-2-dot-3
-  EnforcedStyle: when_needed
+  EnforcedStyle: always
   Enabled: false

data/Dockerfile

@@ -1,20 +1,12 @@
 FROM instructure/rvm
 
-WORKDIR /app
+RUN mkdir -p coverage log pacts
 
-COPY quiz_api_client.gemspec Gemfile /app/
-COPY lib/quiz_api_client/version.rb /app/lib/quiz_api_client/version.rb
+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.6 gem install bundler -v 2.1.4"
+RUN /bin/bash -l -c "rvm-exec 2.6 bundle install --jobs 5"
 
-USER root
-RUN chown -R docker:docker /app
+COPY --chown=docker:docker . .
 
-USER docker
-RUN /bin/bash -l -c "rvm-exec 2.4 bundle install --jobs 5"
-COPY . /app
-RUN rm -f Gemfile.lock
-
-USER root
-RUN chown -R docker:docker /app
-USER 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

@@ -0,0 +1,86 @@
+def buildMatrix = ['2.6', '2.7'].collectEntries { ruby ->
+  ["Ruby ${ruby}": {
+    sh """
+      docker-compose run --name "${env.BUILD_ID}-ruby-${ruby}" \
+          app /bin/bash -lc "rvm-exec ${ruby} bundle install --jobs 5 && rvm-exec ${ruby} bundle exec rspec"
+    """
+  }]
+}
+
+pipeline {
+  agent {
+    label 'docker'
+  }
+  options {
+      buildDiscarder(logRotator(numToKeepStr: '50'))
+      timeout(time: 20, unit: 'MINUTES')
+  }
+  stages {
+    stage('Build') {
+      steps {
+        sh 'docker-compose build --pull'
+      }
+    }
+    stage('Lint') {
+      steps {
+        sh '''
+        docker-compose run --rm app /bin/bash -lc \
+          "rvm-exec 2.6 bundle exec rubocop --fail-level autocorrect"
+        '''
+      }
+    }
+    stage('Unit Tests') {
+      steps { script { parallel buildMatrix } }
+    }
+    stage('Contract Tests') {
+      steps {
+        sh 'docker-compose run app /bin/bash -l -c "rvm-exec 2.6 bundle exec rspec -t pact"'
+      }
+    }
+    stage ('Publish') {
+      when { environment name: "GERRIT_EVENT_TYPE", value: "change-merged"}
+      environment {
+        PACT_BROKER_PASSWORD = credentials('pact_broker_password')
+        JENKINS_URL = "${env.JENKINS_URL}"
+        PACT_CONSUMER_TAG = 'master'
+        PACT_BROKER_USERNAME = 'quizzes'
+        PACT_BROKER_HOST = 'inst-pact-broker.inseng.net'
+      }
+      steps {
+        script {
+          sh '''
+          sha="$(git rev-parse --short HEAD)"
+
+          docker-compose run --rm \
+            -e JENKINS_URL="${JENKINS_URL}" \
+            -e PACT_BROKER_HOST="${PACT_BROKER_HOST}" \
+            -e PACT_BROKER_USERNAME="${PACT_BROKER_USERNAME}" \
+            -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.6 bundle exec rake broker:pact:publish:jenkins_post_merge"
+          '''
+        }
+      }
+    }
+  }
+
+  post {
+    success {
+      sh "docker cp \"${env.BUILD_ID}-ruby-2.6:/usr/src/app/coverage\" ."
+      publishHTML target: [
+                  allowMissing: false,
+                  alwaysLinkToLastBuild: false,
+                  keepAll: true,
+                  reportDir: "coverage",
+                  reportFiles: 'index.html',
+                  reportName: 'Coverage Report'
+                ]
+    }
+    cleanup { // Always runs after all other post conditions=
+      sh 'docker-compose kill'
+      sh 'docker-compose rm -f'
+      sh 'docker images -qf "dangling=true" | xargs docker rmi -f &>/dev/null'
+    }
+  }
+}

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/Rakefile

@@ -1,7 +1,7 @@
 require 'bundler/gem_tasks'
 require 'pact_broker/client/tasks'
 require 'rspec/core/rake_task'
-require_relative './spec/contracts/pact_config'
+require_relative './spec/support/pact_config'
 
 RSpec::Core::RakeTask.new(:spec)
 

data/bin/contracts-generate

@@ -14,7 +14,7 @@ function print_results() {
   docker cp contracts:/usr/src/app/pacts . &> /dev/null
   docker rm -f contracts &> /dev/null
 
-  docker-compose rm -fv contracts-testrunner &> /dev/null
+  docker-compose rm -fv app &> /dev/null
 }
 trap print_results INT TERM EXIT
 set -e
@@ -22,6 +22,5 @@ set -e
 rm -rf pacts
 sha="$(git rev-parse --short HEAD)"
 
-
-docker-compose run --name contracts -e SHA="${sha}" contracts-testrunner bash -c \
-  "bundle && bundle exec rspec spec/contracts && bundle exec rake broker:pact:publish:local"
+docker-compose run --name contracts -e SHA="${sha}" app bash -l -c \
+  "bundle && bundle exec rspec --tag pact && bundle exec rake broker:pact:publish:local"

data/docker-compose.dev.override.yml

@@ -1,19 +1,11 @@
-version: '2'
+version: '3.5'
 
 services:
-  testrunner:
-    volumes:
-      - .:/app
-      - bundler-config:/home/docker/.rvm/gems/ruby-2.4.0
-
-  contracts-testrunner:
-    #external_links:                                        # linux
-    #  - dory_dinghy_http_proxy:pact-broker.docker          # linux
+  app:
+    # This port doesn't exist, but doing this tricks Dory proxy into hooking up
+    # the container so it can actually talk to the Pact Broker.
+    expose: [8080]
+    external_links:
+      - ${PROXY_CONTAINER:-dinghy_http_proxy}:pact-broker.docker
     volumes:
       - .:/usr/src/app
-      #- api-logs:/usr/src/app/log                          # linux:fs
-      - bundler-config:/home/docker/.rvm/gems/ruby-2.4.0
-
-volumes:
-  bundler-config: {}
-  api-logs: {}

data/docker-compose.yml

@@ -1,13 +1,8 @@
-version: '2'
+version: '3.5'
 
 services:
-  testrunner:
+  app:
     build: .
-
-  contracts-testrunner:
-    build:
-      context: .
-      dockerfile: Dockerfile.contracts
     volumes:
       - pacts:/usr/src/app/pacts
 

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
 
@@ -23,6 +23,7 @@ module QuizApiClient
 
     def get(path, all: false, query: {})
       return make_request :get, url_for(path), query: query unless all
+
       make_paginated_request :get, url_for(path), query: query
     end
 
@@ -48,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 = {
@@ -80,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)
@@ -90,7 +91,8 @@ 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)
       end
@@ -107,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
@@ -119,6 +121,7 @@ module QuizApiClient
 
     def next_page_link(response, options)
       return if response.headers['link'].blank?
+
       links = LinkHeader.parse(response.headers['link']).links
       next_link = links.find { |link| link['rel'] == 'next' }
       [next_link.href, options] if next_link
@@ -135,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/item_analyses_service.rb

@@ -2,6 +2,7 @@ module QuizApiClient::Services
   class ItemAnalysesService < BaseApiService
     def list(params:, token: nil, all: false)
       raise 'Quiz Id Required' unless params.key?(:quiz_id)
+
       client(token: token).get(
         "/api/quizzes/#{params[:quiz_id]}/stats/item_analyses",
         all: all
@@ -10,6 +11,7 @@ module QuizApiClient::Services
 
     def get(params:, token: nil)
       raise 'Quiz Id and Item Id are Required' unless params.key?(:id) && params.key?(:quiz_id)
+
       client(token: token).get(
         "/api/quizzes/#{params[:quiz_id]}/stats/item_analyses/#{params[:id]}"
       )

data/lib/quiz_api_client/services/items_service.rb

@@ -2,6 +2,7 @@ module QuizApiClient::Services
   class ItemsService < BaseApiService
     def create(params:, token: nil)
       raise 'Quiz Id Required' unless params && params[:quiz_id]
+
       post_to_quiz_api(params: params, token: token)
     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/services/qti_imports_service.rb

@@ -2,16 +2,26 @@ module QuizApiClient::Services
   class QtiImportsService < BaseApiService
     def create(params:, token: nil)
       raise 'Quiz Id Required' unless params && params[:quiz_id]
-      post_to_quiz_api(params: params, token: token)
-    end
-
-    private
 
-    def post_to_quiz_api(params:, token:)
       client(token: token).post(
         "/api/quizzes/#{params[:quiz_id]}/qti_imports",
         qti_import: params
       )
     end
+
+    def banks(params:, token: nil)
+      client(token: token).post(
+        '/api/qti_imports/banks',
+        qti_import: params
+      )
+    end
+
+    def get_imported_consumer_settings(params:, token: nil)
+      raise 'Quiz Id Required' unless params && params[:quiz_id]
+
+      client(token: token).get(
+        "/api/quizzes/#{params[:quiz_id]}/qti_imports/imported_consumer_settings"
+      )
+    end
   end
 end

data/lib/quiz_api_client/services/quiz_analyses_service.rb

@@ -2,6 +2,7 @@ module QuizApiClient::Services
   class QuizAnalysesService < BaseApiService
     def get(params:, token: nil)
       raise 'Quiz Id Required' unless params.key?(:quiz_id)
+
       get_from_quiz_api(params: params, token: token)
     end
 

data/lib/quiz_api_client/services/quiz_clone_job_service.rb

@@ -2,6 +2,7 @@ module QuizApiClient::Services
   class QuizCloneJobService < BaseApiService
     def show(params:, token: nil)
       raise 'Quiz Clone Job Id Required' unless params && params[:id]
+
       get_from_quiz_api(params: params, token: token)
     end
 

data/lib/quiz_api_client/services/quiz_entries_service.rb

@@ -2,17 +2,20 @@ module QuizApiClient::Services
   class QuizEntriesService < BaseApiService
     def create(params:, token: nil)
       raise 'Quiz Id Required' unless params && params[:id]
+
       post_to_quiz_api(params: params, token: token)
     end
 
     def list(params:, token: nil, all: false)
       raise 'Quiz Id Required' unless params && params[:id]
+
       get_from_quiz_api(params: params, token: token, all: all)
     end
 
     def destroy(params:, token: nil)
       raise 'Quiz Id Required' unless params && params[:quiz_id]
       raise 'Item Id Required' unless params && params[:id]
+
       delete_from_quiz_api(params, token)
     end
 

data/lib/quiz_api_client/services/quiz_session_events_service.rb

@@ -2,6 +2,7 @@ module QuizApiClient::Services
   class QuizSessionEventsService < BaseApiService
     def list(params:, token: nil, all: false)
       raise 'Quiz Session Id Required' unless params.key?(:quiz_session_id)
+
       get_from_quiz_api(params: params, token: token, all: all)
     end
 

data/lib/quiz_api_client/services/quiz_session_result_service.rb

@@ -2,6 +2,7 @@ module QuizApiClient::Services
   class QuizSessionResultService < BaseApiService
     def show(params:, token: nil)
       raise 'Quiz Session Result Id Required' unless params && params[:id]
+
       get_from_quiz_api(params: params, token: token)
     end
 

data/lib/quiz_api_client/services/quiz_session_service.rb

@@ -6,6 +6,7 @@ module QuizApiClient::Services
 
     def show(params:, token: nil)
       raise 'Quiz Session Id Required' unless params && params[:id]
+
       get_from_quiz_api(params: params, token: token)
     end
 

data/lib/quiz_api_client/services/quiz_sessions_service.rb

@@ -3,6 +3,7 @@ module QuizApiClient::Services
     def list(params:, token: nil)
       raise 'Quiz Id Required' unless params && params[:quiz_id]
       raise 'Quiz Session Ids Required' unless params && params[:ids]
+
       client(token: token).get(
         "/api/quizzes/#{params[:quiz_id]}/quiz_sessions",
         query: params[:ids].to_query('ids')
@@ -11,6 +12,7 @@ module QuizApiClient::Services
 
     def create(params:, token: nil)
       raise 'Quiz Id Required' unless params && params[:quiz_id]
+
       post_to_quiz_api(params: params, token: token)
     end
 

data/lib/quiz_api_client/services/session_item_results_service.rb

@@ -3,6 +3,7 @@ module QuizApiClient::Services
     def list(params:, token: nil, all: false)
       raise 'QuizSession Id Required' unless params && params[:quiz_session_id]
       raise 'QuizSessionResult Id Required' unless params && params[:quiz_session_result_id]
+
       get_from_quiz_api(params: params, token: token, all: all)
     end
 

data/lib/quiz_api_client/services/session_items_service.rb

@@ -2,6 +2,7 @@ module QuizApiClient::Services
   class SessionItemsService < BaseApiService
     def list(params:, token: nil, all: false)
       raise 'QuizSession Id Required' unless params && params[:quiz_session_id]
+
       get_from_quiz_api(params: params, token: token, all: all)
     end
 

data/lib/quiz_api_client/services/shared_banks.rb

@@ -2,6 +2,7 @@ module QuizApiClient::Services
   class SharedBanks < BaseApiService
     def list(params:, token: nil, all: false)
       raise 'Bank Id Required' unless params && params[:bank_id]
+
       client(token: token).get(
         "/api/banks/#{params[:bank_id]}/shared_banks",
         all: all
@@ -10,6 +11,7 @@ module QuizApiClient::Services
 
     def create(params:, token: nil)
       raise 'Bank Id Required' unless params && params[:bank_id]
+
       client(token: token).post(
         "/api/banks/#{params[:bank_id]}/shared_banks",
         params
@@ -19,6 +21,7 @@ module QuizApiClient::Services
     def update(params:, token: nil)
       raise 'Bank Id Required' unless params && params[:bank_id]
       raise 'Shared Bank Id Required' unless params && params[:shared_bank_id]
+
       shared_bank_id = params.delete(:shared_bank_id)
       client(token: token).put(
         "/api/banks/#{params[:bank_id]}/shared_banks/#{shared_bank_id}",

data/lib/quiz_api_client/version.rb

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

@@ -1,4 +1,4 @@
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'quiz_api_client/version'
 
@@ -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,18 +42,18 @@ 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.3'
+  spec.required_ruby_version = '>= 2.6'
 
-  spec.add_dependency 'httparty', '~> 0.14.0'
-  spec.add_dependency 'jwt', '>= 1.5', '< 3.0'
+  spec.add_dependency 'httparty', '~> 0.17'
+  spec.add_dependency 'jwt', '~> 2.2'
   spec.add_dependency 'link_header', '~> 0.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.15'
-  spec.add_development_dependency 'pact', '~> 1.20.1'
-  spec.add_development_dependency 'pact_broker-client', '~> 1.14.0'
-  spec.add_development_dependency 'rake', '~> 12.0'
-  spec.add_development_dependency 'rspec', '~> 3.7'
-  spec.add_development_dependency 'rubocop', '~> 0.52.1'
+  spec.add_development_dependency 'pact', '~> 1.41'
+  spec.add_development_dependency 'pact_broker-client', '~> 1.19'
+  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: 2.9.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: 2019-03-05 00:00:00.000000000 Z
+date: 2021-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -27,34 +28,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: '0.17'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: '0.17'
 - !ruby/object:Gem::Dependency
   name: jwt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.5'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.5'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: link_header
   requirement: !ruby/object:Gem::Requirement
@@ -70,89 +65,89 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: pact
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '1.41'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '1.41'
 - !ruby/object:Gem::Dependency
-  name: pact
+  name: pact_broker-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.20.1
+        version: '1.19'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.20.1
+        version: '1.19'
 - !ruby/object:Gem::Dependency
-  name: pact_broker-client
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.14.0
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.14.0
+        version: '12.3'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '3.8'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: 0.74.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: 0.74.0
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: sentry-raven
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.52.1
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.52.1
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -181,7 +176,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - acallejas@instructure.com
 - bpetty@instructure.com
@@ -189,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
@@ -205,17 +201,17 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - Dockerfile
-- Dockerfile.contracts
 - Gemfile
+- Jenkinsfile
 - README.md
 - Rakefile
 - bin/console
 - bin/contracts-generate
 - bin/setup
-- build.sh
 - 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
@@ -239,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
@@ -250,16 +246,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Ruby client for quiz_api
 test_files: []

data/Dockerfile.contracts

@@ -1,19 +0,0 @@
-FROM instructure/ruby:2.3
-
-USER root
-
-ENV APP_HOME /usr/src/app
-RUN mkdir -p $APP_HOME/log
-RUN mkdir -p $APP_HOME/pacts
-
-COPY quiz_api_client.gemspec Gemfile $APP_HOME/
-COPY lib/quiz_api_client/version.rb $APP_HOME/lib/quiz_api_client/version.rb
-
-USER docker
-RUN bundle install --quiet --jobs 8
-
-USER root
-COPY . $APP_HOME
-RUN chown -R docker:docker $APP_HOME
-
-USER docker

data/build.sh

@@ -1,49 +0,0 @@
-#!/usr/bin/env bash
-
-set -ex
-
-function publish_pact_file_to_pact_broker()
-{
-  echo "Publishing pact file to Pact Broker..."
-
-  sha="$(git rev-parse --short HEAD)"
-
-  docker-compose run --rm \
-    -e JENKINS_URL="${JENKINS_URL}" \
-    -e PACT_BROKER_HOST="${PACT_BROKER_HOST}" \
-    -e PACT_BROKER_USERNAME="${PACT_BROKER_USERNAME}" \
-    -e PACT_BROKER_PASSWORD="${PACT_BROKER_PASSWORD}" \
-    -e PACT_CONSUMER_TAG="${PACT_CONSUMER_TAG}" \
-    -e SHA="${sha}" \
-    contracts-testrunner bundle exec rake broker:pact:publish:jenkins_post_merge
-}
-
-function cleanup() {
-  exit_code=$?
-  set +e
-  docker cp coverage:/app/coverage .
-  docker-compose kill
-  docker-compose rm -f
-  exit $exit_code
-}
-trap cleanup INT TERM EXIT
-
-docker-compose build --pull
-
-echo "Running Rubocop..."
-docker-compose run --rm testrunner /bin/bash -lc \
-  "rvm-exec 2.4 bundle exec rubocop --fail-level autocorrect"
-
-echo "Running test suite..."
-docker-compose run --name coverage testrunner $@
-
-echo
-echo "Running contract tests..."
-docker-compose run --name contracts -T contracts-testrunner bundle exec rspec spec/contracts
-docker cp contracts:/usr/src/app/pacts .
-docker cp contracts:/usr/src/app/log .
-echo
-
-if [[ "${GERRIT_EVENT_TYPE}" == "change-merged" ]]; then
-  publish_pact_file_to_pact_broker
-fi