fluent-plugin-mixpanel 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6815b604a35a38d95672504bf46dae46899827b8
-  data.tar.gz: 653a7be3759ed89216cd98280313271f7ccdd2ea
+  metadata.gz: ce61d35f6244b42e741d6d7f3c783ab3ca163673
+  data.tar.gz: c63f6f73b9cd17f02a1463d8bf8eccf490b4a29a
 SHA512:
-  metadata.gz: a1e5d36ce6c9ec2bd08bf5ad73380d49da7be09caf6bfba38bc464ff03362c8d6a307efc8e2923767fd58a06f8c9df736ec275ad253fb2c7322578a524f6fc4a
-  data.tar.gz: 5e862b4b0bc31b9f705b1c43a63737608b2200f51ef41c1039feb0f069836e963e8ca7960cf16a8a80a16b1a84e862eb21e8f330a9142d8d73d95b3471613717
+  metadata.gz: 13c356b9919ce45d9d0a9659193088f76c795bda5dc09228e8979d97954ea1b539bb9178f52c6af59850b5cd7302e3cd47d7000d0182ab2f93bcdbbb09fecca4
+  data.tar.gz: 395b697c73e01b9d39a5dea0607fa4e9f75dbd11462e1b8032944d27f35b003699e5a3f33bc57454fe20c2f60e43b96eaee93aa6ffbd68623eb9cac248d03904

data/README.md

@@ -60,14 +60,23 @@ tracker.track("123", "event1", { key1: "value1", key2: "value2" })
 
 #### Use distinct_id_key and event_map_tag
 
-You can use tag name as event name like this.
+You can use tag name as event name like this. (see additional tag manipulations options below)
+
+##PLEASE NOTE (breaking api change in a future release)
+
+The api for remove_tag_prefix will be changing in a future release. There is currently a boolean option,
+use_legacy_prefix_behavior, which will ensure legacy behavior is maintained until that time. Eventually this option will go away
+as well and the new behavior will be the only way. The difference is pretty simple, the '.' in the prefix needs to be specified.
+This change allows this plugin to use Fluet's mixin and unifies syntax across plugins. Currently, use_legacy_prefix_behavior
+defaults to true, which will work either way, but eventually you will need to specify the '.' in your prefix. Again, use_legacy_prefix_behavior simply removes any '.' along with the specified prefix and will behave properly even after you change your configs
+to be current as seen below. You do not need to set this option.
 
 ```
 <match output.mixpanel.*>
   type mixpanel
   project_token YOUR_PROJECT_TOKEN
   distinct_id_key user_id
-  remove_tag_prefix output.mixpanel
+  remove_tag_prefix output.mixpanel.
   event_map_tag true
 </match>
 ```
@@ -94,7 +103,7 @@ You can use tag name as event name like this.
   type mixpanel
   project_token YOUR_PROJECT_TOKEN
   distinct_id_key user_id
-  remove_tag_prefix output.mixpanel
+  remove_tag_prefix output.mixpanel.
   event_map_tag true
   use_import true
   api_key YOUR_API_KEY
@@ -114,6 +123,17 @@ tracker = Mixpanel::Tracker.new(YOUR_PROJECT_TOKEN)
 tracker.import(api_key, "123", "event1", { key1: "value1", key2: "value2" })
 ```
 
+---
+
+fluentd-plugin-mixpanel also includes the HandleTagNameMixin mixin which allows the following additional options:
+
+```
+remove_tag_prefix <tag_prefix_to_remove_including_the_dot>
+remove_tag_suffix <tag_suffix_to_remove_including_the_dot>
+add_tag_prefix <tag_prefix_to_add_including_the_dot>
+add_tag_suffix <tag_suffix_to_add_including_the_dot>
+```
+
 ### HttpMixpanelInput
 
 HttpMixpanelInput has same configuration as [http Input Plugin](http://docs.fluentd.org/en/articles/in_http).

data/fluent-plugin-mixpanel.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "fluent-plugin-mixpanel"
-  spec.version       = "0.0.6"
+  spec.version       = "0.0.7"
   spec.authors       = ["Kazuyuki Honda"]
   spec.email         = ["hakobera@gmail.com"]
   spec.summary       = %q{Fluentd plugin to input/output event track data to mixpanel}

data/lib/fluent/plugin/out_mixpanel.rb

@@ -1,15 +1,18 @@
+
 class Fluent::MixpanelOutput < Fluent::BufferedOutput
   Fluent::Plugin.register_output('mixpanel', self)
 
+  include Fluent::HandleTagNameMixin
+
   config_param :project_token, :string
   config_param :api_key, :string, :default => ''
   config_param :use_import, :bool, :default => nil
   config_param :distinct_id_key, :string
   config_param :event_key, :string, :default => nil
   config_param :ip_key, :string, :default => nil
-
-  config_param :remove_tag_prefix, :string, :default => nil
   config_param :event_map_tag, :bool, :default => false
+  #NOTE: This will be removed in a future release. Please specify the '.' on any prefix
+  config_param :use_legacy_prefix_behavior, :default => true
 
   class MixpanelError < StandardError
   end
@@ -25,10 +28,10 @@ class Fluent::MixpanelOutput < Fluent::BufferedOutput
     @distinct_id_key = conf['distinct_id_key']
     @event_key = conf['event_key']
     @ip_key = conf['ip_key']
-    @remove_tag_prefix = conf['remove_tag_prefix']
     @event_map_tag = conf['event_map_tag']
     @api_key = conf['api_key']
     @use_import = conf['use_import']
+    @use_legacy_prefix_behavior = conf['use_legacy_prefix_behavior']
 
     if @event_key.nil? and !@event_map_tag
       raise Fluent::ConfigError, "'event_key' must be specifed when event_map_tag == false."
@@ -58,7 +61,8 @@ class Fluent::MixpanelOutput < Fluent::BufferedOutput
       prop.delete('token')
 
       if @event_map_tag
-        data['event'] = tag.gsub(/^#{@remove_tag_prefix}(\.)?/, '')
+        tag.gsub!(/^\./, '') if @use_legacy_prefix_behavior
+        data['event'] = tag
       elsif record[@event_key]
         data['event'] = record[@event_key]
         prop.delete(@event_key)

data/test/plugin/test_out_mixpanel.rb

@@ -15,6 +15,7 @@ class MixpanelOutputTest < Test::Unit::TestCase
 
   IMPORT_CONFIG = CONFIG + %[ api_key test_api_key
                               use_import true
+                              use_legacy_prefix_behavior false
                             ]
 
   def create_driver(conf = CONFIG)
@@ -58,12 +59,11 @@ class MixpanelOutputTest < Test::Unit::TestCase
   end
 
   def test_configure_with_event_map_tag
-    d = create_driver(CONFIG + "remove_tag_prefix mixpanel\n event_map_tag true")
+    d = create_driver(CONFIG + "event_map_tag true")
 
     assert_equal 'test_token', d.instance.project_token
     assert_equal 'user_id', d.instance.distinct_id_key
     assert_equal nil, d.instance.event_key
-    assert_equal 'mixpanel', d.instance.remove_tag_prefix
     assert_equal true.to_s, d.instance.event_map_tag
   end
 
@@ -121,9 +121,23 @@ class MixpanelOutputTest < Test::Unit::TestCase
     assert_equal "value2",      @out[0]['properties']['key2']
   end
 
-  def test_write_with_event_map_tag
+  def test_write_with_no_tag_manipulation
+    stub_mixpanel
+    d = create_driver(CONFIG + "event_map_tag true")
+    time = Time.new('2014-01-01T01:23:45+00:00')
+    d.emit(sample_record, time)
+    d.run
+
+    assert_equal "123",           @out[0]['properties']['distinct_id']
+    assert_equal "mixpanel.test", @out[0]['event']
+    assert_equal time.to_i,       @out[0]['properties']['time']
+    assert_equal "value1",        @out[0]['properties']['key1']
+    assert_equal "value2",        @out[0]['properties']['key2']
+  end
+
+  def test_write_with_event_map_tag_removing_prefix
     stub_mixpanel
-    d = create_driver(CONFIG + "remove_tag_prefix mixpanel\n event_map_tag true")
+    d = create_driver(CONFIG + "remove_tag_prefix mixpanel.\n event_map_tag true")
     time = Time.new('2014-01-01T01:23:45+00:00')
     d.emit(sample_record, time)
     d.run
@@ -135,20 +149,78 @@ class MixpanelOutputTest < Test::Unit::TestCase
     assert_equal "value2",  @out[0]['properties']['key2']
   end
 
-  def test_write_with_no_remove_tag_prefix
+  def test_write_with_event_map_tag_removing_prefix_LEGACY
     stub_mixpanel
-    d = create_driver(CONFIG + "event_map_tag true")
+    d = create_driver(CONFIG + "remove_tag_prefix mixpanel\n event_map_tag true\n use_legacy_prefix_behavior true")
     time = Time.new('2014-01-01T01:23:45+00:00')
     d.emit(sample_record, time)
     d.run
 
-    assert_equal "123",           @out[0]['properties']['distinct_id']
-    assert_equal "mixpanel.test", @out[0]['event']
-    assert_equal time.to_i,       @out[0]['properties']['time']
-    assert_equal "value1",        @out[0]['properties']['key1']
-    assert_equal "value2",        @out[0]['properties']['key2']
+    assert_equal "123",     @out[0]['properties']['distinct_id']
+    assert_equal "test",    @out[0]['event']
+    assert_equal time.to_i, @out[0]['properties']['time']
+    assert_equal "value1",  @out[0]['properties']['key1']
+    assert_equal "value2",  @out[0]['properties']['key2']
+  end
+
+  def test_write_with_event_map_tag_removing_prefix_LEGACY_with_dot
+    stub_mixpanel
+    d = create_driver(CONFIG + "remove_tag_prefix mixpanel.\n event_map_tag true\n use_legacy_prefix_behavior true")
+    time = Time.new('2014-01-01T01:23:45+00:00')
+    d.emit(sample_record, time)
+    d.run
+
+    assert_equal "123",     @out[0]['properties']['distinct_id']
+    assert_equal "test",    @out[0]['event']
+    assert_equal time.to_i, @out[0]['properties']['time']
+    assert_equal "value1",  @out[0]['properties']['key1']
+    assert_equal "value2",  @out[0]['properties']['key2']
+  end
+
+  def test_write_with_event_map_tag_removing_suffix
+    stub_mixpanel
+    d = create_driver(CONFIG + "remove_tag_suffix .test\n event_map_tag true")
+    time = Time.new('2014-01-01T01:23:45+00:00')
+    d.emit(sample_record, time)
+    d.run
+
+    assert_equal "123",     @out[0]['properties']['distinct_id']
+    assert_equal "mixpanel",    @out[0]['event']
+    assert_equal time.to_i, @out[0]['properties']['time']
+    assert_equal "value1",  @out[0]['properties']['key1']
+    assert_equal "value2",  @out[0]['properties']['key2']
+  end
+
+  def test_write_with_event_map_tag_adding_prefix
+    stub_mixpanel
+    d = create_driver(CONFIG + "add_tag_prefix foo.\n event_map_tag true")
+    time = Time.new('2014-01-01T01:23:45+00:00')
+    d.emit(sample_record, time)
+    d.run
+
+    assert_equal "123",     @out[0]['properties']['distinct_id']
+    assert_equal "foo.mixpanel.test",    @out[0]['event']
+    assert_equal time.to_i, @out[0]['properties']['time']
+    assert_equal "value1",  @out[0]['properties']['key1']
+    assert_equal "value2",  @out[0]['properties']['key2']
+  end
+
+  def test_write_with_event_map_tag_adding_suffix
+    stub_mixpanel
+    d = create_driver(CONFIG + "add_tag_suffix .foo\n event_map_tag true")
+    time = Time.new('2014-01-01T01:23:45+00:00')
+    d.emit(sample_record, time)
+    d.run
+
+    assert_equal "123",     @out[0]['properties']['distinct_id']
+    assert_equal "mixpanel.test.foo",    @out[0]['event']
+    assert_equal time.to_i, @out[0]['properties']['time']
+    assert_equal "value1",  @out[0]['properties']['key1']
+    assert_equal "value2",  @out[0]['properties']['key2']
   end
 
+
+
   def test_write_ignore_special_event
     stub_mixpanel
     d = create_driver(CONFIG + "event_key event")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-mixpanel
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Kazuyuki Honda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-02 00:00:00.000000000 Z
+date: 2015-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd