quiz_api_client 0.1.10 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca9a16246b654bd00e0c7c3fb55d6a9594004037
-  data.tar.gz: ac33399eb56be356559f4045bdb30be585bd1560
+  metadata.gz: ed3490344641f0e0df9d58e273898318046a844a
+  data.tar.gz: 4236414000e6d07afb262f9373868af3b01bfc78
 SHA512:
-  metadata.gz: ca0918f5f2daf3f3855a81e46fd3b5165e4d7c58fea2cef97f32bb4043088d18a75b226f00c06006bddf7e3998f0f54492094edb2b1d45d0bcd7d7f5e4e5d2fa
-  data.tar.gz: cc75ae00dd9f1c4fd921390fc414818fbbfb69fcd4f7bce5945ce531314833460ec102ee70f59b8daeb1bf89661fe5de3be73a8fbfb615e845911e6f484aa9d6
+  metadata.gz: 77d1d3fc2d9551f3b8fb1e0797e50fddabb061de4a6accee921be7a6001e150e05a96a5ea3b0f69028d5435059443b0d4651162900e3a9a27460a51307ee2a9c
+  data.tar.gz: fc94ceeb363da8a649e5aeab0d60f1e782f4ab2f03508fe3dfa12c30ed638adccd38988ea3903e812ba24c24c6c875cb46782de1e13f642a00bfc4bb88f25f36

data/README.md

@@ -43,7 +43,7 @@ JWTs are created without hitting quiz_api and and they are validated on quiz_api
 
 Example, generate a token for building:
 ```ruby
-client.quiz_service.token(
+client.jwt_service.grant_permission(
   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)
@@ -52,95 +52,34 @@ client.quiz_service.token(
 ### Calling the API
 
 Example, create a Quiz:
+
 ```ruby
 client.quizzes_service.create(
   params: {
     title: 'My quiz'
-  }
+  },
+  token: my_scoped_token
 )
 ```
 
 ### Currently Supported Functionality
 
-#### Banks Service
-
-**Tokens**
-```ruby
-# Generate Build token
-client.banks_service.token(
-  scope: client.banks_service.scope_build,
-  exp: some_expiration
-)
-```
-
-#### 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:)
+client.quizzes_service.create(token:, params:)
 
 # List Quizzes
-client.quizzes_service.list(params:)
+client.quizzes_service.list(token:, params:)
 ```
 
 #### Quiz Session Service
 
-**Tokens**
-```ruby
-# Generate token: Grade Quiz Session
-client.quiz_session_service.token(
-  scope: client.quiz_session_service.scope_grade,
-  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
-)
-
-# 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
-)
-```
-
-**API Calls**
 ```ruby
 # Update Quiz Session
 client.quiz_session_service.update(
+  token: my_scoped_token,
   params: {
     id: quiz_session_id,
     # Other params here
@@ -150,19 +89,10 @@ client.quiz_session_service.update(
 
 #### 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(
+  token: my_scoped_token,
   params: {
     quiz_id: quiz_id_to_create_session_under
   }
@@ -171,19 +101,10 @@ 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(
+  token: my_scoped_token,
   params: {
     quiz_id: quiz_id_to_create_import_under,
     qti_import: {
@@ -195,25 +116,17 @@ client.qti_imports_service.create(
 
 #### 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(
+  token: my_scoped_token,
   params: {
     quiz_id: quiz_id_to_list_items_under
   }
 )
 # get specific item analysis
 client.item_analyses_service.get(
+  token: my_scoped_token,
   params: {
     quiz_id: quiz_id_to_list_items_under,
     id: item_id_to_get_under
@@ -223,19 +136,10 @@ client.item_analyses_service.get(
 
 #### 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(
+  token: my_scoped_token,
   params: {
     quiz_id: quiz_id_to_get_analysis
   }
@@ -244,19 +148,10 @@ client.quiz_analyses_service.get(
 
 #### 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(
+  token: my_scoped_token,
   params: {
     quiz_session_id: quiz_session_id_to_get_events_under
   }

data/lib/quiz_api_client.rb

@@ -12,12 +12,8 @@ module QuizApiClient
       @protocol = protocol
     end
 
-    def banks_service
-      @_banks_service ||= Services::BanksService.new(service_params)
-    end
-
-    def quiz_service
-      @_quiz_service ||= Services::QuizService.new(service_params)
+    def jwt_service
+      @_jwt_service ||= QuizApiClient::Services::JwtService.new(service_params)
     end
 
     def quizzes_service
@@ -69,11 +65,9 @@ require 'quiz_api_client/http_client'
 require 'quiz_api_client/services/jwt_service'
 require 'quiz_api_client/services/base_api_service'
 
-require 'quiz_api_client/services/banks_service'
 require 'quiz_api_client/services/item_analyses_service'
 require 'quiz_api_client/services/qti_imports_service'
 require 'quiz_api_client/services/quiz_analyses_service'
-require 'quiz_api_client/services/quiz_service'
 require 'quiz_api_client/services/quiz_session_events_service'
 require 'quiz_api_client/services/quiz_session_service'
 require 'quiz_api_client/services/quiz_sessions_service'

data/lib/quiz_api_client/services/base_api_service.rb

@@ -14,28 +14,10 @@ module QuizApiClient::Services
 
     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 uri
       URI.parse("#{protocol}://#{host}").to_s
     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(
-        consumer_key: consumer_key,
-        host: URI.parse("#{protocol}://#{host}").host,
-        shared_secret: shared_secret,
-        protocol: protocol
-      )
-    end
-
     def client(token:)
       QuizApiClient::HttpClient.new(
         uri: uri,

data/lib/quiz_api_client/services/item_analyses_service.rb

@@ -1,34 +1,19 @@
 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)
+    def list(params:, token: nil)
       raise 'Quiz Id Required' unless params.key?(:quiz_id)
-      client(token: token_for_api(default_token, scope_analysis, params[:quiz_id])).get(
+      client(token: token).get(
         "/api/quizzes/#{params[:quiz_id]}/stats/item_analyses",
         {}
       )
     end
 
-    def get(params:, default_token: nil)
+    def get(params:, 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(
+      client(token: token).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

@@ -1,17 +1,8 @@
 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)
+    def create(params:, 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'
+      post_to_quiz_api(params: params, token: token)
     end
 
     private
@@ -22,9 +13,5 @@ module QuizApiClient::Services
         qti_import: params
       )
     end
-
-    def allowed_scopes
-      [scope_create]
-    end
   end
 end

data/lib/quiz_api_client/services/quiz_analyses_service.rb

@@ -1,17 +1,8 @@
 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)
+    def get(params:, 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'
+      get_from_quiz_api(params: params, token: token)
     end
 
     private
@@ -22,9 +13,5 @@ module QuizApiClient::Services
         {}
       )
     end
-
-    def allowed_scopes
-      [scope_analysis]
-    end
   end
 end

data/lib/quiz_api_client/services/quiz_session_events_service.rb

@@ -1,17 +1,8 @@
 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)
+    def list(params:, 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_sessions.log'
+      get_from_quiz_api(params: params, token: token)
     end
 
     private
@@ -22,9 +13,5 @@ module QuizApiClient::Services
         {}
       )
     end
-
-    def allowed_scopes
-      [scope_list]
-    end
   end
 end

data/lib/quiz_api_client/services/quiz_session_result_service.rb

@@ -1,17 +1,8 @@
 module QuizApiClient::Services
   class QuizSessionResultService < 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 show(params:, default_token: nil)
+    def show(params:, token: nil)
       raise 'Quiz Session Result Id Required' unless params && params[:id]
-      get_from_quiz_api(params: params, token: token_for_api(default_token, scope_show, params[:id]))
-    end
-
-    def scope_show
-      'quiz_session_result.show'
+      get_from_quiz_api(params: params, token: token)
     end
 
     private
@@ -21,9 +12,5 @@ module QuizApiClient::Services
         "/api/results/#{params[:id]}"
       )
     end
-
-    def allowed_scopes
-      [scope_show]
-    end
   end
 end

data/lib/quiz_api_client/services/quiz_session_service.rb

@@ -1,33 +1,12 @@
 module QuizApiClient::Services
   class QuizSessionService < 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)
+    def update(params:, token: nil)
+      patch_to_quiz_api(params: params, token: token)
     end
 
-    def update(params:, default_token: nil)
-      patch_to_quiz_api(params: params, token: token_for_api(default_token, scope_update, params[:id]))
-    end
-
-    def show(params:, default_token: nil)
+    def show(params:, token: nil)
       raise 'Quiz Session Id Required' unless params && params[:id]
-      get_from_quiz_api(params: params, token: token_for_api(default_token, scope_show, params[:id]))
-    end
-
-    def scope_update
-      'quiz_session.update'
-    end
-
-    def scope_take
-      'quiz_session.take'
-    end
-
-    def scope_grade
-      'quiz_session.grade'
-    end
-
-    def scope_show
-      'quiz_session.show'
+      get_from_quiz_api(params: params, token: token)
     end
 
     private
@@ -44,14 +23,5 @@ module QuizApiClient::Services
         "/api/quiz_sessions/#{params[:id]}"
       )
     end
-
-    def allowed_scopes
-      [
-        scope_grade,
-        scope_take,
-        scope_update,
-        scope_show
-      ]
-    end
   end
 end

data/lib/quiz_api_client/services/quiz_sessions_service.rb

@@ -1,21 +1,8 @@
 module QuizApiClient::Services
   class QuizSessionsService < 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)
+    def create(params:, 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
-      'quiz_session.create'
-    end
-
-    def scope_list
-      'quiz_sessions.list'
+      post_to_quiz_api(params: params, token: token)
     end
 
     private
@@ -26,9 +13,5 @@ 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

@@ -1,24 +1,11 @@
 module QuizApiClient::Services
   class QuizzesService < 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)
+    def create(params:, token: nil)
+      post_to_quiz_api(params: params, token: token)
     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
-
-    def scope_create
-      'quiz.create'
-    end
-
-    def scope_list
-      'quiz.list'
+    def list(params:, token: nil)
+      get_from_quiz_api(params: params, token: token)
     end
 
     private
@@ -36,9 +23,5 @@ 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.10'.freeze
+  VERSION = '0.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quiz_api_client
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.2.0
 platform: ruby
 authors:
 - Chris Wang
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-27 00:00:00.000000000 Z
+date: 2017-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -130,13 +130,11 @@ files:
 - docker-compose.yml
 - lib/quiz_api_client.rb
 - lib/quiz_api_client/http_client.rb
-- lib/quiz_api_client/services/banks_service.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_result_service.rb
 - lib/quiz_api_client/services/quiz_session_service.rb
@@ -163,7 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby client for quiz_api

data/lib/quiz_api_client/services/banks_service.rb

@@ -1,18 +0,0 @@
-module QuizApiClient::Services
-  class BanksService < 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 scope_build
-      'banks.build'
-    end
-
-    private
-
-    def allowed_scopes
-      [scope_build]
-    end
-  end
-end

data/lib/quiz_api_client/services/quiz_service.rb

@@ -1,14 +0,0 @@
-module QuizApiClient::Services
-  class QuizService < 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
-
-    private
-
-    def allowed_scopes
-      ['quiz.build', 'quiz.analysis']
-    end
-  end
-end