quiz_api_client 2.4.0 → 2.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f109a4af811b6581467d20b04bc580c1f2a3c209
-  data.tar.gz: 73ffe5b91db4ffa77db9de146b29c8162aaef2db
+  metadata.gz: b2a00510f91eb1597a6677ddd7db7342293cbead
+  data.tar.gz: c1328d1480d86fa91731d575eadd820038ac51d5
 SHA512:
-  metadata.gz: 355d7520d371d4cf3a19cb42def9ff1eee21e70eefe6e001b2e0558d6a26dfca1abd9a48d9c184f33ff2bf4ec0d338497729acfa749d73736c490106018509ed
-  data.tar.gz: f99bbc820678763fd8caee43d27ea3ee78f6bb02591c3a0bc833889d754421b088a7b218615ea9940b97bc7dbf94cf2073105772fcf1c8dcfe4bcd3ff5fafdda
+  metadata.gz: 1a3445f192bd75c78fdd3f42f46c2d254ab191bbb9e7c805b77da90244072b8d1467d0001af3591187f8257558bb1adb00e4d5e85c4018cbe180b77e33fc3d5e
+  data.tar.gz: 7eb2997e14243ce80868d28995892c7aeb73f85807c16e3e6f98a1017f7dc33365c29199892c3d4fbd95a9669ff434d387cb99e0fd92ef6dfb0a2e501a143a71

data/README.md

@@ -179,3 +179,53 @@ Then, run `rake spec` to run the tests.
 You can also run `rake console` for an interactive prompt that will allow you to experiment.
 
 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).
+
+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.
+
+### 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
+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
+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
+
+Bonus: You can view your Pact file in the Pact Broker at http://pact-broker.docker
+along with some cool goodies!
+
+### Debugging Failures
+
+Pact has some basic RSpec output for failed specs. It also keeps a log in
+`log/pact.log` and offers general pointers for debugging.
+
+Above all, learn the Pact [basics](https://docs.pact.io/documentation/matching.html).
+
+### What should contract tests cover?
+
+The aim of contract testing here is *not* to test all functional requirements
+of the Quiz API service. Rather, the goal is to ensure changes to the Quiz API
+service don't break its clients. We can best accomplish this with the
+following contract test coverage:
+
+- Basic happy path requests for all endpoints (POST, GET, PUT, DELETE)
+- Basic error paths for all endpoints (verify the error messages and/or HTTP
+response codes are accurate)
+- Resource state management; for example, when a quiz attempt is submitted but
+not yet graded
+- Special edge case errors
+
+Again, what *not* to test: the functional behavior of the service; for
+example, a series of sequential API calls to test a full user scenario.

data/Rakefile

@@ -1,4 +1,5 @@
 require 'bundler/gem_tasks'
+require 'pact_broker/client/tasks'
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
@@ -17,3 +18,34 @@ task :console do
   ARGV.clear
   Pry.start
 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' }
+
+  # 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|
+  require 'quiz_api_client'
+
+  task.consumer_version = QuizApiClient::VERSION
+  task.pattern = 'pacts/*.json'
+
+  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.tag = 'master'
+  puts "Pact file tagged with: #{task.tag}"
+end

data/bin/contracts

@@ -4,16 +4,18 @@ function print_results() {
   exit_code=$?
   set +e
 
-  docker-compose rm -fv contracts-testrunner
-
   if [[ "$exit_code" == "0" ]]; then
-    echo ""
-    echo "Success!"
+    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-compose rm -fv contracts-testrunner &> /dev/null
 }
 trap print_results INT TERM EXIT
 set -e
 
-docker-compose run --name contracts contracts-testrunner bundle && bundle exec rspec spec/contracts
-docker cp contracts:/usr/src/app/log .
-docker cp contracts:/usr/src/app/pacts .
+docker-compose run --name contracts contracts-testrunner bash -c "bundle && bundle exec rspec spec/contracts && bundle exec rake pact:publish:local"

data/build.sh

@@ -2,11 +2,15 @@
 
 set -ex
 
-function save_pact_files_to_s3()
+function publish_pact_file_to_pact_broker()
 {
-  echo "Saving pact files to S3..."
-  folder=${1:-latest}
-  aws s3 cp pacts s3://ci-asset-cache/pacts/${JOB_NAME}/${folder} --recursive --only-show-errors --region us-east-1
+  echo "Publishing pact file to Pact Broker..."
+
+  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
 }
 
 function cleanup() {
@@ -23,12 +27,13 @@ docker-compose build --pull
 echo "Running test suite..."
 docker-compose run --name coverage testrunner $@
 
-echo ""
+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
-  save_pact_files_to_s3
+  publish_pact_file_to_pact_broker
 fi

data/docker-compose.dev.override.yml

@@ -3,8 +3,13 @@ version: '2'
 services:
   testrunner:
     volumes:
-      - .:/usr/src/app/
+      - .:/app
+      - bundler-config:/home/docker/.rvm/gems/ruby-2.4.0
 
   contracts-testrunner:
     volumes:
-      - .:/usr/src/app/
+      - .:/app
+      - bundler-config:/home/docker/.rvm/gems/ruby-2.4.0
+
+volumes:
+  bundler-config: {}

data/docker-compose.yml

@@ -8,3 +8,8 @@ services:
     build:
       context: .
       dockerfile: Dockerfile.contracts
+    volumes:
+      - pacts:/usr/src/app/pacts
+
+volumes:
+  pacts: {}

data/lib/quiz_api_client/http_client.rb

@@ -15,25 +15,31 @@ module QuizApiClient
       initialize_logger(log_level) if logging
     end
 
+    def url_for(path)
+      url = URI(uri)
+      url.path = path
+      url.to_s
+    end
+
     def get(path, all: false, query: {})
-      return make_request :get, path, query: query unless all
-      make_paginated_request :get, path, query: query
+      return make_request :get, url_for(path), query: query unless all
+      make_paginated_request :get, url_for(path), query: query
     end
 
     def post(path, body = {})
-      make_request :post, path, body: body.to_json
+      make_request :post, url_for(path), body: body.to_json
     end
 
     def patch(path, body = {})
-      make_request :patch, path, body: body.to_json
+      make_request :patch, url_for(path), body: body.to_json
     end
 
     def put(path, body = {})
-      make_request :put, path, body: body.to_json
+      make_request :put, url_for(path), body: body.to_json
     end
 
     def delete(path)
-      make_request :delete, path
+      make_request :delete, url_for(path)
     end
 
     private
@@ -65,24 +71,24 @@ module QuizApiClient
       end
     end
 
-    def make_request(method, path, request_options = {})
+    def make_request(method, url, request_options = {})
       self.class.send(
         method,
-        "#{uri}#{path}",
+        url,
         default_request_data.merge(request_options)
       )
     rescue HTTParty::Error, Errno::ECONNREFUSED, Net::ReadTimeout => e
       raise RequestFailed, e.message
     end
 
-    def make_paginated_request(method, path, request_options)
+    def make_paginated_request(method, url, request_options)
       entities = []
-      request_path = path
+      request_url = url
 
-      until request_path.nil? do
-        resp = make_request(method, request_path, request_options)
+      until request_url.nil? do
+        resp = make_request(method, request_url, request_options)
         entities.concat(resp.parsed_response)
-        request_path = next_page(resp)
+        request_url = next_page(resp)
       end
       entities
     end

data/lib/quiz_api_client/version.rb

@@ -1,3 +1,3 @@
 module QuizApiClient
-  VERSION = '2.4.0'.freeze
+  VERSION = '2.4.1'.freeze
 end

data/lib/quiz_api_client.rb

@@ -1,5 +1,6 @@
 require 'httparty'
 require 'jwt'
+require 'link_header'
 
 module QuizApiClient
   class Client

data/quiz_api_client.gemspec

@@ -48,7 +48,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.12'
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'webmock'
-  spec.add_development_dependency 'pact', '~> 1.12.0'
+  spec.add_development_dependency 'pact', '~> 1.16.0'
+  spec.add_development_dependency 'pact_broker-client', '~> 1.6.0'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quiz_api_client
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.4.1
 platform: ruby
 authors:
 - Chris Wang
@@ -19,7 +19,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-28 00:00:00.000000000 Z
+date: 2017-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -111,14 +111,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.0
+        version: 1.16.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.0
+        version: 1.16.0
+- !ruby/object:Gem::Dependency
+  name: pact_broker-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -219,7 +233,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby client for quiz_api