le 2.2.9 → 2.3.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 84d1ea5039bc8264fe26850b807253c23ac5a5f6
-  data.tar.gz: 768cc4836bdad93ca95270424949ab1b7ebe477a
+  metadata.gz: 197d934adfa495609d70c30c00d450a363a5fd8f
+  data.tar.gz: 14719f1f0549fa73898046babe65c80937f9b2e5
 SHA512:
-  metadata.gz: 9189e9168f16f77db1cc7883f5a52b5d6c62fcfef32fef403f74f62a652a0ee2a3ce2070c9bd9f0a595e87d697407d57cfaec22e4bb3ef51f66f3cca71d9de4e
-  data.tar.gz: 4876d219250d9e171d2b6dfc9fd61665c099cda60edb1cbe38f11b30388ffec9a93377563928a7e17850cf3fa0d4b23693dafc2089025a1c63f318f480d3ddd8
+  metadata.gz: 6c7d3c26d04a8cf0dd8e9181a307c63bfccebe1ed7e47fe6cf4831df2e0b590133ba37293794f431dbdc5d160368c68e54cedd8db85fd9105f1a6fcee22866fc
+  data.tar.gz: 0716d1ba6ab62a8a0a39dde7c31cc8b6bfabcaa2e463d6e152e07ca1c35df6d3ea12495d3d635fa0d6264e52e7c15aef273a40ab79b66bbb6edf20ced263d178

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LE.gemspec

@@ -1,20 +1,28 @@
-dir = File.dirname(__FILE__)
-require File.expand_path(File.join(dir, 'lib', 'le'))
-
-Gem::Specification.new do |s|
-  s.name	= "le"
-  s.version	= "2.2.9"
-  s.date	= Time.now
-  s.summary	= "Logentries plugin"
-  s.licenses    = ["MIT"]
-  s.description	=<<EOD
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'le'
 
+Gem::Specification.new do |gem|
+  gem.name	= "le"
+  gem.version	= "2.3.9"
+  gem.date	= Time.now
+  gem.summary	= "Logentries plugin"
+  gem.licenses = ["MIT"]
+  gem.description	=<<EOD
 
 EOD
 
-  s.authors	= ["Mark Lacomber"]
-  s.email	= "mark.lacomber@logentries.com"
-  s.homepage    = "https://github.com/logentries/le_ruby"
-  s.files	= %w{ LE.gemspec } + Dir["#{dir}/lib/**/*.rb"]
-  s.require_paths = ["lib"]
+  gem.authors	= ["Mark Lacomber"]
+  gem.email	= "mark.lacomber@logentries.com"
+  gem.homepage    = "https://github.com/logentries/le_ruby"
+  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.add_development_dependency "bundler"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency 'minitest'
+
 end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2014 Logentries
+
+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,75 @@
+Logging to Logentries in Ruby
+=============================
+
+This is a Logentries library for logging from Ruby platforms, including Heroku.
+
+It is available on github <https://github.com/logentries/le_ruby/> and rubygems
+<http://rubygems.org/>.
+
+
+Example
+-------
+
+    Rails.logger.info("information message")
+    Rails.logger.warn("warning message")
+    Rails.logger.debug("debug message")
+
+
+Howto
+-----
+
+You must first register your account details with Logentries.
+
+Once you have logged in to Logentries, create a new host with a name of your choice.
+Inside this host, create a new logfile, selecting `Token TCP` as the source type.
+
+Heroku
+------
+
+To install the gem you must edit the Gemfile in your local heroku environment
+
+Add the following line:
+
+    gem 'le'
+
+Then from the cmd line run the following command:
+
+    bundle install
+
+This will install the gem on your local environment.
+
+The next step is to configure the default rails logger to use the logentries
+logger.
+
+In your environment configuration file ( for production : `config/environments/production.rb`), add the following:
+
+    Rails.logger = Le.new('LOGENTRIES_TOKEN')
+
+If you want to keep logging locally in addition to sending logs to logentries, just add local parameter after the key.
+By default, this will write to the standard Rails log or to STDOUT if not using Rails:
+
+    Rails.logger = Le.new('LOGENTRIES_TOKEN', :local => true)
+
+You may specify the local log device by providing a filename (String) or IO object (typically STDOUT, STDERR, or an open file):
+
+    Rails.logger = Le.new('LOGENTRIES_TOKEN', :local => 'log/my_custom_log.log')
+
+If you want the gem to use SSL when streaming logs to Logentries, add the ssl parameter and set it to true:
+
+    Rails.logger = Le.new('LOGENTRIES_TOKEN', :ssl => true)
+
+If you want to print debug messages for the gem to a file called logentriesGem.log, add this:
+
+	Rails.logger = Le.new('LOGENTRIES_TOKEN', :debug => true)
+
+If you want to use ActiveSupport::TaggedLogging logging, add this:
+
+    Rails.logger = Le.new('LOGENTRIES_TOKEN', :tag => true)
+
+You can also specify the default level of the logger by adding a :
+
+    Rails.logger = Le.new('LOGENTRIES_TOKEN', :log_level => Logger::<level>)
+
+For the `LOGENTRIES_TOKEN` argument, paste the token for the logfile you created earlier in the Logentries UI.
+
+Now, simply use `Rails.logger.info("message")` inside your code to send logs to Logentries

data/Rakefile

@@ -0,0 +1,16 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs = ['lib','test']
+  t.test_files = Dir.glob("test/**/*_spec.rb").sort
+  t.verbose = true
+end
+
+task :default => [:test]
+task :spec => [:test]
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -I lib -r le.rb"
+end

data/lib/le/host/http.rb

@@ -41,6 +41,9 @@ wVYQgpYWRRZ7bJyfRCJxzIdYF3qy/P9NWyZSlDUuv11s1GSFO2pNd34p59GacVAL
 BJE6y5eOPTSbtkmBW/ukaVYdI5NLXNer3IaK3fetV3LvYGOaX8hR45FI1pvyKYvf
 S5ol3bQmY1mv78XKkOk=
 -----END CERTIFICATE-----'
+      SHUTDOWN_COMMAND = "DIE!DIE!"  # magic command string for async worker to shutdown
+      SHUTDOWN_MAX_WAIT = 10         # max seconds to wait for queue to clear on shutdown
+      SHUTDOWN_WAIT_STEP = 0.2       # sleep duration (seconds) while waiting to shutdown
 
 
       include Le::Host::InstanceMethods
@@ -48,14 +51,19 @@ S5ol3bQmY1mv78XKkOk=
 
       def initialize(token, local, debug, ssl)
         if local
-          if defined?(Rails)
-            @logger_console = Logger.new("log/#{Rails.env}.log")
+          device = if local.class <= TrueClass
+            if defined?(Rails)
+              Rails.root.join("log","#{Rails.env}.log")
+            else
+              STDOUT
+            end
           else
-            @logger_console = Logger.new(STDOUT)
+            local
           end
+          @logger_console = Logger.new(device)
         end
         @token = token
-        @local = local
+        @local = !!local
         @debug = debug
         @ssl = ssl
         @queue = Queue.new
@@ -67,6 +75,7 @@ S5ol3bQmY1mv78XKkOk=
         if @debug
           self.init_debug
         end
+        at_exit { shutdown! }
       end
 
       def init_debug
@@ -178,6 +187,7 @@ S5ol3bQmY1mv78XKkOk=
 
         loop do
           data = @queue.pop
+          break if data == SHUTDOWN_COMMAND
           loop do
             begin
               @conn.write(data)
@@ -204,6 +214,20 @@ S5ol3bQmY1mv78XKkOk=
           @random_message_id_sample_space ||= ('0'..'9').to_a.concat(('A'..'Z').to_a)
           (0..5).map{ @random_message_id_sample_space.sample }.join
         end
+
+        # at_exit handler.
+        # Attempts to clear the queue and terminate the async worker cleanly before process ends.
+        def shutdown!
+          return unless @started
+          dbg "LE: commencing shutdown, queue has #{queue.size} entries to clear"
+          queue << SHUTDOWN_COMMAND
+          SHUTDOWN_MAX_WAIT.div(SHUTDOWN_WAIT_STEP).times do
+            break if queue.empty?
+            sleep SHUTDOWN_WAIT_STEP
+          end
+          dbg "LE: shutdown complete, queue is #{queue.empty? ? '' : 'not '}empty with #{queue.size} entries"
+        end
+
     end
   end
 end

data/test/fixtures/log/.gitignore

@@ -0,0 +1 @@
+*.log

data/test/host_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Le::Host do
+
+  let(:token)   { '11111111-2222-3333-aaaa-bbbbbbbbbbbb' }
+  let(:local)   { false }
+  let(:debug)   { false }
+  let(:ssl)     { false }
+  let(:host)    { Le::Host.new(token, local, debug, ssl) }
+
+  specify { host.must_be_instance_of Le::Host::HTTP }
+
+end

data/test/http_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+require 'pathname'
+
+describe Le::Host::HTTP do
+
+  let(:token)              { '11111111-2222-3333-aaaa-bbbbbbbbbbbb' }
+  let(:local)              { false }
+  let(:debug)              { false }
+  let(:ssl)                { false }
+  let(:host)               { Le::Host::HTTP.new(token, local, debug, ssl) }
+  let(:logger_console)     { host.instance_variable_get(:@logger_console) }
+  let(:logger_console_dev) { logger_console.instance_variable_get(:@logdev).dev }
+
+  specify { host.must_be_instance_of Le::Host::HTTP }
+  specify { host.local.must_equal false }
+  specify { host.debug.must_equal false }
+  specify { host.ssl.must_equal false }
+
+end

data/test/le_spec.rb

@@ -0,0 +1,142 @@
+require 'spec_helper'
+
+describe Le do
+
+  let(:token)              { '11111111-2222-3333-aaaa-bbbbbbbbbbbb' }
+  let(:local)              { false }
+  let(:logger)             { Le.new(token, local: local) }
+  let(:logdev)             { logger.instance_variable_get(:@logdev).dev }
+  let(:logger_console)     { logdev.instance_variable_get(:@logger_console) }
+  let(:logger_console_dev) { logger_console.instance_variable_get(:@logdev).dev }
+
+
+  describe "when non-Rails environment" do
+
+    describe "when initialised with just a token" do
+      let(:logger)         { Le.new(token) }
+      specify { logger.must_be_instance_of Logger }
+      specify { logdev.must_be_instance_of Le::Host::HTTP }
+      specify { logdev.local.must_equal false }
+      specify { logger_console.must_be_nil }
+    end
+
+    describe "and :local is false" do
+      specify { logdev.local.must_equal false }
+      specify { logger_console.must_be_nil }
+    end
+
+    describe "and :local is true" do
+      let(:local)   { true }
+
+      specify { logdev.local.must_equal true }
+      specify { logger_console.must_be_instance_of Logger }
+      specify { logger_console_dev.must_be_instance_of IO }
+    end
+
+
+    describe "and :local => " do
+      let(:local_test_log) { Pathname.new(File.dirname(__FILE__)).join('fixtures','log','local_log.log') }
+      let(:local)   { log_file }
+
+      describe "Pathname" do
+        let(:log_file) { local_test_log }
+
+        specify { logdev.must_be_instance_of Le::Host::HTTP }
+        specify { logdev.local.must_equal true }
+        specify { logger_console.must_be_instance_of Logger }
+        specify { logger_console_dev.must_be_instance_of File }
+        specify { logger_console_dev.path.must_match 'local_log.log' }
+      end
+
+      describe "path string" do
+        let(:log_file) { local_test_log.to_s }
+
+        specify { logdev.must_be_instance_of Le::Host::HTTP }
+        specify { logdev.local.must_equal true }
+        specify { logger_console.must_be_instance_of Logger }
+        specify { logger_console_dev.must_be_instance_of File }
+        specify { logger_console_dev.path.must_match 'local_log.log' }
+      end
+
+      describe "File" do
+        let(:log_file) { File.new(local_test_log) }
+
+        specify { logdev.must_be_instance_of Le::Host::HTTP }
+        specify { logdev.local.must_equal true }
+        specify { logger_console.must_be_instance_of Logger }
+        specify { logger_console_dev.must_be_instance_of File }
+        specify { logger_console_dev.path.must_match 'local_log.log' }
+      end
+
+    end
+
+  end
+
+  describe "when Rails environment" do
+    before do
+      class Rails
+        def self.root
+          Pathname.new(File.dirname(__FILE__)).join('fixtures')
+        end
+        def self.env
+          'test'
+        end
+      end
+    end
+    after do
+      Object.send(:remove_const, :Rails)
+    end
+
+    describe "and :local is false" do
+      specify { logdev.local.must_equal false }
+      specify { logger_console.must_be_nil }
+    end
+
+    describe "and :local is true" do
+      let(:local)   { true }
+
+      specify { logdev.local.must_equal true }
+      specify { logger_console.must_be_instance_of Logger }
+      specify { logger_console_dev.must_be_instance_of File }
+      specify { logger_console_dev.path.must_match 'test.log' }
+    end
+
+    describe "and :local => " do
+      let(:local_test_log) { Pathname.new(File.dirname(__FILE__)).join('fixtures','log','local_log.log') }
+      let(:local)   { log_file }
+
+      describe "Pathname" do
+        let(:log_file) { local_test_log }
+
+        specify { logdev.must_be_instance_of Le::Host::HTTP }
+        specify { logdev.local.must_equal true }
+        specify { logger_console.must_be_instance_of Logger }
+        specify { logger_console_dev.must_be_instance_of File }
+        specify { logger_console_dev.path.must_match 'local_log.log' }
+      end
+
+      describe "path string" do
+        let(:log_file) { local_test_log.to_s }
+
+        specify { logdev.must_be_instance_of Le::Host::HTTP }
+        specify { logdev.local.must_equal true }
+        specify { logger_console.must_be_instance_of Logger }
+        specify { logger_console_dev.must_be_instance_of File }
+        specify { logger_console_dev.path.must_match 'local_log.log' }
+      end
+
+      describe "File" do
+        let(:log_file) { File.new(local_test_log) }
+
+        specify { logdev.must_be_instance_of Le::Host::HTTP }
+        specify { logdev.local.must_equal true }
+        specify { logger_console.must_be_instance_of Logger }
+        specify { logger_console_dev.must_be_instance_of File }
+        specify { logger_console_dev.path.must_match 'local_log.log' }
+      end
+
+    end
+
+  end
+
+end

data/test/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'minitest/autorun'
+require 'le'

metadata

@@ -1,27 +1,78 @@
 --- !ruby/object:Gem::Specification
 name: le
 version: !ruby/object:Gem::Version
-  version: 2.2.9
+  version: 2.3.9
 platform: ruby
 authors:
 - Mark Lacomber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-30 00:00:00.000000000 Z
-dependencies: []
+date: 2014-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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: minitest
+  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: |2+
 
-
 email: mark.lacomber@logentries.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
+- Gemfile
 - LE.gemspec
-- ./lib/le/host.rb
-- ./lib/le/host/http.rb
-- ./lib/le.rb
+- LICENSE
+- README.md
+- Rakefile
+- lib/le.rb
+- lib/le/host.rb
+- lib/le/host/http.rb
+- test/fixtures/log/.gitignore
+- test/host_spec.rb
+- test/http_spec.rb
+- test/le_spec.rb
+- test/spec_helper.rb
 homepage: https://github.com/logentries/le_ruby
 licenses:
 - MIT
@@ -42,8 +93,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.8
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Logentries plugin
-test_files: []
+test_files:
+- test/fixtures/log/.gitignore
+- test/host_spec.rb
+- test/http_spec.rb
+- test/le_spec.rb
+- test/spec_helper.rb