mixpanel-rails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2a402c13b28c27567c34a3a9bb97601a2faaa253
+  data.tar.gz: 2af1d7fde1b4d954f9bbde834062cc64e5c25003
+SHA512:
+  metadata.gz: 4ba26f1b40e7b8bd65157f312c9dd0ac4ec4a4bd6d2d886e59f5ac5677e4da178e44b6b46d72a8d501f34789520b25c090b9eb74bccc653854035b127873d377
+  data.tar.gz: 9850bbdd3de84544d6ff8d161afbcd0cabdeb4b7cd4ebd173cfb0b7662582da160aa0aafc17097c1ea62a14d836eec0bca7e016c6b8df54657965d9a60d47b17

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 mixpanel-rails.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Charles Lowell
+
+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,45 @@
+# Mixpanel::Rails
+
+Painlessly integrate your rails application with [Mixpanel][1]
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mixpanel-rails'
+
+## Configuration
+
+Set the `config.mixpanel.api_token` parameter in your applications configuration or
+the `MIXPANEL_API_TOKEN` environment variable. e.g.
+
+    # config/environments/staging.rb
+    config.mixpanel.token = 'XYZ'
+    config.mixpanel.options = {:async => true}
+
+Want to use the [middleware for tracking with JavaScript][2]?
+
+    # config/application.rb
+    config.mixpanel.middleware.use = true
+    config.mixpanel.middleware.persist = false
+    config.mixpanel.middlware.insert_js_last = true
+    config.mixpanel.middleware.config = {:cookie_name => 'mixpanel_cookie' }
+
+## Usage
+
+You can now access a pre-configured instance of `Mixpanel::Tracker` from anywhere in
+your application by including the `Mixpanel::Helper` module:
+
+    class User < ActiveRecord::Base
+      include Mixpanel::Helper
+      after_create :notify_mixpanel
+
+      def notify_mixpanel
+        mixpanel.track 'User Created', :distinct_id => self.id
+      end
+    end
+
+Alternatively, you can use `Rails.application.mixpanel` if you don't want to include the module
+
+[1]: http://mixpanel.com
+[2]: https://github.com/zevarito/mixpanel#rack-middleware

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/mixpanel-rails.rb

@@ -0,0 +1 @@
+require 'mixpanel/rails'

data/lib/mixpanel/engine.rb

@@ -0,0 +1,38 @@
+require 'mixpanel'
+
+module Mixpanel
+  class Engine < ::Rails::Railtie
+
+    Config = Struct.new(:token, :options, :middleware)
+    MiddlewareConfig = Struct.new(:use, :insert_js_last, :persist, :config)
+
+    config.mixpanel = Config.new(nil, {}, MiddlewareConfig.new(false, false, false, {}))
+
+
+    initializer 'mixpanel.setup' do |app|
+      class << app
+        attr_accessor :mixpanel
+      end
+      config.mixpanel.token ||= ENV['MIXPANEL_TOKEN']
+      $stderr.puts <<-WARNING unless config.mixpanel.token
+No Mixpanel token was configured for environment #{::Rails.env}! this application will be
+unable to interact with mixpanel.com. You can set your token with either the environment
+variable `MIXPANEL_TOKEN` (recommended) or by setting `config.mixpanel.token` in your
+environment file directly.
+WARNING
+      app.mixpanel = Mixpanel::Tracker.new config.mixpanel.token, config.mixpanel.options
+    end
+
+    initializer 'mixpanel.middleware' do |app|
+      mixpanel = config.mixpanel
+      middleware = mixpanel.middleware
+      if middleware.use
+        config.middleware.use 'Mixpanel::Middleware', mixpanel.token, {
+          :insert_js_last => middleware.insert_js_last,
+          :persist => middleware.persist,
+          :config => middleware.config
+        }
+      end
+    end
+  end
+end

data/lib/mixpanel/helper.rb

@@ -0,0 +1,27 @@
+module Mixpanel
+  module Helper
+    def mixpanel
+      config = ::Rails.application.config
+      Mixpanel::Tracker.new(config.mixpanel.token, config.mixpanel.options.merge(mixpanel_options)).tap do |tracker|
+        tracker.extend TrackerProperties
+        tracker.mixpanel_properties = mixpanel_properties
+      end
+    end
+
+    def mixpanel_properties
+      {}
+    end
+
+    def mixpanel_options
+      {}
+    end
+
+    module TrackerProperties
+      attr_accessor :mixpanel_properties
+
+      def track(event_name, properties = {}, options = {})
+        super event_name, mixpanel_properties.merge(properties), options
+      end
+    end
+  end
+end

data/lib/mixpanel/rails.rb

@@ -0,0 +1,3 @@
+require 'mixpanel/rails/version'
+require 'mixpanel/engine'
+require 'mixpanel/helper'

data/lib/mixpanel/rails/version.rb

@@ -0,0 +1,5 @@
+module Mixpanel
+  module Rails
+    VERSION = "0.0.1"
+  end
+end

data/mixpanel-rails.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mixpanel/rails/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "mixpanel-rails"
+  gem.version       = Mixpanel::Rails::VERSION
+  gem.authors       = ["Charles Lowell"]
+  gem.email         = ["cowboyd@thefrontside.net"]
+  gem.description   = %q{A Rails Engine for Mixpanel}
+  gem.summary       = %q{Autoconfigure your Rails environment for use with Mixpanel}
+  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 'rails', '~> 3.0'
+  gem.add_dependency 'mixpanel', '~> 3.0'
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: mixpanel-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Charles Lowell
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDPjCCAiagAwIBAgIBADANBgkqhkiG9w0BAQUFADBFMRAwDgYDVQQDDAdjb3di
+  b3lkMRwwGgYKCZImiZPyLGQBGRYMdGhlZnJvbnRzaWRlMRMwEQYKCZImiZPyLGQB
+  GRYDbmV0MB4XDTEzMDEzMDIxMDYwNFoXDTE0MDEzMDIxMDYwNFowRTEQMA4GA1UE
+  AwwHY293Ym95ZDEcMBoGCgmSJomT8ixkARkWDHRoZWZyb250c2lkZTETMBEGCgmS
+  JomT8ixkARkWA25ldDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAO45
+  CUxpETDGYXjCCy2dMg/aIrdrTqBqQW5ZrzhHxF9EkcdmWFr0z/qMz0JSpZ3pF11Z
+  KYaj5PaQQpjZfLPwbuiGGkuSWi+UAac//V18xo6S4lzRBjO+gpzG9f2AOzt9b+SR
+  Uc8UhO7QBZ5edUDxMxw9QstD+U0YBAlzsPJbHuUOqdtxXmNQCds3ZnqTgZaIpdUy
+  CSejtrukSmlthxFzwgMezYQhcYxmkl+Q475JUodnI6Pjc6nja/Or8Y6cEWiLgeUa
+  a+efcPGLDEbwJC7TGRrvk8yassMByBEJ3XueTMzeqWFd+665ptciojYo6BvIAR0N
+  iLwks0x567FZyS8SqTcCAwEAAaM5MDcwCQYDVR0TBAIwADAdBgNVHQ4EFgQUxVgR
+  5TUqf7Hd24ICb3g4FNbM7oYwCwYDVR0PBAQDAgSwMA0GCSqGSIb3DQEBBQUAA4IB
+  AQDdJj+NzZhiYXA56z0wzRUA/Fcf6CYqKB+RFRlPssDEcHTor5SnwdWgQof/gNLi
+  Qel1Om4zO0Shcp89jxaUqtvEdYVhmyfc0vycHmemKttNBT734yMrEJtF8Hhy+Dnz
+  9CzixXLvgGaRH+mf3M0+l+zIDJJr2L+39L8cyTSSRnp/srfI8aSmJKhGshudBKoC
+  Ty6Gi071pwoJXvdMaE/6iPy7bUzlndYdHyYuWSKaO9N47HqQ62oEnBraglw6ghoi
+  UgImJlChAzCoDP9zi9tdm6jAr7ttF25R9PPYr11ILb7dYe3qUzlNlM6zJx/nb31b
+  IhdyRVup4qLcqYSTPsm6u7VA
+  -----END CERTIFICATE-----
+date: 2013-05-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: mixpanel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A Rails Engine for Mixpanel
+email:
+- cowboyd@thefrontside.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mixpanel-rails.rb
+- lib/mixpanel/engine.rb
+- lib/mixpanel/helper.rb
+- lib/mixpanel/rails.rb
+- lib/mixpanel/rails/version.rb
+- mixpanel-rails.gemspec
+homepage: ''
+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.0
+signing_key: 
+specification_version: 4
+summary: Autoconfigure your Rails environment for use with Mixpanel
+test_files: []