quiz_api_client 4.2.0 → 4.2.1

data/spec/services/quiz_analyses_service_spec.rb

@@ -0,0 +1,44 @@
+describe QuizApiClient::Services::QuizAnalysesService do
+  let(:host) { 'api.host' }
+  let(:config) { QuizApiClient::Config.new { |c| c.host = host } }
+  let(:subject) { described_class.new(config) }
+
+  describe '#list' do
+    let(:params) { { quiz_id: 1 } }
+    let(:stubbed_response) { { 'id' => '1' } }
+    let(:expected_url) do
+      "https://#{host}/api/quizzes/#{params[:quiz_id]}/stats/quiz_analysis"
+    end
+    let(:expected_body) { '' }
+    let(:status_code) { 200 }
+
+    before do
+      stub_request(:get, expected_url)
+        .with(body: expected_body)
+        .to_return(
+          status: status_code,
+          body: stubbed_response.to_json,
+          headers: { 'Content-Type' => 'application/json' }
+        )
+    end
+
+    it 'posts to quiz_api/api/quizzes and returns the response' do
+      result = subject.get(params: params, token: 'token')
+      expect(result.parsed_response).to eql(stubbed_response)
+    end
+
+    it 'raises an error when no quiz_id is specified' do
+      params = {}
+      expect do
+        subject.get(params: params, token: 'token')
+      end.to raise_error 'Quiz Id Required'
+    end
+
+    context 'response' do
+      it 'returns the response with the correct status code' do
+        response = subject.get(params: params, token: 'token')
+        expect(response.code).to eq(status_code)
+      end
+    end
+  end
+end

data/spec/services/quiz_clone_job_service_spec.rb

@@ -0,0 +1,41 @@
+describe QuizApiClient::Services::QuizCloneJobService do
+  let(:host) { 'api.host' }
+  let(:config) { QuizApiClient::Config.new { |c| c.host = host } }
+  let(:subject) { described_class.new(config) }
+
+  describe '#show' do
+    let(:expected_url) { "https://#{host}/api/quiz_clone_jobs/#{params[:id]}" }
+    let(:params) { { id: 1 } }
+    let(:stubbed_response) { { 'id' => 1, 'original_quiz_id' => 666, 'status' => 'completed' } }
+
+    context 'on success' do
+      before do
+        stub_request(:get, expected_url)
+          .to_return(
+            status: 200,
+            body: stubbed_response.to_json,
+            headers: { 'Content-Type' => 'application/json' }
+          )
+      end
+
+      it 'gets from /api/quiz_clone_jobs/:id' do
+        result = subject.show(params: params, token: 'token')
+        expect(result.parsed_response).to eql(stubbed_response)
+      end
+    end
+
+    context 'on failure' do
+      let(:status_code) { 401 }
+
+      before do
+        stub_request(:get, expected_url)
+          .to_return(status: status_code)
+      end
+
+      it 'returns a response with the correct code' do
+        response = subject.show(params: params, token: 'token')
+        expect(response.code).to eq(status_code)
+      end
+    end
+  end
+end

data/spec/services/quiz_clone_jobs_service_spec.rb

@@ -0,0 +1,41 @@
+describe QuizApiClient::Services::QuizCloneJobsService do
+  let(:host) { 'api.host' }
+  let(:config) { QuizApiClient::Config.new { |c| c.host = host } }
+  let(:subject) { described_class.new(config) }
+
+  describe '#create' do
+    let(:expected_url) { "https://#{host}/api/quizzes/#{params[:quiz_id]}/quiz_clone_jobs" }
+    let(:params) { { quiz_id: 1 } }
+    let(:stubbed_response) { { 'id' => '1' } }
+
+    context 'on success' do
+      before do
+        stub_request(:post, expected_url)
+          .to_return(
+            status: 200,
+            body: stubbed_response.to_json,
+            headers: { 'Content-Type' => 'application/json' }
+          )
+      end
+
+      it 'posts to /api/quizzes/:quiz_id/quiz_clone_job' do
+        result = subject.create(params: params, token: 'token')
+        expect(result.parsed_response).to eql(stubbed_response)
+      end
+    end
+
+    context 'on failure' do
+      let(:status_code) { 401 }
+
+      before do
+        stub_request(:post, expected_url)
+          .to_return(status: status_code)
+      end
+
+      it 'returns a response with the correct code' do
+        response = subject.create(params: params, token: 'token')
+        expect(response.code).to eq(status_code)
+      end
+    end
+  end
+end

data/spec/services/quiz_entries_service_spec.rb

@@ -0,0 +1,71 @@
+describe QuizApiClient::Services::QuizEntriesService do
+  let(:host) { 'api.host' }
+  let(:config) { QuizApiClient::Config.new { |c| c.host = host } }
+  let(:subject) { described_class.new(config) }
+
+  describe '#list' do
+    let(:params) { { id: 1 } }
+    let(:stubbed_response) { { 'id' => 1, 'entry' => { 'id' => 1 } } }
+    let(:expected_url) { "https://#{host}/api/quizzes/#{params[:id]}/quiz_entries" }
+    let(:status_code) { 200 }
+
+    before do
+      stub_request(:get, expected_url)
+        .to_return(
+          status: status_code,
+          body: stubbed_response.to_json,
+          headers: { 'Content-Type' => 'application/json' }
+        )
+    end
+
+    it 'gets from quiz_api/api/quizzes/{id}/quiz_entries and returns the response' do
+      result = subject.list(params: params, token: 'token')
+      expect(result.parsed_response).to eql(stubbed_response)
+    end
+  end
+
+  describe '#create' do
+    let(:params) do
+      { id: 1, entry_id: 1, entry_type: 'Item', points_possible: 1 }
+    end
+    let(:stubbed_response) { { 'id' => 1, 'entry' => { 'id' => 1 } } }
+    let(:expected_url) { "https://#{host}/api/quizzes/#{params[:id]}/quiz_entries" }
+    let(:status_code) { 201 }
+
+    before do
+      stub_request(:post, expected_url)
+        .to_return(
+          status: status_code,
+          body: stubbed_response.to_json,
+          headers: { 'Content-Type' => 'application/json' }
+        )
+    end
+
+    it 'posts to quiz_api/api/quizzes/{id}/quiz_entries and returns the response' do
+      result = subject.create(params: params, token: 'token')
+      expect(result.parsed_response).to eql(stubbed_response)
+    end
+  end
+
+  describe '#destroy' do
+    let(:params) do
+      { id: 6, quiz_id: 1 }
+    end
+    let(:expected_url) { "https://#{host}/api/quizzes/#{params[:quiz_id]}/quiz_entries/#{params[:id]}" }
+    let(:status_code) { 200 }
+
+    before do
+      stub_request(:delete, expected_url)
+        .to_return(
+          status: status_code,
+          body: nil,
+          headers: { 'Content-Type' => 'application/json' }
+        )
+    end
+
+    it 'issues a DELETE to quiz_api/api/quizzes/{quiz_id}/quiz_entries/{id} and returns the response' do
+      result = subject.destroy(params: params, token: 'token')
+      expect(result.parsed_response).to eql(nil)
+    end
+  end
+end

data/spec/services/quiz_service_spec.rb

@@ -0,0 +1,49 @@
+describe QuizApiClient::Services::QuizService do
+  let(:host) { 'api.host' }
+  let(:config) { QuizApiClient::Config.new { |c| c.host = host } }
+  let(:subject) { described_class.new(config) }
+
+  describe '#update' do
+    let(:params) { { id: 1, title: 'some new title' } }
+    let(:stubbed_response) { { 'id' => 1, 'title' => 'some new title' } }
+    let(:expected_url) { "https://#{host}/api/quizzes/#{params[:id]}" }
+    let(:expected_body) { { quiz: params }.to_json }
+    let(:status_code) { 200 }
+
+    before do
+      stub_request(:patch, expected_url)
+        .with(body: expected_body)
+        .to_return(
+          status: status_code,
+          body: stubbed_response.to_json,
+          headers: { 'Content-Type' => 'application/json' }
+        )
+    end
+
+    it 'patches to quiz_api/api/quizzes and returns the response' do
+      result = subject.update(params: params, token: 'token')
+      expect(result.parsed_response).to eql(stubbed_response)
+    end
+  end
+
+  describe '#show' do
+    let(:params) { { id: 1 } }
+    let(:stubbed_response) { { 'id' => 1, 'title' => 'some title' } }
+    let(:expected_url) { "https://#{host}/api/quizzes/#{params[:id]}" }
+    let(:status_code) { 200 }
+
+    before do
+      stub_request(:get, expected_url)
+        .to_return(
+          status: status_code,
+          body: stubbed_response.to_json,
+          headers: { 'Content-Type' => 'application/json' }
+        )
+    end
+
+    it 'gets from quiz_api/api/quizzes and returns the response' do
+      result = subject.show(params: params, token: 'token')
+      expect(result.parsed_response).to eql(stubbed_response)
+    end
+  end
+end

data/spec/services/quiz_session_events_service_spec.rb

@@ -0,0 +1,42 @@
+describe QuizApiClient::Services::QuizSessionEventsService do
+  let(:host) { 'api.host' }
+  let(:config) { QuizApiClient::Config.new { |c| c.host = host } }
+  let(:subject) { described_class.new(config) }
+
+  describe '#list' do
+    let(:params) { { quiz_session_id: 1 } }
+    let(:stubbed_response) { { 'id' => '1' } }
+    let(:expected_url) { "https://#{host}/api/quiz_sessions/#{params[:quiz_session_id]}/quiz_session_events" }
+    let(:expected_body) { '' }
+    let(:status_code) { 200 }
+
+    before do
+      stub_request(:get, expected_url)
+        .with(body: expected_body)
+        .to_return(
+          status: status_code,
+          body: stubbed_response.to_json,
+          headers: { 'Content-Type' => 'application/json' }
+        )
+    end
+
+    it 'posts to quiz_api/api/quizzes and returns the response' do
+      response = subject.list(params: params, token: 'token')
+      expect(response.parsed_response).to eql(stubbed_response)
+    end
+
+    it 'raises an error when no quiz_session_id is specified' do
+      params = {}
+      expect do
+        subject.list(params: params, token: 'token')
+      end.to raise_error 'Quiz Session Id Required'
+    end
+
+    context 'response' do
+      it 'returns the response with the correct status code' do
+        response = subject.list(params: params, token: 'token')
+        expect(response.code).to eq(status_code)
+      end
+    end
+  end
+end

data/spec/services/quiz_session_result_service_spec.rb

@@ -0,0 +1,26 @@
+describe QuizApiClient::Services::QuizSessionResultService do
+  let(:host) { 'api.host' }
+  let(:config) { QuizApiClient::Config.new { |c| c.host = host } }
+  let(:subject) { described_class.new(config) }
+
+  describe '#show' do
+    let(:params) { { id: 1 } }
+    let(:stubbed_response) { { 'id' => 1, 'score' => 10 } }
+    let(:expected_url) { "https://#{host}/api/results/#{params[:id]}" }
+    let(:status_code) { 200 }
+
+    before do
+      stub_request(:get, expected_url)
+        .to_return(
+          status: status_code,
+          body: stubbed_response.to_json,
+          headers: { 'Content-Type' => 'application/json' }
+        )
+    end
+
+    it 'gets from quiz_api/api/results and returns the response' do
+      response = subject.show(params: params, token: 'token')
+      expect(response.parsed_response).to eql(stubbed_response)
+    end
+  end
+end

data/spec/services/quiz_session_service_spec.rb

@@ -0,0 +1,49 @@
+describe QuizApiClient::Services::QuizSessionService do
+  let(:host) { 'api.host' }
+  let(:config) { QuizApiClient::Config.new { |c| c.host = host } }
+  let(:subject) { described_class.new(config) }
+
+  describe '#update' do
+    let(:params) { { id: 1, time_limit_seconds: 10 } }
+    let(:stubbed_response) { { 'id' => '1' } }
+    let(:expected_url) { "https://#{host}/api/quiz_sessions/#{params[:id]}" }
+    let(:expected_body) { { quiz_session: { id: 1, time_limit_seconds: 10 } }.to_json }
+    let(:status_code) { 200 }
+
+    before do
+      stub_request(:patch, expected_url)
+        .with(body: expected_body)
+        .to_return(
+          status: status_code,
+          body: stubbed_response.to_json,
+          headers: { 'Content-Type' => 'application/json' }
+        )
+    end
+
+    it 'patches to quiz_api/api/quiz_sessions and returns the response' do
+      response = subject.update(params: params, token: 'token')
+      expect(response.parsed_response).to eql(stubbed_response)
+    end
+  end
+
+  describe '#show' do
+    let(:params) { { id: 1 } }
+    let(:stubbed_response) { { 'id' => 1, 'time_limit_seconds' => 10 } }
+    let(:expected_url) { "https://#{host}/api/quiz_sessions/#{params[:id]}" }
+    let(:status_code) { 200 }
+
+    before do
+      stub_request(:get, expected_url)
+        .to_return(
+          status: status_code,
+          body: stubbed_response.to_json,
+          headers: { 'Content-Type' => 'application/json' }
+        )
+    end
+
+    it 'gets from quiz_api/api/quiz_sessions and returns the response' do
+      response = subject.show(params: params, token: 'token')
+      expect(response.parsed_response).to eql(stubbed_response)
+    end
+  end
+end

data/spec/services/quiz_sessions_service_spec.rb

@@ -0,0 +1,42 @@
+describe QuizApiClient::Services::QuizSessionsService do
+  let(:host) { 'api.host' }
+  let(:config) { QuizApiClient::Config.new { |c| c.host = host } }
+  let(:subject) { described_class.new(config) }
+
+  describe '#create' do
+    let(:params) { { quiz_id: 1 } }
+    let(:stubbed_response) { { 'id' => '1' } }
+    let(:expected_url) { "https://#{host}/api/quizzes/#{params[:quiz_id]}/quiz_sessions" }
+    let(:expected_body) { { quiz_session: { quiz_id: 1 } }.to_json }
+    let(:status_code) { 200 }
+
+    before do
+      stub_request(:post, expected_url)
+        .with(body: expected_body)
+        .to_return(
+          status: status_code,
+          body: stubbed_response.to_json,
+          headers: { 'Content-Type' => 'application/json' }
+        )
+    end
+
+    it 'posts to quiz_api/api/quizzes and returns the response' do
+      result = subject.create(params: params, token: 'token')
+      expect(result.parsed_response).to eql(stubbed_response)
+    end
+
+    it 'raises an error when no quiz_id is specified' do
+      params = {}
+      expect do
+        subject.create(params: params, token: 'token')
+      end.to raise_error 'Quiz Id Required'
+    end
+
+    context 'response' do
+      it 'returns the response with the correct status code' do
+        response = subject.create(params: params, token: 'token')
+        expect(response.code).to eq(status_code)
+      end
+    end
+  end
+end

data/spec/services/quizzes_service_spec.rb

@@ -0,0 +1,71 @@
+describe QuizApiClient::Services::QuizzesService do
+  let(:host) { 'api.host' }
+  let(:config) { QuizApiClient::Config.new { |c| c.host = host } }
+  let(:subject) { described_class.new(config) }
+
+  describe '#list' do
+    let(:params) { { context_id: 1 } }
+    let(:stubbed_response) { { 'id' => '1' } }
+
+    context 'on success' do
+      before do
+        expected_url = "https://#{host}/api/quizzes?context_id=1"
+        stub_request(:get, expected_url)
+          .to_return(
+            status: 200,
+            body: [stubbed_response].to_json,
+            headers: { 'Content-Type' => 'application/json' }
+          )
+      end
+
+      it 'gets quiz_api/api/quizzes and returns the response' do
+        result = subject.list(params: params, token: 'token')
+        expect(result.parsed_response[0]).to eql(stubbed_response)
+      end
+    end
+
+    context 'on failure' do
+      let(:status_code) { 401 }
+      before do
+        expected_url = "https://#{host}/api/quizzes"
+        stub_request(:get, expected_url)
+          .to_return(status: status_code)
+      end
+
+      it 'returns the response with the correct code' do
+        response = subject.list(params: nil, token: 'token')
+        expect(response.code).to eq(status_code)
+      end
+    end
+  end
+
+  describe '#create' do
+    let(:params) { { title: 'Untitled Quiz', owner: 'owner' } }
+    let(:stubbed_response) { { 'id' => '1' } }
+    let(:expected_url) { "https://#{host}/api/quizzes" }
+    let(:expected_body) { { quiz: { title: 'Untitled Quiz', owner: 'owner' } }.to_json }
+    let(:status_code) { 200 }
+
+    before do
+      stub_request(:post, expected_url)
+        .with(body: expected_body)
+        .to_return(
+          status: 200,
+          body: stubbed_response.to_json,
+          headers: { 'Content-Type' => 'application/json' }
+        )
+    end
+
+    it 'posts to quiz_api/api/quizzes and returns the response' do
+      response = subject.create(params: params, token: 'token')
+      expect(response.parsed_response).to eql(stubbed_response)
+    end
+
+    context 'response' do
+      it 'returns the response with the correct code' do
+        response = subject.create(params: params, token: 'token')
+        expect(response.code).to eq(status_code)
+      end
+    end
+  end
+end

data/spec/services/session_item_results_service_spec.rb

@@ -0,0 +1,33 @@
+describe QuizApiClient::Services::SessionItemResultsService do
+  let(:host) { 'api.host' }
+  let(:config) { QuizApiClient::Config.new { |c| c.host = host } }
+  let(:subject) { described_class.new(config) }
+
+  describe '#index' do
+    let(:params) { { quiz_session_id: 1, quiz_session_result_id: 1 } }
+    let(:stubbed_response) { { 'id' => '1_1', 'item' => { 'id' => '1' } } }
+    let(:expected_url) do
+      format(
+        'https://%<host>s/api/quiz_sessions/%<session>d/results/%<result>d/session_item_results',
+        host: host,
+        session: params[:quiz_session_id],
+        result: params[:quiz_session_result_id]
+      )
+    end
+    let(:status_code) { 200 }
+
+    before do
+      stub_request(:get, expected_url)
+        .to_return(
+          status: status_code,
+          body: stubbed_response.to_json,
+          headers: { 'Content-Type' => 'application/json' }
+        )
+    end
+
+    it 'gets session_item_results and returns the response' do
+      response = subject.list(params: params, token: 'token')
+      expect(response.parsed_response).to eql(stubbed_response)
+    end
+  end
+end

data/spec/services/session_items_service_spec.rb

@@ -0,0 +1,26 @@
+describe QuizApiClient::Services::SessionItemsService do
+  let(:host) { 'api.host' }
+  let(:config) { QuizApiClient::Config.new { |c| c.host = host } }
+  let(:subject) { described_class.new(config) }
+
+  describe '#index' do
+    let(:params) { { quiz_session_id: 1 } }
+    let(:stubbed_response) { { 'id' => '1_1', 'item' => { 'id' => '1' } } }
+    let(:expected_url) { "https://#{host}/api/quiz_sessions/#{params[:quiz_session_id]}/session_items" }
+    let(:status_code) { 200 }
+
+    before do
+      stub_request(:get, expected_url)
+        .to_return(
+          status: status_code,
+          body: stubbed_response.to_json,
+          headers: { 'Content-Type' => 'application/json' }
+        )
+    end
+
+    it 'gets from quiz_api/api/quiz_sessions/:id/session_items and returns the response' do
+      result = subject.list(params: params, token: 'token')
+      expect(result.parsed_response).to eql(stubbed_response)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,42 @@
+require 'pact/consumer/rspec'
+require 'pry'
+require 'simplecov'
+require 'webmock/rspec'
+
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
+require 'quiz_api_client'
+
+Dir[File.dirname(__FILE__) + '/support/*.rb'].each { |f| require f }
+Dir[File.dirname(__FILE__) + '/contracts/shared_examples/*.rb'].each { |f| require f }
+
+WebMock.disable_net_connect!(
+  allow_localhost: true,
+  allow: [PactConfig.broker_host]
+)
+
+# see https://github.com/realestate-com-au/pact/blob/master/documentation/configuration.md
+Pact.configure do |config|
+  config.diff_formatter = :list
+  config.logger.level = Logger::DEBUG
+  config.pact_dir = 'pacts'
+  config.pactfile_write_mode = :overwrite
+  config.pactfile_write_order = :chronological
+end
+
+Pact.service_consumer PactConfig::QUIZ_API_CLIENT_RUBY do
+  has_pact_with PactConfig::Providers::QUIZ_API do
+    mock_service :quiz_api do
+      port 1234
+      pact_specification_version '2.0.0'
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.filter_run_excluding :pact
+  config.before { allow_any_instance_of(::Logger).to receive(:info) }
+end

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