effective_logging 1.0.0

data/lib/effective_logging/engine.rb

@@ -0,0 +1,50 @@
+module EffectiveLogging
+  class Engine < ::Rails::Engine
+    engine_name 'effective_logging'
+
+    # Set up our default configuration options.
+    initializer "effective_logging.defaults", :before => :load_config_initializers do |app|
+      eval File.read("#{config.root}/lib/generators/templates/effective_logging.rb")
+    end
+
+    # ActiveAdmin (optional)
+    # This prepends the load path so someone can override the assets.rb if they want.
+    initializer 'effective_logging.active_admin' do
+      if defined?(ActiveAdmin) && EffectiveLogging.use_active_admin == true
+        ActiveAdmin.application.load_paths.unshift Dir["#{config.root}/active_admin"]
+      end
+    end
+
+    # Automatically Log Emails
+    initializer 'effective_logging.emails' do |app|
+      if EffectiveLogging.emails_enabled == true
+        require 'effective_logging/email_logger'
+        ActionMailer::Base.register_observer(EffectiveLogging::EmailLogger)
+      end
+    end
+
+    # Register the log_page_views concern so that it can be called in ActionController or elsewhere
+    initializer 'effective_logging.action_controller' do |app|
+      ActiveSupport.on_load :action_controller do
+        ActionController::Base.extend(EffectiveLogging::LogPageViews::ActionController)
+      end
+    end
+
+    # This has to be run after initialization or User hasn't been loaded yet
+    config.after_initialize do
+      if EffectiveLogging.user_logins_enabled == true
+        ActiveSupport.on_load :active_record do
+          if defined?(Devise)
+            User.instance_eval do
+              alias_method :original_after_database_authentication, :after_database_authentication
+              define_method(:after_database_authentication) { Effective::UserLogger.successful_login(self) ; original_after_database_authentication() }
+            end
+          else
+            raise ArgumentError.new("EffectiveLogging.user_logins_enabled only works with Devise and a user class defined as User")
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/effective_logging/log_page_views.rb

@@ -0,0 +1,68 @@
+module EffectiveLogging
+  module LogPageViews
+
+    module ActionController
+      def log_page_views(options = nil)
+        @log_page_view_options = options || {}
+
+        include EffectiveLogging::LogPageViews::InstanceMethods
+        extend EffectiveLogging::LogPageViews::ClassMethods
+
+        # Break up the options
+        logging_options = {} ; filter_options = {}
+        (@log_page_view_options || {}).each do |k, v|
+          [:details, :skip_namespace].include?(k) ? (logging_options[k] = v) : (filter_options[k] = v)
+        end
+
+        cattr_accessor :log_page_views_opts
+        self.log_page_views_opts = logging_options
+
+        # Set up the after_filter to do page logging
+        after_filter :effective_logging_log_page_view, filter_options
+      end
+
+      def skip_log_page_views(options = {})
+        Rails.logger.info("WARNING EffectiveLogging: skip_log_page_views called without first having called log_page_views. Please add 'log_page_views' to your ApplicationController or this controller before using skip_log_page_views") unless options[:quiet]
+      end
+    end
+
+    module ClassMethods
+      def skip_log_page_views(options = {})
+        before_filter :skip_log_page_view, options
+      end
+    end
+
+    module InstanceMethods
+      def effective_logging_log_page_view
+        return if @_effective_logging_skip_log_page_view == true
+        return if (self.class.log_page_views_opts[:skip_namespace] || []).include?(self.class.parent)
+
+        user = (current_user rescue nil)
+
+        if self.class.log_page_views_opts[:details] == false
+          EffectiveLogger.info("page view: #{request.request_method} #{request.path}", :user => user)
+        else
+          EffectiveLogger.info(
+            "page view: #{request.request_method} #{request.path}",
+            :user => user,
+            :params => request.params.reject { |k, v| (k == 'controller' || k == 'action') },
+            :format => (request.format.to_s == 'text/html' ? nil : request.format.to_s),
+            :referrer => request.referrer,
+            :user_agent => request.user_agent
+          )
+        end
+      end
+
+      def skip_log_page_view
+        @_effective_logging_skip_log_page_view = true
+      end
+
+      def skip_log_page_views
+        @_effective_logging_skip_log_page_view = true
+      end
+
+    end
+
+  end
+end
+

data/lib/effective_logging/version.rb

@@ -0,0 +1,3 @@
+module EffectiveLogging
+  VERSION = '1.0.0'.freeze
+end

data/lib/generators/effective_logging/install_generator.rb

@@ -0,0 +1,33 @@
+module EffectiveLogging
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      desc "Creates an EffectiveLogging initializer in your application."
+
+      source_root File.expand_path("../../templates", __FILE__)
+
+      def self.next_migration_number(dirname)
+        if not ActiveRecord::Base.timestamped_migrations
+          Time.new.utc.strftime("%Y%m%d%H%M%S")
+        else
+          "%.3d" % (current_migration_number(dirname) + 1)
+        end
+      end
+
+      def copy_initializer
+        template "effective_logging.rb", "config/initializers/effective_logging.rb"
+      end
+
+      def create_migration_file
+        @logs_table_name = ':' + EffectiveLogging.logs_table_name.to_s
+
+        migration_template '../../../db/migrate/01_create_effective_logging.rb.erb', 'db/migrate/create_effective_logging.rb'
+      end
+
+      def show_readme
+        readme "README" if behavior == :invoke
+      end
+    end
+  end
+end

data/lib/generators/templates/README

@@ -0,0 +1 @@
+Thanks for using EffectiveLogging

data/lib/generators/templates/effective_logging.rb

@@ -0,0 +1,46 @@
+EffectiveLogging.setup do |config|
+  # Configure Database Tables
+  config.logs_table_name = :logs
+
+  # Authorization Method
+  #
+  # This method is called by all controller actions with the appropriate action and resource
+  # If the method returns false, an Effective::AccessDenied Error will be raised (see README.md for complete info)
+  #
+  # Use via Proc (and with CanCan):
+  # config.authorization_method = Proc.new { |controller, action, resource| can?(action, resource) }
+  #
+  # Use via custom method:
+  # config.authorization_method = :my_authorization_method
+  #
+  # And then in your application_controller.rb:
+  #
+  # def my_authorization_method(action, resource)
+  #   current_user.is?(:admin)
+  # end
+  #
+  # Or disable the check completely:
+  # config.authorization_method = false
+  config.authorization_method = Proc.new { |controller, action, resource| true }  # All users can see every screen
+
+  # Register Effective::Logs with ActiveAdmin if ActiveAdmin is present
+  config.use_active_admin = true
+
+  # Admin Screens Layout Settings
+  config.layout = 'application'   # All EffectiveLogging controllers will use this layout
+
+  # All statuses defined here, as well as 'info', 'success', and 'error' (hardcoded) will be created as
+  # EffectiveLogger.info('my message') macros
+  config.additional_statuses = []
+
+  #########################################
+  #### Automatic Logging Functionality ####
+  #########################################
+
+  # Log all emails sent
+  config.emails_enabled = true
+
+  # Log all successful user login attempts
+  config.user_logins_enabled = true
+
+end

data/spec/effective_logging_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe EffectiveLogging do
+  it 'should be a module' do
+    assert_kind_of Module, EffectiveLogging
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,33 @@
+ENV["RAILS_ENV"] ||= 'test'
+
+require File.expand_path("../dummy/config/environment", __FILE__)
+
+require 'rspec/rails'
+require 'rspec/autorun'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[Rails.root.join("spec/support/**/*.rb")].each {|f| require f }
+
+RSpec.configure do |config|
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  Rails.logger.level = 4    # Output only minimal stuff to test.log
+
+  config.use_transactional_fixtures = true   # Make this false to once again use DatabaseCleaner
+  config.infer_base_class_for_anonymous_controllers = false
+  config.order = 'random'
+end
+
+class ActiveRecord::Base
+  mattr_accessor :shared_connection
+  @@shared_connection = nil
+
+  def self.connection
+    @@shared_connection || retrieve_connection
+  end
+end
+
+# Forces all threads to share the same connection. This works on
+# Capybara because it starts the web server in a thread.
+ActiveRecord::Base.shared_connection = ActiveRecord::Base.connection

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: effective_logging
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Code and Effect
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: coffee-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: devise
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: migrant
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Automatically log all sent emails, user logins, and page views. This
+  also will log custom events from Ruby and JavaScript.
+email:
+- info@codeandeffect.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/effective_logging.js
+- app/assets/javascripts/effective_logging/effective_logger.js.coffee.erb
+- app/controllers/admin/logs_controller.rb
+- app/controllers/effective/logs_controller.rb
+- app/helpers/effective_logging_helper.rb
+- app/models/effective/access_denied.rb
+- app/models/effective/datatables/logs.rb
+- app/models/effective/log.rb
+- app/models/effective/user_logger.rb
+- app/models/effective_logger.rb
+- app/views/active_admin/effective_logging/logs/index.html.haml
+- app/views/active_admin/effective_logging/logs/show.html.haml
+- app/views/admin/logs/index.html.haml
+- app/views/admin/logs/show.html.haml
+- app/views/effective/logs/_log.html.haml
+- app/views/effective/logs/index.html.haml
+- app/views/effective/logs/show.html.haml
+- config/routes.rb
+- db/migrate/01_create_effective_logging.rb.erb
+- lib/effective_logging.rb
+- lib/effective_logging/email_logger.rb
+- lib/effective_logging/engine.rb
+- lib/effective_logging/log_page_views.rb
+- lib/effective_logging/version.rb
+- lib/generators/effective_logging/install_generator.rb
+- lib/generators/templates/README
+- lib/generators/templates/effective_logging.rb
+- spec/effective_logging_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/code-and-effect/effective_logging
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Automatically log all sent emails, user logins, and page views. This also
+  will log custom events from Ruby and JavaScript.
+test_files:
+- spec/effective_logging_spec.rb
+- spec/spec_helper.rb