logplexer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7965fd70bfc4fc76a913352521bfd3235c67bcc7
+  data.tar.gz: 90844311c41a23989bea399cddff63e1dd483edd
+SHA512:
+  metadata.gz: cf87c80eb8c33bf3944e9f319cf6d35449055e3be42cf801ce05aa90a240b00ddf396aafa2a6562a25803ef6f7b08e43a0e4ec01c508d8c47e170eeed2514f37
+  data.tar.gz: af63443d65c27e9b9db5f89b7888f2df574efe1f5224cb835871f3a6d402a60bda4e76e11eb9b18a73fc0ef29807c04df37edba3fcc32647293af55151c7ee98

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in logplexer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Ryan Canty
+
+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,115 @@
+# Logplexer - Multiplex all the logs
+
+Logplexer allows you to multiplex where your logs go depending on the environment: either standard out, log file or Honeybadger. This can be configured at initialize-time or runtime.
+
+By default in a Rails app, it is set to log to standard out in `development` and `test` and log to Honeybadger in any other environment. As log as you have Honeybadger set up in your application this gem will work.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'logplexer', github: "Fullscreen/logplexer"
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Logplexer is a wrapper for `Honeybadger.notify` or Ruby's `Logger` class with all the methods for the typical `Logger` class.
+
+If you are in `development`, you can write:
+
+```ruby
+> Logplexer.info( Exception.new("Oh hai!") )
+I, [2015-06-20T15:25:02.182916 #23463]  INFO -- : Oh hai!
+=> nil
+```
+
+Or in `production`:
+
+```ruby
+> Logplexer.info( Exception.new("Oh hai!") )
+=> "684f15d9-c8f6-4ad8-885d-3ee50f612305"
+```
+
+Which will call `Honeybadger.notify()`
+
+Inputs can be any type, `Exception`, `String`, `Hash`, etc.
+
+If you are in development and would like to log to a logfile, just specify a logfile in the opts argument like so:
+
+```ruby
+> Logplexer.info( "Oh hai!", { logfile: '/Users/ryanc/Desktop/log.txt'} )
+ => true
+```
+
+```bash
+cat ~/Desktop/log.txt
+# Logfile created on 2015-06-20 15:49:16 -0700 by logger.rb/47272
+I, [2015-06-20T15:49:16.040351 #23538]  INFO -- : Oh hai!
+```
+
+If you would like to see the whole backtrace, just set `verbose` to true like so:
+
+```ruby
+def method1
+  begin
+    raise "Holy errors Batman"
+  rescue => e
+    Logplexer.error( e, { verbose: true} )
+  end
+end
+
+def method2
+  method1
+end
+
+def method3
+  method2
+end
+
+method3
+```
+
+```
+E, [2015-06-21T16:04:59.247900 #25737] ERROR -- : Holy errors Batman
+E, [2015-06-21T16:04:59.248003 #25737] ERROR -- : > /Users/ryanc/Workspace/test_logplexer/config/initializers/logplexer.rb:6:in `method1'
+E, [2015-06-21T16:04:59.248024 #25737] ERROR -- : > /Users/ryanc/Workspace/test_logplexer/config/initializers/logplexer.rb:13:in `method2'
+E, [2015-06-21T16:04:59.248041 #25737] ERROR -- : > /Users/ryanc/Workspace/test_logplexer/config/initializers/logplexer.rb:17:in `method3'
+```
+
+Or if you are in developmet and would like to have all instances of Logplexer be verbose, just set the environment variable `LOG_VERBOSE` to "true" like so:
+
+    ENV["LOG_VERBOSE"] = "true"
+
+and everything that isn't specifically marked as `verbose: false` will print the backtrace. Keep in mind that verbose only works when the input is an Exception type.
+
+## Configuration
+
+If your `RAILS_ENV` is set to `development` or `test`, Logplexer will set an environment variable called `LOG_TO_HB` as "false" if it is anything else, i.e. `production` or `staging`, `LOG_TO_HB` will be set to "true".
+
+Overriding this behavior is as easy as adding an initializer with the line:
+
+    ENV['LOG_TO_HB'] = "true"
+
+or
+
+    ENV['LOG_TO_HB'] = "false"
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/logplexer.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "logplexer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/logplexer/railtie.rb

@@ -0,0 +1,11 @@
+module Logplexer
+  class Railtie < Rails::Railtie
+    initializer "logplexer.configure_rails_initialization" do
+      if Rails.env == 'development' or Rails.env == 'test'
+        ENV['LOG_TO_HB'] = 'false'
+      else
+        ENV['LOG_TO_HB'] = 'true'
+      end
+    end
+  end
+end

data/lib/logplexer/version.rb

@@ -0,0 +1,3 @@
+module Logplexer
+  VERSION = "0.1.0"
+end

data/lib/logplexer.rb

@@ -0,0 +1,58 @@
+require "logplexer/version"
+require "honeybadger"
+require 'logplexer/railtie' if defined?(Rails)
+require 'logger'
+module Logplexer
+
+  extend self
+
+  # Dyamically create all the class log methods for Rails logger
+  %W(debug info warn error fatal).each do |log_type|
+    class_eval  <<-RUBY
+      def #{log_type}(exception, opts = {})
+        log( exception, "#{log_type}", opts )
+      end
+    RUBY
+  end
+
+  def log( exception, log_type, opts = {})
+    # We wrap the Honeybadger notify call so that in development,
+    # we actually see the errors. Then we can unwrap the REST errors
+    # if need be
+    return if exception.nil?
+
+    logfile = opts.delete( :logfile )
+    logger = Logger.new( logfile || STDOUT )
+
+    # Override the verbosity if LOG_VERBOSE is unset
+    verbose = ENV["LOG_VERBOSE"] == "true" ? true : opts.delete( :verbose )
+
+    if ENV['LOG_TO_HB'] == "true"
+      #TODO: Maybe extend this to include other kinds of notifiers.
+      if exception.is_a? String
+        exception = { error_class: "Exception",
+                      error_message: exception }
+      end
+      Honeybadger.notify( exception, opts )
+    else
+      # Make sure that the exception is an actual exception and
+      # not just a hash since Honeybadger accepts both
+      if exception.is_a? Exception
+        logger.send( log_type, exception.message )
+        if verbose
+          exception.backtrace.each do |entry|
+            logger.send( log_type, "> #{entry}" )
+          end
+        end
+
+      elsif exception.is_a? String
+        # Log just the string if thats what the user wants
+        logger.send( log_type, exception )
+
+      else
+        # Default kind of log for an object or whatevs
+        logger.send( log_type, exception.inspect )
+      end
+    end
+  end
+end

data/logplexer.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'logplexer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "logplexer"
+  spec.version       = Logplexer::VERSION
+  spec.authors       = ["Ryan Canty"]
+  spec.email         = ["jrcanty@gmail.com"]
+
+  spec.summary       = %q{ Multiplex all the logs }
+  spec.description   = %q{ Multiplexes logs to different places depending on environment }
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "vcr"
+
+  spec.add_runtime_dependency "honeybadger"
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: logplexer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ryan Canty
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: honeybadger
+  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: " Multiplexes logs to different places depending on environment "
+email:
+- jrcanty@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/logplexer.rb
+- lib/logplexer/railtie.rb
+- lib/logplexer/version.rb
+- logplexer.gemspec
+homepage: ''
+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: Multiplex all the logs
+test_files: []