thisdata 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1bd194d89f48c0774d981d4c093ef12a1ed1b16e
-  data.tar.gz: 39ea8f55aaa501587e46cdb586e41a29f711760c
+  metadata.gz: 824e016111d0ad0979a53296fbeaf9020e0d44fe
+  data.tar.gz: 88001169e0964ed9068c7d43f524df35e5740acb
 SHA512:
-  metadata.gz: 0f9c4c7388e0b80d34e78f798fc5691b4db3f864e7ca84db4ddd11499b1395cd76eb33ea3fcc4ff2a4faaa2e48ac428e877e99fabe63a3d2aa84fb53329488ec
-  data.tar.gz: fe572684f6b1790d900ee21fe12ba508c19b017196c621b7de68b1dc99ed1cb3bf7f3e4d9106ee8eddb9cc33ca2346bad2f9688b9b992a4b9f69de4872f4807b
+  metadata.gz: 6cf37586dfcb83cf7d6c12256f68767b5d5ac0c0de3e90fd7208d64a4413c5c60a6183325f94912adb8636436b902c5779e01c605738e4517198fb03831dc1fe
+  data.tar.gz: 681c7e15c374b83551ff7d511eafd6fcc691fedf3249c316860d4bdb3e3aaff5ce9a7416ccf35336979afa54f8cf4f7de44eb96b91d4c2be21fd1b10322b282a

data/CHANGELOG

@@ -1,3 +1,7 @@
+# 0.1.1
+
+Makes Track requests asynchronous by default.
+
 # 0.1.0
 
 Initial release.

data/README.md

@@ -20,25 +20,37 @@ Or install it yourself as:
 
 ## Usage
 
-Run:
+### Ruby
 
-    rails g this_data:install YOUR_API_KEY_HERE
+Configure ThisData as follows:
+
+```
+ThisData.setup do |config|
+  config.api_key = "API_KEY_HERE"
+end
+```
+
+You can then track any event by calling `ThisData.track` and passing a Hash which
+contains an event. See examples and required fields on our API documentation:
+http://help.thisdata.com/docs/apiv1events
+
+**Important!** You should not commit your API keys to source control. Where
+possible, use environment variables / a non-committed secrets file / something
+similar.
+
+### Rails
 
-You can find your API key by going to [ThisData](https://thisdata.com) >
+Find your API key by going to [ThisData](https://thisdata.com) >
   Integrations > Login Intelligence API.
 
+Run:
+
+    rails g this_data:install YOUR_API_KEY_HERE
+
 The generator will create a file in `config/initializers` called "this_data.rb".
 If you need to do any further configuration or customization of ThisData,
 that's the place to do it!
 
-## Ruby
-
-You can track any event by calling `ThisData.track` and passing a Hash which
-contains an event. See examples and required fields on our API documentation:
-http://help.thisdata.com/docs/apiv1events
-
-## Rails
-
 The ThisData::TrackRequest module can be included in a ActionController, giving
 you a handy way to track requests.
 
@@ -67,7 +79,24 @@ class SessionsController < ApplicationController
 end
 ```
 
+### Stuck?
+
+By default there is no logger configured, and requests are performed
+asynchronously. The following config settings can be helpful in debugging issues:
+
+`config/initializers/this_data.rb`
+```
+ThisData.setup do |config|
+  # ...
+
+  config.logger = Rails.logger # or Logger.new($stdout)
+  config.asyc   = false
+end
+```
+
+Our documentation can be read at http://help.thisdata.com.
 
+Reach out to developers@thisdata.com if you need any help.
 
 ## Development
 
@@ -77,4 +106,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/revertio/thisdata-ruby.
+Bug reports and pull requests are welcome on GitHub at https://github.com/thisdata/thisdata-ruby.

data/lib/generators/this_data/install_generator.rb

@@ -22,6 +22,9 @@ ThisData.setup do |config|
 
   # Define a Logger instance if you want to debug / track errors
   # config.logger = Rails.logger unless Rails.env.production?
+
+  # Set this to false if you want ThisData.track to perform in the same thread
+  # config.asyc =               false
 end
 EOS
       end

data/lib/this_data.rb

@@ -27,18 +27,17 @@ module ThisData
       configuration.defaults
     end
 
-    # Creates a Client and tracks an event.
+    # Tracks an event. If `ThisData.configuration.async` is true, this action
+    # will be performed in a new Thread.
     # Event must be a Hash
+    # When performed asynchronously, true is always returned.
+    # Otherwise an HTTPRequest is returned.
     def track(event)
-      Client.new.track(event)
-      log("Tracked event!")
-    rescue => e
-      ThisData.error("Failed to track event:")
-      ThisData.error(e)
-      e.backtrace.each do |line|
-        ThisData.error(line, prefix: false)
+      if ThisData.configuration.async
+        track_async(event)
+      else
+        track_with_response(event)
       end
-      false
     end
 
     # A helper method to track a log-in event. Validates that the minimum
@@ -67,5 +66,35 @@ module ThisData
       log(message, level: 'error', prefix: prefix)
     end
 
+    private
+
+      # Creates a Client and tracks an event.
+      # Event must be a Hash.
+      # Rescues and logs all exceptions.
+      # Returns an HTTPResponse
+      def track_with_response(event)
+        response = Client.new.track(event)
+        log("Tracked event!")
+        response
+      rescue => e
+        ThisData.error("Failed to track event:")
+        ThisData.error(e)
+        e.backtrace.each do |line|
+          ThisData.error(line, prefix: false)
+        end
+        false
+      end
+
+      # Performs the track function within a new Thread, so it is non blocking.
+      # Returns the Thread created
+      def track_async(event)
+        Thread.new do
+          track_with_response(event)
+        end
+      rescue => e
+        ThisData.error("Cannot create Thread: #{e.inspect}")
+        false
+      end
+
   end
 end

data/lib/this_data/configuration.rb

@@ -18,6 +18,11 @@ module ThisData
     #   > Login Intelligence API
     config_option :api_key
 
+    # When true, requests will be performed asynchronously. Setting this to
+    # false can help with debugging.
+    # Default: true
+    config_option :async
+
     # Log the events sent
     config_option :logger
 
@@ -41,6 +46,7 @@ module ThisData
 
       # set default attribute values
       @defaults = OpenStruct.new({
+        async:              true,
         user_method:        :current_user,
         user_id_method:     :id,
         user_name_method:   :name,

data/lib/this_data/track_request.rb

@@ -1,6 +1,10 @@
 # Include ThisData::TrackRequest in your ApplicationController to get a handy
 # track method which looks at the request and current_user variables to
 # generate an event.
+#
+# If you include this in a non-ActionController instance, you must respond to
+# `request` and `ThisData.configuration.user_method`
+#
 module ThisData
   module TrackRequest
     class ThisDataTrackError < StandardError; end
@@ -8,47 +12,29 @@ module ThisData
     # Will pull request and user details from the controller, and send an event
     # to ThisData.
     def thisdata_track(verb: ThisData::Verbs::LOG_IN)
-      controller = controller_from_env
-      user_details = user_details_from_controller(controller)
       event = {
-        verb: verb,
-        ip: request.remote_ip,
+        verb:       verb,
+        ip:         request.remote_ip,
         user_agent: request.user_agent,
-        user: user_details
+        user:       user_details
       }
 
       ThisData.track(event)
     rescue => e
       ThisData.error "Could not track event:"
       ThisData.error e
-      ThisData.error e.backtrace.limit(5).join("\n")
+      ThisData.error e.backtrace[0..5].join("\n")
       false
     end
 
     private
 
-      # Rails keeps a reference to the controller in the env variable.
-      # Returns a Controller
-      def controller_from_env
-        unless controller = env["action_controller.instance"]
-          raise ThisDataTrackError, "Could not get controller from environment"
-        end
-        controller
-      end
-
-      # Fetches the user record by calling the configured method on the
-      # controller.
-      # Will raise a NoMethodError if controller does not respond to the method.
-      # Returns an object
-      def user_from_controller(controller)
-        user = controller.send(ThisData.configuration.user_method)
-      end
-
-      # Will fetch a user and return a Hash of details for that User.
+      # Will fetch a user and return a Hash of details for the User returned
+      # by `ThisData.configuration.user_method`.
       # Will raise a NoMethodError if controller does not return a user,
       #  or we can't get a user id.
-      def user_details_from_controller(controller)
-        user = user_from_controller(controller)
+      def user_details
+        user = send(ThisData.configuration.user_method)
         {
           id:     user.send(ThisData.configuration.user_id_method),
           name:   value_if_configured(user, "user_name_method"),

data/lib/this_data/version.rb

@@ -1,3 +1,3 @@
 module ThisData
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: thisdata
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - ThisData Ltd