fluent-plugin-mail 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3c0ed5964e665422a987c3698d6689c521cb05ae
-  data.tar.gz: c44f585a3b06b52381b74c96cc2a2a835a8ed26c
+  metadata.gz: d9edf6b451d6dd432680716812884d42b96cb2bc
+  data.tar.gz: ad2a991a3c52a084ca35d064748dcf221833d5a0
 SHA512:
-  metadata.gz: 1fcc02a2825ce7515ada10d5fbdcab305d05288a8a08e63632f4316a9bebb41495bd11e9762c7762199ab68d40ca4e4e674ed9e7f81c9f9448da748c03f8316b
-  data.tar.gz: ac92cac11525affb6fd81a07611582f79f025702f52ce223a1c98c8b9c124f0c2c20fdc0419e96561012ef77fe9d0823fa4a576f5946d33b0d594a4e905eb981
+  metadata.gz: 2f441b31252807ee4812f623336ab197bd735505773933b85ae72d4db6b8fc88300b5106c6d41459c0d29d7d8a3dbf12ef0a535eb713bdf6a8f10a719cfba5c1
+  data.tar.gz: 267dfb58de727b25674da456dddea387d3ec76e56edb9247f19ec915720c0655600b12af68f5b945a8ef673c6bcb324f61a7b81a4f98fe3d022a4896279cf71e

data/.gitignore

@@ -16,3 +16,4 @@ test/tmp
 test/version_tmp
 tmp
 vendor/bundle
+.ruby-version

data/.travis.yml

@@ -0,0 +1,8 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.*
+  - 2.2.*
+gemfile:
+  - Gemfile
+  - Gemfile.fluentd.lt.0.12

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+# 0.2.0
+
+Changes:
+
+* Refactoring
+
+Fixes:
+
+* Fix so that `time_locale` option works for time field in mail body
+
+Enhancements:
+
+* Add `localtime` option
+
 # 0.1.2
 
 Enhancement:

data/Gemfile

@@ -1,7 +1,3 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in fluent-plugin-mail.gemspec
 gemspec
-
-
-

data/Gemfile.fluentd.lt.0.12

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+gem 'fluentd', '~> 0.10.43'
+gemspec

data/README.md

@@ -211,6 +211,29 @@ log server("/etc/td-agent/td-agent.conf")
 
 See [CHANGELOG.md](CHANGELOG.md) for more details.
 
+## Development
+
+Run mail server using [mailcatcher](http://mailcatcher.me/) gem as:
+
+```
+$ gem install mailcatcher
+$ mailcactcher
+```
+
+It starts STMP server on localhost:1025, and has Web UI running on localhost:1080.
+
+Run Fluentd as:
+
+```
+$ bundle exec fluentd -c example.conf
+```
+
+Put a message to the Fluentd as:
+
+```
+$ echo '{"message":"This is a test"}' | bundle exec fluent-cat mail.test
+```
+
 ## Copyright
 
 * Copyright

data/example.conf

@@ -0,0 +1,20 @@
+<source>
+  type forward
+</source>
+
+<match mail.test>
+  type mail
+  log_level debug
+  host localhost
+  port 1025
+  from foo@example.com
+  to   bar@example.com
+  bcc  baz@example.com
+  subject this is a test
+  message Hello from out_mail\n[%s] %s
+  message_out_keys time,message
+  time_key time
+  time_locale Asia/Taipei
+  # localtime false
+  time_format %Y-%m-%d %H:%M:%S %z
+</match>

data/fluent-plugin-mail.gemspec

@@ -12,9 +12,10 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = "fluent-plugin-mail"
   gem.require_paths = ["lib"]
-  gem.version       = '0.1.2'
+  gem.version       = '0.2.0'
 
   gem.add_runtime_dependency "fluentd"
   gem.add_runtime_dependency "string-scrub" if RUBY_VERSION.to_f < 2.1
   gem.add_development_dependency "rake"
+  gem.add_development_dependency "test-unit"
 end

data/lib/fluent/plugin/out_mail.rb

@@ -8,26 +8,27 @@ class Fluent::MailOutput < Fluent::Output
     define_method("log") { $log }
   end
 
-  config_param :out_keys, :string, :default => ""
-  config_param :message, :string, :default => nil
-  config_param :message_out_keys, :string, :default => ""
-  config_param :time_key, :string, :default => nil
-  config_param :time_format, :string, :default => nil
-  config_param :tag_key, :string, :default => 'tag'
-  config_param :host, :string
-  config_param :port, :integer, :default => 25
-  config_param :domain, :string, :default => 'localdomain'
-  config_param :user, :string, :default => nil
-  config_param :password, :string, :default => nil
-  config_param :from, :string, :default => 'localhost@localdomain'
-  config_param :to, :string, :default => ''
-  config_param :cc, :string, :default => ''
-  config_param :bcc, :string, :default => ''
-  config_param :subject, :string, :default => 'Fluent::MailOutput plugin'
-  config_param :subject_out_keys, :string, :default => ""
-  config_param :enable_starttls_auto, :bool, :default => false
-  config_param :enable_tls, :bool, :default => false
-  config_param :time_locale, :default => nil
+  config_param :out_keys,             :string,  :default => ""
+  config_param :message,              :string,  :default => nil
+  config_param :message_out_keys,     :string,  :default => ""
+  config_param :time_key,             :string,  :default => nil
+  config_param :tag_key,              :string,  :default => 'tag'
+  config_param :host,                 :string
+  config_param :port,                 :integer, :default => 25
+  config_param :domain,               :string,  :default => 'localdomain'
+  config_param :user,                 :string,  :default => nil
+  config_param :password,             :string,  :default => nil
+  config_param :from,                 :string,  :default => 'localhost@localdomain'
+  config_param :to,                   :string,  :default => ''
+  config_param :cc,                   :string,  :default => ''
+  config_param :bcc,                  :string,  :default => ''
+  config_param :subject,              :string,  :default => 'Fluent::MailOutput plugin'
+  config_param :subject_out_keys,     :string,  :default => ""
+  config_param :enable_starttls_auto, :bool,    :default => false
+  config_param :enable_tls,           :bool,    :default => false
+  config_param :time_format,          :string,  :default => "%F %T %z"
+  config_param :localtime,            :bool,    :default => true
+  config_param :time_locale,                    :default => nil
 
   def initialize
     super
@@ -47,10 +48,16 @@ class Fluent::MailOutput < Fluent::Output
       raise Fluent::ConfigError, "Either 'message' or 'out_keys' must be specifed."
     end
 
-    begin
-      @message % (['1'] * @message_out_keys.length) if @message
-    rescue ArgumentError
-      raise Fluent::ConfigError, "string specifier '%s' of message and message_out_keys specification mismatch"
+    if @message
+      begin
+        @message % (['1'] * @message_out_keys.length)
+      rescue ArgumentError
+        raise Fluent::ConfigError, "string specifier '%s' of message and message_out_keys specification mismatch"
+      end
+      @create_message_proc = Proc.new {|tag, time, record| create_formatted_message(tag, time, record) }
+    else
+      # The default uses the old `key=value` format for old version compatibility
+      @create_message_proc = Proc.new {|tag, time, record| create_key_value_message(tag, time, record) }
     end
 
     begin
@@ -58,22 +65,9 @@ class Fluent::MailOutput < Fluent::Output
     rescue ArgumentError
       raise Fluent::ConfigError, "string specifier '%s' of subject and subject_out_keys specification mismatch"
     end
-
-    if @time_key
-      if @time_format
-        f = @time_format
-        tf = Fluent::TimeFormatter.new(f, @localtime)
-        @time_format_proc = tf.method(:format)
-        @time_parse_proc = Proc.new {|str| Time.strptime(str, f).to_i }
-      else
-        @time_format_proc = Proc.new {|time| time.to_s }
-        @time_parse_proc = Proc.new {|str| str.to_i }
-      end
-    end
   end
 
   def start
-
   end
 
   def shutdown
@@ -84,41 +78,36 @@ class Fluent::MailOutput < Fluent::Output
     subjects = []
 
     es.each {|time,record|
-      if @message
-        messages << create_formatted_message(tag, time, record)
-      else
-        messages << create_key_value_message(tag, time, record)
-      end
+      messages << @create_message_proc.call(tag, time, record)
       subjects << create_formatted_subject(tag, time, record)
     }
 
-    messages.each_with_index do |msg, i|
+    (0...messages.size).each do |i|
+      message = messages[i]
       subject = subjects[i]
       begin
-        res = sendmail(subject, msg)
+        sendmail(subject, message)
       rescue => e
-        log.warn "out_mail: failed to send notice to #{@host}:#{@port}, subject: #{subject}, message: #{msg}, error_class: #{e.class}, error_message: #{e.message}, error_backtrace: #{e.backtrace.first}"
+        log.warn "out_mail: failed to send notice to #{@host}:#{@port}, subject: #{subject}, message: #{message}, " <<
+          "error_class: #{e.class}, error_message: #{e.message}, error_backtrace: #{e.backtrace.first}"
       end
     end
 
     chain.next
   end
 
-  def format(tag, time, record)
-    "#{Time.at(time).strftime('%Y/%m/%d %H:%M:%S')}\t#{tag}\t#{record.to_json}\n"
-  end
-
+  # The old `key=value` format for old version compatibility
   def create_key_value_message(tag, time, record)
     values = []
 
-    @out_keys.each do |key|
+    values << @out_keys.each do |key|
       case key
       when @time_key
-        values << @time_format_proc.call(time)
+        format_time(time, @time_format)
       when @tag_key
-        values << tag
+        tag
       else
-        values << "#{key}: #{record[key].to_s}"
+        "#{key}: #{record[key].to_s}"
       end
     end
 
@@ -131,7 +120,7 @@ class Fluent::MailOutput < Fluent::Output
     values = @message_out_keys.map do |key|
       case key
       when @time_key
-        @time_format_proc.call(time)
+        format_time(time, @time_format)
       when @tag_key
         tag
       else
@@ -143,24 +132,13 @@ class Fluent::MailOutput < Fluent::Output
     with_scrub(message) {|str| str.gsub(/\\n/, "\n") }
   end
 
-  def with_scrub(string)
-    begin
-      return yield(string)
-    rescue ArgumentError => e
-      raise e unless e.message.index("invalid byte sequence in") == 0
-      log.info "out_mail: invalid byte sequence is replaced in #{string}"
-      string.scrub!('?')
-      retry
-    end
-  end
-
   def create_formatted_subject(tag, time, record)
     values = []
 
     values = @subject_out_keys.map do |key|
       case key
       when @time_key
-        @time_format_proc.call(time)
+        format_time(time, @time_format)
       when @tag_key
         tag
       else
@@ -186,16 +164,14 @@ class Fluent::MailOutput < Fluent::Output
     subject = subject.force_encoding('binary')
     body = msg.force_encoding('binary')
 
-    if time_locale
-      date = Time::now.timezone(time_locale)
-    else
-      date = Time::now
-    end
+    # Date: header has timezone, so usually it is not necessary to set locale explicitly
+    # But, for people who would see mail header text directly, the locale information may help something
+    # (for example, they can tell the sender should live in Tokyo if +0900)
+    date = format_time(Time.now, "%a, %d %b %Y %X %z")
 
     mid = sprintf("<%s@%s>", SecureRandom.uuid, SecureRandom.uuid)
-
-    debug_msg = smtp.send_mail(<<EOS, @from, @to.split(/,/), @cc.split(/,/), @bcc.split(/,/))
-Date: #{date.strftime("%a, %d %b %Y %X %z")}
+    content = <<EOF
+Date: #{date}
 From: #{@from}
 To: #{@to}
 Cc: #{@cc}
@@ -206,20 +182,37 @@ Mime-Version: 1.0
 Content-Type: text/plain; charset=utf-8
 
 #{body}
-EOS
-    log.debug "out_mail: email send response: #{debug_msg}"
+EOF
+    response = smtp.send_mail(content, @from, @to.split(/,/), @cc.split(/,/), @bcc.split(/,/))
+    log.debug "out_mail: content: #{content.gsub("\n", "\\n")}"
+    log.debug "out_mail: email send response: #{response.string.chomp}"
     smtp.finish
   end
 
-end
+  def format_time(time, time_format)
+    # Fluentd >= v0.12's TimeFormatter supports timezone, but v0.10 does not
+    if @time_locale
+      with_timezone(@time_locale) { Fluent::TimeFormatter.new(time_format, @localtime).format(time) }
+    else
+      Fluent::TimeFormatter.new(time_format, @localtime).format(time)
+    end
+  end
 
-class Time
-  def timezone(timezone = 'UTC')
-    old = ENV['TZ']
-    utc = self.dup.utc
-    ENV['TZ'] = timezone
-    output = utc.localtime
-    ENV['TZ'] = old
-    output
+  def with_timezone(tz)
+    oldtz, ENV['TZ'] = ENV['TZ'], tz
+    yield
+  ensure
+    ENV['TZ'] = oldtz
+  end
+
+  def with_scrub(string)
+    begin
+      return yield(string)
+    rescue ArgumentError => e
+      raise e unless e.message.index("invalid byte sequence in") == 0
+      log.info "out_mail: invalid byte sequence is replaced in #{string}"
+      string.scrub!('?')
+      retry
+    end
   end
 end

data/test/helper.rb

@@ -1,7 +1,7 @@
 require 'rubygems'
 require 'bundler'
 begin
-  Bundler.setup(:default, :development)
+  Bundler.setup(:default, :test)
 rescue Bundler::BundlerError => e
   $stderr.puts e.message
   $stderr.puts "Run `bundle install` to install missing gems"

data/test/plugin/test_out_mail.rb

@@ -1,4 +1,4 @@
-require 'helper'
+require_relative '../helper'
 
 class MailOutputTest < Test::Unit::TestCase
   def setup

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-mail
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Yuichi UEMURA
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-08 00:00:00.000000000 Z
+date: 2015-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
@@ -39,6 +39,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  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: output plugin for Mail
 email:
 - yuichi.u@gmail.com
@@ -48,11 +62,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
+- Gemfile.fluentd.lt.0.12
 - LICENSE
 - README.md
 - Rakefile
+- example.conf
 - fluent-plugin-mail.gemspec
 - lib/fluent/plugin/out_mail.rb
 - test/helper.rb