castle-rb 7.2.0 → 8.1.0

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Castle
+  module Commands
+    module ListItems
+      # Builds the command to query list items
+      class Query
+        class << self
+          # @param options [Hash]
+          # @return [Castle::Command]
+          def build(options = {})
+            Castle::Validators::Present.call(options, %i[list_id])
+            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]
+
+            list_id = options.delete(:list_id)
+
+            Castle::Command.new("lists/#{list_id}/items/query", options, :post)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/castle/commands/list_items/unarchive.rb

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

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

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

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Castle
+  module Commands
+    # Commands for lists endpoints
+    module Lists
+      # Builds the command to create a list
+      class Create
+        class << self
+          # @param options [Hash]
+          # @return [Castle::Command]
+          def build(options = {})
+            Castle::Validators::Present.call(options, %i[name color primary_field])
+
+            Castle::Command.new('lists', options, :post)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Castle
+  module Commands
+    module Lists
+      # Builds the command to delete a list
+      class Delete
+        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, :delete)
+          end
+        end
+      end
+    end
+  end
+end

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/log.rb

@@ -10,11 +10,7 @@ module Castle
         def build(options = {})
           context = Castle::Context::Sanitize.call(options[:context])
 
-          Castle::Command.new(
-            'log',
-            options.merge(context: context, sent_at: Castle::Utils::GetTimestamp.call),
-            :post
-          )
+          Castle::Command.new('log', options.merge(context: context, sent_at: Castle::Utils::GetTimestamp.call), :post)
         end
       end
     end

data/lib/castle/commands/risk.rb

@@ -10,11 +10,7 @@ module Castle
         def build(options = {})
           context = Castle::Context::Sanitize.call(options[:context])
 
-          Castle::Command.new(
-            'risk',
-            options.merge(context: context, sent_at: Castle::Utils::GetTimestamp.call),
-            :post
-          )
+          Castle::Command.new('risk', options.merge(context: context, sent_at: Castle::Utils::GetTimestamp.call), :post)
         end
       end
     end

data/lib/castle/configuration.rb

@@ -104,9 +104,7 @@ module Castle
     # sets trusted proxies
     # @param value [Array<String,Regexp>]
     def trusted_proxies=(value)
-      unless value.is_a?(Array)
-        raise Castle::ConfigurationError, 'trusted proxies must be an Array'
-      end
+      raise Castle::ConfigurationError, 'trusted proxies must be an Array' unless value.is_a?(Array)
 
       @trusted_proxies = value
     end
@@ -121,8 +119,7 @@ module Castle
     end
 
     def failover_strategy=(value)
-      @failover_strategy =
-        Castle::Failover::STRATEGIES.detect { |strategy| strategy == value.to_sym }
+      @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/process_response.rb

@@ -9,7 +9,8 @@ module Castle
         401 => Castle::UnauthorizedError,
         403 => Castle::ForbiddenError,
         404 => Castle::NotFoundError,
-        419 => Castle::UserUnauthorizedError
+        419 => Castle::UserUnauthorizedError,
+        429 => Castle::RateLimitError
       }.freeze
 
       INVALID_REQUEST_TOKEN = 'invalid_request_token'
@@ -51,9 +52,9 @@ module Castle
               if parsed_body.is_a?(Hash) && parsed_body.key?(:type)
                 if parsed_body[:type] == INVALID_REQUEST_TOKEN
                   raise Castle::InvalidRequestTokenError, parsed_body[:message]
-                else
-                  raise Castle::InvalidParametersError, parsed_body[:message]
                 end
+
+                raise Castle::InvalidParametersError, parsed_body[:message]
               end
             rescue JSON::ParserError
             end

data/lib/castle/core/send_request.rb

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

data/lib/castle/errors.rb

@@ -61,6 +61,10 @@ module Castle
   class UnauthorizedError < Castle::ApiError
   end
 
+  # api error too many requests 429
+  class RateLimitError < Castle::ApiError
+  end
+
   # all internal server errors
   class InternalServerError < Castle::ApiError
   end

data/lib/castle/headers/extract.rb

@@ -23,9 +23,7 @@ module Castle
       # Serialize HTTP headers
       # @return [Hash]
       def call
-        @headers.each_with_object({}) do |(name, value), acc|
-          acc[name] = header_value(name, value)
-        end
+        @headers.each_with_object({}) { |(name, value), acc| acc[name] = header_value(name, value) }
       end
 
       private

data/lib/castle/headers/filter.rb

@@ -12,8 +12,7 @@ module Castle
       HTTP(?:_|-).*|
         CONTENT(?:_|-)LENGTH|
       REMOTE(?:_|-)ADDR
-      $/xi
-        .freeze
+      $/xi.freeze
 
       private_constant :VALUABLE_HEADERS
 
@@ -32,7 +31,7 @@ module Castle
             next unless header_name.match(VALUABLE_HEADERS)
 
             formatted_name = @header_format.call(header_name)
-            acc[formatted_name] = @request_env[header_name]
+            acc[formatted_name] = @request_env[header_name].to_s
           end
       end
     end

data/lib/castle/payload/prepare.rb

@@ -12,8 +12,7 @@ module Castle
         def call(payload_options, request, options = {})
           context = Castle::Context::Prepare.call(request, payload_options.merge(options))
 
-          payload =
-            Castle::Utils::DeepSymbolizeKeys.call(payload_options || {}).merge(context: context)
+          payload = Castle::Utils::DeepSymbolizeKeys.call(payload_options || {}).merge(context: context)
           payload[:timestamp] ||= Castle::Utils::GetTimestamp.call
 
           warn '[DEPRECATION] use user_traits instead of traits key' if payload.key?(:traits)

data/lib/castle/session.rb

@@ -9,7 +9,7 @@ module Castle
 
     class << self
       def call(&block)
-        return unless block_given?
+        return unless block
 
         Castle::Core::GetConnection.call.start(&block)
       end

data/lib/castle/version.rb

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

data/lib/castle.rb

@@ -31,6 +31,19 @@
   castle/commands/risk
   castle/commands/start_impersonation
   castle/commands/track
+  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/count
+  castle/commands/list_items/get
+  castle/commands/list_items/query
+  castle/commands/list_items/unarchive
+  castle/commands/list_items/update
   castle/api/approve_device
   castle/api/authenticate
   castle/api/end_impersonation
@@ -42,12 +55,27 @@
   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/count
+  castle/api/list_items/get
+  castle/api/list_items/query
+  castle/api/list_items/unarchive
+  castle/api/list_items/update
   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
   castle/headers/filter
   castle/headers/format
@@ -67,9 +95,7 @@
 module Castle
   class << self
     def configure(config_hash = nil)
-      (config_hash || {}).each do |config_name, config_value|
-        config.send("#{config_name}=", config_value)
-      end
+      (config_hash || {}).each { |config_name, config_value| config.send(:"#{config_name}=", config_value) }
 
       yield(config) if block_given?
     end

data/spec/integration/rails/rails_spec.rb

@@ -24,11 +24,12 @@ RSpec.describe HomeController, type: :request do
             'Accept' =>
               'text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5',
             'Authorization' => true,
-            'Content-Length' => '0',
             'Cookie' => true,
+            'Content-Length' => '0',
             'Host' => 'www.example.com',
             'X-Forwarded-For' => '5.5.5.5, 1.2.3.4',
-            'Remote-Addr' => '127.0.0.1'
+            'Remote-Addr' => '127.0.0.1',
+            'Version' => 'HTTP/1.0'
           },
           'ip' => '1.2.3.4',
           'library' => {
@@ -40,7 +41,12 @@ RSpec.describe HomeController, type: :request do
     end
     let(:now) { Time.now }
     let(:headers) do
-      { 'HTTP_AUTHORIZATION' => 'Basic 123', 'HTTP_X_FORWARDED_FOR' => '5.5.5.5, 1.2.3.4' }
+      {
+        'HTTP_AUTHORIZATION' => 'Basic 123',
+        'HTTP_X_FORWARDED_FOR' => '5.5.5.5, 1.2.3.4',
+        'HTTP_VERSION' => 'HTTP/1.0',
+        'HTTP_CONTENT_LENGTH' => '0'
+      }
     end
 
     before do

data/spec/integration/rails/support/application.rb

@@ -3,8 +3,8 @@
 require 'action_controller/railtie'
 
 class TestApp < Rails::Application
-  secrets.secret_token = 'secret_token'
-  secrets.secret_key_base = 'secret_key_base'
+  credentials.secret_token = 'secret_token'
+  credentials.secret_key_base = 'secret_key_base'
 
   config.logger = Logger.new($stdout)
   Rails.logger = config.logger

data/spec/integration/rails/support/home_controller.rb

@@ -4,16 +4,7 @@ class HomeController < ActionController::Base
   # prepare context and calling track with client example
   def index1
     request_context = ::Castle::Context::Prepare.call(request)
-    payload = {
-      event: '$login.succeeded',
-      user_id: '123',
-      properties: {
-        key: 'value'
-      },
-      user_traits: {
-        key: 'value'
-      }
-    }
+    payload = { event: '$login.succeeded', user_id: '123', properties: { key: 'value' }, user_traits: { key: 'value' } }
     client = ::Castle::Client.new(context: request_context)
     client.track(payload)
 
@@ -24,16 +15,7 @@ class HomeController < ActionController::Base
   def index2
     payload =
       ::Castle::Payload::Prepare.call(
-        {
-          event: '$login.succeeded',
-          user_id: '123',
-          properties: {
-            key: 'value'
-          },
-          user_traits: {
-            key: 'value'
-          }
-        },
+        { event: '$login.succeeded', user_id: '123', properties: { key: 'value' }, user_traits: { key: 'value' } },
         request
       )
     client = ::Castle::Client.new
@@ -46,18 +28,10 @@ class HomeController < ActionController::Base
   def index3
     payload =
       ::Castle::Payload::Prepare.call(
-        {
-          event: '$login.succeeded',
-          user_id: '123',
-          properties: {
-            key: 'value'
-          },
-          user_traits: {
-            key: 'value'
-          }
-        },
+        { event: '$login.succeeded', user_id: '123', properties: { key: 'value' }, user_traits: { key: 'value' } },
         request
       )
+
     Castle::API::Track.call(payload)
 
     render inline: 'hello'

data/spec/lib/castle/api/approve_device_spec.rb

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
 
-describe Castle::API::ApproveDevice do
+RSpec.describe Castle::API::ApproveDevice do
   before do
-    stub_request(:any, /api.castle.io/)
-      .with(basic_auth: ['', 'secret'])
-      .to_return(status: 200, body: '{}', headers: {})
+    stub_request(:any, /api.castle.io/).with(basic_auth: ['', 'secret']).to_return(status: 200, body: '{}', headers: {})
   end
 
   describe '.call' do
@@ -14,8 +12,6 @@ describe Castle::API::ApproveDevice do
 
     before { retrieve }
 
-    it do
-      assert_requested :put, "https://api.castle.io/v1/devices/#{device_token}/approve", times: 1
-    end
+    it { assert_requested :put, "https://api.castle.io/v1/devices/#{device_token}/approve", times: 1 }
   end
 end

data/spec/lib/castle/api/authenticate_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-describe Castle::API::Authenticate do
+RSpec.describe Castle::API::Authenticate do
   subject(:call_subject) { described_class.call(options) }
 
   let(:ip) { '1.2.3.4' }
@@ -29,15 +29,16 @@ describe Castle::API::Authenticate do
   after { Timecop.return }
 
   describe '.call' do
-    let(:request_body) do
-      { event: '$login.succeeded', context: context, user_id: '1234', sent_at: time_auto }
-    end
+    let(:request_body) { { event: '$login.succeeded', context: context, user_id: '1234', sent_at: time_auto } }
 
     context 'when used with symbol keys' do
       before do
-        stub_request(:any, /api.castle.io/)
-          .with(basic_auth: ['', 'secret'])
-          .to_return(status: 200, body: response_body, headers: {})
+        stub_request(:any, /api.castle.io/).with(basic_auth: ['', 'secret']).to_return(
+          status: 200,
+          body: response_body,
+          headers: {
+          }
+        )
         call_subject
       end
 
@@ -50,17 +51,9 @@ describe Castle::API::Authenticate do
       end
 
       context 'when passed timestamp in options and no defined timestamp' do
-        let(:options) do
-          { event: '$login.succeeded', user_id: '1234', timestamp: time_user, context: context }
-        end
+        let(:options) { { event: '$login.succeeded', user_id: '1234', timestamp: time_user, context: context } }
         let(:request_body) do
-          {
-            event: '$login.succeeded',
-            user_id: '1234',
-            context: context,
-            timestamp: time_user,
-            sent_at: time_auto
-          }
+          { event: '$login.succeeded', user_id: '1234', context: context, timestamp: time_user, sent_at: time_auto }
         end
 
         it do
@@ -78,15 +71,16 @@ describe Castle::API::Authenticate do
 
       context 'when denied without any risk policy' do
         let(:response_body) { deny_response_without_rp.to_json }
-        let(:deny_response_without_rp) do
-          { action: 'deny', user_id: '12345', device_token: 'abcdefg1234' }
-        end
+        let(:deny_response_without_rp) { { action: 'deny', user_id: '12345', device_token: 'abcdefg1234' } }
         let(:deny_without_rp_failover_result) { deny_response_without_rp.merge(failover_appendix) }
 
         before do
-          stub_request(:any, /api.castle.io/)
-            .with(basic_auth: ['', 'secret'])
-            .to_return(status: 200, body: deny_response_without_rp.to_json, headers: {})
+          stub_request(:any, /api.castle.io/).with(basic_auth: ['', 'secret']).to_return(
+            status: 200,
+            body: deny_response_without_rp.to_json,
+            headers: {
+            }
+          )
           call_subject
         end
 
@@ -117,9 +111,12 @@ describe Castle::API::Authenticate do
         let(:deny_with_rp_failover_result) { deny_response_with_rp.merge(failover_appendix) }
 
         before do
-          stub_request(:any, /api.castle.io/)
-            .with(basic_auth: ['', 'secret'])
-            .to_return(status: 200, body: deny_response_with_rp.to_json, headers: {})
+          stub_request(:any, /api.castle.io/).with(basic_auth: ['', 'secret']).to_return(
+            status: 200,
+            body: deny_response_with_rp.to_json,
+            headers: {
+            }
+          )
           call_subject
         end