thisdata 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 733fd722c94d64605f71c6c1dde7651ee3637ef0
-  data.tar.gz: c35dfe168584f381f8d7b4ec785be3d30000a22f
+  metadata.gz: cc2ec4099c581d83cd5e0841bd29312ff6951c3d
+  data.tar.gz: 8373e836057db6ba6ff8ccb785c3df73e7bc49a5
 SHA512:
-  metadata.gz: ed4916c46d949108998764e9dec362e558fefa757bf49944512ad4ea2d6831158a7f858a34fc33ae2d2a1af05cd4ea53deacc03383243925317462e7c9260842
-  data.tar.gz: 003187257e62124d7ab56c6f0c5b4a11f45c6721254413b21d0d55e3764e62938c1853aa9acc83cc591e5bce0a0689cc15c454ee39f8fc1578a7befe6725eb6c
+  metadata.gz: 613abc4d3418e3e8b09a1b11d6b2ab78636d260ca090bbf822c4141ff37c0f8f4bfb6db2879a6f86a3e28fc62486bbd3746d22389fe9bb90ec975cb80ade9597
+  data.tar.gz: 3fb27a19aabd7750898285e206496d8a9207a52340fa63580821a89a98a265ed4c542da32797e7737d59303430f5e2fe5399f3c321bfa4837469d9fb63e04ff9

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+before_install:
+  - gem install bundler

data/CHANGELOG

@@ -1,3 +1,8 @@
+# 0.1.5
+
+  - Allows automatic tracking of ThisData's optional JavaScript cookie value
+    https://github.com/thisdata/thisdata-ruby/issues/13
+
 # 0.1.4
 
   - ThisData wasn't being required properly: https://github.com/thisdata/thisdata-ruby/issues/8

data/README.md

@@ -1,4 +1,4 @@
-# ThisData Ruby
+# ThisData Ruby [![Build Status](https://travis-ci.org/thisdata/thisdata-ruby.png?branch=master)](https://travis-ci.org/thisdata/thisdata-ruby)
 
 This gem allows you to use the ThisData Login Intelligence API.
 
@@ -93,7 +93,9 @@ that's the place to do it!
 `ThisData.track`.**
 
 However, we do provide a `ThisData::TrackRequest` module which, when included in
-an ActionController, gives you a simple way to track requests.
+an ActionController, gives you a simple way to track requests. The advantage
+is that this module knows how to get request details automagically, like the IP,
+user agent, and ThisData's tracking cookie value (if you've turned that on).
 
 You include the module, then call `thisdata_track`. Easy!
 

data/lib/generators/this_data/install_generator.rb

@@ -53,6 +53,13 @@ ThisData.setup do |config|
   # Default: :mobile
   # config.user_mobile_method = :mobile
 
+
+  # ThisData's JS library (optional) adds a cookie.
+  # If you're using the library, set this to true, so that we know to expect
+  # a cookie value
+  # Default: false
+  # config.expect_js_cookie = true
+
 end
 EOS
       end

data/lib/this_data/client.rb

@@ -36,6 +36,10 @@ module ThisData
     #                 *email and/or mobile MUST be passed if you want ThisData
     #                 to send 'Was This You?' notifications via email and/or SMS
     #   - name      (Optional: String)  the user's name, used in notifications
+    #  - session   (Optional: Hash) details about the user's session
+    #   - td_cookie_expected (Optional: Boolean) whether you expect a JS cookie
+    #                         to be present
+    #   - td_cookie_id       (Optional: String) the value of the JS cookie
     def track(event)
       post_event(event)
     end

data/lib/this_data/configuration.rb

@@ -3,6 +3,9 @@ require "ostruct"
 module ThisData
   class Configuration
 
+    # ThisData's JS library (optional) adds a cookie with this name
+    JS_COOKIE_NAME = '__tdli'
+
     # Programatically create attr accessors for config_option
     def self.config_option(name)
       define_method(name) do
@@ -26,6 +29,11 @@ module ThisData
     # Log the events sent
     config_option :logger
 
+    # ThisData's JS library (optional) adds a cookie.
+    # If you're using the library, set this to true, so that we know to expect
+    # a cookie value
+    config_option :expect_js_cookie
+
     # TrackRequest config options
     # We will attempt to call this method on a Controller to get the user record
     # Default: :current_user
@@ -51,7 +59,8 @@ module ThisData
         user_id_method:     :id,
         user_name_method:   :name,
         user_email_method:  :email,
-        user_mobile_method: :mobile
+        user_mobile_method: :mobile,
+        expect_js_cookie:   false
       })
     end
 

data/lib/this_data/track_request.rb

@@ -27,11 +27,16 @@ module ThisData
         user = send(ThisData.configuration.user_method)
       end
 
+
       event = {
         verb:       verb,
         ip:         request.remote_ip,
         user_agent: request.user_agent,
-        user:       user_details(user)
+        user:       user_details(user),
+        session: {
+          td_cookie_expected: ThisData.configuration.expect_js_cookie,
+          td_cookie_id:       td_cookie_value,
+        }
       }
 
       ThisData.track(event)
@@ -68,5 +73,13 @@ module ThisData
         end
       end
 
+      # When using the optional JavaScript library, a cookie is placed which
+      # helps us track devices.
+      # If the cookie is nil, then either you aren't using the JS library, or
+      # the user likely has an ad-blocker.
+      def td_cookie_value
+        cookies[ThisData::Configuration::JS_COOKIE_NAME] rescue nil
+      end
+
   end
 end

data/lib/this_data/version.rb

@@ -1,3 +1,3 @@
 module ThisData
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: thisdata
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - ThisData Ltd
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-02 00:00:00.000000000 Z
+date: 2016-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -119,6 +119,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - CHANGELOG
 - Gemfile
 - LICENSE.md