Release 9.1.0: Events API, housekeeping

CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## 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)

Gemfile

@@ -16,7 +16,7 @@ group :development do
 end
 
 group :development, :test do
-  gem 'debug', platforms: %i[mri mingw x64_mingw]
+  gem 'debug', platforms: %i[mri windows]
 end
 
 group :test do

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    castle-rb (9.0.0)
+    castle-rb (9.1.0)
       base64 (~> 0.2)
 
 GEM
@@ -29,7 +29,7 @@ GEM
       prism (>= 1.3.0)
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
-    json (2.19.5)
+    json (2.19.7)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
     parallel (2.1.0)
@@ -133,4 +133,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   2.6.9
+   2.7.2

gemfiles/rails_7.0.gemfile

@@ -7,7 +7,7 @@ gem 'rails', '~> 7.0.0'
 gem 'rake'
 
 group :development, :test do
-  gem 'debug', platforms: %i[mri mingw x64_mingw]
+  gem 'debug', platforms: %i[mri windows]
 end
 
 group :test do

gemfiles/rails_7.1.gemfile

@@ -7,7 +7,7 @@ gem 'rails', '~> 7.1.0'
 gem 'rake'
 
 group :development, :test do
-  gem 'debug', platforms: %i[mri mingw x64_mingw]
+  gem 'debug', platforms: %i[mri windows]
 end
 
 group :test do

gemfiles/rails_7.2.gemfile

@@ -7,7 +7,7 @@ gem 'rails', '~> 7.2.0'
 gem 'rake'
 
 group :development, :test do
-  gem 'debug', platforms: %i[mri mingw x64_mingw]
+  gem 'debug', platforms: %i[mri windows]
 end
 
 group :test do

gemfiles/rails_8.0.gemfile

@@ -7,7 +7,7 @@ gem 'rails', '~> 8.0.0'
 gem 'rake'
 
 group :development, :test do
-  gem 'debug', platforms: %i[mri mingw x64_mingw]
+  gem 'debug', platforms: %i[mri windows]
 end
 
 group :test do

gemfiles/rails_8.1.gemfile

@@ -7,7 +7,7 @@ gem 'rails', '~> 8.1.0'
 gem 'rake'
 
 group :development, :test do
-  gem 'debug', platforms: %i[mri mingw x64_mingw]
+  gem 'debug', platforms: %i[mri windows]
 end
 
 group :test do

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

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

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

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

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

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

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

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

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

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 @@ def call(config = nil)
           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

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

lib/castle/version.rb

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

spec/lib/castle/api/events/group_spec.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+RSpec.describe Castle::API::Events::Group do
+  before do
+    stub_request(:any, /api.castle.io/).with(basic_auth: ['', 'secret']).to_return(status: 200, body: '{}', headers: {})
+  end
+
+  describe '.call' do
+    subject(:call) { described_class.call(options) }
+
+    let(:options) { { filters: [{ field: 'user.id', op: '$eq', value: 'u-42' }] } }
+
+    before { call }
+
+    it do
+      assert_requested :post, 'https://api.castle.io/v1/events/group', times: 1 do |req|
+        expect(JSON.parse(req.body, symbolize_names: true)).to eq(options)
+      end
+    end
+  end
+end

spec/lib/castle/api/events/query_spec.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+RSpec.describe Castle::API::Events::Query do
+  before do
+    stub_request(:any, /api.castle.io/).with(basic_auth: ['', 'secret']).to_return(status: 200, body: '{}', headers: {})
+  end
+
+  describe '.call' do
+    subject(:call) { described_class.call(options) }
+
+    let(:options) { { filters: [{ field: 'user.id', op: '$eq', value: 'u-42' }], query_type: '$records' } }
+
+    before { call }
+
+    it do
+      assert_requested :post, 'https://api.castle.io/v1/events/query', times: 1 do |req|
+        expect(JSON.parse(req.body, symbolize_names: true)).to eq(options)
+      end
+    end
+  end
+end