preact 0.8.0 → 0.8.1

data/lib/generators/preact_generator.rb

@@ -0,0 +1,25 @@
+class PreactGenerator < Rails::Generators::Base
+  desc "This generator creates a Preact initializer file at config/initializers"
+  argument :project_code, :type => :string
+  argument :api_secret, :type => :string
+
+  def create_initializer_file
+    create_file "config/initializers/preact.rb", <<-FILE
+# Preact Logging Configuration
+# see documentation about configuration options here: https://github.com/preact/preact-ruby
+Preact.configure do |config|
+  config.code   = "#{project_code}"
+  config.secret = "#{api_secret}"
+
+  # automatically log controller actions for authed users
+  # disable this if you want to only log manual events
+  config.autolog = true 
+
+  # disable in Rails non-production environments
+  # uncomment this if you don't want to log development activities
+  #config.disabled = !Rails.env.production?
+end
+FILE
+  end
+
+end

data/lib/preact.rb

@@ -31,14 +31,21 @@ module Preact
       yield(configuration) if block_given?
       
       # Configure logger.  Default to use Rails
-      self.logger ||= configuration.logger || (defined?(Rails) ? Rails.logger : Logger.new(STDOUT))
+      self.logger ||= configuration.logger || (defined?(::Rails) ? ::Rails.logger : Logger.new(STDOUT))
 
       raise StandardError.new "Must specify project code and secret when configuring the Preact api client" unless configuration.valid?
 
-      if defined? Rails
+      if defined? ::Rails
+        # load the rails extensions
+        require 'preact/rails'
+
         # never log things if we're in Rails test environment
-        configuration.disabled = true if Rails.env.test?
+        configuration.disabled = true if ::Rails.env.test?
+      elsif defined? ::Warden
+        # not using rails, so try to use warden
+        require 'preact/warden'
       end
+      
     end
 
     def log_event(user, event, account = nil)

data/lib/preact/configuration.rb

@@ -11,6 +11,8 @@ module Preact
     attr_accessor :disabled
     attr_accessor :person_builder
     attr_accessor :account_builder
+    attr_accessor :autolog
+    attr_accessor :autolog_ignored_actions
     
     # Logger settings
     attr_accessor :logger
@@ -24,7 +26,9 @@ module Preact
       @scheme = 'https'
       @host = 'api.preact.io'
       @base_path = '/api/v2'
-      
+
+      @autolog = false
+      @autolog_ignored_actions = []
       @disabled = false
       @person_builder = nil
       
@@ -50,6 +54,25 @@ module Preact
     def base_uri
       "#{scheme}://#{code}:#{secret}@#{host}#{base_path}"
     end
+
+    def autolog_enabled?
+      autolog == true
+    end
+
+    def autolog_should_log?(controller, action)
+      # check to see if we're ignoring this action
+      if autolog_ignored_actions && autolog_ignored_actions.is_a?(Array)
+
+        # check to see if we've ignored this specific action
+        return false if autolog_ignored_actions.include?("#{controller}##{action}")
+
+        # check to see if we've ignored all actions from this controller
+        return false if autolog_ignored_actions.include?("#{controller}#*")
+
+      end
+
+      true
+    end
     
     def convert_to_person(user)
       if person_builder

data/lib/preact/rails.rb

@@ -0,0 +1,5 @@
+require 'preact/rails/controllers/helpers'
+
+module Preact::Rails
+
+end

data/lib/preact/rails/controllers/helpers.rb

@@ -0,0 +1,66 @@
+module Preact
+  module Controllers
+    module Helpers
+      extend ActiveSupport::Concern
+
+      def preact_autolog_controller_action
+        # only track logged-in users
+        return true unless current_user
+        
+        controller = params[:controller]
+        action = params[:action]
+        target_id = params[:id]
+        note = nil
+
+        return true unless controller && action
+
+        return true unless Preact.configuration.autolog_should_log?(controller, action)
+
+        event_name = "#{controller}##{action}"
+
+        if response.status == 404
+          note = "NOT FOUND"
+        elsif response.status == 500
+          event_name = "!#{event_name}--error"
+        end
+
+        event = {
+          :name => event_name,
+          :target_id => target_id,
+          :medium => "autolog-rails-v1.0",
+          :note => note,
+          :extras => {
+            :_ip => request.remote_ip,
+            :_url => request.url,
+            :_ua => request.env['HTTP_USER_AGENT']
+          }
+        }
+
+        preact_log(event)
+
+        true
+      end
+
+      # helper method on the controller to make logging events easy
+      def preact_log(event, account=nil)
+        if account
+          Preact.log_event(current_user, event, account)
+        else
+          Preact.log_event(current_user, event)
+        end
+      end
+
+      # attach the after_filter to all controllers if we've enabled autologging
+      if Preact.configuration.autolog_enabled?
+        ActiveSupport.on_load(:action_controller) do
+          after_filter :preact_autolog_controller_action
+        end
+      end
+
+    end
+  end
+end
+
+class ActionController::Base
+  include Preact::Controllers::Helpers
+end

data/lib/preact/version.rb

@@ -1,3 +1,3 @@
 module Preact
-  VERSION = "0.8.0"
+  VERSION = "0.8.1"
 end

data/lib/preact/warden.rb

@@ -0,0 +1,5 @@
+require 'preact/warden/hooks'
+
+module Preact::Warden
+
+end

data/lib/preact/warden/hooks.rb

@@ -0,0 +1,7 @@
+# after-auth hook to log the login
+Warden::Manager.after_authentication do |user,auth,opts|
+  Preact.log_event(user, "login")
+end
+Warden::Manager.before_logout do |user,auth,opts|
+  Preact.log_event(user, "logout")
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: preact
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
   prerelease: 
 platform: ruby
 authors:
@@ -131,6 +131,7 @@ extensions: []
 extra_rdoc_files:
 - LICENSE.txt
 files:
+- lib/generators/preact_generator.rb
 - lib/preact/background_logger.rb
 - lib/preact/client.rb
 - lib/preact/configuration.rb
@@ -142,9 +143,13 @@ files:
 - lib/preact/objects/event.rb
 - lib/preact/objects/message.rb
 - lib/preact/objects/person.rb
+- lib/preact/rails/controllers/helpers.rb
+- lib/preact/rails.rb
 - lib/preact/sidekiq/preact_logging_worker.rb
 - lib/preact/sidekiq.rb
 - lib/preact/version.rb
+- lib/preact/warden/hooks.rb
+- lib/preact/warden.rb
 - lib/preact.rb
 - readme.md
 - LICENSE.txt