fluent-plugin-typetalk 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YjIwYTlmMzRhMTFhNTk5NDAxODU1ODVkYjEzOTViYTY1MGJlNTRiNA==
+  data.tar.gz: !binary |-
+    NTRhNDIxMWNiMmEwMmViNTlkOGFmNjIyZDA4NTQ2ZDA5NThiNzczOA==
+SHA512:
+  metadata.gz: !binary |-
+    ZDQ4NmQxNTZiNjYyMDdiODRmN2ViZDY0ZTdlN2MwNmFiZmUyZmQxYmVkMTRm
+    NjQ4NTQ4ZmIxY2I5NTAyNWZiZTc5ZDAzYTc2MDE0NjAwZGI3N2Y0MzcxYWYw
+    NWVlM2Y3ZGU1MDk0OGJjZjZjNDE2NzhmNjU4MTk4MGM4YTY0M2E=
+  data.tar.gz: !binary |-
+    YWIyYjc2YWJhMDM0ZjI0OTA1ZDdkMDAxYTc3MmNiOTI5NmVjZTY0OGU5ZWRk
+    ZTcxZGI2NWE3YTNmOTQ1ZTYwZTc0MDY3OTkwMGViOTE0MTE1MzE1MjMzMDZm
+    ZjU1MjIwMjQ3ODAwMWZkMmY3MjUwMzk3Y2Q5N2JhMTIyNGEzNzA=

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
+.idea
+vendor/bundle
+test_out_typetalk_send.rb

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright (c) 2014- SOMEDA Takashi
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,68 @@
+# fluent-plugin-typetalk
+
+## Overview
+
+[Fluentd](http://fluentd.org) plugin to emit notifications to Typetalk.
+
+## Installation
+
+Install with gem or fluent-gem command as:
+
+```
+# for fluentd
+$ gem install fluent-plugin-typetalk
+
+# for td-agent
+$ sudo /usr/lib64/fluent/ruby/bin/fluent-gem install fluent-plugin-typetalk
+```
+
+## Configuration
+
+### Usage
+
+This plugin uses client credentials for authentication. See [the developer document](http://developers.typetalk.in/oauth.html) how to get your own credential.
+```
+<match ...>
+  type typetalk
+  client_id YOUR_CLIENT_ID
+  client_secret YOUR_CLIENT_SECRET
+  topic_id YOUR_TOPIC_ID
+</match>
+```
+
+The default output format is "<%= tag %> at <%= Time.at(time).localtime %>\n<%= record.to_json %>" and an example output is like this:
+```
+test at 2014-05-13 01:21:30  0900
+{"message":"test1"}
+```
+
+To change output format, you can set "template" parameter as follows:
+```
+<match ...>
+  type typetalk
+  client_id YOUR_CLIENT_ID
+  client_secret YOUR_CLIENT_SECRET
+  topic_id YOUR_TOPIC_ID
+  template "Check! <%= record.to_json %>"
+</match>
+```
+Then you'll get the output like this:
+```
+Check! {"message":"test1"}
+```
+
+## TODO
+
+Pull requests are very welcome!!
+
+## For developers
+
+To run tests, do the following.
+```
+$ VERBOSE=1 bundle exec rake test
+```
+
+## Copyright
+
+Copyright :  Copyright (c) 2014- Takashi Someda (@tksmd)
+License   :  Apache License, Version 2.0

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/fluent-plugin-typetalk.gemspec

@@ -0,0 +1,24 @@
+# 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-typetalk"
+  spec.version       = "0.0.1"
+  spec.authors       = ["tksmd"]
+  spec.email         = ["someda@isenshi.com"]
+  spec.description   = %q{fluent plugin to send message to typetalk}
+  spec.summary       = spec.description
+  spec.homepage      = "https://github.com/tksmd/fluent-plugin-typetalk"
+  spec.license       = "Apache-2.0"
+
+  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", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rr", ">= 1.0.0"
+  spec.add_runtime_dependency "fluentd"
+end

data/lib/fluent/plugin/out_typetalk.rb

@@ -0,0 +1,130 @@
+module Fluent
+  class TypetalkOutput < Fluent::BufferedOutput
+    Fluent::Plugin.register_output('typetalk', self)
+
+    config_param :client_id, :string
+    config_param :client_secret, :string
+    config_param :topic_id, :integer
+    config_param :template, :string, :default => "<%= tag %> at <%= Time.at(time).localtime %>\n<%= record.to_json %>"
+    config_param :flush_interval, :time, :default => 1
+
+    attr_reader :typetalk
+
+    # Define `log` method for v0.10.42 or earlier
+    # see http://blog.livedoor.jp/sonots/archives/36150373.html
+    unless method_defined?(:log)
+      define_method("log") { $log }
+    end
+
+    def initialize
+      super
+      require 'erb'
+    end
+
+    def configure(conf)
+      super
+      @typetalk = Typetalk.new(conf['client_id'], conf['client_secret'])
+    end
+
+    def start
+      super
+    end
+
+    def shutdown
+      super
+    end
+
+    def format(tag, time, record)
+      [tag, time, record].to_msgpack
+    end
+
+    def write(chunk)
+      chunk.msgpack_each do |(tag,time,record)|
+        begin
+          send_message(tag, time, record)
+        rescue => e
+          log.error("out_typetalk:", :error_class => e.class, :error => e.message)
+        end
+      end
+    end
+
+    def send_message(tag, time, record)
+      message = ERB.new(@template).result(binding)
+      @typetalk.post(@topic_id, message)
+    end
+
+  end
+
+  class Typetalk
+
+    def initialize(client_id, client_secret)
+      require 'net/http'
+      require 'uri'
+      require 'json'
+
+      @client_id = client_id
+      @client_secret = client_secret
+
+      @http = Net::HTTP.new('typetalk.in', 443)
+      @http.use_ssl = true
+    end
+
+    def post(topic_id, message)
+      check_token()
+      $log.debug("Typetalk access_token : #{@access_token}")
+
+      res = @http.post(
+        "/api/v1/topics/#{topic_id}",
+        "message=#{message}",
+        { 'Authorization' => "Bearer #{@access_token}" }
+      )
+
+      # todo: handling 429
+      unless res and res.is_a?(Net::HTTPSuccess)
+        raise TypetalkError, "failed to post to typetalk.in, code: #{res && res.code}"
+      end
+
+    end
+
+    def check_token
+
+      if @access_token.nil?
+        update_token()
+      elsif Time.now >= @expires
+        update_token(true)
+      end
+
+    end
+
+    def update_token(refresh = false)
+      params = "client_id=#{@client_id}&client_secret=#{@client_secret}"
+      unless refresh
+        params << "&grant_type=client_credentials&scope=topic.post"
+      else
+        params << "&grant_type=refresh_token&refresh_token=#{@refresh_token}"
+      end
+
+      res = @http.post(
+        "/oauth2/access_token",
+        params
+      )
+
+      if res.is_a?(Net::HTTPUnauthorized)
+        raise TypetalkError, "invalid credentials used. check client_id and client_secret in your configuration."
+      end
+
+      unless res.is_a?(Net::HTTPSuccess)
+        raise TypetalkError, "unexpected error occured in getting access_token, code: #{res && res.code}"
+      end
+
+      json = JSON.parse(res.body)
+      @expires = Time.now + json['expires_in'].to_i
+      @refresh_token = json['refresh_token']
+      @access_token = json['access_token']
+    end
+
+  end
+
+  class TypetalkError < RuntimeError; end
+
+end

data/test/helper.rb

@@ -0,0 +1,29 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'rr'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'fluent/test'
+unless ENV.has_key?('VERBOSE')
+  nulllogger = Object.new
+  nulllogger.instance_eval {|obj|
+    def method_missing(method, *args)
+      # pass
+    end
+  }
+  $log = nulllogger
+end
+
+require 'fluent/plugin/out_typetalk'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_out_typetalk.rb

@@ -0,0 +1,47 @@
+# coding: utf-8
+
+require 'helper'
+
+class TypetalkOutputTest < Test::Unit::TestCase
+  
+  def setup
+    Fluent::Test.setup
+  end
+
+  CONFIG = %[
+    type typetalk
+    client_id 123456
+    client_secret secret
+    topic_id 1
+    template <%= record.to_json %>
+  ]
+
+  def create_driver(conf = CONFIG, tag = 'test')
+    Fluent::Test::BufferedOutputTestDriver.new(Fluent::TypetalkOutput, tag).configure(conf)
+  end
+
+  def test_configure
+    d = create_driver()
+    assert_equal d.instance.typetalk.instance_variable_get(:@client_id), '123456'
+    assert_equal d.instance.typetalk.instance_variable_get(:@client_secret), 'secret'
+  end
+
+  def test_write
+    d = create_driver()
+    stub(d.instance.typetalk).post(1, '{"message":"test1"}')
+    d.emit({'message' => 'test1'})
+    d.run()
+  end
+
+  def test_template
+    d = create_driver(CONFIG, 'warn')
+    d.instance.template = "<%= tag %> at <%= Time.at(time).localtime %>\n<%= record.to_json %>"
+    stub(d.instance.typetalk).post(1, "warn at 2014-05-13 01:05:38 +0900\n{\"message\":\"test1\"}")
+
+    ENV["TZ"]="Asia/Tokyo"
+    t = Time.strptime('2014-05-13 01:05:38', '%Y-%m-%d %T')
+    d.emit({'message' => 'test1'}, t)
+    d.run()
+  end
+
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-typetalk
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- tksmd
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: rr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  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'
+description: fluent plugin to send message to typetalk
+email:
+- someda@isenshi.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-typetalk.gemspec
+- lib/fluent/plugin/out_typetalk.rb
+- test/helper.rb
+- test/plugin/test_out_typetalk.rb
+homepage: https://github.com/tksmd/fluent-plugin-typetalk
+licenses:
+- Apache-2.0
+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.2.2
+signing_key: 
+specification_version: 4
+summary: fluent plugin to send message to typetalk
+test_files:
+- test/helper.rb
+- test/plugin/test_out_typetalk.rb