pushpop-mixpanel 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a8d3ba15e9deadfad48828151d9125ce21ba2c22
+  data.tar.gz: 7445263059c8d122ffc90f223d81acffd97cfecf
+SHA512:
+  metadata.gz: 3a2215952a98ba15628eab98749cc40be9e27d709302b5af2f4f6fff4badd9168af0123e9b8dd3091542c0a03498e57d4fa8826a5723eb81f7782cf3b58cdd28
+  data.tar.gz: 3ecff53f78ff4c6e450d4868ef713ade684633f6d16dceb399e7191e17eaff264917e9de711d897d52ffb65f8d34d250b296d24c2cbabc07afa5039ed820d3a4

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+bundler_args: --without development
+
+rvm:
+  - 2.1.1
+
+script:
+  - bundle exec rake spec

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gem 'pushpop'
+gem 'mixpanel-ruby', '~>2.1.0'
+
+group :development, :test do
+  gem 'rake'
+  gem 'rspec'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+Author Joe Wegner
+Copyright (c) 2015 Keen Labs
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,141 @@
+# pushpop-mixpanel
+
+Mixpanel plugin for [Pushpop](https://github.com/pushpop-project/pushpop).
+
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Global Functions](#global-functions)
+  - [Tracking Functions](#tracking-functions)
+  - [User Functions](#user-functions)
+  - [Analysis Functions](#analysis-functions)
+- [Contributing](#contributing)
+
+## Installation
+
+Add `pushpop-mixpanel` to your Gemfile:
+
+```ruby
+gem 'pushpop-mixpanel'
+```
+
+or install it as a gem
+
+```bash
+$ gem install pushpop-mixpanel
+```
+
+## Usage
+
+The mixpanel plugin gives you a simple interface for tracking information to Mixpanel. You can very simply do all sorts of things with Mixpanel, including creating/deleting users, updating their properties, tracking events, or deleting users altogether.
+
+Here's a quick preview of what a mixpanel job might do
+
+``` ruby
+
+job 'track support users in mixpanel' do
+	
+	step 'receive users' do
+		# Pretend that this step checks for new support emails,
+		# and looks up some information based on that email
+	end
+
+	mixpanel do |response|
+		# Set the user you want to interact with
+		user response.email
+
+		# Update the user with some basic information
+		set({
+			name: response.name,
+			age: response.age
+		})
+
+		# Increment the support request count
+		# Values that aren't currently set will be treated as 0, and then incremented
+		increment({support_requests: 1})
+
+		# Track a charge of $10 (your support fee)
+		charge(10, {type: 'support charge'})
+	end
+end
+```
+
+In order to track things with `pushpop-mixpanel` you will need to drop your project token in the `MIXPANEL_PROJECT_TOKEN` environment variable.
+
+### Global Functions
+
+**user(id, [properties])**
+
+This sets the user context for the rest of the step. All functions run after this will be run with the user `id` specified here. If this user does not already exist in Mixpanel, it will be created.
+
+You can also pass in a hash of `properties` that will be set on the user. If the user already exists, the values in `properties` **will overwrite** existing properties.
+
+### Tracking Functions
+
+**track(name, [properties])**
+
+This will track an event for the currently set user. You can optionally pass in a hash of metadata for this event.
+
+### User Functions
+
+**set(properties)**
+
+Accepts a hash of properties that should be set for the current user. Any properties that already exist on that user will be overwritten by the new values in the hash.
+
+**create_alias(new_id, previous_id)**
+
+Creates a user id alias inside of Mixpanel. Any events/updates made with either `new_id` or `previous_id` going forward will now affect the same user inside of Mixpanel.
+
+_This will also update the current user context to be `new_id`._
+
+**increment(properties)**
+
+This will increment/decrement numeric properties based on the values provided in the hash. For example:
+
+``` ruby
+increment({
+	support_tickets: 1, # Increase ticket count by 1
+	available_balance: -10 # Decrease balance by 10
+})
+```
+
+Incrementing properties that don't currently exist on the user will preset the property to 0, and then do the increment. So incrementing a new property by `10` will set that property to `10`.
+
+**append(properties)**
+
+This will push a value on to the end of a list property. For instance, say your user currently has a property, `{devices: ['android']}`. Then you ran:
+
+``` ruby
+append({
+	devices: 'Mac'
+})
+```
+
+Their `devices` property would now be `['android', 'Mac']`.
+
+**charge(amount, [properties])**
+
+This will add a charge associated with the current user. `amount` should be a dollar value. You can optionally pass in a hash of `properties` that describe the charge.
+
+**delete([ignore_alias])**
+
+This deletes the current user from Mixpanel. **This is a destructive action, and cannot be undone**.
+
+To delete a user and ignore alias, pass `true` in to this function.
+
+### Analysis Functions
+
+For now we are just using [mixpanel_client](https://github.com/keolo/mixpanel_client) internally, so the syntax for doing analysis queries pretty directly matches that. Check out that README for details, but a basic query might look like:
+
+``` ruby
+mixpanel do
+  query 'events/properties',
+    event: 'Support Ticket',
+    type: 'unique',
+    unit: 'day', 
+    interval: 5
+end
+```
+
+## Contributing
+
+Code and documentation issues and pull requests are definitely welcome!

data/Rakefile

@@ -0,0 +1,16 @@
+$stdout.sync = true
+
+$: << File.join(File.dirname(__FILE__), './lib')
+
+begin
+  require 'rspec/core/rake_task'
+  desc 'Run Rspec unit tests'
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.pattern = 'spec/**/*_spec.rb'
+  end
+
+  task default: :spec
+rescue LoadError
+end
+
+

data/lib/pushpop-mixpanel.rb

@@ -0,0 +1,144 @@
+require 'pushpop'
+require 'mixpanel-ruby'
+require 'mixpanel_client'
+
+module Pushpop
+
+  class Mixpanel < Step
+
+    PLUGIN_NAME = 'mixpanel'
+
+    Pushpop::Job.register_plugin(PLUGIN_NAME, self)
+
+    attr_accessor :_user
+    attr_accessor :_endpoint
+    attr_accessor :_query_properties
+    attr_accessor :_user_created
+
+    ## Setup Functions
+
+    def run(last_response=nil, step_responses=nil)
+      ret = self.configure(last_response, step_responses)
+
+      unless self._user_created || self._user.nil?
+        set({})
+      end
+
+      if self._endpoint
+        Pushpop::Mixpanel.querent.request(self._endpoint, self._query_properties)
+      else
+        ret
+      end
+    end
+
+    def configure(last_response=nil, step_responses=nil)
+      self.instance_exec(last_response, step_responses, &block)
+    end
+
+    def user(id, properties = nil)
+      self._user = id
+    
+      if properties.nil?
+        self._user_created = false
+      else
+        self._user_created = true
+        Pushpop::Mixpanel.tracker.people.set(id, properties)
+      end
+    end
+
+    ### Querying Functions
+
+    def query(endpoint, properties = {})
+      self._endpoint = endpoint
+      self._query_properties = properties 
+    end
+
+    ## Tracking Functions
+
+    def track(name, properties = nil)
+      raise 'You have to set the user before tracking mixpanel events' unless self._user
+
+      if properties.nil?
+        Pushpop::Mixpanel.tracker.track(self._user, name)
+      else
+        Pushpop::Mixpanel.tracker.track(self._user, name, properties)
+      end
+    end
+
+    ## User Functions
+    
+    def set(properties)
+      raise 'You have to set the user before updating properties' unless self._user
+      self._user_created = true
+      
+      Pushpop::Mixpanel.tracker.people.set(self._user, properties)
+    end
+
+    def create_alias(new_id, previous_id)
+      Pushpop::Mixpanel.tracker.alias(new_id, previous_id)
+      self._user = new_id
+    end
+
+    def increment(properties)
+      raise 'You have to set the user before incrementing' unless self._user
+      Pushpop::Mixpanel.tracker.people.increment(self._user, properties)
+    end
+
+    def append(properties)
+      raise 'You have to set the user before appending proeprties to it' unless self._user
+      Pushpop::Mixpanel.tracker.people.append(self._user, properties)
+    end
+
+    def charge(amount, properties = nil)
+      raise 'You have to set the user before charging them' unless self._user
+
+      if properties.nil?
+        Pushpop::Mixpanel.tracker.people.track_charge(self._user, amount)
+      else
+        Pushpop::Mixpanel.tracker.people.track_charge(self._user, amount, properties)
+      end
+    end
+
+    def delete(ignore_alias = false)
+      raise 'You have to set the user to delete' unless self._user
+
+      if ignore_alias
+        Pushpop::Mixpanel.tracker.people.delete_user(self._user, {"$ignore_alias" => true})  
+      else
+        Pushpop::Mixpanel.tracker.people.delete_user(self._user)
+      end
+    end
+    
+    
+    class << self
+      def tracker
+        if @tracker
+          @tracker
+        else
+          if !ENV['MIXPANEL_PROJECT_TOKEN'].nil? && !ENV['MIXPANEL_PROJECT_TOKEN'].empty?
+            @tracker = ::Mixpanel::Tracker.new(ENV['MIXPANEL_PROJECT_TOKEN'])
+          else
+            raise 'You must provide a mixpanel project token'
+          end
+        end
+      end
+
+      def querent
+        if @querent
+          @querent
+        else
+          if ENV['MIXPANEL_API_KEY'].nil? || ENV['MIXPANEL_API_KEY'].empty?
+            raise 'You must provide a mixpanel api key'
+          elsif ENV['MIXPANEL_API_SECRET'].nil? || ENV['MIXPANEL_API_SECRET'].empty?
+            raise 'Ypu must provide a mixpanel api secret'
+          else
+            @querent = ::Mixpanel::Client.new(
+              api_key: ENV['MIXPANEL_API_KEY'],
+              api_secret: ENV['MIXPANEL_API_SECRET']
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/pushpop-plugin.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+
+  s.name        = "pushpop-mixpanel"
+  s.version     = '0.1.1'
+  s.authors     = ["Joe Wegner"]
+  s.email       = "joe@keen.io"
+  s.homepage    = "https://github.com/pushpop-project/pushpop-mixpanel"
+  s.summary     = "Pushpop Mixpanel plugin for querying and recording events"
+
+  s.add_dependency "pushpop"
+  s.add_dependency "mixpanel-ruby", '~>2.1.0'
+  s.add_dependency "mixpanel_client"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end
+

data/spec/pushpop-mixpanel_spec.rb

@@ -0,0 +1,213 @@
+require 'spec_helper'
+
+ENV['MIXPANEL_PROJECT_TOKEN'] = '0987654321'
+ENV['MIXPANEL_API_KEY'] = '0987654321'
+ENV['MIXPANEL_API_SECRET'] = '0987654321'
+
+describe Pushpop::Mixpanel do
+  describe 'track' do
+    it 'tracks events' do
+      step = Pushpop::Mixpanel.new do
+        user '12345'
+        track 'An Event'
+      end
+
+      expect(Pushpop::Mixpanel.tracker).to receive(:track).with('12345', 'An Event')
+      step.run
+    end
+
+    it 'tracks events with properties' do
+      step = Pushpop::Mixpanel.new do
+        user '12345'
+        track 'An Event', {browser: 'Chrome'}
+      end
+
+      expect(Pushpop::Mixpanel.tracker).to receive(:track).with('12345', 'An Event', {
+        browser: 'Chrome'
+      })
+      step.run
+    end
+
+    it 'raises an error if the user is not set' do
+      step = Pushpop::Mixpanel.new do
+        track 'An Event'
+      end
+
+      expect{step.run}.to raise_error
+    end
+  end
+
+  describe 'query' do
+    it 'performs queries to an endpoint' do
+      step = Pushpop::Mixpanel.new do
+        query 'a/thing'
+      end 
+
+      expect(Pushpop::Mixpanel.querent).to receive(:request).with('a/thing', {})
+      step.run
+      expect(step._endpoint).to eq('a/thing')
+    end
+
+    it 'performs queries with properties' do
+      step = Pushpop::Mixpanel.new do
+        query 'a/thing', age: 23
+      end
+
+      expect(Pushpop::Mixpanel.querent).to receive(:request).with('a/thing', {age: 23})
+      step.run
+      expect(step._endpoint).to eq('a/thing')
+    end
+  end
+
+  describe 'user' do
+    it 'sets the user to do work with' do
+      step = Pushpop::Mixpanel.new do
+        user '12345'
+      end
+
+      step.run
+      expect(step._user).to eq('12345')
+    end
+
+    it 'creates the user with blank properties if no other set is called' do
+      step = Pushpop::Mixpanel.new do
+        user '12345'
+      end
+
+      expect(Pushpop::Mixpanel.tracker.people).to receive(:set).with('12345', {})
+      step.run
+    end
+
+    it 'updates the user if properties are passed' do
+      step = Pushpop::Mixpanel.new do
+        user '12345', {name: 'Bob'}
+      end
+
+      expect(Pushpop::Mixpanel.tracker.people).to receive(:set).with('12345', {name: 'Bob'})
+      step.run
+    end
+
+    it 'updates a user' do
+      step = Pushpop::Mixpanel.new do
+        user '12345'
+        set({coolness: 1})
+      end
+
+      expect(Pushpop::Mixpanel.tracker.people).to receive(:set).with('12345', {coolness: 1})
+      step.run
+    end
+
+    describe 'alias' do
+      it 'should create aliases' do
+        step = Pushpop::Mixpanel.new do
+          create_alias '12345', '54321' 
+        end
+
+          expect(Pushpop::Mixpanel.tracker).to receive(:alias).with('12345', '54321')
+          step.run
+      end
+
+      it 'set the user to the new alias' do
+        step = Pushpop::Mixpanel.new do
+          create_alias '12345', '54321' 
+        end
+
+          step.run
+          expect(step._user).to eq('12345')
+      end
+    end
+
+    it 'increments a user property' do
+      step = Pushpop::Mixpanel.new do
+        user '12345'
+        increment({coolness: 1})
+      end
+
+      expect(Pushpop::Mixpanel.tracker.people).to receive(:increment).with('12345', {coolness: 1})
+      step.run
+    end
+
+    it 'appends a user property' do
+      step = Pushpop::Mixpanel.new do
+        user '12345'
+        append({hair_color: 'red'})
+      end
+
+      expect(Pushpop::Mixpanel.tracker.people).to receive(:append).with('12345', {hair_color: 'red'})
+      step.run
+    end
+
+    describe 'charge' do
+      it 'adds a charge to a user' do
+        step = Pushpop::Mixpanel.new do
+          user '12345'
+          charge 100
+        end
+
+        expect(Pushpop::Mixpanel.tracker.people).to receive(:track_charge).with('12345', 100)
+        step.run
+      end
+
+      it 'passes properties if they are provided' do
+        step = Pushpop::Mixpanel.new do
+          user '12345'
+          charge 100, {item: 'Hot Dog'}
+        end
+
+        expect(Pushpop::Mixpanel.tracker.people).to receive(:track_charge).with('12345', 100, {
+          item: 'Hot Dog'
+        })
+
+        step.run
+      end
+    end
+
+    describe 'delete' do
+      it 'deletes a user' do
+        step = Pushpop::Mixpanel.new do
+          user '12345'
+          delete
+        end
+
+        expect(Pushpop::Mixpanel.tracker.people).to receive(:delete_user).with('12345')
+        step.run
+      end
+
+      it 'ignores aliases when deleting' do
+        step = Pushpop::Mixpanel.new do
+          user '12345'
+          delete true
+        end
+
+        expect(Pushpop::Mixpanel.tracker.people).to receive(:delete_user).with('12345', {'$ignore_alias' => true})
+        step.run
+      end
+    end
+
+    describe 'errors' do
+      it "can't increment withour a user" do
+        step = Pushpop::Mixpanel.new do
+          increment '54321'
+        end
+
+        expect{step.run}.to raise_error
+      end
+      
+      it "can't append withour a user" do
+        step = Pushpop::Mixpanel.new do
+          append '12345'
+        end
+
+        expect{step.run}.to raise_error
+      end
+      
+      it "can't charge withour a user" do
+        step = Pushpop::Mixpanel.new do
+          charge '100'
+        end
+
+        expect{step.run}.to raise_error
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+$: << File.join(File.dirname(__FILE__), '../lib')
+
+require 'pushpop'
+require 'pushpop-mixpanel'
+
+RSpec.configure do |config|
+  config.before :each do
+    Pushpop.jobs.clear
+  end
+end
+

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: pushpop-mixpanel
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Joe Wegner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pushpop
+  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: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: mixpanel_client
+  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'
+description: 
+email: joe@keen.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/pushpop-mixpanel.rb
+- pushpop-plugin.gemspec
+- spec/pushpop-mixpanel_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/pushpop-project/pushpop-mixpanel
+licenses: []
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Pushpop Mixpanel plugin for querying and recording events
+test_files:
+- spec/pushpop-mixpanel_spec.rb
+- spec/spec_helper.rb