fluent-plugin-mixpanel 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e1511b088e5a44ccfaaf5496c9c6016ed9d0868b
-  data.tar.gz: 1af1398470ca349149446515f2c23ad41e0bb3b8
+  metadata.gz: 6815b604a35a38d95672504bf46dae46899827b8
+  data.tar.gz: 653a7be3759ed89216cd98280313271f7ccdd2ea
 SHA512:
-  metadata.gz: eb42e76500502a2c4e883041abc18c234f69a687f90bffced64cf578d483d30d5c86f3bb81bec9ee4240bc41a3da4296b863b71e9513b2436f9bd72b5df3e0a3
-  data.tar.gz: 57418f562b980b1a061c765e9ff78e773f276b3cf77016a1b7dcae23aa514f018b13a77111989c58986e469c65e76bec2f01867e03a20a1d0a4250ffe46160a6
+  metadata.gz: a1e5d36ce6c9ec2bd08bf5ad73380d49da7be09caf6bfba38bc464ff03362c8d6a307efc8e2923767fd58a06f8c9df736ec275ad253fb2c7322578a524f6fc4a
+  data.tar.gz: 5e862b4b0bc31b9f705b1c43a63737608b2200f51ef41c1039feb0f069836e963e8ca7960cf16a8a80a16b1a84e862eb21e8f330a9142d8d73d95b3471613717

data/.travis.yml

@@ -1,5 +1,5 @@
 language: ruby
 rvm:
-  - 1.9.3
   - 2.0.0
   - 2.1.0
+  - 2.2.0

data/README.md

@@ -2,6 +2,8 @@
 
 [![Build Status](https://travis-ci.org/hakobera/fluent-plugin-mixpanel.png?branch=master)](https://travis-ci.org/hakobera/fluent-plugin-mixpanel)
 
+**CAUTION** This plugin does not support Ruby < 2.0.
+
 ## Component
 
 ### MixpanelOutput
@@ -83,6 +85,35 @@ tracker = Mixpanel::Tracker.new(YOUR_PROJECT_TOKEN)
 tracker.track("123", "event1", { key1: "value1", key2: "value2" })
 ```
 
+#### Use the import method to post instead of track
+
+You can use tag name as event name like this.
+
+```
+<match output.mixpanel.*>
+  type mixpanel
+  project_token YOUR_PROJECT_TOKEN
+  distinct_id_key user_id
+  remove_tag_prefix output.mixpanel
+  event_map_tag true
+  use_import true
+  api_key YOUR_API_KEY
+</match>
+```
+
+If tag name is `output.mixpanel.event1` and record like this:
+
+```rb
+{ user_id: "123", key1: "value1", key2: "value2" }
+```
+
+above settings send to the following data to mixpanel, using [mixpanel-ruby](https://github.com/mixpanel/mixpanel-ruby) gem.
+
+```rb
+tracker = Mixpanel::Tracker.new(YOUR_PROJECT_TOKEN)
+tracker.import(api_key, "123", "event1", { key1: "value1", key2: "value2" })
+```
+
 ### 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.5"
+  spec.version       = "0.0.6"
   spec.authors       = ["Kazuyuki Honda"]
   spec.email         = ["hakobera@gmail.com"]
   spec.summary       = %q{Fluentd plugin to input/output event track data to mixpanel}
@@ -17,9 +17,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "fluentd"
-  spec.add_runtime_dependency "mixpanel-ruby"
+  spec.add_runtime_dependency "fluentd", ">= 0.10.55"
+  spec.add_runtime_dependency "mixpanel-ruby", "~> 2.1.0"
 
   spec.add_development_dependency "rake"
   spec.add_development_dependency "webmock"
+  spec.add_development_dependency "test-unit", "~> 3.0.2"
 end

data/lib/fluent/plugin/out_mixpanel.rb

@@ -2,6 +2,8 @@ class Fluent::MixpanelOutput < Fluent::BufferedOutput
   Fluent::Plugin.register_output('mixpanel', self)
 
   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
@@ -9,6 +11,9 @@ class Fluent::MixpanelOutput < Fluent::BufferedOutput
   config_param :remove_tag_prefix, :string, :default => nil
   config_param :event_map_tag, :bool, :default => false
 
+  class MixpanelError < StandardError
+  end
+
   def initialize
     super
     require 'mixpanel-ruby'
@@ -22,6 +27,8 @@ class Fluent::MixpanelOutput < Fluent::BufferedOutput
     @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']
 
     if @event_key.nil? and !@event_map_tag
       raise Fluent::ConfigError, "'event_key' must be specifed when event_map_tag == false."
@@ -55,7 +62,7 @@ class Fluent::MixpanelOutput < Fluent::BufferedOutput
       elsif record[@event_key]
         data['event'] = record[@event_key]
         prop.delete(@event_key)
-      else 
+      else
         log.warn('no event')
         return
       end
@@ -78,12 +85,21 @@ class Fluent::MixpanelOutput < Fluent::BufferedOutput
 
       prop.select! {|key, _| !key.start_with?('mp_') }
       prop.merge!('time' => time.to_i)
-      
+
       records << data
     end
 
+    send_to_mixpanel(records)
+  end
+
+  def send_to_mixpanel(records)
     records.each do |record|
-      @tracker.track(record['distinct_id'], record['event'], record['properties'])
+     success = 	if @use_import
+        					@tracker.import(@api_key, record['distinct_id'], record['event'], record['properties'])
+      					else
+        					@tracker.track(record['distinct_id'], record['event'], record['properties'])
+      					end
+      raise MixpanelError.new("Failed to track event to mixpanel") unless success
     end
   end
 end

data/test/plugin/test_out_mixpanel.rb

@@ -13,6 +13,10 @@ class MixpanelOutputTest < Test::Unit::TestCase
     distinct_id_key user_id
   ]
 
+  IMPORT_CONFIG = CONFIG + %[ api_key test_api_key
+                              use_import true
+                            ]
+
   def create_driver(conf = CONFIG)
     Fluent::Test::BufferedOutputTestDriver.new(Fluent::MixpanelOutput, 'mixpanel.test').configure(conf)
   end
@@ -24,6 +28,10 @@ class MixpanelOutputTest < Test::Unit::TestCase
     end.to_return(status: 200, body: JSON.generate({ status: 1 }))
   end
 
+  def stub_mixpanel_import
+    stub_mixpanel("https://api.mixpanel.com/import")
+  end
+
   def stub_mixpanel_unavailable(url="https://api.mixpanel.com/track")
     stub_request(:post, url).to_return(status: 503, body: "Service Unavailable")
   end
@@ -75,8 +83,8 @@ class MixpanelOutputTest < Test::Unit::TestCase
   end
 
   def test_write_multi_request
-    stub_mixpanel
-    d = create_driver(CONFIG + "event_key event")
+    stub_mixpanel_import
+    d = create_driver(IMPORT_CONFIG + "event_key event")
     time1 = Time.new('2014-01-01T01:23:45+00:00')
     time2 = Time.new('2014-01-02T01:23:45+00:00')
 
@@ -106,7 +114,7 @@ class MixpanelOutputTest < Test::Unit::TestCase
     d.run
 
     assert_equal "123",         @out[0]['properties']['distinct_id']
-    assert_equal "event1",      @out[0]['event']    
+    assert_equal "event1",      @out[0]['event']
     assert_equal time.to_i,     @out[0]['properties']['time']
     assert_equal "192.168.0.2", @out[0]['properties']['ip']
     assert_equal "value1",      @out[0]['properties']['key1']
@@ -187,7 +195,7 @@ class MixpanelOutputTest < Test::Unit::TestCase
     stub_mixpanel_unavailable
     d = create_driver(CONFIG + "event_key event")
     d.emit(sample_record)
-    assert_raise(Mixpanel::ConnectionError) {
+    assert_raise(Fluent::MixpanelOutput::MixpanelError) {
       d.run
     }
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-mixpanel
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Kazuyuki Honda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-24 00:00:00.000000000 Z
+date: 2015-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.55
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.55
 - !ruby/object:Gem::Dependency
   name: mixpanel-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.2
 description: Fluentd plugin to input/output event track data to mixpanel
 email:
 - hakobera@gmail.com
@@ -108,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Fluentd plugin to input/output event track data to mixpanel