isc_analytics 0.5.1 → 0.5.2

data/README.md

@@ -1,5 +1,6 @@
-# ISC Analytics
-A simple client-side & server-side analytics library for Rails
+# ISC Analytics [![Build Status](https://travis-ci.org/TheGiftsProject/isc_analytics.png?branch=master)](https://travis-ci.org/TheGiftsProject/isc_analytics)
+A simple client-side & server-side analytics library for Rails. It currently supports only KISSmetrics for more advanced
+analytics features (trackEvent / setProperties) and Google Analytics just for tracking pageviews.
 
 ## Installation 
 
@@ -9,21 +10,21 @@ Just add the `isc_analytics` gem into your Gemfile
 gem 'isc_analytics'
 ```
 
-Then create an initializer file in your `config/initialize` directory containing the initial config of your analytics.
+Then add an initializer file in your `config/initializers` directory containing the initial config of your analytics.
 
 ## Configuration
 
-ISC Analytics current supports the following configurations:
+ISC Analytics currently supports the following configuration options:
 
 
 ```ruby
-IscAnalytics.config.accounts = ANALYTIC_ACCOUNTS # an accounts objects (preferably using ConfigReader)
+IscAnalytics.config.accounts = ANALYTIC_ACCOUNTS # an accounts object (preferably using ConfigReader)
 IscAnalytics.config.namespace = 'App' # an alias which will gain all the analytics behivour in the clientside.
 ```
 
-We recommend our other gem [ConfigReader](https://github.com/TheGiftsProject/configreader) to load the analytics_accounts data from a YML.
+We highly recommend you to use our other gem [ConfigReader](https://github.com/TheGiftsProject/configreader) to load the analytics_accounts data from a YML.
 
-The analytics accounts should contain the following sub keys:
+The accounts hash / EnvConfigReader should contain the following sub keys:
 
 ```yml
 kissmetrics_key: "KEY"
@@ -36,29 +37,37 @@ Currently only the KISSMetrics and Google Analytics keys are mandatory although
 
 ## Usage
 
-There are three points of usage for the isc_analytics gem, the first is including and starting to use the gem in your app. The second is Client side analytics events and the third is server side analytics events.
+The basic way to use isc_analytics is to simply follow the **Getting Started** step, which will guide you on how
+to enable simple visitor tracking in KISSmetrics and Google Analytics
 
-### Including
+If you need more, there's a client-side & server-side tracking analytics API. (Enabled just for KISSmetrics)
+
+## Getting Started
+
+After you've finished configuring isc_analytics, do the following in order to include it in your app:
+
+#### ApplicationController
 
-To include isc_analytics in your app, after you install the gem.
 Add the following line inside your ApplicationController:
 
 ```ruby
 include IscAnalytics::ControllerSupport
 ```
-This will enable you to use the analytics object from your controllers and views.
+This will enable you to use the Analytics object from your controllers and views.
 
-And the following line to your main application layout
+#### Application Layout
+
+Add the following line to your main application layout, under the HTML head tag.
 
 ```erb
 <%= add_analytics %>
 ```
 
-This will embed all the needed html for the analytics to run (including the code for all the required services.)
+This will embed all the needed HTML for the analytics to run (including the code for all the required services).
 
-### Client Side
+## Client Side
 
-After your install and include the isc_gem you can use the following functions in your client side javascript.
+Once you've included isc_analytics as we've explained above, you will have access to the following client-side API:
 
 ```js
 Analytics.trackEvent(<event name>, [<properties_hash>]);
@@ -68,14 +77,15 @@ Analytics.identify(<identity>, [<properties_hash>]);
 Analytics.clearIdentity()
 ```
 
-#### Namespacing
-The cool thing is that if you configure a Namespace in the configuration then we'll automatically alias all the functions to the Namespace of your choice for easy access.
+### Namespacing
+
+If you've configured a Namespace in the initializer, then we'll automatically alias all the functions to the Namespace of your choice for easy access.
 For example if I set my namespace as `App` then I'll be able to access the trackEvent function from `App.trackEvent`
 
-### Server Side
+## Server Side
 
-All the **client side event tracking is available from the server side** as well. Once you inlcude isc_analytics you can access the `analytics` object which will have methods identical to the client-side analytics methods.  
-For example you can call `analytics.trackEvent('user-visit')` and it will be persisted in the current user session and flushed into the users browser next time he visits a page (via add_analytics). This mechanism is similar in behaivour to Rails' flash object.
+All the **client side event tracking is available from the server side** as well. Once you've included isc_analytics you can access the `analytics` object which will have methods identical to the client-side analytics methods.  
+For example you can call `analytics.trackEvent('user-visit')` and it will be persisted in the current user session and flushed into the user's browser next time he visits a page (via add_analytics). This mechanism is similar in behaviour to Rails' flash object.
  
 ### Opt out
 

data/lib/assets/javascripts/isc_analytics.js

@@ -0,0 +1 @@
+//= require isc_analytics/index

data/lib/isc_analytics/engine.rb

@@ -1,12 +1,8 @@
-if defined?(::Rails::Engine)
-  module IscAnalytics
-    module Rails
-      class Engine < ::Rails::Engine
-        initializer :assets do |app|
-          IscAnalytics.app = app
-          app.config.assets.precompile += %w(isc_analytics isc_analytics/session isc_analytics/opt_out_analytics)
-        end
-      end
+module IscAnalytics
+  class Engine < ::Rails::Engine
+    initializer 'isc_analytics.assets' do |app|
+      IscAnalytics.app = app
+      app.config.assets.precompile += %w(isc_analytics.js isc_analytics/session.js isc_analytics/opt_out_analytics.js)
     end
   end
-end
+end

data/vendor/assets/javascripts/isc_analytics/session.js

@@ -0,0 +1 @@
+//= require isc_analytics/session/index

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: isc_analytics
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-24 00:00:00.000000000 Z
+date: 2012-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: controller_support
@@ -72,6 +72,7 @@ files:
 - lib/assets/javascripts/isc_analytics/isc_analytics.js.coffee
 - lib/assets/javascripts/isc_analytics/opt_out_analytics.js.coffee
 - lib/assets/javascripts/isc_analytics/visitor_analytics.coffee.erb
+- lib/assets/javascripts/isc_analytics.js
 - lib/isc_analytics/bootstrap.rb
 - lib/isc_analytics/client_api.rb
 - lib/isc_analytics/config.rb
@@ -83,6 +84,7 @@ files:
 - lib/isc_analytics.rb
 - vendor/assets/javascripts/isc_analytics/session/index.js
 - vendor/assets/javascripts/isc_analytics/session/session-0.4.js
+- vendor/assets/javascripts/isc_analytics/session.js
 - vendor/assets/javascripts/isc_analytics/yepnope/css_prefix.js
 - vendor/assets/javascripts/isc_analytics/yepnope/index.js
 - vendor/assets/javascripts/isc_analytics/yepnope/yepnope.js