castle-rb 3.4.0 → 3.4.1

data/lib/castle/context/sanitizer.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Castle
+  module Context
+    # removes not proper active flag values
+    class Sanitizer
+      class << self
+        def call(context)
+          sanitized_active_mode(context) || {}
+        end
+
+        private
+
+        def sanitized_active_mode(context)
+          return unless context
+          return context unless context.key?(:active)
+          return context if [true, false].include?(context[:active])
+          context.reject { |key| key == :active }
+        end
+      end
+    end
+  end
+end

data/lib/castle/review.rb

@@ -3,7 +3,7 @@
 module Castle
   class Review
     def self.retrieve(review_id)
-      command = Castle::Commands::Review.new.build(review_id)
+      command = Castle::Commands::Review.build(review_id)
 
       API.new.request(command)
     end

data/lib/castle/utils/merger.rb

@@ -3,20 +3,20 @@
 module Castle
   module Utils
     class Merger
-      def self.call(first, second)
-        first_s = Castle::Utils.deep_symbolize_keys(first)
-        second_s = Castle::Utils.deep_symbolize_keys(second)
+      def self.call(base, extra)
+        base_s = Castle::Utils.deep_symbolize_keys(base)
+        extra_s = Castle::Utils.deep_symbolize_keys(extra)
 
-        second_s.each do |name, value|
+        extra_s.each do |name, value|
           if value.nil?
-            first_s.delete(name)
-          elsif value.is_a?(Hash) && first_s[name].is_a?(Hash)
-            first_s[name] = call(first_s[name], value)
+            base_s.delete(name)
+          elsif value.is_a?(Hash) && base_s[name].is_a?(Hash)
+            base_s[name] = call(base_s[name], value)
           else
-            first_s[name] = value
+            base_s[name] = value
           end
         end
-        first_s
+        base_s
       end
     end
   end

data/lib/castle/validators/not_supported.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Castle
+  module Validators
+    class NotSupported
+      class << self
+        def call(options, keys)
+          keys.each do |key|
+            next unless options.key?(key)
+            raise Castle::InvalidParametersError, "#{key} is/are not supported"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/castle/validators/present.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Castle
+  module Validators
+    class Present
+      class << self
+        def call(options, keys)
+          keys.each do |key|
+            next unless options[key].to_s.empty?
+            raise Castle::InvalidParametersError, "#{key} is missing or empty"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/castle/version.rb

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

data/spec/lib/castle/client_spec.rb

@@ -76,7 +76,8 @@ describe Castle::Client do
   describe 'impersonate' do
     let(:impersonator) { 'test@castle.io' }
     let(:request_body) do
-      { user_id: '1234', impersonator: impersonator, context: context }
+      { user_id: '1234', timestamp: time_auto, sent_at: time_auto,
+        impersonator: impersonator, context: context }
     end
     let(:options) { { user_id: '1234', impersonator: impersonator } }
 
@@ -255,7 +256,7 @@ describe Castle::Client do
     context 'when request is internal server error' do
       before { allow(client.api).to receive(:request).and_raise(Castle::InternalServerError) }
 
-      context 'throw strategy' do
+      describe 'throw strategy' do
         before { allow(Castle.config).to receive(:failover_strategy).and_return(:throw) }
 
         it { expect { request_response }.to raise_error(Castle::InternalServerError) }

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

@@ -15,10 +15,10 @@ describe Castle::Commands::Authenticate do
   describe '.build' do
     subject(:command) { instance.build(payload) }
 
-    context 'simple merger' do
-      let(:payload) { default_payload.merge({ context: { test: { test2: '1' } } }) }
+    context 'with simple merger' do
+      let(:payload) { default_payload.merge(context: { test: { test2: '1' } }) }
       let(:command_data) do
-        default_payload.merge({ context: { test: { test1: '1', test2: '1' } } })
+        default_payload.merge(context: { test: { test1: '1', test2: '1' } })
       end
 
       it { expect(command.method).to be_eql(:post) }
@@ -26,10 +26,10 @@ describe Castle::Commands::Authenticate do
       it { expect(command.data).to be_eql(command_data) }
     end
 
-    context 'properties' do
-      let(:payload) { default_payload.merge({ properties: { test: '1' } }) }
+    context 'with properties' do
+      let(:payload) { default_payload.merge(properties: { test: '1' }) }
       let(:command_data) do
-        default_payload.merge({ properties: { test: '1' }, context: context })
+        default_payload.merge(properties: { test: '1' }, context: context)
       end
 
       it { expect(command.method).to be_eql(:post) }
@@ -37,10 +37,10 @@ describe Castle::Commands::Authenticate do
       it { expect(command.data).to be_eql(command_data) }
     end
 
-    context 'traits' do
-      let(:payload) { default_payload.merge({ traits: { test: '1' } }) }
+    context 'with traits' do
+      let(:payload) { default_payload.merge(traits: { test: '1' }) }
       let(:command_data) do
-        default_payload.merge({ traits: { test: '1' }, context: context })
+        default_payload.merge(traits: { test: '1' }, context: context)
       end
 
       it { expect(command.method).to be_eql(:post) }
@@ -48,10 +48,10 @@ describe Castle::Commands::Authenticate do
       it { expect(command.data).to be_eql(command_data) }
     end
 
-    context 'active true' do
-      let(:payload) { default_payload.merge({ context: { active: true } }) }
+    context 'when active true' do
+      let(:payload) { default_payload.merge(context: { active: true }) }
       let(:command_data) do
-        default_payload.merge({ context: context.merge(active: true) })
+        default_payload.merge(context: context.merge(active: true))
       end
 
       it { expect(command.method).to be_eql(:post) }
@@ -59,10 +59,10 @@ describe Castle::Commands::Authenticate do
       it { expect(command.data).to be_eql(command_data) }
     end
 
-    context 'active false' do
-      let(:payload) { default_payload.merge({ context: { active: false } }) }
+    context 'when active false' do
+      let(:payload) { default_payload.merge(context: { active: false }) }
       let(:command_data) do
-        default_payload.merge({ context: context.merge(active: false) })
+        default_payload.merge(context: context.merge(active: false))
       end
 
       it { expect(command.method).to be_eql(:post) }
@@ -70,9 +70,9 @@ describe Castle::Commands::Authenticate do
       it { expect(command.data).to be_eql(command_data) }
     end
 
-    context 'active string' do
-      let(:payload) { default_payload.merge({ context: { active: 'string' } }) }
-      let(:command_data) { default_payload.merge({ context: context }) }
+    context 'when active string' do
+      let(:payload) { default_payload.merge(context: { active: 'string' }) }
+      let(:command_data) { default_payload.merge(context: context) }
 
       it { expect(command.method).to be_eql(:post) }
       it { expect(command.path).to be_eql('authenticate') }
@@ -83,7 +83,7 @@ describe Castle::Commands::Authenticate do
   describe '#validate!' do
     subject(:validate!) { instance.build(payload) }
 
-    context 'event not present' do
+    context 'with event not present' do
       let(:payload) { {} }
 
       it do
@@ -93,7 +93,7 @@ describe Castle::Commands::Authenticate do
       end
     end
 
-    context 'user_id not present' do
+    context 'with user_id not present' do
       let(:payload) { { event: '$login.track' } }
 
       it do
@@ -103,7 +103,7 @@ describe Castle::Commands::Authenticate do
       end
     end
 
-    context 'event and user_id present' do
+    context 'with event and user_id present' do
       let(:payload) { { event: '$login.track', user_id: '1234' } }
 
       it { expect { validate! }.not_to raise_error }

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

@@ -15,10 +15,10 @@ describe Castle::Commands::Identify do
   describe '.build' do
     subject(:command) { instance.build(payload) }
 
-    context 'simple merger' do
-      let(:payload) { default_payload.merge({ context: { test: { test2: '1' } } }) }
+    context 'with simple merger' do
+      let(:payload) { default_payload.merge(context: { test: { test2: '1' } }) }
       let(:command_data) do
-        default_payload.merge({ context: { test: { test1: '1', test2: '1' } } })
+        default_payload.merge(context: { test: { test1: '1', test2: '1' } })
       end
 
       it { expect(command.method).to be_eql(:post) }
@@ -26,10 +26,10 @@ describe Castle::Commands::Identify do
       it { expect(command.data).to be_eql(command_data) }
     end
 
-    context 'traits' do
-      let(:payload) { default_payload.merge({ traits: { test: '1' } }) }
+    context 'with traits' do
+      let(:payload) { default_payload.merge(traits: { test: '1' }) }
       let(:command_data) do
-        default_payload.merge({ traits: { test: '1' }, context: context })
+        default_payload.merge(traits: { test: '1' }, context: context)
       end
 
       it { expect(command.method).to be_eql(:post) }
@@ -37,10 +37,10 @@ describe Castle::Commands::Identify do
       it { expect(command.data).to be_eql(command_data) }
     end
 
-    context 'active true' do
-      let(:payload) { default_payload.merge({ context: { active: true } }) }
+    context 'when active true' do
+      let(:payload) { default_payload.merge(context: { active: true }) }
       let(:command_data) do
-        default_payload.merge({ context: context.merge(active: true) })
+        default_payload.merge(context: context.merge(active: true))
       end
 
       it { expect(command.method).to be_eql(:post) }
@@ -48,10 +48,10 @@ describe Castle::Commands::Identify do
       it { expect(command.data).to be_eql(command_data) }
     end
 
-    context 'active false' do
-      let(:payload) { default_payload.merge({ context: { active: false } }) }
+    context 'when active false' do
+      let(:payload) { default_payload.merge(context: { active: false }) }
       let(:command_data) do
-        default_payload.merge({ context: context.merge(active: false) })
+        default_payload.merge(context: context.merge(active: false))
       end
 
       it { expect(command.method).to be_eql(:post) }
@@ -59,9 +59,9 @@ describe Castle::Commands::Identify do
       it { expect(command.data).to be_eql(command_data) }
     end
 
-    context 'active string' do
-      let(:payload) { default_payload.merge({ context: { active: 'string' } }) }
-      let(:command_data) { default_payload.merge({ context: context }) }
+    context 'when active string' do
+      let(:payload) { default_payload.merge(context: { active: 'string' }) }
+      let(:command_data) { default_payload.merge(context: context) }
 
       it { expect(command.method).to be_eql(:post) }
       it { expect(command.path).to be_eql('identify') }
@@ -72,7 +72,7 @@ describe Castle::Commands::Identify do
   describe '#validate!' do
     subject(:validate!) { instance.build(payload) }
 
-    context 'user_id not present' do
+    context 'with user_id not present' do
       let(:payload) { {} }
 
       it do
@@ -82,7 +82,7 @@ describe Castle::Commands::Identify do
       end
     end
 
-    context 'user_id present' do
+    context 'with user_id present' do
       let(:payload) { { user_id: '1234' } }
 
       it { expect { validate! }.not_to raise_error }

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

@@ -5,7 +5,7 @@ describe Castle::Commands::Impersonate do
 
   let(:context) { { user_agent: 'test', ip: '127.0.0.1', client_id: 'test' } }
   let(:impersonator) { 'test@castle.io' }
-  let(:default_payload) { { user_id: '1234' } }
+  let(:default_payload) { { user_id: '1234', sent_at: time_auto } }
 
   let(:time_now) { Time.now }
   let(:time_auto) { time_now.utc.iso8601(3) }

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 describe Castle::Commands::Review do
-  subject(:instance) { described_class.new }
+  subject(:instance) { described_class }
 
   let(:context) { {} }
   let(:review_id) { '1234' }

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

@@ -15,10 +15,10 @@ describe Castle::Commands::Track do
   describe '#build' do
     subject(:command) { instance.build(payload) }
 
-    context 'simple merger' do
-      let(:payload) { default_payload.merge({ context: { test: { test2: '1' } } }) }
+    context 'with simple merger' do
+      let(:payload) { default_payload.merge(context: { test: { test2: '1' } }) }
       let(:command_data) do
-        default_payload.merge({ context: { test: { test1: '1', test2: '1' } } })
+        default_payload.merge(context: { test: { test1: '1', test2: '1' } })
       end
 
       it { expect(command.method).to be_eql(:post) }
@@ -26,10 +26,10 @@ describe Castle::Commands::Track do
       it { expect(command.data).to be_eql(command_data) }
     end
 
-    context 'user_id' do
-      let(:payload) { default_payload.merge({ user_id: '1234' }) }
+    context 'with user_id' do
+      let(:payload) { default_payload.merge(user_id: '1234') }
       let(:command_data) do
-        default_payload.merge({ user_id: '1234', context: context })
+        default_payload.merge(user_id: '1234', context: context)
       end
 
       it { expect(command.method).to be_eql(:post) }
@@ -37,10 +37,10 @@ describe Castle::Commands::Track do
       it { expect(command.data).to be_eql(command_data) }
     end
 
-    context 'properties' do
-      let(:payload) { default_payload.merge({ properties: { test: '1' } }) }
+    context 'with properties' do
+      let(:payload) { default_payload.merge(properties: { test: '1' }) }
       let(:command_data) do
-        default_payload.merge({ properties: { test: '1' }, context: context })
+        default_payload.merge(properties: { test: '1' }, context: context)
       end
 
       it { expect(command.method).to be_eql(:post) }
@@ -48,10 +48,10 @@ describe Castle::Commands::Track do
       it { expect(command.data).to be_eql(command_data) }
     end
 
-    context 'traits' do
-      let(:payload) { default_payload.merge({ traits: { test: '1' } }) }
+    context 'with traits' do
+      let(:payload) { default_payload.merge(traits: { test: '1' }) }
       let(:command_data) do
-        default_payload.merge({ traits: { test: '1' }, context: context })
+        default_payload.merge(traits: { test: '1' }, context: context)
       end
 
       it { expect(command.method).to be_eql(:post) }
@@ -59,10 +59,10 @@ describe Castle::Commands::Track do
       it { expect(command.data).to be_eql(command_data) }
     end
 
-    context 'active true' do
-      let(:payload) { default_payload.merge({ context: { active: true } }) }
+    context 'when active true' do
+      let(:payload) { default_payload.merge(context: { active: true }) }
       let(:command_data) do
-        default_payload.merge({ context: context.merge(active: true) })
+        default_payload.merge(context: context.merge(active: true))
       end
 
       it { expect(command.method).to be_eql(:post) }
@@ -70,10 +70,10 @@ describe Castle::Commands::Track do
       it { expect(command.data).to be_eql(command_data) }
     end
 
-    context 'active false' do
-      let(:payload) { default_payload.merge({ context: { active: false } }) }
+    context 'when active false' do
+      let(:payload) { default_payload.merge(context: { active: false }) }
       let(:command_data) do
-        default_payload.merge({ context: context.merge(active: false) })
+        default_payload.merge(context: context.merge(active: false))
       end
 
       it { expect(command.method).to be_eql(:post) }
@@ -81,9 +81,9 @@ describe Castle::Commands::Track do
       it { expect(command.data).to be_eql(command_data) }
     end
 
-    context 'active string' do
-      let(:payload) { default_payload.merge({ context: { active: 'string' } }) }
-      let(:command_data) { default_payload.merge({ context: context }) }
+    context 'when active string' do
+      let(:payload) { default_payload.merge(context: { active: 'string' }) }
+      let(:command_data) { default_payload.merge(context: context) }
 
       it { expect(command.method).to be_eql(:post) }
       it { expect(command.path).to be_eql('track') }
@@ -94,7 +94,7 @@ describe Castle::Commands::Track do
   describe '#validate!' do
     subject(:validate!) { instance.build(payload) }
 
-    context 'event not present' do
+    context 'when event not present' do
       let(:payload) { {} }
 
       it do
@@ -104,7 +104,7 @@ describe Castle::Commands::Track do
       end
     end
 
-    context 'event present' do
+    context 'when event present' do
       let(:payload) { { event: '$login.track' } }
 
       it { expect { validate! }.not_to raise_error }