nautilfer 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0345f886d7a3add841aab8d2ba2557232461dea43a39cbe383aef7841a380dbe
-  data.tar.gz: 03d7133181c366fcbe8b38eb3c25e029c61bc65ab4f7c6657b122c8ee118e97e
+  metadata.gz: a67099350daf4531189ba0b87dc460a10cc26094677b7bcb218bd82e4f40f8e2
+  data.tar.gz: 33815f57747fc024a5d9035342e31a6766af2170a1067cc5aea2bd6b38b3eac5
 SHA512:
-  metadata.gz: cd254576c3fa630717153bf93008f2534b27ac2384e87f37034fca3212f3bdb94f8c00b5bb0de0cff69bdbccd5d46711bd360dfeb2b4ae5ea8828a7a7c643e39
-  data.tar.gz: ffe47507667a0bc83389db74d1599e61b8b276a6c8ca09fc67a680e3c458fe07beb460c95c598d8a97eaf5840575f1c81dc55bf0b2bf91af3bdc4f3dfd4a6c82
+  metadata.gz: '065369f4809851f0b8b2e3e592db61ff83287348a5269e75d202d38da311ce6533c4d1ce4e7afcf2742b3d4d2adb9e17c4de99d164b83eb1cdc5ba886726c8a2'
+  data.tar.gz: 05b2f7472395f241a2ff91a520abf10915ca548751282b11b1374e2437d8da6aec3d47e9eb9944c939d9f206d34ec2b149f54bab7999465830fb7191c7ca3ad6

data/README.md

@@ -107,6 +107,27 @@ notifier = Nautilfer.new(endpoint: "#{workflow_endpoint}", adapter: :teams)
 notifier.notify("Deployment finished")
 ```
 
+### Configure message templates
+
+Define reusable message templates in the global configuration and select them when instantiating a notifier. Templates are callables that receive the original message and return the formatted text.
+
+```ruby
+Nautilfer.configure do |config|
+  config.message_templates = {
+    default: ->(message) { "[default] #{message}" },
+    headline: ->(message) { "## #{message}" }
+  }
+
+  config.default_message_template = :default
+end
+
+notifier = Nautilfer.new(endpoint: "#{workflow_endpoint}", adapter: :slack)
+notifier.notify("Deployment finished") # => sends "[default] Deployment finished"
+
+headline_notifier = Nautilfer.new(endpoint: "#{workflow_endpoint}", adapter: :slack, message_template: :headline)
+headline_notifier.notify("Deployment finished") # => sends "## Deployment finished"
+```
+
 ## Chatwork Notification Integration
 
 To enable Chatwork notifications using the unified adapter interface, initialize `Nautilfer` with the Chatwork adapter and tar

data/lib/nautilfer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Nautilfer
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

data/lib/nautilfer.rb

@@ -13,11 +13,13 @@ class Nautilfer
   class Error < StandardError; end
 
   class Configuration
-    attr_accessor :environment, :enabled_environments, :disabled_environments
+    attr_accessor :environment, :enabled_environments, :disabled_environments, :message_templates, :default_message_template
 
     def initialize
       @enabled_environments = []
       @disabled_environments = []
+      @message_templates = { default: ->(message) { message } }
+      @default_message_template = :default
     end
   end
 
@@ -33,7 +35,7 @@ class Nautilfer
     @configuration = Configuration.new
   end
 
-  def initialize(endpoint:, adapter: Adapters::Teams.new, environment: nil, enabled_environments: nil, disabled_environments: nil)
+  def initialize(endpoint:, adapter: Adapters::Teams.new, environment: nil, enabled_environments: nil, disabled_environments: nil, message_template: nil)
     config = self.class.configuration
 
     @endpoint = URI.parse(endpoint)
@@ -41,6 +43,7 @@ class Nautilfer
     @environment = environment || config.environment || ENV['NAUTILFER_ENV'] || ENV['RAILS_ENV'] || ENV['RACK_ENV']
     @enabled_environments = normalize_env_list(enabled_environments, config.enabled_environments)
     @disabled_environments = normalize_env_list(disabled_environments, config.disabled_environments)
+    @message_template = resolve_message_template(message_template, config)
   end
 
   def notify(message)
@@ -52,7 +55,7 @@ class Nautilfer
 
   private
 
-  attr_reader :endpoint, :adapter, :environment, :enabled_environments, :disabled_environments
+  attr_reader :endpoint, :adapter, :environment, :enabled_environments, :disabled_environments, :message_template
 
   def resolve_adapter(adapter)
     resolved_adapter =
@@ -99,7 +102,28 @@ class Nautilfer
   end
 
   def build_payload(message)
-    [adapter.payload(message), adapter.headers]
+    [adapter.payload(apply_message_template(message)), adapter.headers]
+  end
+
+  def resolve_message_template(template_key, config)
+    return validate_message_template!(template_key) if template_key.respond_to?(:call)
+
+    key = template_key || config.default_message_template
+    resolved = config.message_templates[key]
+    resolved ||= config.message_templates[key.to_sym] if key.respond_to?(:to_sym)
+    raise Error, "Unknown message template: #{key}" unless resolved
+
+    validate_message_template!(resolved)
+  end
+
+  def validate_message_template!(template)
+    return template if template.respond_to?(:call)
+
+    raise Error, "Unsupported message template: #{template.inspect}"
+  end
+
+  def apply_message_template(message)
+    message_template.call(message)
   end
 
   def perform_request(payload, headers)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nautilfer
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Yusuke Abe