logasm 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3101253198b60ee5b25bb1630c9e921adb38aeb
-  data.tar.gz: 6bd9c7299915e79a8e66e435203814055d02975e
+  metadata.gz: 95ef4c8dd10a76b6775e23d3ed9788b8fd0c566e
+  data.tar.gz: c42a97f69f78953749d22008b8dd8dadab680ba8
 SHA512:
-  metadata.gz: d79512c5dfae753ff1b23afa09d847b4eea76d2c659b496f4b45d1646113af73683c808cb7a756c472dd8eb3befbcf4e2532847180d42512adb9eb8b42db475d
-  data.tar.gz: 85187d7037e0df502f3c25e2c792d1769a4583f39d3876534069365eacea671b092dcb56f37f30216dc89c47a4d6a774223a55ec651f36124124b69efdffc177
+  metadata.gz: 71b8cd77787497193c97508a269c0d538c3fd2a38a8940eaff94174f5918222ff3d59ec8f1fbb1cd7b1f7c90f1147ea08e776762f5919a1eeb20f005b74cd460
+  data.tar.gz: a766efc45eff5765e72353fc49c6680f31722e3bd81d710ceb0f64ef130901c8823349b6556f0bba3e33b07806e69cde3dd842937a621522b78d56af84961029

data/Gemfile.lock

@@ -1,17 +1,26 @@
 PATH
   remote: .
   specs:
-    logasm (0.2.1)
+    logasm (0.2.2)
       inflecto
-      logstash-event (~> 1.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    amq-protocol (2.0.0)
+    atomic (1.1.99)
+    bunny (1.6.3)
+      amq-protocol (>= 1.9.2)
     coderay (1.1.0)
     diff-lcs (1.2.5)
+    freddy (0.4.1)
+      bunny (= 1.6.3)
+      hamster (~> 1.0.1.pre.rc3)
+      symbolizer
+      thread (~> 0.2)
+    hamster (1.0.1.pre.rc3)
+      atomic (~> 1.1)
     inflecto (0.0.2)
-    logstash-event (1.2.02)
     method_source (0.8.2)
     pry (0.10.1)
       coderay (~> 1.1.0)
@@ -32,12 +41,15 @@ GEM
       rspec-support (~> 3.3.0)
     rspec-support (3.3.0)
     slop (3.6.0)
+    symbolizer (0.0.1)
+    thread (0.2.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.3)
+  freddy (~> 0.4.1)
   logasm!
   pry
   rake

data/lib/logasm/adapters/logstash_adapter/formatter.rb

@@ -2,33 +2,14 @@ class Logasm
   module Adapters
     class LogstashAdapter
       class Formatter < ::Logger::Formatter
-        HOST = ::Socket.gethostname
-
         def initialize(service_name)
           @service_name = service_name
         end
 
-        def call(severity, time, _progname, message)
-          event = build_event(message, severity, time)
+        def call(level, _time, _progname, message)
+          event = Utils.build_event(message, level, @service_name)
           "#{event.to_json}\n"
         end
-
-        private
-
-        def build_event(metadata, level, time)
-          event = LogStash::Event.new(metadata.merge("@timestamp" => time))
-
-          event['application'] = @service_name if @service_name
-          event['level'] = level.downcase
-          event['host'] ||= HOST
-
-          # In case Time#to_json has been overridden
-          if event.timestamp.is_a?(Time)
-            event.timestamp = event.timestamp.iso8601(3)
-          end
-
-          event
-        end
       end
     end
   end

data/lib/logasm/adapters/logstash_adapter.rb

@@ -1,5 +1,4 @@
 require 'socket'
-require 'logstash-event'
 require_relative 'logstash_adapter/formatter'
 
 class Logasm

data/lib/logasm/adapters/rabbitmq_adapter.rb

@@ -7,8 +7,6 @@ rescue LoadError => e
   raise exception
 end
 
-require_relative 'rabbitmq_adapter/message_builder'
-
 class Logasm
   module Adapters
     class RabbitmqAdapter
@@ -16,18 +14,18 @@ class Logasm
 
       CONFIGURATION_KEYS = [:host, :user, :pass, :port]
 
-      def initialize(level, service, arguments = {})
+      def initialize(level, service_name, arguments = {})
         config = arguments.select { |key, value| CONFIGURATION_KEYS.include?(key) }
         logger = Logger.new(STDOUT)
         @queue = arguments.fetch(:queue, 'logstash-queue')
         @level = level
-        @message_builder = MessageBuilder.new(service)
+        @service_name = service_name
         @freddy = Freddy.build(logger, config.merge({recover_from_connection_close: true}))
       end
 
       def log(level, metadata = {})
         if meets_threshold?(level)
-          message = @message_builder.build_message metadata, level
+          message = Utils.build_event(metadata, level, @service_name)
           deliver_message message
         end
       end

data/lib/logasm/utils.rb

@@ -0,0 +1,35 @@
+require 'socket'
+
+class Logasm
+  module Utils
+    HOST = ::Socket.gethostname
+
+    # Build logstash json compatible event
+    #
+    # @param [Hash] metadata
+    # @param [#to_s] level
+    # @param [String] service_name
+    #
+    # @return [Hash]
+    def self.build_event(metadata, level, service_name)
+      metadata.merge(
+        application: application_name(service_name),
+        level: level.to_s.downcase,
+        host: HOST,
+        :@timestamp => Time.now.utc.iso8601(3)
+      )
+    end
+
+    # Return application name
+    #
+    # Returns lower snake case application name. This allows the
+    # application value to be used in the elasticsearch index name.
+    #
+    # @param [String] service_name
+    #
+    # @return [String]
+    def self.application_name(service_name)
+      Inflecto.underscore(service_name)
+    end
+  end
+end

data/lib/logasm.rb

@@ -1,6 +1,8 @@
 require 'inflecto'
 require 'logger'
+require 'json'
 require_relative 'logasm/adapters'
+require_relative 'logasm/utils'
 
 class Logasm
   def self.build(service_name, loggers_config)

data/logasm.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |gem|
   gem.name          = "logasm"
-  gem.version       = '0.2.1'
+  gem.version       = '0.2.2'
   gem.authors       = ["Salemove"]
   gem.email         = ["support@salemove.com"]
   gem.description   = %q{It's logasmic}
@@ -16,7 +16,6 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency 'logstash-event', '~> 1.2'
   gem.add_dependency 'inflecto'
 
   gem.add_development_dependency "bundler", "~> 1.3"

data/spec/adapters/logstash_adapter/formatter_spec.rb

@@ -2,37 +2,19 @@ require 'spec_helper'
 require_relative '../../../lib/logasm/adapters/logstash_adapter/formatter'
 
 describe Logasm::Adapters::LogstashAdapter::Formatter do
-  subject(:event) { JSON.parse(formatter.call(severity, time, nil, message)) }
+  subject(:event) { formatter.call(severity, Time.now, nil, message) }
 
-  let(:formatter) { described_class.new(service_name) }
+  let(:formatter)    { described_class.new(service_name) }
   let(:service_name) { 'test_service' }
-  let(:severity) { 'INFO' }
-  let(:time) { Time.now }
-  let(:message) { {} }
-
-  context 'when service name is present' do
-    it 'includes it in the event as application' do
-      expect(event['application']).to eq('test_service')
-    end
-  end
-
-  context 'when service name is not present' do
-    let(:service_name) { nil }
-
-    it 'includes does not include the application key' do
-      expect(event).to_not have_key('application')
-    end
-  end
-
-  it 'includes severity as lowercase level' do
-    expect(event['level']).to eq('info')
-  end
-
-  it 'includes timestamp' do
-    expect(event['@timestamp']).to match(/\d{4}.*/)
-  end
-
-  it 'includes the host' do
-    expect(event['host']).to be_a(String)
+  let(:severity)     { 'INFO' }
+  let(:message)      { {x: 'y'} }
+
+  it 'returns correct json' do
+    hash = JSON.parse(subject)
+    expect(hash['x']).to eq('y')
+    expect(hash['application']).to eq('test_service')
+    expect(hash['level']).to eq('info')
+    expect(hash['host']).to be_a(String)
+    expect(hash['@timestamp']).to match(/\d{4}-\d{2}-\d{2}T.*/)
   end
 end

data/spec/adapters/rabbitmq_adapter_spec.rb

@@ -2,21 +2,33 @@ require 'spec_helper'
 require_relative '../../lib/logasm/adapters/rabbitmq_adapter'
 
 describe Logasm::Adapters::RabbitmqAdapter do
-  let(:adapter) { described_class.new(log_level, nil, { host: 'localhost',
-                                                user: 'guest',
-                                                pass: 'guest',
-                                                port: '5672' }
-                                      ) }
+  let(:adapter) do
+    described_class.new(log_level, 'TestService', {
+      host: 'localhost', user: 'guest', pass: 'guest', port: '5672'
+    })
+  end
   let(:freddy) { adapter.freddy }
 
+  before do
+    allow(Freddy).to receive(:build) { FreddyMock.new }
+  end
+
   describe '#log' do
     context 'when logging a message' do
       let(:log_level) { 0 }
 
       it 'delegates to freddy' do
-        expect(freddy).to receive(:deliver)
-
         adapter.log :info, message: 'test'
+
+        expect(freddy.deliveries.size).to eq(1)
+
+        queue, event = freddy.deliveries[0]
+        expect(queue).to eq('logstash-queue')
+        expect(event[:message]).to eq('test')
+        expect(event[:application]).to eq('test_service')
+        expect(event[:level]).to eq('info')
+        expect(event[:host]).to be_a(String)
+        expect(event[:@timestamp]).to match(/\d{4}-\d{2}-\d{2}T.*/)
       end
     end
 

data/spec/spec_helper.rb

@@ -1,10 +1,14 @@
+require 'rubygems'
+require 'bundler'
+require 'pry'
+Bundler.setup
+
+require 'logasm'
+
+Dir[File.dirname(__FILE__) + '/support/*.rb'].each {|f| require f}
+
 RSpec.configure do |config|
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
   config.order = 'random'
 end
-
-require 'pry'
-require 'securerandom'
-
-require 'logasm'

data/spec/support/freddy_mock.rb

@@ -0,0 +1,11 @@
+class FreddyMock
+  attr_reader :deliveries
+
+  def initialize
+    @deliveries = []
+  end
+
+  def deliver(queue, params)
+    @deliveries << [queue, params]
+  end
+end

data/spec/utils_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Logasm::Utils do
+  describe '.build_event' do
+    subject(:event) { described_class.build_event(metadata, level, service_name) }
+
+    let(:service_name) { 'test_service' }
+    let(:level)        { 'INFO' }
+    let(:metadata)     { {x: 'y'} }
+
+    context 'when service name is in correct format' do
+      it 'includes it in the event as application' do
+        expect(event[:application]).to eq('test_service')
+      end
+    end
+
+    context 'when service name is in camelcase' do
+      let(:service_name) { 'InformationService' }
+
+      it 'includes it in the event as lower snake case' do
+        expect(event[:application]).to eq('information_service')
+      end
+    end
+
+    it 'includes level as a lower case string' do
+      expect(event[:level]).to eq('info')
+    end
+
+    it 'includes timestamp' do
+      expect(event[:@timestamp]).to match(/\d{4}.*/)
+    end
+
+    it 'includes the host' do
+      expect(event[:host]).to be_a(String)
+    end
+  end
+end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: logasm
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Salemove
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-31 00:00:00.000000000 Z
+date: 2015-09-17 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: logstash-event
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: inflecto
   requirement: !ruby/object:Gem::Requirement
@@ -100,16 +86,17 @@ files:
 - lib/logasm/adapters/logstash_adapter.rb
 - lib/logasm/adapters/logstash_adapter/formatter.rb
 - lib/logasm/adapters/rabbitmq_adapter.rb
-- lib/logasm/adapters/rabbitmq_adapter/message_builder.rb
 - lib/logasm/adapters/stdout_adapter.rb
+- lib/logasm/utils.rb
 - logasm.gemspec
 - spec/adapters/logstash_adapter/formatter_spec.rb
 - spec/adapters/logstash_adapter_spec.rb
-- spec/adapters/rabbitmq_adapter/message_builder_spec.rb
 - spec/adapters/rabbitmq_adapter_spec.rb
 - spec/adapters/stdout_adapter_spec.rb
 - spec/logasm_spec.rb
 - spec/spec_helper.rb
+- spec/support/freddy_mock.rb
+- spec/utils_spec.rb
 homepage: 
 licenses:
 - MIT
@@ -130,15 +117,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: What description said
 test_files:
 - spec/adapters/logstash_adapter/formatter_spec.rb
 - spec/adapters/logstash_adapter_spec.rb
-- spec/adapters/rabbitmq_adapter/message_builder_spec.rb
 - spec/adapters/rabbitmq_adapter_spec.rb
 - spec/adapters/stdout_adapter_spec.rb
 - spec/logasm_spec.rb
 - spec/spec_helper.rb
+- spec/support/freddy_mock.rb
+- spec/utils_spec.rb

data/lib/logasm/adapters/rabbitmq_adapter/message_builder.rb

@@ -1,22 +0,0 @@
-require 'socket'
-
-class Logasm
-  module Adapters
-    class RabbitmqAdapter
-      class MessageBuilder
-        HOST = ::Socket.gethostname
-
-        def initialize(service_name)
-          @service_name = service_name
-        end
-
-        def build_message(metadata, level)
-          metadata.merge({ application: @service_name,
-                           level: level,
-                           host: HOST,
-                           :@timestamp => Time.now.utc.iso8601(3) })
-        end
-      end
-    end
-  end
-end

data/spec/adapters/rabbitmq_adapter/message_builder_spec.rb

@@ -1,19 +0,0 @@
-require 'spec_helper'
-require_relative '../../../lib/logasm/adapters/rabbitmq_adapter/message_builder'
-
-describe Logasm::Adapters::RabbitmqAdapter::MessageBuilder do
-  subject { message_builder.build_message(metadata, level) }
-
-  let(:message_builder) { described_class.new(service_name) }
-  let(:service_name) { 'test_service' }
-  let(:level) { :info }
-  let(:metadata) { {message: 'test'} }
-
-  it 'adds necessary arguments' do
-    expect(subject[:message]).to eq(metadata[:message])
-    expect(subject[:application]).to eq(service_name)
-    expect(subject[:level]).to eq(level)
-    expect(subject).to have_key(:host)
-    expect(subject).to have_key(:@timestamp)
-  end
-end