quiz_api_client 2.3.1 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f7699a214c62a08a38ae0bebdd20a2e8eaddd0df
-  data.tar.gz: 4030369f162e0940b1219810ba3119e42ba8ca18
+  metadata.gz: f109a4af811b6581467d20b04bc580c1f2a3c209
+  data.tar.gz: 73ffe5b91db4ffa77db9de146b29c8162aaef2db
 SHA512:
-  metadata.gz: bb05024dcce94975b684f29c5e84e3aa0d0e610d59c0df21911b1fd966c833876abfa6f43760c34437f47fbe687c33e7d19b2512c8d8902af98e48fe3f4676de
-  data.tar.gz: aa28886b1b04e984a035844e6b0be54f1033745760b22fbbdabd54d73375a913e243f4523bf11a8f0f6ef4935b8290eae828394a8e34d86d7b7d7b15e1a81ce9
+  metadata.gz: 355d7520d371d4cf3a19cb42def9ff1eee21e70eefe6e001b2e0558d6a26dfca1abd9a48d9c184f33ff2bf4ec0d338497729acfa749d73736c490106018509ed
+  data.tar.gz: f99bbc820678763fd8caee43d27ea3ee78f6bb02591c3a0bc833889d754421b088a7b218615ea9940b97bc7dbf94cf2073105772fcf1c8dcfe4bcd3ff5fafdda

data/Gemfile

@@ -2,5 +2,4 @@ source 'https://rubygems.org'
 
 gemspec
 
-
 gem 'pry'

data/lib/quiz_api_client/http_client.rb

@@ -1,3 +1,5 @@
+require 'logger'
+
 module QuizApiClient
   class HttpClient
     include HTTParty
@@ -6,9 +8,11 @@ module QuizApiClient
 
     attr_reader :jwt, :uri
 
-    def initialize(uri:, jwt:)
+    def initialize(uri:, jwt:, consumer_request_id: nil, logging: true, log_level: :info)
       @uri = uri
       @jwt = jwt
+      @consumer_request_id = consumer_request_id
+      initialize_logger(log_level) if logging
     end
 
     def get(path, all: false, query: {})
@@ -34,6 +38,33 @@ module QuizApiClient
 
     private
 
+    def initialize_logger(log_level)
+      HTTParty::Logger.add_formatter('quiz_api_client_json_formatter', QuizApiClient::JSONFormatter)
+      @logger = ::Logger.new(STDOUT,
+                             formatter: proc {|_,_,_,msg| msg.merge({consumer_request_id: @consumer_request_id}).to_json },
+                             level: unfriendly_logger_level(log_level)
+                            )
+      @logger_config = { logger: @logger,
+                         log_level: log_level,
+                         log_format: :quiz_api_client_json_formatter
+      }
+    end
+
+    def unfriendly_logger_level(level)
+      case level
+      when :fatal
+        ::Logger::FATAL
+      when :error
+        ::Logger::ERROR
+      when :warn
+        ::Logger::WARN
+      when :info
+        ::Logger::INFO
+      when :debug
+        ::Logger::DEBUG
+      end
+    end
+
     def make_request(method, path, request_options = {})
       self.class.send(
         method,
@@ -57,7 +88,7 @@ module QuizApiClient
     end
 
     def default_request_data
-      {
+      initial_hash = {
         headers: {
           'Authorization' => jwt,
           'AuthType' => 'Signature',
@@ -65,6 +96,11 @@ module QuizApiClient
           'Content-Type' => 'application/json'
         }
       }
+
+      initial_hash[:headers]['X-Consumer-Request-Id'] = @consumer_request_id if @consumer_request_id
+
+      initial_hash.merge!(@logger_config) if @logger_config
+      initial_hash
     end
 
     def next_page(response)

data/lib/quiz_api_client/json_formatter.rb

@@ -0,0 +1,18 @@
+module QuizApiClient
+  class JSONFormatter
+    def initialize(logger, level)
+      @logger = logger
+      @level = level.to_sym
+    end
+
+    def format(request, response)
+      @logger.send(@level, {
+        client_request_id: response.headers.dig('x-request-id', 0),
+        request_url: request.last_uri,
+        response_code: response.code
+      })
+    end
+  end
+end
+
+

data/lib/quiz_api_client/services/base_api_service.rb

@@ -4,12 +4,13 @@ module QuizApiClient::Services
                 :protocol, :errors
 
     def initialize(consumer_key:, host:,
-                   shared_secret:, protocol: 'https')
+                   shared_secret:, protocol: 'https', consumer_request_id: nil)
       @consumer_key = consumer_key
       @host = host
       @shared_secret = shared_secret
       @protocol = protocol
       @errors = []
+      @consumer_request_id = consumer_request_id
     end
 
     private
@@ -21,7 +22,8 @@ module QuizApiClient::Services
     def client(token:)
       QuizApiClient::HttpClient.new(
         uri: uri,
-        jwt: token
+        jwt: token,
+        consumer_request_id: @consumer_request_id
       )
     end
   end

data/lib/quiz_api_client/services/jwt_service.rb

@@ -4,11 +4,12 @@ module QuizApiClient::Services
 
     attr_reader :consumer_key, :host, :shared_secret, :protocol
 
-    def initialize(consumer_key: nil, shared_secret:, host:, protocol: 'https')
+    def initialize(consumer_key: nil, consumer_request_id: nil, shared_secret:, host:, protocol: 'https')
       @consumer_key = consumer_key
       @host = host
       @shared_secret = shared_secret
       @protocol = protocol
+      @consumer_request_id = consumer_request_id
     end
 
     def grant_permission(scope:, exp: nil, uuid: nil, **additional_fields)

data/lib/quiz_api_client/version.rb

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

data/lib/quiz_api_client.rb

@@ -3,13 +3,14 @@ require 'jwt'
 
 module QuizApiClient
   class Client
-    attr_reader :consumer_key, :host, :shared_secret, :protocol
+    attr_reader :consumer_key, :consumer_request_id, :host, :protocol, :shared_secret
 
-    def initialize(consumer_key:, host:, shared_secret:, protocol: 'https')
+    def initialize(consumer_key:, host:, shared_secret:, protocol: 'https', consumer_request_id: nil)
       @consumer_key = consumer_key
       @host = host
       @shared_secret = shared_secret
       @protocol = protocol
+      @consumer_request_id = consumer_request_id
     end
 
     def jwt_service
@@ -69,9 +70,10 @@ module QuizApiClient
     def service_params
       {
         consumer_key: consumer_key,
+        consumer_request_id: consumer_request_id,
         host: host,
-        shared_secret: shared_secret,
-        protocol: protocol
+        protocol: protocol,
+        shared_secret: shared_secret
       }
     end
   end
@@ -80,6 +82,7 @@ end
 require 'quiz_api_client/version'
 
 require 'quiz_api_client/http_client'
+require 'quiz_api_client/json_formatter'
 require 'quiz_api_client/services/jwt_service'
 require 'quiz_api_client/services/base_api_service'
 

data/quiz_api_client.gemspec

@@ -6,8 +6,34 @@ require 'quiz_api_client/version'
 Gem::Specification.new do |spec|
   spec.name          = 'quiz_api_client'
   spec.version       = QuizApiClient::VERSION
-  spec.authors       = ['Chris Wang']
-  spec.email         = ['cwang@instructure.com']
+  spec.authors       = [
+    'Chris Wang',
+    'Augusto Callejas',
+    'Bryan Petty',
+    'Christian Prescott',
+    'Han Yan',
+    'Jayce Higgins',
+    'Marc Alan Phillips',
+    'Michael Brewer-Davis',
+    'Michael Hargiss',
+    'Omar Khan',
+    'Robin Kuss',
+    'Ryan Taylor'
+  ]
+  spec.email         = [
+    'acallejas@instructure.com',
+    'bpetty@instructure.com',
+    'cprescott@instructure.com',
+    'hyan@instructure.com',
+    'jhiggins@instructure.com',
+    'mphillips@instructure.com',
+    'mbd@instructure.com',
+    'mhargiss@instructure.com',
+    'okhan@instructure.com',
+    'rkuss@instructure.com',
+    'rtaylor@instructure.com',
+    'cwang@instructure.com'
+  ]
   spec.summary       = 'Ruby client for quiz_api'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
@@ -16,7 +42,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'httparty', '0.14.0'
-  spec.add_dependency 'jwt'
+  spec.add_dependency 'jwt', '~> 1.5'
   spec.add_dependency 'link_header'
 
   spec.add_development_dependency 'bundler', '~> 1.12'

metadata

@@ -1,14 +1,25 @@
 --- !ruby/object:Gem::Specification
 name: quiz_api_client
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 2.4.0
 platform: ruby
 authors:
 - Chris Wang
+- Augusto Callejas
+- Bryan Petty
+- Christian Prescott
+- Han Yan
+- Jayce Higgins
+- Marc Alan Phillips
+- Michael Brewer-Davis
+- Michael Hargiss
+- Omar Khan
+- Robin Kuss
+- Ryan Taylor
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-05 00:00:00.000000000 Z
+date: 2017-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -28,16 +39,16 @@ dependencies:
   name: jwt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: link_header
   requirement: !ruby/object:Gem::Requirement
@@ -138,6 +149,17 @@ dependencies:
         version: '3.0'
 description: 
 email:
+- acallejas@instructure.com
+- bpetty@instructure.com
+- cprescott@instructure.com
+- hyan@instructure.com
+- jhiggins@instructure.com
+- mphillips@instructure.com
+- mbd@instructure.com
+- mhargiss@instructure.com
+- okhan@instructure.com
+- rkuss@instructure.com
+- rtaylor@instructure.com
 - cwang@instructure.com
 executables: []
 extensions: []
@@ -161,6 +183,7 @@ files:
 - docker-compose.yml
 - lib/quiz_api_client.rb
 - lib/quiz_api_client/http_client.rb
+- lib/quiz_api_client/json_formatter.rb
 - lib/quiz_api_client/services/base_api_service.rb
 - lib/quiz_api_client/services/item_analyses_service.rb
 - lib/quiz_api_client/services/jwt_service.rb