Merge pull request #119 from castle/user-traits-change

rename traits to user_traits

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## master
 
+**BREAKING CHANGES:**
+
+- [#119](github.com/castle/castle-ruby/pull/119) usage of `traits` key is deprecated, use `user_traits` instead
+
 ## 3.4.2 (2018-02-26)
 
 **Features:**

README.md

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

lib/castle/client.rb

@@ -17,6 +17,7 @@ def to_context(request, options = {})
 
       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
 

spec/lib/castle/client_spec.rb

@@ -65,8 +65,8 @@
   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)
@@ -95,13 +95,13 @@
   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 +111,9 @@
 
       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 +128,7 @@
         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 +140,7 @@
     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|

spec/lib/castle/commands/authenticate_spec.rb

@@ -37,10 +37,10 @@
       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) }

spec/lib/castle/commands/identify_spec.rb

@@ -26,10 +26,10 @@
       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) }

spec/lib/castle/commands/track_spec.rb

@@ -48,10 +48,10 @@
       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) }