quiz_api_client 2.5.2 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b4180659165856ded9b3764ed9e934de07a3d776
-  data.tar.gz: 88023493343bbf8acecf384db4d30d056f78ac80
+SHA256:
+  metadata.gz: c62d6c7422e6e7955a1d2ff49b5129adfae616cd48e20586226f8793361cf5d6
+  data.tar.gz: 3109b9e79d25dad954ff33ce31be7a6fab7cb78b10ad11865267ff55e52efd11
 SHA512:
-  metadata.gz: aa0eaa98585b415c124008c862696ebad0c185f0f5d425a1c874bcf62575882e527b67e58fb0303bb127567b17278c4de990700535be814cf299888a501746d5
-  data.tar.gz: e1039a2b1ec7403999120785011e87c9205ee9972bfdfdee204e0c5809a37b30dc711b6511edc92d47de9659c087a4f8fcf4bbcc486151ac246184d3d16e93ad
+  metadata.gz: e8d52fbd491cae973d46862f1ea33efc844c12eacf6308c7a5eff9d711a65a9a09769f0f19eec2844696789862ce68bb0859a2ae5cb8b04dbc56401593539407
+  data.tar.gz: 8c989448eab56f161e2a4dfacf6d68f12f7ad4244410e43478374f5cff60942b397312d4b11527e4a6546cc42c8632c93d43575e92db6f6788bd31bec0b451b8

data/README.md

@@ -185,21 +185,19 @@ When you add or modify a service, be sure to add or modify contract tests!
 ## Contract Tests
 
 We use [Pact](https://docs.pact.io/) for our contract testing. To generate
-a Pact file, run `bin/contracts`.
-
-The `bin/contracts` script will generate the Pact file and place it in the
-pacts/ directory. It will also attempt to publish the Pact file to a local
-Pact Broker.
+a Pact file, run `bin/contracts-generate`. The script will generate the Pact
+file and place it in the pacts/ directory. It will also attempt to publish the
+Pact file to a local Pact Broker.
 
 ### Development Workflow:
 
 1. In the quiz_api repo, spin up the Quiz API service with `bin/dev-setup`
 2. In the quiz_pact_broker repo, spin up a Pact Broker with `bin/dev-setup`
 3. In the quiz_api repo, write Pact provider states in the
-spec/service_consumers/quiz_api_client_ruby/ directory as needed
+spec/service_consumers/api/quiz_api_client_ruby/ directory as needed
 4. In this repo's spec/contracts/ directory, write or modify a contract test
-5. In this repo, run `bin/contracts` to generate a Pact file and publish it to
-the Pact Broker
+5. In this repo, run `bin/contracts-generate` to generate a Pact file and
+publish it to the Pact Broker
 6. In the quiz_api repo, run `bin/contracts` to pull the new Pact file from
 the Pact Broker and run the updated contract tests against the Quiz API service
 

data/Rakefile

@@ -1,6 +1,7 @@
 require 'bundler/gem_tasks'
 require 'pact_broker/client/tasks'
 require 'rspec/core/rake_task'
+require_relative './spec/contracts/pact_config'
 
 RSpec::Core::RakeTask.new(:spec)
 
@@ -20,32 +21,28 @@ task :console do
 end
 
 # see https://github.com/pact-foundation/pact_broker-client/blob/master/README.md
-PactBroker::Client::PublicationTask.new(:local) do |task|
-  require 'quiz_api_client'
-
-  task.consumer_version = QuizApiClient::VERSION
-  task.pattern = 'pacts/*.json'
-
-  task.pact_broker_base_url = 'http://pact-broker.docker'
-  task.pact_broker_basic_auth = { username: 'pact', password: 'broker' }
+namespace :broker do
+  PactBroker::Client::PublicationTask.new(:local) do |task|
+    prepare_pact_files_for_publishing(task)
+  end
 
-  # tag the pact with the git branch name
-  task.tag = `git rev-parse --abbrev-ref HEAD`.strip
-  puts "Pact file tagged with: #{task.tag}"
-end
+  PactBroker::Client::PublicationTask.new(:jenkins_post_merge) do |task|
+    prepare_pact_files_for_publishing(task)
+  end
 
-PactBroker::Client::PublicationTask.new(:jenkins_post_merge) do |task|
-  require 'quiz_api_client'
+  def prepare_pact_files_for_publishing(task)
+    task.pattern = 'pacts/*.json'
 
-  task.consumer_version = QuizApiClient::VERSION
-  task.pattern = 'pacts/*.json'
+    task.pact_broker_base_url = PactConfig.broker_host
+    task.pact_broker_basic_auth = {
+      username: PactConfig.broker_username,
+      password: PactConfig.broker_password
+    }
 
-  task.pact_broker_base_url = ENV.fetch('PACT_BROKER_BASE_URL')
-  task.pact_broker_basic_auth = {
-    username: ENV.fetch('PACT_BROKER_BASIC_AUTH_USERNAME'),
-    password: ENV.fetch('PACT_BROKER_BASIC_AUTH_PASSWORD')
-  }
+    task.consumer_version = PactConfig.consumer_version
+    puts "Consumer version: #{task.consumer_version}"
 
-  task.tag = 'master'
-  puts "Pact file tagged with: #{task.tag}"
+    task.tag = PactConfig.consumer_tag
+    puts "Pact file tagged with: #{task.tag}"
+  end
 end

data/bin/{contracts → contracts-generate}

@@ -12,10 +12,16 @@ function print_results() {
 
   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 contracts-testrunner &> /dev/null
 }
 trap print_results INT TERM EXIT
 set -e
 
-docker-compose run --name contracts contracts-testrunner bash -c "bundle && bundle exec rspec spec/contracts && bundle exec rake pact:publish:local"
+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"

data/bin/setup

@@ -15,23 +15,51 @@ function print_results() {
 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
-
-echo ""
-echo "Preparing environment for dockerized development (if you choose to use it)..."
-
-override_file='docker-compose.override.yml'
-dev_override_file='docker-compose.dev.override.yml'
-if [ -f ${override_file} ] && ! cmp ${override_file} ${dev_override_file} --silent; then
-  echo "We found an existing ${override_file}"
-  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 copying the development example override file to docker-compose.override.yml for you."
-  cp ${dev_override_file} ${override_file}
-fi

data/build.sh

@@ -6,11 +6,16 @@ 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 PACT_BROKER_BASE_URL=${PACT_BROKER_BASE_URL} \
-    -e PACT_BROKER_BASIC_AUTH_USERNAME=${PACT_BROKER_BASIC_AUTH_USERNAME} \
-    -e PACT_BROKER_BASIC_AUTH_PASSWORD=${PACT_BROKER_BASIC_AUTH_PASSWORD} \
-    contracts-testrunner bundle exec rake pact:publish:jenkins_post_merge
+    -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() {

data/docker-compose.dev.override.yml

@@ -7,9 +7,13 @@ services:
       - bundler-config:/home/docker/.rvm/gems/ruby-2.4.0
 
   contracts-testrunner:
+    #external_links:                                        # linux
+    #  - dory_dinghy_http_proxy:pact-broker.docker          # linux
     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/lib/quiz_api_client.rb

@@ -34,6 +34,10 @@ module QuizApiClient
       @_quiz_sessions_service ||= Services::QuizSessionsService.new(service_params)
     end
 
+    def quiz_clone_job_service
+      @_quiz_clone_job_service ||= Services::QuizCloneJobService.new(service_params)
+    end
+
     def quiz_clone_jobs_service
       @_quiz_clone_jobs_service ||= Services::QuizCloneJobsService.new(service_params)
     end
@@ -78,6 +82,10 @@ module QuizApiClient
       @_interaction_types_service ||= QuizApiClient::Services::InteractionTypesService.new(service_params)
     end
 
+    def shared_banks
+      @_shared_banks ||= QuizApiClient::Services::SharedBanks.new(service_params)
+    end
+
     private
 
     def service_params
@@ -111,6 +119,8 @@ require 'quiz_api_client/services/quiz_sessions_service'
 require 'quiz_api_client/services/quiz_service'
 require 'quiz_api_client/services/quizzes_service'
 require 'quiz_api_client/services/quiz_session_result_service'
+require 'quiz_api_client/services/quiz_clone_job_service'
 require 'quiz_api_client/services/quiz_clone_jobs_service'
 require 'quiz_api_client/services/session_items_service'
 require 'quiz_api_client/services/session_item_results_service'
+require 'quiz_api_client/services/shared_banks'

data/lib/quiz_api_client/http_client.rb

@@ -90,6 +90,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
         entities.concat(resp.parsed_response)
         request_url, request_options = next_page(resp, url, options)
       end

data/lib/quiz_api_client/services/items_service.rb

@@ -8,8 +8,10 @@ module QuizApiClient::Services
     private
 
     def post_to_quiz_api(params:, token:)
+      quiz_id = params.delete(:quiz_id)
       client(token: token).post(
-        "/api/quizzes/#{params[:quiz_id]}/items",
+        "/api/quizzes/#{quiz_id}/items",
+        quiz_id: quiz_id,
         item: params
       )
     end

data/lib/quiz_api_client/services/quiz_clone_job_service.rb

@@ -0,0 +1,16 @@
+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
+
+    private
+
+    def get_from_quiz_api(params:, token:)
+      client(token: token).get(
+        "/api/quiz_clone_jobs/#{params.fetch(:id)}"
+      )
+    end
+  end
+end

data/lib/quiz_api_client/services/shared_banks.rb

@@ -0,0 +1,29 @@
+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
+      )
+    end
+
+    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
+      )
+    end
+
+    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}",
+        params
+      )
+    end
+  end
+end

data/lib/quiz_api_client/version.rb

@@ -1,3 +1,3 @@
 module QuizApiClient
-  VERSION = '2.5.2'.freeze
+  VERSION = '2.7.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quiz_api_client
 version: !ruby/object:Gem::Version
-  version: 2.5.2
+  version: 2.7.0
 platform: ruby
 authors:
 - Chris Wang
@@ -19,7 +19,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-13 00:00:00.000000000 Z
+date: 2018-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -210,7 +210,7 @@ files:
 - README.md
 - Rakefile
 - bin/console
-- bin/contracts
+- bin/contracts-generate
 - bin/setup
 - build.sh
 - docker-compose.dev.override.yml
@@ -225,6 +225,7 @@ files:
 - lib/quiz_api_client/services/jwt_service.rb
 - lib/quiz_api_client/services/qti_imports_service.rb
 - lib/quiz_api_client/services/quiz_analyses_service.rb
+- lib/quiz_api_client/services/quiz_clone_job_service.rb
 - lib/quiz_api_client/services/quiz_clone_jobs_service.rb
 - lib/quiz_api_client/services/quiz_entries_service.rb
 - lib/quiz_api_client/services/quiz_service.rb
@@ -235,6 +236,7 @@ files:
 - 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: 
@@ -256,7 +258,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Ruby client for quiz_api