castle-rb 8.1.0 → 9.0.0

data/lib/castle/commands/track.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module Castle
-  module Commands
-    class Track
-      class << self
-        # @param options [Hash]
-        # @return [Castle::Command]
-        def build(options = {})
-          Castle::Validators::Present.call(options, %i[event])
-          context = Castle::Context::Sanitize.call(options[:context])
-
-          Castle::Command.new(
-            'track',
-            options.merge(context: context, sent_at: Castle::Utils::GetTimestamp.call),
-            :post
-          )
-        end
-      end
-    end
-  end
-end

data/lib/castle/support/hanami.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Castle
-  module Hanami
-    module Action
-      def castle
-        @castle ||= ::Castle::Client.from_request(request, cookies: (cookies if defined?(cookies)))
-      end
-    end
-
-    def self.included(base)
-      base.configure { controller.prepare { include Castle::Hanami::Action } }
-    end
-  end
-end

data/lib/castle/support/padrino.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module Padrino
-  class Application
-    module Castle
-      module Helpers
-        def castle
-          @castle ||= ::Castle::Client.from_request(request)
-        end
-      end
-
-      def self.registered(app)
-        app.helpers Helpers
-      end
-    end
-
-    register Castle
-  end
-end

data/spec/integration/rails/rails_spec.rb

@@ -1,95 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-require_relative 'support/all'
-
-RSpec.describe HomeController, type: :request do
-  context 'with index pages' do
-    let(:request) do
-      {
-        'event' => '$login.succeeded',
-        'user_id' => '123',
-        'properties' => {
-          'key' => 'value'
-        },
-        'user_traits' => {
-          'key' => 'value'
-        },
-        'timestamp' => now.utc.iso8601(3),
-        'sent_at' => now.utc.iso8601(3),
-        'context' => {
-          'client_id' => '',
-          'active' => true,
-          'headers' => {
-            '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,
-            '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',
-            'Version' => 'HTTP/1.0'
-          },
-          'ip' => '1.2.3.4',
-          'library' => {
-            'name' => 'castle-rb',
-            'version' => Castle::VERSION
-          }
-        }
-      }
-    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_VERSION' => 'HTTP/1.0',
-        'HTTP_CONTENT_LENGTH' => '0'
-      }
-    end
-
-    before do
-      Timecop.freeze(now)
-      stub_request(:post, 'https://api.castle.io/v1/track')
-    end
-
-    after { Timecop.return }
-
-    describe '#index1' do
-      before { get '/index1', headers: headers }
-
-      it do
-        assert_requested :post, 'https://api.castle.io/v1/track', times: 1 do |req|
-          JSON.parse(req.body) == request
-        end
-      end
-
-      it { expect(response).to be_successful }
-    end
-
-    describe '#index2' do
-      before { get '/index2', headers: headers }
-
-      it do
-        assert_requested :post, 'https://api.castle.io/v1/track', times: 1 do |req|
-          JSON.parse(req.body) == request
-        end
-      end
-
-      it { expect(response).to be_successful }
-    end
-
-    describe '#index3' do
-      before { get '/index3', headers: headers }
-
-      it do
-        assert_requested :post, 'https://api.castle.io/v1/track', times: 1 do |req|
-          JSON.parse(req.body) == request
-        end
-      end
-
-      it { expect(response).to be_successful }
-    end
-  end
-end

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

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-ENV['RAILS_ENV'] = 'test'
-require_relative 'application'
-require_relative 'home_controller'
-require 'rspec/rails'

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

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require 'action_controller/railtie'
-
-class TestApp < Rails::Application
-  credentials.secret_token = 'secret_token'
-  credentials.secret_key_base = 'secret_key_base'
-
-  config.logger = Logger.new($stdout)
-  Rails.logger = config.logger
-
-  routes.draw do
-    get '/index1' => 'home#index1'
-    get '/index2' => 'home#index2'
-    get '/index3' => 'home#index3'
-  end
-end

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

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-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' } }
-    client = ::Castle::Client.new(context: request_context)
-    client.track(payload)
-
-    render inline: 'hello'
-  end
-
-  # prepare payload and calling track with client example
-  def index2
-    payload =
-      ::Castle::Payload::Prepare.call(
-        { event: '$login.succeeded', user_id: '123', properties: { key: 'value' }, user_traits: { key: 'value' } },
-        request
-      )
-    client = ::Castle::Client.new
-    client.track(payload)
-
-    render inline: 'hello'
-  end
-
-  # prepare payload and calling track with direct API::Track service
-  def index3
-    payload =
-      ::Castle::Payload::Prepare.call(
-        { event: '$login.succeeded', user_id: '123', properties: { key: 'value' }, user_traits: { key: 'value' } },
-        request
-      )
-
-    Castle::API::Track.call(payload)
-
-    render inline: 'hello'
-  end
-end

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

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-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
-
-  describe '.call' do
-    subject(:retrieve) { described_class.call(device_token: device_token) }
-
-    let(:device_token) { '1234' }
-
-    before { retrieve }
-
-    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,133 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe Castle::API::Authenticate do
-  subject(:call_subject) { described_class.call(options) }
-
-  let(:ip) { '1.2.3.4' }
-  let(:cookie_id) { 'abcd' }
-  let(:ua) { 'Chrome' }
-  let(:env) do
-    Rack::MockRequest.env_for(
-      '/',
-      'HTTP_USER_AGENT' => ua,
-      'HTTP_X_FORWARDED_FOR' => ip,
-      'HTTP_COOKIE' => "__cid=#{cookie_id};other=efgh"
-    )
-  end
-  let(:request) { Rack::Request.new(env) }
-  let(:context) { Castle::Context::Prepare.call(request) }
-  let(:time_now) { Time.now }
-  let(:time_auto) { time_now.utc.iso8601(3) }
-  let(:time_user) { (Time.now - 10_000).utc.iso8601(3) }
-  let(:response_body) { {}.to_json }
-
-  before do
-    Timecop.freeze(time_now)
-    stub_const('Castle::VERSION', '2.2.0')
-  end
-
-  after { Timecop.return }
-
-  describe '.call' do
-    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: {
-          }
-        )
-        call_subject
-      end
-
-      let(:options) { { event: '$login.succeeded', user_id: '1234', context: context } }
-
-      it do
-        assert_requested :post, 'https://api.castle.io/v1/authenticate', times: 1 do |req|
-          JSON.parse(req.body) == JSON.parse(request_body.to_json)
-        end
-      end
-
-      context 'when passed timestamp in options and no defined timestamp' do
-        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 }
-        end
-
-        it do
-          assert_requested :post, 'https://api.castle.io/v1/authenticate', times: 1 do |req|
-            JSON.parse(req.body) == JSON.parse(request_body.to_json)
-          end
-        end
-      end
-    end
-
-    context 'when denied' do
-      let(:failover_appendix) { { failover: false, failover_reason: nil } }
-
-      let(:options) { { event: '$login.succeeded', user_id: '1234', context: context } }
-
-      context 'when denied without any risk policy' do
-        let(:response_body) { deny_response_without_rp.to_json }
-        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: {
-            }
-          )
-          call_subject
-        end
-
-        it do
-          assert_requested :post, 'https://api.castle.io/v1/authenticate', times: 1 do |req|
-            JSON.parse(req.body) == JSON.parse(request_body.to_json)
-          end
-        end
-
-        it { expect(call_subject).to eql(deny_without_rp_failover_result) }
-      end
-
-      context 'when denied with risk policy' do
-        let(:deny_response_with_rp) do
-          {
-            action: 'deny',
-            user_id: '12345',
-            device_token: 'abcdefg1234',
-            risk_policy: {
-              id: 'q-rbeMzBTdW2Fd09sbz55A',
-              revision_id: 'pke4zqO2TnqVr-NHJOAHEg',
-              name: 'Block Users from X',
-              type: 'bot'
-            }
-          }
-        end
-        let(:response_body) { deny_response_with_rp.to_json }
-        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: {
-            }
-          )
-          call_subject
-        end
-
-        it do
-          assert_requested :post, 'https://api.castle.io/v1/authenticate', times: 1 do |req|
-            JSON.parse(req.body) == JSON.parse(request_body.to_json)
-          end
-        end
-
-        it { expect(call_subject).to eql(deny_with_rp_failover_result) }
-      end
-    end
-  end
-end

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

@@ -1,59 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe Castle::API::EndImpersonation do
-  subject(:call) { described_class.call(options) }
-
-  let(:ip) { '1.2.3.4' }
-  let(:cookie_id) { 'abcd' }
-  let(:ua) { 'Chrome' }
-  let(:env) do
-    Rack::MockRequest.env_for(
-      '/',
-      'HTTP_USER_AGENT' => ua,
-      'HTTP_X_FORWARDED_FOR' => ip,
-      'HTTP_COOKIE' => "__cid=#{cookie_id};other=efgh"
-    )
-  end
-  let(:request) { Rack::Request.new(env) }
-  let(:context) { Castle::Context::Prepare.call(request) }
-  let(:time_now) { Time.now }
-  let(:time_auto) { time_now.utc.iso8601(3) }
-
-  before do
-    Timecop.freeze(time_now)
-    stub_const('Castle::VERSION', '2.2.0')
-    stub_request(:any, /api.castle.io/).with(basic_auth: ['', 'secret']).to_return(
-      status: 200,
-      body: response_body,
-      headers: {
-      }
-    )
-  end
-
-  after { Timecop.return }
-
-  describe 'call' do
-    let(:impersonator) { 'test@castle.io' }
-    let(:request_body) do
-      { user_id: '1234', sent_at: time_auto, properties: { impersonator: impersonator }, context: context }
-    end
-    let(:response_body) { { success: true }.to_json }
-    let(:options) { { user_id: '1234', properties: { impersonator: impersonator }, context: context } }
-
-    context 'when used with symbol keys' do
-      before { call }
-
-      it do
-        assert_requested :delete, 'https://api.castle.io/v1/impersonate', times: 1 do |req|
-          JSON.parse(req.body) == JSON.parse(request_body.to_json)
-        end
-      end
-    end
-
-    context 'when request is not successful' do
-      let(:response_body) { {}.to_json }
-
-      it { expect { call }.to raise_error(Castle::ImpersonationFailed) }
-    end
-  end
-end

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

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

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

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-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
-
-  describe '.call' do
-    subject(:retrieve) { described_class.call(device_token: device_token) }
-
-    let(:device_token) { '1234' }
-
-    before { retrieve }
-
-    it { assert_requested :get, "https://api.castle.io/v1/devices/#{device_token}", times: 1 }
-  end
-end

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

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-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
-
-  describe '.call' do
-    subject(:retrieve) { described_class.call(user_id: user_id) }
-
-    let(:user_id) { '1234' }
-
-    before { retrieve }
-
-    it { assert_requested :get, "https://api.castle.io/v1/users/#{user_id}/devices", times: 1 }
-  end
-end

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

@@ -1,18 +0,0 @@
-# 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

@@ -1,21 +0,0 @@
-# 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

@@ -1,22 +0,0 @@
-# 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

@@ -1,18 +0,0 @@
-# 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

@@ -1,21 +0,0 @@
-# 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

@@ -1,18 +0,0 @@
-# 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

@@ -1,22 +0,0 @@
-# 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

@@ -1,21 +0,0 @@
-# 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

@@ -1,17 +0,0 @@
-# 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