fluent-plugin-sixpack 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7de3147cdbfecd0b93439d12c370b6db923dcbcc
-  data.tar.gz: cab2e034439051a97ce950949801cf70b3a159f3
+  metadata.gz: b91c9d69489bb8e18414ab354bbf69c356d3056e
+  data.tar.gz: 335fe12f805ca1e5564c80980218ce6086d43a28
 SHA512:
-  metadata.gz: 68cdd62f01db47a775f91ef2ed17e8b1137e05933aa8bbaa55d9934c85963fed5ccb73b171db2ca733d067dccbac78f6dea20d3b09f0623d1bbff00df95eab4c
-  data.tar.gz: 89f4a0ef7f4f3271f5aca1e8d82df38dc6d0f7b882e8d5222ad4c6ec982c325d766a153d43db3975a2270cbb0e02e49214a5849f1624086f239fe0bc0b3dff31
+  metadata.gz: f1d16582d6f120cc60a947d627560799c2cedb9e4e0c150812323cb7db228209e742a0206c23456850de78ceff3c5697dcfb5af048ec61e9a82c9786bd1fc905
+  data.tar.gz: 08ee9c0b3bd8410c18bd0081e9a6d5a9cd9873b97323cb2ea56f5c1075d820f7c6dfb4c5a940896439e60801024aaf81feeaf5adfca0a9a708a52dc4c73386c6

data/README.md

@@ -21,6 +21,8 @@ For messages to participate A/B test such as:
 Or messages to convert A/B test such as
 
     tag:your.arbitrary.tag {"record_type":"convert", "experiment":"header-color", "client_id":"ID-0000-0001"}
+    #you can also specify kpi id
+    tag:your.arbitrary.tag {"record_type":"convert", "experiment":"header-color", "client_id":"ID-0000-0001", "kpi":"conversion-100dollar"}
 
 Configuration example for graphs in sixpack with POST api url `http://sixpack:5000/(participate|convert)`. You must set this parameter.
 
@@ -42,6 +44,7 @@ You can change assignment between param keys and values, with using settings bel
 - `key_alternative, :default  => 'alternative'`
 - `key_client_id, :default    => 'client_id'`
 - `key_record_type, :default  => 'record_type'`
+- `key_kpi ,        :default  => 'kpi'`
 
 ### Configuration parameters
 

data/fluent-plugin-sixpack.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |gem|
   gem.name          = "fluent-plugin-sixpack"
-  gem.version       = "0.1.0"
+  gem.version       = "0.2.0"
   gem.authors       = ["Naoki AINOYA"]
   gem.email         = ["ainonic@gmail.com"]
   gem.summary       = %q{Fluentd output plugin to post numbers to sixpack (by seatgeek)}

data/lib/fluent/plugin/out_sixpack.rb

@@ -11,9 +11,10 @@ class Fluent::SixpackOutput < Fluent::Output
   config_param :sixpackapi_url, :string
   config_param :key_experiment, :default   => 'experiment'
   config_param :key_alternatives, :default => 'alternatives'
-  config_param :key_alternative, :default     => 'alternative'
+  config_param :key_alternative, :default  => 'alternative'
   config_param :key_client_id, :default    => 'client_id'
   config_param :key_record_type, :default  => 'record_type'
+  config_param :key_kpi, :string, :default => 'kpi'
 
   config_param :user_agent, :default       => 'user_agent'
   config_param :ip_address, :default       => 'ip_address'
@@ -135,16 +136,23 @@ class Fluent::SixpackOutput < Fluent::Output
                :client_id    => record[@key_client_id],
              })
     when 'convert'
-      return sixpack_path, URI.encode_www_form({
-               :experiment   => record[@key_experiment],
-               :client_id    => record[@key_client_id],
-             })
+      return sixpack_path, form_encode_params_convert(record)
     else
       log.warn 'failed to map sixpack path and query'
       raise
     end
   end
 
+  def form_encode_params_convert(record)
+    params = {
+       :experiment   => record[@key_experiment],
+       :client_id    => record[@key_client_id],
+    }
+    params.merge!({:kpi => record[@key_kpi]}) if(record[@key_kpi])
+
+    return URI.encode_www_form(params)
+  end
+
   def post_request(event)
     uri = URI.parse(@sixpackapi_url)
     uri.path, uri.query = map_sixpack_path_with_query(event[:record])

data/test/plugin/{test_out_growthforecast.rb → test_out_sixpack.rb}

@@ -38,6 +38,21 @@ class SixpackOutputTest < Test::Unit::TestCase
     assert_equal 'experiment_test_convert', @posted[0][:experiment]
   end
 
+  def test_convert_with_kpi
+    d = create_driver(CONFIG_NON_KEEPALIVE, 'test.metrics')
+    d.emit({'record_type' => 'convert',
+            'client_id'  => "0000-0000-0000-0000",
+            'kpi' => "kpi",
+            'experiment' => 'experiment_test_convert'})
+    sleep 0.5 # wait internal posting thread loop
+
+    assert_equal 1, @posted.size
+
+    assert_equal '0000-0000-0000-0000', @posted[0][:client_id]
+    assert_equal 'experiment_test_convert', @posted[0][:experiment]
+    assert_equal 'kpi', @posted[0][:kpi]
+  end
+
   def test_invalid_type
     d = create_driver(CONFIG_NON_KEEPALIVE, 'test.metrics')
     d.emit({'record_type' => 'invalid_type',
@@ -177,20 +192,24 @@ class SixpackOutputTest < Test::Unit::TestCase
             # ok, authorization not required
           end
 
-          @posted.push({
+          post_param = {
               :alternatives=> req.query["alternatives"],
               :alternative => req.query["alternative"],
               :client_id   => req.query["client_id"],
               :experiment  => req.query["experiment"]
-            })
+            }
+
+          @posted.push(post_param)
 
           res.status = 200
         }
         srv.mount_proc('/convert') { |req,res|
-          @posted.push({
+          post_param = {
               :client_id   => req.query["client_id"],
               :experiment  => req.query["experiment"]
-            })
+            }
+          post_param.merge!({:kpi => req.query["kpi"]}) if req.query["kpi"]
+          @posted.push(post_param)
           res.status = 200
         }
         srv.mount_proc('/') { |req,res|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-sixpack
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Naoki AINOYA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-05 00:00:00.000000000 Z
+date: 2014-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -85,7 +85,7 @@ files:
 - fluent-plugin-sixpack.gemspec
 - lib/fluent/plugin/out_sixpack.rb
 - test/helper.rb
-- test/plugin/test_out_growthforecast.rb
+- test/plugin/test_out_sixpack.rb
 homepage: https://github.com/ainoya/fluent-plugin-sixpack
 licenses:
 - APLv2
@@ -112,4 +112,5 @@ specification_version: 4
 summary: Fluentd output plugin to post numbers to sixpack (by seatgeek)
 test_files:
 - test/helper.rb
-- test/plugin/test_out_growthforecast.rb
+- test/plugin/test_out_sixpack.rb
+has_rdoc: