quiz_api_client 4.2.0 → 4.4.0

data/spec/support/pact_config.rb

@@ -0,0 +1,64 @@
+module PactConfig
+  # These constants ensure we use the correct strings and thus help avoid our
+  # accidentally breaking the contract tests
+  QUIZ_API_CLIENT_RUBY = 'Quiz API Client Ruby'.freeze
+
+  # Add new API and LiveEvents providers to this Providers module
+  module Providers
+    QUIZ_API = 'Quiz API'.freeze
+    ALL = Providers.constants.map { |c| Providers.const_get(c) }.freeze
+  end
+
+  class << self
+    def pact_uri(pact_path:)
+      URI::HTTP.build(
+        scheme: protocol,
+        userinfo: "#{broker_username}:#{broker_password}",
+        host: broker_host,
+        path: "/#{pact_path}/#{consumer_tag}"
+      ).to_s
+    end
+
+    def broker_uri
+      URI::HTTP.build(
+        scheme: protocol,
+        userinfo: "#{broker_username}:#{broker_password}",
+        host: broker_host
+      ).to_s
+    end
+
+    def broker_host
+      ENV.fetch('PACT_BROKER_HOST', 'pact-broker.docker')
+    end
+
+    def consumer_tag
+      ENV.fetch('PACT_CONSUMER_TAG', 'local')
+    end
+
+    def consumer_version
+      version = QuizApiClient::VERSION
+      sha = ENV['SHA']
+      version = "#{version}+#{sha}" if sha
+      version
+    end
+
+    def broker_password
+      ENV.fetch('PACT_BROKER_PASSWORD', 'broker')
+    end
+
+    def broker_username
+      ENV.fetch('PACT_BROKER_USERNAME', 'pact')
+    end
+
+    private
+
+    def jenkins_build?
+      !ENV['JENKINS_URL'].nil?
+    end
+
+    def protocol
+      protocol = jenkins_build? ? 'https' : 'http'
+      ENV.fetch('PACT_BROKER_PROTOCOL', protocol)
+    end
+  end
+end

data/spec/support/pact_helper.rb

@@ -0,0 +1,19 @@
+module PactHelper
+  def token_expiration_one_year
+    token_expiration_seconds_from_now(seconds: 31_536_000)
+  end
+
+  def token_expiration_seconds_from_now(seconds:)
+    Time.now.utc.to_i + seconds
+  end
+
+  def headers(token)
+    {
+      'Content-Type' => 'application/json',
+      'AuthType' => 'Signature',
+      'Accept' => 'application/json',
+      'Authorization' => token.to_s,
+      'HOST' => 'localhost:1234'
+    }
+  end
+end

metadata

@@ -1,26 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: quiz_api_client
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 4.4.0
 platform: ruby
 authors:
-- Chris Wang
-- Augusto Callejas
-- Bryan Petty
-- Christian Prescott
-- Han Yan
+- Alex Slaughter
 - Jayce Higgins
-- Marc Alan Phillips
+- Jorge Arteaga
 - Mark Starkman
-- Michael Brewer-Davis
 - Michael Hargiss
-- Omar Khan
 - Robin Kuss
 - Ryan Taylor
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-19 00:00:00.000000000 Z
+date: 2022-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -190,41 +184,21 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
+description: 
 email:
-- acallejas@instructure.com
-- bpetty@instructure.com
-- cprescott@instructure.com
-- hyan@instructure.com
+- aslaughter@instructure.com
 - jhiggins@instructure.com
-- mphillips@instructure.com
+- jorge.arteaga@instructure.com
 - mark.starkman@instructure.com
-- mbd@instructure.com
 - mhargiss@instructure.com
-- okhan@instructure.com
 - rkuss@instructure.com
 - rtaylor@instructure.com
-- cwang@instructure.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".dockerignore"
-- ".editorconfig"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- CHANGELOG.md
-- Dockerfile
-- Gemfile
-- Jenkinsfile
 - README.md
 - Rakefile
-- bin/console
-- bin/contracts-generate
-- bin/setup
-- 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
@@ -232,6 +206,7 @@ files:
 - lib/quiz_api_client/http_request/metrics.rb
 - lib/quiz_api_client/json_formatter.rb
 - lib/quiz_api_client/services/base_api_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
 - lib/quiz_api_client/services/items_service.rb
@@ -246,16 +221,70 @@ files:
 - lib/quiz_api_client/services/quiz_session_result_service.rb
 - lib/quiz_api_client/services/quiz_session_service.rb
 - lib/quiz_api_client/services/quiz_sessions_service.rb
+- lib/quiz_api_client/services/quiz_sync_job_service.rb
+- lib/quiz_api_client/services/quiz_sync_jobs_service.rb
 - lib/quiz_api_client/services/quizzes_service.rb
 - lib/quiz_api_client/services/session_item_results_service.rb
 - lib/quiz_api_client/services/session_items_service.rb
 - lib/quiz_api_client/services/shared_banks.rb
 - lib/quiz_api_client/version.rb
-- quiz_api_client.gemspec
-homepage:
+- spec/config_spec.rb
+- spec/contracts/interaction_types_service_spec.rb
+- spec/contracts/item_analyses_service_spec.rb
+- spec/contracts/items_service_spec.rb
+- spec/contracts/qti_imports_service_spec.rb
+- spec/contracts/quiz_clone_job_service_spec.rb
+- spec/contracts/quiz_clone_jobs_service_spec.rb
+- spec/contracts/quiz_entries_service_spec.rb
+- spec/contracts/quiz_service_spec.rb
+- spec/contracts/quiz_session_events_service_spec.rb
+- spec/contracts/quiz_session_result_service_spec.rb
+- spec/contracts/quiz_session_service_spec.rb
+- spec/contracts/quiz_sessions_service_spec.rb
+- spec/contracts/quiz_sync_job_service_spec.rb
+- spec/contracts/quiz_sync_jobs_service_spec.rb
+- spec/contracts/quizzes_service_spec.rb
+- spec/contracts/session_item_results_service_spec.rb
+- spec/contracts/session_items_service_spec.rb
+- spec/contracts/shared_banks_spec.rb
+- spec/contracts/shared_examples/http_delete_example.rb
+- spec/contracts/shared_examples/http_get_example.rb
+- spec/contracts/shared_examples/http_patch_example.rb
+- spec/contracts/shared_examples/http_post_example.rb
+- spec/contracts/shared_examples/http_put_example.rb
+- spec/http_client_spec.rb
+- spec/json_formatter_spec.rb
+- spec/quiz_api_client/http_request/failure_spec.rb
+- spec/quiz_api_client/http_request/metrics_spec.rb
+- spec/quiz_api_client_spec.rb
+- spec/services/base_api_service_spec.rb
+- spec/services/courses_service_spec.rb
+- spec/services/interaction_types_service_spec.rb
+- spec/services/item_analyses_service_spec.rb
+- spec/services/items_service_spec.rb
+- spec/services/jwt_service_spec.rb
+- spec/services/qti_imports_service_spec.rb
+- spec/services/quiz_analyses_service_spec.rb
+- spec/services/quiz_clone_job_service_spec.rb
+- spec/services/quiz_clone_jobs_service_spec.rb
+- spec/services/quiz_entries_service_spec.rb
+- spec/services/quiz_service_spec.rb
+- spec/services/quiz_session_events_service_spec.rb
+- spec/services/quiz_session_result_service_spec.rb
+- spec/services/quiz_session_service_spec.rb
+- spec/services/quiz_sessions_service_spec.rb
+- spec/services/quiz_sync_job_service_spec.rb
+- spec/services/quiz_sync_jobs_service_spec.rb
+- spec/services/quizzes_service_spec.rb
+- spec/services/session_item_results_service_spec.rb
+- spec/services/session_items_service_spec.rb
+- spec/spec_helper.rb
+- spec/support/pact_config.rb
+- spec/support/pact_helper.rb
+homepage: 
 licenses: []
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -271,7 +300,60 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.6
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Ruby client for quiz_api
-test_files: []
+test_files:
+- spec/config_spec.rb
+- spec/contracts/interaction_types_service_spec.rb
+- spec/contracts/item_analyses_service_spec.rb
+- spec/contracts/items_service_spec.rb
+- spec/contracts/qti_imports_service_spec.rb
+- spec/contracts/quiz_clone_job_service_spec.rb
+- spec/contracts/quiz_clone_jobs_service_spec.rb
+- spec/contracts/quiz_entries_service_spec.rb
+- spec/contracts/quiz_service_spec.rb
+- spec/contracts/quiz_session_events_service_spec.rb
+- spec/contracts/quiz_session_result_service_spec.rb
+- spec/contracts/quiz_session_service_spec.rb
+- spec/contracts/quiz_sessions_service_spec.rb
+- spec/contracts/quiz_sync_job_service_spec.rb
+- spec/contracts/quiz_sync_jobs_service_spec.rb
+- spec/contracts/quizzes_service_spec.rb
+- spec/contracts/session_item_results_service_spec.rb
+- spec/contracts/session_items_service_spec.rb
+- spec/contracts/shared_banks_spec.rb
+- spec/contracts/shared_examples/http_delete_example.rb
+- spec/contracts/shared_examples/http_get_example.rb
+- spec/contracts/shared_examples/http_patch_example.rb
+- spec/contracts/shared_examples/http_post_example.rb
+- spec/contracts/shared_examples/http_put_example.rb
+- spec/http_client_spec.rb
+- spec/json_formatter_spec.rb
+- spec/quiz_api_client/http_request/failure_spec.rb
+- spec/quiz_api_client/http_request/metrics_spec.rb
+- spec/quiz_api_client_spec.rb
+- spec/services/base_api_service_spec.rb
+- spec/services/courses_service_spec.rb
+- spec/services/interaction_types_service_spec.rb
+- spec/services/item_analyses_service_spec.rb
+- spec/services/items_service_spec.rb
+- spec/services/jwt_service_spec.rb
+- spec/services/qti_imports_service_spec.rb
+- spec/services/quiz_analyses_service_spec.rb
+- spec/services/quiz_clone_job_service_spec.rb
+- spec/services/quiz_clone_jobs_service_spec.rb
+- spec/services/quiz_entries_service_spec.rb
+- spec/services/quiz_service_spec.rb
+- spec/services/quiz_session_events_service_spec.rb
+- spec/services/quiz_session_result_service_spec.rb
+- spec/services/quiz_session_service_spec.rb
+- spec/services/quiz_sessions_service_spec.rb
+- spec/services/quiz_sync_job_service_spec.rb
+- spec/services/quiz_sync_jobs_service_spec.rb
+- spec/services/quizzes_service_spec.rb
+- spec/services/session_item_results_service_spec.rb
+- spec/services/session_items_service_spec.rb
+- spec/spec_helper.rb
+- spec/support/pact_config.rb
+- spec/support/pact_helper.rb

data/.dockerignore

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

data/.editorconfig

@@ -1,16 +0,0 @@
-# .editorconfig
-# Please install EditorConfig plugin for your editor or IDE
-# Usage and plugin list can be found here: http://EditorConfig.org
-
-# top-most EditorConfig file
-root = true
-
-[*]
-end_of_line = lf
-indent_style = space
-indent_size = 2
-insert_final_newline = true
-trim_trailing_whitespace = true
-
-[*.md]
-indent_size = 4

data/.gitignore

@@ -1,13 +0,0 @@
-/.bundle/
-/.yardoc
-/.ruby-version
-/_yardoc/
-/coverage/
-/doc/
-/docker-compose.override.yml
-/Gemfile.lock
-/log/
-/pacts/
-/pkg/
-/spec/reports/
-/tmp/

data/.rspec

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

data/.rubocop.yml

@@ -1,72 +0,0 @@
-AllCops:
-  TargetRubyVersion: 2.6
-
-Metrics/ClassLength:
-  Max: 200 # Default: 100
-
-Metrics/LineLength:
-  Max: 120 # Default: 80
-
-Metrics/MethodLength:
-  Max: 20 # Default: 10
-
-Metrics/BlockLength:
-  Max: 30
-  Exclude:
-    - quiz_api_client.gemspec
-    - spec/**/*.rb
-
-Naming/MemoizedInstanceVariableName:
-  EnforcedStyleForLeadingUnderscores: required
-
-Layout/AlignParameters:
-  # Alignment of parameters in multi-line method calls.
-  #
-  # The `with_fixed_indentation` style aligns the following lines with one
-  # level of indentation relative to the start of the line with the method call.
-  #
-  #     method_call(a,
-  #       b)
-  EnforcedStyle: with_fixed_indentation
-
-Layout/CaseIndentation:
-  EnforcedStyle: end
-
-Layout/EndAlignment:
-  EnforcedStyleAlignWith: variable
-
-Style/ClassAndModuleChildren:
-  # Checks the style of children definitions at classes and modules.
-  #
-  # Basically there are two different styles:
-  #
-  # `nested` - have each child on a separate line
-  #   class Foo
-  #     class Bar
-  #     end
-  #   end
-  #
-  # `compact` - combine definitions as much as possible
-  #   class Foo::Bar
-  #   end
-  #
-  # The compact style is only forced, for classes / modules with one child.
-  EnforcedStyle: nested
-  Enabled: false
-
-Style/Documentation:
-  # This cop checks for missing top-level documentation of classes and modules.
-  # Classes with no body and namespace modules are exempt from the check.
-  # Namespace modules are modules that have nothing in their bodies except
-  # classes or other modules.
-  Enabled: false
-
-Style/FrozenStringLiteralComment:
-  # `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: always
-  Enabled: false

data/CHANGELOG.md

@@ -1,35 +0,0 @@
-CHANGELOG
-=========
-
-All notable changes to this project will be documented in this file. This
-project adheres to [Semantic Versioning](http://semver.org/).
-
-[TOC]
-
-#TODO: Enter the date
-## 4.2.0 ()
-
-### Changed
-* Internal refactor of request error handling
-* Added `metric_handler` and `metrics_namespace` to work with InstStatsd gem
-
-## 4.1.0 (2021-10-27)
-
-### Breaking changes (potentially)
-
-* All non-successful (2xx) responses will raise `QuizApiClient::HttpClient::RequestFailed` error except for 401 and 422
-  * Can be overridden in `allowable_response_codes` config
-
-## 4.0.0 (2021-10-18)
-
-### Breaking changes
-
-* Ruby 2.4.x is no longer supported
-* Ruby 2.5.x is no longer supported
-
-### Changed
-* Minimum Ruby version to 2.6.x
-* Internal classes use a configuration object instead parameters on instantiation
-  * Instantiating `QuizApiClient::Client` remains the same
-* Added `error_handler` configuration to work with Sentry Raven gem
-

data/Dockerfile

@@ -1,12 +0,0 @@
-FROM instructure/rvm
-
-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.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.6 bundle exec rspec"

data/Gemfile

@@ -1,5 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec
-
-gem 'pry'

data/Jenkinsfile

@@ -1,86 +0,0 @@
-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/bin/console

@@ -1,7 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'bundler/setup'
-require 'quiz_api_client'
-require 'irb'
-
-IRB.start

data/bin/contracts-generate

@@ -1,26 +0,0 @@
-#!/usr/bin/env bash
-
-function print_results() {
-  exit_code=$?
-  set +e
-
-  if [[ "$exit_code" == "0" ]]; then
-    echo "Success! Open http://pact-broker.docker to view your published pact file."
-  else
-    echo "Oops! Something went wrong."
-  fi
-
-  docker cp contracts:/usr/src/app/log . &> /dev/null
-  docker cp contracts:/usr/src/app/pacts . &> /dev/null
-  docker rm -f contracts &> /dev/null
-
-  docker-compose rm -fv app &> /dev/null
-}
-trap print_results INT TERM EXIT
-set -e
-
-rm -rf pacts
-sha="$(git rev-parse --short HEAD)"
-
-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/bin/setup

@@ -1,65 +0,0 @@
-#!/usr/bin/env bash
-
-function print_results() {
-  exit_code=$?
-  set +e
-
-  echo ""
-
-  if [[ "$exit_code" == "0" ]]; then
-    echo "Success!"
-  else
-    echo "Something went wrong! Check the output above for details."
-  fi
-}
-trap print_results INT TERM EXIT
-set -e
-
-OSNAME=$(uname | tr "[:upper:]" "[:lower:]")
-
-function generate_docker_override_os () {
-  sed -E  "s/#(.*# ${OSNAME}$)/\1/"
-}
-
-function generate_docker_override_filesystem () {
-  if [ -z "${IGNORE_FILESYSTEM_OVERRIDE}" ]; then
-    sed -E  "s/#(.*# ${OSNAME}:fs)/\1/"
-  else
-    cat
-  fi
-}
-
-function generate_docker_override() {
-  if [ -e docker-compose.override.yml ]; then
-    echo "We found an existing docker-compose.override.yml"
-    echo ""
-    echo "You'll want to merge that file with the version controlled
-  docker-compose.dev.override.yml file to make sure you've got
-  the most recent changes"
-    echo ""
-  else
-    echo "we are building the development example override file to docker-compose.override.yml for you"
-    generate_docker_override_os < docker-compose.dev.override.yml | \
-      generate_docker_override_filesystem > docker-compose.override.yml
-  fi
-}
-
-function os_linux_specific_setup() {
-  mkdir -p log pacts
-}
-
-os_specific_setup() {
-  echo Configuring for "${OSNAME}"
-  case ${OSNAME} in
-    linux)
-      os_linux_specific_setup
-      ;;
-  esac
-}
-
-os_specific_setup
-generate_docker_override
-
-echo ""
-echo "Preparing environment for native development..."
-bundle install

data/docker-compose.dev.override.yml

@@ -1,11 +0,0 @@
-version: '3.5'
-
-services:
-  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

data/docker-compose.yml

@@ -1,10 +0,0 @@
-version: '3.5'
-
-services:
-  app:
-    build: .
-    volumes:
-      - pacts:/usr/src/app/pacts
-
-volumes:
-  pacts: {}