rf_logger 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c1e586db46317c23c8457b60a8825bb8047b2e5
-  data.tar.gz: 8f88a4b572038809f6db57189c8f37d00107d6ff
+  metadata.gz: 1d037fd349b2f9bae338bd453fe34222c6461496
+  data.tar.gz: 2fc84efd2d6ceb4b46b7b9bf11ddb85e56fb082a
 SHA512:
-  metadata.gz: 8abd4fa0827da81cc264ddcfcd717b06c894e95ddb403e9989c93e88f519e7b458a6691d465426848086884f02f5c542ea1f5c2db8a9d357012980cf4027a43f
-  data.tar.gz: ce8e7a3778a79b2a4948fed6ad1169a0a46a2218feefad405f150c3080760cecc66d37b331283f513175b245fe3c5bf1c6bfde81c6bbdcbe7884d025c7d8986a
+  metadata.gz: 28ff40a004c18a7b311d1cc5c99b62bd2f7b9df7ce6a6120137e33d7d298a6d40c45ce5b92a028c30c03009102e3533a627b4c6fa368ad2e147f80b8c55f6250
+  data.tar.gz: f6caa2b848a73042f72d19423c20cc835aaccb1b9c0f3d07e187cc82514e520270ed51293c6e1434d46d97acdd15287b0c398bd835935f1071d372e81f5a7a00

data/README.md

@@ -0,0 +1,65 @@
+RF Logger provides a consistent API to log events of different severity levels.  Severities include:
+```
+    :debug # dev-only, for exploring issues
+    :info  # end users, to audit process
+    :warn  # weird thing happened, but isn't really an issue
+    :error # someone fix the code
+    :fatal # system-wide errors
+```
+The API provides helper methods for each severity (i.e. `Logger.debug`).  In addition to logging severity levels, the following fields are optional:
+- actor (The user or caller of the event that you are logging)
+- action (The event you are logging)
+- target_type (We use this in cases where we want to tie a log record to a particular entity or object in the database, for example User)
+- target_id (This is used in conjunction with target_type, as the unique identifier for the relevant entity)
+- metadata (Additional information such as error details and backtraces or other messages, stored as a hash)
+
+This gem includes RfLogger::SimpleLogger and RfLogger::Sequel logger as two options that adhere to this API.  The fields above should be passed into helper methods as a hash.
+
+##Configuration##
+Configuration mostly sets up additional notifications beyond the actual logging.
+
+```ruby
+RfLogger.configure do |c|
+  # environment attempts to determine this for Rails, Sinatra, Padrino, and Rory, but is otherwise
+  c.environment = 'production'  required
+  # fields from above can be interpolated into the notification subject
+  c.notification_subject = "Oh no!  An error of {{level}} severity just occurred."
+  c.set_notifier_list do |n|
+    c.add_notifier Notification::DefinedElsewhere, :levels => [:error], :except => ['test', 'development']
+    c.add_notifier Notification::OhNo, :levels => [:fatal, :error], :only => ['production']
+    c.add_notifer Notifcation:VeryVerbose
+  end
+end
+```
+
+As you seen above, you can specify different notifications for different levels or environments whend you log an event.
+
+##Notification##
+While you have to implement notifiers yourself, the API is fairly simple.  The class must respond to .send_notification.  The argument passed in is an object that includes a #subject (which can be defined in the configuration (see above), and #details, which is the metadata in YAML format.  Future versions of this may allow for other transformations of the log data.
+
+Example:
+```ruby
+require 'tinder'
+module Notification
+  class Campfire
+    class << self
+      def send_error_notification log_info
+        message = log_info.subject + "\n" + log_info.details
+        post_message message
+      end
+
+      def post_message message
+        campfire = Tinder::Campfire.new(config['user'], :token => config['api_token'])
+        room = campfire.find_room_by_id(config['room_id'])
+        room.paste message
+      end
+
+      def config
+        @config ||= YAML.load_file(File.join(Rails.root, 'config/campfire.yml'))
+      end
+    end
+  end
+end
+```
+
+

data/lib/rf_logger/sequel_logger.rb

@@ -1,8 +1,14 @@
+require 'json'
 module RfLogger
   class SequelLogger < Sequel::Model
     class << self
+      def inherited(subclass)
+        subclass.set_dataset underscore(demodulize(subclass.name.pluralize)).to_sym
+        super
+      end
+
       RfLogger::LEVELS.each do |level|
-        define_method level.to_sym do |entry|
+          define_method level.to_sym do |entry|
           log = add level, entry
 
           notification_log = LogForNotification.new(entry.merge(:level => level))

data/lib/rf_logger/version.rb

@@ -1,3 +1,3 @@
 module RfLogger
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/rf_logger.rb

@@ -10,10 +10,6 @@ require 'rf_logger/notifications/error_notification_environment_constraints'
 require 'rf_logger/simple_logger'
 require 'rf_logger/log_for_notification'
 
-if defined?(Sequel)
-  require 'json'
-  require 'rf_logger/sequel_logger'
-end
 
 module RfLogger
   class UndefinedSetting < StandardError; end

data/rf_logger.gemspec

@@ -5,7 +5,7 @@ require 'rf_logger/version'
 
 Gem::Specification.new do |s|
   s.name        = 'rf_logger'
-  s.version     = '0.0.1'
+  s.version     = '0.0.2'
   s.date        = '2014-02-20'
   s.summary     = "A logger that adheres to Renewable Funding logging conventions"
   s.description = "A logger that allows specification of severity, applicable entity/records, metadata, and optional notifications"

data/spec/lib/rf_logger/sequel_logger_spec.rb

@@ -1,3 +1,7 @@
+require 'sequel'
+DB = Sequel.mock
+require File.expand_path( File.dirname( __FILE__ ) + '/../../../lib/rf_logger/sequel_logger' )
+
 describe RfLogger::SequelLogger do
   before :each do
     Time.stub(:now => 'NOW')

data/spec/spec_helper.rb

@@ -5,9 +5,6 @@ SimpleCov.start
 # in spec/support/ and its subdirectories.
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 
-require 'sequel'
-DB = Sequel.mock
-
 require './lib/rf_logger'
 
 RSpec.configure do |config|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rf_logger
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Dave Miller
@@ -121,6 +121,7 @@ files:
 - .gitignore
 - .rspec
 - Gemfile
+- README.md
 - Rakefile
 - lib/rf_logger.rb
 - lib/rf_logger/configuration.rb
@@ -171,4 +172,3 @@ test_files:
 - spec/lib/rf_logger/sequel_logger_spec.rb
 - spec/lib/rf_logger/simple_logger_spec.rb
 - spec/spec_helper.rb
-has_rdoc: