logstash_scribbler 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b85417a19a572d31ba7b9b8189e5e68d7713adef
+  data.tar.gz: 45a8486a13282a99514bfa793d5cf9a0c13515ab
+SHA512:
+  metadata.gz: c2ecef724413e9d1f9470a7af054a06395a8c9907b74dc6e4adce3cf93cd82bcee3dd61e2fc57c1a9cd2d1c6a82e877bacecec262536523c64c36253847fec79
+  data.tar.gz: cc50fece87690cf8f377844d957c7d253b176924fc5b555b9002502a555a35f8d9fdd81c8d9df3b67950b1f7ebaadfc8856099a0ce3f98fd7211f479fbef40b1

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.octopolo.yml

@@ -0,0 +1,4 @@
+github_repo: sportngin/logstash_scribbler
+semantic_versioning: true
+branches_to_keep:
+- master

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.soyuz.yml

@@ -0,0 +1,13 @@
+defaults:
+  deploy_cmd: gem push *.gem
+  before_deploy_cmds:
+    - /usr/local/bin/op tag-release
+    - sed -i "" -e "s/\".*/\"$(git tag| sort -n -t. -k1,1 -k2,2 -k3,3 | tail -1 | sed s/v//)\"/" lib/logstash_scribbler/version.rb
+    - git add  lib/logstash_scribbler/version.rb
+    - git commit -m "Version Bump" && git push
+    - gem build logstash_scribbler.gemspec
+  after_deploy_cmds:
+    - rm *.gem
+environments:
+  -
+    rubygems: {}

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.0
+  - 2.1
+  - 1.9.3
+script: bundle exec rspec

data/CHANGELOG.markdown

@@ -0,0 +1,2 @@
+#### 0.0.2
+#### 0.0.1

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Elliot Hursh
+
+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,34 @@
+# LogstashScribbler
+
+Easily add Logstash support for Scribbler logs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'logstash_scribbler'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install logstash_scribbler
+
+## Usage
+
+require 'logstash_scribbler' and then add the following line to your scribbler initializer.
+```ruby
+config.template = LogstashScribbler.template
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/logstash_scribbler/fork )
+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 a new Pull Request

data/Rakefile

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

data/lib/logstash_scribbler/message.rb

@@ -0,0 +1,44 @@
+module LogstashScribbler
+  class Message
+    attr_reader :error, :message, :custom_fields, :object
+    def initialize(options)
+      @error = inspected_error(options[:error])
+      @message = options[:message]
+      @custom_fields = options[:custom_fields]
+      @object = options[:object]
+    end
+
+    def log
+      LogStash::Event.new(data).to_json
+    end
+
+    def data
+      log_msg = {
+        :error => error,
+        :message => message,
+      }
+      log_msg = custom_fields.merge!(log_msg) if custom_fields
+      log_msg = namespaced_object.merge!(log_msg) if object
+      log_msg.reject { |k, v| v.nil? }
+    end
+
+    def namespaced_object
+      return { :object => object } unless is_active_record?(object)
+      object_type = object.class.name
+      {object_type.to_sym => object}
+    end
+
+    def inspected_error(error)
+      if error.is_a? Exception
+        e = error
+        error = {:message => e.message, :inspect => e.inspect, :backtrace => e.backtrace}
+      else
+        error
+      end
+    end
+
+    def is_active_record?(object)
+      object.is_a?(ActiveRecord::Base) 
+    end
+  end
+end

data/lib/logstash_scribbler/version.rb

@@ -0,0 +1,3 @@
+module LogstashScribbler
+  VERSION = "0.0.2"
+end

data/lib/logstash_scribbler.rb

@@ -0,0 +1,18 @@
+require "logstash_scribbler/version"
+require "logstash_scribbler/message"
+
+module LogstashScribbler
+  def self.template
+    lambda do |options|
+      load_dependencies
+      LogstashScribbler::Message.new(options).log
+    end
+  end
+
+  def self.load_dependencies
+    require 'logstash-event'
+  rescue LoadError
+    puts 'You need to install the logstash-event gem to use the logstash output.'
+    raise
+  end
+end

data/logstash_scribbler.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'logstash_scribbler/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "logstash_scribbler"
+  spec.version       = LogstashScribbler::VERSION
+  spec.authors       = ["Elliot Hursh"]
+  spec.email         = ["elliothursh@gmail.com"]
+  spec.summary       = %q{Creates a logstash template for logstash}
+  spec.description   = %q{Creates a logstash template for logstash}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "logstash-event"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "activerecord"
+  spec.add_development_dependency "activesupport"
+  spec.add_development_dependency "rspec"
+end

data/spec/logstash_scribbler/message_spec.rb

@@ -0,0 +1,85 @@
+require "spec_helper"
+# require "active_record/core"
+require "logstash_scribbler/message"
+
+module LogstashScribbler
+  describe Message do
+    let(:message) {LogstashScribbler::Message.new({:error => "Something Bad", :message => nil, :object => [1,2,3]})}
+    before do
+      allow(message).to receive(:is_active_record?).and_return(false)
+    end
+
+    context "#log" do
+      require 'logstash-event'
+      it "should call Logtash::Event new" do
+        expect(LogStash::Event).to receive(:new).once
+        message.log
+      end
+    end
+
+    context "#data" do
+      it "should not return nil values" do
+        expect(message.data).to eq({:error => "Something Bad", :object => [1,2,3]})
+      end
+
+      it "calls #namespaced_object when passed on object" do
+        expect(message).to receive(:namespaced_object).and_return({:object => [1,2,3]})
+        message.data
+      end
+
+      it "puts custom fields at top level" do
+        options = {:error => "Something Bad", :custom_fields => {:name => "Sport Ngin", :error => "Something kind of Bad"}}
+        message = LogstashScribbler::Message.new(options)
+        expect(options[:custom_fields][:name]).to eq(message.data[:name])
+        expect(options[:error]).to eq(message.data[:error])
+      end
+
+      it "keeps attribute precedence ((:error || :message) > :custom_fields > :object))" do
+        options = {:message => "Normal Message", :custom_fields => { :message => "Custom Message", :object => [1]}, :object => [3,4,5]}
+        message = LogstashScribbler::Message.new(options)
+        allow(message).to receive(:is_active_record?).and_return(false)
+        expect(message.data).to eq({ :message => "Normal Message", :object => [1] })
+      end
+    end
+
+    context "#namespaced_object" do
+      context "when passed non ActiveRecord::Base object" do
+        it "returns a hash" do
+          expect(message.namespaced_object).to be_a(Hash)
+        end
+        it "places object under the 'object' key" do
+          expect(message.namespaced_object[:object]).to eq([1,2,3])
+        end
+      end
+
+      context "when passed ActiveRecord::Base object" do
+        before do
+          allow(message).to receive(:is_active_record?).and_return(true)
+        end
+        it "creates hash from object" do
+          expect(message.namespaced_object).to be_a(Hash)
+        end
+        it "prepends class name to instance variable names" do
+          expect(message.namespaced_object.has_key?(:Array)).to eq(true)
+        end
+      end
+    end
+
+    context "#inspected_error" do
+      context "when passed non Exception" do
+        it "returns error" do
+          expect(message.error).to eq("Something Bad")
+        end
+      end
+
+      context "when passed Exception" do
+        error = Exception.new
+        message = LogstashScribbler::Message.new({:error => error})
+        it "returns a hash of the exception" do
+          expect(message.error).to be_a(Hash)
+        end
+      end
+    end
+  end
+
+end

data/spec/logstash_scribbler_spec.rb

@@ -0,0 +1,28 @@
+require "spec_helper"
+require "logstash_scribbler"
+
+describe LogstashScribbler do
+  let(:options) do
+    {:message => "FooFoo Bar"}
+  end
+  let(:message) {LogstashScribbler::Message.new(options)}
+
+  context ".template" do 
+    it "returns a lambda" do
+      expect(LogstashScribbler.template).to be_a(Proc)
+    end
+  end
+
+  it "calls log" do
+    allow(LogstashScribbler::Message).to receive(:new).and_return(message)
+    expect(message).to receive(:log).once
+    LogstashScribbler.template.call({:message => "FooFoo Bar"})
+  end
+
+  it "calls .load_dependencies" do
+    expect(LogstashScribbler).to receive(:load_dependencies).once
+    LogstashScribbler.template.call({:message => "FooFoo Bar"})
+  end
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,91 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  # config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # 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
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: logstash_scribbler
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Elliot Hursh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logstash-event
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: activerecord
+  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: activesupport
+  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: 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: Creates a logstash template for logstash
+email:
+- elliothursh@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".octopolo.yml"
+- ".rspec"
+- ".soyuz.yml"
+- ".travis.yml"
+- CHANGELOG.markdown
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/logstash_scribbler.rb
+- lib/logstash_scribbler/message.rb
+- lib/logstash_scribbler/version.rb
+- logstash_scribbler.gemspec
+- spec/.DS_Store
+- spec/logstash_scribbler/.DS_Store
+- spec/logstash_scribbler/message_spec.rb
+- spec/logstash_scribbler_spec.rb
+- spec/spec_helper.rb
+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.5
+signing_key: 
+specification_version: 4
+summary: Creates a logstash template for logstash
+test_files:
+- spec/.DS_Store
+- spec/logstash_scribbler/.DS_Store
+- spec/logstash_scribbler/message_spec.rb
+- spec/logstash_scribbler_spec.rb
+- spec/spec_helper.rb