castle-rb 9.0.0 → 9.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '085ac2cdd6ebd7b69ab9171c72009c3f3d792c3d21d55b93d914abd93425098d'
-  data.tar.gz: c31f5076e77d08c27d06b7722558b816a56868a51e7a2f885b9fc9236fc50615
+  metadata.gz: 93980c047867e58e332b7503edfb243e157de612024a137e7e8fe2f6cd69b0ab
+  data.tar.gz: 487754c292626984bb233f67c88b0101aba4a206dfa7ab738f7e042799be59cf
 SHA512:
-  metadata.gz: ecf515a3a5ff3a264a749171a6507d1c03635415359a392b8daafbf1e57291749e509501d449c902b1811903688a2499b7b845bc9cf27d167faa8412cb3ff40e
-  data.tar.gz: 125266f1b4875f105b024b4bef5baf38175af1741e53c35cfe66ab7051dceb6adb76dda87b330ccdd48b06fc30bd4434283868e8be4de540752fbbbe06028ff9
+  metadata.gz: 42b66ed4b557d084bbfbb0b15b69793811c35e87e642b0a07de4aee9c8c0379732747aa9bd8a4890ff34a0420926f280d7d44044f09347e4078b9d65af6c9630
+  data.tar.gz: f15c06bfdcc644c419ff45fa6777c11ddae889a1be42d3b2c88665ce45b08acb71474c182b6524b6d70aa3777349733753fda516bd2215f63ca337bdf7daf102

data/CHANGELOG.md

@@ -1,7 +1,37 @@
 # Changelog
 
+## 9.2.0
+
+**Changes:**
+
+- Slim down the default request context to `headers`, `ip` and `library`; the remaining data is already available via `headers`.
+- Remove the internal `Castle::ClientId::Extract` service and the now-unused `cookies` plumbing in `Castle::Context::GetDefault`.
+- No longer read the API secret from the `CASTLE_API_SECRET` environment variable automatically; set `Castle.api_secret` explicitly (for example `Castle.api_secret = ENV.fetch('CASTLE_API_SECRET')`).
+
+## 9.1.0
+
+**Enhancements:**
+
+- Add Events API support (enterprise) — three new client methods for querying event data:
+  - `events_schema` — `GET /v1/events/schema`
+  - `query_events` — `POST /v1/events/query`
+  - `group_events` — `POST /v1/events/group`
+
+**Housekeeping:**
+
+- Remove unused `Castle::Validators::NotSupported` (dead code)
+- Remove unused `Session::HTTPS_SCHEME` constant; inline the comparison in `GetConnection`
+- Replace deprecated `:mingw, :x64_mingw` Bundler platforms with `:windows`
+- Bump Bundler 2.6.9 → 2.7.2
+- Bump json 2.19.5 → 2.19.7
+
 ## master
 
+- Bump dependencies (rack 3.1.19 → 3.2.6, rake, rspec-\*, timecop, simplecov-html, diff-lcs)
+- Bump Ruby to 3.4.9 (zlib CVE-2026-27820)
+- Bump Node.js to 24.16.0 in `.tool-versions`
+- Repair `yarn format:check`: add `syntax_tree` to the dev group (required by `@prettier/plugin-ruby` 4.x), reformat 11 spec files, and disable rubocop cops that conflict with prettier-ruby (`Layout/SpaceInsideHashLiteralBraces`, `Style/EmptyMethod`)
+
 ## 9.0.0
 
 **BREAKING CHANGES:**

data/lib/castle/api/events/group.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Castle
+  module API
+    module Events
+      # Sends POST /events/group request
+      module Group
+        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::Events::Group.build(options), {}, http, config)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/castle/api/events/query.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Castle
+  module API
+    module Events
+      # Sends POST /events/query request
+      module Query
+        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::Events::Query.build(options), {}, http, config)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/castle/api/events/schema.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Castle
+  module API
+    module Events
+      # Sends GET /events/schema request
+      module Schema
+        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::Events::Schema.build(options), {}, http, config)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/castle/client.rb

@@ -3,6 +3,7 @@
 module Castle
   # Castle's client.
   class Client
+    include Castle::ClientActions::Events
     include Castle::ClientActions::ListItems
     include Castle::ClientActions::Lists
     include Castle::ClientActions::Privacy

data/lib/castle/client_actions/events.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Castle
+  module ClientActions
+    # Client actions for the Events API
+    module Events
+      # @param options [Hash]
+      def events_schema(options = {})
+        Castle::API::Events::Schema.call(options)
+      end
+
+      # @param options [Hash]
+      def query_events(options = {})
+        Castle::API::Events::Query.call(options)
+      end
+
+      # @param options [Hash]
+      def group_events(options = {})
+        Castle::API::Events::Group.call(options)
+      end
+    end
+  end
+end

data/lib/castle/commands/events/group.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Castle
+  module Commands
+    module Events
+      # Builds the command to query aggregated events
+      class Group
+        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('events/group', options, :post)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Castle
+  module Commands
+    module Events
+      # Builds the command to query raw events
+      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('events/query', options, :post)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/castle/commands/events/schema.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Castle
+  module Commands
+    module Events
+      # Builds the command to get the events schema
+      class Schema
+        class << self
+          # @param options [Hash]
+          # @return [Castle::Command]
+          def build(_options = {})
+            Castle::Command.new('events/schema', nil, :get)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/castle/configuration.rb

@@ -69,7 +69,7 @@ module Castle
       self.base_url = BASE_URL
       self.allowlisted = [].freeze
       self.denylisted = [].freeze
-      self.api_secret = ENV.fetch('CASTLE_API_SECRET', '')
+      self.api_secret = ''
       self.ip_headers = [].freeze
       self.trusted_proxies = [].freeze
       self.trust_proxy_chain = false

data/lib/castle/context/get_default.rb

@@ -3,50 +3,21 @@
 module Castle
   module Context
     class GetDefault
-      def initialize(request, cookies = nil)
+      def initialize(request)
         @pre_headers = Castle::Headers::Filter.new(request).call
-        @cookies = cookies || request.cookies
-        @request = request
       end
 
       def call
-        {
-          client_id: client_id,
-          active: true,
-          headers: headers,
-          ip: ip,
-          library: {
-            name: 'castle-rb',
-            version: Castle::VERSION
-          }
-        }.tap do |result|
-          result[:locale] = locale if locale
-          result[:user_agent] = user_agent if user_agent
-        end
+        { headers: headers, ip: ip, library: { name: 'castle-rb', version: Castle::VERSION } }
       end
 
       private
 
-      # @return [String]
-      def locale
-        @pre_headers['Accept-Language']
-      end
-
-      # @return [String]
-      def user_agent
-        @pre_headers['User-Agent']
-      end
-
       # @return [String]
       def ip
         Castle::IPs::Extract.new(@pre_headers).call
       end
 
-      # @return [String]
-      def client_id
-        Castle::ClientId::Extract.new(@pre_headers, @cookies).call
-      end
-
       # formatted and filtered headers
       # @return [Hash]
       def headers

data/lib/castle/context/prepare.rb

@@ -9,7 +9,7 @@ module Castle
         # @param options [Hash]
         # @return [Hash]
         def call(request, options = {})
-          default_context = Castle::Context::GetDefault.new(request, options[:cookies]).call
+          default_context = Castle::Context::GetDefault.new(request).call
           Castle::Context::Merge.call(default_context, options[:context])
         end
       end

data/lib/castle/core/get_connection.rb

@@ -4,8 +4,6 @@ module Castle
   module Core
     # this module returns a new configured Net::HTTP object
     module GetConnection
-      HTTPS_SCHEME = 'https'
-
       class << self
         # @param config [Castle::Configuration, Castle::SingletonConfiguration]
         # @return [Net::HTTP]
@@ -18,7 +16,7 @@ module Castle
           http.open_timeout = timeout_seconds
           http.read_timeout = timeout_seconds
 
-          if config.base_url.scheme == HTTPS_SCHEME
+          if config.base_url.scheme == 'https'
             http.use_ssl = true
             http.verify_mode = OpenSSL::SSL::VERIFY_PEER
           end

data/lib/castle/session.rb

@@ -5,8 +5,6 @@ module Castle
   # and provides start method for persistent connection usage
   # when there is a need of sending multiple requests at once
   module Session
-    HTTPS_SCHEME = 'https'
-
     class << self
       def call(&block)
         return unless block

data/lib/castle/version.rb

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

data/lib/castle.rb

@@ -14,7 +14,6 @@
   castle/utils/get_timestamp
   castle/utils/secure_compare
   castle/validators/present
-  castle/validators/not_supported
   castle/webhooks/verify
   castle/context/merge
   castle/context/sanitize
@@ -37,6 +36,9 @@
   castle/commands/list_items/query
   castle/commands/list_items/unarchive
   castle/commands/list_items/update
+  castle/commands/events/schema
+  castle/commands/events/query
+  castle/commands/events/group
   castle/commands/privacy/request_data
   castle/commands/privacy/delete_data
   castle/api/filter
@@ -56,6 +58,9 @@
   castle/api/list_items/query
   castle/api/list_items/unarchive
   castle/api/list_items/update
+  castle/api/events/schema
+  castle/api/events/query
+  castle/api/events/group
   castle/api/privacy/request_data
   castle/api/privacy/delete_data
   castle/payload/prepare
@@ -64,6 +69,7 @@
   castle/logger
   castle/failover/prepare_response
   castle/failover/strategy
+  castle/client_actions/events
   castle/client_actions/lists
   castle/client_actions/list_items
   castle/client_actions/privacy
@@ -72,7 +78,6 @@
   castle/headers/format
   castle/headers/extract
   castle/secure_mode
-  castle/client_id/extract
   castle/ips/extract
   castle/core/get_connection
   castle/core/process_response

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: castle-rb
 version: !ruby/object:Gem::Version
-  version: 9.0.0
+  version: 9.2.0
 platform: ruby
 authors:
 - Johan Brissmyr
@@ -40,6 +40,9 @@ files:
 - lib/castle-rb.rb
 - lib/castle.rb
 - lib/castle/api.rb
+- lib/castle/api/events/group.rb
+- lib/castle/api/events/query.rb
+- lib/castle/api/events/schema.rb
 - lib/castle/api/filter.rb
 - lib/castle/api/list_items/archive.rb
 - lib/castle/api/list_items/count.rb
@@ -60,11 +63,14 @@ files:
 - lib/castle/api/privacy/request_data.rb
 - lib/castle/api/risk.rb
 - lib/castle/client.rb
+- lib/castle/client_actions/events.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/events/group.rb
+- lib/castle/commands/events/query.rb
+- lib/castle/commands/events/schema.rb
 - lib/castle/commands/filter.rb
 - lib/castle/commands/list_items/archive.rb
 - lib/castle/commands/list_items/count.rb
@@ -113,7 +119,6 @@ files:
 - lib/castle/utils/get_timestamp.rb
 - lib/castle/utils/merge.rb
 - lib/castle/utils/secure_compare.rb
-- lib/castle/validators/not_supported.rb
 - lib/castle/validators/present.rb
 - lib/castle/verdict.rb
 - lib/castle/version.rb

data/lib/castle/client_id/extract.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Castle
-  module ClientId
-    # used for extraction of cookies and headers from the request
-    class Extract
-      # @param headers [Hash]
-      # @param cookies [NilClass|Hash]
-      def initialize(headers, cookies)
-        @headers = headers
-        @cookies = cookies || {}
-      end
-
-      # extracts client id
-      # @return [String]
-      def call
-        @headers['X-Castle-Client-Id'] || @cookies['__cid'] || ''
-      end
-    end
-  end
-end

data/lib/castle/validators/not_supported.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module Castle
-  module Validators
-    # Checks if required keys are supported
-    class NotSupported
-      class << self
-        def call(options, keys)
-          keys.each do |key|
-            next unless options.key?(key)
-
-            raise Castle::InvalidParametersError, "#{key} is/are not supported"
-          end
-        end
-      end
-    end
-  end
-end