errlog 0.3.4 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 17e96f6052645fe7624fcde6a74b51d026cd1411
-  data.tar.gz: bd1de2e4d3b099273b6431e1f960cd799c991a96
+  metadata.gz: 54e8865dba485273e01719ecce629f3eadeb2c45
+  data.tar.gz: 4a90e337de26a0fc931c96f1082e5b1481186d62
 SHA512:
-  metadata.gz: 50139bfaecb2c2efce08c9e2026c975b5dc5be3c191b5053f5d93db96d2ba8e4b8d2c8b779b73f1332c10062c00a6b549bb69274740157643993e2976b83a3a5
-  data.tar.gz: bbc4e3a5e7736f4df68572c4d3ff020fc263e4be04a38c6a315666c5c5eb34a7f613145178d3fd2ce19e9ab51c760d2b4ae32f668855cb3c8533738938a3f808
+  metadata.gz: bc317d9befb4e5afd34df91bba2e17fb965ac19b3291d24884f72bf0996646489bb41046926ae377dfa9178fc2153f2fdb62520b21c6eaf7c05bf825d9e9baae
+  data.tar.gz: e12f81821ae131d2987e9218d5577aacc5122459cba5d3e0397a811b2d55c2389cf26e75b6146e9ac18b06c43b2610b5484d9f51ff22fe38c6684dcbe6042190

data/README.md

@@ -58,6 +58,10 @@ details are available at http://errorlog.co/help/rails
 
 As the service is under active development, be sure to `bundle update errlog` regularly.
 
+## Clients for other platforms:
+
+ * iPhone IOS (objectiveC): https://github.com/sergeych/errlog-ios
+
 ## Contributing
 
 1. Fork it

data/lib/errlog.rb

@@ -15,27 +15,37 @@ if defined?(Rails)
   require 'errlog/rails_controller_extensions'
 end
 
+=begin
+  The reporting module for errlog service, see http://errorlog.com for details.
+
+  The usage is quite simple:
+
+  Errlog.configure(
+      account_id, account_secret,
+      :application => 'MyGreatApplication')
+
+  And use any of {Errlog.context} and {Errlog::Context} methods to report exceptions,
+  collect logs, traces and so on.
+
+  See http://errorlog.co/help for more.
+=end
+
 module Errlog
 
   include Errlog::Constants
+  extend Errlog::Constants
 
-  def self.severity_name code
-    case code
-      when TRACE...WARNING;
-        'trace'
-      when WARNING...ERROR;
-        'warning'
-      else
-        ; 'error'
-    end
-  end
-
+  # @return [Errlog::Packager] packager instance for configured credentials, see {Errorlog.configure}
   def self.packager id, key
     return Packager.new id, key
   end
 
   @@configured = false
 
+  # Configure your instance. Sbhould be called before any other methods. Follow http://errorlog.co/help/rails
+  # to get your credentials
+  #
+  # @param [string] id account id
   def self.configure id, key, opts={}
     @@configured                     = true
     @@app_id, @@app_secret, @options = id, key, opts
@@ -49,7 +59,9 @@ module Errlog
     @@component                      = nil
 
     if @@rails && !opts[:no_catch_logs]
-      @@logger                      = Rails.logger = ChainLogger.new Rails.logger
+      if Rails.env != 'test'
+        @@logger                      = Rails.logger = ChainLogger.new Rails.logger
+      end
       ActionController::Base.logger = ChainLogger.new ActionController::Base.logger
       if defined?(ActiveRecord)
         ActiveRecord::Base.logger = ChainLogger.new ActiveRecord::Base.logger
@@ -63,8 +75,15 @@ module Errlog
     end
   end
 
-  def self.logger
-    @@logger ||= ChainLogger.new
+  # Create logger that will report its content on {Errlog.error}, {Errlog.trace} and {Errlog.warning}
+  # and {ErrlogContext} reporting funtions. It can user existing logger to pass through, ot will create
+  # {Logger} with STDOUT
+  #
+  # @param logger existing logger to pass log to, If nil, STDOUT Logger will be created
+  # @return [ChainLogger] new instance.
+  def self.logger logger = nil
+    logger ||= Logger.new(STDOUT)
+    @@logger ||= ChainLogger.new logger
   end
 
   def self.use_logging?
@@ -91,6 +110,10 @@ module Errlog
     @@rails
   end
 
+  def self.rails_test?
+    @rails_test == nil and @rails_test = @@rails && Rails.env == 'test'
+  end
+
   def self.pack data
     @@packager.pack(data)
   end
@@ -137,7 +160,8 @@ module Errlog
 
   def self.post src
     if @@rails && Rails.env == 'test'
-      Rails.logger.info "Errlog: sending: #{src[:text]}"
+      Rails.logger.info "Errlog: #{severity_name(src[:severity])}: #{src['text']}"
+      stack=src['stack'] and Rails.logger.info "    #{stack.join("\n    ")}"
       return
     end
     data           = pack(src)

data/lib/errlog/chain_loggger.rb

@@ -24,13 +24,19 @@ module Errlog
 
     # @return current log level
     def level
-      @prev_logger and @prev_logger.level
+      @prev_logger ? @prev_logger.level : super
     end
 
     # Standard add log method, see (Logger#add)
     def add severity, message = nil, progname = nil
       message = yield if block_given?
-      @prev_logger and @prev_logger.add(severity, message, progname)
+      if Errlog.rails_test?
+        Rails.logger.add(severity, message, progname)
+      else
+        @prev_logger and @prev_logger.add(severity, message, progname)
+      end
+      # Rails.logger.info "- #{@prev_logger}: #{progname} ="
+      #puts message #if Errlog.rails_test?
       Errlog.context.add_log_record [severity, Time.now, message, progname]
     end
 

data/lib/errlog/constants.rb

@@ -10,6 +10,8 @@ module Errlog
     NOT_FOUND = 49
     TRACE     = 1
 
+    STAT_DATA = 1001
+
     # @!endgroup
 
     def is_error?(code)
@@ -23,5 +25,20 @@ module Errlog
     def is_trace? code
       code >= TRACE && code < WARNING
     end
+
+    # @return [String] name of the corresponding severity code
+    def severity_name code
+      case code
+        when NOT_FOUND;
+          'not found'
+        when TRACE...WARNING;
+          'trace'
+        when WARNING...ERROR;
+          'warning'
+        else
+          ; 'error'
+      end
+    end
+
   end
 end

data/lib/errlog/dj.rb

@@ -1,5 +1,9 @@
 
 begin
+  # Delayed_job integration automatically detects delayed_job presence
+  # and report all uncaught exceptions from your delayed jobs. It also
+  # takes care of properly clearing the context and collection per-job
+  # logs
   class Delayed::Worker
     def handle_failed_job_with_errlog(job, error)
       Errlog.context.component = 'DJ'

data/lib/errlog/packager.rb

@@ -1,45 +1,69 @@
 require 'base64'
 require 'openssl'
 require 'digest/md5'
+require 'digest/sha2'
 require 'boss-protocol'
+require 'stringio'
+require 'json'
 
 module Errlog
 
+  # Packager does (un)packing data to effectively and (where possible) safely
+  # transfer the report over the network. Normally you don't use it directly.
   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)
+      @key   = app_key.length == 16 ? app_key : Base64.decode64(app_key)
     end
 
+    # AES-128 encrypt the block
     def encrypt data
       cipher = OpenSSL::Cipher.new('AES-128-CBC')
       cipher.encrypt
-      iv = cipher.random_iv
+      iv         = cipher.random_iv
       cipher.key = @key
       iv + cipher.update(data) + cipher.update(Digest::MD5.digest(data)) + cipher.final
     end
 
+    # AES-128 decrypt the block
     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
+      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
 
+    # @return [binary] packed payload using the default block format
     def pack payload
       "\x00#{encrypt(Boss.dump @appid, payload)}"
     end
 
+    # @return [Hash] unpacked payload or nil if block format is unknown or block seems
+    # to be broken (e.g. wrong credentials used)
+    #
+    # @note packager can unpack v1 (boss, encrypted) and v2 (json, unencrypted) but it does
+    #       not pack to v2 as it is no secure and limited to US export laws castrated platforms
+    #       like iPhone and is not recommended to be used anywhere else.
     def unpack block
-      block[0].to_i == 0 or return nil
-      id, payload = Boss.load_all(decrypt(block[1..-1]))
-      id == @appid ? payload : nil
+      case block[0].ord
+        when 0
+          id, payload = Boss.load_all(decrypt(block[1..-1]))
+          id == @appid ? payload : nil
+        when 1
+          data = block[1...-32]
+          sign = block[-32..-1]
+          if sign != Digest::SHA256.digest(data + @key)
+            nil
+          else
+            JSON.parse Zlib::GzipReader.new(StringIO.new(data)).read
+          end
+        else
+          nil
+      end
     rescue
       nil
     end

data/lib/errlog/rails_controller_extensions.rb

@@ -2,10 +2,12 @@ module Errlog
   module ControllerFilter
 
     def self.included base
-      base.send :prepend_before_filter, :errlog_connect_context
-      base.send :rescue_from, Exception, :with => :errlog_report_exceptons
-      base.send :helper_method, :errlog_context
-      base.send :helper_method, :errlog_not_found
+      if Rails.env != 'test'
+        base.send :prepend_before_filter, :errlog_connect_context
+        base.send :rescue_from, Exception, :with => :errlog_report_exceptons
+        base.send :helper_method, :errlog_context
+        base.send :helper_method, :errlog_not_found
+      end
     end
 
 

data/lib/errlog/version.rb

@@ -1,3 +1,3 @@
 module Errlog
-  VERSION = "0.3.4"
+  VERSION = "0.3.6"
 end

data/spec/packager_spec.rb

@@ -38,4 +38,12 @@ describe 'Packager' do
     payload = { 'type' => 'log', 'payload' => 'The test payload again' }
     @packager.unpack(Errlog.pack(payload)).should == payload
   end
+
+  it 'should unpack v1 packages' do
+    # V1 format uses GZip stream, no encryption and sha256 signature
+    b64 = 'AR+LCAAAAAAAAAOrVvJIzcnJV7KKVirPL8pJMVTSgTCMlGJrAQuX/j4dAAAAz/urvrAsvKusrC9PvECtQERrhNoH+95xE7EzR1HoThU='
+    data = b64.unpack('m')[0]
+    @packager = Errlog.packager 'TheTestId', '6rA/5Ud1WEYoTz3h9umdXw=='.unpack('m')[0]
+    @packager.unpack(data).should == {'Hello' => ['world1', 'world2']}
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: errlog
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.6
 platform: ruby
 authors:
 - sergeych
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-15 00:00:00.000000000 Z
+date: 2013-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: boss-protocol