mixpal 0.0.5 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5f7b06bf4a86525182d6d44a19848532e62cc51a
-  data.tar.gz: eb38535ae4ef5a101b61a8d30c0a4ed041c04b9d
+SHA256:
+  metadata.gz: 70923329c62f76ee4d6b0796547cdd2e367038940c30d8f5ccb10b044f506d36
+  data.tar.gz: 492801097fa1ac2fb85f4600273b2db3fc6e0e8383c9b17112e0302100fc9020
 SHA512:
-  metadata.gz: 8d4079b4038dad025ca08dfaefcb1239abeacbedccb1c0c7553e1cdaa8cea64849cd03717d83cf2315ede897b85634a55d6950e6de299dbd61f3354f9d97a08d
-  data.tar.gz: 883548ba1bb19454caa6052e2d812efe80f09680b22b1647034865f0c885042b462d1412a37ac152ca1c2786ee89e61ea827a721f6fce11331aab1346907380f
+  metadata.gz: b8dbd5bd3051e8edf9ab7b130c0cd6a5af876d52c8fb6992e82c4ae3b22b58eeb726591bffc67368c9cc3c40e60faa2a1f5d5090a3392fe5fc96f374dde1af6e
+  data.tar.gz: e32c5e8e487ea31dc875df217e26f962c634978cd07b1d036b97a10f3e7eaa0fb8d446b0e8c00d89c4a5eacce591012400d01e3b541bd98238114a4ea1785aaf

data/.rubocop.yml

@@ -0,0 +1,24 @@
+Encoding:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+
+ClassAndModuleChildren:
+  Enabled: false
+
+ClassLength:
+  Enabled: false
+
+MethodLength:
+  Enabled: false
+
+DoubleNegation:
+  Enabled: false
+
+AllCops:
+  NewCops: enable
+  Include:
+    - "Rakefile"
+  Exclude:
+    - "test_app/**/*"

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+before_install:
+  - gem install bundler
+rvm:
+  - 2.5.8
+  - 2.6.6
+  - 2.7.1

data/Dockerfile

@@ -0,0 +1,6 @@
+FROM ruby:2.7.1
+
+WORKDIR /workspace
+
+COPY . .
+RUN bundle install

data/README.md

@@ -1,4 +1,4 @@
-# Mixpal
+# Mixpal [![Build Status](https://travis-ci.org/philosophie/mixpal.svg?branch=master)](https://travis-ci.org/philosophie/mixpal)
 
 As the JavaScript library is Mixpanel's preferred method of usage,
 Mixpal aims to make it easier to work with from your Rails backend.
@@ -78,9 +78,41 @@ mixpanel.update_user email: "mynewemail@example.com"
 
 As with `register_user`, this method will also identify "special properties".
 
+### Custom Events
+
+Mixpal allows you to define custom mixpal methods to use in your controllers/views
+
+1. create a custom module and define your mixpal events
+```ruby
+module YourCustomEventsModule
+  def sign_up(user)
+    register_user user.attributes.slice('name', 'email')
+    track 'User signed up'
+  end
+end
+```
+
+2. create a mixpal.rb initializer and configure mixpal to use your module
+```ruby
+Mixpal.configure do |config|
+  config.helper_module = YourCustomEventsModule
+end
+```
+
+3. use in controllers/views
+```ruby
+class UserController < ActionController::Base
+  def create
+    # ... do cool stuff ...
+    mixpal.sign_up(user)
+    redirect_to root_path
+  end
+end
+```
+
 ### Persistance Across Redirects
 
-Mixpal stores any tracked events or user data in `Rails.cache` when
+Mixpal stores any tracked events or user data in the session when
 it detects a redirect so it can output the appropriate Mixpanel JS integration
 code to the client on the following render. This enables us to do cool things
 like:
@@ -104,16 +136,12 @@ class UsersController < ActionController::Base
 end
 ```
 
-#### Customizing the storage adapter
-
-You can specify a custom persistence storage adapter like so:
-
-```ruby
-Mixpal::Tracker.storage = MyCustomAdapter.new
-```
+#### A note about `CookieStore` size limit
 
-Storage adapters must implement the following API: `write(key, value)`,
-`read(key)`, and `delete(key)`.
+When using Rails' default `ActionDispatch::Session::CookieStore`, a 4K cookie
+size limit is enforced. This cookie is shared by anything using the session.
+If you anticipate tracking many events or large data sets to Mixpal,
+[consider a different session store](http://guides.rubyonrails.org/action_controller_overview.html#session).
 
 ## Contributing
 
@@ -124,3 +152,15 @@ Storage adapters must implement the following API: `write(key, value)`,
 1. Commit your changes (`git commit -am 'Add some feature'`)
 1. Push to the branch (`git push origin feature/my-new-feature`)
 1. Create new Pull Request
+
+## Releasing
+
+Bump `lib/mixpal/version.rb` then build + release with docker-compose. If you
+prefer local development, inspect the Dockerfile to get your local env built.
+
+```
+docker-compose build \
+  --build-arg USER_ID=$(id -u) \
+  --build-arg GROUP_ID=$(id -g)
+docker-compose run rake release
+```

data/Rakefile

@@ -1 +1,10 @@
-require "bundler/gem_tasks"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/docker-compose.yml

@@ -0,0 +1,14 @@
+version: "3.6"
+
+volumes:
+  bundle:
+
+services:
+  gem:
+    build: .
+    volumes:
+      - .:/workspace
+      - bundle:/usr/local/bundle
+      - $HOME/.ssh:/root/.ssh:ro
+      - $HOME/.gitconfig:/root/.gitconfig:ro
+      - $HOME/.gem/credentials:/root/.gem/credentials

data/lib/mixpal.rb

@@ -1,10 +1,30 @@
-require "mixpal/version"
-require "active_support/core_ext"
+require 'mixpal/version'
+require 'active_support'
+require 'active_support/core_ext'
 
 module Mixpal
-  autoload :Util, "mixpal/util"
-  autoload :Tracker, "mixpal/tracker"
-  autoload :Event, "mixpal/event"
-  autoload :User, "mixpal/user"
-  autoload :Integration, "mixpal/integration"
+  autoload :Util, 'mixpal/util'
+  autoload :Tracker, 'mixpal/tracker'
+  autoload :Event, 'mixpal/event'
+  autoload :User, 'mixpal/user'
+  autoload :Revenue, 'mixpal/revenue'
+  autoload :Integration, 'mixpal/integration'
+
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+  end
+
+  class Configuration
+    attr_writer :helper_module
+
+    def helper_module
+      @helper_module ||= Module.new
+    end
+  end
 end

data/lib/mixpal/event.rb

@@ -14,13 +14,13 @@ module Mixpal
 
     def to_store
       {
-        name: name,
-        properties: properties,
+        'name' => name,
+        'properties' => properties
       }
     end
 
     def self.from_store(data)
-      new(data[:name], data[:properties])
+      new(data['name'], data['properties'])
     end
   end
-end
+end

data/lib/mixpal/integration.rb

@@ -4,31 +4,35 @@ module Mixpal
 
     included do
       helper_method :mixpanel
-      after_filter :store_mixpanel_if_redirecting
+      if Rails::VERSION::MAJOR >= 4
+        after_action :store_mixpanel_if_redirecting
+      else
+        after_filter :store_mixpanel_if_redirecting
+      end
 
       class_attribute :mixpanel_identity_data
       def self.mixpanel_identity(object_method, attribute_method)
         self.mixpanel_identity_data = {
           object_method: object_method,
-          attribute_method: attribute_method,
+          attribute_method: attribute_method
         }
       end
     end
 
     def mixpanel
       @mixpanel ||= begin
-        identity = if data = self.class.mixpanel_identity_data
-          send(data[:object_method]).try(data[:attribute_method])
-        end
+        identity = if (data = self.class.mixpanel_identity_data)
+                     send(data[:object_method]).try(data[:attribute_method])
+                   end
 
-        Mixpal::Tracker.new(identity: identity)
+        Mixpal::Tracker.new(identity: identity).tap { |t| t.restore!(session) }
       end
     end
 
     private
 
     def store_mixpanel_if_redirecting
-      mixpanel.store! if status == 302
+      mixpanel.store!(session) if status == 302
     end
   end
-end
+end

data/lib/mixpal/revenue.rb

@@ -0,0 +1,32 @@
+module Mixpal
+  class Revenue
+    attr_reader :amount, :properties
+
+    def initialize(amount, properties)
+      @amount = amount
+      @properties = properties
+    end
+
+    def render
+      args = "#{amount}, #{properties_as_js_object_for_mixpanel}"
+      "mixpanel.people.track_charge(#{args});".html_safe
+    end
+
+    def to_store
+      {
+        'amount' => amount,
+        'properties' => properties
+      }
+    end
+
+    def self.from_store(data)
+      new(data['amount'], data['properties'])
+    end
+
+    private
+
+    def properties_as_js_object_for_mixpanel
+      Mixpal::Util.hash_to_js_object_string(properties)
+    end
+  end
+end

data/lib/mixpal/tracker.rb

@@ -1,16 +1,15 @@
 module Mixpal
   class Tracker
-    attr_reader :events, :user_updates, :identity, :alias_user
+    attr_reader :events, :user_updates, :revenue_updates, :identity, :alias_user
 
-    STORAGE_KEY = "mixpal"
-    class_attribute :storage
-    self.storage = Rails.cache
+    STORAGE_KEY = 'mixpal'
+
+    def initialize(args = {})
+      extend Mixpal.configuration.helper_module
 
-    def initialize(args={})
       @events = []
       @user_updates = []
-
-      restore!
+      @revenue_updates = []
 
       @identity = args[:identity]
     end
@@ -24,44 +23,62 @@ module Mixpal
       user_updates << Mixpal::User.new(properties)
     end
 
-    def track(name, properties={})
+    def track(name, properties = {})
       events << Mixpal::Event.new(name, properties)
     end
 
+    def track_charge(amount, properties = {})
+      revenue_updates << Mixpal::Revenue.new(amount, properties)
+    end
+
     def render
-      "".tap do |html|
-        html << "<script type=\"text/javascript\">"
+      ''.tap do |html|
+        html << '<script type="text/javascript">'
         html << "mixpanel.alias(\"#{identity}\");" if alias_user
         html << "mixpanel.identify(\"#{identity}\");" if identity
-        html << events.map(&:render).join("")
-        html << user_updates.map(&:render).join("")
-        html << "</script>"
+        html << events.map(&:render).join('')
+        html << user_updates.map(&:render).join('')
+        html << revenue_updates.map(&:render).join('')
+        html << '</script>'
       end.html_safe
     end
 
-    def store!
-      self.class.storage.write(STORAGE_KEY, to_store)
+    def store!(session)
+      session[STORAGE_KEY] = to_store
     end
 
-    private
+    def restore!(session)
+      data = session[STORAGE_KEY] || {}
 
-    def restore!
-      data = self.class.storage.read(STORAGE_KEY) || {}
+      @alias_user = data['alias_user']
+      @identity ||= data['identity']
 
-      @alias_user = data[:alias_user]
-      @identity = data[:identity]
-      @events = data[:events].map { |e| Mixpal::Event.from_store(e) } if data[:events]
-      @user_updates = data[:user_updates].map { |u| Mixpal::User.from_store(u) } if data[:user_updates]
+      if data['events']
+        @events = data['events'].map { |e| Mixpal::Event.from_store(e) }
+      end
 
-      self.class.storage.delete(STORAGE_KEY)
+      if data['user_updates']
+        @user_updates =
+          data['user_updates'].map { |u| Mixpal::User.from_store(u) }
+      end
+
+      if data['revenue_updates']
+        @revenue_updates =
+          data['revenue_updates'].map { |u| Mixpal::Revenue.from_store(u) }
+      end
+
+      session.delete(STORAGE_KEY)
     end
 
+    private
+
     def to_store
       {
-        alias_user: @alias_user,
-        identity: identity,
-        events: events.map(&:to_store),
-        user_updates: user_updates.map(&:to_store),
+        'alias_user' => alias_user,
+        'identity' => identity,
+        'events' => events.map(&:to_store),
+        'user_updates' => user_updates.map(&:to_store),
+        'revenue_updates' => revenue_updates.map(&:to_store)
       }
     end
   end

data/lib/mixpal/user.rb

@@ -12,12 +12,12 @@ module Mixpal
 
     def to_store
       {
-        properties: properties,
+        'properties' => properties
       }
     end
 
     def self.from_store(data)
-      new(data[:properties])
+      new(data['properties'])
     end
 
     private
@@ -29,15 +29,17 @@ module Mixpal
     # Isolate special properties and rename their keys to align with
     # Mixpanel's naming.
     def properties_for_mixpanel
-      Hash[properties.map {|k, v| [mixpanel_special_properties_map[k] || k, v] }]
+      Hash[
+        properties.map { |k, v| [mixpanel_special_properties_map[k] || k, v] }
+      ]
     end
 
     def mixpanel_special_properties_map
       {
-        name: "$name",
-        email: "$email",
-        created_at: "$created",
+        name: '$name',
+        email: '$email',
+        created_at: '$created'
       }.with_indifferent_access
     end
   end
-end
+end