Merge pull request #11 from HatsuneMiku3939/feature/request-method

add support of request method

Author: HatsuneMiku3939

README.md

@@ -34,6 +34,8 @@ $ bundle
 
 ## Example
 
+You can found more examples in `test/plugin/test_in_http_pull.rb`
+
 ### Monitoring http status code only
 ```
 <source>
@@ -133,7 +135,17 @@ for more detail.
 
 ### status_only (bool) (optional, default: false)
 
-If status_only is true, body is not parsed.
+If `status_only` is true, body is not parsed.
+
+### http_method (enum) (optional, default: :get)
+
+The http request method for each requests. Avaliable options are listed below.
+
+* `get`
+* `post`
+* `delete`
+
+If `status_only` is true, `http_method` was override to `head`
 
 ### timeout (time) (optional, default: 10s)
 
@@ -151,6 +163,14 @@ The user for basic auth
 
 The password for basic auth
 
+### response_header (section) (optional, default: nil)
+
+The name of response header for capture.
+
+### request_header (section) (optional, default: nil)
+
+The name, value pair of custom reuqest header.
+
 ## In case of remote error
 
 ### Can receive response from remote

fluent-plugin-http-pull.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name    = "fluent-plugin-http-pull"
-  spec.version = "0.5.0"
+  spec.version = "0.6.0"
   spec.authors = ["filepang"]
   spec.email   = ["[email protected]"]
 

lib/fluent/plugin/in_http_pull.rb

@@ -20,7 +20,6 @@ module Fluent
   module Plugin
     class HttpPullInput < Fluent::Plugin::Input
       Fluent::Plugin.register_input("http_pull", self)
-
       helpers :timer, :parser, :compat_parameters
 
       def initialize
@@ -29,19 +28,28 @@ def initialize
 
       desc 'The tag of the event.'
       config_param :tag, :string
+
       desc 'The url of monitoring target'
       config_param :url, :string
+
       desc 'The interval time between periodic request'
       config_param :interval, :time
+
       desc 'status_only'
       config_param :status_only, :bool, default: false
-      desc 'The timeout stime of each request'
+
+      desc 'The http method for each request'
+      config_param :http_method, :enum, list: [:get, :post, :delete], default: :get
+
+      desc 'The timeout second of each request'
       config_param :timeout, :time, default: 10
+
       desc 'The HTTP proxy URL to use for each requests'
       config_param :proxy, :string, default: nil
 
       desc 'user of basic auth'
       config_param :user, :string, default: nil
+
       desc 'password of basic auth'
       config_param :password, :string, default: nil
 
@@ -69,6 +77,8 @@ def configure(conf)
 
           [header.to_sym, value]
         end.to_h
+
+        @http_method = :head if @status_only
       end
 
       def start
@@ -81,7 +91,7 @@ def on_timer
         record = { "url" => @url }
 
         begin
-          request_options = { method: :get, url: @url, timeout: @timeout }
+          request_options = { method: @http_method, url: @url, timeout: @timeout }
 
           request_options[:proxy] = @proxy if @proxy
           request_options[:user] = @user if @user

test/helper/stub_server.rb

@@ -1,5 +1,17 @@
 require 'webrick'
 
+class DeleteService < WEBrick::HTTPServlet::AbstractServlet
+  def service(req, res)
+    if req.request_method != "DELETE"
+      res.status = 405
+    else
+      res.status = 200
+      res['Content-Type'] = 'application/json'
+      res.body = '{ "status": "OK" }'
+    end
+  end
+end
+
 class StubServer
   def initialize
     create_server
@@ -12,6 +24,9 @@ def initialize
     @server.mount_proc '/redirect', &method(:redirect)
     @server.mount_proc '/protected', &method(:protected)
     @server.mount_proc '/custom_header', &method(:custom_header)
+
+    @server.mount_proc '/method_post', &method(:method_post)
+    @server.mount '/method_delete', DeleteService
   end
 
   def start
@@ -90,4 +105,15 @@ def custom_header(req, res)
     res['Content-Type'] = 'application/json'
     res.body = '{ "status": "OK" }'
   end
+
+  def method_post(req, res)
+    if req.request_method != "POST"
+      res.status = 405
+    else
+      res.status = 200
+      res['Content-Type'] = 'application/json'
+      res.body = '{ "status": "OK" }'
+    end
+  end
 end
+

test/plugin/test_in_http_pull.rb

@@ -58,6 +58,13 @@ class HttpPullInputTest < Test::Unit::TestCase
 
       assert_equal(nil, d.instance.proxy)
     end
+
+    test 'http_method' do
+      d = create_driver TEST_DEFAULT_VALUE_CONFIG
+      assert_equal("test", d.instance.tag)
+
+      assert_equal(:get, d.instance.http_method)
+    end
   end
 
   sub_test_case "success case" do
@@ -556,6 +563,62 @@ class HttpPullInputTest < Test::Unit::TestCase
     end
   end
 
+  sub_test_case "request method" do
+    TEST_INTERVAL_3_POST = %[
+      tag test
+      url http://127.0.0.1:3939/method_post
+
+      interval 3s
+      format json
+      http_method post
+    ]
+
+    TEST_INTERVAL_3_DELETE = %[
+      tag test
+      url http://127.0.0.1:3939/method_delete
+
+      interval 3s
+      format json
+      http_method delete
+    ]
+
+    test 'interval 3 with :post' do
+      d = create_driver TEST_INTERVAL_3_POST
+      assert_equal("test", d.instance.tag)
+      assert_equal(3, d.instance.interval)
+
+      d.run(timeout: 8) do
+        sleep 7
+      end
+      assert_equal(2, d.events.size)
+
+      d.events.each do |tag, time, record|
+        assert_equal("test", tag)
+
+        assert_equal({"url"=>"http://127.0.0.1:3939/method_post","status"=>200, "message"=>{"status"=>"OK"}}, record)
+        assert(time.is_a?(Fluent::EventTime))
+      end
+    end
+
+    test 'interval 3 with :delete' do
+      d = create_driver TEST_INTERVAL_3_DELETE
+      assert_equal("test", d.instance.tag)
+      assert_equal(3, d.instance.interval)
+
+      d.run(timeout: 8) do
+        sleep 7
+      end
+      assert_equal(2, d.events.size)
+
+      d.events.each do |tag, time, record|
+        assert_equal("test", tag)
+
+        assert_equal({"url"=>"http://127.0.0.1:3939/method_delete","status"=>200, "message"=>{"status"=>"OK"}}, record)
+        assert(time.is_a?(Fluent::EventTime))
+      end
+    end
+  end
+
   private
 
   def create_driver(conf)