rack-mixpanel 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack-mixpanel.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Derek Barnes
+
+MIT License
+
+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,61 @@
+# Rack::Mixpanel
+
+Rack::Mixpanel provides a piece of Rack middleware for tracking events with
+the same identity as set in the client-side JavaScript API. This is
+achieved through parsing the cookie that Mixpanel sets on your site's
+domain.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack-mixpanel', :require => 'rack/mixpanel'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-mixpanel
+
+### Rails
+
+In your config/application.rb:
+
+```
+config.middleware.use Rack::Mixpanel
+```
+
+This will use the "MIXPANEL_API_TOKEN" environment variable as the
+Mixpanel API token.
+
+Alternatively, you may set this explicitly:
+
+```
+config.middleware.use Rack::Mixpanel, '54c0b5d418d4215a1061a894736eeed9'
+```
+
+## Usage
+
+### Track events
+
+```ruby
+env['mixpanel.tracker'].track event_name, properties
+```
+
+Example:
+
+```ruby
+env['mixpanel.tracker'].track 'Sent message', {:age => 25,
+:recipient_age => 23}
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Pick out an [emoji](http://www.emoji-cheat-sheet.com).
+4. Commit your changes (`git commit -am ':new: Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/rack/mixpanel.rb

@@ -0,0 +1,49 @@
+require 'base64'
+require 'json'
+require 'open-uri'
+
+require 'rack'
+
+module Rack
+  class Mixpanel
+    def initialize(app, token=nil)
+      @app = app
+      @token = token || ENV['MIXPANEL_API_TOKEN']
+    end
+
+    def call(env)
+      request = Rack::Request.new(env)
+      mp_cookie = request.cookies["mp_#{@token}_mixpanel"]
+      if mp_cookie
+        mp_env = JSON.parse(mp_cookie)
+        distinct_id = mp_env['distinct_id']
+        env['mixpanel.distinct_id'] = distinct_id
+      end
+      env['mixpanel.tracker'] = Tracker.new(@token, request.ip, env['mixpanel.distinct_id'])
+      @app.call(env)
+    end
+
+    class Tracker
+      attr_reader :thread
+      def initialize(token, ip, distinct_id)
+        @token = token
+        @ip = ip
+        @distinct_id = distinct_id
+      end
+
+      def track(event, properties)
+        base_props = {
+          'token' => @token,
+          'ip' => @ip,
+          'distinct_id' => @distinct_id
+        }
+        enc_props = Base64.encode64 JSON.generate({'event' => event, 'properties' => base_props.merge(properties)})
+        uri = URI('https://api.mixpanel.com/track')
+        uri.query = URI.encode_www_form(:data => enc_props)
+        @thread = Thread.new { uri.read }
+        nil
+      end
+    end
+  end
+end
+

data/rack-mixpanel.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.name          = "rack-mixpanel"
+  gem.version       = "0.1.0"
+  gem.authors       = ["Derek Barnes"]
+  gem.email         = ["barnes@okcupidlabs.com"]
+  gem.description   = %q{Rack middleware for tracking Mixpanel events}
+  gem.summary       = %q{Rack middleware for tracking Mixpanel events}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'rack'
+  gem.add_development_dependency 'fakeweb'
+  gem.add_development_dependency 'rspec'
+end

data/spec/rack/mixpanel_spec.rb

@@ -0,0 +1,70 @@
+require 'rack/mixpanel'
+require 'fakeweb'
+
+describe Rack::Mixpanel do
+  let(:distinct_id) { '405e1d32-8e1e-4d04-b1ee-d060134c5dcf' }
+  let(:token) { '660f899ecec3091074cc828dde2a2bcd' }
+  let(:cookie) { "mp_#{token}_mixpanel=%7B%22distinct_id%22%3A%22#{distinct_id}%22%2C%22%24initial_referrer%22%3A%22%24direct%22%2C%22%24initial_referring_domain%22%3A%22%24direct%22%7D" }
+
+  subject { Rack::MockRequest.new(app).get('/', 'HTTP_COOKIE' => cookie) }
+
+  describe 'env.distinct_id' do
+    # An app that returns env['mixpanel.distinct_id'] in the body
+    let(:distinct_id_app) do
+      lambda { |env| [200, {'Content-Type' => 'text/plain'}, [env['mixpanel.distinct_id']]] }
+    end
+    context 'when a token is set in the app' do
+      let(:app) { Rack::Mixpanel.new(distinct_id_app, token) }
+      context 'and a cookie is set' do
+        its(:body) { should == distinct_id }
+      end
+      context 'and a cookie is not set' do
+        let(:cookie) { '' }
+        its(:body) { should == '' }
+      end
+    end
+
+    context 'when a token is set in the environment' do
+      let(:app) { Rack::Mixpanel.new(distinct_id_app) }
+      before { ENV['MIXPANEL_API_TOKEN'] = token }
+      context 'and a cookie is set' do
+        its(:body) { should == distinct_id }
+      end
+      context 'and a cookie is not set' do
+        let(:cookie) { '' }
+        its(:body) { should == '' }
+      end
+    end
+  end
+
+  describe 'env.tracker' do
+    # An app that returns the response from the env['mixpanel.track'].track call
+    # and the track call's request thread
+    let(:tracker_app) do
+      lambda do |env|
+        res = env['mixpanel.tracker'].track(event, properties)
+        val = env['mixpanel.tracker'].thread.value
+        [200, {'Content-Type' => 'text/plain'}, [res.nil?, "\n", val]]
+      end
+    end
+    let(:event) { 'signup' }
+    let(:properties) { {'gender' => 'male', 'age' => 45} }
+    let(:app) { Rack::Mixpanel.new(tracker_app, token) }
+    it 'sends a request to Mixpanel' do
+      props = {
+        'event' => event,
+        'properties' => {
+          'token' => token,
+          'ip' => nil,
+          'distinct_id' => distinct_id
+        }.merge(properties)
+      }
+      enc_params = Base64.encode64 JSON.generate(props)
+      query = URI.encode_www_form(:data => enc_params)
+      uri = URI('https://api.mixpanel.com/track')
+      uri.query = query
+      FakeWeb.register_uri(:get, uri, :body => '1')
+      subject.body.split("\n").should == ['true', '1']
+    end
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: rack-mixpanel
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Derek Barnes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rack middleware for tracking Mixpanel events
+email:
+- barnes@okcupidlabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack/mixpanel.rb
+- rack-mixpanel.gemspec
+- spec/rack/mixpanel_spec.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Rack middleware for tracking Mixpanel events
+test_files:
+- spec/rack/mixpanel_spec.rb