castle-rb 6.0.1 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 538dcb5ae34bd3c453ccc2627f351bacb167d46bccb6698dbc90a6c71179a824
-  data.tar.gz: 87e1156703a21a88d9a1bb4990303720ab7577aedb190b580672f6d7456066d9
+  metadata.gz: ab35253e5571890b82e8fd555d8342c1c9713d35d3cf83354c19cccc030c6683
+  data.tar.gz: 9ead0508cede4ddccaa4e58ad8c60e0a76b2f6496279eaccec99419a172af326
 SHA512:
-  metadata.gz: c126df845b56433ad362acea73516b8022757e546a504d2cd5ff79a3c5fea4d20cffe8dd7577cc224edaeca72b8d1f0d1da88c9996fff2cee1f9e9180b26a95d
-  data.tar.gz: 4c3990829af576a0a9162018007446aeb29d7483526f1fd358ac798e5c8b382ba091dc75983da2e956f829c66e1b0311bfe0cd81db2f0ae6a2e892d641b14194
+  metadata.gz: 33f0642e24430268723c3c960b8a214646b76c3693d088b3fc2d37c4fc9ccd41f4a3b4e295ab73b8e7530184d8b35f83b38918d1b588050b33238cdbbd9e64e0
+  data.tar.gz: 4518be516263d115b2e55e2ca058aeb5a727dbb1e82343b52bec9a93a3b589457499a51512a914675c80514222ded34f15d66e741327fa6deb1f7be09feac334

data/README.md

@@ -159,7 +159,7 @@ The client will automatically configure the context for each request.
 If you need to modify the event context properties or if you desire to add additional properties such as user traits to the context, you can pass the properties along with the other data. For example:
 ```ruby
 {
-  event: ::Castle::Events::LOGIN_SUCCEEDED,
+  event: '$login.succeeded',
   user_id: user.id,
   properties: {
     key: 'value'
@@ -180,7 +180,7 @@ Here is a simple example of a track event.
 ```ruby
 begin
   castle.track(
-    event: ::Castle::Events::LOGIN_SUCCEEDED,
+    event: '$login.succeeded',
     user_id: user.id
   )
 rescue Castle::Error => e
@@ -213,7 +213,7 @@ end
 ```ruby
 payload = ::Castle::Payload::Prepare.call(
   {
-    event: ::Castle::Events::LOGIN_SUCCEEDED,
+    event: '$login.succeeded',
     user_id: user.id,
     properties: {
       key: 'value'
@@ -234,12 +234,12 @@ If you want to reuse the connection to send multiple events:
 ```ruby
 Castle::Session.call do |http|
   castle.track(
-    event: ::Castle::Events::LOGOUT_SUCCEEDED,
+    event: '$logout.succeeded',
     user_id: user2.id
     http: http
   )
   castle.track(
-    event: ::Castle::Events::LOGIN_SUCCEEDED,
+    event: '$login.succeeded',
     user_id: user1.id
     http: http
   )
@@ -248,11 +248,11 @@ end
 
 ## Events
 
-List of Recognized Events can be found [here](https://github.com/castle/castle-ruby/tree/master/lib/castle/events.rb) or in the [docs](https://docs.castle.io/api_reference/#list-of-recognized-events)
+List of Recognized Events can be found in the [docs](https://docs.castle.io/v1/reference/events/)
 
 ## Device management
 
-This SDK allows issuing requests to [Castle's Device Management Endpoints](https://docs.castle.io/device_management_tool/). Use these endpoints for admin-level management of end-user devices (i.e., for an internal dashboard).
+This SDK allows issuing requests to [Castle's Device Management Endpoints](https://docs.castle.io/v1/reference/api-reference/#devices). Use these endpoints for admin-level management of end-user devices (i.e., for an internal dashboard).
 
 Fetching device data, approving a device, reporting a device requires a valid `device_token`.
 
@@ -305,4 +305,4 @@ Castle uses webhooks to notify about `$incident.confirmed` or `$review.opened` e
 
 ## Documentation
 
-[Official Castle docs](https://castle.io/docs)
+[Official Castle docs](https://docs.castle.io/)

data/lib/castle.rb

@@ -1,16 +1,10 @@
 # frozen_string_literal: true
 
-%w[
-  openssl
-  net/http
-  json
-  time
-].each(&method(:require))
+%w[openssl net/http json time].each(&method(:require))
 
 %w[
   castle/version
   castle/verdict
-  castle/events
   castle/errors
   castle/command
   castle/utils/deep_symbolize_keys
@@ -29,21 +23,23 @@
   castle/commands/approve_device
   castle/commands/authenticate
   castle/commands/end_impersonation
+  castle/commands/filter
   castle/commands/get_device
   castle/commands/get_devices_for_user
-  castle/commands/identify
+  castle/commands/log
   castle/commands/report_device
-  castle/commands/review
+  castle/commands/risk
   castle/commands/start_impersonation
   castle/commands/track
   castle/api/approve_device
   castle/api/authenticate
   castle/api/end_impersonation
+  castle/api/filter
   castle/api/get_device
   castle/api/get_devices_for_user
-  castle/api/identify
+  castle/api/log
   castle/api/report_device
-  castle/api/review
+  castle/api/risk
   castle/api/start_impersonation
   castle/api/track
   castle/payload/prepare

data/lib/castle/api.rb

@@ -20,12 +20,10 @@ module Castle
       # @param command [String]
       # @param headers [Hash]
       # @param http [Net::HTTP]
-      # @param config [Castle::Configuration, Castle::SingletonConfiguration]
+      # @param config [Castle::Configuration, Castle::SingletonConfiguration, nil]
       # @return [Hash]
-      def call(command, headers = {}, http = nil, config = Castle.config)
-        Castle::Core::ProcessResponse.call(
-          send_request(command, headers, http, config)
-        )
+      def call(command, headers = {}, http = nil, config = nil)
+        Castle::Core::ProcessResponse.call(send_request(command, headers, http, config), config)
       end
 
       private
@@ -34,16 +32,13 @@ module Castle
       # @param headers [Hash]
       # @param http [Net::HTTP]
       # @param config [Castle::Configuration, Castle::SingletonConfiguration]
-      def send_request(command, headers = {}, http = nil, config = Castle.config)
+      def send_request(command, headers = {}, http = nil, config = nil)
+        config ||= Castle.config
+
         raise Castle::ConfigurationError, 'configuration is not valid' unless config.valid?
 
         begin
-          Castle::Core::SendRequest.call(
-            command,
-            headers,
-            http,
-            config
-          )
+          Castle::Core::SendRequest.call(command, headers, http, config)
         rescue *HANDLED_ERRORS => e
           # @note We need to initialize the error, as the original error is a cause for this
           # custom exception. If we would do it the default Ruby way, the original error

data/lib/castle/api/approve_device.rb

@@ -12,12 +12,7 @@ module Castle
           http = options.delete(:http)
           config = options.delete(:config) || Castle.config
 
-          Castle::API.call(
-            Castle::Commands::ApproveDevice.build(options),
-            {},
-            http,
-            config
-          )
+          Castle::API.call(Castle::Commands::ApproveDevice.build(options), {}, http, config)
         end
       end
     end

data/lib/castle/api/authenticate.rb

@@ -14,16 +14,19 @@ module Castle
           http = options.delete(:http)
           config = options.delete(:config) || Castle.config
 
-          response = Castle::API.call(
-            Castle::Commands::Authenticate.build(options),
-            {},
-            http,
-            config
-          )
+          response =
+            Castle::API.call(Castle::Commands::Authenticate.build(options), {}, http, config)
           response.merge(failover: false, failover_reason: nil)
         rescue Castle::RequestError, Castle::InternalServerError => e
           unless config.failover_strategy == :throw
-            return Castle::Failover::PrepareResponse.new(options[:user_id], reason: e.to_s).call
+            strategy = (config || Castle.config).failover_strategy
+            return(
+              Castle::Failover::PrepareResponse.new(
+                options[:user_id],
+                reason: e.to_s,
+                strategy: strategy
+              ).call
+            )
           end
 
           raise e

data/lib/castle/api/end_impersonation.rb

@@ -14,14 +14,9 @@ module Castle
           http = options.delete(:http)
           config = options.delete(:config) || Castle.config
 
-          Castle::API.call(
-            Castle::Commands::EndImpersonation.build(options),
-            {},
-            http,
-            config
-          ).tap do |response|
-            raise Castle::ImpersonationFailed unless response[:success]
-          end
+          Castle::API
+            .call(Castle::Commands::EndImpersonation.build(options), {}, http, config)
+            .tap { |response| raise Castle::ImpersonationFailed unless response[:success] }
         end
       end
     end

data/lib/castle/api/filter.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Castle
+  module API
+    # Module for filter endpoint
+    module Filter
+      class << self
+        # @param options [Hash]
+        # return [Hash]
+        def call(options = {})
+          unless options[:no_symbolize]
+            options = Castle::Utils::DeepSymbolizeKeys.call(options || {})
+          end
+          options.delete(:no_symbolize)
+          http = options.delete(:http)
+          config = options.delete(:config) || Castle.config
+
+          response = Castle::API.call(Castle::Commands::Filter.build(options), {}, http, config)
+          response.merge(failover: false, failover_reason: nil)
+        rescue Castle::RequestError, Castle::InternalServerError => e
+          unless config.failover_strategy == :throw
+            strategy = (config || Castle.config).failover_strategy
+            return(
+              Castle::Failover::PrepareResponse.new(
+                options[:user][:id],
+                reason: e.to_s,
+                strategy: strategy
+              ).call
+            )
+          end
+
+          raise e
+        end
+      end
+    end
+  end
+end

data/lib/castle/api/get_device.rb

@@ -12,12 +12,7 @@ module Castle
           http = options.delete(:http)
           config = options.delete(:config) || Castle.config
 
-          Castle::API.call(
-            Castle::Commands::GetDevice.build(options),
-            {},
-            http,
-            config
-          )
+          Castle::API.call(Castle::Commands::GetDevice.build(options), {}, http, config)
         end
       end
     end

data/lib/castle/api/get_devices_for_user.rb

@@ -12,12 +12,7 @@ module Castle
           http = options.delete(:http)
           config = options.delete(:config) || Castle.config
 
-          Castle::API.call(
-            Castle::Commands::GetDevicesForUser.build(options),
-            {},
-            http,
-            config
-          )
+          Castle::API.call(Castle::Commands::GetDevicesForUser.build(options), {}, http, config)
         end
       end
     end

data/lib/castle/api/log.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Castle
+  module API
+    # Module for log endpoint
+    module Log
+      class << self
+        # @param options [Hash]
+        # return [Hash]
+        def call(options = {})
+          unless options[:no_symbolize]
+            options = Castle::Utils::DeepSymbolizeKeys.call(options || {})
+          end
+          options.delete(:no_symbolize)
+          http = options.delete(:http)
+          config = options.delete(:config) || Castle.config
+
+          response = Castle::API.call(Castle::Commands::Log.build(options), {}, http, config)
+          response.merge(failover: false, failover_reason: nil)
+        rescue Castle::RequestError, Castle::InternalServerError => e
+          unless config.failover_strategy == :throw
+            strategy = (config || Castle.config).failover_strategy
+            return(
+              Castle::Failover::PrepareResponse.new(
+                options[:user][:id],
+                reason: e.to_s,
+                strategy: strategy
+              ).call
+            )
+          end
+
+          raise e
+        end
+      end
+    end
+  end
+end

data/lib/castle/api/report_device.rb

@@ -12,12 +12,7 @@ module Castle
           http = options.delete(:http)
           config = options.delete(:config) || Castle.config
 
-          Castle::API.call(
-            Castle::Commands::ReportDevice.build(options),
-            {},
-            http,
-            config
-          )
+          Castle::API.call(Castle::Commands::ReportDevice.build(options), {}, http, config)
         end
       end
     end

data/lib/castle/api/risk.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Castle
+  module API
+    # Module for risk endpoint
+    module Risk
+      class << self
+        # @param options [Hash]
+        # return [Hash]
+        def call(options = {})
+          unless options[:no_symbolize]
+            options = Castle::Utils::DeepSymbolizeKeys.call(options || {})
+          end
+          options.delete(:no_symbolize)
+          http = options.delete(:http)
+          config = options.delete(:config) || Castle.config
+
+          response = Castle::API.call(Castle::Commands::Risk.build(options), {}, http, config)
+          response.merge(failover: false, failover_reason: nil)
+        rescue Castle::RequestError, Castle::InternalServerError => e
+          unless config.failover_strategy == :throw
+            strategy = (config || Castle.config).failover_strategy
+            return(
+              Castle::Failover::PrepareResponse.new(
+                options[:user][:id],
+                reason: e.to_s,
+                strategy: strategy
+              ).call
+            )
+          end
+
+          raise e
+        end
+      end
+    end
+  end
+end

data/lib/castle/api/start_impersonation.rb

@@ -14,14 +14,9 @@ module Castle
           http = options.delete(:http)
           config = options.delete(:config) || Castle.config
 
-          Castle::API.call(
-            Castle::Commands::StartImpersonation.build(options),
-            {},
-            http,
-            config
-          ).tap do |response|
-            raise Castle::ImpersonationFailed unless response[:success]
-          end
+          Castle::API
+            .call(Castle::Commands::StartImpersonation.build(options), {}, http, config)
+            .tap { |response| raise Castle::ImpersonationFailed unless response[:success] }
         end
       end
     end

data/lib/castle/api/track.rb

@@ -13,12 +13,7 @@ module Castle
           http = options.delete(:http)
           config = options.delete(:config) || Castle.config
 
-          Castle::API.call(
-            Castle::Commands::Track.build(options),
-            {},
-            http,
-            config
-          )
+          Castle::API.call(Castle::Commands::Track.build(options), {}, http, config)
         end
       end
     end

data/lib/castle/client.rb

@@ -1,12 +1,11 @@
 # frozen_string_literal: true
 
 module Castle
+  # Castle's client.
   class Client
     class << self
       def from_request(request, options = {})
-        new(
-          options.merge(context: Castle::Context::Prepare.call(request, options))
-        )
+        new(options.merge(context: Castle::Context::Prepare.call(request, options)))
       end
     end
 
@@ -34,7 +33,7 @@ module Castle
     end
 
     # @param options [Hash]
-    def identify(options = {})
+    def track(options = {})
       options = Castle::Utils::DeepSymbolizeKeys.call(options || {})
 
       return unless tracked?
@@ -43,49 +42,68 @@ module Castle
 
       new_context = Castle::Context::Merge.call(@context, options[:context])
 
-      Castle::API::Identify.call(options.merge(context: new_context, no_symbolize: true))
+      Castle::API::Track.call(options.merge(context: new_context, no_symbolize: true))
     end
 
     # @param options [Hash]
-    def track(options = {})
+    def filter(options = {})
       options = Castle::Utils::DeepSymbolizeKeys.call(options || {})
 
-      return unless tracked?
+      return generate_do_not_track_response(options[:user][:id]) unless tracked?
 
       add_timestamp_if_necessary(options)
 
       new_context = Castle::Context::Merge.call(@context, options[:context])
 
-      Castle::API::Track.call(options.merge(context: new_context, no_symbolize: true))
+      Castle::API::Filter.call(options.merge(context: new_context, no_symbolize: true))
     end
 
     # @param options [Hash]
-    def start_impersonation(options = {})
+    def risk(options = {})
       options = Castle::Utils::DeepSymbolizeKeys.call(options || {})
 
+      return generate_do_not_track_response(options[:user][:id]) unless tracked?
+
       add_timestamp_if_necessary(options)
 
       new_context = Castle::Context::Merge.call(@context, options[:context])
 
-      Castle::API::StartImpersonation.call(options.merge(context: new_context, no_symbolize: true))
+      Castle::API::Risk.call(options.merge(context: new_context, no_symbolize: true))
     end
 
     # @param options [Hash]
-    def end_impersonation(options = {})
+    def log(options = {})
       options = Castle::Utils::DeepSymbolizeKeys.call(options || {})
 
+      return generate_do_not_track_response(options[:user][:id]) unless tracked?
+
       add_timestamp_if_necessary(options)
 
       new_context = Castle::Context::Merge.call(@context, options[:context])
 
-      Castle::API::EndImpersonation.call(options.merge(context: new_context, no_symbolize: true))
+      Castle::API::Log.call(options.merge(context: new_context, no_symbolize: true))
+    end
+
+    # @param options [Hash]
+    def start_impersonation(options = {})
+      options = Castle::Utils::DeepSymbolizeKeys.call(options || {})
+
+      add_timestamp_if_necessary(options)
+
+      new_context = Castle::Context::Merge.call(@context, options[:context])
+
+      Castle::API::StartImpersonation.call(options.merge(context: new_context, no_symbolize: true))
     end
 
     # @param options [Hash]
-    def review(options = {})
+    def end_impersonation(options = {})
       options = Castle::Utils::DeepSymbolizeKeys.call(options || {})
 
-      Castle::API::Review.call(options.merge(no_symbolize: true))
+      add_timestamp_if_necessary(options)
+
+      new_context = Castle::Context::Merge.call(@context, options[:context])
+
+      Castle::API::EndImpersonation.call(options.merge(context: new_context, no_symbolize: true))
     end
 
     def disable_tracking
@@ -96,17 +114,19 @@ module Castle
       @do_not_track = false
     end
 
+    # @return [Boolean]
     def tracked?
       !@do_not_track
     end
 
     private
 
-    # @param user_id [String|Boolean]
+    # @param user_id [String, Boolean]
     def generate_do_not_track_response(user_id)
       Castle::Failover::PrepareResponse.new(
         user_id,
-        strategy: :allow, reason: 'Castle is set to do not track.'
+        strategy: :allow,
+        reason: 'Castle is set to do not track.'
       ).call
     end