thisdata 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c769ec94d780ff1f93699730acb971cf09d0d580
-  data.tar.gz: 1d4a7fa9e5b57fc1e6d563d02dd50473f4a1f809
+  metadata.gz: 733fd722c94d64605f71c6c1dde7651ee3637ef0
+  data.tar.gz: c35dfe168584f381f8d7b4ec785be3d30000a22f
 SHA512:
-  metadata.gz: b06b6d18354099b7dafb19eb982710606d1cba120fe9b0c99db8f3e7107f0c5a3b748b136eb4a554ad6ac3d73b6bab727a7169da9e146d80dd99b49944f1b01d
-  data.tar.gz: ad687196cfd094456dc13046e76ccc12ca60a92fbc718bf770e0d3c109e6e4f7afa3bffe4cc679338a3b17d56faf78998e737d0b7ebc8c770f1d208d2f61f4ed
+  metadata.gz: ed4916c46d949108998764e9dec362e558fefa757bf49944512ad4ea2d6831158a7f858a34fc33ae2d2a1af05cd4ea53deacc03383243925317462e7c9260842
+  data.tar.gz: 003187257e62124d7ab56c6f0c5b4a11f45c6721254413b21d0d55e3764e62938c1853aa9acc83cc591e5bce0a0689cc15c454ee39f8fc1578a7befe6725eb6c

data/CHANGELOG

@@ -1,3 +1,13 @@
+# 0.1.4
+
+  - ThisData wasn't being required properly: https://github.com/thisdata/thisdata-ruby/issues/8
+  - The response / failure of a request to our API wasn't being correctly logged
+    https://github.com/thisdata/thisdata-ruby/issues/9
+  - There are some new verbs with special semantic meaning which we've added
+    https://github.com/thisdata/thisdata-ruby/issues/12
+  - Tweaks to the ruby sample code, by @timhaines
+    https://github.com/thisdata/thisdata-ruby/pull/7
+
 # 0.1.3
 
 In the `ThisData::TrackRequest` module, make tracking a bit easier especially

data/README.md

@@ -27,22 +27,23 @@ http://help.thisdata.com
 
 #### Configuration
 
-Configure ThisData as follows:
+An example ThisData configuration is below. See `this_data/configuration.rb` for
+more options. For example, in production we recommend you turn on
+ the asynchronous and non-logging behaviour.
+
+If you're using Rails, you can generate this config file by following our
+[Set Up](#set-up) steps further down.
+
 
 ```ruby
+require 'this_data'
 ThisData.setup do |config|
-  config.api_key = "API_KEY_HERE" # Don't commit your key to source control!
+  config.api_key = 'API_KEY_HERE' # Don't commit your key to source control!
   config.logger  = Logger.new($stdout)
   config.async   = false
 end
 ```
 
-See `this_data/configuration.rb` for more options, and some suggested
-Ruby on Rails options in `this_data/generators/install_generator.rb`.
-
-For example, in production you will probably want asynchronous and non-logging
-behaviour.
-
 #### Tracking an Event
 
 You can then track any event by calling `ThisData.track` and passing a Hash which
@@ -58,7 +59,7 @@ ThisData.track(
     user: {
       id: user.id.to_s,
       name: user.name,
-      email: user.email
+      email: user.email,
       mobile: user.mobile
     }
   }
@@ -128,6 +129,19 @@ Note: as with many sensitive operations, taking different actions when an
 account exists vs. when an account doesn't exist can lead to a information
 disclosure through timing attacks.
 
+### Will this break my app?
+
+We hope not! We encourage you to use the asynchronous API call where possible
+just in case our end goes down. In all cases we have error handling to capture
+hard failures, but there may be edge-cases where timeouts or other bugs haven't
+been properly handled.
+
+So in your own app you could move tracking to a background job, enforce timeouts,
+add threading (safely!), or employ other methods which enforce good behaviour of
+third party gems.
+
+Read more: http://help.thisdata.com/docs/how-do-you-not-break-my-app
+
 
 ### Stuck?
 

data/lib/generators/this_data/install_generator.rb

@@ -1,3 +1,4 @@
+require 'this_data'
 module ThisData
   class InstallGenerator < Rails::Generators::Base
 

data/lib/this_data.rb

@@ -74,7 +74,8 @@ module ThisData
       # Returns an HTTPResponse
       def track_with_response(event)
         response = Client.new.track(event)
-        if response.try(:success?)
+        success = response && response.success? # HTTParty doesn't like `.try`
+        if success
           log("Tracked event! #{response.response.inspect}")
         else
           warn("Track failure! #{response.response.inspect} #{response.body}")

data/lib/this_data/verbs.rb

@@ -1,3 +1,10 @@
+# We use verbs to distinguish between different types of events.
+# The following is a a list of verbs which hold special semantic meaning to us.
+# In addition to these you can send any verb you like.
+#
+# Learn more about these verbs, and others, here:
+#   http://help.thisdata.com/docs/verbs
+#
 module ThisData
   class Verbs
 
@@ -6,5 +13,20 @@ module ThisData
     LOG_IN_DENIED         = 'log-in-denied'
     LOG_IN_CHALLENGE      = 'log-in-challenge'
 
+    ACCESS                = 'access'
+
+    EMAIL_UPDATE          = 'email-update'
+    PASSWORD_UPDATE       = 'password-update'
+
+    PASSWORD_RESET_REQUEST  = 'password-reset-request'
+    PASSWORD_RESET          = 'password-reset'
+    PASSWORD_RESET_FAIL     = 'password-reset-fail'
+
+    AUTHENTICATION_CHALLENGE      = 'authentication-challenge'
+    AUTHENTICATION_CHALLENGE_PASS = 'authentication-challenge-pass'
+    AUTHENTICATION_CHALLENGE_FAIL = 'authentication-challenge-fail'
+
+    TWO_FACTOR_DISABLE = 'two-factor-disable'
+
   end
 end

data/lib/this_data/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: thisdata
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - ThisData Ltd
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-26 00:00:00.000000000 Z
+date: 2016-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty