vero 0.7.0 → 0.10.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 613bdd22722909307a31f9216cadf88cdbab3ef8
+  data.tar.gz: 75cf2287ad113db6da85c725ad2e60e4241198bb
+SHA512:
+  metadata.gz: c2096897426a341a5eb32081d8a3590341befb1b4d02d9c46898b7945568fe7e0bf47bcacb634c3f4068e4fd4ac2ed06aae2776696a3bc33532e0483a0d7678c
+  data.tar.gz: 8c0edb41c39c2ef8a475ffdec1b05012b147f5ad415eb9887b8b8d338a74b2f0bae3edc4e894b2782e80f4ef84a22e19d0b4918809ca48104d55bdc180daca04

data/CHANGES.md

@@ -1,14 +1,17 @@
+## 0.9.0
+
+- *Added support for Sidekiq**. You can now use Sidekiq to deliver API requests to Vero. To do so, just specify `config.async = :sidekiq` in your config.rb file.
+
+## 0.8.0
+
+- **"development_mode" flag has been deprecated.** It is recommended to use a multiple projects (with different API credentials). Please contact support@getvero.com for assistance in upgrading your account.
+
 ## 0.7.0
 
-- **girl_friday has been replaced by sucker_punch**. The most significant
-effect of this change is that Ruby 1.8.7 will no longer be supported.
+- **girl_friday has been replaced by sucker_punch**. The most significant effect of this change is that Ruby 1.8.7 will no longer be supported.
 
 ## 0.6.0
 
-- **All APIs using the `trackable` interface will now pass up an `:id`** (if
-it has been made available). In the past the gem would assume that the user's id
-would always be equal to their email address, but now the gem properly implements
-the Vero API.
+- **All APIs using the `trackable` interface will now pass up an `:id`** (if it has been made available). In the past the gem would assume that the user's id would always be equal to their email address, but now the gem properly implements the Vero API.
 
-- **`update_user!` method no longer takes an optional new email address as a
-parameter**. It is recommended that the email be made a trackable field.
+- **`update_user!` method no longer takes an optional new email address as a parameter**. It is recommended that the email be made a trackable field.

data/Gemfile

@@ -1,3 +1,17 @@
-source "http://rubygems.org"
+# frozen_string_literal: true
+
+source 'http://rubygems.org'
 
 gemspec
+
+group :development, :test do
+  gem 'delayed_job', '~> 3.0.0'
+  gem 'delayed_job_active_record'
+  gem 'rails', '~> 3.0'
+  gem 'resque'
+  gem 'sidekiq', '~> 3.5.1'
+  gem 'sucker_punch', '~> 1.6.0'
+end
+
+gem 'rspec', group: :test
+gem 'rubocop', group: :development

data/Gemfile.lock

@@ -1,20 +1,19 @@
 PATH
   remote: .
   specs:
-    vero (0.6.0)
+    vero (0.10.0)
       json
       rest-client
-      sucker_punch (~> 1.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    actionmailer (3.2.13)
-      actionpack (= 3.2.13)
-      mail (~> 2.5.3)
-    actionpack (3.2.13)
-      activemodel (= 3.2.13)
-      activesupport (= 3.2.13)
+    actionmailer (3.2.22.5)
+      actionpack (= 3.2.22.5)
+      mail (~> 2.5.4)
+    actionpack (3.2.22.5)
+      activemodel (= 3.2.22.5)
+      activesupport (= 3.2.22.5)
       builder (~> 3.0.0)
       erubis (~> 2.7.0)
       journey (~> 1.0.4)
@@ -22,121 +21,183 @@ GEM
       rack-cache (~> 1.2)
       rack-test (~> 0.6.1)
       sprockets (~> 2.2.1)
-    activemodel (3.2.13)
-      activesupport (= 3.2.13)
+    activemodel (3.2.22.5)
+      activesupport (= 3.2.22.5)
       builder (~> 3.0.0)
-    activerecord (3.2.13)
-      activemodel (= 3.2.13)
-      activesupport (= 3.2.13)
+    activerecord (3.2.22.5)
+      activemodel (= 3.2.22.5)
+      activesupport (= 3.2.22.5)
       arel (~> 3.0.2)
       tzinfo (~> 0.3.29)
-    activeresource (3.2.13)
-      activemodel (= 3.2.13)
-      activesupport (= 3.2.13)
-    activesupport (3.2.13)
-      i18n (= 0.6.1)
+    activeresource (3.2.22.5)
+      activemodel (= 3.2.22.5)
+      activesupport (= 3.2.22.5)
+    activesupport (3.2.22.5)
+      i18n (~> 0.6, >= 0.6.4)
       multi_json (~> 1.0)
-    arel (3.0.2)
+    arel (3.0.3)
+    ast (2.4.1)
     builder (3.0.4)
-    celluloid (0.15.2)
-      timers (~> 1.1.0)
+    celluloid (0.17.4)
+      celluloid-essentials
+      celluloid-extras
+      celluloid-fsm
+      celluloid-pool
+      celluloid-supervision
+      timers (>= 4.1.1)
+    celluloid-essentials (0.20.5)
+      timers (>= 4.1.1)
+    celluloid-extras (0.20.5)
+      timers (>= 4.1.1)
+    celluloid-fsm (0.20.5)
+      timers (>= 4.1.1)
+    celluloid-pool (0.20.5)
+      timers (>= 4.1.1)
+    celluloid-supervision (0.20.6)
+      timers (>= 4.1.1)
+    concurrent-ruby (1.1.7)
+    connection_pool (2.2.3)
     delayed_job (3.0.5)
       activesupport (~> 3.0)
-    delayed_job_active_record (0.4.4)
-      activerecord (>= 2.1.0, < 4)
-      delayed_job (~> 3.0)
-    diff-lcs (1.2.4)
+    delayed_job_active_record (4.1.4)
+      activerecord (>= 3.0, < 6.1)
+      delayed_job (>= 3.0, < 5)
+    diff-lcs (1.4.4)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
     erubis (2.7.0)
-    hike (1.2.2)
-    i18n (0.6.1)
+    hike (1.2.3)
+    http-accept (1.7.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
     journey (1.0.4)
-    json (1.7.7)
-    json (1.7.7-java)
-    mail (2.5.3)
-      i18n (>= 0.4.0)
+    json (1.8.6)
+    mail (2.5.5)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
-    mime-types (1.23)
-    mono_logger (1.0.1)
-    multi_json (1.7.2)
-    netrc (0.7.7)
-    polyglot (0.3.3)
-    rack (1.4.5)
-    rack-cache (1.2)
+    mime-types (1.25.1)
+    mono_logger (1.1.0)
+    multi_json (1.15.0)
+    netrc (0.11.0)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    polyglot (0.3.5)
+    rack (1.4.7)
+    rack-cache (1.12.0)
       rack (>= 0.4)
-    rack-protection (1.5.0)
+    rack-protection (1.5.5)
       rack
-    rack-ssl (1.3.3)
+    rack-ssl (1.3.4)
       rack
-    rack-test (0.6.2)
+    rack-test (0.6.3)
       rack (>= 1.0)
-    rails (3.2.13)
-      actionmailer (= 3.2.13)
-      actionpack (= 3.2.13)
-      activerecord (= 3.2.13)
-      activeresource (= 3.2.13)
-      activesupport (= 3.2.13)
+    rails (3.2.22.5)
+      actionmailer (= 3.2.22.5)
+      actionpack (= 3.2.22.5)
+      activerecord (= 3.2.22.5)
+      activeresource (= 3.2.22.5)
+      activesupport (= 3.2.22.5)
       bundler (~> 1.0)
-      railties (= 3.2.13)
-    railties (3.2.13)
-      actionpack (= 3.2.13)
-      activesupport (= 3.2.13)
+      railties (= 3.2.22.5)
+    railties (3.2.22.5)
+      actionpack (= 3.2.22.5)
+      activesupport (= 3.2.22.5)
       rack-ssl (~> 1.3.2)
       rake (>= 0.8.7)
       rdoc (~> 3.4)
       thor (>= 0.14.6, < 2.0)
-    rake (10.0.4)
+    rainbow (3.0.0)
+    rake (13.0.1)
     rdoc (3.12.2)
       json (~> 1.4)
-    redis (3.0.4)
-    redis-namespace (1.2.1)
-      redis (~> 3.0.0)
-    resque (1.24.1)
+    redis (3.3.5)
+    redis-namespace (1.8.0)
+      redis (>= 3.0.4)
+    regexp_parser (1.7.1)
+    resque (2.0.0)
       mono_logger (~> 1.0)
       multi_json (~> 1.0)
-      redis-namespace (~> 1.2)
+      redis-namespace (~> 1.6)
       sinatra (>= 0.9.2)
       vegas (~> 0.1.2)
-    rest-client (1.7.2)
-      mime-types (>= 1.16, < 3.0)
-      netrc (~> 0.7)
-    rspec (2.13.0)
-      rspec-core (~> 2.13.0)
-      rspec-expectations (~> 2.13.0)
-      rspec-mocks (~> 2.13.0)
-    rspec-core (2.13.1)
-    rspec-expectations (2.13.0)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.13.1)
-    sinatra (1.3.6)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.91.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.4.0, < 1.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.4.1)
+      parser (>= 2.7.1.4)
+    ruby-progressbar (1.10.1)
+    sidekiq (3.5.4)
+      celluloid (~> 0.17.2)
+      connection_pool (~> 2.2, >= 2.2.0)
+      json (~> 1.0)
+      redis (~> 3.2, >= 3.2.1)
+      redis-namespace (~> 1.5, >= 1.5.2)
+    sinatra (1.4.6)
       rack (~> 1.4)
-      rack-protection (~> 1.3)
-      tilt (~> 1.3, >= 1.3.3)
-    sprockets (2.2.2)
+      rack-protection (~> 1.4)
+      tilt (>= 1.3, < 3)
+    sprockets (2.2.3)
       hike (~> 1.2)
       multi_json (~> 1.0)
       rack (~> 1.0)
       tilt (~> 1.1, != 1.3.0)
-    sucker_punch (1.1)
-      celluloid (~> 0.15.2)
-    thor (0.18.1)
-    tilt (1.3.7)
-    timers (1.1.0)
-    treetop (1.4.12)
+    sucker_punch (1.6.0)
+      celluloid (~> 0.17.2)
+    thor (1.0.1)
+    tilt (1.4.1)
+    timers (4.3.2)
+    treetop (1.4.15)
       polyglot
       polyglot (>= 0.3.1)
-    tzinfo (0.3.37)
+    tzinfo (0.3.57)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.7)
+    unicode-display_width (1.7.0)
     vegas (0.1.11)
       rack (>= 1.0.0)
 
 PLATFORMS
-  java
   ruby
 
 DEPENDENCIES
-  delayed_job
+  delayed_job (~> 3.0.0)
   delayed_job_active_record
   rails (~> 3.0)
   resque
   rspec
+  rubocop
+  sidekiq (~> 3.5.1)
+  sucker_punch (~> 1.6.0)
   vero!
+
+BUNDLED WITH
+   1.17.3

data/README.markdown

@@ -12,59 +12,74 @@ For more information about the platform, [click here](http://getvero.com).
 
 Include in your Gemfile:
 
-    gem 'vero'
+```
+gem 'vero'
+```
 
 Or install the gem:
 
-    gem install vero
+```
+gem install vero
+```
 
 Create an initializer in your config/initializers folder called vero.rb with the
 following:
 
-    # config/initializers/vero.rb
-    Vero::App.init do |config|
-      config.api_key = "Your API key goes here"
-      config.secret = "Your API secret goes here"
-    end
+```ruby
+# config/initializers/vero.rb
+Vero::App.init do |config|
+  if Rails.env.production?
+    config.api_key = "Your Production API key goes here"
+    config.secret = "Your Production API secret goes here"
+  else
+    config.api_key = "Your Development API key goes here"
+    config.secret = "Your Development API secret goes here"
+  end
+end
+```
 
 You will be able to find your API key and secret by logging into Vero
 ([sign up](http://getvero.com) if you haven't already) and clicking the
 'Your Account' link at the top of the page then select 'API Keys'.
 
-By default, events are sent asynchronously using a background thread.
-We recommend that you select one of the supported queue-based alternatives:
+By default, events are sent synchronously.
+We recommend that you select one of the supported background thread/queue-based alternatives and add their
+respective gem to your Gemfile:
 
-    config.async = :none            # Synchronously
-    config.async = :thread          # Background thread (default)
-    config.async = :delayed_job     # DelayedJob
-    config.async = :resque          # Resque (recommended)
+```ruby
+config.async = :none            # Synchronously
+config.async = :sucker_punch    # SuckerPunch
+config.async = :delayed_job     # DelayedJob
+config.async = :sidekiq         # Sidekiq
+config.async = :resque          # Resque (recommended)
+```
 
 **Note:** If you're using Mongoid with DelayedJob, you must add
 `gem "delayed_job_mongoid"` to your Gemfile.
 
-vero will automatically choose whether to send requests to your
-**development** or **live** environment if you are using Rails 3.x. You can
-override this in your initializer:
-
-    config.development_mode = true # or false
-
-Finally, if you wish to disable vero requests when running your automated tests,
+Finally, if you wish to disable Vero requests when running your automated tests,
 add the following line to your initializer:
 
-    config.disabled = Rails.env.test?
+```ruby
+config.disabled = Rails.env.test?
+```
+
+If you have any additional questions, please contact support@getvero.com.
 
 ## Setup tracking
 
 You will need to define who should be tracked and what information about them
 you would like sent to Vero. In this example we'll track users:
 
-    # app/models/user.rb
-    class User < ActiveRecord::Base
-      include Vero::Trackable
-      trackable :id, :email, :name
+```ruby
+# app/models/user.rb
+class User < ActiveRecord::Base
+  include Vero::Trackable
+  trackable :id, :email, :name
 
-      ...
-    end
+  # ...
+end
+```
 
 As you can see we're saying that a User is trackable and that we'd like to pass
 up their user id, email address, and name.
@@ -72,17 +87,19 @@ up their user id, email address, and name.
 Each symbol passed to trackable should reference either an instance method or
 field. Therefore it's perfectly legal to do something like:
 
-    # app/models/user.rb
-    class User < ActiveRecord::Base
-      include Vero::Trackable
-      trackable :id, :email, :contest_count
+```ruby
+# app/models/user.rb
+class User < ActiveRecord::Base
+  include Vero::Trackable
+  trackable :id, :email, :contest_count
 
-      has_many :contests
+  has_many :contests
 
-      def contest_count
-        self.contests.count
-      end
-    end
+  def contest_count
+    self.contests.count
+  end
+end
+```
 
 There is one caveat: you must pass an "id" to the API in order to perform
 requests. In many cases the user "id" will simply be their email address. The
@@ -92,31 +109,35 @@ the "id".
 If the user's email address is stored under a different field, you can do the
 following:
 
-    # app/models/user.rb
-    class User < ActiveRecord::Base
-      include Vero::Trackable
-      trackable :id, :email
+```ruby
+# app/models/user.rb
+class User < ActiveRecord::Base
+  include Vero::Trackable
+  trackable :id, :email
 
-      def email; self.primary_contact; end
-    end
+  def email; self.primary_contact; end
+end
+```
 
 Finally, you can track multiple properties stored in a Hash by doing the
 following:
 
-    # app/models/user.rb
-    class User < ActiveRecord::Base
-      include Vero::Trackable
-      trackable :id, :email, {:extras => :properties}
+```ruby
+# app/models/user.rb
+class User < ActiveRecord::Base
+  include Vero::Trackable
+  trackable :id, :email, {:extras => :properties}
 
-      def email; self.primary_contact; end
+  def email; self.primary_contact; end
 
-      def properties
-        {
-          :first_name => "James",
-          :last_name => "Lamont"
-        }
-      end
-    end
+  def properties
+    {
+      :first_name => "James",
+      :last_name => "Lamont"
+    }
+  end
+end
+```
 
 **Note:** You may choose to bypass extending the `User` model by calling the
 API via [simple DSL](https://github.com/getvero/vero#simple-dsl) found below.
@@ -127,51 +148,54 @@ Events can be sent by any model which has been previously marked as trackable.
 
 To send an event:
 
-    # app/controllers/contests_controller.rb
-    class ContestsController < ActionController::Base
-      before_filter :authenticate_user!
-      ...
+```ruby
+# app/controllers/contests_controller.rb
+class ContestsController < ActionController::Base
+  before_filter :authenticate_user!
+  # ...
 
+  def create
+    @contest = current_user.contests.build(params[:contest])
 
-      def create
-        @contest = current_user.contests.build(params[:contest])
+    if @contest.save
+      # Tell Vero that a new contest has been created
+      current_user.track!('new_contest_created')
 
-        if @contest.save
-          # Tell Vero that a new contest has been created
-          current_user.track!('new_contest_created')
-
-          flash[:notice] = "New contest saved successfully!"
-          redirect_to contests_path
-        else
-          flash[:alert] = "Unable to create your contest. Please review your details and try again."
-          render 'new'
-        end
-      end
+      flash[:notice] = "New contest saved successfully!"
+      redirect_to contests_path
+    else
+      flash[:alert] = "Unable to create your contest. Please review your details and try again."
+      render 'new'
     end
+  end
+end
+```
 
 You may want to send additional data about an event:
 
-    # app/controllers/contests_controller.rb
-    class ContestsController < ActionController::Base
-      before_filter :authenticate_user!
-      ...
+```ruby
+# app/controllers/contests_controller.rb
+class ContestsController < ActionController::Base
+  before_filter :authenticate_user!
+  # ...
 
 
-      def create
-        @contest = current_user.contests.build(params[:contest])
+  def create
+    @contest = current_user.contests.build(params[:contest])
 
-        if @contest.save
-          # Tell Vero that a new contest has been created, and the id and name
-          current_user.track!('new_contest_created', {:id => @contest.id, :name => @content.name})
+    if @contest.save
+      # Tell Vero that a new contest has been created, and the id and name
+      current_user.track!('new_contest_created', {:id => @contest.id, :name => @content.name})
 
-          flash[:notice] = "New contest saved successfully!"
-          redirect_to contests_path
-        else
-          flash[:alert] = "Unable to create your contest. Please review your details and try again."
-          render 'new'
-        end
-      end
+      flash[:notice] = "New contest saved successfully!"
+      redirect_to contests_path
+    else
+      flash[:alert] = "Unable to create your contest. Please review your details and try again."
+      render 'new'
     end
+  end
+end
+```
 
 ## Simple DSL
 
@@ -181,38 +205,43 @@ using a simple DSL (thanks @jherdman) as you would from the Javascript library.
 First, ensure you've correctly configured the gem following the instructions as
 outlined in Installation. Now you can call the API using the following methods:
 
-    class UsersController < ApplicationController
-      include Vero::DSL
-
-      def perform_action
-        # Tracking an event
-        vero.events.track!({
-          :event_name => "test_event",
-          :data => {:date => "2013-02-12 16:17"},
-          :identity => {:id => 123, :email => "james@getvero.com"}
-        })
-      end
-
-      def create
-        # Identifying a user
-        vero.users.track!({:id => 123, :data => {}})
-      end
-
-      def update
-        # Editing a user
-        vero.users.edit_user!({:id => 123, :changes => {:age => 25}})
-
-        # Editing a user's tags
-        vero.users.edit_user_tags!({:id => 123, :add => ["awesome"], :remove => []})
-
-        # Changing a user's id
-        vero.users.reidentify!({:id => 123, :new_id => "honeybadger@getvero.com"})
-      end
-
-      def destroy
-        vero.users.unsubscribe!({:id => 123})
-      end
-    end
+```ruby
+class UsersController < ApplicationController
+  include Vero::DSL
+
+  def perform_action
+    # Tracking an event
+    vero.events.track!({
+      :event_name => "test_event",
+      :data => {:date => "2013-02-12 16:17"},
+      :identity => {:id => 123, :email => "james@getvero.com"}
+    })
+  end
+
+  def create
+    # Identifying a user
+    vero.users.track!({:id => 123, :data => {}})
+  end
+
+  def update
+    # Editing a user
+    vero.users.edit_user!({:id => 123, :changes => {:age => 25}})
+
+    # Editing a user's tags
+    vero.users.edit_user_tags!({:id => 123, :add => ["awesome"], :remove => []})
+
+    # Changing a user's id
+    vero.users.reidentify!({:id => 123, :new_id => "honeybadger@getvero.com"})
+
+    # Resubscribing a user
+    vero.users.resubscribe!({:id => 123})
+  end
+
+  def destroy
+    vero.users.unsubscribe!({:id => 123})
+  end
+end
+```
 
 ## License Information