informant-rails 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8a65828c53957be32307a98b3b0d54e8faaa0c23
-  data.tar.gz: 014728da192e78d784c737dcd9b17bf067eecab0
+  metadata.gz: 5995154e25aa6d876e155c33a55da4604f2f7757
+  data.tar.gz: fc7097388c33fd8a607e2deca10ffe7d769fe9c5
 SHA512:
-  metadata.gz: 4df17ef313a87bc1a7f66bf25c2d5486fc94e4980eee851a2171ea3087c30731b4dac1b7b69a53a7c13c51b6c22b3a2363ccb8459d3a58e4150beb7d0d27d180
-  data.tar.gz: 70366afc5e6eb6c236afb3576f1f826dba2e5445727119bf40cd3b443b530b1d7f33220c6b0b3ab45a8ef6048dce8c68c76e6410e45fef43a209247fb3cca374
+  metadata.gz: 4a01db40601239898b1b9999f73ec0ee16fa1d1833b64ffded4d6bd4a4bd1666e843ef4424c951b6494936320e6603e96090f52fb80c33b3d50f5b91b76b06e2
+  data.tar.gz: fc63088ae0632869acfd095ff2654d215fca6c2eda610468314937b53c0341c2ae0e97f40b941e9df4e061c0f17ee27ff248e9c4c5c7615b3ec6dd49bb86a99c

data/README.markdown

@@ -8,7 +8,13 @@ The informant-rails gem provides Rails and ActiveRecord hooks for The Informant.
 
 ## Compatibility
 
-The informant-rails gem is tested against Ruby 1.9.3, 2.0.0, and Rubinius.
+The informant-rails gem supports the following versions of Ruby:
+- 1.9.x
+- 2.x
+- rubinius
+- jruby
+
+It will work automatically with Rails 3.x / 4.x and Mongoid 3.x / 4.x.
 
 [![Build Status](https://travis-ci.org/informantapp/informant-rails.svg?branch=master)](https://travis-ci.org/informantapp/informant-rails)
 [![Code Climate](https://codeclimate.com/github/informantapp/informant-rails.png)](https://codeclimate.com/github/informantapp/informant-rails)
@@ -23,4 +29,50 @@ gem 'informant-rails', group: :production
 
 ## Usage
 
-By default, any request that causes an ActiveRecord model to be validated will be tracked by the Informant once the gem is added to your project.
+By default, any request that causes an ActiveRecord or Mongoid model to be validated will be tracked by the Informant once the gem is added to your project.
+
+### Tracking Other Validations
+
+If you have other objects that conform to the ActiveModel interface, you can include validation tracking in your class and it will just work.
+
+```
+class VeryActiveModel
+  include InformantRails::ValidationTracking
+end
+```
+
+## Configuration
+
+Configuration options are specified in the `InformantRails::Config` module. Reasonable defaults are provided but you can override them as necessary by creating an initializer and passing a block to `configure`.
+
+```
+InformantRails::Config.configure do |config|
+  config.api_token = ENV['INFORMANT_API_KEY']
+  config.exclude_models = %w(UntrackedModel)
+  config.filter_parameters.push *%w(password password_confirmation)
+end
+```
+
+### api_token
+
+Default Value: `ENV['INFORMANT_API_KEY']`
+
+Example Value: `dff67d9e61eaa8cf110b3d3f3238a671`
+
+This should be set to the API key assigned to you when you provisioned your application. Heroku will automatically add this to your environment when you provision the addon. Otherwise, you can get this from the Informant web application.
+
+### exclude_models
+
+Default Value: `[]`
+
+Default Value: `['Person', 'Employee']`
+
+This allows you to exclude certain models from tracking. If you don't want them to be included, just list their class names as strings.
+
+### filter_parameters
+
+Default Value: `Rails.configuration.filter_parameters`
+
+Example Value: `['password', 'password_confirmation']`
+
+Any field names specified here will not be included in value tracking. Any sensitive information that you wouldn't want to include in your server log should be listed here as well.

data/lib/informant-rails/client.rb

@@ -2,10 +2,9 @@ require 'typhoeus'
 
 module InformantRails
   class Client
-    @requests = {}
 
     def self.record(env)
-      unless env['REQUEST_METHOD'] == 'GET'
+      unless Config.api_token.blank? || env['REQUEST_METHOD'] == 'GET'
         new_request.request_url = env['HTTP_REFERER']
       end
     end
@@ -23,44 +22,46 @@ module InformantRails
 
     def self.process
       if request && request.models.any?
-        Typhoeus::Request.new(
-          api_url,
-          method: :post,
-          body: { payload: request }.to_json,
-          headers: {
-            "Authorization" => ActionController::HttpAuthentication::Token.encode_credentials(InformantRails::Config.api_token),
-            "Content-Type" => "application/json"
-          }
-        ).run
+        this_request = request
+        Thread.new { transmit(this_request) }
       end
     ensure
-      remove_request
+      cleanup
     end
 
     def self.request
-      @requests[request_id]
+      Thread.current[:informant_request]
     end
 
-    private
-
-    def self.include_model?(model)
-      !InformantRails::Config.exclude_models.include?(model.class.to_s)
+    def self.cleanup
+      Thread.current[:informant_request] = nil
     end
 
-    def self.new_request
-      @requests[request_id] = Request.new
+    def self.transmit(completed_request)
+      Typhoeus::Request.new(
+        api_url,
+        method: :post,
+        body: { payload: completed_request }.to_json,
+        headers: {
+          "Authorization" => ActionController::HttpAuthentication::Token.encode_credentials(Config.api_token),
+          "Content-Type" => "application/json"
+        }
+      ).run
     end
 
-    def self.remove_request
-      @requests.delete(request_id)
+    private
+
+    def self.include_model?(model)
+      !Config.exclude_models.include?(model.class.to_s)
     end
 
-    def self.request_id
-      Thread.current.object_id
+    def self.new_request
+      Thread.current[:informant_request] = Request.new
     end
 
     def self.api_url
       @api_url ||= 'https://api.informantapp.com/api/v1/form_submissions'
     end
+
   end
 end

data/lib/informant-rails/connection_tester.rb

@@ -3,16 +3,16 @@ module InformantRails
     def self.run; new.run end
 
     def run
-      if InformantRails::Config.api_token.blank?
+      if Config.api_token.blank?
         Rails.logger.info missing_api_token_message
       else
-        InformantRails::Client.record('HTTP_REFERER' => '/connectivity/test')
-        InformantRails::Client.record_action('Connectivity', 'test')
-        InformantRails::Client.request.instance_variable_set('@models', [{
+        Client.record('HTTP_REFERER' => '/connectivity/test')
+        Client.record_action('Connectivity', 'test')
+        Client.request.instance_variable_set('@models', [{
           name: 'TestClass',
           errors: [name: 'field_name', value: 'field_value', message: 'must be unique']
         }])
-        response = InformantRails::Client.process
+        response = Client.transmit(Client.request)
 
         if response.success?
           Rails.logger.info success_message

data/lib/informant-rails/middleware.rb

@@ -1,9 +1,9 @@
 module InformantRails
   class Middleware < Struct.new(:app)
     def call(env)
-      InformantRails::Client.record(env)
+      Client.record(env)
       response = app.call(env)
-      InformantRails::Client.process
+      Client.process
       response
     end
   end

data/lib/informant-rails/railtie.rb

@@ -1,32 +1,24 @@
 module InformantRails
   class Railtie < ::Rails::Railtie
     initializer 'informant middleware' do |config|
-      if InformantRails::Config.api_token
-        config.middleware.use 'InformantRails::Middleware'
-      end
+      config.middleware.use 'InformantRails::Middleware'
     end
 
     initializer 'informant ActionController binding' do
-      if InformantRails::Config.api_token
-        ActiveSupport.on_load :action_controller do
-          include InformantRails::RequestTracking
-        end
-
-        InformantRails::Config.filter_parameters = Rails.configuration.filter_parameters
+      ActiveSupport.on_load :action_controller do
+        include InformantRails::RequestTracking
       end
+
+      InformantRails::Config.filter_parameters = Rails.configuration.filter_parameters
     end
 
     initializer 'informant ActiveRecord binding' do
-      if InformantRails::Config.api_token
-
-        ActiveSupport.on_load(:active_record) do
-          include InformantRails::ValidationTracking
-        end
-
-        ActiveSupport.on_load(:mongoid) do
-          include InformantRails::ValidationTracking
-        end
+      ActiveSupport.on_load(:active_record) do
+        include InformantRails::ValidationTracking
+      end
 
+      ActiveSupport.on_load(:mongoid) do
+        include InformantRails::ValidationTracking
       end
     end
   end

data/lib/informant-rails/version.rb

@@ -1,3 +1,3 @@
 module InformantRails
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: informant-rails
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Paul Elliott
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-06 00:00:00.000000000 Z
+date: 2014-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails