fluent-plugin-hato 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 384dfe1359429a798af48a603e2f81ad67e20886
+  data.tar.gz: ecc62c3105772cab61398dd0526f5eb3cdf69763
+SHA512:
+  metadata.gz: 0faa655dc5fc83d7d4689fcdbff6d269b9b106fd3ff0584f68d69ad2da2abf3e7557f6373e6d15763e6d3f5c21e56ec8c89312f204e58bba01914df64df25403
+  data.tar.gz: 9c65693cc7e16fdadad05dc2ff4311a18687b5c613a6d2a7e95f356789f18fca6b814a1b28d111e635aaa99c533ea20c218ad969529f2e4dc0a93c7e3c296f17

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - ruby-head
+  - rbx-19mode
+

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Kentaro Kuribayashi
+
+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,72 @@
+# Fluent::Plugin::Hato [![BuildStatus](https://secure.travis-ci.org/kentaro/fluent-plugin-hato.png)](http://travis-ci.org/kentaro/fluent-Plugin-hato)
+
+## Component
+
+### HatoOutput
+
+fluent-plugin-hato is a plugin for Fluentd to send messages via [Hato](http://github.com/kentaro/hato).
+
+## Usage
+
+### Synopsis
+
+```
+<match notification.**>
+  type           hato
+
+  api_key        YOUR_API_KEY
+  scheme         http
+  port           9699
+  message_keys   foo, bar, baz
+  message_format [notification] %s %s %s
+</match>
+```
+
+### Params
+
+#### `api_key` (required)
+
+API key for your Hato installation.
+
+#### `scheme` (optional: default = 'http')
+
+Schema for your Hato installation.
+
+#### `host` (required)
+
+Host for your Hato installation.
+
+#### `port` (optional: default = 9699)
+
+Port for your Hato installation.
+
+#### `message_keys` (optional: default = '')
+
+Keys represented by comma-separated value for message.
+
+#### `message_format` (optional: default = '')
+
+Message format.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fluent-plugin-hato'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fluent-plugin-hato
+
+## Contributing
+
+1. Fork it
+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 new Pull Request
+

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+  spec.ruby_opts = %w[-w]
+end
+
+task :default => :spec
+

data/fluent-plugin-hato.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fluent-plugin-hato'
+  spec.version       = '0.0.1'
+  spec.authors       = ['Kentaro Kuribayashi']
+  spec.email         = ['kentarok@gmail.com']
+  spec.description   = %q{A fluent plugin to send messages to Hato}
+  spec.summary       = %q{A fluent plugin to send messages to Hato}
+  spec.homepage      = 'http://github.com/kentaro/fluent-plugin-hato'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  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_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'fluentd'
+  spec.add_development_dependency 'hato'
+end
+

data/lib/fluent/plugin/out_hato.rb

@@ -0,0 +1,71 @@
+require 'uri'
+require 'net/http'
+
+class Fluent::HatoOutput < Fluent::Output
+  Fluent::Plugin.register_output('hato', self)
+
+  include Fluent::HandleTagNameMixin
+
+  config_param :api_key,        :string
+  config_param :scheme,         :string,  :default => 'http'
+  config_param :host,           :string
+  config_param :port,           :integer, :default => 9699
+  config_param :message_keys,   :string,  :default => ''
+  config_param :message_format, :string,  :default => ''
+
+  def configure(conf)
+    super
+
+    if @api_key.nil?
+      raise Fluent::ConfigError(
+        '[out_hato] missing mandatory parameter: `api_key`'
+      )
+    end
+
+    if @host.nil?
+      raise Fluent::ConfigError(
+        '[out_hato] missing mandatory parameter: `host`'
+      )
+    end
+
+    @api_endpoint = '%s://%s:%s/notify' % [
+      @scheme,
+      @host,
+      @port,
+    ]
+  end
+
+  def emit(tag, es, chain)
+    es.each do |time, record|
+      message = message_format % message_keys.split(/\s*,\s*/).map do |key|
+        record[key].to_s
+      end
+      send_message(tag, message)
+    end
+  end
+
+  private
+
+  def send_message(tag, message)
+    begin
+      res = send_request(tag, message)
+      res.value
+    rescue => e
+      $log.warn("[out_hato] failed to send a message tagged with #{tag} to #{scheme}://#{@host}:#{port} for the reason '#{e.message}'")
+    end
+  end
+
+  def send_request(tag, message)
+    http = Net::HTTP.new(URI(@api_endpoint).host, URI(@api_endpoint).port)
+    req  = Net::HTTP::Post.new(URI(@api_endpoint).path)
+
+    req.form_data = {
+      'tag'     => tag,
+      'message' => message,
+      'api_key' => @api_key,
+    }
+
+    http.request(req)
+  end
+end
+

data/spec/lib/out_hato_spec.rb

@@ -0,0 +1,109 @@
+require 'spec_helper'
+
+describe Fluent::HatoOutput do
+  let(:conf) {
+    %[
+      api_key        test_key
+      host           localhost
+      message_keys   foo,bar, baz ,qux
+      message_format [test] %s %s %s %s
+    ]
+  }
+
+  describe '#configure' do
+    context "success" do
+      let(:driver) { Fluent::Test::OutputTestDriver.new(described_class, 'test').configure(conf) }
+      subject {
+        driver.instance
+      }
+
+      it {
+        expect(subject).to be_an_instance_of described_class
+        expect(subject.api_key).to be == 'test_key'
+      }
+    end
+
+    context "failure" do
+      context 'api_key not set' do
+        it {
+          expect {
+            Fluent::Test::OutputTestDriver.new(described_class, 'test').configure(
+              %[
+                host           localhost
+                message_keys   foo,bar, baz ,qux
+                message_format [test] %s %s %s %s
+              ]
+            )
+          }.to raise_error(Fluent::ConfigError)
+        }
+      end
+
+      context 'host not set' do
+        it {
+          expect {
+            Fluent::Test::OutputTestDriver.new(described_class, 'test').configure(
+              %[
+                api_key        test_key
+                message_keys   foo,bar, baz ,qux
+                message_format [test] %s %s %s %s
+              ]
+            )
+          }.to raise_error(Fluent::ConfigError)
+        }
+      end
+    end
+  end
+
+  describe "#send_message" do
+    let(:driver) {
+      Fluent::Test::OutputTestDriver.new(described_class, 'test').configure(conf)
+    }
+    subject {
+      driver.instance
+    }
+    before {
+      $log.reset
+    }
+
+    context 'success' do
+      before {
+        allow(subject).to receive(:send_request).and_return(
+          Net::HTTPSuccess.new('1.1', '200', 'success')
+        )
+
+        subject.send(:send_message, 'test', 'test message')
+      }
+
+      it {
+        expect($log.message).to be_nil
+      }
+    end
+
+    context 'failure' do
+      context 'network error' do
+        before {
+          allow(subject).to receive(:send_request).and_raise(Timeout::Error.new('timeout'))
+          subject.send(:send_message, 'test', 'test message')
+        }
+
+        it {
+          expect($log.message).to be =~ /timeout/
+        }
+      end
+
+      context 'http error' do
+        before {
+          allow(subject).to receive(:send_request).and_return(
+            Net::HTTPClientError.new('1.1', '403', 'forbidden')
+          )
+          subject.send(:send_message, 'test', 'test message')
+        }
+
+        it {
+          expect($log.message).to be =~ /forbidden/
+        }
+      end
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require 'fluent/test'
+require 'fluent/plugin/out_hato'
+
+RSpec.configure do |config|
+end
+
+unless ENV.has_key?('VERBOSE')
+  nulllogger = Object.new
+  nulllogger.instance_eval {|obj|
+    def message
+      @message
+    end
+
+    def reset
+      @message = nil
+    end
+
+    def method_missing(method, *args)
+      @message = args.first
+    end
+  }
+  $log = nulllogger
+end
+

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-hato
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kentaro Kuribayashi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-11 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: 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'
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  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: hato
+  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: A fluent plugin to send messages to Hato
+email:
+- kentarok@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-hato.gemspec
+- lib/fluent/plugin/out_hato.rb
+- spec/lib/out_hato_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/kentaro/fluent-plugin-hato
+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.0.2
+signing_key: 
+specification_version: 4
+summary: A fluent plugin to send messages to Hato
+test_files:
+- spec/lib/out_hato_spec.rb
+- spec/spec_helper.rb