securenative 0.1.16 → 0.1.22

data/lib/{securenative/logger.rb → utils/secure_native_logger.rb}

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'logger'
 
-class Logger
+class SecureNativeLogger
   @logger = Logger.new(STDOUT)
 
-  def self.init_logger(level)
+  def self.init_logger(level = 'DEBUG')
     @logger.level = case level
                     when 'WARN'
                       Logger::WARN
@@ -39,4 +41,4 @@ class Logger
   def self.error(msg)
     @logger.error(msg)
   end
-end
+end

data/lib/{securenative/utils → utils}/signature_utils.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require 'openssl'
 
 class SignatureUtils
-  SIGNATURE_HEADER = 'x-securenative'.freeze
+  SIGNATURE_HEADER = 'x-securenative'
 
   def self.valid_signature?(api_key, payload, header_signature)
     key = api_key.encode('utf-8')
@@ -11,4 +13,4 @@ class SignatureUtils
   rescue StandardError
     false
   end
-end
+end

data/lib/utils/utils.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class Utils
+  def self.null_or_empty?(string)
+    return true if !string || string.empty? || string.nil?
+
+    false
+  end
+end

data/lib/utils/version_utils.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class VersionUtils
+  def self.version
+    begin
+      Gem.loaded_specs['securenative'].version.to_s
+    rescue StandardError
+      'unknown'
+    end
+  end
+end

data/{lib/securenative → out/production/securenative-ruby}/api_manager.rb

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
+
 require 'json'
-require_relative 'logger'
 
 class ApiManager
   def initialize(event_manager, securenative_options)
@@ -8,23 +9,23 @@ class ApiManager
   end
 
   def track(event_options)
-    Logger.debug('Track event call')
+    SecureNativeLogger.debug('Track event call')
     event = SDKEvent.new(event_options, @options)
     @event_manager.send_async(event, ApiRoute::TRACK)
   end
 
   def verify(event_options)
-    Logger.debug('Verify event call')
+    SecureNativeLogger.debug('Verify event call')
     event = SDKEvent.new(event_options, @options)
 
     begin
       res = JSON.parse(@event_manager.send_sync(event, ApiRoute::VERIFY, false))
       return VerifyResult.new(res['riskLevel'], res['score'], res['triggers'])
     rescue StandardError => e
-      Logger.debug('Failed to call verify; {}'.format(e))
+      SecureNativeLogger.debug('Failed to call verify; {}'.format(e))
     end
     return VerifyResult.new(RiskLevel::LOW, 0, nil) if @options.fail_over_strategy == FailOverStrategy::FAIL_OPEN
 
     VerifyResult.new(RiskLevel::HIGH, 1, nil)
   end
-end
+end

data/{lib/securenative → out/production/securenative-ruby}/config/configuration_builder.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+require 'enums/failover_strategy'
+
 class ConfigurationBuilder
   attr_reader :api_key, :api_url, :interval, :max_events, :timeout, :auto_send, :disable, :log_level, :fail_over_strategy
   attr_writer :api_key, :api_url, :interval, :max_events, :timeout, :auto_send, :disable, :log_level, :fail_over_strategy
@@ -17,10 +21,10 @@ class ConfigurationBuilder
   end
 
   def self.default_config_builder
-    ConfigurationBuilder()
+    ConfigurationBuilder.new
   end
 
   def self.default_securenative_options
-    SecureNativeOptions()
+    SecureNativeOptions.new
   end
-end
+end

data/{lib/securenative → out/production/securenative-ruby}/config/configuration_manager.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require 'parseconfig'
 
 class ConfigurationManager
-  DEFAULT_CONFIG_FILE = 'securenative.cfg'.freeze
-  CUSTOM_CONFIG_FILE_ENV_NAME = 'SECURENATIVE_COMFIG_FILE'.freeze
+  DEFAULT_CONFIG_FILE = 'securenative.cfg'
+  CUSTOM_CONFIG_FILE_ENV_NAME = 'SECURENATIVE_COMFIG_FILE'
   @config = nil
 
   def self.read_resource_file(resource_path)
@@ -50,4 +52,4 @@ class ConfigurationManager
                          _get_env_or_default(properties, 'SECURENATIVE_LOG_LEVEL', options.log_level),
                          _get_env_or_default(properties, 'SECURENATIVE_FAILOVER_STRATEGY', options.fail_over_strategy))
   end
-end
+end

data/{lib/securenative → out/production/securenative-ruby}/config/securenative_options.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class SecureNativeOptions
   attr_reader :api_key, :api_url, :interval, :max_events, :timeout, :auto_send, :disable, :log_level, :fail_over_strategy
   attr_writer :api_key, :api_url, :interval, :max_events, :timeout, :auto_send, :disable, :log_level, :fail_over_strategy
@@ -15,4 +17,4 @@ class SecureNativeOptions
     @log_level = log_level
     @fail_over_strategy = fail_over_strategy
   end
-end
+end

data/out/production/securenative-ruby/context/securenative_context.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+class SecureNativeContext
+  attr_reader :client_token, :ip, :remote_ip, :headers, :url, :http_method, :body
+  attr_writer :client_token, :ip, :remote_ip, :headers, :url, :http_method, :body
+
+  def initialize(client_token = nil, ip = nil, remote_ip = nil, headers = nil, url = nil, http_method = nil, body = nil)
+    @client_token = client_token
+    @ip = ip
+    @remote_ip = remote_ip
+    @headers = headers
+    @url = url
+    @http_method = http_method
+    @body = body
+  end
+
+  def self.default_context_builder
+    SecureNativeContext.new
+  end
+
+  def self.from_http_request(request)
+    begin
+      client_token = request.cookies[RequestUtils.SECURENATIVE_COOKIE]
+    rescue StandardError
+      client_token = nil
+    end
+
+    begin
+      headers = request.headers
+    rescue StandardError
+      headers = nil
+    end
+
+    client_token = RequestUtils.get_secure_header_from_request(headers) if Utils.null_or_empty?(client_token)
+
+    SecureNativeContext.new(url: request.url, method: request.http_method, header: headers, client_token: client_token,
+                            client_ip: RequestUtils.get_client_ip_from_request(request),
+                            remote_ip: RequestUtils.get_remote_ip_from_request(request), body: nil)
+  end
+end

data/out/production/securenative-ruby/enums/api_route.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ApiRoute
+  TRACK = 'track'
+  VERIFY = 'verify'
+end

data/out/production/securenative-ruby/enums/event_types.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module EventTypes
+  LOG_IN = 'sn.user.login'
+  LOG_IN_CHALLENGE = 'sn.user.login.challenge'
+  LOG_IN_FAILURE = 'sn.user.login.failure'
+  LOG_OUT = 'sn.user.logout'
+  SIGN_UP = 'sn.user.signup'
+  AUTH_CHALLENGE = 'sn.user.auth.challenge'
+  AUTH_CHALLENGE_SUCCESS = 'sn.user.auth.challenge.success'
+  AUTH_CHALLENGE_FAILURE = 'sn.user.auth.challenge.failure'
+  TWO_FACTOR_DISABLE = 'sn.user.2fa.disable'
+  EMAIL_UPDATE = 'sn.user.email.update'
+  PASSWORD_REST = 'sn.user.password.reset'
+  PASSWORD_REST_SUCCESS = 'sn.user.password.reset.success'
+  PASSWORD_UPDATE = 'sn.user.password.update'
+  PASSWORD_REST_FAILURE = 'sn.user.password.reset.failure'
+  USER_INVITE = 'sn.user.invite'
+  ROLE_UPDATE = 'sn.user.role.update'
+  PROFILE_UPDATE = 'sn.user.profile.update'
+  PAGE_VIEW = 'sn.user.page.view'
+  VERIFY = 'sn.verify'
+end

data/out/production/securenative-ruby/enums/failover_strategy.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module FailOverStrategy
+  FAIL_OPEN = 'fail-open'
+  FAIL_CLOSED = 'fail-closed'
+end

data/out/production/securenative-ruby/enums/risk_level.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RiskLevel
+  LOW = 'low'
+  MEDIUM = 'medium'
+  HIGH = 'high'
+end

data/out/production/securenative-ruby/errors/securenative_config_error.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class SecureNativeConfigError < StandardError
+end

data/out/production/securenative-ruby/errors/securenative_http_error.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class SecureNativeHttpError < StandardError
+end

data/out/production/securenative-ruby/errors/securenative_invalid_options_error.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class SecureNativeInvalidOptionsError < StandardError
+end

data/out/production/securenative-ruby/errors/securenative_invalid_uri_error.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class SecureNativeInvalidUriError < StandardError
+end

data/out/production/securenative-ruby/errors/securenative_parse_error.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class SecureNativeParseError < StandardError
+end

data/out/production/securenative-ruby/errors/securenative_sdk_Illegal_state_error.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class SecureNativeSDKIllegalStateError < StandardError
+end

data/out/production/securenative-ruby/errors/securenative_sdk_error.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class SecureNativeSDKError < StandardError
+end

data/out/production/securenative-ruby/event_manager.rb

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+
+require 'utils/secure_native_logger'
+require 'config/securenative_options'
+require 'http/securenative_http_client'
+require 'errors/securenative_sdk_error'
+
+class QueueItem
+  attr_reader :url, :body, :retry_sending
+  attr_writer :url, :body, :retry_sending
+
+  def initialize(url, body, retry_sending)
+    @url = url
+    @body = body
+    @retry = retry_sending
+  end
+end
+
+class EventManager
+  def initialize(options = SecureNativeOptions.new, http_client = nil)
+    if options.api_key.nil?
+      raise SecureNativeSDKError, 'API key cannot be None, please get your API key from SecureNative console.'
+    end
+
+    @http_client = if http_client.nil?
+                     SecureNativeHttpClient.new(options)
+                   else
+                     http_client
+                   end
+
+    @queue = []
+    @semaphore = Mutex.new
+    @interval = options.interval
+    @options = options
+    @send_enabled = false
+    @attempt = 0
+    @coefficients = [1, 1, 2, 3, 5, 8, 13]
+
+    @thread = Thread.new {run}
+  end
+
+  def send_async(event, resource_path)
+    if @options.disable
+      SecureNativeLogger.warning('SDK is disabled. no operation will be performed')
+      return
+    end
+
+    item = QueueItem(resource_path, JSON.parse(EventManager.serialize(event)), false)
+    @queue.append(item)
+  end
+
+  def flush
+    @queue.each do |item|
+      @http_client.post(item.url, item.body)
+    end
+  end
+
+  def send_sync(event, resource_path, retry_sending)
+    if @options.disable
+      SecureNativeLogger.warning('SDK is disabled. no operation will be performed')
+      return
+    end
+
+    SecureNativeLogger.debug("Attempting to send event #{event}")
+    res = @http_client.post(resource_path, JSON.parse(EventManager.serialize(event)))
+
+    if res.status_code != 200
+      SecureNativeLogger.info('SecureNative failed to call endpoint {} with event {}. adding back to queue'.format(resource_path, event))
+      item = QueueItem(resource_path, JSON.parse(EventManager.serialize(event)), retry_sending)
+      @queue.append(item)
+    end
+
+    res
+  end
+
+  def run
+    loop do
+      @semaphore.synchronize do
+        next unless !@queue.empty? && @send_enabled
+
+        @queue.each do |item|
+          begin
+            res = @http_client.post(item.url, item.body)
+            if res.status_code == 401
+              item.retry_sending = false
+            elsif res.status_code != 200
+              raise SecureNativeHttpError, res.status_code
+            end
+            SecureNativeLogger.debug('Event successfully sent; {}'.format(item.body))
+            return res
+          rescue StandardError => e
+            SecureNativeLogger.error('Failed to send event; {}'.format(e))
+            if item.retry_sending
+              @attempt = 0 if @coefficients.length == @attempt + 1
+
+              back_off = @coefficients[@attempt] * @options.interval
+              SecureNativeLogger.debug('Automatic back-off of {}'.format(back_off))
+              @send_enabled = false
+              sleep back_off
+              @send_enabled = true
+            end
+          end
+        end
+      end
+      sleep @interval / 1000
+    end
+  end
+
+  def start_event_persist
+    SecureNativeLogger.debug('Starting automatic event persistence')
+    if @options.auto_send || @send_enabled
+      @send_enabled = true
+    else
+      SecureNativeLogger.debug('Automatic event persistence is disabled, you should persist events manually')
+    end
+  end
+
+  def stop_event_persist
+    if @send_enabled
+      SecureNativeLogger.debug('Attempting to stop automatic event persistence')
+      begin
+        flush
+        @thread&.stop
+        SecureNativeLogger.debug('Stopped event persistence')
+      rescue StandardError => e
+        SecureNativeLogger.error('Could not stop event scheduler; {}'.format(e))
+      end
+    end
+  end
+
+  def self.serialize(obj)
+    {
+      rid: obj.rid,
+      eventType: obj.event_type,
+      userId: obj.user_id,
+      userTraits: {
+        name: obj.user_traits.name,
+        email: obj.user_traits.email,
+        phone: obj.user_traits.phone,
+        createdAt: obj.user_traits.created_at
+      },
+      request: {
+        cid: obj.request.cid,
+        vid: obj.request.vid,
+        fp: obj.request.fp,
+        ip: obj.request.ip,
+        remoteIp: obj.request.remote_ip,
+        http_method: obj.request.http_method,
+        url: obj.request.url,
+        headers: obj.request.headers
+      },
+      timestamp: obj.timestamp,
+      properties: obj.properties
+    }
+  end
+end

data/out/production/securenative-ruby/event_options.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+class EventOptions
+  MAX_PROPERTIES_SIZE = 10
+
+  def initialize(event_type, user_id, user_traits, user_name, email, phone, created_at, context, properties, timestamp)
+    traits = UserTraits(user_name)
+    if user_name && email && phone && created_at
+      traits = UserTraits(user_name, email, phone, created_at)
+    elsif user_name && email && phone
+      traits = UserTraits(user_name, email, phone)
+    elsif user_name && email
+      traits = UserTraits(user_name, email)
+    end
+
+    @event_options = EventOptions(event_type)
+    @event_options.user_id = user_id
+    @event_options.user_traits = user_traits if user_traits
+    @event_options.user_traits = traits
+    @event_options.context = context
+    @event_options.properties = properties
+    @event_options.timestamp = timestamp
+  end
+
+  def build
+    if !@event_options.properties.nil? && @event_options.properties.length > MAX_PROPERTIES_SIZE
+      raise SecureNativeInvalidOptionsError('You can have only up to {} custom properties', MAX_PROPERTIES_SIZE)
+    end
+
+    @event_options
+  end
+end