fluent-plugin-redmine 0.5.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a91fd3eb7844c4d4b564c7b9e195ba64db4794d0
-  data.tar.gz: 93e74847c269c3d683c840300cc31660b3609d45
+  metadata.gz: f193b8f6fea649e602c652324c244eb11d521eea
+  data.tar.gz: 4633aeb58a38806c7f3221a692184dfbcd2eb512
 SHA512:
-  metadata.gz: 3764f98d7e9909c70524965113d5892952d9a08171f6ac46bfa92dd3aeeaf726fe5a0e5514bc9a73620855e262909e81de0d22b688702bdf4126a101e9f97663
-  data.tar.gz: 5bc9748c211feb0acf4b474cea6e6961d638dfe0168bb4b437b4ddc8df4306ac32a3c6bb6a061c794f8e0261f007047397e9e7def3722e2dcb8df8c24f720e3a
+  metadata.gz: d0a01fcc9fb1e13e446432cef4edd0c601d5fa22a4feb625057bc868f95237ac5a7f09291815faaa3b56215748e817eab1872edf2cb4d955c408bc0546f47712
+  data.tar.gz: b8d76888ac8d943176ceb84b61147135869451983e06b54cfff84da9c9ba8b245b61bf6290d5bf3f0001d66bccfe2d437c3546b7eb6f239fb41b4c012e464da0

data/README.md

@@ -38,12 +38,14 @@ Here is example settings:
 
 and here is optional configuration:
 
-    project_id  myproject              # projectId of redmine
-    category_id 70                     # categoryId of tickets
-    project_id_key key_of_priority_id  # value in record for priorityId
-    category_id_key key_of_category_id # value in record for categoryId
-    tag_key my_ tag                    # 'tag' is used by default
-    debug_http  true                   # set debug_http=true of Net::HTTP module, false is used by default
+    project_id  myproject                         # Redmine project id
+    category_id 70                                # Redmine category id
+    project_id_key key_of_priority_id             # key name if the record for priority id
+    category_id_key key_of_category_id            # key name if the record for category id
+    tag_key my_ tag                               # 'tag' is used by default
+    custom_fields  [{"id":1, "value" "value01"}]  # Redmine custom fields, array of hash with id, value
+    custom_fields_key key_of_custom_fields        # key name if the record for custom fields
+    debug_http  true                              # set debug_http=true of Net::HTTP module, false is used by default
 
 
 ### placeholders

data/fluent-plugin-redmine.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "fluent-plugin-redmine"
-  spec.version       = "0.5.3"
+  spec.version       = "0.6.0"
   spec.authors       = ["Takuma kanari"]
   spec.email         = ["chemtrails.t@gmail.com"]
   spec.summary       = %q{Fluentd output plugin to create ticket in redmine}

data/lib/fluent/plugin/out_redmine.rb

@@ -9,40 +9,46 @@ module Fluent
     end
 
     desc "Redmine url"
-    config_param :url, :string, :default => nil
+    config_param :url, :string, default: nil
 
     desc "Redmine api key"
-    config_param :api_key, :string, :default => nil, :secret => true
+    config_param :api_key, :string, default: nil, secret: true
 
     desc "Key name in the record for tag"
-    config_param :tag_key, :string, :default => "tag"
+    config_param :tag_key, :string, default: "tag"
 
     desc "Redmine project id"
-    config_param :project_id, :string, :default => nil
+    config_param :project_id, :string, default: nil
 
     desc "Redmine category id"
-    config_param :category_id, :integer, :default => nil
+    config_param :category_id, :integer, default: nil
 
     desc "Key name in the record for Redmine category id"
-    config_param :category_id_key, :string, :default => nil
+    config_param :category_id_key, :string, default: nil
 
     desc "Redmine tracker id"
-    config_param :tracker_id, :integer
+    config_param :tracker_id, :integer, default: nil
 
     desc "Redmine priority id"
-    config_param :priority_id, :integer
+    config_param :priority_id, :integer, default: nil
 
     desc "Key name in the record for Redmine priority id"
-    config_param :priority_id_key, :string, :default => nil
+    config_param :priority_id_key, :string, default: nil
 
     desc "Ticket title"
-    config_param :subject, :string, :default => "Fluent::RedmineOutput plugin"
+    config_param :subject, :string, default: "Fluent::RedmineOutput plugin"
 
     desc "Ticket description"
-    config_param :description, :string, :default => ""
+    config_param :description, :string, default: ""
 
     desc "If true, show debug message of http operations"
-    config_param :debug_http, :bool, :default => false
+    config_param :debug_http, :bool, default: false
+
+    desc "Redmine custom fields, array of hash with id, value"
+    config_param :custom_fields, :array, default: []
+
+    desc "Key name in the record for Redmine custom fields"
+    config_param :custom_fields_key, :string, default: nil
 
     def initialize
       super
@@ -123,16 +129,17 @@ module Fluent
     def make_payload(subject, desc, record)
       priority_id = @priority_id_key.nil? ? @priority_id : (record[@priority_id_key] || @priority_id).to_i
       category_id = @category_id_key.nil? ? @category_id : (record[@category_id_key] || @category_id).to_i
-      {
-        :issue => {
-          :project_id => @project_id,
-          :tracker_id => @tracker_id,
-          :priority_id => priority_id,
-          :category_id => category_id,
-          :subject => subject,
-          :description => desc
-        }
+      custom_fields = @custom_fields_key.nil? ? @custom_fields : (record[@custom_fields_key] || [])
+      issue = {
+        project_id: @project_id,
+        category_id: category_id,
+        subject: subject,
+        description: desc
       }
+      issue[:tracker_id] = @tracker_id unless @tracker_id.nil?
+      issue[:priority_id] = priority_id unless priority_id.nil?
+      issue[:custom_fields] = custom_fields unless custom_fields.empty?
+      { issue: issue }
     end
 
     private

data/test/plugin/test_out_redmine.rb

@@ -21,6 +21,28 @@ class RedmineOutputTest < Test::Unit::TestCase
     description this is description %{d1} - %{d2} - %{d3}
   ]
 
+  CONFIG_WITHOUT_TRACKER_ID_AND_PRIORITY_ID = %[
+    type redmine
+    url http://localhost:4000
+    api_key test-api-key
+    tag_key test
+    project_id 1
+    category_id 4
+    subject awesome
+    description this is description %{d1} - %{d2} - %{d3}
+  ]
+
+  CONFIG_WITH_CUSTOM_FIELDS = %[
+    type redmine
+    url http://localhost:4000
+    api_key test-api-key
+    tag_key test
+    project_id 1
+    subject awesome
+    custom_fields [{"id" : 1, "value" : "awesome"}]
+    description this is description %{d1} - %{d2} - %{d3}
+  ]
+
   CONFIG_WITH_PROPERTY_ALIAS_KEYS = %[
     type redmine
     url http://localhost:4000
@@ -32,6 +54,7 @@ class RedmineOutputTest < Test::Unit::TestCase
     category_id 4
     priority_id_key key_of_priority_id
     category_id_key key_of_category_id
+    custom_fields_key key_of_custom_fields
     subject awesome
     description this is description %{d1} - %{d2} - %{d3}
   ]
@@ -149,6 +172,7 @@ class RedmineOutputTest < Test::Unit::TestCase
     assert_nothing_raised { p = create_driver(CONFIG_WITH_PROPERTY_ALIAS_KEYS).instance }
     assert_equal "key_of_priority_id", p.priority_id_key
     assert_equal "key_of_category_id", p.category_id_key
+    assert_equal "key_of_custom_fields", p.custom_fields_key
   end
 
   def test_configure_https
@@ -200,17 +224,49 @@ CONFIG
     assert_equal p.project_id, ret[:issue][:project_id]
     assert_equal p.tracker_id, ret[:issue][:tracker_id]
     assert_equal p.priority_id, ret[:issue][:priority_id]
+    assert_false ret[:issue].key?(:custom_fields)
+  end
+
+  def test_make_payload_with_custom_fields
+    p = create_driver(CONFIG_WITH_CUSTOM_FIELDS).instance
+    record = {
+      "name" => "John",
+      "age" => 25,
+      "message" => "this is message!"
+    }
+    ret = p.make_payload("subject", "description", record)
+    assert_equal 1, ret[:issue][:custom_fields].size
+    assert_equal 1, ret[:issue][:custom_fields].first["id"]
+    assert_equal "awesome", ret[:issue][:custom_fields].first["value"]
+  end
+
+  def test_make_payload_without_tracker_id_and_priority_id
+    p = create_driver(CONFIG_WITHOUT_TRACKER_ID_AND_PRIORITY_ID).instance
+    record = {
+      "name" => "John",
+      "age" => 25,
+      "message" => "this is message!"
+    }
+    ret = p.make_payload("subject", "description", record)
+    assert_equal "subject", ret[:issue][:subject]
+    assert_equal "description", ret[:issue][:description]
+    assert_false ret[:issue].key?(:priority_id)
+    assert_false ret[:issue].key?(:tracker_id)
+    assert_equal p.priority_id, ret[:issue][:priority_id]
   end
 
   def test_make_payload_with_alias_keys
     p = create_driver(CONFIG_WITH_PROPERTY_ALIAS_KEYS).instance
+    custom_fields = [{"id" => 1, "value" => "awesome"}]
     record = {
       "key_of_priority_id" => "123",
-      "key_of_category_id" => "456"
+      "key_of_category_id" => "456",
+      "key_of_custom_fields" => custom_fields
     }
     ret = p.make_payload("subject", "description", record)
     assert_equal 123, ret[:issue][:priority_id]
     assert_equal 456, ret[:issue][:category_id]
+    assert_equal custom_fields, ret[:issue][:custom_fields]
   end
 
   def test_make_payload_with_alias_keys_use_default_ids
@@ -218,6 +274,7 @@ CONFIG
     ret = p.make_payload("subject", "description", {})
     assert_equal 3, ret[:issue][:priority_id]
     assert_equal 4, ret[:issue][:category_id]
+    assert_false ret[:issue].key?(:custom_fields)
   end
 
   def test_emit

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-redmine
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.6.0
 platform: ruby
 authors:
 - Takuma kanari
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-16 00:00:00.000000000 Z
+date: 2017-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd