castle-rb 6.0.1 → 7.0.0

data/lib/castle/ips/extract.rb

@@ -7,14 +7,16 @@ module Castle
     class Extract
       # ordered list of ip headers for ip extraction
       DEFAULT = %w[X-Forwarded-For Remote-Addr].freeze
+
       # list of header which are used with proxy depth setting
       DEPTH_RELATED = %w[X-Forwarded-For].freeze
 
       private_constant :DEFAULT
 
       # @param headers [Hash]
-      # @param config [Castle::Configuration, Castle::SingletonConfiguration]
-      def initialize(headers, config = Castle.config)
+      # @param config [Castle::Configuration, Castle::SingletonConfiguration, nil]
+      def initialize(headers, config = nil)
+        config ||= Castle.config
         @headers = headers
         @ip_headers = config.ip_headers.empty? ? DEFAULT : config.ip_headers
         @proxies = config.trusted_proxies + Castle::Configuration::TRUSTED_PROXIES

data/lib/castle/logger.rb

@@ -6,9 +6,9 @@ module Castle
     class << self
       # @param message [String]
       # @param data [String]
-      # @param config [Castle::Configuration, Castle::SingletonConfiguration]
-      def call(message, data = nil, config = Castle.config)
-        logger = config.logger
+      # @param config [Castle::Configuration, Castle::SingletonConfiguration, nil]
+      def call(message, data = nil, config = nil)
+        logger = (config || Castle.config).logger
 
         return unless logger
 

data/lib/castle/payload/prepare.rb

@@ -2,7 +2,7 @@
 
 module Castle
   module Payload
-    # this prepare payload based on the request
+    # prepares payload based on the request
     module Prepare
       class << self
         # @param payload_options [Hash]
@@ -12,9 +12,8 @@ module Castle
         def call(payload_options, request, options = {})
           context = Castle::Context::Prepare.call(request, payload_options.merge(options))
 
-          payload = Castle::Utils::DeepSymbolizeKeys.call(
-            payload_options || {}
-          ).merge(context: context)
+          payload =
+            Castle::Utils::DeepSymbolizeKeys.call(payload_options || {}).merge(context: context)
           payload[:timestamp] ||= Castle::Utils::GetTimestamp.call
 
           warn '[DEPRECATION] use user_traits instead of traits key' if payload.key?(:traits)

data/lib/castle/secure_mode.rb

@@ -6,8 +6,9 @@ module Castle
   module SecureMode
     class << self
       # @param user_id [String]
-      # @param config [Castle::Configuration, Castle::SingletonConfiguration]
-      def signature(user_id, config = Castle.config)
+      # @param config [Castle::Configuration, Castle::SingletonConfiguration, nil]
+      def signature(user_id, config = nil)
+        config ||= Castle.config
         OpenSSL::HMAC.hexdigest('sha256', config.api_secret, user_id.to_s)
       end
     end

data/lib/castle/support/hanami.rb

@@ -4,16 +4,12 @@ module Castle
   module Hanami
     module Action
       def castle
-        @castle ||= ::Castle::Client.from_request(request, cookies: (cookies if defined? cookies))
+        @castle ||= ::Castle::Client.from_request(request, cookies: (cookies if defined?(cookies)))
       end
     end
 
     def self.included(base)
-      base.configure do
-        controller.prepare do
-          include Castle::Hanami::Action
-        end
-      end
+      base.configure { controller.prepare { include Castle::Hanami::Action } }
     end
   end
 end

data/lib/castle/support/rails.rb

@@ -7,7 +7,5 @@ module Castle
     end
   end
 
-  ActiveSupport.on_load(:action_controller) do
-    include CastleClient
-  end
+  ActiveSupport.on_load(:action_controller) { include CastleClient }
 end

data/lib/castle/utils/clean_invalid_chars.rb

@@ -9,9 +9,7 @@ module Castle
           when ::String
             arg.encode('UTF-8', invalid: :replace, undef: :replace)
           when ::Hash
-            arg.transform_values do |v|
-              Castle::Utils::CleanInvalidChars.call(v)
-            end
+            arg.transform_values { |v| Castle::Utils::CleanInvalidChars.call(v) }
           when ::Array
             arg.map { |el| Castle::Utils::CleanInvalidChars.call(el) }
           else

data/lib/castle/verdict.rb

@@ -5,8 +5,10 @@ module Castle
   module Verdict
     # allow
     ALLOW = 'allow'
+
     # deny
     DENY = 'deny'
+
     # challenge
     CHALLENGE = 'challenge'
   end

data/lib/castle/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Castle
-  VERSION = '6.0.1'
+  VERSION = '7.0.0'
 end

data/lib/castle/webhooks/verify.rb

@@ -7,9 +7,10 @@ module Castle
       class << self
         # Checks if webhook is valid
         # @param webhook [Request]
-        # @param config [Castle::Configuration, Castle::SingletonConfiguration]
-        def call(webhook, config = Castle.config)
-          expected_signature = compute_signature(webhook, config.api_secret)
+        # @param config [Castle::Configuration, Castle::SingletonConfiguration, nil]
+        def call(webhook, config = nil)
+          config ||= Castle.config
+          expected_signature = compute_signature(webhook, config)
           signature = webhook.env['HTTP_X_CASTLE_SIGNATURE']
           verify_signature(signature, expected_signature)
         end
@@ -18,13 +19,14 @@ module Castle
 
         # Computes a webhook signature using provided user_id
         # @param webhook [Request]
-        # @param api_secret [String]
-        def compute_signature(webhook, api_secret)
+        # @param config [Castle::Configuration, Castle::SingletonConfiguration]
+        # @return [String]
+        def compute_signature(webhook, config)
           Base64.encode64(
             OpenSSL::HMAC.digest(
               OpenSSL::Digest.new('sha256'),
-              api_secret,
-              Castle::Core::ProcessWebhook.call(webhook)
+              config.api_secret,
+              Castle::Core::ProcessWebhook.call(webhook, config)
             )
           ).strip
         end

data/spec/integration/rails/rails_spec.rb

@@ -9,15 +9,20 @@ RSpec.describe HomeController, type: :request do
       {
         'event' => '$login.succeeded',
         'user_id' => '123',
-        'properties' => { 'key' => 'value' },
-        'user_traits' => { 'key' => 'value' },
+        'properties' => {
+          'key' => 'value'
+        },
+        'user_traits' => {
+          'key' => 'value'
+        },
         'timestamp' => now.utc.iso8601(3),
         'sent_at' => now.utc.iso8601(3),
         'context' => {
           'client_id' => '',
           'active' => true,
           'headers' => {
-            'Accept' => 'text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5',
+            'Accept' =>
+              'text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5',
             'Authorization' => true,
             'Content-Length' => '0',
             'Cookie' => true,
@@ -35,10 +40,7 @@ RSpec.describe HomeController, type: :request do
     end
     let(:now) { Time.now }
     let(:headers) do
-      {
-        'HTTP_AUTHORIZATION' => 'Basic 123',
-        'HTTP_X_FORWARDED_FOR' => '5.5.5.5, 1.2.3.4'
-      }
+      { 'HTTP_AUTHORIZATION' => 'Basic 123', 'HTTP_X_FORWARDED_FOR' => '5.5.5.5, 1.2.3.4' }
     end
 
     before do

data/spec/integration/rails/support/home_controller.rb

@@ -22,19 +22,20 @@ class HomeController < ActionController::Base
 
   # prepare payload and calling track with client example
   def index2
-    payload = ::Castle::Payload::Prepare.call(
-      {
-        event: '$login.succeeded',
-        user_id: '123',
-        properties: {
-          key: 'value'
+    payload =
+      ::Castle::Payload::Prepare.call(
+        {
+          event: '$login.succeeded',
+          user_id: '123',
+          properties: {
+            key: 'value'
+          },
+          user_traits: {
+            key: 'value'
+          }
         },
-        user_traits: {
-          key: 'value'
-        }
-      },
-      request
-    )
+        request
+      )
     client = ::Castle::Client.new
     client.track(payload)
 
@@ -43,19 +44,20 @@ class HomeController < ActionController::Base
 
   # prepare payload and calling track with direct API::Track service
   def index3
-    payload = ::Castle::Payload::Prepare.call(
-      {
-        event: '$login.succeeded',
-        user_id: '123',
-        properties: {
-          key: 'value'
+    payload =
+      ::Castle::Payload::Prepare.call(
+        {
+          event: '$login.succeeded',
+          user_id: '123',
+          properties: {
+            key: 'value'
+          },
+          user_traits: {
+            key: 'value'
+          }
         },
-        user_traits: {
-          key: 'value'
-        }
-      },
-      request
-    )
+        request
+      )
     Castle::API::Track.call(payload)
 
     render inline: 'hello'

data/spec/lib/castle/api/approve_device_spec.rb

@@ -2,9 +2,9 @@
 
 describe Castle::API::ApproveDevice do
   before do
-    stub_request(:any, /api.castle.io/).with(
-      basic_auth: ['', 'secret']
-    ).to_return(status: 200, body: '{}', headers: {})
+    stub_request(:any, /api.castle.io/)
+      .with(basic_auth: ['', 'secret'])
+      .to_return(status: 200, body: '{}', headers: {})
   end
 
   describe '.call' do

data/spec/lib/castle/api/authenticate_spec.rb

@@ -30,15 +30,14 @@ describe Castle::API::Authenticate do
 
   describe '.call' do
     let(:request_body) do
-      { event: '$login.succeeded', context: context, user_id: '1234',
-        sent_at: time_auto }
+      { event: '$login.succeeded', context: context, user_id: '1234', sent_at: time_auto }
     end
 
     context 'when used with symbol keys' do
       before do
-        stub_request(:any, /api.castle.io/).with(
-          basic_auth: ['', 'secret']
-        ).to_return(status: 200, body: response_body, headers: {})
+        stub_request(:any, /api.castle.io/)
+          .with(basic_auth: ['', 'secret'])
+          .to_return(status: 200, body: response_body, headers: {})
         call_subject
       end
 
@@ -55,8 +54,13 @@ describe Castle::API::Authenticate do
           { event: '$login.succeeded', user_id: '1234', timestamp: time_user, context: context }
         end
         let(:request_body) do
-          { event: '$login.succeeded', user_id: '1234', context: context,
-            timestamp: time_user, sent_at: time_auto }
+          {
+            event: '$login.succeeded',
+            user_id: '1234',
+            context: context,
+            timestamp: time_user,
+            sent_at: time_auto
+          }
         end
 
         it do
@@ -75,20 +79,14 @@ describe Castle::API::Authenticate do
       context 'when denied without any risk policy' do
         let(:response_body) { deny_response_without_rp.to_json }
         let(:deny_response_without_rp) do
-          {
-            action: 'deny',
-            user_id: '12345',
-            device_token: 'abcdefg1234'
-          }
-        end
-        let(:deny_without_rp_failover_result) do
-          deny_response_without_rp.merge(failover_appendix)
+          { action: 'deny', user_id: '12345', device_token: 'abcdefg1234' }
         end
+        let(:deny_without_rp_failover_result) { deny_response_without_rp.merge(failover_appendix) }
 
         before do
-          stub_request(:any, /api.castle.io/).with(
-            basic_auth: ['', 'secret']
-          ).to_return(status: 200, body: deny_response_without_rp.to_json, headers: {})
+          stub_request(:any, /api.castle.io/)
+            .with(basic_auth: ['', 'secret'])
+            .to_return(status: 200, body: deny_response_without_rp.to_json, headers: {})
           call_subject
         end
 
@@ -116,14 +114,12 @@ describe Castle::API::Authenticate do
           }
         end
         let(:response_body) { deny_response_with_rp.to_json }
-        let(:deny_with_rp_failover_result) do
-          deny_response_with_rp.merge(failover_appendix)
-        end
+        let(:deny_with_rp_failover_result) { deny_response_with_rp.merge(failover_appendix) }
 
         before do
-          stub_request(:any, /api.castle.io/).with(
-            basic_auth: ['', 'secret']
-          ).to_return(status: 200, body: deny_response_with_rp.to_json, headers: {})
+          stub_request(:any, /api.castle.io/)
+            .with(basic_auth: ['', 'secret'])
+            .to_return(status: 200, body: deny_response_with_rp.to_json, headers: {})
           call_subject
         end
 

data/spec/lib/castle/api/end_impersonation_spec.rb

@@ -22,9 +22,9 @@ describe Castle::API::EndImpersonation do
   before do
     Timecop.freeze(time_now)
     stub_const('Castle::VERSION', '2.2.0')
-    stub_request(:any, /api.castle.io/).with(
-      basic_auth: ['', 'secret']
-    ).to_return(status: 200, body: response_body, headers: {})
+    stub_request(:any, /api.castle.io/)
+      .with(basic_auth: ['', 'secret'])
+      .to_return(status: 200, body: response_body, headers: {})
   end
 
   after { Timecop.return }
@@ -32,8 +32,14 @@ describe Castle::API::EndImpersonation do
   describe 'call' do
     let(:impersonator) { 'test@castle.io' }
     let(:request_body) do
-      { user_id: '1234', sent_at: time_auto,
-        properties: { impersonator: impersonator }, context: context }
+      {
+        user_id: '1234',
+        sent_at: time_auto,
+        properties: {
+          impersonator: impersonator
+        },
+        context: context
+      }
     end
     let(:response_body) { { success: true }.to_json }
     let(:options) do

data/spec/lib/castle/api/filter_spec.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+describe Castle::API::Filter do
+  pending
+end

data/spec/lib/castle/api/get_device_spec.rb

@@ -2,9 +2,9 @@
 
 describe Castle::API::GetDevice do
   before do
-    stub_request(:any, /api.castle.io/).with(
-      basic_auth: ['', 'secret']
-    ).to_return(status: 200, body: '{}', headers: {})
+    stub_request(:any, /api.castle.io/)
+      .with(basic_auth: ['', 'secret'])
+      .to_return(status: 200, body: '{}', headers: {})
   end
 
   describe '.call' do

data/spec/lib/castle/api/get_devices_for_user_spec.rb

@@ -2,9 +2,9 @@
 
 describe Castle::API::GetDevicesForUser do
   before do
-    stub_request(:any, /api.castle.io/).with(
-      basic_auth: ['', 'secret']
-    ).to_return(status: 200, body: '{}', headers: {})
+    stub_request(:any, /api.castle.io/)
+      .with(basic_auth: ['', 'secret'])
+      .to_return(status: 200, body: '{}', headers: {})
   end
 
   describe '.call' do

data/spec/lib/castle/api/log_spec.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+describe Castle::API::Log do
+  pending
+end

data/spec/lib/castle/api/report_device_spec.rb

@@ -2,9 +2,9 @@
 
 describe Castle::API::ReportDevice do
   before do
-    stub_request(:any, /api.castle.io/).with(
-      basic_auth: ['', 'secret']
-    ).to_return(status: 200, body: '{}', headers: {})
+    stub_request(:any, /api.castle.io/)
+      .with(basic_auth: ['', 'secret'])
+      .to_return(status: 200, body: '{}', headers: {})
   end
 
   describe '.call' do