quiz_api_client 4.2.1 → 4.5.0

data/spec/contracts/shared_examples/http_get_example.rb

@@ -1,139 +0,0 @@
-shared_context 'http get' do
-  let(:quizzes_api_path) { raise 'Override in spec' }
-  let(:consumer_key) { 'consumer key' }
-  let(:consumer_request_id) { 'consumer request id' }
-  let(:host) { 'localhost:1234' }
-  let(:shared_secret) { 'secret' }
-  let(:scope) { raise 'Override in spec' }
-  let(:resource_id) { nil }
-  let(:response_headers) { { 'Content-Type' => 'application/json; charset=utf-8' } }
-  let(:response_body) { raise 'Override in spec' }
-  let(:service_name) { raise 'Override in spec' }
-  let(:status) { 200 }
-  let(:provider_state) { raise 'Override in spec' }
-  let(:user) { nil }
-  let(:params) { raise 'Override in spec' }
-  let(:query_params) { {} }
-  let(:request_description) { raise 'Override in spec (must be unique!)' }
-
-  let(:client) do
-    QuizApiClient::Client.new(
-      consumer_key: consumer_key,
-      consumer_request_id: consumer_request_id,
-      host: host,
-      shared_secret: shared_secret,
-      protocol: 'http'
-    )
-  end
-end
-
-shared_examples 'a http get request to quiz_api' do
-  include_context 'http get'
-
-  context 'retrieving a single resource' do
-    let(:token) do
-      client.jwt_service.grant_permission(
-        exp: token_expiration_one_year,
-        scope: scope,
-        uuid: user,
-        resource_id: resource_id
-      )
-    end
-
-    before do
-      quiz_api
-        .given(provider_state)
-        .upon_receiving(request_description)
-        .with(
-          method: :get,
-          path: quizzes_api_path,
-          headers: headers(token),
-          query: query_params
-        )
-        .will_respond_with(
-          status: status,
-          headers: response_headers,
-          body: response_body
-        )
-    end
-
-    it 'verifies the request is valid' do
-      result = client.send(service_name).show(token: token, params: params)
-      expect(result).to be_truthy
-    end
-  end
-end
-
-shared_examples 'a http get request to quiz_api collection endpoint' do
-  include_context 'http get'
-
-  context 'retrieving a list of resources' do
-    let(:token) do
-      client.jwt_service.grant_permission(
-        exp: token_expiration_one_year,
-        scope: scope,
-        uuid: user,
-        resource_id: resource_id
-      )
-    end
-
-    before do
-      quiz_api
-        .given(provider_state)
-        .upon_receiving(request_description)
-        .with(
-          method: :get,
-          path: quizzes_api_path,
-          headers: headers(token),
-          query: query_params
-        )
-        .will_respond_with(
-          status: status,
-          headers: response_headers,
-          body: response_body
-        )
-    end
-
-    it 'verifies the request is valid' do
-      result = client.send(service_name).list(token: token, params: params)
-      expect(result).to be_truthy
-    end
-  end
-end
-
-shared_examples 'a http get only request to quiz_api' do
-  include_context 'http get'
-
-  context 'retrieving a single resource' do
-    let(:token) do
-      client.jwt_service.grant_permission(
-        exp: token_expiration_one_year,
-        scope: scope,
-        uuid: user,
-        resource_id: resource_id
-      )
-    end
-
-    before do
-      quiz_api
-        .given(provider_state)
-        .upon_receiving(request_description)
-        .with(
-          method: :get,
-          path: quizzes_api_path,
-          headers: headers(token),
-          query: query_params
-        )
-        .will_respond_with(
-          status: status,
-          headers: response_headers,
-          body: response_body
-        )
-    end
-
-    it 'verifies the request is valid' do
-      result = client.send(service_name).get(token: token, params: params)
-      expect(result).to be_truthy
-    end
-  end
-end

data/spec/contracts/shared_examples/http_patch_example.rb

@@ -1,60 +0,0 @@
-shared_examples 'a http patch request to quiz_api' do
-  let(:quizzes_api_path) { raise 'Override in spec' }
-  let(:consumer_key) { 'consumer key' }
-  let(:consumer_request_id) { 'consumer request id' }
-  let(:host) { 'localhost:1234' }
-  let(:shared_secret) { 'secret' }
-  let(:scope) { raise 'Override in spec' }
-  let(:user) { nil }
-  let(:resource_id) { nil }
-  let(:response_body) { raise 'Override in spec' }
-  let(:service_name) { raise 'Override in spec' }
-  let(:status) { 200 }
-  let(:provider_state) { raise 'Override in spec' }
-  let(:params) { raise 'Override in spec' }
-  let(:body) { raise 'Override in spec' }
-  let(:request_description) { raise 'Override in spec (must be unique!)' }
-
-  let(:client) do
-    QuizApiClient::Client.new(
-      consumer_key: consumer_key,
-      consumer_request_id: consumer_request_id,
-      host: host,
-      shared_secret: shared_secret,
-      protocol: 'http'
-    )
-  end
-
-  context 'updating a resource' do
-    let(:token) do
-      client.jwt_service.grant_permission(
-        exp: token_expiration_one_year,
-        scope: scope,
-        uuid: user,
-        resource_id: resource_id
-      )
-    end
-
-    before do
-      quiz_api
-        .given(provider_state)
-        .upon_receiving(request_description)
-        .with(
-          method: :patch,
-          path: quizzes_api_path,
-          headers: headers(token),
-          body: body
-        )
-        .will_respond_with(
-          status: status,
-          headers: { 'Content-Type' => 'application/json; charset=utf-8' },
-          body: response_body
-        )
-    end
-
-    it 'verifies the request is valid' do
-      result = client.send(service_name).update(token: token, params: params)
-      expect(result).to be_truthy
-    end
-  end
-end

data/spec/contracts/shared_examples/http_post_example.rb

@@ -1,60 +0,0 @@
-shared_examples 'a http post request to quiz_api' do
-  let(:quizzes_api_path) { raise 'Override in spec' }
-  let(:consumer_key) { 'consumer key' }
-  let(:consumer_request_id) { 'consumer request id' }
-  let(:host) { 'localhost:1234' }
-  let(:shared_secret) { 'secret' }
-  let(:scope) { raise 'Override in spec' }
-  let(:user) { nil }
-  let(:resource_id) { nil }
-  let(:response_body) { raise 'Override in spec' }
-  let(:service_name) { raise 'Override in spec' }
-  let(:status) { 201 }
-  let(:provider_state) { raise 'Override in spec' }
-  let(:params) { raise 'Override in spec' }
-  let(:body) { raise 'Override in spec' }
-  let(:request_description) { raise 'Override in spec (must be unique!)' }
-
-  let(:client) do
-    QuizApiClient::Client.new(
-      consumer_key: consumer_key,
-      consumer_request_id: consumer_request_id,
-      host: host,
-      shared_secret: shared_secret,
-      protocol: 'http'
-    )
-  end
-
-  context 'creating a new resource' do
-    let(:token) do
-      client.jwt_service.grant_permission(
-        exp: token_expiration_one_year,
-        scope: scope,
-        uuid: user,
-        resource_id: resource_id
-      )
-    end
-
-    before do
-      quiz_api
-        .given(provider_state)
-        .upon_receiving(request_description)
-        .with(
-          method: :post,
-          path: quizzes_api_path,
-          headers: headers(token),
-          body: body
-        )
-        .will_respond_with(
-          status: status,
-          headers: { 'Content-Type' => 'application/json; charset=utf-8' },
-          body: response_body
-        )
-    end
-
-    it 'verifies the request is valid' do
-      result = client.send(service_name).create(token: token, params: params)
-      expect(result).to be_truthy
-    end
-  end
-end

data/spec/contracts/shared_examples/http_put_example.rb

@@ -1,60 +0,0 @@
-shared_examples 'a http put request to quiz_api' do
-  let(:quizzes_api_path) { raise 'Override in spec' }
-  let(:consumer_key) { 'consumer key' }
-  let(:consumer_request_id) { 'consumer request id' }
-  let(:host) { 'localhost:1234' }
-  let(:shared_secret) { 'secret' }
-  let(:scope) { raise 'Override in spec' }
-  let(:resource_id) { nil }
-  let(:response_body) { raise 'Override in spec' }
-  let(:service_name) { raise 'Override in spec' }
-  let(:status) { 200 }
-  let(:provider_state) { raise 'Override in spec' }
-  let(:user) { nil }
-  let(:params) { raise 'Override in spec' }
-  let(:body) { raise 'Override in spec' }
-  let(:request_description) { raise 'Override in spec (must be unique!)' }
-
-  let(:client) do
-    QuizApiClient::Client.new(
-      consumer_key: consumer_key,
-      consumer_request_id: consumer_request_id,
-      host: host,
-      shared_secret: shared_secret,
-      protocol: 'http'
-    )
-  end
-
-  context 'updating a resource' do
-    let(:token) do
-      client.jwt_service.grant_permission(
-        exp: token_expiration_one_year,
-        scope: scope,
-        uuid: user,
-        resource_id: resource_id
-      )
-    end
-
-    before do
-      quiz_api
-        .given(provider_state)
-        .upon_receiving(request_description)
-        .with(
-          method: :put,
-          path: quizzes_api_path,
-          headers: headers(token),
-          body: body
-        )
-        .will_respond_with(
-          status: status,
-          headers: { 'Content-Type' => 'application/json; charset=utf-8' },
-          body: response_body
-        )
-    end
-
-    it 'verifies the request is valid' do
-      result = client.send(service_name).update(token: token, params: params)
-      expect(result).to be_truthy
-    end
-  end
-end

data/spec/support/pact_config.rb

@@ -1,64 +0,0 @@
-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

@@ -1,19 +0,0 @@
-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