castle-rb 8.1.0 → 9.0.0

data/spec/lib/castle/core/send_request_spec.rb

@@ -1,97 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe Castle::Core::SendRequest do
-  let(:config) { Castle.config }
-
-  describe '#call' do
-    let(:command) { Castle::Commands::Track.build(event: '$login.succeeded') }
-    let(:headers) { {} }
-    let(:request_build) { {} }
-    let(:expected_headers) { { 'Content-Type' => 'application/json' } }
-    let(:http) { instance_double(Net::HTTP) }
-
-    context 'without http arg provided' do
-      subject(:call) { described_class.call(command, headers, nil, config) }
-
-      let(:http) { instance_double(Net::HTTP) }
-      let(:command) { Castle::Commands::Track.build(event: '$login.succeeded') }
-      let(:headers) { {} }
-      let(:request_build) { {} }
-      let(:expected_headers) { { 'Content-Type' => 'application/json' } }
-
-      before do
-        allow(Castle::Core::GetConnection).to receive(:call).and_return(http)
-        allow(http).to receive(:request)
-        allow(described_class).to receive(:build).and_return(request_build)
-        call
-      end
-
-      it { expect(described_class).to have_received(:build).with(command, expected_headers, config) }
-
-      it { expect(http).to have_received(:request).with(request_build) }
-    end
-
-    context 'with http arg provided' do
-      subject(:call) { described_class.call(command, headers, http, config) }
-
-      before do
-        allow(Castle::Core::GetConnection).to receive(:call)
-        allow(http).to receive(:request)
-        allow(described_class).to receive(:build).and_return(request_build)
-        call
-      end
-
-      it { expect(Castle::Core::GetConnection).not_to have_received(:call) }
-
-      it { expect(described_class).to have_received(:build).with(command, expected_headers, config) }
-
-      it { expect(http).to have_received(:request).with(request_build) }
-    end
-  end
-
-  describe '#build' do
-    subject(:build) { described_class.build(command, headers, config) }
-
-    let(:headers) { { 'SAMPLE-HEADER' => '1' } }
-    let(:api_secret) { 'secret' }
-
-    context 'when post' do
-      let(:time) { Time.now.utc.iso8601(3) }
-      let(:command) { Castle::Commands::Track.build(event: '$login.succeeded', name: "\xC4") }
-      let(:expected_body) { { event: '$login.succeeded', name: '�', context: {}, sent_at: time } }
-
-      before { allow(Castle::Utils::GetTimestamp).to receive(:call).and_return(time) }
-
-      it { expect(build.body).to eql(expected_body.to_json) }
-      it { expect(build.method).to eql('POST') }
-      it { expect(build.path).to eql("/v1/#{command.path}") }
-      it { expect(build.to_hash).to have_key('authorization') }
-      it { expect(build.to_hash).to have_key('sample-header') }
-      it { expect(build.to_hash['sample-header']).to eql(['1']) }
-    end
-
-    context 'when get' do
-      let(:time) { Time.now.utc.iso8601(3) }
-      let(:command) { Castle::Commands::GetDevice.build(device_token: '1') }
-      let(:expected_body) { {} }
-
-      before { allow(Castle::Utils::GetTimestamp).to receive(:call).and_return(time) }
-
-      it { expect(build.body).to eql(expected_body.to_json) }
-      it { expect(build.method).to eql('GET') }
-      it { expect(build.path).to eql("/v1/#{command.path}") }
-    end
-
-    context 'when put' do
-      let(:time) { Time.now.utc.iso8601(3) }
-      let(:command) { Castle::Commands::ApproveDevice.build(device_token: '1') }
-      let(:expected_body) { {} }
-
-      before { allow(Castle::Utils::GetTimestamp).to receive(:call).and_return(time) }
-
-      it { expect(build.body).to eql(expected_body.to_json) }
-      it { expect(build.method).to eql('PUT') }
-      it { expect(build.path).to eql("/v1/#{command.path}") }
-    end
-  end
-end

data/spec/lib/castle/failover/strategy_spec.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe Castle::Failover::Strategy do
-  subject(:strategy) { described_class }
-
-  it { expect(strategy::ALLOW).to be(:allow) }
-  it { expect(strategy::DENY).to be(:deny) }
-  it { expect(strategy::CHALLENGE).to be(:challenge) }
-  it { expect(strategy::THROW).to be(:throw) }
-
-  it { expect(Castle::Failover::STRATEGIES).to eql(%i[allow deny challenge throw]) }
-end

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

@@ -1,103 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe Castle::Headers::Extract do
-  subject(:extract_call) { described_class.new(formatted_headers).call }
-
-  let(:formatted_headers) do
-    {
-      'Content-Length' => '0',
-      'Authorization' => 'Basic 123456',
-      'Cookie' => '__cid=abcd;other=efgh',
-      'Ok' => 'OK',
-      'Accept' => 'application/json',
-      'X-Forwarded-For' => '1.2.3.4',
-      'User-Agent' => 'Mozilla 1234'
-    }
-  end
-
-  after do
-    Castle.config.allowlisted = %w[]
-    Castle.config.denylisted = %w[]
-  end
-
-  context 'when allowlist is not set in the configuration' do
-    let(:result) do
-      {
-        'Accept' => 'application/json',
-        'Authorization' => true,
-        'Cookie' => true,
-        'Content-Length' => '0',
-        'Ok' => 'OK',
-        'User-Agent' => 'Mozilla 1234',
-        'X-Forwarded-For' => '1.2.3.4'
-      }
-    end
-
-    it { expect(extract_call).to eq(result) }
-  end
-
-  context 'when allowlist is set in the configuration' do
-    before { Castle.config.allowlisted = %w[Accept OK] }
-
-    let(:result) do
-      {
-        'Accept' => 'application/json',
-        'Authorization' => true,
-        'Cookie' => true,
-        'Content-Length' => true,
-        'Ok' => 'OK',
-        'User-Agent' => 'Mozilla 1234',
-        'X-Forwarded-For' => true
-      }
-    end
-
-    it { expect(extract_call).to eq(result) }
-  end
-
-  context 'when denylist is set in the configuration' do
-    context 'with a User-Agent' do
-      let(:result) do
-        {
-          'Accept' => 'application/json',
-          'Authorization' => true,
-          'Cookie' => true,
-          'Content-Length' => '0',
-          'Ok' => 'OK',
-          'User-Agent' => 'Mozilla 1234',
-          'X-Forwarded-For' => '1.2.3.4'
-        }
-      end
-
-      before { Castle.config.denylisted = %w[User-Agent] }
-
-      it { expect(extract_call).to eq(result) }
-    end
-
-    context 'with a different header' do
-      let(:result) do
-        {
-          'Accept' => true,
-          'Authorization' => true,
-          'Cookie' => true,
-          'Content-Length' => '0',
-          'Ok' => 'OK',
-          'User-Agent' => 'Mozilla 1234',
-          'X-Forwarded-For' => '1.2.3.4'
-        }
-      end
-
-      before { Castle.config.denylisted = %w[Accept] }
-
-      it { expect(extract_call).to eq(result) }
-    end
-  end
-
-  context 'when a header is both allowlisted and denylisted' do
-    before do
-      Castle.config.allowlisted = %w[Accept]
-      Castle.config.denylisted = %w[Accept]
-    end
-
-    it { expect(extract_call['Accept']).to be(true) }
-  end
-end

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

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe Castle::Headers::Filter do
-  subject(:filter_call) { described_class.new(request).call }
-
-  let(:env) do
-    result =
-      Rack::MockRequest.env_for(
-        '/',
-        'Action-Dispatch.request.content-Type' => 'application/json',
-        'HTTP_AUTHORIZATION' => 'Basic 123456',
-        'HTTP_COOKIE' => '__cid=abcd;other=efgh',
-        'HTTP_ACCEPT' => 'application/json',
-        'HTTP_X_FORWARDED_FOR' => '1.2.3.4',
-        'HTTP_USER_AGENT' => 'Mozilla 1234',
-        'TEST' => '1',
-        'REMOTE_ADDR' => '1.2.3.4',
-        'HTTP_CONTENT_LENGTH' => '0',
-        'http_accept_language.parser' => -> { 'noop' }
-      )
-    result[:HTTP_OK] = 'OK'
-    result
-  end
-  let(:filtered) do
-    {
-      'Accept' => 'application/json',
-      'Authorization' => 'Basic 123456',
-      'Cookie' => '__cid=abcd;other=efgh',
-      'Content-Length' => '0',
-      'Ok' => 'OK',
-      'User-Agent' => 'Mozilla 1234',
-      'Remote-Addr' => '1.2.3.4',
-      'X-Forwarded-For' => '1.2.3.4',
-      'Accept-Language.parser' => start_with('#<Proc')
-    }
-  end
-  let(:request) { Rack::Request.new(env) }
-
-  context 'with list of header' do
-    it { expect(filter_call).to match(filtered) }
-  end
-end

data/spec/lib/castle/headers/format_spec.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe Castle::Headers::Format do
-  subject(:format) { described_class }
-
-  it 'removes HTTP_' do
-    expect(format.call('HTTP_X_TEST')).to eql('X-Test')
-  end
-
-  it 'capitalizes header' do
-    expect(format.call('X_TEST')).to eql('X-Test')
-  end
-
-  it 'ignores letter case and -_ divider' do
-    expect(format.call('http-X_teST')).to eql('X-Test')
-  end
-
-  it 'does not remove http if there is no _- char' do
-    expect(format.call('httpX_teST')).to eql('Httpx-Test')
-  end
-
-  it 'capitalizes' do
-    expect(format.call(:clearance)).to eql('Clearance')
-  end
-end

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

@@ -1,91 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe Castle::IPs::Extract do
-  subject(:extractor) { described_class.new(headers) }
-
-  describe 'ip' do
-    after do
-      Castle.config.ip_headers = []
-      Castle.config.trusted_proxies = []
-    end
-
-    context 'when regular ip' do
-      let(:headers) { { 'X-Forwarded-For' => '1.2.3.5' } }
-
-      it { expect(extractor.call).to eql('1.2.3.5') }
-    end
-
-    context 'when we need to use other ip header' do
-      let(:headers) { { 'Cf-Connecting-Ip' => '1.2.3.4', 'X-Forwarded-For' => '1.1.1.1, 1.2.2.2, 1.2.3.5' } }
-
-      context 'with uppercase format' do
-        before { Castle.config.ip_headers = %w[CF_CONNECTING_IP X-Forwarded-For] }
-
-        it { expect(extractor.call).to eql('1.2.3.4') }
-      end
-
-      context 'with regular format' do
-        before { Castle.config.ip_headers = %w[Cf-Connecting-Ip X-Forwarded-For] }
-
-        it { expect(extractor.call).to eql('1.2.3.4') }
-      end
-
-      context 'with value from trusted proxies it get seconds header' do
-        before do
-          Castle.config.ip_headers = %w[Cf-Connecting-Ip X-Forwarded-For]
-          Castle.config.trusted_proxies = %w[1.2.3.4]
-        end
-
-        it { expect(extractor.call).to eql('1.2.3.5') }
-      end
-    end
-
-    context 'with all the trusted proxies' do
-      let(:http_x_header) { '127.0.0.1,10.0.0.1,172.31.0.1,192.168.0.1' }
-
-      let(:headers) { { 'Remote-Addr' => '127.0.0.1', 'X-Forwarded-For' => http_x_header } }
-
-      it 'fallbacks to first available header when all headers are marked trusted proxy' do
-        expect(extractor.call).to eql('127.0.0.1')
-      end
-    end
-
-    context 'with trust_proxy_chain option' do
-      let(:http_x_header) { '6.6.6.6, 2.2.2.3, 6.6.6.5' }
-
-      let(:headers) { { 'Remote-Addr' => '6.6.6.4', 'X-Forwarded-For' => http_x_header } }
-
-      before { Castle.config.trust_proxy_chain = true }
-
-      it 'selects first available header' do
-        expect(extractor.call).to eql('6.6.6.6')
-      end
-    end
-
-    context 'with trusted_proxy_depth option' do
-      let(:http_x_header) { '6.6.6.6, 2.2.2.3, 6.6.6.5' }
-
-      let(:headers) { { 'Remote-Addr' => '6.6.6.4', 'X-Forwarded-For' => http_x_header } }
-
-      before { Castle.config.trusted_proxy_depth = 1 }
-
-      it 'selects first available header' do
-        expect(extractor.call).to eql('2.2.2.3')
-      end
-    end
-
-    context 'when list of not trusted ips provided in X_FORWARDED_FOR' do
-      let(:headers) { { 'X-Forwarded-For' => '6.6.6.6, 2.2.2.3, 192.168.0.7', 'Client-Ip' => '6.6.6.6' } }
-
-      it 'does not allow to spoof ip' do
-        expect(extractor.call).to eql('2.2.2.3')
-      end
-
-      context 'when marked 2.2.2.3 as trusted proxy' do
-        before { Castle.config.trusted_proxies = [/^2.2.2.\d$/] }
-
-        it { expect(extractor.call).to eql('6.6.6.6') }
-      end
-    end
-  end
-end

data/spec/lib/castle/logger_spec.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-# tmp logger for testing
-class TmpLogger
-  # @param _message [String]
-  def info(_message)
-  end
-end
-
-RSpec.describe Castle::Logger do
-  subject(:log) { described_class.call(message, data) }
-
-  let(:message) { 'https://localhost/test:' }
-  let(:integration_logger) { TmpLogger.new }
-  let(:data) { { a: 1 }.to_json }
-  let(:logger_message) { "[CASTLE] #{message} #{data}" }
-
-  before { allow(integration_logger).to receive(:info).and_call_original }
-
-  describe '.call' do
-    context 'without logger' do
-      before do
-        Castle.config.logger = nil
-        log
-      end
-
-      it { expect(integration_logger).not_to have_received(:info) }
-    end
-
-    context 'with logger' do
-      before do
-        Castle.config.logger = integration_logger
-        log
-      end
-
-      it { expect(integration_logger).to have_received(:info).with(logger_message) }
-    end
-  end
-end

data/spec/lib/castle/payload/prepare_spec.rb

@@ -1,52 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe Castle::Payload::Prepare do
-  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",
-      'HTTP_CONTENT_LENGTH' => '0'
-    )
-  end
-  let(:request) { Rack::Request.new(env) }
-
-  let(:headers) { { 'Content-Length': '0', 'User-Agent': ua, 'X-Forwarded-For': ip.to_s, Cookie: true } }
-  let(:context) do
-    {
-      client_id: 'abcd',
-      active: true,
-      user_agent: ua,
-      headers: headers,
-      ip: ip,
-      library: {
-        name: 'castle-rb',
-        version: '2.2.0'
-      }
-    }
-  end
-
-  let(:time_now) { Time.now }
-  let(:time_formatted) { time_now.utc.iso8601(3) }
-  let(:payload_options) { { user_id: '1234', user_traits: { name: 'Jo' } } }
-  let(:result) { { user_id: '1234', user_traits: { name: 'Jo' }, timestamp: time_formatted, context: context } }
-
-  before do
-    Timecop.freeze(time_now)
-    stub_const('Castle::VERSION', '2.2.0')
-  end
-
-  after { Timecop.return }
-
-  describe '#call' do
-    subject(:generated) { described_class.call(payload_options, request) }
-
-    context 'when active true' do
-      it { is_expected.to eql(result) }
-    end
-  end
-end

data/spec/lib/castle/secure_mode_spec.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe Castle::SecureMode do
-  it 'has signature' do
-    expect(described_class.signature('test')).to eql('0329a06b62cd16b33eb6792be8c60b158d89a2ee3a876fce9a881ebb488c0914')
-  end
-end

data/spec/lib/castle/session_spec.rb

@@ -1,61 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe Castle::Session do
-  describe '.call' do
-    context 'when ssl false' do
-      let(:localhost) { 'localhost' }
-      let(:port) { 3002 }
-
-      before do
-        Castle.config.base_url = 'http://localhost:3002'
-        stub_request(:get, 'localhost:3002/test').to_return(status: 200, body: '{}', headers: {})
-      end
-
-      context 'with block' do
-        let(:api_url) { '/test' }
-        let(:request) { Net::HTTP::Get.new(api_url) }
-
-        before do
-          allow(Net::HTTP).to receive(:new).with(localhost, port).and_call_original
-
-          described_class.call { |http| http.request(request) }
-        end
-
-        it { expect(Net::HTTP).to have_received(:new).with(localhost, port) }
-
-        it { expect(a_request(:get, 'localhost:3002/test')).to have_been_made.once }
-      end
-
-      context 'without block' do
-        before { described_class.call }
-
-        it { expect(a_request(:get, 'localhost:3002/test')).not_to have_been_made }
-      end
-    end
-
-    context 'when ssl true' do
-      let(:localhost) { 'localhost' }
-      let(:port) { 443 }
-
-      before do
-        Castle.config.base_url = 'https://localhost'
-        stub_request(:get, 'https://localhost/test').to_return(status: 200, body: '{}', headers: {})
-      end
-
-      context 'with block' do
-        let(:api_url) { '/test' }
-        let(:request) { Net::HTTP::Get.new(api_url) }
-
-        before do
-          allow(Net::HTTP).to receive(:new).with(localhost, port).and_call_original
-
-          allow(Net::HTTP).to receive(:start)
-
-          described_class.call { |http| http.request(request) }
-        end
-
-        it { expect(Net::HTTP).to have_received(:new).with(localhost, port) }
-      end
-    end
-  end
-end

data/spec/lib/castle/singleton_configuration_spec.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe Castle::SingletonConfiguration do
-  subject(:config) { described_class.instance }
-
-  it_behaves_like 'configuration_host'
-  it_behaves_like 'configuration_request_timeout'
-  it_behaves_like 'configuration_allowlisted'
-  it_behaves_like 'configuration_denylisted'
-  it_behaves_like 'configuration_failover_strategy'
-  it_behaves_like 'configuration_api_secret'
-
-  it { expect(config.api_secret).to eql('secret') }
-end

data/spec/lib/castle/utils/clean_invalid_chars_spec.rb

@@ -1,69 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe Castle::Utils::CleanInvalidChars do
-  describe '::call' do
-    subject { described_class.call(input) }
-
-    context 'when input is a string' do
-      let(:input) { '1234' }
-
-      it { is_expected.to eq input }
-    end
-
-    context 'when input is an array' do
-      let(:input) { [1, 2, 3, '4'] }
-
-      it { is_expected.to eq input }
-    end
-
-    context 'when input is a hash' do
-      let(:input) { { user_id: 1 } }
-
-      it { is_expected.to eq input }
-    end
-
-    context 'when input is nil' do
-      let(:input) { nil }
-
-      it { is_expected.to eq input }
-    end
-
-    context 'when input is a nested hash' do
-      let(:input) { { user: { id: 1 } } }
-
-      it { is_expected.to eq input }
-    end
-
-    context 'with invalid UTF-8 characters' do
-      context 'when input is a hash' do
-        let(:input) { { user_id: "inv\xC4lid" } }
-
-        it { is_expected.to eq(user_id: 'inv�lid') }
-      end
-
-      context 'when input is a nested hash' do
-        let(:input) { { user: { id: "inv\xC4lid" } } }
-
-        it { is_expected.to eq(user: { id: 'inv�lid' }) }
-      end
-
-      context 'when input is an array of hashes' do
-        let(:input) { [{ user: "inv\xC4lid" }] * 2 }
-
-        it { is_expected.to eq([{ user: 'inv�lid' }, { user: 'inv�lid' }]) }
-      end
-
-      context 'when input is an array' do
-        let(:input) { ["inv\xC4lid"] * 2 }
-
-        it { is_expected.to eq(%w[inv�lid inv�lid]) }
-      end
-
-      context 'when input is a hash with array in key' do
-        let(:input) { { items: ["inv\xC4lid"] * 2 } }
-
-        it { is_expected.to eq(items: %w[inv�lid inv�lid]) }
-      end
-    end
-  end
-end

data/spec/lib/castle/utils/clone_spec.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe Castle::Utils::Clone do
-  subject(:clone) { described_class }
-
-  describe 'call' do
-    let(:nested) { { c: '3' } }
-    let(:first) { { test: { test1: { c: '4' }, test2: nested, a: '1', b: '2' } } }
-    let(:result) { { test: { test1: { c: '4' }, test2: { c: '3' }, a: '1', b: '2' } } }
-    let(:cloned) { clone.call(first) }
-
-    before { cloned }
-
-    it do
-      nested[:test] = 'sample'
-      expect(cloned).to eql(result)
-    end
-  end
-end

data/spec/lib/castle/utils/deep_symbolize_keys_spec.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe Castle::Utils::DeepSymbolizeKeys do
-  let(:nested_strings) { { 'a' => { 'b' => { 'c' => 3 } } } }
-  let(:nested_symbols) { { a: { b: { c: 3 } } } }
-  let(:nested_mixed) { { 'a' => { b: { 'c' => 3 } } } }
-  let(:string_array_of_hashes) { { 'a' => [{ 'b' => 2 }, { 'c' => 3 }, 4] } }
-  let(:symbol_array_of_hashes) { { a: [{ b: 2 }, { c: 3 }, 4] } }
-  let(:mixed_array_of_hashes) { { a: [{ b: 2 }, { 'c' => 3 }, 4] } }
-
-  describe '::call' do
-    subject { described_class.call(hash) }
-
-    context 'when nested_symbols' do
-      let(:hash) { nested_symbols }
-
-      it { is_expected.to eq(nested_symbols) }
-    end
-
-    context 'when nested_strings' do
-      let(:hash) { nested_strings }
-
-      it { is_expected.to eq(nested_symbols) }
-    end
-
-    context 'when nested_mixed' do
-      let(:hash) { nested_mixed }
-
-      it { is_expected.to eq(nested_symbols) }
-    end
-
-    context 'when string_array_of_hashes' do
-      let(:hash) { string_array_of_hashes }
-
-      it { is_expected.to eq(symbol_array_of_hashes) }
-    end
-
-    context 'when symbol_array_of_hashes' do
-      let(:hash) { symbol_array_of_hashes }
-
-      it { is_expected.to eq(symbol_array_of_hashes) }
-    end
-
-    context 'when mixed_array_of_hashes' do
-      let(:hash) { mixed_array_of_hashes }
-
-      it { is_expected.to eq(symbol_array_of_hashes) }
-    end
-  end
-end