fluent-plugin-amplitude 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a99dfa0622abec2b9b5b7eced10c234698e62f9
-  data.tar.gz: 0b2b2e968e091881426eae51e4b812d22351bc0f
+  metadata.gz: 1d93878883ecfd0b74360d52da210ee1914685fa
+  data.tar.gz: 537a7ead298423f76e5dbaecb13487a7df983101
 SHA512:
-  metadata.gz: 2dba48d6ac9d57bfc8871c91371bb9ee789f54ff232a28d7405f6cd11275ad606df15d4a58107a4bb45518ad4f3c1fcafcbf0afcbfc818d9d14459c6607e63a1
-  data.tar.gz: b3e098e985a55091aee6e17668e2b92779456f39e96eb3a6e15039555225ab210f211655f45e6062217e49ba6dbfccd0ec68ee700215d70f3bf63e4754cadea1
+  metadata.gz: 2a155ce833996a533cb9e1ded2e07af0efd642b40da14bff03795b837ac7739cbccd48d9b36d876548685551ebc7632f9461ceffe615b8dcb3a22ff976f630bd
+  data.tar.gz: 2c9bf89150f181a1fcae00fd61f43292dd5fc7504e4302fe7cafcfb8d0175ecb44c9b05a35af970fcadc534a5240519603c9a4856b91ec3aff26a43cc6f35f3b

data/.gitignore

@@ -1 +1,3 @@
 Gemfile.lock
+
+*.pem

data/README.md

@@ -48,12 +48,20 @@ You must set at least one of `user_id_key` and `device_id_key`. They will be use
 #### time_key
 If set, `time_key` will be used to pull out a timestamp field to set as `time` in the Amplitude API request. This can be an array, the first matching key will be used.
 
+####  revenue_properties
+
+`revenue_properties` are a fixed set of properties that Amplitude looks for in order to determine which events are revenue events (see Amplitude's [revenue tracking guide](https://amplitude.zendesk.com/hc/en-us/articles/115003116888-Tracking-Revenue) and [HTTP API documentation](https://amplitude.zendesk.com/hc/en-us/articles/204771828#keys-for-the-event-argument) for more information). `revenue_properties` are set as top-level properties on the API call. The `revenue_properties` we currently support are:
+* quantity
+* price
+* revenue
+* revenue_type
+
 #### user_properties and event_properties
 You can optionally specify lists of `user_properties` and `event_properties` to pull from the record.
 
 If `user_properties` are specified, only those properties will be included as `user_properties` in the Amplitude API call.  Otherwise no `user_properties` will be sent.
 
-If `event_properties` are specified, only those properties will be included as `event_properties` in the Amplitude API call. Otherwise the entire record (minus the key/value for `user_id_key` and `device_id_key`, and minus any `user_properties`) will be sent as `event_properties` to Amplitude.
+If `event_properties` are specified, only those properties will be included as `event_properties` in the Amplitude API call. If no `event_properties` are specified, then every field with the exception of `user_id_key`, `device_id_key`, all `revenue_properties`, and anything specified in `user_properties`, will be sent as `event_properties` in the Amplitude API call.
 
 #### event type
 The event_type is the tag.  To modify this, fluent-plugin-amplitude includes the `HandleTagNameMixin` mixin which allows the following options:

data/fluent-plugin-amplitude.gemspec

@@ -4,9 +4,9 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'fluent-plugin-amplitude'
-  spec.version       = '0.1.0'
-  spec.authors       = ['Vijay Ramesh']
-  spec.email         = ['vijay@change.org']
+  spec.version       = '0.2.0'
+  spec.authors       = ['Change.org']
+  spec.email         = ['tech_ops@change.org']
   spec.summary       = 'Fluentd plugin to output event data to Amplitude'
   spec.description   = 'Fluentd plugin to output event data to Amplitude'
   spec.homepage      = 'https://github.com/change/fluent-plugin-amplitude'
@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'fluentd', '>= 0.10.55'
   spec.add_runtime_dependency 'amplitude-api', '~> 0.0.9'
-  spec.add_runtime_dependency 'msgpack', '~> 0'
+  spec.add_runtime_dependency 'msgpack', '~> 1.0'
 
   spec.add_development_dependency 'rake', '~> 11.3'
   spec.add_development_dependency 'rspec', '~> 3.5'

data/lib/fluent/plugin/out_amplitude.rb

@@ -7,6 +7,13 @@ module Fluent
     include Fluent::HandleTagNameMixin
     include FakeActiveSupport
 
+    REVENUE_PROPERTIES = %w(
+      price
+      quantity
+      revenue
+      revenue_type
+    ).freeze
+
     config_param :api_key, :string, secret: true
     config_param :device_id_key, :array, default: nil
     config_param :user_id_key, :array, default: nil
@@ -16,8 +23,8 @@ module Fluent
     config_param :properties_blacklist, :array, default: nil
     config_param :events_whitelist, :array, default: nil
     config_param :events_blacklist, :array, default: nil
-    class AmplitudeError < StandardError
-    end
+
+    class AmplitudeError < StandardError; end
 
     def initialize
       super
@@ -44,6 +51,7 @@ module Fluent
       filter_properties_blacklist!(record)
       extract_user_and_device!(amplitude_hash, record)
       set_time!(amplitude_hash, record)
+      extract_revenue_properties!(amplitude_hash, record)
       extract_user_properties!(amplitude_hash, record)
       extract_event_properties!(amplitude_hash, record)
 
@@ -119,6 +127,14 @@ module Fluent
       log.info("failed to parse #{time_string}: #{e.message}")
     end
 
+    def extract_revenue_properties!(amplitude_hash, record)
+      REVENUE_PROPERTIES.each do |prop|
+        next if record[prop].nil?
+
+        amplitude_hash[prop.to_sym] = record.delete(prop)
+      end
+    end
+
     def extract_user_properties!(amplitude_hash, record)
       # if user_properties are specified, pull them off of the record
       return unless @user_properties
@@ -132,7 +148,7 @@ module Fluent
 
     def extract_event_properties!(amplitude_hash, record)
       # if event_properties are specified, pull them off of the record
-      # otherwise, use the remaining record (minus any user_properties)
+      # otherwise, use the remaining record (minus any revenue_properties and user_properties)
       amplitude_hash[:event_properties] = begin
         if @event_properties
           record.select do |k, _v|

data/spec/out_amplitude_spec.rb

@@ -42,7 +42,11 @@ describe Fluent::AmplitudeOutput do
           'last_name' => 'Weir',
           'state' => 'CA',
           'current_source' => 'fb_share',
-          'recruiter_id' => 710
+          'recruiter_id' => 710,
+          'revenue_type' => 'sustainer',
+          'quantity' => 2,
+          'price' => 10.05,
+          'revenue' => 20.10,
         }
       end
 
@@ -51,6 +55,10 @@ describe Fluent::AmplitudeOutput do
           event_type: tag,
           user_id: 42,
           device_id: 'e6153b00-85d8-11e6-b1bc-43192d1e493f',
+          price: 10.05,
+          quantity: 2,
+          revenue: 20.10,
+          revenue_type: 'sustainer',
           user_properties: {
             first_name: 'Bobby',
             last_name: 'Weir'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-amplitude
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
-- Vijay Ramesh
+- Change.org
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-03 00:00:00.000000000 Z
+date: 2017-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -130,7 +130,7 @@ dependencies:
         version: 0.44.1
 description: Fluentd plugin to output event data to Amplitude
 email:
-- vijay@change.org
+- tech_ops@change.org
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -164,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Fluentd plugin to output event data to Amplitude