cabin-es 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 832bce7cbb88ad24a9565a823ceed93701d74516
+  data.tar.gz: 6194b13528cbd44ff616bb3878b2ad565effcb46
+SHA512:
+  metadata.gz: fcf3ebe7c7d42c6c41cc23c02d80eaa5bfb71bc1b95b5c59027f6e479889093e0eb15c9199763a5de38c7de1c466d0e31c7038726c339931daf692c191952349
+  data.tar.gz: 72676a61d90a83f7d5578e3519c51cf38c118d958a1a4e59cb1b642fac0fcede09aed455235efb92e9ac6c83c392646b8dbcb2a5b84c1f1fbd468e5c1305b3aa

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/bundle

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Stark Riedesel
+
+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,84 @@
+# Cabin - ElasticSearch
+
+[ElasticSearch](https://www.elastic.co/) output provider for the [Ruby Cabin](https://github.com/jordansissel/ruby-cabin) logging framework.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cabin-es', require: 'cabin/es'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cabin-es
+
+## Usage
+
+Used just like any other Cabin output plugin:
+
+```ruby
+require 'cabin'
+require 'cabin/es'
+
+# Create a new Cabin channel
+@logger = Cabin::Channel.new
+
+# Subscribe to an ElasticSearch host
+es = Cabin::Output::ElasticSearch.new(url: 'http://elasticsearch.example.com:9200', index: 'cabin', type: 'log')
+@logger.subscribe(es)
+
+# Send logs just like normal
+@logger.info "Test Message", {some: 'data', nested { data: 'is cool' }}
+
+# Set the ElasticSearch "_type" on a per-message basis
+@logger.info "Special Message", {some: 'data', _type: 'special'}
+```
+
+Message and data fields are imported into ElasticSearch as you would expect
+```json
+{
+  "_index": "cabin",
+  "_type": "log",
+  "_id": "AVgrn6PBq2Wn7-YPg6FT",
+  "_score": null,
+  "_source": {
+    "timestamp": "2016-11-03T14:17:12.076636-0500",
+    "message": "Test Message",
+    "level": "info",
+    "some": "data",
+    "nested": {
+      "data": "is cool"
+    }
+  },
+  "fields": {
+    "timestamp": [
+      1478200632076
+    ]
+  },
+  "sort": [
+    1478200632076
+  ]
+}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/starkriedesel/cabin-es.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cabin/es"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cabin-es.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cabin/es/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cabin-es"
+  spec.version       = Cabin::Es::VERSION
+  spec.authors       = ["Stark Riedesel"]
+  spec.email         = ["starkriedesel@gmail.com"]
+
+  spec.summary       = %q{ElasticSearch output provider for the Ruby Cabin logging framework}
+  spec.description   = %q{ElasticSearch output provider for the Ruby Cabin logging framewor}
+  spec.homepage      = "https://www.github.com/starkriedesel/cabin-es"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   = []
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_runtime_dependency "cabin", "~> 0.9.0"
+  spec.add_runtime_dependency "elasticsearch", "~> 2.0.0"
+end

data/lib/cabin/es.rb

@@ -0,0 +1,8 @@
+require "cabin/es/version"
+require 'cabin/outputs/elastic_search'
+
+module Cabin
+  module Es
+    # Your code goes here...
+  end
+end

data/lib/cabin/es/version.rb

@@ -0,0 +1,5 @@
+module Cabin
+  module Es
+    VERSION = "0.0.1"
+  end
+end

data/lib/cabin/outputs/elastic_search.rb

@@ -0,0 +1,28 @@
+require 'cabin'
+require 'elasticsearch'
+
+class Cabin::Outputs::ElasticSearch
+  attr_accessor :settings, :es
+
+  def initialize(args={})
+    logger = args.delete 'logger'
+    self.settings = {index: 'cabin', type: 'cabin'}.merge(args)
+    sanity_check!
+    self.es = Elasticsearch::Client.new urls: settings[:urls], logger: logger
+  end
+
+  def sanity_check!
+    settings[:urls] ||= [settings.delete(:url)] if settings.key? :url
+    [:index, :type].each {|x| settings[x] = settings[x].to_s}
+    raise Exception.new 'Index must be not blank for Cabin::Outputs::ElasticSearch' if settings[:index] =~ /^\s*$/
+    raise Exception.new 'Type must be not blank for Cabin::Outputs::ElasticSearch' if settings[:type] =~ /^\s*$/
+    raise Exception.new 'At least one URL must be provided to Cabin::Outputs::ElasticSearch' if settings[:urls].nil? or settings[:urls].count == 0
+  end
+
+  def <<(event)
+    type = event.delete :_type
+    type = event.delete "_type" if type.nil?
+    type = settings[:type] if type.nil?
+    es.index index: settings[:index], type: type.to_s, body: event
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: cabin-es
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Stark Riedesel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: cabin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: elasticsearch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: ElasticSearch output provider for the Ruby Cabin logging framewor
+email:
+- starkriedesel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cabin-es.gemspec
+- lib/cabin/es.rb
+- lib/cabin/es/version.rb
+- lib/cabin/outputs/elastic_search.rb
+homepage: https://www.github.com/starkriedesel/cabin-es
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5.1
+signing_key: 
+specification_version: 4
+summary: ElasticSearch output provider for the Ruby Cabin logging framework
+test_files: []