domoscio_viz 0.2.0 → 0.2.5a

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '03468c791eacd5b3f47a390530f79cf17e5958f62b4c10e4dbd6ae4f7142210e'
-  data.tar.gz: 97dd49337711f35d774db1b9958524dc6ac9a20f77cda5173723cce4e79061f3
+  metadata.gz: c21fbe0307ea47d6608df642b9a72d6a684d707002aad710369a1deeb6e8b150
+  data.tar.gz: 2e8c0a44e2c64fb0bec2d7b3e38ed8feccd52183e34c17f0100db24d8a23253c
 SHA512:
-  metadata.gz: 6f96faeb12b74a5efe1d32e9e28a6d50763c05c969239114127c4cff14b45da9a6be097bd3596a2aa1976f3ab5601b916891fd423b68d5c2185a3ca4bb997b9f
-  data.tar.gz: 60fce846d350aa913453f5c35de699a26e7bae9cf7379d56b968bee6b1ae433ccf7bc065eb612a450af028738a8d81cca75f7c5e002906e953b5a681bc882931
+  metadata.gz: 31c4a07d614f7228da16b172b166df19bb46559658e3d4b2e1facd74952ff5f610ac536eb411f1b8723104c6628bdf17f99af2966c4dc7ba63f8734e2a14cb75
+  data.tar.gz: ea7ee09cad87f5c02af87783729b71e01c9bcb46ac45666902b89b360a1cf1806ccafccf5651a84e1864f5a40dd9f3ab8d34c072ea754d9e1018af4d25919ccd

data/lib/domoscio_viz.rb

@@ -2,16 +2,13 @@
 require 'net/https'
 require 'cgi/util'
 require 'multi_json'
-
 # helpers
 require 'domoscio_viz/version'
 require 'domoscio_viz/json'
 require 'domoscio_viz/errors'
 require 'domoscio_viz/authorization_token'
-
 # generators
 require 'domoscio_viz/generators/install_generator'
-
 # resources
 require 'domoscio_viz/http_calls'
 require 'domoscio_viz/resource'
@@ -20,28 +17,10 @@ require 'domoscio_viz/chart/chart'
 module DomoscioViz
 
   class Configuration
-    attr_accessor :preproduction, :test, :root_url,
-    :client_id, :client_passphrase,
-    :temp_dir
-
-    def preproduction
-      @preproduction || false
-    end
-       
-    def test
-      @test || false
-    end
+    attr_accessor :root_url, :client_id, :client_passphrase, :temp_dir
 
     def root_url
-      if @preproduction == true
-        if @test == true
-          @root_url || "https://domoscio-viz-engine-preprod.azurewebsites.net"
-        else
-          @root_url || "https://domoscio-viz-engine-v2.azurewebsites.net"
-        end
-      else
-        @root_url || "http://localhost:3002"
-      end
+      @root_url ||= ""
     end
   end
 
@@ -59,40 +38,84 @@ module DomoscioViz
   end
 
   #
-  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?
+  # - +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
+  #
+  # Performs HTTP requests to Adaptive Engine
+  # On token issues, will try once to get a new token then will output a DomoscioViz::ReponseError with details
+  #
+  # Raises DomoscioViz::ResponseError on Adaptive Error Status
+  # Raises DomoscioViz::ProcessingError on Internal Error
+  #
+  def self.request(method, url, params={})
 
-    res = DomoscioViz.send_request(uri, method, params, headers, before_request_proc)
+    store_tokens, headers = request_headers
+    uri = api_uri(url)
 
-     # decode json data
-     begin
-      data = DomoscioViz::JSON.load(res.body.nil? ? '' : res.body)
-      unless (res.kind_of? Net::HTTPClientError) || (res.kind_of? Net::HTTPServerError)
-        DomoscioViz::AuthorizationToken::Manager.storage.store({access_token: res['Accesstoken'], refresh_token: res['Refreshtoken']})
-      end
-    rescue MultiJson::LoadError
-      data = {}
+    response = DomoscioViz.send_request(uri, method, params, headers)
+    return response if response.kind_of? DomoscioViz::ProcessingError
+
+    begin
+      raise_http_failure(uri, response, params)
+      data = DomoscioViz::JSON.load(response.body.nil? ? '' : response.body)
+      DomoscioViz::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, response.body, params)
+    rescue ResponseError => exception
+      data = exception
     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|
+  private
+
+  # This function catches usual Http errors during calls
+  #
+  def self.send_request(uri, method, params, headers)
+    begin
+      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, HTTP::ConnectionError, Errno::ECONNREFUSED, Errno::ECONNRESET, EOFError, Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError => exception
+      ProcessingError.new(uri, 500, exception, response, params)
+    end
+  end
+
+  # 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: 'VisualizationEngine not available'}}, {}, params)
+      else
+        raise ResponseError.new(uri, response.code.to_i,  DomoscioViz::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 = DomoscioViz::JSON.dump(params)
-      before_request_proc.call(req) if before_request_proc
+      req.body = DomoscioRails::JSON.dump(params)
       http.request req
     end
   end
 
-  private
+  # 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)
+    DomoscioViz::AuthorizationToken::Manager.storage.store({access_token: response['Accesstoken'], refresh_token: response['Refreshtoken']})
+    response
+  end
 
   def self.user_agent
     @uname ||= get_uname
-
     {
       bindings_version: DomoscioViz::VERSION,
       lang: 'ruby',
@@ -108,34 +131,48 @@ module DomoscioViz
     '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 = DomoscioViz::AuthorizationToken::Manager.get_token
-
-    if !auth_token.is_a? String
-      headers = {
-        'user_agent' => "#{DomoscioViz.user_agent}",
-        'ClientId' => "#{DomoscioViz.configuration.client_id}",
-        'AccessToken' => "#{auth_token[:access_token]}",
-        'RefreshToken' => "#{auth_token[:refresh_token]}",
-        'Content-Type' => 'application/json'
-      }
-    else
-      headers = {
-        'user_agent' => "#{DomoscioViz.user_agent}",
-        'ClientId' => "#{DomoscioViz.configuration.client_id}",
-        'Authorization' => "Token token=#{DomoscioViz.configuration.client_passphrase}",
-        'Content-Type' => 'application/json'
-      }
+    begin
+      auth_token = DomoscioViz::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' => "#{DomoscioViz.user_agent}",
+      'ClientId' => "#{DomoscioViz.configuration.client_id}",
+      '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' => "#{DomoscioViz.user_agent}",
+      'ClientId' => "#{DomoscioViz.configuration.client_id}",
+      'Authorization' => "Token token=#{DomoscioViz.configuration.client_passphrase}",
+      'Content-Type' => 'application/json'
+    }
   end
 
   DomoscioViz.configure do |c|
-      c.preproduction = false
       c.client_id = nil
       c.client_passphrase = nil
       c.temp_dir = File.expand_path('../tmp', __FILE__)
       FileUtils.mkdir_p(c.temp_dir) unless File.directory?(c.temp_dir)
   end
-
-end
+end

data/lib/domoscio_viz/authorization_token.rb

@@ -1,6 +1,5 @@
 module DomoscioViz
   module AuthorizationToken
-
     class Manager
 
       class << self
@@ -13,9 +12,7 @@ module DomoscioViz
         end
 
         def get_token
-          token = storage.get
-          token = DomoscioViz.configuration.client_passphrase if token.nil?
-          token
+          storage.get
         end
       end
     end
@@ -36,9 +33,7 @@ module DomoscioViz
 
       def initialize(temp_dir = nil)
         @temp_dir = temp_dir || DomoscioViz.configuration.temp_dir
-        if !@temp_dir
-          raise "Path to temporary folder is not defined"
-        end
+        raise "Path to temporary folder is not defined" unless @temp_dir
       end
 
       def get

data/lib/domoscio_viz/errors.rb

@@ -1,24 +1,26 @@
 module DomoscioViz
-
   # 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.
+  # ResponseError from VizEngine
   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 Domoscio_viz
+  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_viz/generators/install_generator.rb

@@ -1,12 +1,10 @@
 require 'rails/generators'
-
 module DomoscioViz
   class InstallGenerator < ::Rails::Generators::Base
     source_root File.expand_path('../templates', __FILE__)
     desc "Generate config file for DomoscioViz configuration"
-
     def install
-        copy_file "install.rb", "config/initializers/domoscio_viz.rb"
+      copy_file "install.rb", "config/initializers/domoscio_viz.rb"
     end
   end
 end

data/lib/domoscio_viz/generators/templates/install.rb

@@ -1,13 +1,6 @@
 DomoscioViz.configure do |c|
-    if Rails.env == "production"
-        c.preproduction = true
-    else
-        c.preproduction = false
-    end
     c.client_id = ENV['DOMOSCIO_ID']
     c.client_passphrase = ENV['DOMOSCIO_PASSWORD']
-
     c.temp_dir = File.expand_path('../tmp', __FILE__)
-
     FileUtils.mkdir_p(c.temp_dir) unless File.directory?(c.temp_dir)
 end

data/lib/domoscio_viz/http_calls.rb

@@ -2,15 +2,10 @@ module DomoscioViz
   module HTTPCalls
     module GetUrl
       module ClassMethods
-        # In order to catch current SocketsTimeoutError that seem to appear when the VizEngine stays Idle for too long
-        # Perform the request a second time if it fails the fisrt time
         def get_url(util_name = nil, params = {})
-          response = DomoscioViz.request(:post, url(util_name), params)
-          response = DomoscioViz.request(:post, url(util_name), params) unless response && response.is_a?(Hash) && response['url'] && response['success'] == true
-          response
+          DomoscioViz.request(:post, url(util_name), params)
         end
       end
-
       def self.included(base)
         base.extend(ClassMethods)
       end      

data/lib/domoscio_viz/resource.rb

@@ -21,4 +21,4 @@ module DomoscioViz
       end
     end
   end
-end
+end

data/lib/domoscio_viz/version.rb

@@ -1,3 +1,3 @@
 module DomoscioViz
-  VERSION = "0.2.0"
-end
+  VERSION = "0.2.5a"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: domoscio_viz
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.5a
 platform: ruby
 authors:
 - Benoit Praly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-04 00:00:00.000000000 Z
+date: 2021-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -44,7 +44,6 @@ files:
 - lib/domoscio_viz/json.rb
 - lib/domoscio_viz/resource.rb
 - lib/domoscio_viz/version.rb
-- lib/tasks/domoscio_rails_tasks.rake
 homepage: http://www.domoscio.com
 licenses:
 - MIT
@@ -60,11 +59,11 @@ 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
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Summary of DomoscioViz.

data/lib/tasks/domoscio_rails_tasks.rake

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