castle-rb 3.4.2 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84dd494b50643e628c57809953e2bb59fa25a5a550dd8b1d58bb712e11a81604
-  data.tar.gz: 56e6bb84867531074995a550573e9790e9d5a6638931ac77fb83c590cbbc5204
+  metadata.gz: 6376098ba7a5b711d926fe187c38d2ed31a68b7ddf53024f2d51a81a14482604
+  data.tar.gz: b4ca1f4dbd10607b5c5bfad6a9b7528d3ebb8ebf7a2b6fd1287af08333b110d4
 SHA512:
-  metadata.gz: cb4fca490621a4e3349ce70a7036e62a4fa695d45964614308eb34a2024afdb3e333402fc10468e9e66fae24a972388366c078a665e41c73136068021687b7cf
-  data.tar.gz: 640e52eed4f09cc4060fe6e40e38d2500849640133671fe171fb35e589df0aee27134431630e16bfd03b76b3239f6f3b5fce8b427f468b2d7a3139ce1d29b8f1
+  metadata.gz: 70c04aa5f1d0f3f4af5789a7aad877380b3d82fafbd935ec746bd40aab904c110bea4410d161c48521fee108a5212c7d81b8a00b465b82940e7f6f9c48236f26
+  data.tar.gz: 345383199ba415d699f97f1ebf242d21dc8e1eb921a4c60f6366464a1e6bc5b5ac0680d7010e6f2b4b9ff5366393c9fd9b70237951ac7b013328e05af3af11b7

data/README.md

@@ -128,7 +128,7 @@ track_options = ::Castle::Client.to_options({
   properties: {
     key: 'value'
   },
-  traits: {
+  user_traits: {
     key: 'value'
   }
 })

data/lib/castle/client.rb

@@ -17,6 +17,7 @@ module Castle
 
       def to_options(options = {})
         options[:timestamp] ||= Castle::Utils::Timestamp.call
+        warn '[DEPRECATION] use user_traits instead of traits key' if options.key?(:traits)
         options
       end
 
@@ -80,7 +81,9 @@ module Castle
       options = Castle::Utils.deep_symbolize_keys(options || {})
       add_timestamp_if_necessary(options)
       command = Castle::Commands::Impersonate.new(@context).build(options)
-      @api.request(command)
+      @api.request(command).tap do |response|
+        raise Castle::ImpersonationFailed unless response[:success]
+      end
     end
 
     def disable_tracking

data/lib/castle/configuration.rb

@@ -65,8 +65,8 @@ module Castle
       /^(\w+)=$/ =~ method_name
     end
 
-    def method_missing(m, *_args)
-      raise Castle::ConfigurationError, "there is no such a config #{m}"
+    def method_missing(setting, *_args)
+      raise Castle::ConfigurationError, "there is no such a config #{setting}"
     end
   end
 end

data/lib/castle/context/default.rb

@@ -4,7 +4,7 @@ module Castle
   module Context
     class Default
       def initialize(request, cookies = nil)
-        @client_id = Extractors::ClientId.new(request, cookies || request.cookies).call('__cid')
+        @client_id = Extractors::ClientId.new(request, cookies || request.cookies).call
         @headers = Extractors::Headers.new(request).call
         @request_ip = Extractors::IP.new(request).call
       end

data/lib/castle/errors.rb

@@ -26,4 +26,7 @@ module Castle
   class UnauthorizedError < Castle::ApiError; end
   # all internal server errors
   class InternalServerError < Castle::ApiError; end
+
+  # impersonation command failed
+  class ImpersonationFailed < Castle::ApiError; end
 end

data/lib/castle/extractors/client_id.rb

@@ -9,9 +9,8 @@ module Castle
         @cookies = cookies || {}
       end
 
-      def call(name)
-        @cookies[name] ||
-          @request.env.fetch('HTTP_X_CASTLE_CLIENT_ID', '')
+      def call
+        @request.env['HTTP_X_CASTLE_CLIENT_ID'] || @cookies['__cid'] || ''
       end
     end
   end

data/lib/castle/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Castle
-  VERSION = '3.4.2'
+  VERSION = '3.5.0'
 end

data/spec/lib/castle/client_spec.rb

@@ -36,13 +36,14 @@ describe Castle::Client do
   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')
     stub_request(:any, /api.castle.io/).with(
       basic_auth: ['', 'secret']
-    ).to_return(status: 200, body: '{}', headers: {})
+    ).to_return(status: 200, body: response_body, headers: {})
   end
 
   after { Timecop.return }
@@ -65,8 +66,8 @@ describe Castle::Client do
   end
 
   describe 'to_options' do
-    let(:options) { { user_id: '1234', traits: { name: 'Jo' } } }
-    let(:result) { { user_id: '1234', traits: { name: 'Jo' }, timestamp: time_auto } }
+    let(:options) { { user_id: '1234', user_traits: { name: 'Jo' } } }
+    let(:result) { { user_id: '1234', user_traits: { name: 'Jo' }, timestamp: time_auto } }
 
     it do
       expect(described_class.to_options(options)).to eql(result)
@@ -79,29 +80,36 @@ describe Castle::Client do
       { user_id: '1234', timestamp: time_auto, sent_at: time_auto,
         impersonator: impersonator, context: context }
     end
+    let(:response_body) { { success: true }.to_json }
     let(:options) { { user_id: '1234', impersonator: impersonator } }
 
-    before { client.impersonate(options) }
-
     context 'when used with symbol keys' do
+      before { client.impersonate(options) }
+
       it do
         assert_requested :post, '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 { client.impersonate(options) }.to raise_error(Castle::ImpersonationFailed) }
+    end
   end
 
   describe 'identify' do
     let(:request_body) do
       { user_id: '1234', timestamp: time_auto,
-        sent_at: time_auto, context: context, traits: { name: 'Jo' } }
+        sent_at: time_auto, context: context, user_traits: { name: 'Jo' } }
     end
 
     before { client.identify(options) }
 
     context 'when used with symbol keys' do
-      let(:options) { { user_id: '1234', traits: { name: 'Jo' } } }
+      let(:options) { { user_id: '1234', user_traits: { name: 'Jo' } } }
 
       it do
         assert_requested :post, 'https://api.castle.io/v1/identify', times: 1 do |req|
@@ -111,9 +119,9 @@ describe Castle::Client do
 
       context 'when passed timestamp in options and no defined timestamp' do
         let(:client) { client_with_no_timestamp }
-        let(:options) { { user_id: '1234', traits: { name: 'Jo' }, timestamp: time_user } }
+        let(:options) { { user_id: '1234', user_traits: { name: 'Jo' }, timestamp: time_user } }
         let(:request_body) do
-          { user_id: '1234', traits: { name: 'Jo' }, context: context,
+          { user_id: '1234', user_traits: { name: 'Jo' }, context: context,
             timestamp: time_user, sent_at: time_auto }
         end
 
@@ -128,7 +136,7 @@ describe Castle::Client do
         let(:client) { client_with_user_timestamp }
         let(:request_body) do
           { user_id: '1234', timestamp: time_user, sent_at: time_auto,
-            context: context, traits: { name: 'Jo' } }
+            context: context, user_traits: { name: 'Jo' } }
         end
 
         it do
@@ -140,7 +148,7 @@ describe Castle::Client do
     end
 
     context 'when used with string keys' do
-      let(:options) { { 'user_id' => '1234', 'traits' => { 'name' => 'Jo' } } }
+      let(:options) { { 'user_id' => '1234', 'user_traits' => { 'name' => 'Jo' } } }
 
       it do
         assert_requested :post, 'https://api.castle.io/v1/identify', times: 1 do |req|

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

@@ -37,10 +37,10 @@ describe Castle::Commands::Authenticate do
       it { expect(command.data).to be_eql(command_data) }
     end
 
-    context 'with traits' do
-      let(:payload) { default_payload.merge(traits: { test: '1' }) }
+    context 'with user_traits' do
+      let(:payload) { default_payload.merge(user_traits: { test: '1' }) }
       let(:command_data) do
-        default_payload.merge(traits: { test: '1' }, context: context)
+        default_payload.merge(user_traits: { test: '1' }, context: context)
       end
 
       it { expect(command.method).to be_eql(:post) }

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

@@ -26,10 +26,10 @@ describe Castle::Commands::Identify do
       it { expect(command.data).to be_eql(command_data) }
     end
 
-    context 'with traits' do
-      let(:payload) { default_payload.merge(traits: { test: '1' }) }
+    context 'with user_traits' do
+      let(:payload) { default_payload.merge(user_traits: { test: '1' }) }
       let(:command_data) do
-        default_payload.merge(traits: { test: '1' }, context: context)
+        default_payload.merge(user_traits: { test: '1' }, context: context)
       end
 
       it { expect(command.method).to be_eql(:post) }

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

@@ -48,10 +48,10 @@ describe Castle::Commands::Track do
       it { expect(command.data).to be_eql(command_data) }
     end
 
-    context 'with traits' do
-      let(:payload) { default_payload.merge(traits: { test: '1' }) }
+    context 'with user_traits' do
+      let(:payload) { default_payload.merge(user_traits: { test: '1' }) }
       let(:command_data) do
-        default_payload.merge(traits: { test: '1' }, context: context)
+        default_payload.merge(user_traits: { test: '1' }, context: context)
       end
 
       it { expect(command.method).to be_eql(:post) }

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

@@ -3,7 +3,8 @@
 describe Castle::Extractors::ClientId do
   subject(:extractor) { described_class.new(request, cookies) }
 
-  let(:client_id) { 'abcd' }
+  let(:client_id_cookie) { 'abcd' }
+  let(:client_id_header) { 'abcde' }
   let(:cookies) { request.cookies }
   let(:request) { Rack::Request.new(env) }
   let(:env) do
@@ -14,12 +15,12 @@ describe Castle::Extractors::ClientId do
     let(:headers) do
       {
         'HTTP_X_FORWARDED_FOR' => '1.2.3.4',
-        'HTTP_COOKIE' => "__cid=#{client_id};other=efgh"
+        'HTTP_COOKIE' => "__cid=#{client_id_cookie};other=efgh"
       }
     end
 
     it do
-      expect(extractor.call('__cid')).to eql(client_id)
+      expect(extractor.call).to eql(client_id_cookie)
     end
   end
 
@@ -27,12 +28,12 @@ describe Castle::Extractors::ClientId do
     let(:headers) do
       {
         'HTTP_X_FORWARDED_FOR' => '1.2.3.4',
-        'HTTP_X_CASTLE_CLIENT_ID' => client_id
+        'HTTP_X_CASTLE_CLIENT_ID' => client_id_header
       }
     end
 
     it 'appends the client_id' do
-      expect(extractor.call('__cid')).to eql(client_id)
+      expect(extractor.call).to eql(client_id_header)
     end
   end
 
@@ -41,7 +42,21 @@ describe Castle::Extractors::ClientId do
     let(:headers) { {} }
 
     it do
-      expect(extractor.call('__cid')).to eql('')
+      expect(extractor.call).to eql('')
+    end
+  end
+
+  context 'with X-Castle-Client-Id header and cookies client' do
+    let(:headers) do
+      {
+        'HTTP_X_FORWARDED_FOR' => '1.2.3.4',
+        'HTTP_X_CASTLE_CLIENT_ID' => client_id_header,
+        'HTTP_COOKIE' => "__cid=#{client_id_cookie};other=efgh"
+      }
+    end
+
+    it 'appends the client_id' do
+      expect(extractor.call).to eql(client_id_header)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: castle-rb
 version: !ruby/object:Gem::Version
-  version: 3.4.2
+  version: 3.5.0
 platform: ruby
 authors:
 - Johan Brissmyr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-26 00:00:00.000000000 Z
+date: 2018-04-18 00:00:00.000000000 Z
 dependencies: []
 description: Castle protects your users from account compromise
 email: johan@castle.io
@@ -101,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: Castle