castle-rb 8.0.0 → 9.0.0

data/lib/castle/commands/lists/get.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Castle
+  module Commands
+    module Lists
+      # Builds the command to get a list
+      class Get
+        class << self
+          # @param options [Hash]
+          # @return [Castle::Command]
+          def build(options = {})
+            Castle::Validators::Present.call(options, %i[list_id])
+
+            Castle::Command.new("lists/#{options[:list_id]}", nil, :get)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/castle/commands/lists/get_all.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Castle
+  module Commands
+    module Lists
+      # Builds the command to get all lists
+      class GetAll
+        class << self
+          # @return [Castle::Command]
+          def build
+            Castle::Command.new('lists', nil, :get)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/castle/commands/lists/query.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Castle
+  module Commands
+    module Lists
+      # Builds the command to query lists
+      class Query
+        class << self
+          # @param options [Hash]
+          # @return [Castle::Command]
+          def build(options = {})
+            options[:filters]&.each { |f| Castle::Validators::Present.call(f, %i[field op value]) }
+            Castle::Validators::Present.call(options[:sort], %i[field order]) if options[:sort]
+
+            Castle::Command.new('lists/query', options, :post)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/castle/commands/lists/update.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Castle
+  module Commands
+    module Lists
+      # Builds the command to update a list
+      class Update
+        class << self
+          # @param options [Hash]
+          # @return [Castle::Command]
+          def build(options = {})
+            Castle::Validators::Present.call(options, %i[list_id])
+
+            list_id = options.delete(:list_id)
+
+            Castle::Command.new("lists/#{list_id}", options, :put)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/castle/commands/privacy/delete_data.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Castle
+  module Commands
+    module Privacy
+      # Builds the command for DELETE /v1/privacy/users — GDPR Article 17 (right to be forgotten).
+      class DeleteData
+        class << self
+          # @param options [Hash] must include :identifier and :identifier_type ($id or $email)
+          # @return [Castle::Command]
+          def build(options = {})
+            Castle::Validators::Present.call(options, %i[identifier identifier_type])
+
+            Castle::Command.new('privacy/users', options, :delete)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/castle/commands/privacy/request_data.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Castle
+  module Commands
+    module Privacy
+      # Builds the command for POST /v1/privacy/users — GDPR Article 15 (right of access).
+      class RequestData
+        class << self
+          # @param options [Hash] must include :identifier and :identifier_type ($id or $email)
+          # @return [Castle::Command]
+          def build(options = {})
+            Castle::Validators::Present.call(options, %i[identifier identifier_type])
+
+            Castle::Command.new('privacy/users', options, :post)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/castle/core/get_connection.rb

@@ -12,7 +12,11 @@ module Castle
         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
+          # `request_timeout` is in milliseconds for historical reasons; both
+          # Net::HTTP timeouts take seconds.
+          timeout_seconds = config.request_timeout / 1000.0
+          http.open_timeout = timeout_seconds
+          http.read_timeout = timeout_seconds
 
           if config.base_url.scheme == HTTPS_SCHEME
             http.use_ssl = true

data/lib/castle/core/process_response.rb

@@ -57,6 +57,7 @@ module Castle
                 raise Castle::InvalidParametersError, parsed_body[:message]
               end
             rescue JSON::ParserError
+              # body wasn't valid JSON; fall through to the generic 422 error below
             end
           end
 

data/lib/castle/core/process_webhook.rb

@@ -11,7 +11,7 @@ module Castle
         # @return [String]
         def call(webhook, config = nil)
           webhook.body.read.tap do |result|
-            raise Castle::ApiError, 'Invalid webhook from Castle API' if result.blank?
+            raise Castle::ApiError, 'Invalid webhook from Castle API' if result.nil? || result.empty?
 
             Castle::Logger.call('webhook:', result.to_s, config)
           end

data/lib/castle/core/send_request.rb

@@ -15,7 +15,8 @@ module Castle
         # @param http [Net::HTTP]
         # @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))
+          connection = http || Castle::Core::GetConnection.call(config)
+          connection.request(build(command, headers.merge(DEFAULT_HEADERS), config))
         end
 
         # @param command [String]

data/lib/castle/errors.rb

@@ -12,7 +12,7 @@ module Castle
     attr_reader :reason
 
     # @param reason [Exception] the core exception that causes this error
-    def initialize(reason)
+    def initialize(reason) # rubocop:disable Lint/MissingSuper -- preserves legacy `to_s` (returns class name)
       @reason = reason
     end
   end
@@ -68,8 +68,4 @@ module Castle
   # all internal server errors
   class InternalServerError < Castle::ApiError
   end
-
-  # impersonation command failed
-  class ImpersonationFailed < Castle::ApiError
-  end
 end

data/lib/castle/headers/filter.rb

@@ -12,7 +12,7 @@ module Castle
       HTTP(?:_|-).*|
         CONTENT(?:_|-)LENGTH|
       REMOTE(?:_|-)ADDR
-      $/xi.freeze
+      $/xi
 
       private_constant :VALUABLE_HEADERS
 

data/lib/castle/version.rb

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

data/lib/castle.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-%w[openssl net/http json time].each(&method(:require))
+%w[openssl net/http json time base64].each(&method(:require))
 
 %w[
   castle/version
@@ -20,34 +20,53 @@
   castle/context/sanitize
   castle/context/get_default
   castle/context/prepare
-  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/log
-  castle/commands/report_device
   castle/commands/risk
-  castle/commands/start_impersonation
-  castle/commands/track
-  castle/api/approve_device
-  castle/api/authenticate
-  castle/api/end_impersonation
+  castle/commands/lists/get_all
+  castle/commands/lists/create
+  castle/commands/lists/delete
+  castle/commands/lists/get
+  castle/commands/lists/query
+  castle/commands/lists/update
+  castle/commands/list_items/archive
+  castle/commands/list_items/create
+  castle/commands/list_items/create_batch
+  castle/commands/list_items/count
+  castle/commands/list_items/get
+  castle/commands/list_items/query
+  castle/commands/list_items/unarchive
+  castle/commands/list_items/update
+  castle/commands/privacy/request_data
+  castle/commands/privacy/delete_data
   castle/api/filter
-  castle/api/get_device
-  castle/api/get_devices_for_user
   castle/api/log
-  castle/api/report_device
   castle/api/risk
-  castle/api/start_impersonation
-  castle/api/track
+  castle/api/lists/get_all
+  castle/api/lists/create
+  castle/api/lists/delete
+  castle/api/lists/get
+  castle/api/lists/query
+  castle/api/lists/update
+  castle/api/list_items/archive
+  castle/api/list_items/create
+  castle/api/list_items/create_batch
+  castle/api/list_items/count
+  castle/api/list_items/get
+  castle/api/list_items/query
+  castle/api/list_items/unarchive
+  castle/api/list_items/update
+  castle/api/privacy/request_data
+  castle/api/privacy/delete_data
   castle/payload/prepare
   castle/configuration
   castle/singleton_configuration
   castle/logger
   castle/failover/prepare_response
   castle/failover/strategy
+  castle/client_actions/lists
+  castle/client_actions/list_items
+  castle/client_actions/privacy
   castle/client
   castle/headers/filter
   castle/headers/format

metadata

@@ -1,64 +1,89 @@
 --- !ruby/object:Gem::Specification
 name: castle-rb
 version: !ruby/object:Gem::Version
-  version: 8.0.0
+  version: 9.0.0
 platform: ruby
 authors:
 - Johan Brissmyr
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-12 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: appraisal
+  name: base64
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '0.2'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: Castle protects your users from account compromise
-email: johan@castle.io
+        version: '0.2'
+description: |-
+  Castle protects web and mobile applications from account takeovers,
+  fake accounts, bots, and other forms of account abuse. This gem is
+  the official server-side Ruby SDK: it sends user events, retrieves
+  real-time risk decisions, manages trust and block lists, and
+  verifies webhook signatures.
+email: team@castle.io
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- LICENSE
 - README.md
 - lib/castle-rb.rb
 - lib/castle.rb
 - lib/castle/api.rb
-- lib/castle/api/approve_device.rb
-- lib/castle/api/authenticate.rb
-- lib/castle/api/end_impersonation.rb
 - lib/castle/api/filter.rb
-- lib/castle/api/get_device.rb
-- lib/castle/api/get_devices_for_user.rb
+- lib/castle/api/list_items/archive.rb
+- lib/castle/api/list_items/count.rb
+- lib/castle/api/list_items/create.rb
+- lib/castle/api/list_items/create_batch.rb
+- lib/castle/api/list_items/get.rb
+- lib/castle/api/list_items/query.rb
+- lib/castle/api/list_items/unarchive.rb
+- lib/castle/api/list_items/update.rb
+- lib/castle/api/lists/create.rb
+- lib/castle/api/lists/delete.rb
+- lib/castle/api/lists/get.rb
+- lib/castle/api/lists/get_all.rb
+- lib/castle/api/lists/query.rb
+- lib/castle/api/lists/update.rb
 - lib/castle/api/log.rb
-- lib/castle/api/report_device.rb
+- lib/castle/api/privacy/delete_data.rb
+- lib/castle/api/privacy/request_data.rb
 - lib/castle/api/risk.rb
-- lib/castle/api/start_impersonation.rb
-- lib/castle/api/track.rb
 - lib/castle/client.rb
+- lib/castle/client_actions/list_items.rb
+- lib/castle/client_actions/lists.rb
+- lib/castle/client_actions/privacy.rb
 - lib/castle/client_id/extract.rb
 - lib/castle/command.rb
-- lib/castle/commands/approve_device.rb
-- lib/castle/commands/authenticate.rb
-- lib/castle/commands/end_impersonation.rb
 - lib/castle/commands/filter.rb
-- lib/castle/commands/get_device.rb
-- lib/castle/commands/get_devices_for_user.rb
+- lib/castle/commands/list_items/archive.rb
+- lib/castle/commands/list_items/count.rb
+- lib/castle/commands/list_items/create.rb
+- lib/castle/commands/list_items/create_batch.rb
+- lib/castle/commands/list_items/get.rb
+- lib/castle/commands/list_items/query.rb
+- lib/castle/commands/list_items/unarchive.rb
+- lib/castle/commands/list_items/update.rb
+- lib/castle/commands/lists/create.rb
+- lib/castle/commands/lists/delete.rb
+- lib/castle/commands/lists/get.rb
+- lib/castle/commands/lists/get_all.rb
+- lib/castle/commands/lists/query.rb
+- lib/castle/commands/lists/update.rb
 - lib/castle/commands/log.rb
-- lib/castle/commands/report_device.rb
+- lib/castle/commands/privacy/delete_data.rb
+- lib/castle/commands/privacy/request_data.rb
 - lib/castle/commands/risk.rb
-- lib/castle/commands/start_impersonation.rb
-- lib/castle/commands/track.rb
 - lib/castle/configuration.rb
 - lib/castle/context/get_default.rb
 - lib/castle/context/merge.rb
@@ -80,8 +105,6 @@ files:
 - lib/castle/secure_mode.rb
 - lib/castle/session.rb
 - lib/castle/singleton_configuration.rb
-- lib/castle/support/hanami.rb
-- lib/castle/support/padrino.rb
 - lib/castle/support/rails.rb
 - lib/castle/support/sinatra.rb
 - lib/castle/utils/clean_invalid_chars.rb
@@ -95,74 +118,15 @@ files:
 - lib/castle/verdict.rb
 - lib/castle/version.rb
 - lib/castle/webhooks/verify.rb
-- spec/integration/rails/rails_spec.rb
-- spec/integration/rails/support/all.rb
-- spec/integration/rails/support/application.rb
-- spec/integration/rails/support/home_controller.rb
-- spec/lib/castle/api/approve_device_spec.rb
-- spec/lib/castle/api/authenticate_spec.rb
-- spec/lib/castle/api/end_impersonation_spec.rb
-- spec/lib/castle/api/filter_spec.rb
-- spec/lib/castle/api/get_device_spec.rb
-- spec/lib/castle/api/get_devices_for_user_spec.rb
-- spec/lib/castle/api/log_spec.rb
-- spec/lib/castle/api/report_device_spec.rb
-- spec/lib/castle/api/risk_spec.rb
-- spec/lib/castle/api/start_impersonation_spec.rb
-- spec/lib/castle/api/track_spec.rb
-- spec/lib/castle/api_spec.rb
-- spec/lib/castle/client_id/extract_spec.rb
-- spec/lib/castle/client_spec.rb
-- spec/lib/castle/command_spec.rb
-- spec/lib/castle/commands/approve_device_spec.rb
-- spec/lib/castle/commands/authenticate_spec.rb
-- spec/lib/castle/commands/end_impersonation_spec.rb
-- spec/lib/castle/commands/filter_spec.rb
-- spec/lib/castle/commands/get_device_spec.rb
-- spec/lib/castle/commands/get_devices_for_user_spec.rb
-- spec/lib/castle/commands/log_spec.rb
-- spec/lib/castle/commands/report_device_spec.rb
-- spec/lib/castle/commands/risk_spec.rb
-- spec/lib/castle/commands/start_impersonation_spec.rb
-- spec/lib/castle/commands/track_spec.rb
-- spec/lib/castle/configuration_spec.rb
-- spec/lib/castle/context/get_default_spec.rb
-- spec/lib/castle/context/merge_spec.rb
-- spec/lib/castle/context/prepare_spec.rb
-- spec/lib/castle/context/sanitize_spec.rb
-- spec/lib/castle/core/get_connection_spec.rb
-- spec/lib/castle/core/process_response_spec.rb
-- spec/lib/castle/core/process_webhook_spec.rb
-- spec/lib/castle/core/send_request_spec.rb
-- spec/lib/castle/failover/strategy_spec.rb
-- spec/lib/castle/headers/extract_spec.rb
-- spec/lib/castle/headers/filter_spec.rb
-- spec/lib/castle/headers/format_spec.rb
-- spec/lib/castle/ips/extract_spec.rb
-- spec/lib/castle/logger_spec.rb
-- spec/lib/castle/payload/prepare_spec.rb
-- spec/lib/castle/secure_mode_spec.rb
-- spec/lib/castle/session_spec.rb
-- spec/lib/castle/singleton_configuration_spec.rb
-- spec/lib/castle/utils/clean_invalid_chars_spec.rb
-- spec/lib/castle/utils/clone_spec.rb
-- spec/lib/castle/utils/deep_symbolize_keys_spec.rb
-- spec/lib/castle/utils/get_timestamp_spec.rb
-- spec/lib/castle/utils/merge_spec.rb
-- spec/lib/castle/validators/not_supported_spec.rb
-- spec/lib/castle/validators/present_spec.rb
-- spec/lib/castle/verdict_spec.rb
-- spec/lib/castle/version_spec.rb
-- spec/lib/castle/webhooks/verify_spec.rb
-- spec/lib/castle_spec.rb
-- spec/spec_helper.rb
-- spec/support/shared_examples/action_request.rb
-- spec/support/shared_examples/configuration.rb
 homepage: https://castle.io
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  homepage_uri: https://castle.io
+  source_code_uri: https://github.com/castle/castle-ruby
+  changelog_uri: https://github.com/castle/castle-ruby/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/castle/castle-ruby/issues
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -170,78 +134,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.17
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
-summary: Castle
-test_files:
-- spec/integration/rails/rails_spec.rb
-- spec/integration/rails/support/all.rb
-- spec/integration/rails/support/application.rb
-- spec/integration/rails/support/home_controller.rb
-- spec/lib/castle/api/approve_device_spec.rb
-- spec/lib/castle/api/authenticate_spec.rb
-- spec/lib/castle/api/end_impersonation_spec.rb
-- spec/lib/castle/api/filter_spec.rb
-- spec/lib/castle/api/get_device_spec.rb
-- spec/lib/castle/api/get_devices_for_user_spec.rb
-- spec/lib/castle/api/log_spec.rb
-- spec/lib/castle/api/report_device_spec.rb
-- spec/lib/castle/api/risk_spec.rb
-- spec/lib/castle/api/start_impersonation_spec.rb
-- spec/lib/castle/api/track_spec.rb
-- spec/lib/castle/api_spec.rb
-- spec/lib/castle/client_id/extract_spec.rb
-- spec/lib/castle/client_spec.rb
-- spec/lib/castle/command_spec.rb
-- spec/lib/castle/commands/approve_device_spec.rb
-- spec/lib/castle/commands/authenticate_spec.rb
-- spec/lib/castle/commands/end_impersonation_spec.rb
-- spec/lib/castle/commands/filter_spec.rb
-- spec/lib/castle/commands/get_device_spec.rb
-- spec/lib/castle/commands/get_devices_for_user_spec.rb
-- spec/lib/castle/commands/log_spec.rb
-- spec/lib/castle/commands/report_device_spec.rb
-- spec/lib/castle/commands/risk_spec.rb
-- spec/lib/castle/commands/start_impersonation_spec.rb
-- spec/lib/castle/commands/track_spec.rb
-- spec/lib/castle/configuration_spec.rb
-- spec/lib/castle/context/get_default_spec.rb
-- spec/lib/castle/context/merge_spec.rb
-- spec/lib/castle/context/prepare_spec.rb
-- spec/lib/castle/context/sanitize_spec.rb
-- spec/lib/castle/core/get_connection_spec.rb
-- spec/lib/castle/core/process_response_spec.rb
-- spec/lib/castle/core/process_webhook_spec.rb
-- spec/lib/castle/core/send_request_spec.rb
-- spec/lib/castle/failover/strategy_spec.rb
-- spec/lib/castle/headers/extract_spec.rb
-- spec/lib/castle/headers/filter_spec.rb
-- spec/lib/castle/headers/format_spec.rb
-- spec/lib/castle/ips/extract_spec.rb
-- spec/lib/castle/logger_spec.rb
-- spec/lib/castle/payload/prepare_spec.rb
-- spec/lib/castle/secure_mode_spec.rb
-- spec/lib/castle/session_spec.rb
-- spec/lib/castle/singleton_configuration_spec.rb
-- spec/lib/castle/utils/clean_invalid_chars_spec.rb
-- spec/lib/castle/utils/clone_spec.rb
-- spec/lib/castle/utils/deep_symbolize_keys_spec.rb
-- spec/lib/castle/utils/get_timestamp_spec.rb
-- spec/lib/castle/utils/merge_spec.rb
-- spec/lib/castle/validators/not_supported_spec.rb
-- spec/lib/castle/validators/present_spec.rb
-- spec/lib/castle/verdict_spec.rb
-- spec/lib/castle/version_spec.rb
-- spec/lib/castle/webhooks/verify_spec.rb
-- spec/lib/castle_spec.rb
-- spec/spec_helper.rb
-- spec/support/shared_examples/action_request.rb
-- spec/support/shared_examples/configuration.rb
+summary: Official Ruby SDK for the Castle fraud and account-abuse prevention platform
+test_files: []

data/lib/castle/api/approve_device.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module Castle
-  module API
-    # Sends PUT devices/#{device_token}/approve request
-    module ApproveDevice
-      class << self
-        # @param options [Hash]
-        # return [Hash]
-        def call(options = {})
-          options = Castle::Utils::DeepSymbolizeKeys.call(options || {})
-          http = options.delete(:http)
-          config = options.delete(:config) || Castle.config
-
-          Castle::API.call(Castle::Commands::ApproveDevice.build(options), {}, http, config)
-        end
-      end
-    end
-  end
-end

data/lib/castle/api/authenticate.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-module Castle
-  module API
-    module Authenticate
-      class << self
-        # @param options [Hash]
-        # return [Hash]
-        def call(options = {})
-          options = Castle::Utils::DeepSymbolizeKeys.call(options || {}) unless options[:no_symbolize]
-          options.delete(:no_symbolize)
-          http = options.delete(:http)
-          config = options.delete(:config) || Castle.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
-            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/end_impersonation.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module Castle
-  module API
-    # Sends DELETE impersonate request
-    module EndImpersonation
-      class << self
-        # @param options [Hash]
-        def call(options = {})
-          options = Castle::Utils::DeepSymbolizeKeys.call(options || {}) unless options[:no_symbolize]
-          options.delete(:no_symbolize)
-          http = options.delete(:http)
-          config = options.delete(:config) || Castle.config
-
-          Castle::API
-            .call(Castle::Commands::EndImpersonation.build(options), {}, http, config)
-            .tap { |response| raise Castle::ImpersonationFailed unless response[:success] }
-        end
-      end
-    end
-  end
-end

data/lib/castle/api/get_device.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module Castle
-  module API
-    # Sends GET devices/#{device_token} request
-    module GetDevice
-      class << self
-        # @param options [Hash]
-        # return [Hash]
-        def call(options = {})
-          options = Castle::Utils::DeepSymbolizeKeys.call(options || {})
-          http = options.delete(:http)
-          config = options.delete(:config) || Castle.config
-
-          Castle::API.call(Castle::Commands::GetDevice.build(options), {}, http, config)
-        end
-      end
-    end
-  end
-end