logstash-filter-mixpanel 0.1.1 → 0.1.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZDA1YzRhYzRiMTJhYzRlZDliOTQ1NjI3NmJhM2I0NjQ5ZjJmN2Y2Ng==
+    YzNhMGYxMmM5OTBkZjFlMjQxZDc0NjE4ZjRmMzk1NWI0ZjQ4N2U2ZA==
   data.tar.gz: !binary |-
-    Nzg2ZDMxYzYzNzdlY2Q3NzY2YTgzZDJkZjEwZjg4NWFlM2YyMDg1OA==
+    YTRlMzhmOTc3MzhlZjYwZWZkZWJiMTdlY2Q1Mzk3YWJiOWNhMWMyMg==
 SHA512:
   metadata.gz: !binary |-
-    MGQ3M2VjMjRmMzk3NWVjYTJmOTNlMjJkOTlhYjcwM2RjNGE4YzVjZTJjODFm
-    ZWFkMzFhMjUwNzU1N2ZhNjY4NjQ4YzY5YjdjNjc1NmQwZTBiZWNkNmFiZmE3
-    ZTJjOTY4NjBhYzhmMjUxMmQ5N2RiYTg2NGM2ZGE1YzBmNDY5NGY=
+    MzIyMDhkODU3YWJkMjdlNGY5Yzc4ZGUyMDI4NzRjMWVjZDVmYjhkY2Q5M2Fi
+    NTIxY2RmMTkyYTMzYmNiMzdiYzRjZTNjNTFkYTI2ZWJlN2E4YjNkNzIyZDU0
+    ZTljYTNkZGMzMTE1NTE5ZWY2MzkyYjExOWI4ZmRlZTRiOTI5MDA=
   data.tar.gz: !binary |-
-    ZTY3MjBmMjdiYWIzYjM2M2MyZGVhYjJhMzU1ZDZlNmI4MGU4MDY2YjQxNDdk
-    NWY1OTg4Nzg1ZjM4OTE2NWFkMTcwN2I5ZDk3YmUzN2MyN2U0YzE4MTU4N2Zh
-    YTgyOGRjNjlkNWRhMDZlMWZhYTYyZmI0ZTRkYjBiOWU1NmQ1YTA=
+    MWU1NDBjYmUyOGRjNTk3MGFiZjY2MWM2YTc0MDAxNzI2YmQzM2U5YjViMTQz
+    ZGUwYTQ4ZmMzNTJhZjRlOTI1ODBhMTkzMWFhNDQxOWE4MGJiM2Q0MjU1MmJl
+    ZWU4YWVjYmJhYWE4MzIxOGNhYWMzMjY3M2M2YWJhNDczZTIyYzY=

data/lib/logstash/filters/mixpanel.rb

@@ -18,14 +18,15 @@ class LogStash::Filters::Mixpanel < LogStash::Filters::Base
   #   }
   # }
   #
-  config_name "mixpanel"
-  
+  config_name 'mixpanel'
+
   # Replace the message with this value.
   config :api_key, :validate => :string, :required => true
   config :api_secret, :validate => :string, :required => true
-  config :where, :validate => :string, :required => true
+  config :where, :validate => :array, :required => true
   config :source, :validate => :string, :default => 'message'
   config :target, :validate => :string, :default => 'mixpanel'
+  config :tag_on_failure, :validate => :array, :default => ['_mixpanelfilterfailure']
 
 
   public
@@ -40,19 +41,49 @@ class LogStash::Filters::Mixpanel < LogStash::Filters::Base
   def filter(event)
 
     result = fetch_data
-    # TODO: remove puts result
-    puts result
-    event[@target] = result
+    if !result.nil?
+      event[@target] = result
 
-    # filter_matched should go in the last line of our successful code
-    filter_matched(event)
+      # filter_matched should go in the last line of our successful code
+      filter_matched(event)
+    else
+      @tag_on_failure.each do |tag|
+        event['tags'] ||= []
+        event['tags'] << tag unless event["tags"].include?(tag)
+      end
+    end
   end # def filter
 
   private
   def fetch_data
     options = {}
-    # options['where'] = @where if @where
-    result = @mp.request('engage', options)
+    options['where'] = prepare_where @where if @where
+
+    response = @mp.request('engage', options)
+    if response['results'].size >= 1
+      single_res = response['results'][0]
+    else
+      return nil
+    end
+    distinct_id = single_res['$distinct_id']
+    result = single_res['$properties']
+    result['$distinct_id'] = distinct_id
     result
   end
+
+  private
+  def prepare_where wheredata
+    special_properties = %w(email first_name last_name last_seen created)
+    res_array = []
+    wheredata.each { |constraint|
+      constraint.each { |key, value|
+        # prepend key with dollar sigh if key is in special_properties
+        # TODO: add test for special properties without dollar sign
+        key = "$#{key}" if special_properties.include? key
+
+        res_array.push "properties[\"#{key}\"] == \"#{value}\""
+      }
+    }
+    res_array.join ' and '
+  end
 end # class LogStash::Filters::Example

data/logstash-filter-mixpanel.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'logstash-filter-mixpanel'
-  s.version = '0.1.1'
+  s.version = '0.1.3'
   s.version = "#{s.version}.pre.#{ENV['TRAVIS_BUILD_NUMBER']}" if ENV['TRAVIS'] and ENV['TRAVIS_BRANCH'] != 'master'
   s.licenses = ['Apache License (2.0)']
   s.summary = "This filter checks mixpanel for additional people data and adds it to the event data"

data/spec/filters/mixpanel_spec.rb

@@ -10,15 +10,35 @@ describe LogStash::Filters::Mixpanel do
   before(:all) do
     @mp = Mixpanel::Tracker.new(ENV['MP_PROJECT_TOKEN'])
 
-    @user_id = FFaker::Guid.guid
-    @user_ip = FFaker::Internet.ip_v4_address
-    @user_data = {
-        :$first_name => FFaker::NameDE.first_name,
-        :$last_name => FFaker::NameDE.last_name,
-        :$email => FFaker::Internet.safe_email
+    @user_1_id = FFaker::Guid.guid
+    @user_1_ip = FFaker::Internet.ip_v4_address
+    @user_1_email = FFaker::Internet.safe_email
+    @user_1_first_name = FFaker::NameDE.first_name
+    @user_1_last_name = FFaker::NameDE.last_name
+    @user_1_data = {
+        :$first_name => @user_1_first_name,
+        :$last_name => @user_1_last_name,
+        :$email => @user_1_email,
+        'Device ID' => @user_1_id
     }
-    @mp.people.set(@user_id, @user_data, ip=@user_ip)
-    @mp.track(@user_id, 'user created')
+    @mp.people.set(@user_1_id, @user_1_data, ip=@user_1_ip)
+    @mp.track(@user_1_id, 'user 1 created')
+
+    @user_2_id = FFaker::Guid.guid
+    @user_2_ip = FFaker::Internet.ip_v4_address
+    @user_2_email = FFaker::Internet.safe_email
+    @user_2_first_name = @user_1_first_name
+    @user_2_last_name = @user_1_last_name
+    @user_2_data = {
+        :$first_name => @user_2_first_name,
+        :$last_name => @user_2_last_name,
+        :$email => @user_2_email,
+        'Device ID' => @user_2_id
+    }
+    @mp.people.set(@user_2_id, @user_2_data, ip=@user_2_ip)
+    @mp.track(@user_2_id, 'user 2 created')
+
+
   end
 
   context 'raise error' do
@@ -53,7 +73,7 @@ describe LogStash::Filters::Mixpanel do
         config = {
             'api_key' => '123',
             'api_secret' => '123',
-            'where' => '123'
+            'where' => [{'Device ID' => @user_1_id}]
         }
         filter = LogStash::Filters::Mixpanel.new config
         filter.register
@@ -70,7 +90,7 @@ describe LogStash::Filters::Mixpanel do
         config = {
             'api_key' => ENV['MP_PROJECT_KEY'],
             'api_secret' => '123',
-            'where' => '123'
+            'where' => [{'Device ID' => @user_1_id}]
         }
         filter = LogStash::Filters::Mixpanel.new config
         filter.register
@@ -85,29 +105,96 @@ describe LogStash::Filters::Mixpanel do
   end
 
   context 'fetch created user' do
-    let(:config) do <<-CONFIG
+    context 'by device id' do
+      let(:config) do <<-CONFIG
       filter {
         mixpanel {
           api_key => '#{ENV['MP_PROJECT_KEY']}'
           api_secret => '#{ENV['MP_PROJECT_SECRET']}'
-          where => '123'
+          where => [{'Device ID' => '#{@user_1_id}'}]
         }
       }
-    CONFIG
+      CONFIG
+      end
+
+      sample("message" => "123") do
+        expect(subject).to include('mixpanel')
+        expect(subject['mixpanel']).to include('Device ID')
+        expect(subject['mixpanel']).to include('$distinct_id')
+        expect(subject['mixpanel']).to include('$email')
+        expect(subject['mixpanel']).to include('$last_name')
+        expect(subject['mixpanel']).to include('Device ID')
+        insist { subject['tags'] }.nil?
+      end
     end
 
-    # sample("message" => "123") do
-    #   expect(subject).to include('mixpanel')
-    # end
+    context 'by email' do
+      let(:config) do <<-CONFIG
+      filter {
+        mixpanel {
+          api_key => '#{ENV['MP_PROJECT_KEY']}'
+          api_secret => '#{ENV['MP_PROJECT_SECRET']}'
+          where => [{'email' => '#{@user_1_email}'}]
+        }
+      }
+      CONFIG
+      end
 
-    context 'by distinct id' do
       sample("message" => "123") do
         expect(subject).to include('mixpanel')
+        expect(subject['mixpanel']).to include('Device ID')
+        expect(subject['mixpanel']).to include('$distinct_id')
+        expect(subject['mixpanel']).to include('$email')
+        expect(subject['mixpanel']).to include('$last_name')
+        expect(subject['mixpanel']).to include('Device ID')
+        insist { subject['tags'] }.nil?
       end
     end
   end
 
+  context 'test on multiple returns' do
+    let(:config) do <<-CONFIG
+      filter {
+        mixpanel {
+          api_key => '#{ENV['MP_PROJECT_KEY']}'
+          api_secret => '#{ENV['MP_PROJECT_SECRET']}'
+          where => [{'first_name' => '#{@user_1_first_name}'}]
+        }
+      }
+    CONFIG
+    end
+
+    sample("message" => "123") do
+      expect(subject).to include('mixpanel')
+      expect(subject['mixpanel']).to include('Device ID')
+      expect(subject['mixpanel']).to include('$distinct_id')
+      expect(subject['mixpanel']).to include('$email')
+      expect(subject['mixpanel']).to include('$last_name')
+      expect(subject['mixpanel']).to include('Device ID')
+      insist { subject['tags'] }.nil?
+    end
+  end
+
+  context 'test on no returns' do
+    let(:config) do <<-CONFIG
+      filter {
+        mixpanel {
+          api_key => '#{ENV['MP_PROJECT_KEY']}'
+          api_secret => '#{ENV['MP_PROJECT_SECRET']}'
+          where => [{'first_name' => 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'}]
+        }
+      }
+    CONFIG
+    end
+
+    sample("message" => "123") do
+      insist { subject["tags"] }.include?('_mixpanelfilterfailure')
+      reject { subject }.include?('mixpanel')
+    end
+  end
+
   after(:all) do
-    @mp.people.delete_user(@user_id)
+    @mp.people.delete_user(@user_1_id)
+    @mp.people.delete_user(@user_2_id)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-mixpanel
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Torsten Feld
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-06 00:00:00.000000000 Z
+date: 2015-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-core