castle-rb 4.2.1 → 7.0.0

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

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

data/spec/lib/castle/{extractors/ip_spec.rb → ips/extract_spec.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-describe Castle::Extractors::IP do
+describe Castle::IPs::Extract do
   subject(:extractor) { described_class.new(headers) }
 
   describe 'ip' do
@@ -43,9 +43,7 @@ describe Castle::Extractors::IP do
     end
 
     context 'with all the trusted proxies' do
-      let(:http_x_header) do
-        '127.0.0.1,10.0.0.1,172.31.0.1,192.168.0.1,::1,fd00::,localhost,unix,unix:/tmp/sock'
-      end
+      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 } }
 
@@ -54,12 +52,33 @@ describe Castle::Extractors::IP do
       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) do
-        {
-          'X-Forwarded-For' => '6.6.6.6, 2.2.2.3, 192.168.0.7',
-          'Client-Ip' => '6.6.6.6'
-        }
+        { 'X-Forwarded-For' => '6.6.6.6, 2.2.2.3, 192.168.0.7', 'Client-Ip' => '6.6.6.6' }
       end
 
       it 'does not allow to spoof ip' do

data/spec/lib/castle/logger_spec.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+# tmp logger for testing
+class TmpLogger
+  # @param _message [String]
+  def info(_message); end
+end
+
+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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+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"
+    )
+  end
+  let(:request) { Rack::Request.new(env) }
+
+  let(:headers) do
+    { 'Content-Length': '0', 'User-Agent': ua, 'X-Forwarded-For': ip.to_s, 'Cookie': true }
+  end
+  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) do
+    { user_id: '1234', user_traits: { name: 'Jo' }, timestamp: time_formatted, context: context }
+  end
+
+  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/session_spec.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+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 be_eql('secret') }
+end

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

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+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/{cloner_spec.rb → clone_spec.rb}

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-describe Castle::Utils::Cloner do
-  subject(:cloner) { described_class }
+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) { cloner.call(first) }
+    let(:cloned) { clone.call(first) }
 
     before { cloned }
 

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+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

data/spec/lib/castle/utils/{timestamp_spec.rb → get_timestamp_spec.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-describe Castle::Utils::Timestamp do
+describe Castle::Utils::GetTimestamp do
   subject(:timestamp) { described_class.call }
 
   let(:time_string) { '2018-01-10T14:14:24.407Z' }

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+describe Castle::Utils::Merge do
+  subject(:merge) { described_class }
+
+  describe 'call' do
+    let(:first) { { test: { test1: { c: '4' }, test2: { c: '3' }, a: '1', b: '2' } } }
+    let(:second) do
+      { test2: '2', test: { 'test1' => { d: '5' }, :test2 => '6', :a => nil, :b => '3' } }
+    end
+    let(:result) { { test2: '2', test: { test1: { c: '4', d: '5' }, test2: '6', b: '3' } } }
+
+    it { expect(merge.call(first, second)).to be_eql(result) }
+  end
+end

data/spec/lib/castle/validators/present_spec.rb

@@ -8,9 +8,7 @@ describe Castle::Validators::Present do
       let(:keys) { %i[second third] }
 
       it do
-        expect do
-          call
-        end.to raise_error(Castle::InvalidParametersError, 'third is missing or empty')
+        expect { call }.to raise_error(Castle::InvalidParametersError, 'third is missing or empty')
       end
     end
 
@@ -18,9 +16,10 @@ describe Castle::Validators::Present do
       let(:keys) { %i[second invalid] }
 
       it do
-        expect do
-          call
-        end.to raise_error(Castle::InvalidParametersError, 'invalid is missing or empty')
+        expect { call }.to raise_error(
+          Castle::InvalidParametersError,
+          'invalid is missing or empty'
+        )
       end
     end