quiz_api_client 4.0.0 → 4.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48279a4ca7eeb3d7fc50e493733f5718c2960b2267d70db68b2956b0b11c99c1
-  data.tar.gz: cbd66f799b72273b23b2e7a208fc10336bee5cf2cb93656987d0fdc5d1c173a7
+  metadata.gz: e2f68d04f56475db3135d3b6f74e36d19a3300c213622c6829cad7066c7f77a2
+  data.tar.gz: ddea88d65b109c9b5c685c4c5f54c7de741d27fe236ce6164e6a6f5a01a180a1
 SHA512:
-  metadata.gz: d448acbf4ac471f2c8f55cda52191d35ade2d0e107546946e9cee8f6712556ac402160150555d8e3f978034843240deeeb4cec0a658a5fdf8ce2b2b8d3e1a452
-  data.tar.gz: c73951b3bc89f5ff17b08ac1199aff03f3fd2a7e9cf701d5b2d9fffcc31d4bc76ddd2cc4384622584479ab32f2abf85abc3993554fb8a872a4b961eb8b23b4a3
+  metadata.gz: 4605af70971e585e3086828448d81903e180cacc99287003471f8c99863b940e719c5bb8735cf48c4bbf9aefb4486ab2ed72139c1d331b8fa8d5b73fdfab8a8f
+  data.tar.gz: f6fc9e7840d04d4ff65f5c442ccbc45b2314b565f801dc6a707c1ba8b13989e0aa57b43d9bd9cb39a947ad3eae08134e09cf82c9189a2d55a52c5bb0792b756f

data/README.md

@@ -41,6 +41,10 @@ client = QuizApiClient::Client.new(
 
 In order to set addition error information in your error handling system, you can set the `error_hander` property of the config.  The list of valid values can be found in the `QuizApiClient::Config::ERROR_HANDLERS` constant.
 
+### Metrics
+
+HTTP Request metrics will now be provided if the `setup_metrics` method is called.  The list of valid values can be found in the `QuizApiClient::Config::METRICS_HANDLERS` constant.  The count and duration metrics will be provided under the namespace provided.
+
 ### Creation of Tokens
 
 JWTs are created without hitting quiz_api and and they are validated on quiz_api. Tokens are created for a given scope, expiration, and an optional resource_id.

data/lib/quiz_api_client/config.rb

@@ -1,12 +1,16 @@
 module QuizApiClient
   class Config
+    DEFAULT_ALLOWABLE_RESPONSE_CODES = [401, 422].freeze
     DEFAULT_PROTOCOL = 'https'.freeze
     ERROR_HANDLERS = %i[sentry_raven].freeze
+    METRICS_HANDLERS = %i[inststatsd].freeze
 
     class InvalidErrorHandler < StandardError; end
+    class InvalidMetricsHandler < StandardError; end
+    class InvalidMetricsNamespace < StandardError; end
 
-    attr_reader :error_handler
-    attr_writer :protocol
+    attr_reader :error_handler, :metrics_handler, :metrics_namespace
+    attr_writer :protocol, :allowable_response_codes
     attr_accessor :consumer_key, :consumer_request_id, :host, :shared_secret
 
     def initialize
@@ -18,21 +22,43 @@ module QuizApiClient
     end
 
     def error_handler=(handler)
-      validate_error_hander!(handler)
+      validate_error_handler!(handler)
 
-      @error_handler = handler
+      @error_handler = handler.to_sym
+    end
+
+    def setup_metrics(handler, namespace)
+      validate_metrics_handler!(handler)
+      validate_metrics_namespace!(namespace)
+
+      @metrics_handler = handler.to_sym
+      @metrics_namespace = namespace.to_s.strip
+    end
+
+    def allowable_response_codes
+      @allowable_response_codes || DEFAULT_ALLOWABLE_RESPONSE_CODES
     end
 
     private
 
-    def validate_error_hander!(handler)
+    def validate_error_handler!(handler)
       return unless handler
+      return if ERROR_HANDLERS.include?(handler)
 
-      unless ERROR_HANDLERS.include?(handler)
-        raise InvalidErrorHandler, "It must be one of the following: #{ERROR_HANDLERS.inspect}"
-      end
+      raise InvalidErrorHandler, "It must be one of the following: #{ERROR_HANDLERS.inspect}"
+    end
 
-      @error_handler = handler.to_sym
+    def validate_metrics_handler!(handler)
+      return unless handler
+      return if METRICS_HANDLERS.include?(handler)
+
+      raise InvalidMetricsHandler, "It must be one of the following: #{METRICS_HANDLERS.inspect}"
+    end
+
+    def validate_metrics_namespace!(namespace)
+      return unless namespace.nil? || namespace.to_s.strip == ''
+
+      raise InvalidMetricsNamespace, 'It must be present'
     end
   end
 end

data/lib/quiz_api_client/http_client.rb

@@ -4,7 +4,14 @@ module QuizApiClient
   class HttpClient
     include HTTParty
 
-    class RequestFailed < StandardError; end
+    class RequestFailed < StandardError
+      attr_reader :context
+
+      def initialize(context)
+        @context = context
+        super(context)
+      end
+    end
 
     attr_reader :jwt, :uri, :config
 
@@ -75,13 +82,18 @@ module QuizApiClient
     end
 
     def make_request(method, url, request_options = {})
-      self.class.send(
+      start_time = Time.now
+      resp = self.class.send(
         method,
         url,
         default_request_data.merge(request_options)
       )
+      raise_error(method, url, response: resp) unless successful_response?(resp)
+      resp
     rescue HTTParty::Error, Errno::ECONNREFUSED, Net::ReadTimeout => e
       raise_error(method, url, current_error: e)
+    ensure
+      record_metrics(method, url, resp, start_time, Time.now)
     end
 
     def make_paginated_request(method, url, options)
@@ -91,8 +103,6 @@ module QuizApiClient
 
       until request_url.nil?
         resp = make_request(method, request_url, request_options)
-        raise_error(method, url, response: resp) unless resp.code == 200
-
         entities.concat(resp.parsed_response)
         request_url, request_options = next_page(resp, url, options)
       end
@@ -139,50 +149,22 @@ module QuizApiClient
       [url, options.merge(query: query)]
     end
 
-    def generate_error_context(method, url, response = nil)
-      context = {
-        quiz_api_client: {
-          request: {
-            method: method,
-            url: url
-          }
-        }
-      }
-
-      if response
-        context[:quiz_api_client][:response] = {
-          body: response.body,
-          code: response.code
-        }
-      end
+    def raise_error(method, url, response: nil, current_error: nil)
+      failure = QuizApiClient::HttpRequest::Failure.new(config)
 
-      context
+      failure.raise_error(method, url, response: response, current_error: current_error)
     end
 
-    def record_error_context(context)
-      case config.error_handler
-      when :sentry_raven
-        require 'sentry-raven'
-        Raven.extra_context(context)
-      end
-    end
+    def record_metrics(method, url, resp, start_time, end_time)
+      code = resp&.code || 0
+      metrics = QuizApiClient::HttpRequest::Metrics.new(config, method, url, code)
 
-    def error_message(current_error, url, response)
-      if current_error && response
-        "#{current_error.message}: #{url} responded #{response.body} (#{response.code})"
-      elsif current_error
-        current_error.message
-      elsif response
-        "#{url} responded #{response.body} (#{response.code})"
-      end
+      metrics.increment
+      metrics.duration(start_time, end_time)
     end
 
-    def raise_error(method, url, response: nil, current_error: nil, error_class: RequestFailed)
-      context = generate_error_context(method, url, response)
-
-      record_error_context(context)
-
-      raise error_class, error_message(current_error, url, response)
+    def successful_response?(resp)
+      resp.success? || config.allowable_response_codes.include?(resp.code)
     end
   end
 end

data/lib/quiz_api_client/http_request/failure.rb

@@ -0,0 +1,65 @@
+module QuizApiClient
+  module HttpRequest
+    class Failure
+      attr_reader :config
+
+      def initialize(config)
+        @config = config
+      end
+
+      def raise_error(
+        method,
+        url,
+        response: nil,
+        current_error: nil,
+        error_class: QuizApiClient::HttpClient::RequestFailed
+      )
+        context = generate_error_context(method, url, response)
+
+        record_error_context(context)
+
+        raise error_class.new(context), error_message(current_error, url, response)
+      end
+
+      private
+
+      def generate_error_context(method, url, response = nil)
+        context = {
+          quiz_api_client: {
+            request: {
+              method: method,
+              url: url
+            }
+          }
+        }
+
+        if response
+          context[:quiz_api_client][:response] = {
+            body: response.body,
+            code: response.code
+          }
+        end
+
+        context
+      end
+
+      def record_error_context(context)
+        case config.error_handler
+        when :sentry_raven
+          require 'sentry-raven'
+          Raven.extra_context(context)
+        end
+      end
+
+      def error_message(current_error, url, response)
+        if current_error && response
+          "#{current_error.message}: #{url} responded #{response.body} (#{response.code})"
+        elsif current_error
+          current_error.message
+        elsif response
+          "#{url} responded #{response.body} (#{response.code})"
+        end
+      end
+    end
+  end
+end

data/lib/quiz_api_client/http_request/metrics.rb

@@ -0,0 +1,67 @@
+module QuizApiClient
+  module HttpRequest
+    class Metrics
+      extend Forwardable
+
+      attr_reader :config, :method, :url, :code
+      def_delegators :config, :metrics_handler, :metrics_namespace
+
+      def initialize(config, method, url, code)
+        @config = config
+        @method = method
+        @url = url
+        @code = code
+      end
+
+      def increment
+        return unless configured?
+
+        case metrics_handler
+        when :inststatsd
+          InstStatsd::Statsd.increment count_metric_name, tags: tags
+        end
+      end
+
+      def duration(start_time, end_time)
+        return unless configured?
+
+        duration_ms = ((end_time - start_time) * 1_000).round
+
+        case metrics_handler
+        when :inststatsd
+          InstStatsd::Statsd.timing duration_metric_name, duration_ms, tags: tags
+        end
+      end
+
+      private
+
+      def configured?
+        metrics_handler_present? && metrics_namespace_present?
+      end
+
+      def count_metric_name
+        "#{metrics_namespace}.quiz_api_client.request.count"
+      end
+
+      def duration_metric_name
+        "#{metrics_namespace}.quiz_api_client.request.duration_ms"
+      end
+
+      def metrics_handler_present?
+        !metrics_handler.nil?
+      end
+
+      def metrics_namespace_present?
+        !metrics_namespace.nil?
+      end
+
+      def tags
+        {
+          method: method,
+          status: code,
+          url: url
+        }
+      end
+    end
+  end
+end

data/lib/quiz_api_client/services/items_service.rb

@@ -1,5 +1,11 @@
 module QuizApiClient::Services
   class ItemsService < BaseApiService
+    def list(params:, token: nil)
+      raise 'Quiz Id Required' unless params && params[:quiz_id]
+
+      list_from_quiz_api(params: params, token: token)
+    end
+
     def create(params:, token: nil)
       raise 'Quiz Id Required' unless params && params[:quiz_id]
 
@@ -8,6 +14,11 @@ module QuizApiClient::Services
 
     private
 
+    def list_from_quiz_api(params:, token:)
+      quiz_id = params.delete(:quiz_id)
+      client(token: token).get("/api/quizzes/#{quiz_id}/items")
+    end
+
     def post_to_quiz_api(params:, token:)
       quiz_id = params.delete(:quiz_id)
       client(token: token).post(

data/lib/quiz_api_client/version.rb

@@ -1,3 +1,3 @@
 module QuizApiClient
-  VERSION = '4.0.0'.freeze
+  VERSION = '4.2.1'.freeze
 end

data/lib/quiz_api_client.rb

@@ -101,6 +101,8 @@ require 'quiz_api_client/version'
 require 'quiz_api_client/config'
 require 'quiz_api_client/http_client'
 require 'quiz_api_client/json_formatter'
+require 'quiz_api_client/http_request/failure'
+require 'quiz_api_client/http_request/metrics'
 require 'quiz_api_client/services/jwt_service'
 require 'quiz_api_client/services/base_api_service'
 

data/spec/config_spec.rb

@@ -0,0 +1,66 @@
+describe QuizApiClient::Config do
+  describe 'initialize with block' do
+    it 'sets the config value' do
+      config = described_class.new do |c|
+        c.host = 'a host'
+      end
+      expect(config.host).to eq 'a host'
+    end
+  end
+
+  describe '#protocol' do
+    it 'returns the default when nil' do
+      config = described_class.new
+      expect(config.protocol).to eq QuizApiClient::Config::DEFAULT_PROTOCOL
+    end
+  end
+
+  describe '#error_handler=' do
+    it 'raises an error with an invalid error handler' do
+      config = described_class.new
+      expect { config.error_handler = :invalid_error_handler }
+        .to raise_error(QuizApiClient::Config::InvalidErrorHandler)
+    end
+  end
+
+  describe '#allowable_response_codes' do
+    it 'returns the default when nil' do
+      config = described_class.new
+      expect(config.allowable_response_codes).to eq QuizApiClient::Config::DEFAULT_ALLOWABLE_RESPONSE_CODES
+    end
+  end
+
+  describe '#setup_metrics' do
+    let(:valid_handler) { :inststatsd }
+    let(:invalid_handler) { :invalid_handler }
+
+    let(:valid_namespace) { :quiz_lti }
+    let(:invalid_namespace) { ' ' }
+
+    it 'raises an error with an invalid metrics handler' do
+      config = described_class.new
+      expect { config.setup_metrics(invalid_handler, valid_namespace) }
+        .to raise_error(QuizApiClient::Config::InvalidMetricsHandler)
+    end
+
+    it 'raises an error with an invalid namespace' do
+      config = described_class.new
+      expect { config.setup_metrics(valid_handler, invalid_namespace) }
+        .to raise_error(QuizApiClient::Config::InvalidMetricsNamespace)
+    end
+
+    it 'raises an error with an nil namespace' do
+      config = described_class.new
+      expect { config.setup_metrics(valid_handler, nil) }
+        .to raise_error(QuizApiClient::Config::InvalidMetricsNamespace)
+    end
+
+    it 'sets the handler and namespace successfully' do
+      config = described_class.new
+      config.setup_metrics(valid_handler, valid_namespace)
+
+      expect(config.metrics_handler).to eq valid_handler
+      expect(config.metrics_namespace).to eq valid_namespace.to_s
+    end
+  end
+end

data/spec/contracts/interaction_types_service_spec.rb

@@ -0,0 +1,22 @@
+describe QuizApiClient::Services::InteractionTypesService, :pact do
+  include PactHelper
+
+  it_behaves_like 'a http get request to quiz_api collection endpoint' do
+    let(:provider_state) { 'a set of interaction types' }
+    let(:request_description) { 'a request to retrieve a list of interaction types' }
+    let(:quizzes_api_path) { '/api/interaction_types' }
+    let(:scope) { 'quiz.build' }
+    let(:params) { nil }
+    let(:response_body) do
+      Pact.each_like(
+        id: '1',
+        slug: 'choice',
+        name: 'Multiple Choice',
+        properties_schema: {},
+        scoring_algorithm_default: 'Equivalence',
+        user_response_type_options: ['Uuid']
+      )
+    end
+    let(:service_name) { :interaction_types_service }
+  end
+end

data/spec/contracts/item_analyses_service_spec.rb

@@ -0,0 +1,59 @@
+describe QuizApiClient::Services::ItemAnalysesService, :pact do
+  include PactHelper
+
+  it_behaves_like 'a http get request to quiz_api collection endpoint', testrail_id: %w[3402546] do
+    let(:request_description) { 'a request to retrieve item analyses all quiz_id items' }
+    let(:quiz_id) { 1 }
+    let(:quizzes_api_path) { "/api/quizzes/#{quiz_id}/stats/item_analyses" }
+    let(:provider_state) { 'quiz with item analysis' }
+    let(:resource_id) { '1' }
+    let(:scope) { 'quiz.analysis' }
+    let(:params) { { quiz_id: '1' } }
+    let(:response_body) do
+      [
+        {
+          item_id: Pact.like('1'),
+          points_possible: Pact.like(1.0),
+          item_body: Pact.like('item body'),
+          interaction_type: 'choice',
+          item_analysis: {},
+          batch_timestamp: Pact.like('2017-06-15T22:14:51.215Z'),
+          outcome_alignment_set_guid: Pact.like('cbedd9b0-d1ab-43a9-a3b2-89c3134a722a')
+        },
+        {
+          item_id: Pact.like('1'),
+          points_possible: Pact.like(1.0),
+          item_body: Pact.like('item body'),
+          interaction_type: 'choice',
+          item_analysis: {},
+          batch_timestamp: Pact.like('2017-06-15T22:14:51.215Z'),
+          outcome_alignment_set_guid: Pact.like('cbedd9b0-d1ab-43a9-a3b2-89c3134a722a')
+        }
+      ]
+    end
+    let(:service_name) { :item_analyses_service }
+  end
+
+  it_behaves_like 'a http get only request to quiz_api', testrail_id: %w[3402547] do
+    let(:request_description) { 'a request to retrieve item analyses for a quiz item' }
+    let(:quiz_id) { 1 }
+    let(:id) { 1 }
+    let(:quizzes_api_path) { "/api/quizzes/#{quiz_id}/stats/item_analyses/#{id}" }
+    let(:provider_state) { 'quiz with item analysis' }
+    let(:resource_id) { '1' }
+    let(:scope) { 'quiz.analysis' }
+    let(:params) { { quiz_id: '1', id: '1' } }
+    let(:response_body) do
+      {
+        item_id: Pact.like('1'),
+        points_possible: Pact.like(1.0),
+        item_body: Pact.like('item body'),
+        interaction_type: 'choice',
+        item_analysis: {},
+        batch_timestamp: Pact.like('2017-06-15T22:14:51.215Z'),
+        outcome_alignment_set_guid: Pact.like('cbedd9b0-d1ab-43a9-a3b2-89c3134a722a')
+      }
+    end
+    let(:service_name) { :item_analyses_service }
+  end
+end

data/spec/contracts/items_service_spec.rb

@@ -0,0 +1,59 @@
+describe QuizApiClient::Services::ItemsService, :pact do
+  include PactHelper
+
+  it_behaves_like 'a http post request to quiz_api' do
+    let(:provider_state) { 'a quiz and a multiple choice interaction type' }
+    let(:request_description) { 'a request to create an item' }
+    let(:quizzes_api_path) { "/api/quizzes/#{quiz_id}/items" }
+    let(:resource_id) { '1' }
+    let(:scope) { 'quiz.build' }
+    let(:quiz_id) { 1 }
+    let(:params) do
+      {
+        quiz_id: quiz_id,
+        interaction_data: {
+          choices: [{
+            id: 'guid',
+            itemBody: '<p>Choice</p>',
+            position: 1
+          }]
+        },
+        interaction_type_id: 1, # we'll seed InteractionType::MultipleChoice
+        item_body: 'Some kind of stem',
+        properties: {},
+        scoring_algorithm: 'Equivalence',
+        scoring_data: {
+          value: 'another guid'
+        },
+        title: 'A perfectly cromulent title',
+        user_response_type: 'Uuid'
+      }
+    end
+    let(:item_params) { params.clone.tap { |p| p.delete(:quiz_id) } }
+    let(:body) { { quiz_id: quiz_id, item: item_params } }
+    let(:response_body) do
+      {
+        id: Pact.like('1'),
+        interaction_data: {
+          choices: Pact.each_like(
+            id: 'a guid',
+            item_body: 'choice description',
+            position: 1
+          )
+        },
+        item_body: Pact.like(''),
+        properties: Pact.like({}),
+        status: Pact.like(''),
+        title: Pact.like(''),
+        user_response_type: Pact.like(''),
+        stimulus_id: Pact.like(''),
+        interaction_type: Pact.like({}),
+        scoring_data: {
+          value: Pact.like('')
+        },
+        scoring_algorithm: Pact.like('')
+      }
+    end
+    let(:service_name) { :items_service }
+  end
+end

data/spec/contracts/qti_imports_service_spec.rb

@@ -0,0 +1,34 @@
+describe QuizApiClient::Services::QtiImportsService, :pact do
+  include PactHelper
+
+  it_behaves_like 'a http post request to quiz_api', testrail_id: %w[3402548] do
+    let(:request_description) { 'a request to import a QTI' }
+    let(:provider_state) { 'a quiz' }
+    let(:quiz_id) { 1 }
+    let(:url) { 'http://fake.url' }
+    let(:quizzes_api_path) { "/api/quizzes/#{quiz_id}/qti_imports" }
+    let(:scope) { 'qti_import.create' }
+    let(:resource_id) { quiz_id }
+    let(:params) do
+      {
+        quiz_id: quiz_id,
+        url: url
+      }
+    end
+    let(:body) { { qti_import: params } }
+    let(:response_body) do
+      {
+        id: Pact.like('1'),
+        parent_id: quiz_id.to_s,
+        parent_type: Pact.like('Quiz'),
+        status: 'scheduled',
+        url: url,
+        message: Pact.like(''),
+        created_at: Pact.like(''),
+        updated_at: Pact.like(''),
+        progress: Pact.like(0.0)
+      }
+    end
+    let(:service_name) { :qti_imports_service }
+  end
+end

data/spec/contracts/quiz_clone_job_service_spec.rb

@@ -0,0 +1,20 @@
+describe QuizApiClient::Services::QuizCloneJobService, :pact do
+  include PactHelper
+
+  it_behaves_like 'a http get request to quiz_api' do
+    let(:request_description) { 'a request to retrieve a quiz clone job' }
+    let(:quizzes_api_path) { "/api/quiz_clone_jobs/#{resource_id}" }
+    let(:provider_state) { 'a quiz clone job' }
+    let(:scope) { 'quiz_clone_job.show' }
+    let(:params) { { id: resource_id } }
+    let(:resource_id) { '1' }
+    let(:response_body) do
+      {
+        id: Pact.like('1'),
+        original_quiz_id: Pact.like('1'),
+        status: Pact.like('scheduled')
+      }
+    end
+    let(:service_name) { :quiz_clone_job_service }
+  end
+end

data/spec/contracts/quiz_clone_jobs_service_spec.rb

@@ -0,0 +1,21 @@
+describe QuizApiClient::Services::QuizCloneJobsService, :pact do
+  include PactHelper
+
+  it_behaves_like 'a http post request to quiz_api' do
+    let(:request_description) { 'a request to clone a quiz' }
+    let(:quizzes_api_path) { "/api/quizzes/#{resource_id}/quiz_clone_jobs" }
+    let(:provider_state) { 'a quiz' }
+    let(:scope) { 'quiz.clone' }
+    let(:params) { { quiz_id: resource_id } }
+    let(:body) { {} }
+    let(:resource_id) { '1' }
+    let(:response_body) do
+      {
+        id: Pact.like('1'),
+        original_quiz_id: Pact.like('1'),
+        status: Pact.like('scheduled')
+      }
+    end
+    let(:service_name) { :quiz_clone_jobs_service }
+  end
+end