castle-rb 4.0.0 → 5.0.0

data/spec/lib/castle/api_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 describe Castle::API do
-  subject(:request) { described_class.request(command) }
+  subject(:call) { described_class.call(command) }
 
   let(:command) { Castle::Commands::Track.new({}).build(event: '$login.succeeded') }
 
@@ -10,7 +10,7 @@ describe Castle::API do
 
     it do
       expect do
-        request
+        call
       end.to raise_error(Castle::RequestError)
     end
   end
@@ -20,7 +20,7 @@ describe Castle::API do
 
     it do
       expect do
-        request
+        call
       end.to raise_error(Castle::BadRequestError)
     end
   end
@@ -30,7 +30,7 @@ describe Castle::API do
 
     it do
       expect do
-        request
+        call
       end.to raise_error(Castle::ConfigurationError)
     end
   end

data/spec/lib/castle/client_spec.rb

@@ -82,10 +82,10 @@ describe Castle::Client do
     let(:impersonator) { 'test@castle.io' }
     let(:request_body) do
       { user_id: '1234', timestamp: time_auto, sent_at: time_auto,
-        impersonator: impersonator, context: context }
+        properties: { impersonator: impersonator }, context: context }
     end
     let(:response_body) { { success: true }.to_json }
-    let(:options) { { user_id: '1234', impersonator: impersonator } }
+    let(:options) { { user_id: '1234', properties: { impersonator: impersonator } } }
 
     context 'when used with symbol keys' do
       before { client.impersonate(options) }

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

@@ -36,9 +36,9 @@ describe Castle::Commands::Impersonate do
     end
 
     context 'with impersonator' do
-      let(:payload) { default_payload.merge(impersonator: impersonator) }
+      let(:payload) { default_payload.merge(properties: { impersonator: impersonator }) }
       let(:command_data) do
-        default_payload.merge(impersonator: impersonator, context: context)
+        default_payload.merge(properties: { impersonator: impersonator }, context: context)
       end
 
       it { expect(command.method).to be_eql(:post) }

data/spec/lib/castle/configuration_spec.rb

@@ -2,30 +2,30 @@
 
 describe Castle::Configuration do
   subject(:config) do
-    described_class.new
+    described_class.instance
   end
 
   describe 'host' do
     context 'with default' do
-      it { expect(config.host).to be_eql('api.castle.io') }
+      it { expect(config.url.host).to be_eql('api.castle.io') }
     end
 
     context 'with setter' do
-      before { config.host = 'api.castle.dev' }
+      before { config.url = 'http://api.castle.dev/v2' }
 
-      it { expect(config.host).to be_eql('api.castle.dev') }
+      it { expect(config.url.host).to be_eql('api.castle.dev') }
     end
   end
 
   describe 'post' do
     context 'with default' do
-      it { expect(config.port).to be_eql(443) }
+      it { expect(config.url.port).to be_eql(443) }
     end
 
     context 'with setter' do
-      before { config.port = 3001 }
+      before { config.url = 'http://api.castle.dev:3001/v2' }
 
-      it { expect(config.port).to be_eql(3001) }
+      it { expect(config.url.port).to be_eql(3001) }
     end
   end
 
@@ -38,6 +38,7 @@ describe Castle::Configuration do
         allow(ENV).to receive(:fetch).with(
           'CASTLE_API_SECRET', ''
         ).and_return(secret_key_env)
+        config.reset
       end
 
       it do
@@ -66,7 +67,7 @@ describe Castle::Configuration do
     end
 
     it do
-      expect(config.api_secret).to be_eql('')
+      expect(config.api_secret).to be_eql('secret')
     end
   end
 
@@ -88,34 +89,34 @@ describe Castle::Configuration do
     end
   end
 
-  describe 'whitelisted' do
+  describe 'allowlisted' do
     it do
-      expect(config.whitelisted.size).to be_eql(0)
+      expect(config.allowlisted.size).to be_eql(0)
     end
 
     context 'with setter' do
       before do
-        config.whitelisted = ['header']
+        config.allowlisted = ['header']
       end
 
       it do
-        expect(config.whitelisted).to be_eql(['Header'])
+        expect(config.allowlisted).to be_eql(['Header'])
       end
     end
   end
 
-  describe 'blacklisted' do
+  describe 'denylisted' do
     it do
-      expect(config.blacklisted.size).to be_eql(0)
+      expect(config.denylisted.size).to be_eql(0)
     end
 
     context 'with setter' do
       before do
-        config.blacklisted = ['header']
+        config.denylisted = ['header']
       end
 
       it do
-        expect(config.blacklisted).to be_eql(['Header'])
+        expect(config.denylisted).to be_eql(['Header'])
       end
     end
   end

data/spec/lib/castle/context/default_spec.rb

@@ -4,14 +4,14 @@ describe Castle::Context::Default do
   subject { described_class.new(request, nil) }
 
   let(:ip) { '1.2.3.4' }
-  let(:cookie_id) { 'abcd' }
+  let(:client_id) { 'abcd' }
 
   let(:env) do
     Rack::MockRequest.env_for('/',
                               'HTTP_X_FORWARDED_FOR' => ip,
                               'HTTP_ACCEPT_LANGUAGE' => 'en',
                               'HTTP_USER_AGENT' => 'test',
-                              'HTTP_COOKIE' => "__cid=#{cookie_id};other=efgh")
+                              'HTTP_COOKIE' => "__cid=#{client_id};other=efgh")
   end
   let(:request) { Rack::Request.new(env) }
   let(:default_context) { subject.call }
@@ -34,6 +34,7 @@ describe Castle::Context::Default do
   it { expect(default_context[:origin]).to be_eql('web') }
   it { expect(default_context[:headers]).to be_eql(result_headers) }
   it { expect(default_context[:ip]).to be_eql(ip) }
+  it { expect(default_context[:client_id]).to be_eql(client_id) }
   it { expect(default_context[:library][:name]).to be_eql('castle-rb') }
   it { expect(default_context[:library][:version]).to be_eql(version) }
   it { expect(default_context[:user_agent]).to be_eql('test') }

data/spec/lib/castle/extractors/client_id_spec.rb

@@ -3,7 +3,7 @@
 describe Castle::Extractors::ClientId do
   subject(:extractor) { described_class.new(formatted_headers, cookies) }
 
-  let(:formatted_headers) { Castle::HeaderFilter.new(request).call }
+  let(:formatted_headers) { Castle::HeadersFilter.new(request).call }
   let(:client_id_cookie) { 'abcd' }
   let(:client_id_header) { 'abcde' }
   let(:cookies) { request.cookies }

data/spec/lib/castle/extractors/headers_spec.rb

@@ -3,7 +3,6 @@
 describe Castle::Extractors::Headers do
   subject(:headers) { described_class.new(formatted_headers).call }
 
-  let(:client_id) { 'abcd' }
   let(:formatted_headers) do
     {
       'Content-Length' => '0',
@@ -17,11 +16,11 @@ describe Castle::Extractors::Headers do
   end
 
   after do
-    Castle.config.whitelisted = %w[]
-    Castle.config.blacklisted = %w[]
+    Castle.config.allowlisted = %w[]
+    Castle.config.denylisted = %w[]
   end
 
-  context 'when whitelist is not set in the configuration' do
+  context 'when allowlist is not set in the configuration' do
     let(:result) do
       {
         'Accept' => 'application/json',
@@ -37,8 +36,8 @@ describe Castle::Extractors::Headers do
     it { expect(headers).to eq(result) }
   end
 
-  context 'when whitelist is set in the configuration' do
-    before { Castle.config.whitelisted = %w[Accept OK] }
+  context 'when allowlist is set in the configuration' do
+    before { Castle.config.allowlisted = %w[Accept OK] }
 
     let(:result) do
       {
@@ -55,7 +54,7 @@ describe Castle::Extractors::Headers do
     it { expect(headers).to eq(result) }
   end
 
-  context 'when blacklist is set in the configuration' do
+  context 'when denylist is set in the configuration' do
     context 'with a User-Agent' do
       let(:result) do
         {
@@ -69,7 +68,7 @@ describe Castle::Extractors::Headers do
         }
       end
 
-      before { Castle.config.blacklisted = %w[User-Agent] }
+      before { Castle.config.denylisted = %w[User-Agent] }
 
       it { expect(headers).to eq(result) }
     end
@@ -87,16 +86,16 @@ describe Castle::Extractors::Headers do
         }
       end
 
-      before { Castle.config.blacklisted = %w[Accept] }
+      before { Castle.config.denylisted = %w[Accept] }
 
       it { expect(headers).to eq(result) }
     end
   end
 
-  context 'when a header is both whitelisted and blacklisted' do
+  context 'when a header is both allowlisted and denylisted' do
     before do
-      Castle.config.whitelisted = %w[Accept]
-      Castle.config.blacklisted = %w[Accept]
+      Castle.config.allowlisted = %w[Accept]
+      Castle.config.denylisted = %w[Accept]
     end
 
     it do

data/spec/lib/castle/extractors/ip_spec.rb

@@ -4,6 +4,11 @@ describe Castle::Extractors::IP 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' } }
 
@@ -16,20 +21,20 @@ describe Castle::Extractors::IP do
       end
 
       context 'with uppercase format' do
-        before { Castle.config.ip_headers = %w[CF_CONNECTING_IP] }
+        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] }
+        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' do
+      context 'with value from trusted proxies it get seconds header' do
         before do
-          Castle.config.ip_headers = %w[Cf-Connecting-Ip]
+          Castle.config.ip_headers = %w[Cf-Connecting-Ip X-Forwarded-For]
           Castle.config.trusted_proxies = %w[1.2.3.4]
         end
 
@@ -39,16 +44,44 @@ describe Castle::Extractors::IP do
 
     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'
+        '127.0.0.1,10.0.0.1,172.31.0.1,192.168.0.1'
       end
 
       let(:headers) { { 'Remote-Addr' => '127.0.0.1', 'X-Forwarded-For' => http_x_header } }
 
-      it 'fallbacks to remote_addr even if trusted proxy' do
+      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) do
+        '6.6.6.6, 2.2.2.3, 6.6.6.5'
+      end
+
+      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) do
+        '6.6.6.6, 2.2.2.3, 6.6.6.5'
+      end
+
+      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
         {

data/spec/lib/castle/{header_filter_spec.rb → headers_filter_spec.rb}

@@ -1,28 +1,28 @@
 # frozen_string_literal: true
 
-describe Castle::HeaderFilter do
+describe Castle::HeadersFilter do
   subject(:headers) { described_class.new(request).call }
 
-  let(:client_id) { 'abcd' }
   let(:env) do
-    Rack::MockRequest.env_for(
+    result = Rack::MockRequest.env_for(
       '/',
       'Action-Dispatch.request.content-Type' => 'application/json',
       'HTTP_AUTHORIZATION' => 'Basic 123456',
-      'HTTP_COOKIE' => "__cid=#{client_id};other=efgh",
-      'HTTP_OK' => 'OK',
+      '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'
     )
+    result[:HTTP_OK] = 'OK'
+    result
   end
   let(:filtered) do
     {
       'Accept' => 'application/json',
       'Authorization' => 'Basic 123456',
-      'Cookie' => "__cid=#{client_id};other=efgh",
+      'Cookie' => '__cid=abcd;other=efgh',
       'Content-Length' => '0',
       'Ok' => 'OK',
       'User-Agent' => 'Mozilla 1234',

data/spec/lib/castle/{header_formatter_spec.rb → headers_formatter_spec.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-describe Castle::HeaderFormatter do
-  subject(:formatter) { described_class.new }
+describe Castle::HeadersFormatter do
+  subject(:formatter) { described_class }
 
   it 'removes HTTP_' do
     expect(formatter.call('HTTP_X_TEST')).to be_eql('X-Test')

data/spec/spec_helper.rb

@@ -16,8 +16,7 @@ WebMock.disable_net_connect!(allow_localhost: true)
 
 RSpec.configure do |config|
   config.before do
-    Castle.instance_variable_set(:@configuration, Castle::Configuration.new)
-
+    Castle.config.reset
     Castle.configure do |cfg|
       cfg.api_secret = 'secret'
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: castle-rb
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Johan Brissmyr
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-20 00:00:00.000000000 Z
+date: 2020-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal
@@ -34,9 +34,10 @@ files:
 - lib/castle-rb.rb
 - lib/castle.rb
 - lib/castle/api.rb
+- lib/castle/api/connection.rb
 - lib/castle/api/request.rb
-- lib/castle/api/request/build.rb
 - lib/castle/api/response.rb
+- lib/castle/api/session.rb
 - lib/castle/client.rb
 - lib/castle/command.rb
 - lib/castle/commands/authenticate.rb
@@ -54,8 +55,8 @@ files:
 - lib/castle/extractors/headers.rb
 - lib/castle/extractors/ip.rb
 - lib/castle/failover_auth_response.rb
-- lib/castle/header_filter.rb
-- lib/castle/header_formatter.rb
+- lib/castle/headers_filter.rb
+- lib/castle/headers_formatter.rb
 - lib/castle/review.rb
 - lib/castle/secure_mode.rb
 - lib/castle/support/hanami.rb
@@ -73,9 +74,10 @@ files:
 - spec/integration/rails/support/all.rb
 - spec/integration/rails/support/application.rb
 - spec/integration/rails/support/home_controller.rb
-- spec/lib/castle/api/request/build_spec.rb
+- spec/lib/castle/api/connection_spec.rb
 - spec/lib/castle/api/request_spec.rb
 - spec/lib/castle/api/response_spec.rb
+- spec/lib/castle/api/session_spec.rb
 - spec/lib/castle/api_spec.rb
 - spec/lib/castle/client_spec.rb
 - spec/lib/castle/command_spec.rb
@@ -92,8 +94,8 @@ files:
 - spec/lib/castle/extractors/client_id_spec.rb
 - spec/lib/castle/extractors/headers_spec.rb
 - spec/lib/castle/extractors/ip_spec.rb
-- spec/lib/castle/header_filter_spec.rb
-- spec/lib/castle/header_formatter_spec.rb
+- spec/lib/castle/headers_filter_spec.rb
+- spec/lib/castle/headers_formatter_spec.rb
 - spec/lib/castle/review_spec.rb
 - spec/lib/castle/secure_mode_spec.rb
 - spec/lib/castle/utils/cloner_spec.rb
@@ -109,7 +111,7 @@ homepage: https://castle.io
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -124,8 +126,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.1.3
+signing_key:
 specification_version: 4
 summary: Castle
 test_files:
@@ -136,6 +138,7 @@ test_files:
 - spec/integration/rails/rails_spec.rb
 - spec/lib/castle_spec.rb
 - spec/lib/castle/review_spec.rb
+- spec/lib/castle/headers_filter_spec.rb
 - spec/lib/castle/client_spec.rb
 - spec/lib/castle/context/default_spec.rb
 - spec/lib/castle/context/merger_spec.rb
@@ -143,15 +146,15 @@ test_files:
 - spec/lib/castle/api_spec.rb
 - spec/lib/castle/configuration_spec.rb
 - spec/lib/castle/version_spec.rb
-- spec/lib/castle/header_formatter_spec.rb
 - spec/lib/castle/utils/cloner_spec.rb
 - spec/lib/castle/utils/timestamp_spec.rb
 - spec/lib/castle/utils/merger_spec.rb
 - spec/lib/castle/command_spec.rb
+- spec/lib/castle/headers_formatter_spec.rb
+- spec/lib/castle/api/session_spec.rb
 - spec/lib/castle/api/request_spec.rb
+- spec/lib/castle/api/connection_spec.rb
 - spec/lib/castle/api/response_spec.rb
-- spec/lib/castle/api/request/build_spec.rb
-- spec/lib/castle/header_filter_spec.rb
 - spec/lib/castle/commands/review_spec.rb
 - spec/lib/castle/commands/authenticate_spec.rb
 - spec/lib/castle/commands/track_spec.rb