woopra_track 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b7223a15d2694d6f1fff24368c65052dd3074bd
-  data.tar.gz: 5d4e05376eb54ff80f73adc72fbdb0438a76771e
+  metadata.gz: f086eb67b919daf6479b17a3681ace3acde785d9
+  data.tar.gz: e842a3d273e3a99e2d10117149f4a4a0212d26af
 SHA512:
-  metadata.gz: ef3905755fbae9609a907ac9b828ba3706c6006a0e8cb9c2ea20845457691ae926ab43bfcdc8abe2a826bde2e897dfa7e735f0c8e3d6d7573288b1db3870893a
-  data.tar.gz: 7b983f399f2855fb2e68be53b4706d37d291e42faf8f9bf2ad7fc84091cce43c6621a1ee5785bba633f0b026c645acb2b82e3446f8724b80f1b85e5ec3e897f4
+  metadata.gz: b5ad5ce7ed87604e4da354f683d200da0989c99fd011fa44efee45e3bb48ae71864d61f365b801a9a84e26e91d3313261d5152be16a4f068b17052acde8d1fca
+  data.tar.gz: 588c1a8d06f2987c99e51eb2fb400c7d67df369593798129e8b2f8e96e6a2aa4eb6947ff9d4a4aa9fbb532278cbd3b20ac2e91f2064498604c7aad8eed1ad1d9

data/README.md

@@ -1,6 +1,10 @@
 # WoopraTrack
 
-Tracking library for woopra.com. Woopra analytics client-side and server-side tracking helper.
+Tracking library for [woopra.com](https://www.woopra.com). Woopra analytics client-side and server-side tracking helper.
+
+[![Gem Version](https://badge.fury.io/rb/woopra_track.svg)](https://badge.fury.io/rb/woopra_track)
+[![Build Status](https://travis-ci.org/hardpixel/woopra-track.svg?branch=master)](https://travis-ci.org/hardpixel/woopra-track)
+[![Code Climate](https://codeclimate.com/github/hardpixel/woopra-track/badges/gpa.png)](https://codeclimate.com/github/hardpixel/woopra-track)
 
 ## Installation
 
@@ -20,7 +24,135 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+To enable tracker in a ActionController controller, include the `WoopraTrack` concern in your class:
+
+```ruby
+class PagesController < ApplicationController
+  include WoopraTrack
+end
+```
+
+You can then configure the tracker in your controller. For example, if you want to set up tracking with Woopra on your homepage, the controller should look like and then you will have the `@woopra` instance variable available:
+
+```ruby
+class PagesController < ApplicationController
+  def home
+    config = { domain: 'website.com' }
+    woopra(request, config)
+
+    # Your code here...
+  end
+end
+```
+
+You can also customize all the properties of the woopra during that step by adding them to the `config_hash`. For example, to also update your idle timeout (default: 30 seconds):
+
+```ruby
+# Using woopra function
+config = { domain: 'website.com', idle_timeout: 15000 }
+woopra(request, config)
+
+# Using @woopra instance variable
+@woopra.config({ idle_timeout: 15000 })
+```
+
+To add custom visitor properties, you should use the `identify` function:
+
+```ruby
+@woopra.identify({
+  email:   'johndoe@website.com',
+  name:    'John Doe',
+  company: 'Business'
+})
+```
+
+If you wish to identify a user without any tracking event, don't forget to `push` the update to woopra:
+
+```ruby
+# Push through front-end
+@woopra.identify(user_hash)
+@woopra.push
+
+# Push through back-end
+@woopra.identify(user_hash)
+@woopra.push(true)
+```
+
+If you wish to track page views, just call `track`:
+
+``` ruby
+# Front-end tracking:
+@woopra.track
+
+# Back-end tracking:
+@woopra.track(true)
+```
+
+You can also track custom events through the front-end or the back-end. With all the previous steps done at once, your controller should look like:
+
+``` ruby
+class PagesController < ApplicationController
+  include WoopraTrack
+
+  def home
+    # Initialize and configure woopra tracker
+    config = { domain: 'website.com', idle_timeout: 15000 }
+    woopra(request, config)
+
+    # Identify user
+    @woopra.identify({
+      email:   'johndoe@website.com',
+      name:    'John Doe',
+      company: 'Business'
+    })
+
+    # Track a custom event through the front end...
+    @woopra.track('play', {
+      artist: 'Dave Brubeck',
+      song:   'Take Five',
+      genre:  'Jazz'
+    })
+
+    # ... and through the back end by passing the optional argument `true`
+    @woopra.track('signup', {
+      company:  'Business',
+      username: 'johndoe',
+      plan:     'Gold'
+    }, true)
+
+    # Enable front-end tracking
+    @woopra.track
+
+    # Your code here...
+  end
+end
+```
+
+and add the code in your template's header (here `home.html.erb`)
+
+```erb
+<!DOCTYPE html>
+<html>
+  <head>
+    <!-- Your header here... -->
+    <%= woopra_javascript_tag %>
+  </head>
+   <body>
+    <!-- Your body here... -->
+  </body>
+</html>
+```
+
+Finally, if you wish to track your users only through the back-end, you should set the cookie on your user's browser. However, if you are planning to also use front-end tracking, don't even bother with that step, the JavaScript tracker will handle it for you.
+
+``` ruby
+# During initialization
+config = { domain: 'website.com', idle_timeout: 15000 }
+woopra(request, config, cookies)
+
+# Using set cookie function
+@woopra.set_cookie(cookies)
+```
 
 ## Development
 

data/lib/woopra_track/tracker.rb

@@ -141,16 +141,18 @@ module WoopraTrack
         request_headers   = { 'User-Agent' => @request.env['HTTP_USER_AGENT'] }
         request_response  = Typhoeus.get(request_url, headers: request_headers)
 
-        if @logger
-          if request_response.success?
-            @logger.info("Woopra") { "Success: #{request_url}" }
-          elsif request_response.timed_out?
-            @logger.warn("Woopra") { "Timeout: #{request_url}" }
-          elsif request_response.code == 0
-            @logger.error("Woopra") { "#{request_response.return_message}, #{request_url}" }
-          else
-            @logger.error("Woopra") { "WOOPRA Failed: #{request_response.code.to_s}, #{request_url}" }
-          end
+        log_request(request_response) if @logger
+      end
+
+      def log_request(response)
+        if response.success?
+          @logger.info("Woopra") { "Success: #{request_url}" }
+        elsif response.timed_out?
+          @logger.warn("Woopra") { "Timeout: #{request_url}" }
+        elsif response.code == 0
+          @logger.error("Woopra") { "#{response.return_message}, #{request_url}" }
+        else
+          @logger.error("Woopra") { "WOOPRA Failed: #{response.code}, #{request_url}" }
         end
       end
 

data/lib/woopra_track/version.rb

@@ -1,3 +1,3 @@
 module WoopraTrack
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: woopra_track
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jonian Guveli