vero 0.9.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dc379e2eaa97b37404afab58dc1a69dee2a4549b
-  data.tar.gz: aa4f5aefc12a29b4710ec2ba253a437531ef9641
+  metadata.gz: 613bdd22722909307a31f9216cadf88cdbab3ef8
+  data.tar.gz: 75cf2287ad113db6da85c725ad2e60e4241198bb
 SHA512:
-  metadata.gz: 8fea3136272e976ebf31f6703d746dff1e8fcaa85d1161ace2463a31918d0e653a8a5497db2eab7fe573e5f4030c5ef0f946e2dbded9e3217776cab3a06226bf
-  data.tar.gz: 6afbcb7b24fe63f0264d2e40e3bdaa1528ee8f92540ff9263272f3324b54fabdeb8a3cbf4938e374027f326e2340c0185fbac237681c1616945dc7a56398bfc3
+  metadata.gz: c2096897426a341a5eb32081d8a3590341befb1b4d02d9c46898b7945568fe7e0bf47bcacb634c3f4068e4fd4ac2ed06aae2776696a3bc33532e0483a0d7678c
+  data.tar.gz: 8c0edb41c39c2ef8a475ffdec1b05012b147f5ad415eb9887b8b8d338a74b2f0bae3edc4e894b2782e80f4ef84a22e19d0b4918809ca48104d55bdc180daca04

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.9.0)
+    vero (0.10.0)
       json
       rest-client
-      sucker_punch (~> 1.6.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    actionmailer (3.2.22)
-      actionpack (= 3.2.22)
+    actionmailer (3.2.22.5)
+      actionpack (= 3.2.22.5)
       mail (~> 2.5.4)
-    actionpack (3.2.22)
-      activemodel (= 3.2.22)
-      activesupport (= 3.2.22)
+    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,23 +21,24 @@ GEM
       rack-cache (~> 1.2)
       rack-test (~> 0.6.1)
       sprockets (~> 2.2.1)
-    activemodel (3.2.22)
-      activesupport (= 3.2.22)
+    activemodel (3.2.22.5)
+      activesupport (= 3.2.22.5)
       builder (~> 3.0.0)
-    activerecord (3.2.22)
-      activemodel (= 3.2.22)
-      activesupport (= 3.2.22)
+    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.22)
-      activemodel (= 3.2.22)
-      activesupport (= 3.2.22)
-    activesupport (3.2.22)
+    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.3)
+    ast (2.4.1)
     builder (3.0.4)
-    celluloid (0.17.2)
+    celluloid (0.17.4)
       celluloid-essentials
       celluloid-extras
       celluloid-fsm
@@ -53,89 +53,108 @@ GEM
       timers (>= 4.1.1)
     celluloid-pool (0.20.5)
       timers (>= 4.1.1)
-    celluloid-supervision (0.20.5)
+    celluloid-supervision (0.20.6)
       timers (>= 4.1.1)
-    connection_pool (2.2.0)
+    concurrent-ruby (1.1.7)
+    connection_pool (2.2.3)
     delayed_job (3.0.5)
       activesupport (~> 3.0)
-    delayed_job_active_record (4.0.3)
-      activerecord (>= 3.0, < 5.0)
-      delayed_job (>= 3.0, < 4.1)
-    diff-lcs (1.2.5)
-    domain_name (0.5.25)
+    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.3)
-    hitimes (1.2.3)
-    hitimes (1.2.3-java)
-    http-cookie (1.0.2)
+    http-accept (1.7.0)
+    http-cookie (1.0.3)
       domain_name (~> 0.5)
-    i18n (0.7.0)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
     journey (1.0.4)
-    json (1.8.3)
-    json (1.8.3-java)
-    mail (2.5.4)
+    json (1.8.6)
+    mail (2.5.5)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
     mime-types (1.25.1)
     mono_logger (1.1.0)
-    multi_json (1.11.2)
-    netrc (0.10.3)
+    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.2)
+    rack-cache (1.12.0)
       rack (>= 0.4)
-    rack-protection (1.5.3)
+    rack-protection (1.5.5)
       rack
     rack-ssl (1.3.4)
       rack
     rack-test (0.6.3)
       rack (>= 1.0)
-    rails (3.2.22)
-      actionmailer (= 3.2.22)
-      actionpack (= 3.2.22)
-      activerecord (= 3.2.22)
-      activeresource (= 3.2.22)
-      activesupport (= 3.2.22)
+    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.22)
-    railties (3.2.22)
-      actionpack (= 3.2.22)
-      activesupport (= 3.2.22)
+      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.4.2)
+    rainbow (3.0.0)
+    rake (13.0.1)
     rdoc (3.12.2)
       json (~> 1.4)
-    redis (3.2.1)
-    redis-namespace (1.5.2)
-      redis (~> 3.0, >= 3.0.4)
-    resque (1.25.2)
+    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.3)
+      redis-namespace (~> 1.6)
       sinatra (>= 0.9.2)
       vegas (~> 0.1.2)
-    rest-client (1.8.0)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
       http-cookie (>= 1.0.2, < 2.0)
-      mime-types (>= 1.16, < 3.0)
-      netrc (~> 0.7)
-    rspec (3.3.0)
-      rspec-core (~> 3.3.0)
-      rspec-expectations (~> 3.3.0)
-      rspec-mocks (~> 3.3.0)
-    rspec-core (3.3.2)
-      rspec-support (~> 3.3.0)
-    rspec-expectations (3.3.1)
+      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.3.0)
-    rspec-mocks (3.3.2)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.3.0)
-    rspec-support (3.3.0)
-    sidekiq (3.5.1)
+      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)
@@ -152,23 +171,21 @@ GEM
       tilt (~> 1.1, != 1.3.0)
     sucker_punch (1.6.0)
       celluloid (~> 0.17.2)
-    thor (0.19.1)
+    thor (1.0.1)
     tilt (1.4.1)
-    timers (4.1.1)
-      hitimes
+    timers (4.3.2)
     treetop (1.4.15)
       polyglot
       polyglot (>= 0.3.1)
-    tzinfo (0.3.44)
+    tzinfo (0.3.57)
     unf (0.1.4)
       unf_ext
-    unf (0.1.4-java)
-    unf_ext (0.0.7.1)
+    unf_ext (0.0.7.7)
+    unicode-display_width (1.7.0)
     vegas (0.1.11)
       rack (>= 1.0.0)
 
 PLATFORMS
-  java
   ruby
 
 DEPENDENCIES
@@ -177,5 +194,10 @@ DEPENDENCIES
   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,38 +12,47 @@ 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|
-      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
+```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 = :sidekiq         # Sidekiq
-    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.
@@ -51,7 +60,9 @@ We recommend that you select one of the supported queue-based alternatives:
 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.
 
@@ -60,13 +71,15 @@ If you have any additional questions, please contact support@getvero.com.
 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.
@@ -74,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
@@ -94,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.
@@ -129,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
 
@@ -183,41 +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"})
-
-        # Resubscribing a user
-        vero.users.resubscribe!({:id => 123})
-      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