domoscio_viz 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 887c55dd8caa52f79ff7cdb18b53f7ed134b538f0d3783d5f4826bbe99efe0db
-  data.tar.gz: 6229db276d697d67b482d5c6bedf8bf0cd5a236ce3336f73f5187ab4d995af85
+  metadata.gz: 86781580f4a835cfa5ac44fd6bc32933955f484fecbef42222957ea05239bb2e
+  data.tar.gz: 58776787e717e2f6d6527c995a8d1b1865d5d4bc78a6067476b1dc049a9a39b5
 SHA512:
-  metadata.gz: 665710baedb373e38e2cfb5a821f95ce52d5ba80d16de6d56127a8cc90ad1b80cbd9391ae45a377f679f6316bff32623f99e5c1598c1bd4122207d6dae616c4e
-  data.tar.gz: e02a53ce48feffc03b70377f129339dd3e4c7ad43f0b776be02baa67d9d8741ec9fc2544ba19e762d36576f8d2bdd1f2a7eb2a433bb9d69cbfce5fb704ffae79
+  metadata.gz: 4dbb5722a87cb87d27c40809144a88235c87f4ecae0923ba3b7d02274397ce15902fea2e58a09c40ca72603684b57c57c6ff1745b2267dec6b56eae1230cb17a
+  data.tar.gz: 801a9125a3a74fc97c56cb83b01a2d531c5837e928469cdf120ac05d91e056f616725ede57265f73ffd939ffd001bac21e39f0281b6135e1134db766ef4d93e0

data/lib/domoscio_viz.rb

@@ -17,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-v2-preprod.azurewebsites.net"
-        else
-          @root_url || "https://visualization-engine.domoscio.com"
-        end
-      else
-        @root_url || "http://localhost:3002"
-      end
+      @root_url ||= ""
     end
   end
 
@@ -55,50 +37,85 @@ module DomoscioViz
     URI(configuration.root_url + url)
   end
 
-  def self.request(method, url, params={}, filters={}, headers = request_headers, before_request_proc = nil)
-    return false if @disabled
+  #
+  # - +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={})
+
+    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 = DomoscioViz.send_request(uri, method, params, headers, before_request_proc)
-    return res if res.kind_of? DomoscioViz::ProcessingError
+
+    response = DomoscioViz.send_request(uri, method, params, headers)
+    return response if response.kind_of? DomoscioViz::ProcessingError
+
     begin
-      raise_http_failure(uri, res, params)
-      data = DomoscioViz::JSON.load(res.body.nil? ? '' : res.body)
-      DomoscioViz::AuthorizationToken::Manager.storage.store({access_token: res['Accesstoken'], refresh_token: res['Refreshtoken']})
+      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
-      return ProcessingError.new(uri, 500, exception, res.body, params)
+      data = ProcessingError.new(uri, 500, exception, response.body, params)
     rescue ResponseError => exception
-      return exception
+      data = exception
     end
+
     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, HTTP::ConnectionError, Errno::ECONNREFUSED, Errno::ECONNRESET, EOFError, Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError => exception
-      ProcessingError.new(uri, 500, exception, res, params)
+      ProcessingError.new(uri, 500, exception, response, params)
     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: 'VisualizationEngine 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)
+        body = DomoscioViz::JSON.load((response.body.nil? ? '' : response.body), :symbolize_keys => true)
+        raise ResponseError.new(uri, response.code.to_i, body, 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)
+    DomoscioViz::AuthorizationToken::Manager.storage.store({access_token: response['Accesstoken'], refresh_token: response['Refreshtoken']})
+    response
+  end
+
   def self.user_agent
     @uname ||= get_uname
     {
@@ -116,29 +133,45 @@ 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__)

data/lib/domoscio_viz/authorization_token.rb

@@ -12,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
@@ -35,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/generators/templates/install.rb

@@ -1,9 +1,4 @@
 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__)

data/lib/domoscio_viz/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: domoscio_viz
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - Benoit Praly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-18 00:00:00.000000000 Z
+date: 2021-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -63,7 +63,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 DomoscioViz.