fluent-plugin-amplitude 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 151e2c0afc12d5647faa456efe7e679050d5a251
-  data.tar.gz: abdda1c6803826eb6df78d8283d9ef1ea7004f4b
+  metadata.gz: ce23650ea41be224d3c3cace3bc46ecd231868e7
+  data.tar.gz: 9c51f42644f97118db2ff87001d9109d118a0f6a
 SHA512:
-  metadata.gz: c07e35b6e4fd5147796bee6dc3270ff0bbf486e26bc405f71675dee9972f807a6a4773c5983baadd7643c559155f9e04ada15d81c506e523df460ea0cd048558
-  data.tar.gz: 51b777c6ea536b11e7a5d1d704346a4cca5261946e462e08c3672cabe6d72025a4d0b19dcb6da1ffedcd362562bd17999030637300a2c4bd8c517286731dbdf2
+  metadata.gz: bdfe8433824bbed0fc3eaf4f84d625c54f1a8262b541d11730d28939a857c4e834320dfac4414131cf0501e21401f9c131e93cbc7667ff14e3bcc977132f22ac
+  data.tar.gz: da8cda4768e715a4cbfd58f4acc18029b35677a5d8e1c2cd19141d7d8aa2e2275022111b4a685d49ee43951714f427d59cd4628c2a1d6c59900f26721a045b29

data/README.md

@@ -41,7 +41,7 @@ $ sudo /usr/lib64/fluent/ruby/bin/fluent-gem install fluent-plugin-amplitude
 AmplitudeOutput needs your Amplitude `api_key` ([see Amplitude for more information](https://amplitude.zendesk.com/hc/en-us/articles/206728448-Where-can-I-find-my-app-s-API-Key-or-Secret-Key-))
 
 #### user_id_key and device_id_key
-You must set at least one of `user_id_key` and `device_id_key`. They will be used to pull out the `user_id` and `device_id` values from the record to send to the Amplitude API.
+You must set at least one of `user_id_key` and `device_id_key`. They will be used to pull out the `user_id` and `device_id` values from the record to send to the Amplitude API. Note these can both be arrays, and the first matching key will be used.
 
 #### user_properties and event_properties
 You can optionally specify lists of `user_properties` and `event_properties` to pull from the record.

data/fluent-plugin-amplitude.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'fluent-plugin-amplitude'
-  spec.version       = '0.0.4'
+  spec.version       = '0.0.5'
   spec.authors       = ['Vijay Ramesh']
   spec.email         = ['vijay@change.org']
   spec.summary       = 'Fluentd plugin to output event data to Amplitude'

data/lib/fluent/plugin/out_amplitude.rb

@@ -8,8 +8,8 @@ module Fluent
     include FakeActiveSupport
 
     config_param :api_key, :string, secret: true
-    config_param :device_id_key, :string
-    config_param :user_id_key, :string
+    config_param :device_id_key, :array, default: nil
+    config_param :user_id_key, :array, default: nil
     config_param :user_properties, :array, default: nil
     config_param :event_properties, :array, default: nil
     config_param :properties_blacklist, :array, default: nil
@@ -66,12 +66,21 @@ module Fluent
     end
 
     def extract_user_and_device_or_fail!(amplitude_hash, record)
-      if @user_id_key && record[@user_id_key]
-        amplitude_hash[:user_id] = record.delete(@user_id_key)
+      if @user_id_key
+        @user_id_key.each do |user_id_key|
+          if record[user_id_key]
+            amplitude_hash[:user_id] = record.delete(user_id_key)
+            break
+          end
+        end
       end
-
-      if @device_id_key && record[@device_id_key]
-        amplitude_hash[:device_id] = record.delete(@device_id_key)
+      if @device_id_key
+        @device_id_key.each do |device_id_key|
+          if record[device_id_key]
+            amplitude_hash[:device_id] = record.delete(device_id_key)
+            break
+          end
+        end
       end
 
       verify_user_and_device_or_fail(amplitude_hash)

data/spec/out_amplitude_spec.rb

@@ -206,5 +206,91 @@ describe Fluent::AmplitudeOutput do
         amplitude.run
       end
     end
+
+    context 'multiple user_id_key specified' do
+      let(:conf) do
+        %(
+          api_key XXXXXX
+          user_id_key user_id, another_user_id_field
+          device_id_key uuid
+          user_properties first_name, last_name
+          event_properties current_source
+        )
+      end
+      let(:event) do
+        {
+          'another_user_id_field' => 42,
+          'uuid' => 'e6153b00-85d8-11e6-b1bc-43192d1e493f',
+          'first_name' => 'Bobby',
+          'last_name' => 'Weir',
+          'state' => 'CA',
+          'current_source' => 'fb_share',
+          'recruiter_id' => 710
+        }
+      end
+
+      let(:formatted_event) do
+        {
+          event_type: tag,
+          user_id: 42,
+          device_id: 'e6153b00-85d8-11e6-b1bc-43192d1e493f',
+          user_properties: {
+            first_name: 'Bobby',
+            last_name: 'Weir'
+          },
+          event_properties: {
+            current_source: 'fb_share'
+          }
+        }
+      end
+
+      it 'produces the expected output' do
+        amplitude.expect_format [tag, now, formatted_event].to_msgpack
+        amplitude.run
+      end
+    end
+
+    context 'multiple device_id_key specified' do
+      let(:conf) do
+        %(
+          api_key XXXXXX
+          user_id_key user_id
+          device_id_key uuid, user_uuid
+          user_properties first_name, last_name
+          event_properties current_source
+        )
+      end
+      let(:event) do
+        {
+          'user_id' => 42,
+          'user_uuid' => 'e6153b00-85d8-11e6-b1bc-43192d1e493f',
+          'first_name' => 'Bobby',
+          'last_name' => 'Weir',
+          'state' => 'CA',
+          'current_source' => 'fb_share',
+          'recruiter_id' => 710
+        }
+      end
+
+      let(:formatted_event) do
+        {
+          event_type: tag,
+          user_id: 42,
+          device_id: 'e6153b00-85d8-11e6-b1bc-43192d1e493f',
+          user_properties: {
+            first_name: 'Bobby',
+            last_name: 'Weir'
+          },
+          event_properties: {
+            current_source: 'fb_share'
+          }
+        }
+      end
+
+      it 'produces the expected output' do
+        amplitude.expect_format [tag, now, formatted_event].to_msgpack
+        amplitude.run
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-amplitude
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Vijay Ramesh