fluent-plugin-mixpanel 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d8d9a539d77b2b4338ad6de2f4389095fd034816
+  data.tar.gz: 62760bebcef57a117db6191fd5610d99a079ca7e
+SHA512:
+  metadata.gz: 9383f6371b857b50d34892e334193b308124378497f70f9baaf4c21af058acc89a34e6ecf3222fa3f4800e6435ea8360caaa8fe2aa2fd69f9d0a45b2d264324c
+  data.tar.gz: f4c3f7cc40d6879ef48dd827a655a50d8caa583ba2a69578632f5db62ce9638ac17349941354423e82566feec5a8d1144fa4f23801aaed009790bc49b02eedd5

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fluent-plugin-mixpanel.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright (c) 2014- Kazuyuki Honda
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,58 @@
+# fluent-plugin-mixpanel
+
+[![Build Status](https://travis-ci.org/hakobera/fluent-plugin-mixpanel.png?branch=master)](https://travis-ci.org/hakobera/fluent-plugin-mixpanel)
+
+## Component
+
+### MixpanelOutput
+
+[Fluentd](http://fluentd.org) plugin to send event track data to [mixpanel](https://mixpanel.com).
+
+## Installation
+
+Install with gem or fluent-gem command as:
+
+```
+# for fluentd
+$ gem install fluent-plugin-mixpanel
+
+# for td-agent
+$ sudo /usr/lib64/fluent/ruby/bin/fluent-gem install fluent-plugin-mixpanel
+```
+
+## Configuration
+
+### MixpanelOutput
+
+MixpanelOutput needs mixpanel's `project_token`, that can get from your mixpanel project settings.
+You should also specify property key name by `distinct_id_key` and `event_key`.
+
+```xml
+<match output.mixpanel.*>
+  type mixpanel
+  project_token YOUR_PROJECT_TOKEN
+  distinct_id_key user_id
+  event_key event_name
+</match>
+```
+
+If record like this:
+
+```rb
+{ user_id: "123", event_name: "event1", 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.track("123", "event1", { key1: "value1", key2: "value2" })
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/hakobera/fluent-plugin-mixpanel/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/fluent-plugin-mixpanel.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "fluent-plugin-mixpanel"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Kazuyuki Honda"]
+  spec.email         = ["hakobera@gmail.com"]
+  spec.summary       = %q{Fluentd plugin to send event track data to mixpanel}
+  spec.description   = %q{Fluentd plugin to send event track data to mixpanel}
+  spec.homepage      = "https://github.com/hakobera/fluent-plugin-mixpanel"
+  spec.license       = "Apache License, Version 2.0"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  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_development_dependency "rake"
+  spec.add_development_dependency "webmock"
+end

data/lib/fluent/plugin/out_mixpanel.rb

@@ -0,0 +1,76 @@
+class Fluent::MixpanelOutput < Fluent::BufferedOutput
+  Fluent::Plugin.register_output('mixpanel', self)
+
+  config_param :project_token, :string
+  config_param :distinct_id_key, :string
+  config_param :event_key, :string
+
+  def initialize
+    super
+    require 'mixpanel-ruby'
+  end
+
+  def configure(conf)
+    super
+    @project_tokey = conf['project_token']
+    @distinct_id_key = conf['distinct_id_key']
+    @event_key = conf['event_key']
+
+    if @project_token.empty?
+      raise Fluent::ConfigError, "'project_token' must be specifed."
+    end
+
+    if @distinct_id_key.empty?
+      raise Fluent::ConfigError, "'distinct_id_key' must be specifed."
+    end
+
+    if @event_key.empty?
+      raise Fluent::ConfigError, "'event_key' must be specifed."
+    end
+  end
+
+  def start
+    super
+    @tracker = Mixpanel::Tracker.new(@project_token)
+  end
+
+  def shutdown
+    super
+  end
+
+  def format(tag, time, record)
+    [tag, time, record].to_msgpack
+  end
+
+  def write(chunk)
+    records = []
+    chunk.msgpack_each do |tag, time, record|
+      data = {}
+
+      if record[@distinct_id_key]
+        data['distinct_id'] = record[@distinct_id_key]
+        record.delete(@distinct_id_key)
+      else
+        log.warn('no distinct_id')
+        return
+      end
+
+      if record[@event_key]
+        data['event'] = record[@event_key]
+        record.delete(@event_key)
+      else 
+        log.warn('no event')
+        return
+      end
+
+      record.merge!(time: time.to_i)
+      data['properties'] = record
+      
+      records << data
+    end
+
+    records.each do |record|
+      @tracker.track(record['distinct_id'], record['event'], record['properties'])
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'fluent/test'
+unless ENV.has_key?('VERBOSE')
+  nulllogger = Object.new
+  nulllogger.instance_eval {|obj|
+    def method_missing(method, *args)
+      # pass
+    end
+  }
+  $log = nulllogger
+end
+
+require 'fluent/plugin/out_mixpanel'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_out_mixpanel.rb

@@ -0,0 +1,93 @@
+require 'helper'
+require 'uri'
+require 'webmock/test_unit'
+
+WebMock.disable_net_connect!
+
+class MixpanelOutputTest < Test::Unit::TestCase
+
+  def setup
+    Fluent::Test.setup
+    @out = []
+  end
+
+  CONFIG = %[
+    project_token test_token
+    distinct_id_key user_id
+    event_key event
+  ]
+
+  def create_driver(conf = CONFIG)
+    Fluent::Test::BufferedOutputTestDriver.new(Fluent::MixpanelOutput).configure(conf)
+  end
+
+  def stub_mixpanel(url="https://api.mixpanel.com/track")
+    stub_request(:post, url).with do |req|
+      body = URI.decode_www_form(req.body)
+      @out << JSON.load(Base64.decode64(body.assoc('data').last))
+    end.to_return(status: 200, body: JSON.generate({ status: 1 }))
+  end
+
+  def stub_mixpanel_unavailable(url="https://api.mixpanel.com/track")
+    stub_request(:post, url).to_return(status: 503, body: "Service Unavailable")
+  end
+
+  def sample_record
+    { user_id: "123", event: "event1", key1: "value1", key2: "value2" }
+  end
+
+  def test_configure
+    d = create_driver
+
+    assert_equal 'test_token', d.instance.project_token
+    assert_equal 'user_id', d.instance.distinct_id_key
+    assert_equal 'event', d.instance.event_key
+  end
+
+  def test_write
+    stub_mixpanel
+    d = create_driver
+    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 "event1",  @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_multi_request
+    stub_mixpanel
+    d = create_driver
+    time1 = Time.new('2014-01-01T01:23:45+00:00')
+    time2 = Time.new('2014-01-02T01:23:45+00:00')
+
+    d.emit(sample_record, time1)
+    d.emit(sample_record.merge(key3: "value3"), time2)
+    d.run
+
+    assert_equal "123",      @out[0]['properties']['distinct_id']
+    assert_equal "event1",   @out[0]['event']
+    assert_equal time1.to_i, @out[0]['properties']['time']
+    assert_equal "value1",   @out[0]['properties']['key1']
+    assert_equal "value2",   @out[0]['properties']['key2']
+
+    assert_equal "123",      @out[1]['properties']['distinct_id']
+    assert_equal "event1",   @out[1]['event']
+    assert_equal time2.to_i, @out[1]['properties']['time']
+    assert_equal "value1",   @out[1]['properties']['key1']
+    assert_equal "value2",   @out[1]['properties']['key2']
+    assert_equal "value2",   @out[1]['properties']['key2']
+  end
+
+  def test_request_error
+    stub_mixpanel_unavailable
+    d = create_driver
+    d.emit(sample_record)
+    assert_raise(Mixpanel::ConnectionError) {
+      d.run
+    }
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-mixpanel
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kazuyuki Honda
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mixpanel-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Fluentd plugin to send event track data to mixpanel
+email:
+- hakobera@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-mixpanel.gemspec
+- lib/fluent/plugin/out_mixpanel.rb
+- test/helper.rb
+- test/plugin/test_out_mixpanel.rb
+homepage: https://github.com/hakobera/fluent-plugin-mixpanel
+licenses:
+- Apache License, Version 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: Fluentd plugin to send event track data to mixpanel
+test_files:
+- test/helper.rb
+- test/plugin/test_out_mixpanel.rb