fluent-plugin-sendgrid-event 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: af4ed2dd208e0d2ee36d2a06ff960dd1456cc82d
+  data.tar.gz: db3a6d8ce63603e354f3248168f8f0214170f1c1
+SHA512:
+  metadata.gz: b9d8efaf4a385570a44231b0a244a21d3aaa94e23637a19acc58e511e365b8d0e5e605345fb3b23a7a01d222fe7e75f3fd4db2357c6c027a039d13f3899b1f09
+  data.tar.gz: 89a2bb97ba30d6dec52de424e5b80dbf31bdd0a2e11ffa73539389189b48be9250c41834076803bdbec3e06b3dd094ecad909f2f3dc029ddf34020aa47dc813d

data/.gitignore

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,47 @@
+# fluent-plugin-sendgrid-event
+
+Fluentd input plugin to receive sendgrid event.
+
+SendGrid is a delivering email platform.  Please visit below link for the specification of event webhook.
+https://sendgrid.com/docs/API_Reference/Webhooks/event.html
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fluent-plugin-sendgrid-event'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fluent-plugin-sendgrid-event
+
+## Usage
+
+The following is an example of configuration.
+
+```
+<source>
+  type sendgrid_event
+  host 127.0.0.1
+  port 9191
+  tag sendgrid
+</source>
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/hiroakis/fluent-plugin-sendgrid-event/fork )
+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
+
+## License
+
+MIT

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-sendgrid-event.gemspec

@@ -0,0 +1,25 @@
+# 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-sendgrid-event"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Hiroaki Sano"]
+  spec.email         = ["hiroaki.sano.9stories@gmail.com"]
+
+  spec.summary       = %q{Fluent input plugin to receive sendgrid event.}
+  spec.homepage      = "https://github.com/hiroakis/fluent-plugin-sendgrid-event"
+  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.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "test-unit"
+
+  spec.add_runtime_dependency "fluentd"
+end

data/lib/fluent/plugin/in_sendgrid_event.rb

@@ -0,0 +1,83 @@
+module Fluent
+  class SendGridEventInput < Input
+    Plugin.register_input('sendgrid_event', self)
+
+    config_param :tag, :string, :default => nil
+    config_param :host, :string, :default => "0.0.0.0"
+    config_param :port, :integer, :default => 9191
+    config_param :request_uri, :string, :default => "/"
+
+    unless method_defined?(:log)
+      define_method("log") { $log }
+    end
+
+    def initialize
+      super
+    end
+
+    def configure(conf)
+      log.trace "in_sendgrid_event: configure"
+      super
+
+      if @tag.nil?
+        raise Fluent::ConfigError, "sendgrid_event: 'tag' parameter is required"
+      end
+    end
+
+    def start
+      log.trace "in_sendgrid_event: start"
+      super
+
+      @thread = Thread.new(&method(:run))
+    end
+
+    def shutdown
+      log.trace "in_sendgrid_event: shutdown"
+      super
+
+      @server.shutdown
+      Thread.kill(@thread)
+    end
+
+    def run
+      log.trace "in_sendgrid_event: run"
+      listen = {
+        :BindAddress => @host,
+        :Port => @port
+      }
+
+      @server = WEBrick::HTTPServer.new(listen)
+      @server.mount_proc(@request_uri) do |req, res|
+        begin
+          if req.request_method == "POST" && req.body
+            events = JSON.parse(req.body)
+            events.each do |event|
+              emit_event(event)
+            end
+            log.trace "in_sendgrid_event: success"
+            res.status = 200
+          else
+            log.error "in_sendgrid_event: invalid request"
+            res.status = 400
+          end
+        rescue JSON::ParserError => e
+          log.error "in_sendgrid_event: #{e}"
+          res.status = 400
+        rescue WEBrick::HTTPStatus::LengthRequired => e
+          log.error "in_sendgrid_event: #{e}"
+          res.status = 411
+        rescue Exception => e
+          log.warn "in_sendgrid_event: Retry: Reason: #{e}"
+          log.warn "#{e.backtrace.join('\n')}"
+          res.status = 503
+        end
+      end
+      @server.start
+    end # The end of run method
+
+    def emit_event(event)
+      log.trace "in_sendgrid_event: emit_event"
+      Engine.emit("#{tag}", Engine.now, event)
+    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_sendgrid_event'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_in_sendgrid_event.rb

@@ -0,0 +1,134 @@
+require 'helper'
+
+class SendGridEventTest < Test::Unit::TestCase
+
+  def setup
+    Fluent::Test.setup
+  end
+
+  CONFIG = %[
+    type sendgrid_event
+    host 127.0.0.1
+    port 9191
+    tag sendgrid.event
+  ]
+
+  def create_driver(conf=CONFIG, tag='test')
+    Fluent::Test::OutputTestDriver.new(Fluent::SendGridEventInput, tag).configure(conf)
+  end
+
+  def test_configuration
+    d = create_driver
+    assert_equal '127.0.0.1', d.instance.host
+    assert_equal 9191, d.instance.port
+    assert_equal 'sendgrid.event', d.instance.tag
+  end
+
+  def test_configuration_with_empty_tag
+    assert_raise(Fluent::ConfigError) {
+      create_driver %[
+        type sendgrid_event
+        host 127.0.0.1
+        port 9191
+        # tag sendgrid.event
+      ]
+    }
+  end
+
+  # This data is from https://sendgrid.com/docs/API_Reference/Webhooks/event.html
+  def valid_event_json
+    [
+      {
+        "sg_message_id":"sendgrid_internal_message_id",
+        "email": "john.doe@sendgrid.com",
+        "timestamp": 1337197600,
+        "smtp-id": "<4FB4041F.6080505@sendgrid.com>",
+        "event": "processed"
+      },
+      {
+        "sg_message_id":"sendgrid_internal_message_id",
+        "email": "john.doe@sendgrid.com",
+        "timestamp": 1337966815,
+        "category": "newuser",
+        "event": "click",
+        "url": "https://sendgrid.com"
+      },
+      {
+        "sg_message_id":"sendgrid_internal_message_id",
+        "email": "john.doe@sendgrid.com",
+        "timestamp": 1337969592,
+        "smtp-id": "<20120525181309.C1A9B40405B3@Example-Mac.local>",
+        "event": "group_unsubscribe",
+        "asm_group_id": 42
+      }
+    ].to_json
+  end
+
+  def invalid_event_json
+    valid_event_json.gsub!(":", ";")
+  end
+
+  def send_event(post_data)
+    require 'net/http'
+    http = Net::HTTP.new("localhost", 9191)
+    req = Net::HTTP::Post.new('/')
+    req.body = post_data
+    req["Content-Type"] = "application/json"
+    res = http.request(req)
+    res
+  end
+
+  def test_with_valid_event_json
+    d = create_driver %[
+      type sendgrid_event
+      host 127.0.0.1
+      port 9191
+      tag sendgrid.event
+    ]
+
+    d.run do
+      res = send_event(valid_event_json)
+      assert_equal("200", res.code)
+    end
+
+    assert_equal(3, d.emits.size)
+
+    assert_equal("sendgrid.event",                  d.emits[0][0])
+    assert_equal("sendgrid_internal_message_id",    d.emits[0][2]["sg_message_id"])
+    assert_equal("john.doe@sendgrid.com",           d.emits[0][2]["email"])
+    assert_equal(1337197600,                        d.emits[0][2]["timestamp"])
+    assert_equal("<4FB4041F.6080505@sendgrid.com>", d.emits[0][2]["smtp-id"])
+    assert_equal("processed",                       d.emits[0][2]["event"])
+
+    assert_equal("sendgrid.event",               d.emits[1][0])
+    assert_equal("sendgrid_internal_message_id", d.emits[1][2]["sg_message_id"])
+    assert_equal("john.doe@sendgrid.com",        d.emits[1][2]["email"])
+    assert_equal(1337966815,                     d.emits[1][2]["timestamp"])
+    assert_equal("newuser",                      d.emits[1][2]["category"])
+    assert_equal("click",                        d.emits[1][2]["event"])
+    assert_equal("https://sendgrid.com",         d.emits[1][2]["url"])
+
+    assert_equal("sendgrid.event",                                  d.emits[2][0])
+    assert_equal("sendgrid_internal_message_id",                    d.emits[2][2]["sg_message_id"])
+    assert_equal("john.doe@sendgrid.com",                           d.emits[2][2]["email"])
+    assert_equal(1337969592,                                        d.emits[2][2]["timestamp"])
+    assert_equal("<20120525181309.C1A9B40405B3@Example-Mac.local>", d.emits[2][2]["smtp-id"])
+    assert_equal("group_unsubscribe",                               d.emits[2][2]["event"])
+    assert_equal(42,                                                d.emits[2][2]["asm_group_id"])
+  end
+
+  def test_invalid_event_json
+    d = create_driver %[
+      type sendgrid_event
+      host 127.0.0.1
+      port 9191
+      tag sendgrid.event
+    ]
+
+    d.run do
+      res = send_event(invalid_event_json)
+      assert_equal("400", res.code)
+    end
+    assert_equal(0, d.emits.size)
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-sendgrid-event
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Hiroaki Sano
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: 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'
+- !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: 
+email:
+- hiroaki.sano.9stories@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- fluent-plugin-sendgrid-event.gemspec
+- lib/fluent/plugin/in_sendgrid_event.rb
+- test/helper.rb
+- test/plugin/test_in_sendgrid_event.rb
+homepage: https://github.com/hiroakis/fluent-plugin-sendgrid-event
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Fluent input plugin to receive sendgrid event.
+test_files:
+- test/helper.rb
+- test/plugin/test_in_sendgrid_event.rb