domoscio_rails 0.2.24 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80036d711a50e0323cbd9f9fa260ebc9c9c6d194060f68b8be05d2ee7eab4206
-  data.tar.gz: 944991129c4a01704a0b24776d605ff926f408b48e17e998b1a525bcf43a469b
+  metadata.gz: b7cabe98aeb3d48cbe9e3221c798052ca22e9838641b0f0eb5c814651b56b86e
+  data.tar.gz: add23b57f3520e3c63c943beb1e915b3ca75f82ff1a015048079342c2f9ba981
 SHA512:
-  metadata.gz: ae6d858a4ca54802ff2504ee268fcacf8915cc45832fad48ba59c70daf1f49567112f5647b68dded5ab0056cef403cb77e52e9a06f341fc52f9ee45d52babd98
-  data.tar.gz: 01f77a383197e1e91b4b4c196d40098b44fec5a60eb2ec87a06ed34bde89633053000799b2920200d38b3b14266dda6e64cba292b34fdd726d54a4f1feb4109f
+  metadata.gz: 641267c7319ab1653ceb738267fa8f4faa2705d13d19f0e139c95b6f862c33eaedb23c4d0ae47bde11dd37ba7dbf2a423d63976b61e699ae1fdca0855030e403
+  data.tar.gz: 0db98990280a8ea3eb7d4ed485f02e5a0117127c03b8474220740d247ebd307e64161e1ead8200dc4235b22dc822e389d19c24326c0123dfa1aa4a813a443ae7

data/lib/domoscio_rails.rb

@@ -2,83 +2,47 @@
 require 'net/https'
 require 'cgi/util'
 require 'multi_json'
-
 # helpers
 require 'domoscio_rails/version'
 require 'domoscio_rails/json'
 require 'domoscio_rails/errors'
 require 'domoscio_rails/authorization_token'
-
 # resources
 require 'domoscio_rails/http_calls'
 require 'domoscio_rails/resource'
-require 'domoscio_rails/adaptative/deterministic/path_rule'
-require 'domoscio_rails/adaptative/deterministic/rule_input'
-require 'domoscio_rails/adaptative/deterministic/rule_output'
-require 'domoscio_rails/adaptative/deterministic/rule_condition'
-require 'domoscio_rails/adaptative/predictive/objective'
-require 'domoscio_rails/adaptative/predictive/objective_student'
-require 'domoscio_rails/adaptative/predictive/objective_knowledge_node'
-require 'domoscio_rails/adaptative/predictive/objective_knowledge_node_student'
-require 'domoscio_rails/adaptative/recommendation'
-require 'domoscio_rails/path/learning_path'
-require 'domoscio_rails/content/content'
-require 'domoscio_rails/content/knowledge_node_content'
-require 'domoscio_rails/student/student'
-require 'domoscio_rails/student/student_cluster'
-require 'domoscio_rails/knowledge/knowledge_graph'
-require 'domoscio_rails/knowledge/knowledge_edge'
-require 'domoscio_rails/knowledge/knowledge_node'
-require 'domoscio_rails/metadata/tag'
-require 'domoscio_rails/metadata/tagging'
-require 'domoscio_rails/metadata/tag_set'
-require 'domoscio_rails/metadata/tag_edge'
-require 'domoscio_rails/data/knowledge_node_student'
-require 'domoscio_rails/data/event'
-require 'domoscio_rails/data/learning_session'
-require 'domoscio_rails/utils/review_util'
-require 'domoscio_rails/utils/gameplay_util'
-require 'domoscio_rails/utils/alerts_util'
-require 'domoscio_rails/utils/recommendation_util'
-require 'domoscio_rails/metadata/delta_object'
+require 'domoscio_rails/data/content.rb'
+require 'domoscio_rails/data/event.rb'
+require 'domoscio_rails/data/instance.rb'
+require 'domoscio_rails/data/learning_session.rb'
+require 'domoscio_rails/data/student.rb'
+require 'domoscio_rails/knowledge/knowledge_edge.rb'
+require 'domoscio_rails/knowledge/knowledge_graph.rb'
+require 'domoscio_rails/knowledge/knowledge_node_content.rb'
+require 'domoscio_rails/knowledge/knowledge_node_student.rb'
+require 'domoscio_rails/knowledge/knowledge_node.rb'
+require 'domoscio_rails/objective/objective_knowledge_node_student.rb'
+require 'domoscio_rails/objective/objective_knowledge_node.rb'
+require 'domoscio_rails/objective/objective_student.rb'
+require 'domoscio_rails/objective/objective.rb'
+require 'domoscio_rails/tag/tag_edge.rb'
+require 'domoscio_rails/tag/tag_set.rb'
+require 'domoscio_rails/tag/tag.rb'
+require 'domoscio_rails/tag/tagging.rb'
+require 'domoscio_rails/utils/gameplay_util.rb'
+require 'domoscio_rails/utils/recommendation_util.rb'
+require 'domoscio_rails/utils/review_util.rb'
 
 module DomoscioRails
-
   class Configuration
-    attr_accessor :preproduction, :test, :dev, :root_url, :client_id, :client_passphrase, :temp_dir, :disabled, :version
-
-    def disabled
-      @disabled || false
-    end
-
-    def preproduction
-      @preproduction || false
-    end
-
-    def test
-      @test || false
-    end
-
-    def dev
-      @dev || false
-    end
+    attr_accessor :root_url, :client_id, :client_passphrase, :temp_dir, :version
 
+    # Refers to AdaptiveEngine Version
     def version
-      @version || 1
+      @version || 2
     end
 
     def root_url
-      if @preproduction == true
-        if @test == true
-          @root_url || "https://staging.adaptive-engine.domoscio.com"
-        elsif @dev == true
-          @root_url || "https://preprod.adaptive-engine.domoscio.com"
-        else
-          @root_url || "https://adaptive-engine.domoscio.com"
-        end
-      else
-        @root_url || "http://localhost:3001"
-      end
+      @root_url || ""
     end
   end
 
@@ -107,56 +71,70 @@ module DomoscioRails
   #
   def self.request(method, url, params={}, filters={}, headers = request_headers, before_request_proc = nil)
     return false if @disabled
+    # sets a default page size to 2k
+    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)
-
-    # decode json data
+    return res if res.kind_of? DomoscioRails::ProcessingError
     begin
+      raise_http_failure(uri, res, params)
       data = DomoscioRails::JSON.load(res.body.nil? ? '' : res.body)
-      unless (res.kind_of? Net::HTTPClientError) || (res.kind_of? Net::HTTPServerError)
-        DomoscioRails::AuthorizationToken::Manager.storage.store({access_token: res['Accesstoken'], refresh_token: res['Refreshtoken']})
-      end
-    rescue MultiJson::LoadError
-      data = {}
+      DomoscioRails::AuthorizationToken::Manager.storage.store({access_token: res['Accesstoken'], refresh_token: res['Refreshtoken']})
+    rescue MultiJson::LoadError => exception
+      data = ProcessingError.new(uri, 500, exception, res.body, params)
+    rescue ResponseError => exception
+      data = exception
     end
 
     if res['Total'] && !filters[:page]
       pagetotal = (res['Total'].to_i / res['Per-Page'].to_f).ceil
-
       for j in 2..pagetotal
-        params = params.merge({page: j})
-        res = DomoscioRails.send_request(uri, method, params, headers, before_request_proc)
-
-        # decode json data
+        res = DomoscioRails.send_request(uri, method, params.merge({page: j}), headers, before_request_proc)
+        return res if res.kind_of? DomoscioRails::ProcessingError
         begin
-          data += DomoscioRails::JSON.load(res.body.nil? ? '' : res.body)
+          raise_http_failure(uri, res, params)
+          body = DomoscioRails::JSON.load(res.body.nil? ? '' : res.body)
+          data += body
           data.flatten!
-        rescue MultiJson::LoadError
-          data = {}
+        rescue MultiJson::LoadError => exception
+          return ProcessingError.new(uri, 500, exception, res.body, params)
+        rescue ResponseError => exception
+          return exception
         end
-
       end
     end
     data
   end
 
-
   def self.send_request(uri, method, params, headers, before_request_proc)
-    res = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http| # , 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
+    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
+    rescue Timeout::Error, Errno::EINVAL, Errno::ECONNREFUSED, Errno::ECONNRESET, EOFError, Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError => exception
+      ProcessingError.new(uri, 500, exception, res)
     end
   end
 
   private
 
+  def self.raise_http_failure(uri, res, params)
+    unless res.kind_of? Net::HTTPSuccess
+      if res.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)
+      end
+    end
+  end
+
   def self.user_agent
     @uname ||= get_uname
-
     {
       bindings_version: DomoscioRails::VERSION,
       lang: 'ruby',
@@ -174,21 +152,20 @@ module DomoscioRails
 
   def self.request_headers
     auth_token = DomoscioRails::AuthorizationToken::Manager.get_token
-
     if !auth_token.is_a? String
       headers = {
-        'user_agent' => "DomoscioRails V2 RubyBindings/#{DomoscioRails::VERSION}",
+        'user_agent' => "#{DomoscioRails.user_agent}",
         'AccessToken' => "#{auth_token[:access_token]}",
         'RefreshToken' => "#{auth_token[:refresh_token]}",
         'Content-Type' => 'application/json'
       }
     else
       headers = {
-        'user_agent' => "DomoscioRails V2 RubyBindings/#{DomoscioRails::VERSION}",
-        'Authorization' => "Token token=#{DomoscioRails.configuration.client_passphrase}",#"#{auth_token['token_type']} #{auth_token['access_token']}",
+        'user_agent' => "#{DomoscioRails.user_agent}",
+        'Authorization' => "Token token=#{DomoscioRails.configuration.client_passphrase}",
         'Content-Type' => 'application/json'
       }
     end
     headers
   end
-end
+end

data/lib/domoscio_rails/authorization_token.rb

@@ -1,8 +1,6 @@
 module DomoscioRails
   module AuthorizationToken
-
     class Manager
-
       class << self
         def storage
           @@storage ||= FileStorage.new
@@ -19,7 +17,6 @@ module DomoscioRails
         end
       end
     end
-
     class StaticStorage
       def get
         @@token ||= nil
@@ -63,7 +60,7 @@ module DomoscioRails
       end
 
       def file_path
-        @temp_dir = DomoscioRails.configuration.temp_dir if @temp_dir != DomoscioRails.configuration.temp_dir
+        @temp_dir = DomoscioRails.configuration.temp_dir
         File.join(@temp_dir, "DomoscioRails.AuthorizationToken.FileStore.tmp")
       end
     end

data/lib/domoscio_rails/{content → data}/content.rb

@@ -5,5 +5,6 @@ module DomoscioRails
     include DomoscioRails::HTTPCalls::Fetch
     include DomoscioRails::HTTPCalls::Update
     include DomoscioRails::HTTPCalls::Destroy
+    include DomoscioRails::HTTPCalls::Util
   end
 end

data/lib/domoscio_rails/errors.rb

@@ -1,24 +1,25 @@
 module DomoscioRails
-
   # Generic error superclass for MangoPay specific errors.
-  # Currently never instantiated directly.
-  # Currently only single subclass used.
   class Error < StandardError
   end
 
-  # Thrown from any MangoPay API call whenever
-  # it returns response with HTTP code != 200.
+  # Error Message from AdaptiveEngine
   class ResponseError < Error
-
-    attr_reader :request_url, :code, :details
-
-    def initialize(request_url, code, details)
-      @request_url, @code, @details = request_url, code, details
+    attr_reader :request_url, :code, :details, :body, :request_params
+    def initialize(request_url, code, details = {}, body = nil, request_params = {})
+      @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
+  end
 
-    def message; @details['Message']; end
-    def type;    @details['Type']; end
-    def errors;  @details['errors']; end
+  # ProcessingError from DomoscioRails
+  class ProcessingError < Error
+    attr_reader :request_url, :code, :details, :body, :request_params
+    def initialize(request_url, code, details = {}, body = nil, request_params = {})
+      @request_url, @code, @details, @body, @request_params = request_url, code, details, body, request_params
+      super(message) if message
+    end
+    def message; @details.message; end
   end
 end

data/lib/domoscio_rails/http_calls.rb

@@ -8,7 +8,6 @@ module DomoscioRails
           DomoscioRails.request(:post, url(id), params)
         end
       end
-
       def self.included(base)
         base.extend(ClassMethods)
       end
@@ -20,7 +19,6 @@ module DomoscioRails
           DomoscioRails.request(:put, url(id), params)
         end
       end
-
       def self.included(base)
         base.extend(ClassMethods)
       end
@@ -32,7 +30,6 @@ module DomoscioRails
           DomoscioRails.request(:put, url(nil, nil, true), params)
         end
       end
-
       def self.included(base)
         base.extend(ClassMethods)
       end
@@ -40,19 +37,14 @@ module DomoscioRails
 
     module Fetch
       module ClassMethods
-        def fetch(id_or_filters = nil)
-          id, filters = DomoscioRails::HTTPCalls::Fetch.parse_id_or_filters(id_or_filters)
-          response = DomoscioRails.request(:get, url(id), {}, filters)
+        def fetch(id = nil, params = {})
+          DomoscioRails.request(:get, url(id), params)
         end
       end
 
       def self.included(base)
         base.extend(ClassMethods)
       end
-
-      def self.parse_id_or_filters(id_or_filters = nil)
-        id_or_filters.is_a?(Hash) ? [nil, id_or_filters] : [id_or_filters, {}]
-      end
     end
 
     module Destroy
@@ -81,7 +73,5 @@ module DomoscioRails
         base.extend(ClassMethods)
       end
     end
-
-
   end
 end

data/lib/domoscio_rails/{adaptative/predictive → objective}/objective_knowledge_node_student.rb

@@ -1,7 +1,6 @@
 module DomoscioRails
-    # An objective knowledge node student.
     class ObjectiveKnowledgeNodeStudent < Resource
       include DomoscioRails::HTTPCalls::Fetch
       include DomoscioRails::HTTPCalls::Update
     end
-  end
+  end

data/lib/domoscio_rails/resource.rb

@@ -1,16 +1,13 @@
 module DomoscioRails
-  # @abstract
   class Resource
     class << self
       def class_name
         name.split('::')[-1]
       end
-
       def url(id = nil, util_name = nil, on_self = nil )
         if self == Resource
           raise NotImplementedError.new('Resource is an abstract class. Do not use it directly.')
         end
-        
         build_url = "/v#{DomoscioRails.configuration.version}/instances/#{DomoscioRails.configuration.client_id}"
         if !on_self
           build_url << "/#{class_name.underscore}s"
@@ -25,4 +22,4 @@ module DomoscioRails
       end
     end
   end
-end
+end

data/lib/domoscio_rails/version.rb

@@ -1,3 +1,3 @@
 module DomoscioRails
-  VERSION = "0.2.24"
-end
+  VERSION = "0.3.5"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: domoscio_rails
 version: !ruby/object:Gem::Version
-  version: 0.2.24
+  version: 0.3.5
 platform: ruby
 authors:
 - Benoit Praly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-04 00:00:00.000000000 Z
+date: 2021-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -36,44 +36,33 @@ files:
 - Rakefile
 - lib/domoscio_rails.rb
 - lib/domoscio_rails.tbz
-- lib/domoscio_rails/adaptative/deterministic/path_rule.rb
-- lib/domoscio_rails/adaptative/deterministic/rule_condition.rb
-- lib/domoscio_rails/adaptative/deterministic/rule_input.rb
-- lib/domoscio_rails/adaptative/deterministic/rule_output.rb
-- lib/domoscio_rails/adaptative/predictive/objective.rb
-- lib/domoscio_rails/adaptative/predictive/objective_knowledge_node.rb
-- lib/domoscio_rails/adaptative/predictive/objective_knowledge_node_student.rb
-- lib/domoscio_rails/adaptative/predictive/objective_student.rb
-- lib/domoscio_rails/adaptative/recommendation.rb
-- lib/domoscio_rails/admin/instance.rb
 - lib/domoscio_rails/authorization_token.rb
-- lib/domoscio_rails/content/content.rb
-- lib/domoscio_rails/content/knowledge_node_content.rb
+- lib/domoscio_rails/data/content.rb
 - lib/domoscio_rails/data/event.rb
-- lib/domoscio_rails/data/knowledge_node_student.rb
+- lib/domoscio_rails/data/instance.rb
 - lib/domoscio_rails/data/learning_session.rb
-- lib/domoscio_rails/data/result.rb
+- lib/domoscio_rails/data/student.rb
 - lib/domoscio_rails/errors.rb
 - lib/domoscio_rails/http_calls.rb
 - lib/domoscio_rails/json.rb
 - lib/domoscio_rails/knowledge/knowledge_edge.rb
 - lib/domoscio_rails/knowledge/knowledge_graph.rb
 - lib/domoscio_rails/knowledge/knowledge_node.rb
-- lib/domoscio_rails/metadata/delta_object.rb
-- lib/domoscio_rails/metadata/tag.rb
-- lib/domoscio_rails/metadata/tag_edge.rb
-- lib/domoscio_rails/metadata/tag_set.rb
-- lib/domoscio_rails/metadata/tagging.rb
-- lib/domoscio_rails/path/learning_path.rb
+- lib/domoscio_rails/knowledge/knowledge_node_content.rb
+- lib/domoscio_rails/knowledge/knowledge_node_student.rb
+- lib/domoscio_rails/objective/objective.rb
+- lib/domoscio_rails/objective/objective_knowledge_node.rb
+- lib/domoscio_rails/objective/objective_knowledge_node_student.rb
+- lib/domoscio_rails/objective/objective_student.rb
 - lib/domoscio_rails/resource.rb
-- lib/domoscio_rails/student/student.rb
-- lib/domoscio_rails/student/student_cluster.rb
-- lib/domoscio_rails/utils/alerts_util.rb
+- lib/domoscio_rails/tag/tag.rb
+- lib/domoscio_rails/tag/tag_edge.rb
+- lib/domoscio_rails/tag/tag_set.rb
+- lib/domoscio_rails/tag/tagging.rb
 - lib/domoscio_rails/utils/gameplay_util.rb
 - lib/domoscio_rails/utils/recommendation_util.rb
 - lib/domoscio_rails/utils/review_util.rb
 - lib/domoscio_rails/version.rb
-- lib/tasks/domoscio_rails_tasks.rake
 homepage: http://www.domoscio.com
 licenses:
 - MIT
@@ -93,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Summary of DomoscioRails.

data/lib/domoscio_rails/adaptative/deterministic/path_rule.rb

@@ -1,10 +0,0 @@
-module DomoscioRails
-  # A PathRule.
-  class PathRule < 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/adaptative/deterministic/rule_condition.rb

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

data/lib/domoscio_rails/adaptative/deterministic/rule_input.rb

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

data/lib/domoscio_rails/adaptative/deterministic/rule_output.rb

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

data/lib/domoscio_rails/adaptative/recommendation.rb

@@ -1,7 +0,0 @@
-module DomoscioRails
-  # A Recommandation.
-  class Recommendation < Resource
-    include DomoscioRails::HTTPCalls::Fetch
-    include DomoscioRails::HTTPCalls::Destroy
-  end
-end

data/lib/domoscio_rails/data/result.rb

@@ -1,10 +0,0 @@
-module DomoscioRails
-  # A Student Result on a KnowledgeNode.
-  class Result < Resource
-    
-    include DomoscioRails::HTTPCalls::Create
-    include DomoscioRails::HTTPCalls::Fetch
-    include DomoscioRails::HTTPCalls::Destroy
-
-  end
-end

data/lib/domoscio_rails/metadata/delta_object.rb

@@ -1,6 +0,0 @@
-module DomoscioRails
-  # A delta object.
-  class DeltaObject < Resource
-    include DomoscioRails::HTTPCalls::Fetch
-  end
-end

data/lib/domoscio_rails/path/learning_path.rb

@@ -1,6 +0,0 @@
-module DomoscioRails
-  # A LearningPath.
-  class LearningPath < Resource
-    include DomoscioRails::HTTPCalls::Fetch
-  end
-end

data/lib/domoscio_rails/student/student_cluster.rb

@@ -1,6 +0,0 @@
-module DomoscioRails
-  # A student cluster.
-  class StudentCluster < Resource
-    include DomoscioRails::HTTPCalls::Fetch
-  end
-end

data/lib/domoscio_rails/utils/alerts_util.rb

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

data/lib/tasks/domoscio_rails_tasks.rake

@@ -1,4 +0,0 @@
-# desc "Explaining what the task does"
-# task :domoscio_rails do
-#   # Task goes here
-# end