domoscio_rails 0.3.4 → 0.3.8a

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: efcd54188f9c196af4bcfe979c6979d40eeabed22b8fb9313c0b1e96b2ef9415
-  data.tar.gz: d1070f84b35a299e2fa4a4d528c42c5230b33718defe5f3fab6309091d04aa96
+  metadata.gz: e594a08ade8e083ea0ab3e612e7134b857a9cc946a05ca3389ee5cc0a5d74b7d
+  data.tar.gz: 9ca19fbfbf9156600306929503d423e768b597c6101b683350978d1e8213f23f
 SHA512:
-  metadata.gz: 18ec7ba3d002ab25a50fb05bc0b1f12d59dfa2f1f8856805de6ec7c3ebc4709740905339f322082b28f60d6747aec5049c70cb09c765751e63c483b3188e0ff1
-  data.tar.gz: 51fa1d938065643659e2dbe404295c88416ab9bb8a4a5d444e21b06aa6a066101ff0eff8cf45260d78e04ce71084295b55db160c5a451a7d382d7a6787c2dc36
+  metadata.gz: 8fc507af97c64fb9451cacd1e79f7a0a19f02f02af6093a2ca61546144ac8055aaa69e2b54832f1aa8fca609db095bf67d615cedd0b05fca50e9bc01d4f11a25
+  data.tar.gz: cab7cb431f5776565767b22380755426a31d953f612bd8017f8676698924c682a1550b3fd166c258bcaa71bb26a32f38630bd4cd5c565d3f490b99f2ae72a478

data/lib/domoscio_rails.rb

@@ -13,6 +13,7 @@ require 'domoscio_rails/resource'
 require 'domoscio_rails/data/content.rb'
 require 'domoscio_rails/data/event.rb'
 require 'domoscio_rails/data/instance.rb'
+require 'domoscio_rails/data/recommendation.rb'
 require 'domoscio_rails/data/learning_session.rb'
 require 'domoscio_rails/data/student.rb'
 require 'domoscio_rails/knowledge/knowledge_edge.rb'
@@ -38,11 +39,11 @@ module DomoscioRails
 
     # Refers to AdaptiveEngine Version
     def version
-      @version || 2
+      @version ||= 2
     end
 
     def root_url
-      @root_url || ""
+      @root_url ||= ""
     end
   end
 
@@ -63,42 +64,44 @@ module DomoscioRails
   # - +method+: HTTP method; lowercase symbol, e.g. :get, :post etc.
   # - +url+: the part after Configuration#root_url
   # - +params+: hash; entity data for creation, update etc.; will dump it by JSON and assign to Net::HTTPRequest#body
-  # - +filters+: hash; pagination params etc.; will encode it by URI and assign to URI#query
-  # - +headers+: hash; request_headers by default
-  # - +before_request_proc+: optional proc; will call it passing the Net::HTTPRequest instance just before Net::HTTPRequest#request
   #
-  # Raises DomoscioRails::ResponseError if response code != 200.
+  # Performs HTTP requests to Adaptive Engine
+  # On token issues, will try once to get a new token then will output a DomoscioRails::ReponseError with details
   #
-  def self.request(method, url, params={}, filters={}, headers = request_headers, before_request_proc = nil)
-    return false if @disabled
-    #sets a default page size of 50
-    params.merge!({'per_page': 50}) unless params['per_page']
+  # Raises DomoscioRails::ResponseError on Adaptive Error Status
+  # Raises DomoscioRails::ProcessingError on Internal Error
+  #
+  def self.request(method, url, params={})
+
+    store_tokens, headers = request_headers
+    params.merge!({'per_page': 2000}) unless params[:per_page]
     uri = api_uri(url)
-    uri.query = URI.encode_www_form(filters) unless filters.empty?
-    res = DomoscioRails.send_request(uri, method, params, headers, before_request_proc)
-    return res if res.kind_of? DomoscioRails::ProcessingError
+
+    response = DomoscioRails.send_request(uri, method, params, headers)
+    return response if response.kind_of? DomoscioRails::ProcessingError
+
     begin
-      raise_http_failure(uri, res, params)
-      data = DomoscioRails::JSON.load(res.body.nil? ? '' : res.body)
-      DomoscioRails::AuthorizationToken::Manager.storage.store({access_token: res['Accesstoken'], refresh_token: res['Refreshtoken']})
+      raise_http_failure(uri, response, params)
+      data = DomoscioRails::JSON.load(response.body.nil? ? '' : response.body)
+      DomoscioRails::AuthorizationToken::Manager.storage.store({access_token: response['Accesstoken'], refresh_token: response['Refreshtoken']}) if store_tokens
     rescue MultiJson::LoadError => exception
-      data = ProcessingError.new(uri, 500, exception, res.body, params)
+      data = ProcessingError.new(uri, 500, exception, response.body, params)
     rescue ResponseError => exception
       data = exception
     end
 
-    if res['Total'] && !filters[:page]
-      pagetotal = (res['Total'].to_i / res['Per-Page'].to_f).ceil
+    if response['Total']
+      pagetotal = (response['Total'].to_i / response['Per-Page'].to_f).ceil
       for j in 2..pagetotal
-        res = DomoscioRails.send_request(uri, method, params.merge({page: j}), headers, before_request_proc)
-        return res if res.kind_of? DomoscioRails::ProcessingError
+        response = DomoscioRails.send_request(uri, method, params.merge({page: j}), headers)
+        return response if response.kind_of? DomoscioRails::ProcessingError
         begin
-          raise_http_failure(uri, res, params)
-          body = DomoscioRails::JSON.load(res.body.nil? ? '' : res.body)
+          raise_http_failure(uri, response, params)
+          body = DomoscioRails::JSON.load(response.body.nil? ? '' : response.body)
           data += body
           data.flatten!
         rescue MultiJson::LoadError => exception
-          return ProcessingError.new(uri, 500, exception, res.body, params)
+          return ProcessingError.new(uri, 500, exception, response.body, params)
         rescue ResponseError => exception
           return exception
         end
@@ -107,32 +110,51 @@ module DomoscioRails
     data
   end
 
-  def self.send_request(uri, method, params, headers, before_request_proc)
+  private
+
+  # This function catches usual Http errors during calls
+  #
+  def self.send_request(uri, method, params, headers)
     begin
-      res = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
-        req = Net::HTTP::const_get(method.capitalize).new(uri.request_uri, headers)
-        req.body = DomoscioRails::JSON.dump(params)
-        before_request_proc.call(req) if before_request_proc
-        http.request req
-      end
+      response = perform_call(uri, method, params, headers)
+      response = retry_call_and_store_tokens(uri, method, params, headers) if ['401','403'].include? response.code
+      response
     rescue Timeout::Error, Errno::EINVAL, Errno::ECONNREFUSED, Errno::ECONNRESET, EOFError, Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError => exception
-      ProcessingError.new(uri, 500, exception, res)
+      ProcessingError.new(uri, 500, exception, response)
     end
   end
 
-  private
-
-  def self.raise_http_failure(uri, res, params)
-    unless res.kind_of? Net::HTTPSuccess
-      if res.blank?
+  # This helper will check the response status and build the correcponding DomoscioRails::ResponseError
+  #
+  def self.raise_http_failure(uri, response, params)
+    unless response.kind_of? Net::HTTPSuccess
+      if response.blank?
         raise ResponseError.new(uri, 500, {error: {status: 500, message: 'AdaptiveEngine not available'}}, {}, params)
       else
-        body = DomoscioRails::JSON.load((res.body.nil? ? '' : res.body), :symbolize_keys => true)
-        raise ResponseError.new(uri, res.code.to_i, body, res.body, params)
+        raise ResponseError.new(uri, response.code.to_i, DomoscioRails::JSON.load((response.body.nil? ? '' : response.body), :symbolize_keys => true), response.body, params)
       end
     end
   end
 
+  # Actual HTTP call is performed here
+  #
+  def self.perform_call(uri, method, params, headers)
+    Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
+      req = Net::HTTP::const_get(method.capitalize).new(uri.request_uri, headers)
+      req.body = DomoscioRails::JSON.dump(params)
+      http.request req
+    end
+  end
+
+  # This method is called when AdaptiveEngine returns tokens errors
+  # Action on those errors is to retry and request new tokens, those new token are then stored
+  def self.retry_call_and_store_tokens(uri, method, params, headers)
+    headers = request_new_tokens
+    response = perform_call(uri, method, params, headers)
+    DomoscioRails::AuthorizationToken::Manager.storage.store({access_token: response['Accesstoken'], refresh_token: response['Refreshtoken']})
+    response
+  end
+
   def self.user_agent
     @uname ||= get_uname
     {
@@ -150,22 +172,39 @@ module DomoscioRails
     'uname lookup failed'
   end
 
+  # Process the token loading and analyze
+  # will return the processed headers and a token store flag
+  #
   def self.request_headers
-    auth_token = DomoscioRails::AuthorizationToken::Manager.get_token
-    if !auth_token.is_a? String
-      headers = {
-        'user_agent' => "#{DomoscioRails.user_agent}",
-        'AccessToken' => "#{auth_token[:access_token]}",
-        'RefreshToken' => "#{auth_token[:refresh_token]}",
-        'Content-Type' => 'application/json'
-      }
-    else
-      headers = {
-        'user_agent' => "#{DomoscioRails.user_agent}",
-        'Authorization' => "Token token=#{DomoscioRails.configuration.client_passphrase}",
-        'Content-Type' => 'application/json'
-      }
+    begin
+      auth_token = DomoscioRails::AuthorizationToken::Manager.get_token
+      if auth_token && auth_token[:access_token] && auth_token[:refresh_token]
+        [false, send_current_tokens(auth_token)]
+      else
+        [true, request_new_tokens]
+      end
+    rescue SyntaxError, StandardError
+      [true, request_new_tokens]
     end
-    headers
+  end
+
+  # If stored token successfully loaded we build the header with them
+  #
+  def self.send_current_tokens(auth_token)
+    {
+      'user_agent' => "#{DomoscioRails.user_agent}",
+      'AccessToken' => "#{auth_token[:access_token]}",
+      'RefreshToken' => "#{auth_token[:refresh_token]}",
+      'Content-Type' => 'application/json'
+    }
+  end
+
+  # If we cant find tokens of they are corrupted / expired, then we set headers to request new ones
+  def self.request_new_tokens
+    {
+      'user_agent' => "#{DomoscioRails.user_agent}",
+      'Authorization' => "Token token=#{DomoscioRails.configuration.client_passphrase}",
+      'Content-Type' => 'application/json'
+    }
   end
 end

data/lib/domoscio_rails/authorization_token.rb

@@ -11,9 +11,7 @@ module DomoscioRails
         end
 
         def get_token
-          token = storage.get
-          token = DomoscioRails.configuration.client_passphrase if token.nil?
-          token
+          storage.get
         end
       end
     end
@@ -29,13 +27,9 @@ module DomoscioRails
 
     class FileStorage
       require 'yaml'
-      @temp_dir
 
-      def initialize(temp_dir = nil)
-        @temp_dir = temp_dir || DomoscioRails.configuration.temp_dir
-        if !@temp_dir
-          raise "Path to temporary folder is not defined"
-        end
+      def initialize
+        raise "Path to temporary folder is not defined" unless DomoscioRails.configuration.temp_dir
       end
 
       def get
@@ -60,8 +54,7 @@ module DomoscioRails
       end
 
       def file_path
-        @temp_dir = DomoscioRails.configuration.temp_dir
-        File.join(@temp_dir, "DomoscioRails.AuthorizationToken.FileStore.tmp")
+        File.join(DomoscioRails.configuration.temp_dir, "DomoscioRails.AuthorizationToken.FileStore.tmp")
       end
     end
   end

data/lib/domoscio_rails/data/content.rb

@@ -1,10 +1,11 @@
 module DomoscioRails
-  # A Content.
   class Content < Resource
+
     include DomoscioRails::HTTPCalls::Create
     include DomoscioRails::HTTPCalls::Fetch
     include DomoscioRails::HTTPCalls::Update
     include DomoscioRails::HTTPCalls::Destroy
     include DomoscioRails::HTTPCalls::Util
+
   end
 end

data/lib/domoscio_rails/data/event.rb

@@ -1,5 +1,4 @@
 module DomoscioRails
-  # A Student Result on a KnowledgeNode.
   class Event < Resource
     
     include DomoscioRails::HTTPCalls::Create

data/lib/domoscio_rails/data/instance.rb

@@ -1,9 +1,10 @@
 module DomoscioRails
-  # A company.
   class Instance < Resource
+
     include DomoscioRails::HTTPCalls::Create
     include DomoscioRails::HTTPCalls::Fetch
     include DomoscioRails::HTTPCalls::UpdateSelf
     include DomoscioRails::HTTPCalls::Destroy
+
   end
 end

data/lib/domoscio_rails/data/learning_session.rb

@@ -1,10 +1,11 @@
 module DomoscioRails
-  # A LearningSession is basicly a group of events.
   class LearningSession < Resource
-    
+
     include DomoscioRails::HTTPCalls::Create
     include DomoscioRails::HTTPCalls::Fetch
     include DomoscioRails::HTTPCalls::Destroy
+    include DomoscioRails::HTTPCalls::Update
+    include DomoscioRails::HTTPCalls::Util
 
   end
 end

data/lib/domoscio_rails/data/recommendation.rb

@@ -0,0 +1,7 @@
+module DomoscioRails
+  class Recommendation < Resource
+
+    include DomoscioRails::HTTPCalls::Fetch
+
+  end
+end

data/lib/domoscio_rails/data/student.rb

@@ -1,9 +1,10 @@
 module DomoscioRails
-  # A company.
   class Student < Resource
+
     include DomoscioRails::HTTPCalls::Create
     include DomoscioRails::HTTPCalls::Fetch
-    include DomoscioRails::HTTPCalls::Update
     include DomoscioRails::HTTPCalls::Destroy
+    include DomoscioRails::HTTPCalls::Update
+
   end
 end

data/lib/domoscio_rails/errors.rb

@@ -10,7 +10,7 @@ module DomoscioRails
       @request_url, @code, @details, @body, @request_params = request_url, code, details, body, request_params
       super(message) if message
     end
-    def message; @details.is_a?(Hash) ? @details.dig(:error, :message) : @details; end
+    def message; (@details.is_a?(Hash) && @details[:error].is_a?(Hash)) ? @details.dig(:error, :message) : @details; end
   end
 
   # ProcessingError from DomoscioRails

data/lib/domoscio_rails/knowledge/knowledge_edge.rb

@@ -1,11 +1,10 @@
 module DomoscioRails
-  # A Knowledge Edge.
   class KnowledgeEdge < Resource
-    
+
     include DomoscioRails::HTTPCalls::Create
     include DomoscioRails::HTTPCalls::Fetch
-    include DomoscioRails::HTTPCalls::Update
     include DomoscioRails::HTTPCalls::Destroy
+    include DomoscioRails::HTTPCalls::Update
 
   end
 end

data/lib/domoscio_rails/knowledge/knowledge_graph.rb

@@ -1,11 +1,10 @@
 module DomoscioRails
-  # A Knowledge Graph.
   class KnowledgeGraph < Resource
-    
+
     include DomoscioRails::HTTPCalls::Create
     include DomoscioRails::HTTPCalls::Fetch
-    include DomoscioRails::HTTPCalls::Update
     include DomoscioRails::HTTPCalls::Destroy
+    include DomoscioRails::HTTPCalls::Update
 
   end
 end

data/lib/domoscio_rails/knowledge/knowledge_node.rb

@@ -1,11 +1,10 @@
 module DomoscioRails
-  # A Knowledge Node.
   class KnowledgeNode < Resource
-    
+
     include DomoscioRails::HTTPCalls::Create
     include DomoscioRails::HTTPCalls::Fetch
-    include DomoscioRails::HTTPCalls::Update
     include DomoscioRails::HTTPCalls::Destroy
+    include DomoscioRails::HTTPCalls::Update
 
   end
 end

data/lib/domoscio_rails/knowledge/knowledge_node_content.rb

@@ -1,9 +1,10 @@
 module DomoscioRails
-  # A KnowledgeNodeContent.
   class KnowledgeNodeContent < Resource
+
     include DomoscioRails::HTTPCalls::Create
     include DomoscioRails::HTTPCalls::Fetch
-    include DomoscioRails::HTTPCalls::Update
     include DomoscioRails::HTTPCalls::Destroy
+    include DomoscioRails::HTTPCalls::Update
+
   end
 end

data/lib/domoscio_rails/knowledge/knowledge_node_student.rb

@@ -1,7 +1,6 @@
 module DomoscioRails
-  # A Knowledge Edge.
   class KnowledgeNodeStudent < Resource
-    
+
     include DomoscioRails::HTTPCalls::Create
     include DomoscioRails::HTTPCalls::Fetch
     include DomoscioRails::HTTPCalls::Destroy

data/lib/domoscio_rails/objective/objective.rb

@@ -1,9 +1,10 @@
 module DomoscioRails
-  # An objective.
   class Objective < Resource
+
     include DomoscioRails::HTTPCalls::Create
     include DomoscioRails::HTTPCalls::Fetch
-    include DomoscioRails::HTTPCalls::Update
     include DomoscioRails::HTTPCalls::Destroy
+    include DomoscioRails::HTTPCalls::Update
+
   end
 end

data/lib/domoscio_rails/objective/objective_knowledge_node.rb

@@ -1,6 +1,10 @@
 module DomoscioRails
-    # An objective knowledge node.
-    class ObjectiveKnowledgeNode < Resource
-      include DomoscioRails::HTTPCalls::Fetch
-    end
+  class ObjectiveKnowledgeNode < Resource
+
+    include DomoscioRails::HTTPCalls::Create
+    include DomoscioRails::HTTPCalls::Fetch
+    include DomoscioRails::HTTPCalls::Destroy
+    include DomoscioRails::HTTPCalls::Update
+
   end
+end

data/lib/domoscio_rails/objective/objective_knowledge_node_student.rb

@@ -1,6 +1,10 @@
 module DomoscioRails
-    class ObjectiveKnowledgeNodeStudent < Resource
-      include DomoscioRails::HTTPCalls::Fetch
-      include DomoscioRails::HTTPCalls::Update
-    end
-  end
+  class ObjectiveKnowledgeNodeStudent < Resource
+
+    include DomoscioRails::HTTPCalls::Create
+    include DomoscioRails::HTTPCalls::Fetch
+    include DomoscioRails::HTTPCalls::Destroy
+    include DomoscioRails::HTTPCalls::Update
+
+  end
+end

data/lib/domoscio_rails/objective/objective_student.rb

@@ -1,10 +1,11 @@
 module DomoscioRails
-  # An objective student.
   class ObjectiveStudent < Resource
+
     include DomoscioRails::HTTPCalls::Create
     include DomoscioRails::HTTPCalls::Fetch
-    include DomoscioRails::HTTPCalls::Update
     include DomoscioRails::HTTPCalls::Destroy
+    include DomoscioRails::HTTPCalls::Update
     include DomoscioRails::HTTPCalls::Util
+
   end
 end

data/lib/domoscio_rails/tag/tag.rb

@@ -1,9 +1,10 @@
 module DomoscioRails
-  # A Tag.
   class Tag < Resource
+
     include DomoscioRails::HTTPCalls::Create
     include DomoscioRails::HTTPCalls::Fetch
-    include DomoscioRails::HTTPCalls::Update
     include DomoscioRails::HTTPCalls::Destroy
+    include DomoscioRails::HTTPCalls::Update
+
   end
 end

data/lib/domoscio_rails/tag/tag_edge.rb

@@ -1,9 +1,10 @@
 module DomoscioRails
-  # A TagEdge.
   class TagEdge < Resource
+
     include DomoscioRails::HTTPCalls::Create
     include DomoscioRails::HTTPCalls::Fetch
-    include DomoscioRails::HTTPCalls::Update
     include DomoscioRails::HTTPCalls::Destroy
+    include DomoscioRails::HTTPCalls::Update
+
   end
 end

data/lib/domoscio_rails/tag/tag_set.rb

@@ -1,9 +1,10 @@
 module DomoscioRails
-  # A TagSet.
   class TagSet < Resource
+
     include DomoscioRails::HTTPCalls::Create
     include DomoscioRails::HTTPCalls::Fetch
-    include DomoscioRails::HTTPCalls::Update
     include DomoscioRails::HTTPCalls::Destroy
+    include DomoscioRails::HTTPCalls::Update
+
   end
 end

data/lib/domoscio_rails/tag/tagging.rb

@@ -1,9 +1,10 @@
 module DomoscioRails
-  # A Tagging.
   class Tagging < Resource
+
     include DomoscioRails::HTTPCalls::Create
     include DomoscioRails::HTTPCalls::Fetch
-    include DomoscioRails::HTTPCalls::Update
     include DomoscioRails::HTTPCalls::Destroy
+    include DomoscioRails::HTTPCalls::Update
+
   end
 end

data/lib/domoscio_rails/utils/gameplay_util.rb

@@ -1,6 +1,7 @@
 module DomoscioRails
-  # A company.
   class GameplayUtil < Resource
+
     include DomoscioRails::HTTPCalls::Util
+
   end
 end

data/lib/domoscio_rails/utils/recommendation_util.rb

@@ -1,6 +1,7 @@
 module DomoscioRails
-    # A company.
-    class RecommendationUtil < Resource
-      include DomoscioRails::HTTPCalls::Util
-    end
-  end
+  class RecommendationUtil < Resource
+
+    include DomoscioRails::HTTPCalls::Util
+
+  end
+end

data/lib/domoscio_rails/utils/review_util.rb

@@ -1,6 +1,7 @@
 module DomoscioRails
-  # A company.
   class ReviewUtil < Resource
+
     include DomoscioRails::HTTPCalls::Util
+
   end
 end

data/lib/domoscio_rails/version.rb

@@ -1,3 +1,3 @@
 module DomoscioRails
-  VERSION = "0.3.4"
+  VERSION = "0.3.8a"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: domoscio_rails
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.8a
 platform: ruby
 authors:
 - Benoit Praly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-02 00:00:00.000000000 Z
+date: 2021-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -41,6 +41,7 @@ files:
 - lib/domoscio_rails/data/event.rb
 - lib/domoscio_rails/data/instance.rb
 - lib/domoscio_rails/data/learning_session.rb
+- lib/domoscio_rails/data/recommendation.rb
 - lib/domoscio_rails/data/student.rb
 - lib/domoscio_rails/errors.rb
 - lib/domoscio_rails/http_calls.rb
@@ -78,9 +79,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.1.2
 signing_key: