logmaster 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0373b64411b242583449c3964dec0af7ba046084
+  data.tar.gz: 495b5011311803dd68cecab49ccbe006386add72
+SHA512:
+  metadata.gz: e9b0c64385948186a75c0305202510e9d08a9464c976fa46f25ba23259f1db8155786f6b93753cd667891b5fdfc63043467c7074fd4691513a84dfdd595ab1eb
+  data.tar.gz: 58717ffcb9e8332fa0603de31bbacb2176098a800fe5db1da6dfac6a466289edb1ecaaed1fc82eb6175cf0085104ed698d058e721c1666833a9e964edf087896

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+
+gem "pony"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 2.0.1"
+  gem "github_api", "0.11.3"
+end
+
+group :test do
+  gem 'rspec'
+end

data/Gemfile.lock

@@ -0,0 +1,76 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.6)
+    builder (3.2.2)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.8)
+    github_api (0.11.3)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.1)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 1.2)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.0)
+      oauth2
+    hashie (3.3.1)
+    highline (1.6.21)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (1.0.0)
+    mail (2.6.1)
+      mime-types (>= 1.16, < 3)
+    mime-types (2.3)
+    mini_portile (0.6.0)
+    multi_json (1.10.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.3.1)
+      mini_portile (= 0.6.0)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    pony (1.11)
+      mail (>= 2.0)
+    rack (1.5.2)
+    rake (10.3.2)
+    rdoc (4.1.2)
+      json (~> 1.4)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.4)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.1)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.0)
+    thread_safe (0.3.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  github_api (= 0.11.3)
+  jeweler (~> 2.0.1)
+  pony
+  rspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Roman Snitko
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,48 @@
+Logmaster
+=========
+
+An enhanced logger library that handles different types of loggers
+(at the moment STDOUT and FILE) and sends emails if email config is provided.
+
+It can also watch and rescue exceptions logging them as FATAL.
+
+Here's a usage example listing all of the possible options:
+
+
+    logmaster = Logmaster.new(
+      log_level:       Logger::WARN,         # Default is Logger::INFO
+      file:            '/var/log/myapp.log', # if nil, will not log into any file
+      stdout:          true,       # if false, will not log into STDOUR
+      raise_exception: false,      # if true, will a raise an Exception after logging it
+      email_config:    nil,        # see email config options below
+      name:            "Logmaster" # currently useful for the email subjects,
+                                   # so you can see who's emailing you
+    )
+
+    logmaster.warn("This is a warning message") # logs into file and into the STDOUT
+    logmaster.info("This is an info message")   # doesn't log anything, log level isn't sufficient
+
+
+Sending email notifications
+---------------------------
+Logmaster can also send emails. It uses Pony (https://github.com/benprew/pony) to do that. Pony usually
+makes use of sendmail, but you can also specify SMTP options. See Pony docs to learn more. In our
+example I will use the sendmail (which is default):
+
+    logmaster = Logmaster.new( email_config: { to: 'me@email.foo', from: "logmaster@yourapp.com" })
+    logmaster.warn("Wow, this is another warning!")
+
+The second line will trigger sending an email to your address.
+
+
+Wathcing the code for Exceptions
+--------------------------------
+You can watch your code for exceptions and then also log them. After you created your logmaster
+instance, it's as simple as that:
+
+    logmaster.watch_exceptions do
+      1/0
+    end
+
+the exception will be rescued and logged as FATAL. If you also wish to actually raise it after it is
+logged, don't forget to set `Logmaster#raise_exception` to `true`.

data/Rakefile

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "logmaster"
+  gem.homepage = "http://github.com/snitko/logmaster"
+  gem.license = "MIT"
+  gem.summary = %Q{A wrapper around ruby stdlib Logger with emailing capabilities}
+  gem.description = %Q{A wrapper around ruby stdlib Logger with emailing capabilities}
+  gem.email = "roman.snitko@gmail.com"
+  gem.authors = ["Roman Snitko"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/email_templates/message.erb

@@ -0,0 +1,3 @@
+<p>Logger message type: <b><%= type %></b></p>
+<br/>
+<pre><%= message %></pre>

data/lib/logmaster.rb

@@ -0,0 +1,86 @@
+require 'logger'
+
+class Logmaster
+
+  attr_accessor :loggers, :log_level, :name, :email_config, :raise_exception
+
+  def initialize(
+    log_level:       Logger::INFO,
+    file:            nil,   # if nil, will not log into any file
+    stdout:          true,  # if false, will not log into STDOUR
+    raise_exception: false, # if true, will a raise an Exception after logging it
+    email_config:    nil,   # see email config options for Pony gem
+    name:            "Logmaster"
+  )
+
+    @name            = name
+    @raise_exception = raise_exception
+    @log_level       = log_level
+    @loggers         = []
+
+    self.email_config = email_config if email_config
+
+    @loggers << ::Logger.new(STDOUT)            if stdout
+    @loggers << ::Logger.new(file, 10, 1024000) if file
+    @loggers.each { |l| l.level = @log_level }
+
+  end
+
+  def email_config=(settings)
+
+    require 'pony'
+    require 'erb'
+
+    @email_config = { via: :sendmail, from: 'logmaster@localhost', subject: "#{@name} message" }
+    @email_config.merge!(settings)
+    if @email_config[:to].nil?
+      raise "Please specify email addresses of email recipients using :to key in email_config attr (value should be array)"
+    end
+
+  end
+
+  def watch_exceptions
+    raise "Please provide a block to this method" unless block_given?
+    begin
+      yield
+    rescue Exception => e
+      message =  e.class.to_s
+      message += ": "
+      message += e.message
+      message += "\n"
+      message += "Backtrace:\n"
+      e.backtrace.each { |l| message += "    #{l}\n" }
+      self.fatal(message)
+      raise e if @raise_exception
+    end
+  end
+
+  private
+
+    def method_missing(name, *args)
+
+      if [:unknown, :fatal, :error, :warn, :info, :debug].include?(name)
+        
+        if @email_config && @log_level <= Logger.const_get(name.to_s.upcase)
+          send_email(type: name, message: args[0]) 
+        end
+
+        args[0] = args[0] + "\n\n"
+        @loggers.each do |logger|
+          logger.send(name, *args)
+        end
+
+      end
+
+    end
+
+    def send_email(type:, message:)
+      template = ERB.new(File.read(File.expand_path(File.dirname(__FILE__)) +
+                         "/../email_templates/message.erb")
+                         ).result(binding)
+
+      Pony.mail(@email_config.merge({ html_body: template }))
+    end
+
+
+end

data/spec/logmaster_spec.rb

@@ -0,0 +1,59 @@
+require 'rspec'
+require 'logmaster'
+require 'fileutils'
+
+class Logger
+  # Suppress log messages when testing
+  def add(*args);end
+end
+
+describe Logmaster do
+
+  LOGFILE = File.expand_path(File.dirname(__FILE__) + '/logfile')
+
+  before(:each) do
+    @logmaster = Logmaster.new(file: LOGFILE)
+  end
+
+  after(:each) do
+    FileUtils.rm LOGFILE
+  end
+
+  it "creates two loggers (stdout and logfile)" do
+    expect(@logmaster.loggers[0]).to be_kind_of(Logger) 
+    expect(@logmaster.loggers[1]).to be_kind_of(Logger) 
+  end
+
+  it "sets email settings" do
+    @logmaster.email_config = { to: 'your-email@here.com' } 
+    expect(@logmaster.email_config).to eq({ via: :sendmail, from: 'logmaster@localhost', subject: "Logmaster message", to: 'your-email@here.com' })
+  end
+
+  it "sends log messages to each logger" do
+    @logmaster.loggers.each do |logger|
+      expect(logger).to receive(:warn).once
+    end
+    @logmaster.warn("WARNING bitches!")
+  end
+
+  it "sends emails when the log level of a log message is appropriate" do
+    @logmaster.email_config = { to: 'your-email@here.com' } 
+    @logmaster.log_level = Logger::WARN
+
+    expect(Pony).to receive(:mail)
+
+    @logmaster.warn("WARNING bitches!") # Should call Pony.mail
+    @logmaster.log_level = Logger::FATAL
+    @logmaster.warn("WARNING bitches!") # This time shouldn't, log_level is wrong
+  end
+
+  it "watches for exceptions" do
+    @logmaster.loggers.each do |logger|
+      expect(logger).to receive(:fatal).once
+    end
+    @logmaster.watch_exceptions do
+      1/0
+    end
+  end
+
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: logmaster
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Roman Snitko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pony
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: github_api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+description: A wrapper around ruby stdlib Logger with emailing capabilities
+email: roman.snitko@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- ".document"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- email_templates/message.erb
+- lib/logmaster.rb
+- spec/logmaster_spec.rb
+homepage: http://github.com/snitko/logmaster
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A wrapper around ruby stdlib Logger with emailing capabilities
+test_files: []