Fix namespace

Author: Inbal Tako

Gemfile.lock

@@ -208,7 +208,7 @@ GEM
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
       rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
+    rspec-core (3.9.3)
       rspec-support (~> 3.9.3)
     rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)

README.md

@@ -53,15 +53,15 @@ SecureNative can automatically load your config from *securenative.yml* file or
 require 'securenative'
 
 
-secureative =  SecureNativeSDK.init
+secureative =  SecureNative::Client.init
 ```
 ### Option 2: Initialize via API Key
 
 ```ruby
 require 'securenative'
 
 
-securenative =  SecureNativeSDK.init_with_api_key('YOUR_API_KEY')
+securenative =  SecureNative::Client.init_with_api_key('YOUR_API_KEY')
 ```
 
 ### Option 3: Initialize via ConfigurationBuilder
@@ -70,7 +70,7 @@ require 'securenative'
 
 
 options = SecureNative::Config::ConfigurationBuilder.new(api_key: 'API_KEY', max_events: 10, log_level: 'ERROR')
-SecureNativeSDK.init_with_options(options)                                 
+SecureNative::Client.init_with_options(options)                                 
 ```
 
 ## Getting SecureNative instance
@@ -79,7 +79,7 @@ Once initialized, sdk will create a singleton instance which you can get:
 require 'securenative'
 
 
-secureNative = SecureNativeSDK.instance
+secureNative = SecureNative::Client.instance
 ```
 
 ## Tracking events
@@ -92,7 +92,7 @@ require 'securenative'
 
 
 def track
-    securenative = SecureNativeSDK.instance
+    securenative = SecureNative::Client.instance
     context = SecureNative::Context.new(client_token: 'SECURED_CLIENT_TOKEN', ip: '127.0.0.1',
                                        headers: { 'user-agent' => 'Mozilla: Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.3 Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/43.4' })
 
@@ -113,7 +113,7 @@ require 'securenative'
 
 
 def track(request)
-    securenative = SecureNativeSDK.instance
+    securenative = SecureNative::Client.instance
     context = SecureNative::Context.from_http_request(request)
 
     event_options = SecureNative::EventOptions.new(event: SecureNative::EventTypes::LOG_IN, user_id: '1234', context: context,
@@ -135,7 +135,7 @@ require 'securenative'
 
 
 def verify(request)
-    securenative = SecureNativeSDK.instance
+    securenative = SecureNative::Client.instance
     context = SecureNative::Context.from_http_request(request)
 
     event_options = SecureNative::EventOptions.new(event: SecureNative::EventTypes::LOG_IN, user_id: '1234', context: context,
@@ -158,7 +158,7 @@ require 'securenative'
 
 
 def webhook_endpoint(request)
-    securenative = SecureNativeSDK.instance
+    securenative = SecureNative::Client.instance
 
     # Checks if request is verified
     is_verified = securenative.verify_request_payload(request)
@@ -185,5 +185,5 @@ require 'securenative'
 
 options = SecureNative::Options.new(api_key: 'API_KEY', max_events: 10, log_level: 'ERROR', proxy_headers: ['CF-Connecting-IP'])
 
-SecureNativeSDK.init_with_options(options)
+SecureNative::Client.init_with_options(options)
 ``` 

lib/securenative.rb

@@ -16,9 +16,9 @@
 require 'securenative/utils/utils'
 require 'securenative/utils/log'
 require 'securenative/utils/ip_utils'
-require 'securenative/context/rails_context'
-require 'securenative/context/hanami_context'
-require 'securenative/context/sinatra_context'
+require 'securenative/frameworks/hanami'
+require 'securenative/frameworks/sinatra'
+require 'securenative/frameworks/rails'
 require 'securenative/context'
 require 'securenative/event_options'
 require 'securenative/user_traits'
@@ -34,7 +34,7 @@
 require 'securenative/http_client'
 require 'securenative/event_manager'
 require 'securenative/api_manager'
-require 'securenative/sdk'
+require 'securenative/client'
 require 'securenative/version'
 
 require 'yaml'

lib/securenative/client.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module SecureNative
+  class Client
+    attr_reader :options
+
+    def initialize(options)
+      @securenative = nil
+      if SecureNative::Utils::Utils.null_or_empty?(options.api_key)
+        raise SecureNativeSDKError, 'You must pass your SecureNative api key'
+      end
+
+      @options = options
+      @event_manager = EventManager.new(@options)
+
+      @api_manager = SecureNative::ApiManager.new(@event_manager, @options)
+      SecureNative::Log.init_logger(@options.log_level)
+    end
+
+    def self.init_with_options(options)
+      if @securenative.nil?
+        @securenative = SecureNative::Client.new(options)
+        @securenative
+      else
+        SecureNative::Log.debug('This SDK was already initialized.')
+        raise SecureNativeSDKError, 'This SDK was already initialized.'
+      end
+    end
+
+    def self.init_with_api_key(api_key)
+      if SecureNative::Utils::Utils.null_or_empty?(api_key)
+        raise SecureNativeConfigError, 'You must pass your SecureNative api key'
+      end
+
+      if @securenative.nil?
+        options = SecureNative::Config::ConfigurationBuilder.new(api_key: api_key)
+        @securenative = SecureNative::Client.new(options)
+        @securenative
+      else
+        SecureNative::Log.debug('This SDK was already initialized.')
+        raise SecureNativeSDKError, 'This SDK was already initialized.'
+      end
+    end
+
+    def self.init
+      options = SecureNative::Config::ConfigurationManager.load_config
+      init_with_options(options)
+    end
+
+    def self.instance
+      raise SecureNativeSDKIllegalStateError if @securenative.nil?
+
+      @securenative
+    end
+
+    def track(event_options)
+      @api_manager.track(event_options)
+    end
+
+    def verify(event_options)
+      @api_manager.verify(event_options)
+    end
+
+    def self._flush
+      @securenative = nil
+    end
+
+    def verify_request_payload(request)
+      request_signature = request.header[SignatureUtils.SIGNATURE_HEADER]
+      body = request.body
+
+      SignatureUtils.valid_signature?(@options.api_key, body, request_signature)
+    end
+  end
+end

lib/securenative/context.rb

@@ -18,33 +18,33 @@ def initialize(client_token: '', ip: '', remote_ip: '', headers: nil, url: '', h
     end
 
     def self.default_context_builder
-      Context.new
+      SecureNative::Context.new
     end
 
     def self.from_http_request(request)
-      client_token = SecureNative::FrameWorkContext::RailsContext.get_client_token(request)
-      client_token = SecureNative::FrameWorkContext::SinatraContext.get_client_token(request) if client_token.nil?
-      client_token = SecureNative::FrameWorkContext::HanamiContext.get_client_token(request) if client_token.nil?
+      client_token = SecureNative::Frameworks::Rails.get_client_token(request)
+      client_token = SecureNative::Frameworks::Sinatra.get_client_token(request) if client_token.nil?
+      client_token = SecureNative::Frameworks::Hanami.get_client_token(request) if client_token.nil?
 
       begin
-        headers = SecureNative::FrameWorkContext::RailsContext.get_headers(request)
-        headers = SecureNative::FrameWorkContext::SinatraContext.get_headers(request) if headers.nil?
-        headers = SecureNative::FrameWorkContext::HanamiContext.get_headers(request) if headers.nil?
+        headers = SecureNative::Frameworks::Rails.get_headers(request)
+        headers = SecureNative::Frameworks::Sinatra.get_headers(request) if headers.nil?
+        headers = SecureNative::Frameworks::Hanami.get_headers(request) if headers.nil?
 
         # Standard Ruby request
         headers = request.header.to_hash if headers.nil?
       rescue StandardError
         headers = []
       end
 
-      url = SecureNative::FrameWorkContext::RailsContext.get_url(request)
-      url = SecureNative::FrameWorkContext::SinatraContext.get_url(request) if url.nil?
-      url = SecureNative::FrameWorkContext::HanamiContext.get_url(request) if url.nil?
+      url = SecureNative::Frameworks::Rails.get_url(request)
+      url = SecureNative::Frameworks::Sinatra.get_url(request) if url.nil?
+      url = SecureNative::Frameworks::Hanami.get_url(request) if url.nil?
       url = '' if url.nil?
 
-      method = SecureNative::FrameWorkContext::RailsContext.get_method(request)
-      method = SecureNative::FrameWorkContext::SinatraContext.get_method(request) if method.nil?
-      method = SecureNative::FrameWorkContext::HanamiContext.get_method(request) if method.nil?
+      method = SecureNative::Frameworks::Rails.get_method(request)
+      method = SecureNative::Frameworks::Sinatra.get_method(request) if method.nil?
+      method = SecureNative::Frameworks::Hanami.get_method(request) if method.nil?
       method = '' if method.nil?
 
       begin
@@ -57,9 +57,9 @@ def self.from_http_request(request)
         client_token = SecureNative::Utils::RequestUtils.get_secure_header_from_request(headers)
       end
 
-      Context.new(client_token: client_token, ip: SecureNative::Utils::RequestUtils.get_client_ip_from_request(request),
-                  remote_ip: SecureNative::Utils::RequestUtils.get_remote_ip_from_request(request),
-                  headers: headers, url: url, http_method: method || '', body: body)
+      SecureNative::Context.new(client_token: client_token, ip: SecureNative::Utils::RequestUtils.get_client_ip_from_request(request),
+                     remote_ip: SecureNative::Utils::RequestUtils.get_remote_ip_from_request(request),
+                     headers: headers, url: url, http_method: method || '', body: body)
     end
   end
 end

…b/securenative/context/hanami_context.rb lib/securenative/frameworks/hanami.rblib/securenative/context/hanami_context.rb renamed to lib/securenative/frameworks/hanami.rb lib/securenative/context/hanami_context.rb renamed to lib/securenative/frameworks/hanami.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 module SecureNative
-  module FrameWorkContext
-    class HanamiContext
+  module Frameworks
+    class Hanami
       SECURENATIVE_COOKIE = '_sn'
 
       def self.get_client_token(request)
@@ -36,11 +36,11 @@ def self.get_method(request)
       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']}
+          { 'user-agent' => request.env['HTTP_USER_AGENT'] }
         rescue StandardError
           nil
         end
       end
     end
   end
-end
+end

lib/securenative/context/rails_context.rb lib/securenative/frameworks/rails.rblib/securenative/context/rails_context.rb renamed to lib/securenative/frameworks/rails.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 module SecureNative
-  module FrameWorkContext
-    class RailsContext
+  module Frameworks
+    class Rails
       SECURENATIVE_COOKIE = '_sn'
 
       def self.get_client_token(request)

…/securenative/context/sinatra_context.rb lib/securenative/frameworks/sinatra.rblib/securenative/context/sinatra_context.rb renamed to lib/securenative/frameworks/sinatra.rb lib/securenative/context/sinatra_context.rb renamed to lib/securenative/frameworks/sinatra.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 module SecureNative
-  module FrameWorkContext
-    class SinatraContext
+  module Frameworks
+    class Sinatra
       SECURENATIVE_COOKIE = '_sn'
 
       def self.get_client_token(request)

lib/securenative/sdk.rb

@@ -37,7 +37,7 @@ def initialize(event_options, securenative_options)
     end
 
     def to_s
-      "securenative.context: #{@context}, rid: #{@rid}, event_type: #{@event_type}, user_id: #{@user_id},
+      "context: #{@context}, rid: #{@rid}, event_type: #{@event_type}, user_id: #{@user_id},
     user_traits: #{@user_traits}, request: #{@request}, timestamp: #{@timestamp}, properties: #{@properties}"
     end
   end