logstash-filter-mixpanel 0.1.0 → 0.1.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZWM4MmFhYmZjMGE4NDFkZGI2YWQ0MDg0ODI1NDMwMzY1ZGQ2NzkyMQ==
+    ZDA1YzRhYzRiMTJhYzRlZDliOTQ1NjI3NmJhM2I0NjQ5ZjJmN2Y2Ng==
   data.tar.gz: !binary |-
-    MDYyOGFlYTZkZGQ0MDNmZDdiYmRkOThjMTNjNzYzMWQ5N2Q1M2MyNw==
+    Nzg2ZDMxYzYzNzdlY2Q3NzY2YTgzZDJkZjEwZjg4NWFlM2YyMDg1OA==
 SHA512:
   metadata.gz: !binary |-
-    Nzk5MzZhYTcyYTRjNTlkMGUzNThiMTUzZmM5OGFmMGEzMGZiNGE5YjMzZmUz
-    MTE3NDk3OWZkNjhmZjc0NDQzNzMxMTYxZWExYmJhMjI4YjhiMzEwMjJlMDdj
-    NmQyNzFjMjk1MzRhMDFiMDU4YjdiNTcxYmVjMTNiNWE3NjE4OTA=
+    MGQ3M2VjMjRmMzk3NWVjYTJmOTNlMjJkOTlhYjcwM2RjNGE4YzVjZTJjODFm
+    ZWFkMzFhMjUwNzU1N2ZhNjY4NjQ4YzY5YjdjNjc1NmQwZTBiZWNkNmFiZmE3
+    ZTJjOTY4NjBhYzhmMjUxMmQ5N2RiYTg2NGM2ZGE1YzBmNDY5NGY=
   data.tar.gz: !binary |-
-    ZjFlNDUwOWJkM2M4ODgyZmU4MTEwNmNjNDA3YWZjNzcyNTAyMmE3ODk1MzNm
-    MGQxZmQ3MzRmYzNlYTkxMzEzYjM2NzAyYzI5OTFjODdkNzBmNmRlOTA5ZWU0
-    ZTdjNGYyOTY2YmM1YWRhZjJmODczOWE0MDhlOTBhOGNlYWJkMTg=
+    ZTY3MjBmMjdiYWIzYjM2M2MyZGVhYjJhMzU1ZDZlNmI4MGU4MDY2YjQxNDdk
+    NWY1OTg4Nzg1ZjM4OTE2NWFkMTcwN2I5ZDk3YmUzN2MyN2U0YzE4MTU4N2Zh
+    YTgyOGRjNjlkNWRhMDZlMWZhYTYyZmI0ZTRkYjBiOWU1NmQ1YTA=

data/Gemfile

@@ -1,3 +1,6 @@
 source 'https://rubygems.org'
 gemspec
-gem 'coveralls', require: false
+gem 'mixpanel_client', '~> 4.1.2'
+gem 'coveralls', require: false
+# gem "ffaker", "~> 2.0"
+# gem "mixpanel-ruby", "< 2.0"

data/README.md

@@ -6,7 +6,7 @@ It is fully free and fully open source. The license is Apache 2.0, meaning you a
 
 # Status
 - [![Gem Version](https://badge.fury.io/rb/logstash-filter-mixpanel.svg)](http://badge.fury.io/rb/logstash-filter-mixpanel)
-- [![Build Status](https://travis-ci.org/torstenfeld/logstash-filter-mixpanel.svg?branch=master)](https://travis-ci.org/torstenfeld/logstash-filter-mixpanel) (master)
+- [![Build Status](https://travis-ci.org/torstenfeld/logstash-filter-mixpanel.svg?branch=master)](https://travis-ci.org/torstenfeld/logstash-filter-mixpanel)
 - [![Coverage Status](https://coveralls.io/repos/torstenfeld/logstash-filter-mixpanel/badge.svg?branch=master)](https://coveralls.io/r/torstenfeld/logstash-filter-mixpanel?branch=master)
 - [![Code Climate](https://codeclimate.com/github/torstenfeld/logstash-filter-mixpanel/badges/gpa.svg)](https://codeclimate.com/github/torstenfeld/logstash-filter-mixpanel)
 - [![Dependency Status](https://gemnasium.com/torstenfeld/logstash-filter-mixpanel.svg)](https://gemnasium.com/torstenfeld/logstash-filter-mixpanel)
@@ -15,8 +15,7 @@ It is fully free and fully open source. The license is Apache 2.0, meaning you a
 
 - Edit Logstash `Gemfile` and add needed requirements:
 ```ruby
-gem "whatlanguage"
-gem "logstash-filter-mixpanel", ">= 0.2.0", :git => "https://github.com/torstenfeld/logstash-filter-mixpanel.git"
+gem "logstash-filter-mixpanel", ">= 0.1.0", :git => "https://github.com/torstenfeld/logstash-filter-mixpanel.git"
 ```
 
 
@@ -24,3 +23,6 @@ gem "logstash-filter-mixpanel", ">= 0.2.0", :git => "https://github.com/torstenf
 ```sh
 bundle install
 ```
+
+# Using
+[![Mixpanel Logo](https://cdn.mxpnl.com/site_media/images/partner/badge_blue.png)](https://mixpanel.com/f/partner)

data/lib/logstash/filters/mixpanel.rb

@@ -1,12 +1,13 @@
 # encoding: utf-8
 require "logstash/filters/base"
 require "logstash/namespace"
+require 'mixpanel_client'
 
 # This example filter will replace the contents of the default 
 # message field with whatever you specify in the configuration.
 #
 # It is only intended to be used as an example.
-class LogStash::Filters::Example < LogStash::Filters::Base
+class LogStash::Filters::Mixpanel < LogStash::Filters::Base
 
   # Setting the config_name here is required. This is how you
   # configure this filter from your Logstash config.
@@ -17,27 +18,41 @@ class LogStash::Filters::Example < LogStash::Filters::Base
   #   }
   # }
   #
-  config_name "example"
+  config_name "mixpanel"
   
   # Replace the message with this value.
-  config :message, :validate => :string, :default => "Hello World!"
-  
+  config :api_key, :validate => :string, :required => true
+  config :api_secret, :validate => :string, :required => true
+  config :where, :validate => :string, :required => true
+  config :source, :validate => :string, :default => 'message'
+  config :target, :validate => :string, :default => 'mixpanel'
+
 
   public
   def register
-    # Add instance variables 
+    @mp = Mixpanel::Client.new(
+      api_key: @api_key,
+      api_secret: @api_secret
+    )
   end # def register
 
   public
   def filter(event)
 
-    if @message
-      # Replace the event message with our message as configured in the
-      # config file.
-      event["message"] = @message
-    end
+    result = fetch_data
+    # TODO: remove puts result
+    puts result
+    event[@target] = result
 
     # filter_matched should go in the last line of our successful code
     filter_matched(event)
   end # def filter
+
+  private
+  def fetch_data
+    options = {}
+    # options['where'] = @where if @where
+    result = @mp.request('engage', options)
+    result
+  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.0'
+  s.version = '0.1.1'
   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"
@@ -20,6 +20,9 @@ Gem::Specification.new do |s|
 
   # Gem dependencies
   s.add_runtime_dependency "logstash-core", '>= 1.4.0', '< 2.0.0'
+  s.add_runtime_dependency "mixpanel_client", '~> 4.1'
   s.add_development_dependency 'logstash-devutils'
-  s.add_development_dependency 'coveralls', '~> 0.8.1'
+  s.add_development_dependency 'coveralls', '~> 0.8'
+  s.add_development_dependency 'ffaker', '~> 2.0'
+  s.add_development_dependency 'mixpanel-ruby', '< 2.0'
 end

data/mixpanel_test.rb

@@ -0,0 +1,43 @@
+# require File.absolute_path(File.join(File.dirname(__FILE__), 'lib/logstash/filters/mixpanel'))
+# require 'lib/logstash/filters/mixpanel'
+
+
+class MixpanelTest
+  def initialize
+    require 'rubygems'
+    require 'mixpanel_client'
+    @mp = Mixpanel::Client.new(
+        api_key: ENV['MP_PROJECT_KEY'],
+        api_secret: ENV['MP_PROJECT_SECRET']
+    )
+  end
+
+  def run
+    result = fetch_data
+    result
+  end
+
+  private
+  def fetch_data
+    result = @mp.request('engage', {})
+    result
+  end
+end
+
+# mpt = MixpanelTest.new
+# mpt.config
+# res = mpt.run
+# puts res.inspect
+
+test_hash = {
+    'filter' {
+        'languagedetect' => {
+            'api_key' => ENV['MP_PROJECT_KEY'],
+            'api_secret' => ENV['MP_PROJECT_SECRET'],
+            'where' => '123'
+        }
+    }
+}
+
+test_string = test_hash.to_s
+puts test_string

data/spec/filters/mixpanel_spec.rb

@@ -1,20 +1,113 @@
 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 'mixpanel_client'
+require 'mixpanel-ruby'
+require 'ffaker'
+require 'base64'
 
-describe LogStash::Filters::Example do
-  describe "Set to Hello World" do
+
+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
+    }
+    @mp.people.set(@user_id, @user_data, ip=@user_ip)
+    @mp.track(@user_id, 'user created')
+  end
+
+  context 'raise error' do
+    context 'on wrong api key config' do
+      subject {
+        config = {
+            'api_key' => 123
+        }
+        filter = LogStash::Filters::Mixpanel.new config
+      }
+
+      it 'should raise error on invalid api key config' do
+        insist { subject.register }.raises(LogStash::ConfigurationError)
+      end
+    end
+
+    context 'on wrong api secret config' do
+      subject {
+        config = {
+            'api_secret' => 123
+        }
+        filter = LogStash::Filters::Mixpanel.new config
+      }
+
+      it 'should raise error on invalid api secret config' do
+        insist { subject.register }.raises(LogStash::ConfigurationError)
+      end
+    end
+
+    context 'on invalid api key' do
+      subject {
+        config = {
+            'api_key' => '123',
+            'api_secret' => '123',
+            'where' => '123'
+        }
+        filter = LogStash::Filters::Mixpanel.new config
+        filter.register
+        filter.filter LogStash::Event.new
+      }
+
+      it 'should raise error on invalid api key' do
+        insist { subject.filter.flush }.raises(Mixpanel::HTTPError)
+      end
+    end
+
+    context 'on invalid api secret' do
+      subject {
+        config = {
+            'api_key' => ENV['MP_PROJECT_KEY'],
+            'api_secret' => '123',
+            'where' => '123'
+        }
+        filter = LogStash::Filters::Mixpanel.new config
+        filter.register
+        filter.filter LogStash::Event.new
+        # filter.filter LogStash::Event.new({'message' => 'test'})
+      }
+
+      it 'should raise error on invalid api secret' do
+        insist { subject.filter.flush }.raises(Mixpanel::HTTPError)
+      end
+    end
+  end
+
+  context 'fetch created user' do
     let(:config) do <<-CONFIG
       filter {
-        example {
-          message => "Hello World"
+        mixpanel {
+          api_key => '#{ENV['MP_PROJECT_KEY']}'
+          api_secret => '#{ENV['MP_PROJECT_SECRET']}'
+          where => '123'
         }
       }
     CONFIG
     end
 
-    sample("message" => "some text") do
-      expect(subject).to include("message")
-      expect(subject['message']).to eq('Hello World')
+    # sample("message" => "123") do
+    #   expect(subject).to include('mixpanel')
+    # end
+
+    context 'by distinct id' do
+      sample("message" => "123") do
+        expect(subject).to include('mixpanel')
+      end
     end
   end
+
+  after(:all) do
+    @mp.people.delete_user(@user_id)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-mixpanel
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Torsten Feld
@@ -30,6 +30,20 @@ dependencies:
     - - <
       - !ruby/object:Gem::Version
         version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: mixpanel_client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: logstash-devutils
   requirement: !ruby/object:Gem::Requirement
@@ -50,14 +64,42 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: ffaker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: mixpanel-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - <
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - <
+      - !ruby/object:Gem::Version
+        version: '2.0'
 description: This gem is a logstash plugin required to be installed on top of the
   Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not
   a stand-alone program
@@ -77,6 +119,7 @@ files:
 - Rakefile
 - lib/logstash/filters/mixpanel.rb
 - logstash-filter-mixpanel.gemspec
+- mixpanel_test.rb
 - spec/filters/mixpanel_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/torstenfeld/logstash-filter-mixpanel