securenative 0.1.23 → 0.1.29

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ba285b1ac9a68c9cb1143ab595a4c052636e47b8d4cc39e16821e0582e06a62
-  data.tar.gz: c6295e963d7440c4dc8be4046077cafb4af96311f500fa2220717bf726b0ffba
+  metadata.gz: 1e77f21b6db9cbf2d39a0e135b87e61a56fea0d8658c3d1dee6f122ea1837d7f
+  data.tar.gz: 83cb07f6de364d69fc32b56150904f33c466c814fdc9ed826bee5882953257db
 SHA512:
-  metadata.gz: 7f78c7385e543d75dd106611eb77f71004fcb12d10702ae99a02af27cf3273bd45fcb2d5c7725a7001f143973f1cf2d70c19b3d57e3222d0b7965a40ec343f2c
-  data.tar.gz: fada20df309348b5e74a8886fb5855d51aed1ad4ba2245dd23df60f409b1fd6e3bc11efd829b4b21a2b0fa9cf2dac45c08628f088e49879a09a45853aee52ef7
+  metadata.gz: d00171651e6ce7dfc04986e9a729665a8c1033ee140a4316dbc7f5449c2769a5773ed60cc1097e958aca35973b6450b0c95a74d6b2c3253e0d672acfa76413e1
+  data.tar.gz: 4a4ecc7175d42feacd4b9e46279532f988c133b0d802d032468ebde2078a2b110291a27ebb0753e300c7f36dc1d3209906df027a84e1f65ea6fec7408a637a0f

data/README.md

@@ -53,7 +53,7 @@ SecureNative can automatically load your config from *securenative.yml* file or
 require 'securenative'
 
 
-secureative =  SecureNative.init
+secureative =  SecureNative::Client.init
 ```
 ### Option 2: Initialize via API Key
 
@@ -61,7 +61,7 @@ secureative =  SecureNative.init
 require 'securenative'
 
 
-securenative =  SecureNative.init_with_api_key('YOUR_API_KEY')
+securenative =  SecureNative::Client.init_with_api_key('YOUR_API_KEY')
 ```
 
 ### Option 3: Initialize via ConfigurationBuilder
@@ -69,8 +69,8 @@ securenative =  SecureNative.init_with_api_key('YOUR_API_KEY')
 require 'securenative'
 
 
-options = ConfigurationBuilder.new(api_key: 'API_KEY', max_events: 10, log_level: 'ERROR')
-SecureNative.init_with_options(options)                                 
+options = SecureNative::Config::ConfigurationBuilder.new(api_key: 'API_KEY', max_events: 10, log_level: 'ERROR')
+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 = SecureNative.instance
+secureNative = SecureNative::Client.instance
 ```
 
 ## Tracking events
@@ -89,18 +89,15 @@ instance. Make sure you build event with the EventBuilder:
 
  ```ruby
 require 'securenative'
-require 'models/event_options'
-require 'enums/event_types'
-require 'models/user_traits'
 
 
 def track
-    securenative = SecureNative.instance
-    context = SecureNativeContext.new(client_token: 'SECURED_CLIENT_TOKEN', ip: '127.0.0.1',
+    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' })
     
-    event_options = EventOptions.new(event: EventTypes::LOG_IN, user_id: '1234', context: context,
-                                     user_traits: UserTraits.new(name: 'Your Name', email: 'name@gmail.com', phone: '+1234567890'),
+    event_options = SecureNative::EventOptions.new(event: SecureNative::EventTypes::LOG_IN, user_id: '1234', context: context,
+                                     user_traits: SecureNative::UserTraits.new(name: 'Your Name', email: 'name@gmail.com', phone: '+1234567890'),
                                      properties: { custom_param1: 'CUSTOM_PARAM_VALUE', custom_param2: true, custom_param3: 3 })
     
     securenative.track(event_options)
@@ -109,21 +106,18 @@ def track
 end
  ```
 
-You can also create request context from requests:
+You can also create request securenative.context from requests:
 
 ```ruby
 require 'securenative'
-require 'models/event_options'
-require 'enums/event_types'
-require 'models/user_traits'
 
 
 def track(request)
-    securenative = SecureNative.instance
-    context = SecureNativeContext.from_http_request(request)
+    securenative = SecureNative::Client.instance
+    context = SecureNative::Context.from_http_request(request)
     
-    event_options = EventOptions.new(event: EventTypes::LOG_IN, user_id: '1234', context: context,
-                                     user_traits: UserTraits.new(name: 'Your Name', email: 'name@gmail.com', phone: '+1234567890'),
+    event_options = SecureNative::EventOptions.new(event: SecureNative::EventTypes::LOG_IN, user_id: '1234', context: context,
+                                     user_traits: SecureNative::UserTraits.new(name: 'Your Name', email: 'name@gmail.com', phone: '+1234567890'),
                                      properties: { custom_param1: 'CUSTOM_PARAM_VALUE', custom_param2: true, custom_param3: 3 })
     
     securenative.track(event_options)
@@ -138,17 +132,14 @@ end
 
 ```ruby
 require 'securenative'
-require 'models/event_options'
-require 'enums/event_types'
-require 'models/user_traits'
 
 
 def verify(request)
-    securenative = SecureNative.instance
-    context = SecureNativeContext.from_http_request(request)
+    securenative = SecureNative::Client.instance
+    context = SecureNative::Context.from_http_request(request)
 
-    event_options = EventOptions.new(event: EventTypes::LOG_IN, user_id: '1234', context: context,
-                                         user_traits: UserTraits.new(name: 'Your Name', email: 'name@gmail.com', phone: '+1234567890'),
+    event_options = SecureNative::EventOptions.new(event: SecureNative::EventTypes::LOG_IN, user_id: '1234', context: context,
+                                         user_traits: SecureNative::UserTraits.new(name: 'Your Name', email: 'name@gmail.com', phone: '+1234567890'),
                                          properties: { custom_param1: 'CUSTOM_PARAM_VALUE', custom_param2: true, custom_param3: 3 })
     
     verify_result = securenative.verify(event_options)
@@ -167,9 +158,32 @@ require 'securenative'
 
 
 def webhook_endpoint(request)
-    securenative = SecureNative.instance
+    securenative = SecureNative::Client.instance
     
     # Checks if request is verified
     is_verified = securenative.verify_request_payload(request)
 end
- ```
+ ```
+
+## Extract proxy headers from Cloudflare
+
+You can specify custom header keys to allow extraction of client ip from different providers.
+This example demonstrates the usage of proxy headers for ip extraction from Cloudflare.
+
+### Option 1: Using config file
+```yaml
+SECURENATIVE_API_KEY: dsbe27fh3437r2yd326fg3fdg36f43
+SECURENATIVE_PROXY_HEADERS: ["CF-Connecting-IP"]
+```
+
+Initialize sdk as showed above.
+
+### Options 2: Using ConfigurationBuilder
+
+```ruby
+require 'securenative'
+
+options = SecureNative::Options.new(api_key: 'API_KEY', max_events: 10, log_level: 'ERROR', proxy_headers: ['CF-Connecting-IP'])
+
+SecureNative::Client.init_with_options(options)
+``` 

data/lib/securenative.rb

@@ -1,83 +1,49 @@
 # frozen_string_literal: true
 
-require 'utils/secure_native_logger'
-require 'utils/signature_utils'
-require 'utils/utils'
-require 'errors/securenative_sdk_error'
-require 'errors/securenative_sdk_Illegal_state_error'
-require 'errors/securenative_config_error'
-require 'enums/failover_strategy'
-require 'config/configuration_builder'
-require 'config/configuration_manager'
-require 'event_manager'
-require 'api_manager'
-
-class SecureNative
-  attr_reader :options
-
-  def initialize(options)
-    @securenative = nil
-    raise SecureNativeSDKError, 'You must pass your SecureNative api key' if Utils.null_or_empty?(options.api_key)
-
-    @options = options
-    @event_manager = EventManager.new(@options)
-
-    @event_manager.start_event_persist unless @options.api_url.nil?
-
-    @api_manager = ApiManager.new(@event_manager, @options)
-    SecureNativeLogger.init_logger(@options.log_level)
-  end
-
-  def self.init_with_options(options)
-    if @securenative.nil?
-      @securenative = SecureNative.new(options)
-      @securenative
-    else
-      SecureNativeLogger.debug('This SDK was already initialized.')
-      raise SecureNativeSDKError, 'This SDK was already initialized.'
-    end
-  end
-
-  def self.init_with_api_key(api_key)
-    raise SecureNativeConfigError, 'You must pass your SecureNative api key' if Utils.null_or_empty?(api_key)
-
-    if @securenative.nil?
-      options = ConfigurationBuilder.new(api_key: api_key)
-      @securenative = SecureNative.new(options)
-      @securenative
-    else
-      SecureNativeLogger.debug('This SDK was already initialized.')
-      raise SecureNativeSDKError, 'This SDK was already initialized.'
-    end
-  end
-
-  def self.init
-    options = 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
+require 'securenative/failover_strategy'
+require 'securenative/enums/risk_level'
+require 'securenative/enums/api_route'
+require 'securenative/event_types'
+require 'securenative/enums/risk_level'
+require 'securenative/config/configuration_builder'
+require 'securenative/config/configuration_manager'
+require 'securenative/options'
+require 'securenative/utils/request_utils'
+require 'securenative/utils/version_utils'
+require 'securenative/utils/encryption_utils'
+require 'securenative/utils/signature_utils'
+require 'securenative/utils/date_utils'
+require 'securenative/utils/utils'
+require 'securenative/utils/log'
+require 'securenative/utils/ip_utils'
+require 'securenative/frameworks/hanami'
+require 'securenative/frameworks/sinatra'
+require 'securenative/frameworks/rails'
+require 'securenative/context'
+require 'securenative/event_options'
+require 'securenative/user_traits'
+require 'securenative/request_context'
+require 'securenative/client_token'
+require 'securenative/sdk_event'
+require 'securenative/verify_result'
+require 'securenative/errors/invalid_options_error'
+require 'securenative/errors/sdk_Illegal_state_error'
+require 'securenative/errors/config_error'
+require 'securenative/errors/sdk_error'
+require 'securenative/errors/http_error'
+require 'securenative/http_client'
+require 'securenative/event_manager'
+require 'securenative/api_manager'
+require 'securenative/client'
+require 'securenative/version'
+
+require 'yaml'
+require 'net/http'
+require 'uri'
+require 'json'
+require 'securerandom'
+require 'openssl'
+require 'digest'
+require 'base64'
+require 'resolv'
+require 'logger'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: securenative
 version: !ruby/object:Gem::Version
-  version: 0.1.23
+  version: 0.1.29
 platform: ruby
 authors:
 - SecureNative
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-24 00:00:00.000000000 Z
+date: 2020-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -45,111 +45,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/ci.yml"
-- ".github/workflows/publish.yml"
-- ".github/workflows/test.yml"
-- ".gitignore"
-- ".rakeTasks"
-- ".rspec"
-- Gemfile
-- Gemfile.lock
-- LICENSE
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
-- lib/api_manager.rb
-- lib/config/configuration_builder.rb
-- lib/config/configuration_manager.rb
-- lib/config/securenative_options.rb
-- lib/context/hanami_context.rb
-- lib/context/rails_context.rb
-- lib/context/securenative_context.rb
-- lib/context/sinatra_context.rb
-- lib/enums/api_route.rb
-- lib/enums/event_types.rb
-- lib/enums/failover_strategy.rb
-- lib/enums/risk_level.rb
-- lib/errors/securenative_config_error.rb
-- lib/errors/securenative_http_error.rb
-- lib/errors/securenative_invalid_options_error.rb
-- lib/errors/securenative_invalid_uri_error.rb
-- lib/errors/securenative_parse_error.rb
-- lib/errors/securenative_sdk_Illegal_state_error.rb
-- lib/errors/securenative_sdk_error.rb
-- lib/event_manager.rb
-- lib/http/secure_native_http_response.rb
-- lib/http/securenative_http_client.rb
-- lib/models/client_token.rb
-- lib/models/device.rb
-- lib/models/event_options.rb
-- lib/models/request_context.rb
-- lib/models/request_options.rb
-- lib/models/sdk_event.rb
-- lib/models/user_traits.rb
-- lib/models/verify_result.rb
-- lib/securenative.rb
-- lib/utils/date_utils.rb
-- lib/utils/encryption_utils.rb
-- lib/utils/ip_utils.rb
-- lib/utils/request_utils.rb
-- lib/utils/secure_native_logger.rb
-- lib/utils/signature_utils.rb
-- lib/utils/utils.rb
-- lib/utils/version_utils.rb
-- out/production/securenative-ruby/api_manager.rb
-- out/production/securenative-ruby/config/configuration_builder.rb
-- out/production/securenative-ruby/config/configuration_manager.rb
-- out/production/securenative-ruby/config/securenative_options.rb
-- out/production/securenative-ruby/context/hanami_context.rb
-- out/production/securenative-ruby/context/rails_context.rb
-- out/production/securenative-ruby/context/securenative_context.rb
-- out/production/securenative-ruby/context/sinatra_context.rb
-- out/production/securenative-ruby/enums/api_route.rb
-- out/production/securenative-ruby/enums/event_types.rb
-- out/production/securenative-ruby/enums/failover_strategy.rb
-- out/production/securenative-ruby/enums/risk_level.rb
-- out/production/securenative-ruby/errors/securenative_config_error.rb
-- out/production/securenative-ruby/errors/securenative_http_error.rb
-- out/production/securenative-ruby/errors/securenative_invalid_options_error.rb
-- out/production/securenative-ruby/errors/securenative_invalid_uri_error.rb
-- out/production/securenative-ruby/errors/securenative_parse_error.rb
-- out/production/securenative-ruby/errors/securenative_sdk_Illegal_state_error.rb
-- out/production/securenative-ruby/errors/securenative_sdk_error.rb
-- out/production/securenative-ruby/event_manager.rb
-- out/production/securenative-ruby/http/secure_native_http_response.rb
-- out/production/securenative-ruby/http/securenative_http_client.rb
-- out/production/securenative-ruby/models/client_token.rb
-- out/production/securenative-ruby/models/device.rb
-- out/production/securenative-ruby/models/event_options.rb
-- out/production/securenative-ruby/models/request_context.rb
-- out/production/securenative-ruby/models/request_options.rb
-- out/production/securenative-ruby/models/sdk_event.rb
-- out/production/securenative-ruby/models/user_traits.rb
-- out/production/securenative-ruby/models/verify_result.rb
-- out/production/securenative-ruby/securenative.rb
-- out/production/securenative-ruby/utils/date_utils.rb
-- out/production/securenative-ruby/utils/encryption_utils.rb
-- out/production/securenative-ruby/utils/ip_utils.rb
-- out/production/securenative-ruby/utils/request_utils.rb
-- out/production/securenative-ruby/utils/secure_native_logger.rb
-- out/production/securenative-ruby/utils/signature_utils.rb
-- out/production/securenative-ruby/utils/utils.rb
-- out/production/securenative-ruby/utils/version_utils.rb
-- out/test/securenative-ruby/spec_api_manager.rb
-- out/test/securenative-ruby/spec_context_builder.rb
-- out/test/securenative-ruby/spec_date_utils.rb
-- out/test/securenative-ruby/spec_encryption_utils.rb
-- out/test/securenative-ruby/spec_event_manager.rb
-- out/test/securenative-ruby/spec_helper.rb
-- out/test/securenative-ruby/spec_ip_utils.rb
-- out/test/securenative-ruby/spec_request_utils.rb
-- out/test/securenative-ruby/spec_sdk_event.rb
-- out/test/securenative-ruby/spec_securenative.rb
-- out/test/securenative-ruby/spec_securenative_http_client.rb
-- out/test/securenative-ruby/spec_signature_utils.rb
-- out/test/securenative-ruby/spec_version_util.rb
-- securenative.gemspec
+- lib//securenative.rb
+- spec//spec_helper.rb
 homepage: https://www.securenative.com
 licenses:
 - MIT
@@ -163,15 +61,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: SecureNative SDK for Ruby
-test_files: []
+test_files:
+- spec//spec_helper.rb

data/.github/workflows/ci.yml

@@ -1,49 +0,0 @@
-name: CI
-
-on:
-  pull_request:
-    branches:
-      - master
-      - dev
-      - dev-*
-
-jobs:
-  test:
-    name: CI
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        os: [ubuntu-latest]
-    steps:
-      - uses: actions/checkout@v1
-      - uses: actions/setup-ruby@v1
-        with:
-          ruby-version: 2.6.x
-      - name: Install dependencies
-        run: |
-          gem install bundler
-          bundler install
-      - name: Run tests
-        run: bundle exec rspec spec --pattern **/spec_*.rb
-
-      - name: Notify slack success
-        if: success()
-        env:
-          SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}
-        uses: voxmedia/github-action-slack-notify-build@v1.1.1
-        with:
-          message_id: ${{ steps.slack.outputs.message_id }}
-          channel: github-actions
-          status: SUCCESS
-          color: good
-
-      - name: Notify slack fail
-        if: failure()
-        env:
-          SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}
-        uses: voxmedia/github-action-slack-notify-build@v1.1.1
-        with:
-          message_id: ${{ steps.slack.outputs.message_id }}
-          channel: github-actions
-          status: FAILED
-          color: danger