errlog 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bbd26baa17726137322c3d5df046b9cbcdffd189
+  data.tar.gz: d4cc1c6f7e80b69c68b35c3f2b616588ca6cbc52
+SHA512:
+  metadata.gz: 8ff796221f1b57d49247a1905a8ca00abb2e55119fe574a0fbeb38a771f331bf2c496de08c49557122fbcdfffe44c3b29a06a82141aeca5d6c04d585e30480e0
+  data.tar.gz: a74925cff35f45f5d496892413e64a2c28f83c04e91275e60b814d73a2c75c6b5270e2dd27aa55b5524ffca173dbfc9a41d982de05ce10c6ec19cbbe0fd478da

data/.gitignore

@@ -0,0 +1,20 @@
+.DS_Store
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea
+.rbx

data/.rspec

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

data/.rvmrc

@@ -0,0 +1,2 @@
+rvm use 2.0.0
+#rvm use 1.9.3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 sergeych
+
+MIT License
+
+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,35 @@
+# Errlog
+
+*ATTENTION!*
+
+This is a reporting tool tor errlog service, that is not yet open for public test.
+
+
+The rest is a template for not to type it later on. Please ignore.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'errlog'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install errlog
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/errlogr

@@ -0,0 +1,122 @@
+#!/usr/bin/env ruby
+require 'errlog'
+require 'yaml'
+require 'ostruct'
+require 'colorize'
+
+def usage
+  puts <<End
+
+Errlog reporting tool (visit http://errlog.com for details)
+
+Usage:
+
+  errlog [params] "text to report"
+
+Parameters
+
+  --warn, --trace
+    report as warning or trace, respectively (default is error)
+
+  -k <acc_key>
+    account key (should obtain it in http://logger.com)
+
+  -i <acc_id>
+    account id (should obtain it in http://logger.com)
+
+  -p platform
+    set the platform value
+
+  -a appname
+    set the application name
+
+Some/all of there parameters might be set in the .errlog.yml file in the current path
+or down the tree. Command-line parameters override these from configuration file.
+
+Note that configuration file will not be used if both id and key are set in the command line
+arguments!
+
+exit status: 100 - error in arguments, 10 - failed to send, 0 - successfully sent
+End
+  exit 100
+end
+
+def error text
+  STDOUT.puts "\n*** Error: #{text}".red
+  usage
+end
+
+usage if ARGV.length == 0
+
+key, id, text, host, app, platform = nil, nil, '', nil, nil, nil
+severity = 100
+
+begin
+  n = 0
+  while n < ARGV.length do
+    arg = ARGV[n]
+    n += 1
+    case arg
+      when '-k'
+        key = ARGV[n]
+        n += 1
+      when '-i'
+        id = ARGV[n]
+        n += 1
+      when /^--local/
+        host = "http://localhost:3000"
+      when /^--warn/
+        severity = Errlog::WARNING
+      when /^--trace/
+        severity = Errlog::TRACE
+      when '-a'
+        app = ARGV[n]
+        n += 1
+      when '-p'
+        platform = ARGV[n]
+        n += 1
+      else
+        text = arg.strip
+        break
+    end
+  end
+rescue
+  error "Error parsing arguments"
+end
+
+def search_down_the_tree(path, name)
+  n = File.join path, name
+  return n if File.exists?(n)
+  root = File::split(path)[0]
+  return nil if root == path
+  search_down_the_tree root, name
+end
+
+if !key || !id
+  unless (cfile = search_down_the_tree(Dir::pwd, '.errlog.yml'))
+    error "Neither id/key or configuration file was found"
+    usage
+  end
+  cfg = OpenStruct.new YAML::load_file(cfile)
+  id ||= cfg.account_id
+  key ||= cfg.account_key
+  app ||= cfg.application
+  platform ||= cfg.platform
+end
+
+if !key || !id || text==''
+  error "You must specify at least id, key and text"
+  usage
+end
+
+usage if !key || !id || text.length == 0
+
+Errlog.configure id, key, {host: host}
+Errlog.context.platform = platform
+Errlog.context.application = app
+
+Errlog.report text, severity do |error|
+  STDERR.puts "Error: #{error}".red if error
+  exit error ? 10 : 0
+end
+Errlog.wait

data/errlog.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'errlog/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "errlog"
+  gem.version       = Errlog::VERSION
+  gem.authors       = ["sergeych"]
+  gem.email         = ["real.sergeych@gmail.com"]
+  gem.description   = %q{Logger and error reporter agent for errlog service}
+  gem.summary       = %q{under development}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.bindir        = 'bin'
+
+  gem.required_ruby_version = '>= 1.9.2'
+
+  gem.add_dependency 'boss-protocol', '>= 0.1.3'
+  gem.add_dependency 'hashie', '>= 1.2.0'
+  gem.add_dependency 'httpclient', '>= 2.3'
+  gem.add_dependency 'colorize'
+  gem.add_development_dependency "rspec"
+end

data/lib/errlog.rb

@@ -0,0 +1,120 @@
+require 'errlog/version'
+require 'errlog/packager'
+require 'errlog/constants'
+require 'errlog/chain_loggger'
+require 'boss-protocol'
+require 'errlog/context'
+require 'hashie'
+require 'thread'
+require 'httpclient'
+require 'weakref'
+
+module Errlog
+
+  include Errlog::Constants
+
+  def self.severity_name code
+    case code
+      when TRACE...WARNING;
+        'trace'
+      when WARNING...ERROR;
+        'warning'
+      else
+        ; 'error'
+    end
+  end
+
+  def self.packager id, key
+    return Packager.new id, key
+  end
+
+  def self.configure id, key, opts={}
+    @@app_id, @@app_secret, @options = id, key, opts
+    @@app_name                       = opts[:app_name]
+    @@packager                       = packager @@app_id, @@app_secret
+    @@host                           = opts[:host] || "http://errlog.com"
+    @@client                         = HTTPClient.new
+    begin
+      Rails.env
+      @@rails = true
+    rescue
+      @@rails = false
+    end
+  end
+
+  def self.app_name
+    @@app_name #rescue nil
+  end
+
+  def self.configured?
+    @@app_id && @@app_secret
+  end
+
+  def self.default_platform
+    @@rails ? 'rails' : 'ruby'
+  end
+
+  def self.rails?
+    @@rails
+  end
+
+  def self.pack data
+    @@packager.pack(data)
+  end
+
+  def self.create_logger with_logger=nil
+    self.context.create_logger with_logger
+  end
+
+  def self.protect component_name=nil, options={}, &block
+     context.protect component_name, options, &block
+  end
+
+  def self.protect_rethrow component_name=nil, &block
+    context.protect_rethrow component_name, &block
+  end
+
+  def self.report_exception e, &block
+    self.context.report_exception e, &block
+  end
+
+  def self.report text, severity = Errlog::ERROR, &block
+    self.context.report text, severity, &block
+  end
+
+  def self.clear_context
+    ctx                              = Errlog::Context.new
+    Thread.current[:errlog_context] = ctx
+    ctx
+  end
+
+  def self.context
+    Thread.current[:errlog_context] || clear_context
+  end
+
+  private
+
+  def self.post src
+    data = pack(src)
+    @@send_threads ||= []
+
+    t = Thread.start {
+      #puts "sending to #{@@host}"
+      error = nil
+      begin
+        res = @@client.post "#{@@host}/reports/log", app_id: @@app_id, data: Base64::encode64(data)
+        error = "report refused: #{res.status}" if res.status != 200
+      rescue Exception => e
+        error = e
+      end
+      yield error if block_given?
+    }
+    @@send_threads << WeakRef.new(t)
+  end
+
+  def self.wait
+    @@send_threads.each { |t| t.weakref_alive? and t.join }
+    @@send_threads == []
+  end
+
+end

data/lib/errlog/chain_loggger.rb

@@ -0,0 +1,31 @@
+require 'logger'
+
+module Errlog
+
+  class ChainLogger < Logger
+
+    attr_reader :buffer, :prev_logger
+
+    def initialize prev
+      @buffer      = []
+      @prev_logger = prev
+      super(nil)
+    end
+
+    def level= l
+      @prev_logger.level = l
+    end
+
+    def level
+      @prev_logger.level
+    end
+
+    def add severity, message = nil, progname = nil
+      message = yield if block_given?
+      @prev_logger and @prev_logger.add(severity, message, progname)
+      @buffer << [severity, Time.now, message, progname]
+    end
+
+  end
+end
+

data/lib/errlog/constants.rb

@@ -0,0 +1,21 @@
+module Errlog
+  module Constants
+
+    ERROR     = 100
+    WARNING   = 50
+    NOT_FOUND = 50
+    TRACE     = 1
+
+    def is_error?(code)
+      code >= ERROR
+    end
+
+    def is_warning? code
+      code >= WARNING && code < ERROR
+    end
+
+    def is_trace? code
+      code >= TRACE && code < WARNING
+    end
+  end
+end

data/lib/errlog/context.rb

@@ -0,0 +1,44 @@
+require 'hashie'
+
+module Errlog
+  class Context < Hashie::Mash
+
+    def protect component_name=nil, options={}
+      component_name and self.component_name = component_name
+      begin
+        yield self
+      rescue Exception => e
+        report_exception e
+        options[:retrhow] and raise
+      end
+    end
+
+    def protect_rethrow component_name=nil, &block
+      self.protect component_name, retrhow: true, &block
+    end
+
+    def report_exception e, &block
+      self.stack = e.backtrace
+      report "#{e.class.name}: #{e.to_s}", Errlog::ERROR
+    end
+
+    def report text, severity = Errlog::ERROR, &block
+      raise 'Errlog is not configured. Use Errlog.config' unless Errlog.configured?
+      !self.app_name and self.app_name = Errlog.app_name
+      self.time     = Time.now
+      self.severity = severity
+      self.platform ||= Errlog.default_platform
+      self.stack    ||= caller
+      self.text = text
+      @loggers and self.log = @loggers.reduce([]){ |all,x| all + x.buffer }.sort { |x,y| x[1] <=> y[1] }
+      Errlog.rails? and self.rails_root = Rails.root.to_s
+      Errlog.post(self.to_hash, &block)
+    end
+
+    def create_logger with_logger=nil
+      l = Errlog::ChainLogger.new(with_logger)
+      (@loggers ||= []) << l
+      l
+    end
+  end
+end

data/lib/errlog/packager.rb

@@ -0,0 +1,49 @@
+require 'base64'
+require 'openssl'
+require 'digest/md5'
+require 'boss-protocol'
+
+module Errlog
+
+  class Packager
+
+    # class InvalidPackage < Exception; end
+
+    def initialize app_id, app_key
+      @appid = app_id
+      @key = app_key.length == 16 ? app_key : Base64.decode64(app_key)
+    end
+
+    def encrypt data
+      cipher = OpenSSL::Cipher.new('AES-128-CBC')
+      cipher.encrypt
+      iv = cipher.random_iv
+      cipher.key = @key
+      iv + cipher.update(data) + cipher.update(Digest::MD5.digest(data)) + cipher.final
+    end
+
+    def decrypt ciphertext
+      cipher = OpenSSL::Cipher.new('AES-128-CBC')
+      cipher.decrypt
+      cipher.iv = ciphertext[0..15]
+      cipher.key = @key
+      data = cipher.update(ciphertext[16..-1]) + cipher.final
+      data, digest = data[0...-16], data[-16..-1]
+      digest == Digest::MD5.digest(data) ? data : nil
+    end
+
+    def pack payload
+      "\x00#{encrypt(Boss.dump @appid, payload)}"
+    end
+
+    def unpack block
+      block[0].to_i == 0 or return nil
+      id, payload = Boss.load_all(decrypt(block[1..-1]))
+      id == @appid ? payload : nil
+    rescue
+      nil
+    end
+
+  end
+
+end

data/lib/errlog/version.rb

@@ -0,0 +1,3 @@
+module Errlog
+  VERSION = "0.1.1"
+end

data/spec/errlog_spec.rb

@@ -0,0 +1,89 @@
+# logger_spec.rb
+
+require 'spec_helper.rb'
+require 'hashie'
+require 'errlog'
+require 'stringio'
+
+describe Errlog do
+
+  before :each do
+    Errlog.configure 'TheTestId', '1234567890123456'
+    @packager = Errlog.packager 'TheTestId', '1234567890123456'
+  end
+
+  it 'should have context' do
+    Errlog.context.value = 'test'
+    Errlog.context.value.should == 'test'
+    Errlog.clear_context
+    Errlog.context.value.should == nil
+  end
+
+  # This spec checks the whole chain - protect, report_exception, report, but does not check post
+  it 'should provide protection' do
+    Errlog.should_receive(:post).exactly(3).times do |payload|
+      payload = Hashie::Mash.new payload
+      payload.should_not be_nil
+      payload.stack[0].should =~ /errlog_spec/
+      payload.text.should == 'RuntimeError: TestError'
+      payload.time.should be_within(5000).of(Time.now)
+      payload.component_name.should == 'test'
+      payload.test.should == '123'
+    end
+
+    Errlog.protect 'test' do |ctx|
+      Errlog.clear_context
+      ctx.test = '123'
+      raise 'TestError'
+    end
+
+    -> {
+      Errlog.protect_rethrow 'test' do |ctx|
+        ctx.test = '123'
+        raise 'TestError'
+      end
+    }.should raise_error
+
+    Errlog.context.test = '123'
+    Errlog.report 'RuntimeError: TestError'
+  end
+
+  it 'should provide logs' do
+    Errlog.should_receive(:post).exactly(1).times do |payload|
+      payload = Hashie::Mash.new payload
+      payload.text.should == 'LogTest'
+      payload.log.length.should == 2
+      payload.log[0][3].should == 'test info'
+      payload.log[1][3].should == 'test warning'
+    end
+    sio = StringIO.new
+    l1 = Errlog.create_logger
+    l2 = Errlog.create_logger Logger.new(sio)
+    l1.info 'test info'
+    l2.warn 'test warning'
+    Errlog.report 'LogTest', Errlog::TRACE
+    sio.string.should match( /W, \[.*\]  WARN -- : test warning/)
+  end
+
+  it 'should provide constants' do
+    extend Errlog::Constants
+
+    is_error?(Errlog::ERROR).should be_true
+    is_error?(Errlog::WARNING).should_not be_true
+    is_error?(Errlog::TRACE).should_not be_true
+
+
+    is_warning?(Errlog::ERROR).should_not be_true
+    is_warning?(Errlog::WARNING).should be_true
+    is_warning?(Errlog::TRACE).should_not be_true
+    
+    is_trace?(Errlog::ERROR).should_not be_true
+    is_trace?(Errlog::WARNING).should_not be_true
+    is_trace?(Errlog::TRACE).should be_true
+
+    Errlog.severity_name(Errlog::ERROR).should == 'error'
+    Errlog.severity_name(Errlog::WARNING).should == 'warning'
+    Errlog.severity_name(Errlog::TRACE).should == 'trace'
+  end
+
+end

data/spec/packager_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+require 'errlog'
+
+describe 'Packager' do
+
+  before do
+    @packager = Errlog.packager 'TheTestId', '1234567890123456'
+  end
+
+  it 'should properly cipher' do
+    data  = 'The test data to encrypt/decrypt, just a test but long enough'
+    cdata = @packager.encrypt data
+    @packager.decrypt(cdata).should == data
+  end
+
+  it 'should accept base64-encoded keys too' do
+    p2    = Errlog.packager 'TheOtherId', Base64.encode64('1234567890123456')
+    data  = 'The test data to encrypt/decrypt, just a test but long enough, and for another purpose'
+    cdata = @packager.encrypt data
+    p2.decrypt(cdata).should == data
+  end
+
+  it 'should create and parse the package' do
+    payload = { 'type' => 'log', 'payload' => 'The test payload' }
+    data    = @packager.pack payload
+    @packager.unpack(data).should == payload
+  end
+
+  it 'should check that package is valid (signed)' do
+    payload = { 'type' => 'log', 'payload' => 'The test payload' }
+    data    = @packager.pack payload
+    p2 = Errlog.packager 'TheOtherId', Base64.encode64('123456789012345678901234')
+    p2.unpack(data).should == nil
+  end
+
+  it 'should provide settings-driven packer' do
+    Errlog.configure 'TheTestId', '1234567890123456'
+    payload = { 'type' => 'log', 'payload' => 'The test payload again' }
+    @packager.unpack(Errlog.pack(payload)).should == payload
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: errlog
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- sergeych
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: boss-protocol
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  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: 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'
+description: Logger and error reporter agent for errlog service
+email:
+- real.sergeych@gmail.com
+executables:
+- errlogr
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/errlogr
+- errlog.gemspec
+- lib/errlog.rb
+- lib/errlog/chain_loggger.rb
+- lib/errlog/constants.rb
+- lib/errlog/context.rb
+- lib/errlog/packager.rb
+- lib/errlog/version.rb
+- spec/errlog_spec.rb
+- spec/packager_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: under development
+test_files:
+- spec/errlog_spec.rb
+- spec/packager_spec.rb
+- spec/spec_helper.rb