securenative 0.1.23 → 0.1.24

data/lib/securenative/context/sinatra_context.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module SecureNative
+  class SinatraContext
+    SECURENATIVE_COOKIE = '_sn'
+
+    def self.get_client_token(request)
+      begin
+        request.env[SECURENATIVE_COOKIE]
+      rescue StandardError
+        begin
+          request.cookies[SECURENATIVE_COOKIE]
+        rescue StandardError
+          nil
+        end
+      end
+    end
+
+    def self.get_url(request)
+      begin
+        request.env['REQUEST_URI']
+      rescue StandardError
+        nil
+      end
+    end
+
+    def self.get_method(request)
+      begin
+        request.env['REQUEST_METHOD']
+      rescue StandardError
+        nil
+      end
+    end
+
+    def self.get_headers(request)
+      begin
+        # Note: At the moment we're filtering out everything but user-agent since ruby's payload is way too big
+        {'user-agent' => request.env['HTTP_USER_AGENT']}
+      rescue StandardError
+        nil
+      end
+    end
+  end
+end

data/lib/securenative/enums/api_route.rb

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

data/lib/securenative/enums/event_types.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module SecureNative
+  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
+end

data/lib/securenative/enums/failover_strategy.rb

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

data/lib/securenative/enums/risk_level.rb

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

data/lib/securenative/errors/securenative_config_error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module SecureNative
+  class SecureNativeConfigError < StandardError
+  end
+end

data/lib/securenative/errors/securenative_http_error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module SecureNative
+  class SecureNativeHttpError < StandardError
+  end
+end

data/lib/securenative/errors/securenative_invalid_options_error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module SecureNative
+  class SecureNativeInvalidOptionsError < StandardError
+  end
+end

data/lib/securenative/errors/securenative_invalid_uri_error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module SecureNative
+  class SecureNativeInvalidUriError < StandardError
+  end
+end

data/lib/securenative/errors/securenative_parse_error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module SecureNative
+  class SecureNativeParseError < StandardError
+  end
+end

data/lib/securenative/errors/securenative_sdk_Illegal_state_error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module SecureNative
+  class SecureNativeSDKIllegalStateError < StandardError
+  end
+end

data/lib/securenative/errors/securenative_sdk_error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module SecureNative
+  class SecureNativeSDKError < StandardError
+  end
+end

data/lib/securenative/event_manager.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+require 'securenative/utils/secure_native_logger'
+require 'securenative/config/securenative_options'
+require 'securenative/http/securenative_http_client'
+require 'securenative/errors/securenative_sdk_error'
+require 'securenative/errors/securenative_http_error'
+
+module SecureNative
+  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.new(resource_path, EventManager.serialize(event).to_json, 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, EventManager.serialize(event).to_json)
+
+      if res.nil? || res.code != '200'
+        SecureNativeLogger.info("SecureNative failed to call endpoint #{resource_path} with event #{event}. adding back to queue")
+        item = QueueItem.new(resource_path, EventManager.serialize(event).to_json, 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.code == '401'
+                item.retry_sending = false
+              elsif res.code != '200'
+                raise SecureNativeHttpError, res.status_code
+              end
+              SecureNativeLogger.debug("Event successfully sent; #{item.body}")
+              return res
+            rescue StandardError => e
+              SecureNativeLogger.error("Failed to send event; #{e}")
+              if item.retry_sending
+                @attempt = 0 if @coefficients.length == @attempt + 1
+
+                back_off = @coefficients[@attempt] * @options.interval
+                SecureNativeLogger.debug("Automatic back-off of #{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; #{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,
+              method: obj.request.http_method || '',
+              url: obj.request.url,
+              headers: obj.request.headers
+          },
+          timestamp: obj.timestamp,
+          properties: obj.properties
+      }
+    end
+  end
+end

data/lib/securenative/http/secure_native_http_response.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module SecureNative
+  class SecureNativeHttpResponse
+    attr_reader :ok, :status_code, :body
+    attr_writer :ok, :status_code, :body
+
+    def initialize(ok, status_code, body)
+      @ok = ok
+      @status_code = status_code
+      @body = body
+    end
+  end
+end

data/lib/securenative/http/securenative_http_client.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'uri'
+require 'json'
+require 'securenative/utils/version_utils'
+require 'securenative/utils/secure_native_logger'
+
+module SecureNative
+  class SecureNativeHttpClient
+    AUTHORIZATION_HEADER = 'Authorization'
+    VERSION_HEADER = 'SN-Version'
+    USER_AGENT_HEADER = 'User-Agent'
+    USER_AGENT_HEADER_VALUE = 'SecureNative-ruby'
+    CONTENT_TYPE_HEADER = 'Content-Type'
+    CONTENT_TYPE_HEADER_VALUE = 'application/json'
+
+    def initialize(securenative_options)
+      @options = securenative_options
+    end
+
+    def _headers
+      {
+          CONTENT_TYPE_HEADER => CONTENT_TYPE_HEADER_VALUE,
+          USER_AGENT_HEADER => USER_AGENT_HEADER_VALUE,
+          VERSION_HEADER => VersionUtils.version,
+          AUTHORIZATION_HEADER => @options.api_key
+      }
+    end
+
+    def post(path, body)
+      uri = URI.parse("#{@options.api_url}/#{path}")
+      headers = _headers
+
+      client = Net::HTTP.new(uri.host, uri.port)
+      client.use_ssl = true
+      client.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+      request = Net::HTTP::Post.new(uri.request_uri, headers)
+      request.body = body
+
+      res = nil
+      begin
+        res = client.request(request)
+      rescue StandardError => e
+        SecureNativeLogger.error("Failed to send request; #{e}")
+        return res
+      end
+      res
+    end
+  end
+end

data/lib/securenative/models/client_token.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module SecureNative
+  class ClientToken
+    attr_reader :cid, :vid, :fp
+    attr_writer :cid, :vid, :fp
+
+    def initialize(cid, vid, fp)
+      @cid = cid
+      @vid = vid
+      @fp = fp
+    end
+  end
+end

data/lib/securenative/models/device.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module SecureNative
+  class Device
+    attr_reader :device_id
+    attr_writer :device_id
+
+    def initialize(device_id)
+      @device_id = device_id
+    end
+  end
+end

data/lib/securenative/models/event_options.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'securenative/models/event_options'
+require 'securenative/models/user_traits'
+require 'securenative/errors/securenative_invalid_options_error'
+
+module SecureNative
+  class EventOptions
+    attr_reader :event, :user_id, :user_traits, :context, :properties, :timestamp
+    attr_writer :event, :user_id, :user_traits, :context, :properties, :timestamp
+
+    MAX_PROPERTIES_SIZE = 10
+
+    def initialize(event: nil, user_id: nil, user_traits: nil, user_name: nil, email: nil, phone: nil, created_at: nil, context: nil, properties: nil, timestamp: nil)
+      if !properties.nil? && properties.length > MAX_PROPERTIES_SIZE
+        raise SecureNativeInvalidOptionsError, "You can have only up to #{MAX_PROPERTIES_SIZE} custom properties"
+      end
+
+      if user_traits.nil?
+        if user_name && email && phone && created_at
+          user_traits = UserTraits(user_name, email, phone, created_at)
+        elsif user_name && email && phone
+          user_traits = UserTraits(user_name, email, phone)
+        elsif user_name && email
+          user_traits = UserTraits(user_name, email)
+        else
+          user_traits = UserTraits.new
+        end
+      end
+
+      @event = event
+      @user_id = user_id
+      @user_traits = user_traits
+      @context = context
+      @properties = properties
+      @timestamp = timestamp
+    end
+  end
+end