castle-rb 6.0.1 → 7.0.0

data/lib/castle/commands/approve_device.rb

@@ -9,11 +9,7 @@ module Castle
         # @return [Castle::Command]
         def build(options = {})
           Castle::Validators::Present.call(options, %i[device_token])
-          Castle::Command.new(
-            "devices/#{options[:device_token]}/approve",
-            nil,
-            :put
-          )
+          Castle::Command.new("devices/#{options[:device_token]}/approve", nil, :put)
         end
       end
     end

data/lib/castle/commands/end_impersonation.rb

@@ -19,7 +19,7 @@ module Castle
             :delete
           )
         end
-  end
+      end
     end
   end
 end

data/lib/castle/commands/filter.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Castle
+  module Commands
+    # Generates the payload for the filter request
+    class Filter
+      class << self
+        # @param options [Hash]
+        # @return [Castle::Command]
+        def build(options = {})
+          Castle::Validators::Present.call(options, %i[event])
+          context = Castle::Context::Sanitize.call(options[:context])
+
+          Castle::Command.new(
+            'filter',
+            options.merge(context: context, sent_at: Castle::Utils::GetTimestamp.call),
+            :post
+          )
+        end
+      end
+    end
+  end
+end

data/lib/castle/commands/get_device.rb

@@ -9,11 +9,7 @@ module Castle
         # @return [Castle::Command]
         def build(options = {})
           Castle::Validators::Present.call(options, %i[device_token])
-          Castle::Command.new(
-            "devices/#{options[:device_token]}",
-            nil,
-            :get
-          )
+          Castle::Command.new("devices/#{options[:device_token]}", nil, :get)
         end
       end
     end

data/lib/castle/commands/get_devices_for_user.rb

@@ -9,11 +9,7 @@ module Castle
         # @return [Castle::Command]
         def build(options = {})
           Castle::Validators::Present.call(options, %i[user_id])
-          Castle::Command.new(
-            "users/#{options[:user_id]}/devices",
-            nil,
-            :get
-          )
+          Castle::Command.new("users/#{options[:user_id]}/devices", nil, :get)
         end
       end
     end

data/lib/castle/commands/{identify.rb → log.rb}

@@ -2,16 +2,17 @@
 
 module Castle
   module Commands
-    class Identify
+    # Generates the payload for the log request
+    class Log
       class << self
         # @param options [Hash]
         # @return [Castle::Command]
         def build(options = {})
-          Castle::Validators::NotSupported.call(options, %i[properties])
+          Castle::Validators::Present.call(options, %i[event])
           context = Castle::Context::Sanitize.call(options[:context])
 
           Castle::Command.new(
-            'identify',
+            'log',
             options.merge(context: context, sent_at: Castle::Utils::GetTimestamp.call),
             :post
           )

data/lib/castle/commands/report_device.rb

@@ -9,11 +9,7 @@ module Castle
         # @return [Castle::Command]
         def build(options = {})
           Castle::Validators::Present.call(options, %i[device_token])
-          Castle::Command.new(
-            "devices/#{options[:device_token]}/report",
-            nil,
-            :put
-          )
+          Castle::Command.new("devices/#{options[:device_token]}/report", nil, :put)
         end
       end
     end

data/lib/castle/commands/risk.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Castle
+  module Commands
+    # Generates the payload for the risk request
+    class Risk
+      class << self
+        # @param options [Hash]
+        # @return [Castle::Command]
+        def build(options = {})
+          Castle::Validators::Present.call(options, %i[event])
+          context = Castle::Context::Sanitize.call(options[:context])
+
+          Castle::Command.new(
+            'risk',
+            options.merge(context: context, sent_at: Castle::Utils::GetTimestamp.call),
+            :post
+          )
+        end
+      end
+    end
+  end
+end

data/lib/castle/commands/start_impersonation.rb

@@ -19,7 +19,7 @@ module Castle
             :post
           )
         end
-  end
+      end
     end
   end
 end

data/lib/castle/configuration.rb

@@ -8,15 +8,18 @@ module Castle
     # API endpoint
     BASE_URL = 'https://api.castle.io/v1'
     REQUEST_TIMEOUT = 1000 # in milliseconds
+
     # regexp of trusted proxies which is always appended to the trusted proxy list
-    TRUSTED_PROXIES = [/
+    TRUSTED_PROXIES = [
+      /
       \A127\.0\.0\.1\Z|
       \A(10|172\.(1[6-9]|2[0-9]|30|31)|192\.168)\.|
       \A::1\Z|\Afd[0-9a-f]{2}:.+|
       \Alocalhost\Z|
       \Aunix\Z|
       \Aunix:
-    /ix].freeze
+    /ix
+    ].freeze
 
     # @note this value is not assigned as we don't recommend using a allowlist. If you need to use
     #   one, this constant is provided as a good default.
@@ -47,8 +50,14 @@ module Castle
     ].freeze
 
     attr_accessor :request_timeout, :trust_proxy_chain, :logger
-    attr_reader :api_secret, :allowlisted, :denylisted, :failover_strategy, :ip_headers,
-                :trusted_proxies, :trusted_proxy_depth, :base_url
+    attr_reader :api_secret,
+                :allowlisted,
+                :denylisted,
+                :failover_strategy,
+                :ip_headers,
+                :trusted_proxies,
+                :trusted_proxy_depth,
+                :base_url
 
     def initialize
       @header_format = Castle::Headers::Format
@@ -96,7 +105,9 @@ module Castle
     # sets trusted proxies
     # @param value [Array<String,Regexp>]
     def trusted_proxies=(value)
-      raise Castle::ConfigurationError, 'trusted proxies must be an Array' unless value.is_a?(Array)
+      unless value.is_a?(Array)
+        raise Castle::ConfigurationError, 'trusted proxies must be an Array'
+      end
 
       @trusted_proxies = value
     end
@@ -111,9 +122,8 @@ module Castle
     end
 
     def failover_strategy=(value)
-      @failover_strategy = Castle::Failover::STRATEGIES.detect do |strategy|
-        strategy == value.to_sym
-      end
+      @failover_strategy =
+        Castle::Failover::STRATEGIES.detect { |strategy| strategy == value.to_sym }
       raise Castle::ConfigurationError, 'unrecognized failover strategy' if @failover_strategy.nil?
     end
 

data/lib/castle/core/get_connection.rb

@@ -8,7 +8,9 @@ module Castle
 
       class << self
         # @param config [Castle::Configuration, Castle::SingletonConfiguration]
-        def call(config = Castle.config)
+        # @return [Net::HTTP]
+        def call(config = nil)
+          config ||= Castle.config
           http = Net::HTTP.new(config.base_url.host, config.base_url.port)
           http.read_timeout = config.request_timeout / 1000.0
 

data/lib/castle/core/process_response.rb

@@ -14,10 +14,13 @@ module Castle
       }.freeze
 
       class << self
-        def call(response)
+        # @param response [Response]
+        # @param config [Castle::Configuration, Castle::SingletonConfiguration, nil]
+        # @return [Hash]
+        def call(response, config = nil)
           verify!(response)
 
-          Castle::Logger.call('response:', response.body.to_s)
+          Castle::Logger.call('response:', response.body.to_s, config)
 
           return {} if response.body.nil? || response.body.empty?
 

data/lib/castle/core/process_webhook.rb

@@ -7,12 +7,17 @@ module Castle
       class << self
         # Checks if webhook is valid
         # @param webhook [Request]
-        def call(webhook)
-          webhook.body.read.tap do |result|
-            raise Castle::ApiError, 'Invalid webhook from Castle API' if result.blank?
+        # @param config [Castle::Configuration, Castle::SingletonConfiguration, nil]
+        # @return [String]
+        def call(webhook, config = nil)
+          webhook
+            .body
+            .read
+            .tap do |result|
+              raise Castle::ApiError, 'Invalid webhook from Castle API' if result.blank?
 
-            Castle::Logger.call('webhook:', result.to_s)
-          end
+              Castle::Logger.call('webhook:', result.to_s, config)
+            end
         end
       end
     end

data/lib/castle/core/send_request.rb

@@ -5,9 +5,7 @@ module Castle
     # this class is responsible for making requests to api
     module SendRequest
       # Default headers that we add to passed ones
-      DEFAULT_HEADERS = {
-        'Content-Type' => 'application/json'
-      }.freeze
+      DEFAULT_HEADERS = { 'Content-Type' => 'application/json' }.freeze
 
       private_constant :DEFAULT_HEADERS
 
@@ -15,31 +13,25 @@ module Castle
         # @param command [String]
         # @param headers [Hash]
         # @param http [Net::HTTP]
-        # @param config [Castle::Configuration, Castle::SingletonConfiguration]
-        def call(command, headers, http = nil, config = Castle.config)
+        # @param config [Castle::Configuration, Castle::SingletonConfiguration, nil]
+        def call(command, headers, http = nil, config = nil)
           (http || Castle::Core::GetConnection.call).request(
-            build(
-              command,
-              headers.merge(DEFAULT_HEADERS),
-              config
-            )
+            build(command, headers.merge(DEFAULT_HEADERS), config)
           )
         end
 
         # @param command [String]
         # @param headers [Hash]
-        # @param config [Castle::Configuration, Castle::SingletonConfiguration]
-        def build(command, headers, config = Castle.config)
+        # @param config [Castle::Configuration, Castle::SingletonConfiguration, nil]
+        def build(command, headers, config)
           url = "#{config.base_url.path}/#{command.path}"
           request_obj = Net::HTTP.const_get(command.method.to_s.capitalize).new(url, headers)
 
           unless command.method == :get
-            request_obj.body = ::Castle::Utils::CleanInvalidChars.call(
-              command.data
-            ).to_json
+            request_obj.body = ::Castle::Utils::CleanInvalidChars.call(command.data).to_json
           end
 
-          Castle::Logger.call("#{url}:", request_obj.body)
+          Castle::Logger.call("#{url}:", request_obj.body, config)
 
           request_obj.basic_auth('', config.api_secret)
           request_obj

data/lib/castle/errors.rb

@@ -2,7 +2,9 @@
 
 module Castle
   # general error
-  class Error < RuntimeError; end
+  class Error < RuntimeError
+  end
+
   # Raised when anything is wrong with the request (any unhappy path)
   # This error indicates that either we would wait too long for a response or something
   # else happened somewhere in the middle and we weren't able to get the results
@@ -14,30 +16,52 @@ module Castle
       @reason = reason
     end
   end
+
   # security error
-  class SecurityError < Castle::Error; end
+  class SecurityError < Castle::Error
+  end
+
   # wrong configuration error
-  class ConfigurationError < Castle::Error; end
+  class ConfigurationError < Castle::Error
+  end
+
   # error returned by api
-  class ApiError < Castle::Error; end
+  class ApiError < Castle::Error
+  end
+
   # webhook signature verification error
-  class WebhookVerificationError < Castle::Error; end
+  class WebhookVerificationError < Castle::Error
+  end
 
   # api error bad request 400
-  class BadRequestError < Castle::ApiError; end
+  class BadRequestError < Castle::ApiError
+  end
+
   # api error forbidden 403
-  class ForbiddenError < Castle::ApiError; end
+  class ForbiddenError < Castle::ApiError
+  end
+
   # api error not found 404
-  class NotFoundError < Castle::ApiError; end
+  class NotFoundError < Castle::ApiError
+  end
+
   # api error user unauthorized 419
-  class UserUnauthorizedError < Castle::ApiError; end
+  class UserUnauthorizedError < Castle::ApiError
+  end
+
   # api error invalid param 422
-  class InvalidParametersError < Castle::ApiError; end
+  class InvalidParametersError < Castle::ApiError
+  end
+
   # api error unauthorized 401
-  class UnauthorizedError < Castle::ApiError; end
+  class UnauthorizedError < Castle::ApiError
+  end
+
   # all internal server errors
-  class InternalServerError < Castle::ApiError; end
+  class InternalServerError < Castle::ApiError
+  end
 
   # impersonation command failed
-  class ImpersonationFailed < Castle::ApiError; end
+  class ImpersonationFailed < Castle::ApiError
+  end
 end

data/lib/castle/failover/prepare_response.rb

@@ -4,19 +4,14 @@ module Castle
   module Failover
     # generate failover authentication response
     class PrepareResponse
-      def initialize(user_id, reason:, strategy: Castle.config.failover_strategy)
+      def initialize(user_id, reason:, strategy:)
         @strategy = strategy
         @reason = reason
         @user_id = user_id
       end
 
       def call
-        {
-          action: @strategy.to_s,
-          user_id: @user_id,
-          failover: true,
-          failover_reason: @reason
-        }
+        { action: @strategy.to_s, user_id: @user_id, failover: true, failover_reason: @reason }
       end
     end
   end

data/lib/castle/failover/strategy.rb

@@ -6,10 +6,13 @@ module Castle
     module Strategy
       # allow
       ALLOW = :allow
+
       # deny
       DENY = :deny
+
       # challenge
       CHALLENGE = :challenge
+
       # throw an error
       THROW = :throw
     end

data/lib/castle/headers/extract.rb

@@ -13,11 +13,11 @@ module Castle
       private_constant :ALWAYS_ALLOWLISTED, :ALWAYS_DENYLISTED
 
       # @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)
         @headers = headers
-        @config = config
-        @no_allowlist = config.allowlisted.empty?
+        @config = config || Castle.config
+        @no_allowlist = @config.allowlisted.empty?
       end
 
       # Serialize HTTP headers

data/lib/castle/headers/filter.rb

@@ -12,7 +12,8 @@ module Castle
       HTTP(?:_|-).*|
         CONTENT(?:_|-)LENGTH|
       REMOTE(?:_|-)ADDR
-      $/xi.freeze
+      $/xi
+        .freeze
 
       private_constant :VALUABLE_HEADERS
 
@@ -25,12 +26,14 @@ module Castle
       # Serialize HTTP headers
       # @return [Hash]
       def call
-        @request_env.keys.each_with_object({}) do |header_name, acc|
-          next unless header_name.match(VALUABLE_HEADERS)
+        @request_env
+          .keys
+          .each_with_object({}) do |header_name, acc|
+            next unless header_name.match(VALUABLE_HEADERS)
 
-          formatted_name = @header_format.call(header_name)
-          acc[formatted_name] = @request_env[header_name]
-        end
+            formatted_name = @header_format.call(header_name)
+            acc[formatted_name] = @request_env[header_name]
+          end
       end
     end
   end