logstash-filter-mixpanel 0.1.3 → 0.1.4

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YzNhMGYxMmM5OTBkZjFlMjQxZDc0NjE4ZjRmMzk1NWI0ZjQ4N2U2ZA==
+    ZDU0ODI4YTRjYjk1YzRiNDk5YTdkZTNhMWRmM2U4MjMyNzNmMmMxNA==
   data.tar.gz: !binary |-
-    YTRlMzhmOTc3MzhlZjYwZWZkZWJiMTdlY2Q1Mzk3YWJiOWNhMWMyMg==
+    Y2E2ZDE0OGNjOGQ0MGQwNDBjNDhlZGRkYjEzMDc5ODcyNmQ1MTA5ZQ==
 SHA512:
   metadata.gz: !binary |-
-    MzIyMDhkODU3YWJkMjdlNGY5Yzc4ZGUyMDI4NzRjMWVjZDVmYjhkY2Q5M2Fi
-    NTIxY2RmMTkyYTMzYmNiMzdiYzRjZTNjNTFkYTI2ZWJlN2E4YjNkNzIyZDU0
-    ZTljYTNkZGMzMTE1NTE5ZWY2MzkyYjExOWI4ZmRlZTRiOTI5MDA=
+    NmFjMmI3MTdkMjAxOWVkY2RlNzBmOWJiMTc0MDU0OWQzZGFmODZiZWRhYjE1
+    ZThlMTI1NGNlMjU0NTIxMmQ3NDE4Njk4OWFjODNlZmNjNmNlZGFiMTdlNGNh
+    YTg0ZTIxNjU5NGNkNmExNmJhODVlZmMzYjFmYzY1YzUzZWYzMmE=
   data.tar.gz: !binary |-
-    MWU1NDBjYmUyOGRjNTk3MGFiZjY2MWM2YTc0MDAxNzI2YmQzM2U5YjViMTQz
-    ZGUwYTQ4ZmMzNTJhZjRlOTI1ODBhMTkzMWFhNDQxOWE4MGJiM2Q0MjU1MmJl
-    ZWU4YWVjYmJhYWE4MzIxOGNhYWMzMjY3M2M2YWJhNDczZTIyYzY=
+    ODViNGM2ZDU0NjhlYmQ0NGYwYjkyZjVkM2UxODkyMmEyYzUwNGQ2ZmI1MDQ4
+    MTgwOTMzYjY5NDRmNzdkOGVhZjk3NWNiYTE1ZWUxMTJkNjJlOTFkODI4N2Mw
+    YTY2OTE4NDQ5ZmI0ZjJkZmMwZDg2YjUxODNiN2JiZGJiZGYwZjY=

data/lib/logstash/filters/mixpanel.rb

@@ -24,9 +24,11 @@ class LogStash::Filters::Mixpanel < LogStash::Filters::Base
   config :api_key, :validate => :string, :required => true
   config :api_secret, :validate => :string, :required => true
   config :where, :validate => :array, :required => true
+  config :use_or, :validate => :boolean, :default => false
   config :source, :validate => :string, :default => 'message'
   config :target, :validate => :string, :default => 'mixpanel'
   config :tag_on_failure, :validate => :array, :default => ['_mixpanelfilterfailure']
+  config :tag_on_multiresults, :validate => :array, :default => ['_mixpanelfiltermultiresults']
 
 
   public
@@ -40,7 +42,7 @@ class LogStash::Filters::Mixpanel < LogStash::Filters::Base
   public
   def filter(event)
 
-    result = fetch_data
+    result = fetch_data event
     if !result.nil?
       event[@target] = result
 
@@ -55,12 +57,18 @@ class LogStash::Filters::Mixpanel < LogStash::Filters::Base
   end # def filter
 
   private
-  def fetch_data
+  def fetch_data(event)
     options = {}
     options['where'] = prepare_where @where if @where
 
     response = @mp.request('engage', options)
-    if response['results'].size >= 1
+    if response['results'].size == 1
+      single_res = response['results'][0]
+    elsif response['results'].size > 1
+      @tag_on_multiresults.each do |tag|
+        event['tags'] ||= []
+        event['tags'] << tag unless event['tags'].include?(tag)
+      end
       single_res = response['results'][0]
     else
       return nil
@@ -72,18 +80,22 @@ class LogStash::Filters::Mixpanel < LogStash::Filters::Base
   end
 
   private
-  def prepare_where wheredata
+  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 '
+    if @use_or
+      result = res_array.join ' or '
+    else
+      result = res_array.join ' and '
+    end
+    result
   end
-end # class LogStash::Filters::Example
+end # class LogStash::Filters::Mixpanel

data/logstash-filter-mixpanel.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'logstash-filter-mixpanel'
-  s.version = '0.1.3'
+  s.version = '0.1.4'
   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

@@ -1,5 +1,6 @@
 require File.absolute_path(File.join(File.dirname(__FILE__), '../../spec/spec_helper'))
 require File.absolute_path(File.join(File.dirname(__FILE__), '../../lib/logstash/filters/mixpanel'))
+require 'rspec'
 require 'mixpanel_client'
 require 'mixpanel-ruby'
 require 'ffaker'
@@ -7,39 +8,6 @@ require 'base64'
 
 
 describe LogStash::Filters::Mixpanel do
-  before(:all) do
-    @mp = Mixpanel::Tracker.new(ENV['MP_PROJECT_TOKEN'])
-
-    @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_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
     context 'on wrong api key config' do
@@ -106,95 +74,244 @@ describe LogStash::Filters::Mixpanel do
 
   context 'fetch created user' do
     context 'by device id' do
+      before {
+        @id = FFaker::Guid.guid
+        @expected_result = {
+            'page' => 0,
+            'page_size' => 1000,
+            'results' => [{ '$distinc_id' => 123124,
+                            '$properties' => { '$created' => '2008-12-12T11:20:47',
+                                               '$email' => 'example@mixpanel.com',
+                                               '$first_name' => 'Example',
+                                               '$last_name' => 'Name',
+                                               'Device ID' => @id,
+                                               '$last_seen' => '2008-06-09T23:08:40' }
+                          }]
+        }
+        Mixpanel::Client.any_instance.stub(:request).and_return(@expected_result)
+      }
+
       let(:config) do <<-CONFIG
       filter {
         mixpanel {
           api_key => '#{ENV['MP_PROJECT_KEY']}'
           api_secret => '#{ENV['MP_PROJECT_SECRET']}'
-          where => [{'Device ID' => '#{@user_1_id}'}]
+          where => [{'Device ID' => '#{@id}'}]
         }
       }
       CONFIG
       end
 
-      sample("message" => "123") 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')
+        expect(subject['mixpanel']['Device ID']).to eq(@id)
+        expect(subject['mixpanel']).to eq(@expected_result['results'][0]['$properties'])
         insist { subject['tags'] }.nil?
       end
     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}'}]
+    # TODO: Create Unit test for "by email if it has no dollar char"
+    # context 'by email if it has no dollar char' do
+    #   before {
+    #     @id = FFaker::Guid.guid
+    #     @expected_result = {
+    #         'page' => 0,
+    #         'page_size' => 1000,
+    #         'results' => [{ '$distinc_id' => 123124,
+    #                         '$properties' => { '$created' => '2008-12-12T11:20:47',
+    #                                            '$email' => 'example@mixpanel.com',
+    #                                            '$first_name' => 'Example',
+    #                                            '$last_name' => 'Name',
+    #                                            'Device ID' => @id,
+    #                                            '$last_seen' => '2008-06-09T23:08:40' }
+    #                       }]
+    #     }
+    #     Mixpanel::Client.any_instance.stub(:request).and_return(@expected_result)
+    #   }
+    #
+    #   let(:config) do <<-CONFIG
+    #   filter {
+    #     mixpanel {
+    #       api_key => '#{ENV['MP_PROJECT_KEY']}'
+    #       api_secret => '#{ENV['MP_PROJECT_SECRET']}'
+    #       where => [{'email' => '#{@id}'}]
+    #     }
+    #   }
+    #   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
+    #
+    # TODO: Create Unit test for "by email if it has dollar char"
+    # context 'by email if it has dollar char' 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
+    #
+    #   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
+    context 'with and constraint' do
+      before {
+        @first_name = FFaker::NameDE.first_name
+        @expected_result = {
+            'page' => 0,
+            'page_size' => 1000,
+            'results' => [{ '$distinc_id' => 123124,
+                            '$properties' => { '$created' => '2008-12-12T11:20:47',
+                                               '$email' => 'example1@mixpanel.com',
+                                               '$first_name' => @first_name,
+                                               '$last_name' => 'Name1',
+                                               'Device ID' => '123',
+                                               '$last_seen' => '2008-06-09T23:08:40' }
+                          }, { '$distinc_id' => 1231244,
+                            '$properties' => { '$created' => '2008-12-12T11:20:47',
+                                               '$email' => 'example2@mixpanel.com',
+                                               '$first_name' => @first_name,
+                                               '$last_name' => 'Name2',
+                                               'Device ID' => '1234',
+                                               '$last_seen' => '2008-06-09T23:08:40' }
+                          }]
         }
+        Mixpanel::Client.any_instance.stub(:request).and_return(@expected_result)
       }
-      CONFIG
+
+      let(:config) do <<-CONFIG
+        filter {
+          mixpanel {
+            api_key => '#{ENV['MP_PROJECT_KEY']}'
+            api_secret => '#{ENV['MP_PROJECT_SECRET']}'
+            where => [{'first_name' => '#{@first_name}'}]
+          }
+        }
+        CONFIG
       end
 
-      sample("message" => "123") do
-        expect(subject).to include('mixpanel')
+      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('$first_name')
         expect(subject['mixpanel']).to include('$last_name')
         expect(subject['mixpanel']).to include('Device ID')
-        insist { subject['tags'] }.nil?
+        expect(subject).to include('tags')
+
+        expect(subject['tags']).to include('_mixpanelfiltermultiresults')
+        expect(subject['mixpanel']).to eq(@expected_result['results'][0]['$properties'])
+        # expect(subject['mixpanel']['$first_name']).to eq(@first_name)
+        # expect(subject['mixpanel']['$last_name']).to eq('Name1')
       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}'}]
+    context 'with or constraint' do
+      before {
+        @email1 = FFaker::Internet.safe_email
+        @email2 = FFaker::Internet.safe_email
+        @expected_result = {
+            'page' => 0,
+            'page_size' => 1000,
+            'results' => [{ '$distinc_id' => 123124,
+                            '$properties' => { '$created' => '2008-12-12T11:20:47',
+                                               '$email' => 'example1@mixpanel.com',
+                                               '$first_name' => 'Firstname1',
+                                               '$last_name' => 'Name1',
+                                               'Device ID' => '123',
+                                               '$last_seen' => '2008-06-09T23:08:40' }
+                          }, { '$distinc_id' => 1231244,
+                               '$properties' => { '$created' => '2008-12-12T11:20:47',
+                                                  '$email' => 'example1@mixpanel.com',
+                                                  '$first_name' => 'Firstname2',
+                                                  '$last_name' => 'Name2',
+                                                  'Device ID' => '1234',
+                                                  '$last_seen' => '2008-06-09T23:08:40' }
+                          }]
         }
+        Mixpanel::Client.any_instance.stub(:request).and_return(@expected_result)
       }
-    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?
+      let(:config) do <<-CONFIG
+        filter {
+          mixpanel {
+            api_key => '#{ENV['MP_PROJECT_KEY']}'
+            api_secret => '#{ENV['MP_PROJECT_SECRET']}'
+            where => [{'email' => '#{@email1}'}, {'email' => '#{@email2}'}]
+            use_or => true
+          }
+        }
+      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')
+
+        expect(subject).to include('tags')
+        expect(subject['tags']).to include('_mixpanelfiltermultiresults')
+        expect(subject['mixpanel']).to eq(@expected_result['results'][0]['$properties'])
+      end
     end
   end
 
   context 'test on no returns' do
+    before {
+      @expected_result = {
+          'page' => 0,
+          'page_size' => 1000,
+          'results' => []
+      }
+      Mixpanel::Client.any_instance.stub(:request).and_return(@expected_result)
+    }
+
     let(:config) do <<-CONFIG
       filter {
         mixpanel {
           api_key => '#{ENV['MP_PROJECT_KEY']}'
           api_secret => '#{ENV['MP_PROJECT_SECRET']}'
-          where => [{'first_name' => 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'}]
+          where => [{'$first_name' => 'thisfirstnameshouldneverbeseen123'}]
         }
       }
     CONFIG
     end
 
-    sample("message" => "123") do
-      insist { subject["tags"] }.include?('_mixpanelfilterfailure')
+    sample('message' => '123') do
+      insist { subject['tags'] }.include?('_mixpanelfilterfailure')
       reject { subject }.include?('mixpanel')
     end
   end
-
-  after(:all) do
-    @mp.people.delete_user(@user_1_id)
-    @mp.people.delete_user(@user_2_id)
-  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-mixpanel
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Torsten Feld