domoscio_rails 0.2.14 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f3eace41e37214c6a5a2649420cb57edd98ec923
-  data.tar.gz: c87f19311410ae698ff78abb40a607a1f12d0103
+SHA256:
+  metadata.gz: 4b1afdf503120aeb74bb9d38237a533f7becd888b329098199446db697b9fe26
+  data.tar.gz: bda6a20da9b44d4ef8a32910688ec633606168f012b7d6af4047854d7e443a0e
 SHA512:
-  metadata.gz: 79285394f183ebd822d66d1cab36a6185d7a6561d5a7cbf6ec01096a85c583c964b4aebaf1fab3fe07fc2fcf1ad3263f48edb3b2e256e09b3aa9361c8239a8cc
-  data.tar.gz: d0f7faa57bd977033263b18fbcfab376027ad946105be2a25525cf9797744f8aede2b6309e204464366d7bb9f428897984c294d0dbe3a2f2a59e36af6c50d316
+  metadata.gz: d350f60cbbb55a8e5a8222edac01778216c3e3db07c645b3212c849ab41dc670eb1d79f9d31ff8256a0f5d702934af3043cf368fb9635bc206d44e2023ba50bb
+  data.tar.gz: 388c1db2de8db63dfccea4335a0c8542615725408501283293aa537282a8d5ed4e285231f4d3ed45dae603cde678ebef80fb6ad356cc4bf1857dff1c3a4e67a8

data/lib/domoscio_rails.rb

@@ -1,14 +1,12 @@
-  
-require 'net/http'
+
+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'
@@ -18,13 +16,12 @@ 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_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/admin/user'
 require 'domoscio_rails/student/student'
 require 'domoscio_rails/student/student_cluster'
 require 'domoscio_rails/knowledge/knowledge_graph'
@@ -36,17 +33,16 @@ 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'
 module DomoscioRails
-
   class Configuration
-    attr_accessor :preproduction, :root_url,
-    :client_id, :client_passphrase,
-    :temp_dir, :disabled, :version
-    
+    attr_accessor :preproduction, :test, :dev, :root_url, :client_id, :client_passphrase, :temp_dir, :disabled, :version
+
     def disabled
       @disabled || false
     end
@@ -54,13 +50,31 @@ module DomoscioRails
     def preproduction
       @preproduction || false
     end
-    
+
+    def test
+      @test || false
+    end
+
+    def dev
+      @dev || false
+    end
+
     def version
       @version || 1
     end
 
     def root_url
-      @root_url || (@preproduction == true  ? ( @version > 1 ? "http://api.domoscio.com" : "http://stats-engine-api.domoscio.com" )  : "http://localhost:3001/")
+      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
     end
   end
 
@@ -90,47 +104,62 @@ module DomoscioRails
   def self.request(method, url, params={}, filters={}, headers = request_headers, before_request_proc = nil)
     return false if @disabled
     uri = api_uri(url)
-    uri.query = URI.encode_www_form(filters) unless filters.empty?    
-    
-    res = Net::HTTP.start(uri.host, uri.port) 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
-    end
-
-    # decode json data
+    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
     begin
+      unless res.kind_of? Net::HTTPSuccess
+        data = DomoscioRails::JSON.load((res.body.nil? ? '' : res.body), :symbolize_keys => true) 
+        raise ResponseError.new(uri, res.code.to_i, data, res.body)
+      end
       data = DomoscioRails::JSON.load(res.body.nil? ? '' : res.body)
-    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)
+    rescue ResponseError => exception
+      data = exception
     end
 
-    ############### TEMP!!!! #######################################################
-    #pp method, uri.request_uri, params #, filters, headers
-    #pp res, data
-    #puts
-
-    # if (!(res.is_a? Net::HTTPOK))
-    #   ex = DomoscioRails::ResponseError.new(uri, res.code, data)
-    #   ############## TEMP!!!! ########################################################
-    #   #pp ex, data
-    #   raise ex
-    # end
-
-    # copy pagination info if any
-    # ['x-number-of-pages', 'x-number-of-items'].each { |k|
-#       filters[k.gsub('x-number-of-', 'total_')] = res[k].to_i if res[k]
-#     }
-
+    if res['Total'] && !filters[:page]
+      pagetotal = (res['Total'].to_i / res['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
+        begin
+          unless res.kind_of? Net::HTTPSuccess
+            body = DomoscioRails::JSON.load((res.body.nil? ? '' : res.body), :symbolize_keys => true) 
+            raise ResponseError.new(uri, res.code.to_i, body, res.body)
+          end
+          body = DomoscioRails::JSON.load(res.body.nil? ? '' : res.body)
+          data += body
+          data.flatten!
+        rescue MultiJson::LoadError => exception
+          return ProcessingError.new(uri, 500, exception, res.body)
+        rescue ResponseError => exception
+          return exception
+        end
+      end
+    end
     data
   end
 
+  def self.send_request(uri, method, params, headers, before_request_proc)
+    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.body)
+    end
+  end
+
   private
 
   def self.user_agent
     @uname ||= get_uname
-
     {
       bindings_version: DomoscioRails::VERSION,
       lang: 'ruby',
@@ -148,17 +177,21 @@ module DomoscioRails
 
   def self.request_headers
     auth_token = DomoscioRails::AuthorizationToken::Manager.get_token
-    headers = {
-      'user_agent' => "DomoscioRails V2 RubyBindings/#{DomoscioRails::VERSION}",
-      'Authorization' => "Token token=#{DomoscioRails.configuration.client_passphrase}",#"#{auth_token['token_type']} #{auth_token['access_token']}",
-      'Content-Type' => 'application/json'
-    }
-    # begin
-#       headers.update('x_mangopay_client_user_agent' => DomoscioRails::JSON.dump(user_agent))
-#     rescue => e
-#       headers.update('x_mangopay_client_raw_user_agent' => user_agent.inspect, error: "#{e} (#{e.class})")
-#     end
+
+    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'
+      }
+    end
+    headers
   end
-  
-  
-end
+end

data/lib/domoscio_rails/adaptative/predictive/objective_knowledge_node.rb

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

data/lib/domoscio_rails/adaptative/predictive/objective_knowledge_node_student.rb

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

data/lib/domoscio_rails/adaptative/predictive/objective_student.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
+end

data/lib/domoscio_rails/authorization_token.rb

@@ -1,11 +1,9 @@
 module DomoscioRails
   module AuthorizationToken
-
     class Manager
-
       class << self
         def storage
-          @@storage ||= StaticStorage.new
+          @@storage ||= FileStorage.new
         end
 
         def storage= (storage)
@@ -13,22 +11,12 @@ module DomoscioRails
         end
 
         def get_token
-          # token = storage.get
-          #           if token.nil? || token['timestamp'].nil? || token['timestamp'] <= Time.now
-          #             token = DomoscioRails.request(:post, '/api/oauth/token', {}, {}, {}, Proc.new do |req|
-          #               cfg = DomoscioRails.configuration
-          #               req.basic_auth cfg.client_id, cfg.client_passphrase
-          #               req.body = 'grant_type=client_credentials'
-          #             end)
-          #             token['timestamp'] = Time.now + token['expires_in'].to_i
-          #             storage.store token
-          #           end
-          token = DomoscioRails.configuration.client_passphrase
+          token = storage.get
+          token = DomoscioRails.configuration.client_passphrase if token.nil?
           token
         end
       end
     end
-
     class StaticStorage
       def get
         @@token ||= nil
@@ -72,6 +60,7 @@ module DomoscioRails
       end
 
       def file_path
+        @temp_dir = DomoscioRails.configuration.temp_dir
         File.join(@temp_dir, "DomoscioRails.AuthorizationToken.FileStore.tmp")
       end
     end

data/lib/domoscio_rails/data/learning_session.rb

@@ -0,0 +1,10 @@
+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
+
+  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
+    def initialize(request_url, code, details, body)
+      @request_url, @code, @details, @body = request_url, code, details, body
       super(message) if message
     end
+    def message; @details.dig(:error, :message) || @details; end
+  end
 
-    def message; @details['Message']; end
-    def type;    @details['Type']; end
-    def errors;  @details['errors']; end
+  # Error Message from DomoscioRails
+  class ProcessingError < Error
+    attr_reader :request_url, :code, :details, :body
+    def initialize(request_url, code, details, body)
+      @request_url, @code, @details, @body = request_url, code, details, body
+      super(message) if message
+    end
+    def message; @details.message; end
   end
 end

data/lib/domoscio_rails/http_calls.rb

@@ -1,6 +1,6 @@
 module DomoscioRails
   module HTTPCalls
-    
+
     module Create
       module ClassMethods
         def create(*id, params)
@@ -25,7 +25,7 @@ module DomoscioRails
         base.extend(ClassMethods)
       end
     end
-    
+
     module UpdateSelf
       module ClassMethods
         def update_self(params = {})
@@ -54,7 +54,7 @@ module DomoscioRails
         id_or_filters.is_a?(Hash) ? [nil, id_or_filters] : [id_or_filters, {}]
       end
     end
-    
+
     module Destroy
       module ClassMethods
         def destroy(id = nil, params = {})
@@ -64,21 +64,24 @@ module DomoscioRails
 
       def self.included(base)
         base.extend(ClassMethods)
-      end      
+      end
     end
-    
+
     module Util
       module ClassMethods
         def util(id = nil, util_name = nil, params = {})
           DomoscioRails.request(:get, url(id, util_name), params)
         end
+        def util_post(id = nil, util_name = nil, params = {})
+          DomoscioRails.request(:post, url(id, util_name), params)
+        end
       end
 
       def self.included(base)
         base.extend(ClassMethods)
-      end      
+      end
     end
-    
-    
+
+
   end
-end
+end

data/lib/domoscio_rails/metadata/delta_object.rb

@@ -0,0 +1,6 @@
+module DomoscioRails
+  # A delta object.
+  class DeltaObject < Resource
+    include DomoscioRails::HTTPCalls::Fetch
+  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/utils/alerts_util.rb

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

data/lib/domoscio_rails/utils/recommendation_util.rb

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

data/lib/domoscio_rails/version.rb

@@ -1,3 +1,3 @@
 module DomoscioRails
-  VERSION = "0.2.14"
-end
+  VERSION = "0.3.1"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: domoscio_rails
 version: !ruby/object:Gem::Version
-  version: 0.2.14
+  version: 0.3.1
 platform: ruby
 authors:
 - Benoit Praly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-30 00:00:00.000000000 Z
+date: 2020-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,7 +24,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
-description: Description of DomoscioRails.
+description: Ruby client to interact with Domoscio API.
 email:
 - benoit.praly@domoscio.com
 executables: []
@@ -46,12 +46,12 @@ files:
 - lib/domoscio_rails/adaptative/predictive/objective_student.rb
 - lib/domoscio_rails/adaptative/recommendation.rb
 - lib/domoscio_rails/admin/instance.rb
-- lib/domoscio_rails/admin/user.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/event.rb
 - lib/domoscio_rails/data/knowledge_node_student.rb
+- lib/domoscio_rails/data/learning_session.rb
 - lib/domoscio_rails/data/result.rb
 - lib/domoscio_rails/errors.rb
 - lib/domoscio_rails/http_calls.rb
@@ -59,6 +59,7 @@ files:
 - 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
@@ -67,10 +68,11 @@ files:
 - 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/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
@@ -90,8 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Summary of DomoscioRails.

data/lib/domoscio_rails/admin/user.rb

@@ -1,10 +0,0 @@
-module DomoscioRails
-  # A user of the API.
-  class User < Resource
-    
-    include DomoscioRails::HTTPCalls::Create
-    include DomoscioRails::HTTPCalls::Fetch
-    include DomoscioRails::HTTPCalls::Update
-
-  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