rulesio 0.9.8 → 0.9.10

data/README.md

@@ -61,7 +61,9 @@ To manually send an event when a user upgrades to a "premium" account:
 Filtering sensitive data
 ------------------------
 
-This gem will not send any parameters mentioned in Rails.application.config.filter_parameters, nor will it send any parameters that match /password/. We recommend extending this line in application.rb
+By default, the exceptions middleware will send information to an error channel about exceptions from your application, including params, session, referer and requested url, backtrace, rails\_env and a UID of the user that was affected by the exception. The users middleware will send information to a user channel about all page views, form submissions, page errors and model validation errors from your application. This includes the user's email address (when available as current\_user.email), params and session data, referring and requested urls, status codes, rails_env and connections to any corresponding exception events. For examples of user and error events generated by the gem, see [sample user event](https://github.com/rulesio/rulesio/wiki/Sample-user-event) and [sample error event](https://github.com/rulesio/rulesio/wiki/Sample-error-event).
+
+This gem will not send any parameters mentioned in Rails.application.config.filter\_parameters. We recommend extending this line in application.rb
 
     config.filter_parameters += [:password]
 
@@ -123,7 +125,7 @@ The RulesIO::Users middleware uses the same token as RulesIO::Rack.
 Here's an example of how to skip sending any user events for all requests to the SillyController:
 
     middleware :users do
-      ignore_if lambda { |env| env['action_controller.instance'].is_a? SillyController }
+      ignore_if Proc.new { |env| env['action_controller.instance'].is_a? SillyController }
     end
 
 To make life easier in the case where you want a condition evaluated in the context of a Rails controller, you can do the same thing like this. (Only the users middleware supports ignore_if_controller.)
@@ -163,3 +165,8 @@ Compatibility
 -------------
 
 This gem can be used without Rails, but when used with Rails it depends on Rails 3 (we've tested with Rails 3.1 and 3.2). If you want to use girl_friday, you must use Ruby 1.9.2 or greater, JRuby, or Rubinius.
+
+More info
+---------
+
+See the [wiki](https://github.com/rulesio/rulesio/wiki).

data/Rakefile

@@ -1 +1,13 @@
+require "bundler"
 require "bundler/gem_tasks"
+Bundler::GemHelper.install_tasks
+Bundler.setup
+
+require "rake/testtask"
+Rake::TestTask.new(:test) do |test|
+  test.libs = %w(lib test)
+  test.pattern = "test/**/test_*.rb"
+  test.verbose = true
+end
+
+task :default => :test

data/lib/rulesio/users.rb

@@ -7,9 +7,9 @@ module RulesIO
     def initialize(app, options={})
       @app, @options = app, options
       @options[:ignore_crawlers]      ||= RulesIO.default_ignored_crawlers
-      @options[:ignore_if]            ||= lambda { |env| false }
+      @options[:ignore_if]            ||= Proc.new { |env| false }
       @options[:ignore_if_controller] ||= 'false'
-      @options[:custom_data]          ||= lambda { |env| {} }
+      @options[:custom_data]          ||= Proc.new { |env| {} }
     end
 
     def call(env)
@@ -38,7 +38,13 @@ module RulesIO
 
     def conditionally_ignored_controller(condition, env)
       controller = env['action_controller.instance']
-      controller.instance_eval condition
+      if condition.is_a?(String)
+        controller.instance_eval(condition)
+      elsif condition.is_a?(Proc) && !condition.lambda?
+        controller.instance_eval(&condition)
+      else
+        false
+      end
     end
 
     def conditionally_ignored(ignore_proc, env)

data/lib/rulesio/version.rb

@@ -1,3 +1,3 @@
 module RulesIO
-  VERSION = '0.9.8'
+  VERSION = '0.9.10'
 end

data/lib/rulesio.rb

@@ -53,10 +53,18 @@ module RulesIO
   def self.current_actor(env)
     if controller = env['action_controller.instance']
       begin
-        data = controller.instance_eval(RulesIO.controller_data)
+        data = if RulesIO.controller_data.is_a?(String)
+          controller.instance_eval(RulesIO.controller_data)
+        elsif RulesIO.controller_data.is_a?(Proc) && !RulesIO.controller_data.lambda?
+          controller.instance_eval(&RulesIO.controller_data)
+        else
+          {}
+        end
         data = data.with_indifferent_access
         return data[:_actor] if data[:_actor]
-      rescue
+      rescue Exception => e
+        puts e.message
+        puts e.backtrace.join("\n")
       end
 
       begin
@@ -64,7 +72,9 @@ module RulesIO
         [:to_param, :id].each do |method|
           return user.send(method) if user && user.respond_to?(method)
         end
-      rescue
+      rescue Exception => e
+        puts e.message
+        puts e.backtrace.join("\n")
       end
     end
     nil
@@ -82,17 +92,24 @@ module RulesIO
   def self.prepare_event(event, env)
     event = event.with_indifferent_access
 
+    current_user = current_user(env)
+    actor = current_actor(env)
+
     if controller = env['action_controller.instance']
       begin
-        data = controller.instance_eval(RulesIO.controller_data).with_indifferent_access
-        event = data.merge(event)
-      rescue
+        data = if RulesIO.controller_data.is_a?(String)
+          controller.instance_eval(RulesIO.controller_data)
+        elsif RulesIO.controller_data.is_a?(Proc) && !RulesIO.controller_data.lambda?
+          controller.instance_eval(&RulesIO.controller_data)
+        else
+          {}
+        end
+        event = data.with_indifferent_access.merge(event)
+      rescue Exception => e
+        RulesIO.logger.warn "RulesIO having trouble with controller_data: #{e}"
       end
     end
 
-    current_user = current_user(env)
-    actor = current_actor(env)
-
     event[:_actor] = actor || 'anonymous' unless event[:_actor].present?
     event[:_timestamp] ||= Time.now.to_f
     event[:rails_env] = Rails.env if defined?(Rails)

data/rulesio.gemspec

@@ -18,5 +18,11 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency 'activesupport'
   s.add_runtime_dependency 'actionpack'
-  s.add_runtime_dependency 'girl_friday', '~> 0.10.0'
+  s.add_runtime_dependency 'girl_friday', '~> 0.11'
+
+  s.add_development_dependency "bundler", "~> 1"
+  s.add_development_dependency "test-unit", "~> 2.2"
+  s.add_development_dependency "mocha"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rails"
 end

data/test/helper.rb

@@ -0,0 +1,6 @@
+Bundler.require
+require "test/unit"
+require "active_support/all"
+require "mocha"
+
+require "rulesio"

data/test/test_configuration.rb

@@ -0,0 +1,143 @@
+require "helper"
+require "rulesio/railtie"
+require "rulesio/girl_friday_queue"
+
+MockController = Class.new
+
+class TestConfiguration < Test::Unit::TestCase
+  REDIS = Object.new
+
+  STRING_CONFIGURATION = <<-CONFIG
+  token 'FOOF'
+  queue RulesIO::GirlFridayQueue, :store => GirlFriday::Store::Redis, :store_config => { :pool => TestConfiguration::REDIS }
+  controller_data "{:_actor => self.current_user.try(:email) || 'anonymous'}"
+
+  middleware :users do
+    ignore_if_controller 'self.is_a?(MockController) && ["create", "recent"].include?(params[:action])'
+  end
+  CONFIG
+  
+  BLOCK_CONFIGURATION = <<-CONFIG
+  token 'FOOF'
+  queue RulesIO::GirlFridayQueue, :store => GirlFriday::Store::Redis, :store_config => { :pool => TestConfiguration::REDIS }
+  controller_data lambda { {:_actor => self.current_user.try(:email) || 'anonymous'} }
+
+  middleware :users do
+    ignore_if_controller lambda { self.is_a?(MockController) && ["create", "recent"].include?(params[:action]) }
+  end
+  CONFIG
+  
+  PROC_CONFIGURATION = <<-CONFIG
+  token 'FOOF'
+  queue RulesIO::GirlFridayQueue, :store => GirlFriday::Store::Redis, :store_config => { :pool => TestConfiguration::REDIS }
+  controller_data Proc.new { {:_actor => self.current_user.try(:email) || 'anonymous'} }
+
+  middleware :users do
+    ignore_if_controller Proc.new { self.is_a?(MockController) && ["create", "recent"].include?(params[:action]) }
+  end
+  CONFIG
+
+  setup do
+    Rails.expects(:logger)
+    Rails.expects(:application).returns(mock(:config => mock(:filter_parameters => [])))
+    @rc = RulesIO::RailsConfigurator.new
+  end
+  
+  test "general configuration works" do
+    user_middleware = @rc.instance_eval do
+      eval TestConfiguration::STRING_CONFIGURATION, binding, __FILE__, __LINE__
+      RulesIO::Rack.new(Object.new,
+        :webhook_url => @webhook_url,
+        :disable_sending_events => @disable,
+        :token => @token,
+        :queue => @queue,
+        :queue_options => @queue_options,
+        :controller_data => @controller_data
+      )
+      RulesIO::Users.new(Object.new, @middlewares[:users].configuration)
+    end
+    assert_not_nil @rc.middlewares
+    assert_equal 'FOOF', RulesIO.token
+    assert_equal RulesIO::GirlFridayQueue, RulesIO.queue
+    assert_equal 'self.is_a?(MockController) && ["create", "recent"].include?(params[:action])', user_middleware.instance_variable_get(:@options)[:ignore_if_controller]
+  end
+  
+  test "configuring blocks as strings works" do
+    user_middleware = @rc.instance_eval do
+      eval TestConfiguration::STRING_CONFIGURATION, binding, __FILE__, __LINE__
+      RulesIO::Rack.new(Object.new,
+        :webhook_url => @webhook_url,
+        :disable_sending_events => @disable,
+        :token => @token,
+        :queue => @queue,
+        :queue_options => @queue_options,
+        :controller_data => @controller_data
+      )
+      RulesIO::Users.new(Object.new, @middlewares[:users].configuration)
+    end
+    
+    assert @rc.middlewares[:users].configuration[:ignore_if_controller].is_a? String
+    assert_equal 'self.is_a?(MockController) && ["create", "recent"].include?(params[:action])', @rc.middlewares[:users].configuration[:ignore_if_controller]
+    assert @rc.instance_variable_get(:@controller_data).is_a? String
+    
+    stub_controller_instance = stub(:current_user => stub(:email => 'email@example.com'), :params => {:action => 'update'})
+    stub_controller_instance.expects(:is_a?).with(MockController).returns(true)
+    env = {'action_controller.instance' => stub_controller_instance}
+    assert_equal 'email@example.com', RulesIO.current_actor(env)
+    assert_equal false, user_middleware.send(:should_be_ignored, env)
+  end
+  
+  test "configuring blocks as lambdas DOES NOT work" do
+    user_middleware = @rc.instance_eval do
+      eval TestConfiguration::BLOCK_CONFIGURATION
+      RulesIO::Rack.new(Object.new,
+        :webhook_url => @webhook_url,
+        :disable_sending_events => @disable,
+        :token => @token,
+        :queue => @queue,
+        :queue_options => @queue_options,
+        :controller_data => @controller_data
+      )
+      RulesIO::Users.new(Object.new, @middlewares[:users].configuration)
+    end
+    
+    assert @rc.middlewares[:users].configuration[:ignore_if_controller].is_a? Proc
+    assert @rc.instance_variable_get(:@controller_data).is_a? Proc
+    assert @rc.middlewares[:users].configuration[:ignore_if_controller].lambda?
+    assert @rc.instance_variable_get(:@controller_data).lambda?
+    
+    stub_controller_instance = stub(:current_user => stub(:email => 'email@example.com'), :params => {:action => 'update'})
+    # is never called, because a lambda doesn't work right with instance_eval
+    stub_controller_instance.expects(:is_a?).never
+    env = {'action_controller.instance' => stub_controller_instance}
+    # returns nil, because lambda doesn't work right with instance_eval
+    assert_equal nil, RulesIO.current_actor(env)
+    assert_equal false, user_middleware.send(:should_be_ignored, env)
+  end
+  
+  test "configuring blocks as Procs works" do
+    user_middleware = @rc.instance_eval do
+      eval TestConfiguration::PROC_CONFIGURATION, binding, __FILE__, __LINE__
+      RulesIO::Rack.new(Object.new,
+        :webhook_url => @webhook_url,
+        :disable_sending_events => @disable,
+        :token => @token,
+        :queue => @queue,
+        :queue_options => @queue_options,
+        :controller_data => @controller_data
+      )
+      RulesIO::Users.new(Object.new, @middlewares[:users].configuration)
+    end
+    
+    assert @rc.middlewares[:users].configuration[:ignore_if_controller].is_a? Proc
+    assert @rc.instance_variable_get(:@controller_data).is_a? Proc
+    assert !@rc.middlewares[:users].configuration[:ignore_if_controller].lambda?
+    assert !@rc.instance_variable_get(:@controller_data).lambda?
+    
+    stub_controller_instance = stub(:current_user => stub(:email => 'email@example.com'), :params => {:action => 'update'})
+    stub_controller_instance.expects(:is_a?).with(MockController).returns(true)
+    env = {'action_controller.instance' => stub_controller_instance}
+    assert_equal 'email@example.com', RulesIO.current_actor(env)
+    assert_equal false, user_middleware.send(:should_be_ignored, env)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rulesio
 version: !ruby/object:Gem::Version
-  version: 0.9.8
+  version: 0.9.10
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-11 00:00:00.000000000 Z
+date: 2013-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -51,7 +51,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '0.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -59,7 +59,87 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Rack middleware for connecting Rack applications to rules.io, with extensions
   for Rails 3 applications.
 email:
@@ -83,6 +163,8 @@ files:
 - lib/rulesio/users.rb
 - lib/rulesio/version.rb
 - rulesio.gemspec
+- test/helper.rb
+- test/test_configuration.rb
 homepage: https://github.com/rulesio/rulesio
 licenses: []
 post_install_message: 
@@ -107,4 +189,6 @@ rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Rack middleware for connecting to rules.io
-test_files: []
+test_files:
+- test/helper.rb
+- test/test_configuration.rb