castle-rb 8.0.0 → 8.1.0

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Castle
-  VERSION = '8.0.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

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

@@ -1,6 +1,6 @@
 # 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: {})
   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' }

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-describe Castle::API::EndImpersonation do
+RSpec.describe Castle::API::EndImpersonation do
   subject(:call) { described_class.call(options) }
 
   let(:ip) { '1.2.3.4' }

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-describe Castle::API::Filter do
+RSpec.describe Castle::API::Filter do
   pending
 end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-describe Castle::API::GetDevice do
+RSpec.describe Castle::API::GetDevice do
   before do
     stub_request(:any, /api.castle.io/).with(basic_auth: ['', 'secret']).to_return(status: 200, body: '{}', headers: {})
   end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-describe Castle::API::GetDevicesForUser do
+RSpec.describe Castle::API::GetDevicesForUser do
   before do
     stub_request(:any, /api.castle.io/).with(basic_auth: ['', 'secret']).to_return(status: 200, body: '{}', headers: {})
   end

data/spec/lib/castle/api/list_items/archive_spec.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+RSpec.describe Castle::API::ListItems::Archive do
+  before do
+    stub_request(:any, /api.castle.io/).with(basic_auth: ['', 'secret']).to_return(status: 200, body: '{}', headers: {})
+  end
+
+  describe '.call' do
+    subject(:all) { described_class.call(options) }
+
+    let(:url) { "https://api.castle.io/v1/lists/#{options[:list_id]}/items/#{options[:list_item_id]}/archive" }
+    let(:options) { { list_id: '123', list_item_id: '456' } }
+
+    before { all }
+
+    it { assert_requested :delete, url, times: 1 }
+  end
+end

data/spec/lib/castle/api/list_items/count_spec.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+RSpec.describe Castle::API::ListItems::Count do
+  before do
+    stub_request(:any, /api.castle.io/).with(basic_auth: ['', 'secret']).to_return(status: 200, body: '{}', headers: {})
+  end
+
+  describe '.call' do
+    subject(:all) { described_class.call(options) }
+
+    let(:options) { { list_id: '123', filters: [{ field: 'test', op: '$eq', value: 'test' }] } }
+
+    before { all }
+
+    it do
+      assert_requested :post, "https://api.castle.io/v1/lists/#{options[:list_id]}/items/count", times: 1 do |req|
+        expect(JSON.parse(req.body, symbolize_names: true)).to eq(options.except(:list_id))
+      end
+    end
+  end
+end

data/spec/lib/castle/api/list_items/create_spec.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+RSpec.describe Castle::API::ListItems::Create do
+  before do
+    stub_request(:any, /api.castle.io/).with(basic_auth: ['', 'secret']).to_return(status: 200, body: '{}', headers: {})
+  end
+
+  describe '.call' do
+    subject(:all) { described_class.call(options) }
+
+    let(:author) { { type: '$other', identifier: 'test identifier' } }
+    let(:options) { { list_id: '123', primary_value: 'test value', author: author,  } }
+
+    before { all }
+
+    it do
+      assert_requested :post, "https://api.castle.io/v1/lists/#{options[:list_id]}/items", times: 1 do |req|
+        expect(JSON.parse(req.body, symbolize_names: true)).to eq(options.except(:list_id))
+      end
+    end
+  end
+end

data/spec/lib/castle/api/list_items/get_spec.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+RSpec.describe Castle::API::ListItems::Get do
+  before do
+    stub_request(:any, /api.castle.io/).with(basic_auth: ['', 'secret']).to_return(status: 200, body: '{}', headers: {})
+  end
+
+  describe '.call' do
+    subject(:all) { described_class.call(options) }
+
+    let(:options) { { list_id: '123', list_item_id: '456' } }
+    let(:url) { "https://api.castle.io/v1/lists/#{options[:list_id]}/items/#{options[:list_item_id]}" }
+
+    before { all }
+
+    it { assert_requested :get, url, times: 1 }
+  end
+end

data/spec/lib/castle/api/list_items/query_spec.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+RSpec.describe Castle::API::ListItems::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(:all) { described_class.call(options) }
+
+    let(:options) { { list_id: '123', filters: [{ field: 'test', op: '$eq', value: 'test' }] } }
+
+    before { all }
+
+    it do
+      assert_requested :post, "https://api.castle.io/v1/lists/#{options[:list_id]}/items/query", times: 1 do |req|
+        expect(JSON.parse(req.body, symbolize_names: true)).to eq(options.except(:list_id))
+      end
+    end
+  end
+end

data/spec/lib/castle/api/list_items/unarchive_spec.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+RSpec.describe Castle::API::ListItems::Unarchive do
+  before do
+    stub_request(:any, /api.castle.io/).with(basic_auth: ['', 'secret']).to_return(status: 200, body: '{}', headers: {})
+  end
+
+  describe '.call' do
+    subject(:all) { described_class.call(options) }
+
+    let(:url) { "https://api.castle.io/v1/lists/#{options[:list_id]}/items/#{options[:list_item_id]}/unarchive" }
+    let(:options) { { list_id: '123', list_item_id: '456' } }
+
+    before { all }
+
+    it { assert_requested :put, url, times: 1 }
+  end
+end

data/spec/lib/castle/api/list_items/update_spec.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+RSpec.describe Castle::API::ListItems::Update do
+  before do
+    stub_request(:any, /api.castle.io/).with(basic_auth: ['', 'secret']).to_return(status: 200, body: '{}', headers: {})
+  end
+
+  describe '.call' do
+    subject(:all) { described_class.call(options) }
+
+    let(:url) { "https://api.castle.io/v1/lists/#{options[:list_id]}/items/#{options[:list_item_id]}" }
+    let(:options) { { list_id: '123', list_item_id: '456', comment: 'updating comment!' } }
+
+    before { all }
+
+    it do
+      assert_requested :put, url, times: 1 do |req|
+        expect(JSON.parse(req.body, symbolize_names: true)).to eq(options.except(:list_id, :list_item_id))
+      end
+    end
+  end
+end

data/spec/lib/castle/api/lists/create_spec.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+RSpec.describe Castle::API::Lists::Create do
+  before do
+    stub_request(:any, /api.castle.io/).with(basic_auth: ['', 'secret']).to_return(status: 200, body: '{}', headers: {})
+  end
+
+  describe '.call' do
+    subject(:all) { described_class.call(options) }
+
+    let(:options) { { name: 'name', color: '$red', primary_field: 'user.email' } }
+
+    before { all }
+
+    it do
+      assert_requested :post, 'https://api.castle.io/v1/lists', times: 1 do |req|
+        expect(JSON.parse(req.body, symbolize_names: true)).to eq(options)
+      end
+    end
+  end
+end

data/spec/lib/castle/api/lists/delete_spec.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+RSpec.describe Castle::API::Lists::Delete do
+  before do
+    stub_request(:any, /api.castle.io/).with(basic_auth: ['', 'secret']).to_return(status: 200, body: '{}', headers: {})
+  end
+
+  describe '.call' do
+    subject(:all) { described_class.call(options) }
+
+    let(:options) { { list_id: '123' } }
+
+    before { all }
+
+    it { assert_requested :delete, "https://api.castle.io/v1/lists/#{options[:list_id]}", times: 1 }
+  end
+end

data/spec/lib/castle/api/lists/get_all_spec.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+RSpec.describe Castle::API::Lists::GetAll do
+  before do
+    stub_request(:any, /api.castle.io/).with(basic_auth: ['', 'secret']).to_return(status: 200, body: '{}', headers: {})
+  end
+
+  describe '.call' do
+    subject(:all) { described_class.call(options) }
+
+    let(:options) { { } }
+
+    before { all }
+
+    it { assert_requested :get, "https://api.castle.io/v1/lists", times: 1 }
+  end
+end

data/spec/lib/castle/api/lists/get_spec.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+RSpec.describe Castle::API::Lists::Get do
+  before do
+    stub_request(:any, /api.castle.io/).with(basic_auth: ['', 'secret']).to_return(status: 200, body: '{}', headers: {})
+  end
+
+  describe '.call' do
+    subject(:all) { described_class.call(options) }
+
+    let(:options) { { list_id: '123' } }
+
+    before { all }
+
+    it { assert_requested :get, "https://api.castle.io/v1/lists/#{options[:list_id]}", times: 1 }
+  end
+end

data/spec/lib/castle/api/lists/query_spec.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+RSpec.describe Castle::API::Lists::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(:all) { described_class.call(options) }
+
+    let(:options) { { filters: [{ field: 'test', op: '$eq', value: 'test' }] } }
+
+    before { all }
+
+    it do
+      assert_requested :post, "https://api.castle.io/v1/lists/query", times: 1 do |req|
+        expect(JSON.parse(req.body, symbolize_names: true)).to eq(options)
+      end
+    end
+  end
+end

data/spec/lib/castle/api/lists/update_spec.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+RSpec.describe Castle::API::Lists::Update do
+  before do
+    stub_request(:any, /api.castle.io/).with(basic_auth: ['', 'secret']).to_return(status: 200, body: '{}', headers: {})
+  end
+
+  describe '.call' do
+    subject(:all) { described_class.call(options) }
+
+    let(:options) { { list_id: '123', name: 'name', color: '$red' } }
+
+    before { all }
+
+    it do
+      assert_requested :put, "https://api.castle.io/v1/lists/#{options[:list_id]}", times: 1 do |req|
+        expect(JSON.parse(req.body, symbolize_names: true)).to eq(options.except(:list_id))
+      end
+    end
+  end
+end

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-describe Castle::API::Log do
+RSpec.describe Castle::API::Log do
   pending
 end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-describe Castle::API::ReportDevice do
+RSpec.describe Castle::API::ReportDevice do
   before do
     stub_request(:any, /api.castle.io/).with(basic_auth: ['', 'secret']).to_return(status: 200, body: '{}', headers: {})
   end

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-describe Castle::API::Risk do
+RSpec.describe Castle::API::Risk do
   pending
 end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-describe Castle::API::StartImpersonation do
+RSpec.describe Castle::API::StartImpersonation do
   subject(:call) { described_class.call(options) }
 
   let(:ip) { '1.2.3.4' }

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-describe Castle::API::Track do
+RSpec.describe Castle::API::Track do
   subject(:call) { described_class.call(options) }
 
   let(:ip) { '1.2.3.4' }

data/spec/lib/castle/api_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-describe Castle::API do
+RSpec.describe Castle::API do
   subject(:call) { described_class.call(command) }
 
   let(:command) { Castle::Commands::Track.build(event: '$login.succeeded') }

data/spec/lib/castle/client_id/extract_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-describe Castle::ClientId::Extract do
+RSpec.describe Castle::ClientId::Extract do
   subject(:extractor) { described_class.new(formatted_headers, cookies) }
 
   let(:formatted_headers) { Castle::Headers::Filter.new(request).call }

data/spec/lib/castle/client_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-describe Castle::Client do
+RSpec.describe Castle::Client do
   let(:ip) { '1.2.3.4' }
   let(:cookie_id) { 'abcd' }
   let(:ua) { 'Chrome' }
@@ -334,4 +334,9 @@ describe Castle::Client do
   describe 'log' do
     it_behaves_like 'action request', :log
   end
+
+  describe 'client action mixins' do
+    it_behaves_like 'it has list actions'
+    it_behaves_like 'it has list item actions'
+  end
 end

data/spec/lib/castle/command_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-describe Castle::Command do
+RSpec.describe Castle::Command do
   subject(:command) { described_class.new('go', { id: '1' }, :post) }
 
   it { expect(command.path).to eql('go') }

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-describe Castle::Commands::ApproveDevice do
+RSpec.describe Castle::Commands::ApproveDevice do
   subject(:instance) { described_class }
 
   let(:context) { {} }

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-describe Castle::Commands::Authenticate do
+RSpec.describe Castle::Commands::Authenticate do
   subject(:instance) { described_class }
 
   let(:context) { { test: { test1: '1' } } }

data/spec/lib/castle/commands/end_impersonation_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-describe Castle::Commands::EndImpersonation do
+RSpec.describe Castle::Commands::EndImpersonation do
   subject(:instance) { described_class }
 
   let(:context) { { user_agent: 'test', ip: '127.0.0.1', client_id: 'test' } }

data/spec/lib/castle/commands/filter_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-describe Castle::Commands::Filter do
+RSpec.describe Castle::Commands::Filter do
   subject(:instance) { described_class }
 
   let(:context) { { test: { test1: '1' } } }

data/spec/lib/castle/commands/get_device_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-describe Castle::Commands::GetDevice do
+RSpec.describe Castle::Commands::GetDevice do
   subject(:instance) { described_class }
 
   let(:context) { {} }

data/spec/lib/castle/commands/get_devices_for_user_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-describe Castle::Commands::GetDevicesForUser do
+RSpec.describe Castle::Commands::GetDevicesForUser do
   subject(:instance) { described_class }
 
   let(:context) { {} }

data/spec/lib/castle/commands/list_items/archive_spec.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+RSpec.describe Castle::Commands::ListItems::Archive do
+  describe '.build' do
+    subject(:command) { described_class.build(options) }
+
+    context 'with valid options' do
+      let(:options) { { list_id: 'list_id', list_item_id: 'list_item_id'} }
+
+      it { expect(command.method).to be(:delete) }
+      it { expect(command.path).to eql('lists/list_id/items/list_item_id/archive') }
+      it { expect(command.data).to be_nil }
+    end
+
+    context 'with invalid options' do
+      let(:options) { { list_id: 'list_id' } }
+
+      it { expect { command }.to raise_error(Castle::InvalidParametersError) }
+    end
+  end
+end

data/spec/lib/castle/commands/list_items/count_spec.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+RSpec.describe Castle::Commands::ListItems::Count do
+  describe '.build' do
+    subject(:command) { described_class.build(options) }
+
+    context 'with valid options' do
+      let(:options) { { list_id: 'list_id', filters: [{ field: 'primary_value', op: '$eq', value: 'test'}]} }
+
+      it { expect(command.method).to be(:post) }
+      it { expect(command.path).to eql('lists/list_id/items/count') }
+      it { expect(command.data).to eql(options.except(:list_id)) }
+    end
+
+    context 'with invalid filters' do
+      let(:options) { { list_id: 'list_id', filters: [{ field: 'primary_field', op: '$eq' }]} }
+
+      it { expect { command }.to raise_error(Castle::InvalidParametersError) }
+    end
+  end
+end

data/spec/lib/castle/commands/list_items/create_spec.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+RSpec.describe Castle::Commands::ListItems::Create do
+  describe '.build' do
+    subject(:command) { described_class.build(options) }
+
+    context 'with valid options' do
+      let(:author) { { type: '$other', identifier: 'some value' } }
+      let(:options) { { list_id: 'list_id', author: author, primary_value: 'some value' } }
+
+      it { expect(command.method).to be(:post) }
+      it { expect(command.path).to eql('lists/list_id/items') }
+      it { expect(command.data).to eql(options.except(:list_id)) }
+    end
+
+    context 'with invalid options' do
+      let(:options) { { list_id: 'list_id' } }
+
+      it { expect { command }.to raise_error(Castle::InvalidParametersError) }
+    end
+  end
+end