fluent-plugin-deskcom 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5641dbda7a204f52d882965061aea9a383f83730
+  data.tar.gz: 9170d67ca166201d7bc734efec235d927c92a017
+SHA512:
+  metadata.gz: 9057d3893407ec129cc8cf68f6280fb329ce1578c51628085ac5c19bc61a5f2dc970c28ec47d6414fe0ca05529522fe9894e3fee4f24ce2c3363f03a0384f0aa
+  data.tar.gz: 3ccee42a011fa0a5c40fb3c3890c8808b0bcde0a52b971764746303757749750bccb5f061017660763553a1fccf06adc706341ab5504d50e742c17e1b70777db

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Toru Takahashi
+
+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,170 @@
+Deskcom plugin for Fluentd
+===========================
+
+Fluentd Input plugin to collect data from Your Deskcom.
+It is useful to improve your support quality.
+This plugin is still experimental.
+This plugin depends on [desk library](https://github.com/chriswarren/desk)
+Also, please see [Desk API v2](http://dev.desk.com/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fluent-plugin-deskcom'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fluent-plugin-deskcom
+
+## Usage
+
+### Cases Config Sample
+
+```ruby
+<source>
+  type                deskcom
+  subdomain           DESKCOM_SUBDOMAIN           # Required (<subdomain>.desk.com)
+  consumer_key        DESKCOM_CONSUMER_KEY        # Required
+  consumer_secret     DESKCOM_CONSUMER_SECRET     # Required
+  oauth_token         DESKCOM_OAUTH_TOKEN         # Required
+  oauth_token_secret  DESKCOM_OAUTH_TOKEN_SECRET  # Required
+  store_file          /var/log/cases.yml          # Optional (filepath)
+  output_format       simple                      # Optional (simple(default))
+  input_api           cases                       # Optional (cases(default) or replies)
+  tag                 deskcom.cases               # Required
+  time_format         updated_at                  # Optional
+</source>
+```
+
+```ruby
+{
+    "id": 150,
+    "blurb": ": "",
+    "priority": 4,
+    "external_id": null,
+    "locked_until": null,
+    "label_ids": [],
+    "active_at": null,
+    "changed_at": "2013-02-10T14:18:56Z",
+    "created_at": "2013-01-15T11:12:20Z",
+    "updated_at": "2013-02-10T14:18:56Z",
+    "first_opened_at": null,
+    "opened_at": null,
+    "first_resolved_at": "2013-01-27T13:54:13Z",
+    "resolved_at": "2013-01-27T13:54:13Z",
+    "status": "closed",
+    "description": null,
+    "language": null,
+    "received_at": "2013-01-15T11:12:20Z",
+    "type": "email",
+    "labels": [],
+    "subject": "Chat transcript: no operator and Japan #6642",
+    "custom_fields": "{\"custom1_\":null,\"custom2_\":null}"
+}
+```
+
+### Replies Config Sample
+
+```ruby
+<source>
+  type                deskcom
+  subdomain           DESKCOM_SUBDOMAIN           # Required (<subdomain>.desk.com)
+  consumer_key        DESKCOM_CONSUMER_KEY        # Required
+  consumer_secret     DESKCOM_CONSUMER_SECRET     # Required
+  oauth_token         DESKCOM_OAUTH_TOKEN         # Required
+  oauth_token_secret  DESKCOM_OAUTH_TOKEN_SECRET  # Required
+  store_file          /var/log/replies.yml          # Optional (filepath)
+  output_format       simple                      # Optional (simple(default))
+  input_api           replies                     # Optional (cases(default) or replies)
+  tag                 deskcom.replies               # Required
+</source>
+```
+
+```ruby
+{
+    "case_id": 1
+    "id": 159057281,
+    "created_at": "2013-01-14T22:18:14Z",
+    "updated_at": "2013-01-14T22:18:14Z",
+    "sent_at": null,
+    "erased_at": null,
+    "hidden_by": null,
+    "hidden_at": null,
+    "body": "",
+    "from": "Toru Takahashi <torutakahashi.ayashi@gmail.com>",
+    "to": "\"test user\" <test@user.co.jp>",
+    "cc": "",
+    "bcc": null,
+    "client_type": "apple_mail",
+    "direction": "in",
+    "status": "received",
+    "subject": "subject",
+    "hidden": false
+}
+```
+
+### Config Sample (Deskcom -> TreasureData)
+
+```ruby
+# fluent.conf
+<source>
+  type                deskcom
+  subdomain           DESKCOM_SUBDOMAIN           # Required (<subdomain>.desk.com)
+  consumer_key        DESKCOM_CONSUMER_KEY        # Required
+  consumer_secret     DESKCOM_CONSUMER_SECRET     # Required
+  oauth_token         DESKCOM_OAUTH_TOKEN         # Required
+  oauth_token_secret  DESKCOM_OAUTH_TOKEN_SECRET  # Required
+  store_file          /var/log/cases.yml          # Optional (filepath)
+  output_format       simple                      # Optional (simple(default))
+  input_api           cases                       # Optional (cases(default) or replies)
+  tag                 deskcom.cases               # Required
+  time_column         updated_at
+</source>
+
+<source>
+  type                deskcom
+  subdomain           DESKCOM_SUBDOMAIN           # Required (<subdomain>.desk.com)
+  consumer_key        DESKCOM_CONSUMER_KEY        # Required
+  consumer_secret     DESKCOM_CONSUMER_SECRET     # Required
+  oauth_token         DESKCOM_OAUTH_TOKEN         # Required
+  oauth_token_secret  DESKCOM_OAUTH_TOKEN_SECRET  # Required
+  store_file          /var/log/replies.yml        # Optional (filepath)
+  output_format       simple                      # Optional (simple(default))
+  input_api           replies                     # Optional (cases(default) or replies)
+  tag                 deskcom.replies             # Required
+  time_column         created_at
+</source>
+
+<match **>
+  type tdlog
+  apikey TREASUREDATA_API_KEY
+
+  auto_create_table
+  buffer_path /var/log/td-agent/tdlog
+</match>
+```
+
+Please check store_file's permission to write by fluentd.
+
+## TO DO
+
+- Allows over 2 input_api (Ex. input_api cases,replies)
+- Add other input_api
+- Add Rate Limits
+- Add feature to remind last collect cases or replies when forced termination.
+
+## Copyright
+
+Copyright (c) 2014 Toru Takahashi
+
+## License
+
+MIT License
+

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-deskcom.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+$:.push File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name          = "fluent-plugin-deskcom"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Toru Takahashi"]
+  spec.email         = ["torutakahashi.ayashi@gmail.com"]
+  spec.summary       = %q{Input plugin to collect data from Deskcom.}
+  spec.description   = %q{fluent Input plugin to collect data from Deskcom.}
+  spec.homepage      = "https://github.com/toru-takahashi/fluent-plugin-deskcom"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_runtime_dependency "fluentd"
+  spec.add_runtime_dependency "desk"
+end

data/lib/fluent/plugin/in_deskcom.rb

@@ -0,0 +1,167 @@
+module Fluent
+class DeskcomInput < Fluent::Input
+  Fluent::Plugin.register_input('deskcom', self)
+
+  # un-support yet: nest flat
+  OUTPUT_FORMAT_TYPE = %w(simple)
+  # un-support yet: brand article reply ~
+  INPUT_API_TYPE = %w(cases replies)
+  DEFAULT_PER_PAGE = 50
+
+  config_param :subdomain,            :string, :default => nil
+  config_param :consumer_key,         :string, :default => nil
+  config_param :consumer_secret,      :string, :default => nil
+  config_param :oauth_token,          :string, :default => nil
+  config_param :oauth_token_secret,   :string, :default => nil
+  config_param :store_file,           :string, :default => nil
+  config_param :output_format,        :string, :default => 'simple'
+  config_param :input_api,            :string, :default => 'cases'
+  config_param :tag,                  :string, :default => nil
+  config_param :time_column,          :string, :default => nil
+
+  def initialize
+    super
+    require 'desk'
+    require 'yaml'
+    require 'pathname'
+  end
+
+
+  def configure(conf)
+    super
+    if !OUTPUT_FORMAT_TYPE.include?(@output_format)
+      raise Fluent::ConfigError, "output_format value undefined #{@output_format}"
+    end
+
+    if !INPUT_API_TYPE.include?(@input_api)
+      raise Fluent::ConfigError, "input_api value undefined #{@input_api}"
+    end
+
+    if !@consumer_key || !@consumer_secret || !@oauth_token || !@oauth_token_secret
+      raise Fluent::ConfigError, "missing values in consumer_key or consumer_secret or oauth_token or oauth_token_secret"
+    end
+
+    if !@store_file
+      $log.warn("stored_time_file path is missing")
+    end
+
+
+    @stored_time = load_store_file
+    @started_time = Time.now.to_i
+    @per_page = DEFAULT_PER_PAGE
+
+    Desk.configure do |config|
+      config.subdomain          = @subdomain
+      config.consumer_key       = @consumer_key
+      config.consumer_secret    = @consumer_secret
+      config.oauth_token        = @oauth_token
+      config.oauth_token_secret = @oauth_token_secret
+    end
+  end
+
+  def start
+    super
+    @thread = Thread.new(&method(:run))
+  end
+
+  def shutdown
+    @thread.kill
+  end
+
+  def run
+    page = 1
+    if @input_api == 'cases' then
+      begin
+        cases = Desk.cases(:since_updated_at => @stored_time, :page => page, :per_page => @per_page)
+        cases.each do |c|
+          get_content(c)
+        end
+        page = page + 1
+      end while cases.total_entries > (@per_page*page)
+    elsif @input_api == 'replies'
+      begin
+        cases = Desk.cases(:since_updated_at => @stored_time, :page => page, :per_page => @per_page)
+        cases.each do |c|
+          Desk.case_replies(c.id).each do |r|
+            r[:case_id] = c.id
+            get_content(r) if c.count > 0
+          end
+        end
+        page = page + 1
+      end while cases.total_entries > (@per_page*page)
+    end
+    save_store_file unless !@store_file
+  rescue => e
+    $log.error "deskcom run: #{e.message}"
+  end
+
+  def get_content(status)
+    case @output_format
+    when 'simple'
+      record = Hash.new
+      status.each_pair do |k,v|
+        # @stored_time <= store data's updated time < @started_time
+        if (k == 'updated_at') then
+          at_time = Time.parse(v).to_i
+          if (at_time >= @started_time) || (at_time < @stored_time) then
+            next
+          end
+        end
+
+        if (!@time_column.nil? && k == "#{@time_column}") then
+          @time_value = Time.parse(v).to_i rescue nil
+        end
+
+        if (k == '_links') then
+          next
+        end
+
+        if v.kind_of? Hashie::Deash then
+          record.store(k, v.to_json)
+        else
+          record.store(k, v)
+        end
+      end
+    end
+
+    if !@time_value.nil? then
+      Engine.emit(@tag, @time_value, record)
+    else
+      Engine.emit(@tag, @started_time,  record)
+    end
+  rescue => e
+    $log.error "deskcom get_content: #{e.message}"
+  end
+
+  # => int
+  def load_store_file
+    begin
+      f = Pathname.new(@store_file)
+      stored_time = 0
+      f.open('r') do |f|
+        stored = YAML.load_file(f)
+        stored_time = stored[:time].to_i
+      end
+      $log.info "deskcom: Load #{@store_file}: #{@stored_time}"
+    rescue => e
+      $log.warn "deskcom: Can't load store_file #{e.message}"
+      return 0
+    end
+    return stored_time
+  end
+
+  def save_store_file
+    begin
+      f = Pathname.new(@store_file)
+      f.open('w') do |f|
+        data = {:time => @started_time}
+        YAML.dump(data, f)
+      end
+      $log.info "deskcom: Save started_time: #{@started_time} to #{@store_file}"
+    rescue => e
+      $log.warn "deskcom: Can't save store_file #{e.message}"
+    end
+  end
+
+end
+end

data/test/helper.rb

@@ -0,0 +1,28 @@
+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'
+
+$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/in_deskcom'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_in_deskcom.rb

@@ -0,0 +1,41 @@
+require 'helper'
+
+class DeskcomInputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+  CONFIG = %[
+    subdomain           SUBDOMAIN
+    consumer_key        CONSUMER_KEY
+    consumer_secret     CONSUMER_SECRET
+    oauth_token         OAUTH_TOKEN
+    oauth_token_secret  OAUTH_TOKEN_SECRET
+    store_file          /tmp/pos.yml
+    output_format       simple
+    input_api           cases
+    tag                 deskcom.cases
+  ]
+
+  def create_driver(conf=CONFIG, tag='test', use_v1=false)
+    Fluent::Test::InputTestDriver.new(Fluent::DeskcomInput).configure(conf, use_v1)
+  end
+
+  def test_configure
+    d = create_driver
+
+    assert_equal 'SUBDOMAIN',           d.instance.subdomain
+    assert_equal 'CONSUMER_KEY',        d.instance.consumer_key
+    assert_equal 'CONSUMER_SECRET',     d.instance.consumer_secret
+    assert_equal 'OAUTH_TOKEN',         d.instance.oauth_token
+    assert_equal 'OAUTH_TOKEN_SECRET',  d.instance.oauth_token_secret
+    assert_equal '/tmp/pos.yml',        d.instance.store_file
+    assert_equal 'simple',              d.instance.output_format
+    assert_equal 'cases',               d.instance.input_api
+    assert_equal 'deskcom.cases',       d.instance.tag
+  end
+
+  def test_get_content
+    # TO DO: write actual code
+  end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-deskcom
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Toru Takahashi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-02 00:00:00.000000000 Z
+dependencies:
+- !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: 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'
+- !ruby/object:Gem::Dependency
+  name: desk
+  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 Input plugin to collect data from Deskcom.
+email:
+- torutakahashi.ayashi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-deskcom.gemspec
+- lib/fluent/plugin/in_deskcom.rb
+- test/helper.rb
+- test/plugin/test_in_deskcom.rb
+homepage: https://github.com/toru-takahashi/fluent-plugin-deskcom
+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.14
+signing_key: 
+specification_version: 4
+summary: Input plugin to collect data from Deskcom.
+test_files:
+- test/helper.rb
+- test/plugin/test_in_deskcom.rb