quiz_api_client 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a7510dde6f3ff21858b72aa6fc3054583b210b9b
-  data.tar.gz: c5354fba783d3dc1399afae7462ac6d112568430
+  metadata.gz: b4bf29ac754ada773490f0576569a0a204226669
+  data.tar.gz: 0c3cf4baae7eaa570c2e3186377cd1f9d121883f
 SHA512:
-  metadata.gz: 3868dd59280ee8c59b3517d12ba5fd31e88c77ae9649736ef5d4b6c1083e133c6a1e40269143279e0a44d1f0c2588b824f462c3b32cf72345c198fd0423456b8
-  data.tar.gz: a453ef98e547383558b24f78f57992f5ecae5f62660e980821b6aad22cca4ffe86e33f56ced23676c7f28550c7843127553e7151438e2c4877383543bd9b5279
+  metadata.gz: cceeefa90889b19abcdd0bf516db220096469924b573b83beaac864ff0ed610508a7f48d15be57e0b911c4c9cae18256b5f62dfc0ef2a9d43122f27f65f511ed
+  data.tar.gz: ab7b4bfb05c414ca931d8c00d0d1cdbdfbe0841f44754bfbcb1a0e15b37cf0a9f6d58f413351a001f6793667b94b6abaf2f752281eee71e0d5bbc4c3b959fa28

data/.dockerignore

@@ -0,0 +1,4 @@
+/coverage
+/docker-compose.yml
+/Dockerfile
+/**/*.gem

data/.gitignore

@@ -1,6 +1,5 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/

data/Dockerfile

@@ -0,0 +1,23 @@
+FROM instructure/ruby:2.3
+
+USER root
+
+RUN apt-get update \
+ && apt-get install -y unzip \
+ && apt-get clean \
+ && rm -rf /var/lib/apt/lists/*
+
+ENV LANG C.UTF-8
+WORKDIR /app
+
+COPY Gemfile quiz_api_client.gemspec Gemfile.lock /app/
+COPY . /app
+RUN chown -R docker:docker /app
+
+USER docker
+RUN bundle install --jobs 8
+USER root
+
+RUN mkdir -p /app/coverage && chown -R docker:docker /app
+
+USER docker

data/Gemfile

@@ -1,3 +1,6 @@
 source 'https://rubygems.org'
 
 gemspec
+
+
+gem 'pry'

data/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: .
+  specs:
+    quiz_api_client (0.1.4)
+      httparty
+      jwt
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.0)
+      public_suffix (~> 2.0, >= 2.0.2)
+    coderay (1.1.1)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    hashdiff (0.3.2)
+    httparty (0.14.0)
+      multi_xml (>= 0.5.2)
+    json (2.0.3)
+    jwt (1.5.6)
+    method_source (0.8.2)
+    multi_xml (0.6.0)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    public_suffix (2.0.5)
+    rake (10.4.2)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    safe_yaml (1.0.4)
+    simplecov (0.13.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    slop (3.6.0)
+    webmock (2.3.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.12)
+  pry
+  quiz_api_client!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  simplecov
+  webmock
+
+BUNDLED WITH
+   1.14.3

data/README.md

@@ -150,6 +150,100 @@ client.quiz_sessions_service.create(
 )
 ```
 
+#### QTI Imports Service
+
+**Tokens**
+```ruby
+# Generate token: Create Qti Import
+client.qti_imports_service.token(
+  scope: client.quizzes_service.scope_create,
+  exp: some_expiration
+)
+```
+
+**API Calls**
+```ruby
+# Create QTI Import
+client.qti_imports_service.create(
+  params: {
+    quiz_id: quiz_id_to_create_import_under,
+    qti_import: {
+      url: url where QTI Export is stored
+    }
+  }
+)
+```
+
+#### Item Analyses Service
+
+**Tokens**
+```ruby
+# Generate token: Fetch Item Analyses
+client.item_analyses_service.token(
+  scope: client.item_analyses_service.scope_analysis,
+  exp: some_expiration
+)
+```
+
+**API Calls**
+```ruby
+# List item analyses
+client.item_analyses_service.list(
+  params: {
+    quiz_id: quiz_id_to_list_items_under
+  }
+)
+# get specific item analysis
+client.item_analyses_service.get(
+  params: {
+    quiz_id: quiz_id_to_list_items_under,
+    id: item_id_to_get_under
+  }
+)
+```
+
+#### Quiz Analyses Service
+
+**Tokens**
+```ruby
+# Generate token: Fetch Quiz Analyses
+client.quiz_analyses_service.token(
+  scope: client.quiz_analyses_service.scope_analysis,
+  exp: some_expiration
+)
+```
+
+**API Calls**
+```ruby
+# get specific item analysis
+client.quiz_analyses_service.get(
+  params: {
+    quiz_id: quiz_id_to_get_analysis
+  }
+)
+```
+
+#### Quiz Session Events Service
+
+**Tokens**
+```ruby
+# Generate token: Fetch Quiz Session Events
+client.quiz_session_events_service.token(
+  scope: client.quiz_session_events_service.scope_list,
+  exp: some_expiration
+)
+```
+
+**API Calls**
+```ruby
+# list quiz session events
+client.quiz_session_events_service.list(
+  params: {
+    quiz_session_id: quiz_session_id_to_get_events_under
+  }
+)
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies.

data/build.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+
+export COMPOSE_PROJECT_NAME=api_client
+
+function cleanup() {
+  exit_code=$?
+  set +e
+  
+  docker rmi -f $(docker images -qf "dangling=true") &>/dev/null
+  exit $exit_code
+}
+trap cleanup INT TERM EXIT
+
+set -e
+
+docker-compose build --pull
+
+echo "Running test suite..."
+docker-compose run -d testrunner bash -c 'bundle exec rspec && sleep 10'
+docker-compose run testrunner bundle exec rspec
+
+docker cp $(docker-compose ps -q testrunner):/app/coverage .

data/docker-compose.yml

@@ -0,0 +1,5 @@
+version: '2'
+
+services:
+  testrunner:
+    build: .

data/lib/quiz_api_client.rb

@@ -1,9 +1,13 @@
 require 'quiz_api_client/version'
+require 'quiz_api_client/services/qti_imports_service'
 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'
+require 'quiz_api_client/services/item_analyses_service'
+require 'quiz_api_client/services/quiz_analyses_service'
+require 'quiz_api_client/services/quiz_session_events_service'
 
 module QuizApiClient
   class Client
@@ -17,16 +21,38 @@ module QuizApiClient
     end
 
     def quiz_service
-      @_quiz_service ||= Services::QuizService.new(
+      @_quiz_service ||= Services::QuizService.new(service_params)
+    end
+
+    def quizzes_service
+      @_quizzes_service ||= Services::QuizzesService.new(service_params)
+    end
+
+    def quiz_session_service
+      @_quiz_session_service ||= Services::QuizSessionService.new(service_params)
+    end
+
+    def quiz_sessions_service
+      @_quiz_sessions_service ||= Services::QuizSessionsService.new(service_params)
+    end
+
+    def qti_imports_service
+      @_qti_imports_service ||= Services::QtiImportsService.new(service_params)
+    end
+
+    private
+
+    def service_params
+      {
         consumer_key: consumer_key,
         host: host,
         shared_secret: shared_secret,
         protocol: protocol
-      )
+      }
     end
 
-    def quizzes_service
-      @_quizzes_service ||= Services::QuizzesService.new(
+    def item_analyses_service
+      @_item_analyses_service ||= Services::ItemAnalysesService.new(
         consumer_key: consumer_key,
         host: host,
         shared_secret: shared_secret,
@@ -34,8 +60,8 @@ module QuizApiClient
       )
     end
 
-    def quiz_session_service
-      @_quiz_session_service ||= Services::QuizSessionService.new(
+    def quiz_analyses_service
+      @_quiz_analyses_service ||= Services::QuizAnalysesService.new(
         consumer_key: consumer_key,
         host: host,
         shared_secret: shared_secret,
@@ -43,8 +69,8 @@ module QuizApiClient
       )
     end
 
-    def quiz_sessions_service
-      @_quiz_sessions_service ||= Services::QuizSessionsService.new(
+    def quiz_session_events_service
+      @_quiz_session_events_service ||= Services::QuizSessionEventsService.new(
         consumer_key: consumer_key,
         host: host,
         shared_secret: shared_secret,

data/lib/quiz_api_client/services/item_analyses_service.rb

@@ -0,0 +1,36 @@
+require 'quiz_api_client/services/base_api_service'
+
+module QuizApiClient::Services
+  class ItemAnalysesService < BaseApiService
+    def token(scope:, exp: nil, resource_id: nil)
+      return unless allowed_scopes.include?(scope)
+      generate_token(scope: scope, exp: exp, resource_id: resource_id)
+    end
+
+    def list(params:, default_token: nil)
+      raise 'Quiz Id Required' unless params.key?(:quiz_id)
+      client(token: token_for_api(default_token, scope_analysis, params[:quiz_id])).get(
+        "/api/quizzes/#{params[:quiz_id]}/stats/item_analyses",
+        {}
+      )
+    end
+
+    def get(params:, default_token: nil)
+      raise 'Quiz Id and Item Id are Required' unless params.key?(:id) && params.key?(:quiz_id)
+      client(token: token_for_api(default_token, scope_analysis, params[:quiz_id])).get(
+        "/api/quizzes/#{params[:quiz_id]}/stats/item_analyses/#{params[:id]}",
+        {}
+      )
+    end
+
+    def scope_analysis
+      'quiz.analysis'
+    end
+
+    private
+
+    def allowed_scopes
+      [scope_analysis]
+    end
+  end
+end

data/lib/quiz_api_client/services/qti_imports_service.rb

@@ -0,0 +1,32 @@
+require 'quiz_api_client/services/base_api_service'
+
+module QuizApiClient::Services
+  class QtiImportsService < BaseApiService
+    def token(scope:, exp: nil, resource_id: nil)
+      return unless allowed_scopes.include?(scope)
+      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
+
+    def scope_create
+      'qti_import.create'
+    end
+
+    private
+
+    def post_to_quiz_api(params:, token:)
+      client(token: token).post(
+        "/api/quizzes/#{params[:quiz_id]}/qti_imports",
+        qti_import: params
+      )
+    end
+
+    def allowed_scopes
+      [scope_create]
+    end
+  end
+end

data/lib/quiz_api_client/services/quiz_analyses_service.rb

@@ -0,0 +1,32 @@
+require 'quiz_api_client/services/base_api_service'
+
+module QuizApiClient::Services
+  class QuizAnalysesService < BaseApiService
+    def token(scope:, exp: nil, resource_id: nil)
+      return unless allowed_scopes.include?(scope)
+      generate_token(scope: scope, exp: exp, resource_id: resource_id)
+    end
+
+    def get(params:, default_token: nil)
+      raise 'Quiz Id Required' unless params.key?(:quiz_id)
+      get_from_quiz_api(params: params, token: token_for_api(default_token, scope_analysis, params[:quiz_id]))
+    end
+
+    def scope_analysis
+      'quiz.analysis'
+    end
+
+    private
+
+    def get_from_quiz_api(params:, token:)
+      client(token: token).get(
+        "/api/quizzes/#{params[:quiz_id]}/stats/quiz_analysis",
+        {}
+      )
+    end
+
+    def allowed_scopes
+      [scope_analysis]
+    end
+  end
+end

data/lib/quiz_api_client/services/quiz_service.rb

@@ -3,13 +3,18 @@ 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
+      return unless allowed_scopes.include?(scope)
       generate_token(scope: scope, exp: exp, resource_id: resource_id)
     end
 
-    # Allowed scopes
     def scope_build
       'quiz.build'
     end
+
+    private
+
+    def allowed_scopes
+      [scope_build]
+    end
   end
 end

data/lib/quiz_api_client/services/quiz_session_events_service.rb

@@ -0,0 +1,32 @@
+require 'quiz_api_client/services/base_api_service'
+
+module QuizApiClient::Services
+  class QuizSessionEventsService < BaseApiService
+    def token(scope:, exp: nil, resource_id: nil)
+      return unless allowed_scopes.include?(scope)
+      generate_token(scope: scope, exp: exp, resource_id: resource_id)
+    end
+
+    def list(params:, default_token: nil)
+      raise 'Quiz Session Id Required' unless params.key?(:quiz_session_id)
+      get_from_quiz_api(params: params, token: token_for_api(default_token, scope_list, params[:quiz_session_id]))
+    end
+
+    def scope_list
+      'quiz_session.take'
+    end
+
+    private
+
+    def get_from_quiz_api(params:, token:)
+      client(token: token).get(
+        "/api/quiz_sessions/#{params[:quiz_session_id]}/quiz_session_events",
+        {}
+      )
+    end
+
+    def allowed_scopes
+      [scope_list]
+    end
+  end
+end

data/lib/quiz_api_client/services/quiz_session_service.rb

@@ -3,7 +3,7 @@ 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)
+      return unless allowed_scopes.include?(scope)
       generate_token(scope: scope, exp: exp, resource_id: resource_id)
     end
 
@@ -11,7 +11,6 @@ module QuizApiClient::Services
       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
@@ -28,5 +27,9 @@ module QuizApiClient::Services
         quiz_session: params
       )
     end
+
+    def allowed_scopes
+      [scope_update, scope_take]
+    end
   end
 end

data/lib/quiz_api_client/services/quiz_sessions_service.rb

@@ -3,7 +3,7 @@ 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)
+      return unless allowed_scopes.include?(scope)
       generate_token(scope: scope, exp: exp, resource_id: resource_id)
     end
 
@@ -12,7 +12,6 @@ module QuizApiClient::Services
       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
@@ -29,5 +28,9 @@ module QuizApiClient::Services
         quiz_session: params
       )
     end
+
+    def allowed_scopes
+      [scope_create, scope_list]
+    end
   end
 end

data/lib/quiz_api_client/services/quizzes_service.rb

@@ -3,7 +3,7 @@ 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)
+      return unless allowed_scopes.include?(scope)
       generate_token(scope: scope, exp: exp, resource_id: resource_id)
     end
 
@@ -15,7 +15,6 @@ module QuizApiClient::Services
       get_from_quiz_api(params: params, token: token_for_api(default_token, scope_list))
     end
 
-    ## Allowed scopes
     def scope_create
       'quiz.create'
     end
@@ -39,5 +38,9 @@ module QuizApiClient::Services
         params
       )
     end
+
+    def allowed_scopes
+      [scope_create, scope_list]
+    end
   end
 end

data/lib/quiz_api_client/version.rb

@@ -1,3 +1,3 @@
 module QuizApiClient
-  VERSION = '0.1.3'.freeze
+  VERSION = '0.1.4'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quiz_api_client
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Chris Wang
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-24 00:00:00.000000000 Z
+date: 2017-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -115,20 +115,29 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".dockerignore"
 - ".editorconfig"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- Dockerfile
 - Gemfile
+- Gemfile.lock
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- build.sh
+- docker-compose.yml
 - 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/item_analyses_service.rb
 - lib/quiz_api_client/services/jwt_service.rb
+- lib/quiz_api_client/services/qti_imports_service.rb
+- lib/quiz_api_client/services/quiz_analyses_service.rb
 - lib/quiz_api_client/services/quiz_service.rb
+- lib/quiz_api_client/services/quiz_session_events_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