quiz_api_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8e46fc44771fd9dd6ceeb5aaa6c4e331ac5f500b
+  data.tar.gz: 1bf44fddb2e367f4a1271bafcccf3d256f66994d
+SHA512:
+  metadata.gz: 6847f2213f8778d0ab0b6e5513f37cea73d6cbb1f4e7d9f27fce94b2053f437c5dfb1b214012d2b1383e592b5094a8575d6333006afdf1183b041d1a86a045e2
+  data.tar.gz: b3e2e93799b2796c2b6ff639009c95adb8c00e2ee65f02d5f1a41813757291977eb6b73b805a079d3cde325a058bd3c4c7cb2c7a2deb2fff2548993fca3cc16c

data/.editorconfig

@@ -0,0 +1,16 @@
+# .editorconfig
+# Please install EditorConfig plugin for your editor or IDE
+# Usage and plugin list can be found here: http://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+end_of_line = lf
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+indent_size = 4

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,79 @@
+Rails:
+  Enabled: true
+
+Rails/HttpPositionalArguments:
+  # Renable once we are on Rails v5
+  Enabled: false
+
+AllCops:
+  TargetRubyVersion: 2.3
+
+Metrics/ClassLength:
+  Max: 200 # Default: 100
+
+Metrics/LineLength:
+  Max: 120 # Default: 80
+
+Metrics/MethodLength:
+  Max: 20 # Default: 10
+
+Metrics/BlockLength:
+  Max: 30
+  Exclude:
+    - 'spec/**/*.rb'
+    - 'config/routes.rb'
+    - 'app/docs/**/*.rb'
+
+Style/AlignParameters:
+  # Alignment of parameters in multi-line method calls.
+  #
+  # The `with_fixed_indentation` style aligns the following lines with one
+  # level of indentation relative to the start of the line with the method call.
+  #
+  #     method_call(a,
+  #       b)
+  EnforcedStyle: with_fixed_indentation
+
+Style/ClassAndModuleChildren:
+  # Checks the style of children definitions at classes and modules.
+  #
+  # Basically there are two different styles:
+  #
+  # `nested` - have each child on a separate line
+  #   class Foo
+  #     class Bar
+  #     end
+  #   end
+  #
+  # `compact` - combine definitions as much as possible
+  #   class Foo::Bar
+  #   end
+  #
+  # The compact style is only forced, for classes / modules with one child.
+  EnforcedStyle: nested
+  Enabled: false
+
+Style/Documentation:
+  # This cop checks for missing top-level documentation of classes and modules.
+  # Classes with no body and namespace modules are exempt from the check.
+  # Namespace modules are modules that have nothing in their bodies except
+  # classes or other modules.
+  Enabled: false
+
+Lint/EndAlignment:
+  AlignWith: variable
+
+Style/CaseIndentation:
+  IndentWhenRelativeTo: end
+
+Style/FrozenStringLiteralComment:
+  # `when_needed` will add the frozen string literal comment to files
+  # only when the `TargetRubyVersion` is set to 2.3+.
+  # `always` will always add the frozen string literal comment to a file
+  # regardless of the Ruby version or if `freeze` or `<<` are called on a
+  # string literal. If you run code against multiple versions of Ruby, it is
+  # possible that this will create errors in Ruby 2.3.0+.
+  #
+  # See: https://wyeworks.com/blog/2015/12/1/immutable-strings-in-ruby-2-dot-3
+  EnforcedStyle: when_needed
+  Enabled: false

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,155 @@
+# QuizApiClient
+
+Welcome!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'quiz_api_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install quiz_api_client
+
+## Usage
+
+This client library is used to access quiz_api through Signed Auth, our implementation of signing a JWT with the appropriate scope and resource_id.
+
+Currently, the "services" are organized by resource, following the REST convention of pluralization.
+
+### Instantiate the Client
+
+To instantiate a client, you'll need the secret and the host.
+
+```ruby
+client = QuizApiClient::Client.new(
+  quiz_api_host: 'your-quiz-api-host-here.com',
+  quiz_api_secret_for_jwt: 'the-api-secret normally stored on the quiz_api account'
+)
+```
+
+### 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.
+
+Example, generate a token for building:
+```ruby
+client.quiz_service.token(
+  scope: client.quiz_service.scope_build,
+  exp: Time.now.utc.to_i + 60, # some reasonable time, obviously longer is more a security risk
+  resource_id: 1)
+```
+
+### Calling the API
+
+Example, create a Quiz:
+```ruby
+client.quiz_service.create(
+  params: {
+    title: 'My quiz'
+  }
+```
+
+### Currently Supported Functionality
+
+#### Quiz Service
+
+**Tokens**
+```ruby
+# Generate Build token
+client.quiz_service.token(
+  scope: client.quiz_service.scope_build,
+  exp: some_expiration,
+  resource_id: quiz_id_here
+)
+```
+
+#### Quizzes Service
+
+**Tokens**
+```ruby
+# Generate token: Create Quiz
+client.quizzes_service.token(
+  scope: client.quizzes_service.scope_create,
+  exp: some_expiration
+)
+
+# List Quizzes
+client.quizzes_service.token(
+  scope: client.quizzes_service.scope_list,
+  exp: some_expiration
+)
+```
+
+**API Calls**
+```ruby
+# Create Quiz
+client.quizzes_service.create(params:)
+
+# List Quizzes
+client.quizzes_service.list(params:)
+```
+
+#### Quiz Session Service
+
+**Tokens**
+```ruby
+# Generate token: Update Quiz Session
+client.quiz_session_service.token(
+  scope: client.quiz_session_service.scope_update,
+  exp: some_expiration,
+  resource_id: quiz_session_id
+)
+
+# Generate token: Take Quiz Session
+client.quiz_session_service.token(
+  scope: client.quiz_session_service.scope_take,
+  exp: some_expiration,
+  resource_id: quiz_session_id
+)
+```
+
+**API Calls**
+```ruby
+# Update Quiz Session
+client.quiz_session_service.update(
+  params: {
+    id: quiz_session_id,
+    # Other params here
+  }
+)
+```
+
+#### Quiz Sessions Service
+
+**Tokens**
+```ruby
+# Generate token: Create Quiz Session
+client.quiz_sessions_service.token(
+  scope: client.quiz_sessions_service.scope_create,
+  exp: some_expiration
+)
+```
+
+**API Calls**
+```ruby
+# Create Quiz Session
+client.quiz_sessions_service.create(
+  params: {
+    quiz_id: quiz_id_to_create_session_under
+  }
+)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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).

data/Rakefile

@@ -0,0 +1,19 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+task :console do
+  require 'pry'
+  require 'quiz_api_client'
+
+  def reload!
+    files = $LOADED_FEATURES.select { |feat| feat =~ %r{/\/quiz_api_client/} }
+    files.each { |file| load file }
+  end
+
+  ARGV.clear
+  Pry.start
+end

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'quiz_api_client'
+require 'irb'
+
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/quiz_api_client/http_client.rb

@@ -0,0 +1,58 @@
+require 'httparty'
+
+module QuizApiClient
+  class HttpClient
+    include HTTParty
+
+    class RequestFailed < StandardError; end
+
+    attr_reader :jwt, :uri
+
+    def initialize(uri:, jwt:)
+      @uri = uri
+      @jwt = jwt
+    end
+
+    def get(path, query = {})
+      make_request :get, path, options(query: query)
+    end
+
+    def post(path, body = {})
+      make_request :post, path, options(body: body)
+    end
+
+    def patch(path, body = {})
+      make_request :patch, path, options(body: body)
+    end
+
+    def put(path, body = {})
+      make_request :put, path, options(body: body)
+    end
+
+    def delete(path)
+      make_request :delete, path, options
+    end
+
+    private
+
+    def make_request(method, path, options)
+      self.class.send(
+        method,
+        "#{uri}#{path}",
+        options
+      )
+    rescue HTTParty::Error, Errno::ECONNREFUSED, Net::ReadTimeout => e
+      raise RequestFailed, e.message
+    end
+
+    def options(opts = {})
+      { headers: headers }.merge(opts)
+    end
+
+    def headers
+      { 'Authorization' => jwt,
+        'AuthType' => 'Signature',
+        'Accept' => 'application/json' }
+    end
+  end
+end

data/lib/quiz_api_client/services/base_api_service.rb

@@ -0,0 +1,43 @@
+require 'quiz_api_client/http_client'
+require 'quiz_api_client/services/jwt_service'
+
+module QuizApiClient::Services
+  class BaseApiService
+    attr_reader :quiz_api_host, :quiz_api_secret_for_jwt, :errors
+
+    def initialize(quiz_api_host:, quiz_api_secret_for_jwt:)
+      @quiz_api_host = quiz_api_host
+      @quiz_api_secret_for_jwt = quiz_api_secret_for_jwt
+      @errors = []
+    end
+
+    private
+
+    def token_for_api(default_token = nil, scope = nil, resource_id = nil)
+      return default_token unless default_token.nil?
+      generate_token(scope: scope, resource_id: resource_id)
+    end
+
+    def quiz_api_url
+      "http://#{quiz_api_host}"
+    end
+
+    def generate_token(scope:, exp: nil, resource_id: nil)
+      jwt_service.grant_permission(scope: scope, exp: exp, resource_id: resource_id)
+    end
+
+    def jwt_service
+      QuizApiClient::Services::JwtService.new(
+        url: quiz_api_url,
+        jwt_secret: quiz_api_secret_for_jwt
+      )
+    end
+
+    def quiz_api_client(token:)
+      QuizApiClient::HttpClient.new(
+        uri: quiz_api_url,
+        jwt: token
+      )
+    end
+  end
+end

data/lib/quiz_api_client/services/jwt_service.rb

@@ -0,0 +1,32 @@
+require 'jwt'
+
+module QuizApiClient::Services
+  HASHING_ALGORITHM = 'HS512'.freeze
+  class JwtService
+    attr_reader :url, :jwt_secret, :user_id
+
+    def initialize(jwt_secret:, url:)
+      @url = url
+      @jwt_secret = jwt_secret
+    end
+
+    def grant_permission(scope:, exp: nil, resource_id: nil)
+      payload = {
+        host: url,
+        scope: scope,
+        exp: exp || Time.now.utc.to_i + 60,
+
+        # FIXME: This is currently required on quiz_web
+        user: {
+          full_name: 'Fake Full Name',
+          given_name: 'Fake',
+          email: 'quizzes+fake@instructure.com',
+          id: 1
+        }
+      }
+      payload[:resource_id] = resource_id if resource_id
+
+      JWT.encode(payload, jwt_secret, HASHING_ALGORITHM)
+    end
+  end
+end

data/lib/quiz_api_client/services/quiz_service.rb

@@ -0,0 +1,15 @@
+require 'quiz_api_client/services/base_api_service'
+
+module QuizApiClient::Services
+  class QuizService < BaseApiService
+    def token(scope:, exp: nil, resource_id: nil)
+      return unless scope == scope_build
+      generate_token(scope: scope, exp: exp, resource_id: resource_id)
+    end
+
+    # Allowed scopes
+    def scope_build
+      'quiz.build'
+    end
+  end
+end

data/lib/quiz_api_client/services/quiz_session_service.rb

@@ -0,0 +1,31 @@
+require 'quiz_api_client/services/base_api_service'
+
+module QuizApiClient::Services
+  class QuizSessionService < BaseApiService
+    def token(scope:, exp: nil, resource_id: nil)
+      return unless (scope == scope_update) || (scope == scope_take)
+      generate_token(scope: scope, exp: exp, resource_id: resource_id)
+    end
+
+    def update(params:, default_token: nil)
+      patch_to_quiz_api(params: params, token: token_for_api(default_token, scope_update, params[:id]))
+    end
+
+    # Allowed scopes
+    def scope_update
+      'quiz_session.update'
+    end
+    def scope_take
+      'quiz_session.take'
+    end
+
+    private
+
+    def patch_to_quiz_api(params:, token:)
+      quiz_api_client(token: token).patch(
+        "/api/quiz_sessions/#{params[:id]}",
+        quiz_session: params
+      )
+    end
+  end
+end

data/lib/quiz_api_client/services/quiz_sessions_service.rb

@@ -0,0 +1,33 @@
+require 'quiz_api_client/services/base_api_service'
+
+module QuizApiClient::Services
+  class QuizSessionsService < BaseApiService
+    def token(scope:, exp: nil, resource_id: nil)
+      return unless (scope == scope_create) || (scope == scope_list)
+      generate_token(scope: scope, exp: exp, resource_id: resource_id)
+    end
+
+    def create(params:, default_token: nil)
+      raise 'Quiz Id Required' unless params && params[:quiz_id]
+      post_to_quiz_api(params: params, token: token_for_api(default_token, scope_create, params[:quiz_id]))
+    end
+
+    # Allowed scopes
+    def scope_create
+      'quiz_session.create'
+    end
+
+    def scope_list
+      'quiz_session.list'
+    end
+
+    private
+
+    def post_to_quiz_api(params:, token:)
+      quiz_api_client(token: token).post(
+        "/api/quizzes/#{params[:quiz_id]}/quiz_sessions",
+        quiz_session: params
+      )
+    end
+  end
+end

data/lib/quiz_api_client/services/quizzes_service.rb

@@ -0,0 +1,43 @@
+require 'quiz_api_client/services/base_api_service'
+
+module QuizApiClient::Services
+  class QuizzesService < BaseApiService
+    def token(scope:, exp: nil, resource_id: nil)
+      return unless (scope == scope_create) || (scope == scope_list)
+      generate_token(scope: scope, exp: exp, resource_id: resource_id)
+    end
+
+    def create(params:, default_token: nil)
+      post_to_quiz_api(params: params, token: token_for_api(default_token, scope_create))
+    end
+
+    def list(params:, default_token: nil)
+      get_from_quiz_api(params: params, token: token_for_api(default_token, scope_list))
+    end
+
+    ## Allowed scopes
+    def scope_create
+      'quiz.create'
+    end
+
+    def scope_list
+      'quiz.list'
+    end
+
+    private
+
+    def post_to_quiz_api(params:, token:)
+      quiz_api_client(token: token).post(
+        '/api/quizzes',
+        quiz: params
+      )
+    end
+
+    def get_from_quiz_api(params:, token:)
+      quiz_api_client(token: token).get(
+        '/api/quizzes',
+        params
+      )
+    end
+  end
+end

data/lib/quiz_api_client/version.rb

@@ -0,0 +1,3 @@
+module QuizApiClient
+  VERSION = '0.1.0'.freeze
+end

data/lib/quiz_api_client.rb

@@ -0,0 +1,45 @@
+require 'quiz_api_client/version'
+require 'quiz_api_client/services/quiz_service'
+require 'quiz_api_client/services/quizzes_service'
+require 'quiz_api_client/services/quiz_sessions_service'
+require 'quiz_api_client/services/quiz_session_service'
+require 'quiz_api_client/services/quiz_sessions_service'
+
+module QuizApiClient
+  class Client
+    attr_reader :quiz_api_host, :quiz_api_secret_for_jwt
+
+    def initialize(quiz_api_host:, quiz_api_secret_for_jwt:)
+      @quiz_api_host = quiz_api_host
+      @quiz_api_secret_for_jwt = quiz_api_secret_for_jwt
+    end
+
+    def quiz_service
+      @_quiz_service ||= Services::QuizService.new(
+        quiz_api_host: quiz_api_host,
+        quiz_api_secret_for_jwt: quiz_api_secret_for_jwt
+      )
+    end
+
+    def quizzes_service
+      @_quizzes_service ||= Services::QuizzesService.new(
+        quiz_api_host: quiz_api_host,
+        quiz_api_secret_for_jwt: quiz_api_secret_for_jwt
+      )
+    end
+
+    def quiz_session_service
+      @_quiz_service ||= Services::QuizSessionService.new(
+        quiz_api_host: quiz_api_host,
+        quiz_api_secret_for_jwt: quiz_api_secret_for_jwt
+      )
+    end
+
+    def quiz_sessions_service
+      @_quiz_sessions_service ||= Services::QuizSessionsService.new(
+        quiz_api_host: quiz_api_host,
+        quiz_api_secret_for_jwt: quiz_api_secret_for_jwt
+      )
+    end
+  end
+end

data/quiz_api_client.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+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.summary       = 'Ruby client for quiz_api'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'httparty'
+  spec.add_dependency 'jwt'
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: quiz_api_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Wang
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- cwang@instructure.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/quiz_api_client.rb
+- lib/quiz_api_client/http_client.rb
+- lib/quiz_api_client/services/base_api_service.rb
+- lib/quiz_api_client/services/jwt_service.rb
+- lib/quiz_api_client/services/quiz_service.rb
+- lib/quiz_api_client/services/quiz_session_service.rb
+- lib/quiz_api_client/services/quiz_sessions_service.rb
+- lib/quiz_api_client/services/quizzes_service.rb
+- lib/quiz_api_client/version.rb
+- quiz_api_client.gemspec
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.3
+signing_key: 
+specification_version: 4
+summary: Ruby client for quiz_api
+test_files: []