nautilfer 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f026890d209390f607032ea3ac7f6c30375600b711f2377c3df67b68bbd050e7
-  data.tar.gz: 943ed91b71baaa172ba03f7e861ccf41f65ecdd18ecdeec511cf4d26f0592ad2
+  metadata.gz: 0345f886d7a3add841aab8d2ba2557232461dea43a39cbe383aef7841a380dbe
+  data.tar.gz: 03d7133181c366fcbe8b38eb3c25e029c61bc65ab4f7c6657b122c8ee118e97e
 SHA512:
-  metadata.gz: 580405d5b98669d458560cc4a84abb99501eaed169eebfad4a0a27ff2496055125534379dbc5c144ddd76a30f96d3d17a73605493ccea3a8404d77a36ebcd37e
-  data.tar.gz: 46500be06ccc88b586feddc3cad131bbe5ea9701be8df3a4ff67f9ad73d7b12dab6c1b8eeea9ee1bc51a654586f1dddd17aca9378aa8d7ab7e5de781889ff744
+  metadata.gz: cd254576c3fa630717153bf93008f2534b27ac2384e87f37034fca3212f3bdb94f8c00b5bb0de0cff69bdbccd5d46711bd360dfeb2b4ae5ea8828a7a7c643e39
+  data.tar.gz: ffe47507667a0bc83389db74d1599e61b8b276a6c8ca09fc67a680e3c458fe07beb460c95c598d8a97eaf5840575f1c81dc55bf0b2bf91af3bdc4f3dfd4a6c82

data/AGENTS.md

@@ -4,3 +4,4 @@
 - Every change must include appropriate updates to the test suite (add or modify specs as needed).
 - Update the README if necessary to reflect your changes.
 - All instructions in this file are written in English and should be followed as written.
+- `Gemfile.lock` is intentionally omitted from the repository; do not add or commit it.

data/README.md

@@ -50,27 +50,17 @@ To use nautilfer, first require it.
 require 'nautilfer'
 ```
 
-Then, you can easily parse and extract information from a web page like this:
+Instantiate Nautilfer with the adapter you want to use:
 
 ```ruby
-Nautilfer.to_teams(message: "## TEST\nhello", endpoint: "#{workflow_endpoint}")
-```
-
-Or instantiate Nautilfer directly when you want to reuse the same endpoint:
-
-```ruby
-notifier = Nautilfer.new(endpoint: "#{workflow_endpoint}", adapter: :teams)
+notifier = Nautilfer.new(endpoint: "#{workflow_endpoint}", adapter: Nautilfer::Adapters::Teams.new)
 notifier.notify("## TEST\nhello")
 ```
 
 To notify a Slack channel via Incoming Webhook:
 
 ```ruby
-Nautilfer.to_slack(message: "Deployment completed", endpoint: "#{slack_webhook_url}")
-```
-
-```ruby
-slack_notifier = Nautilfer.new(endpoint: "#{slack_webhook_url}", adapter: :slack)
+slack_notifier = Nautilfer.new(endpoint: "#{slack_webhook_url}", adapter: Nautilfer::Adapters::Slack.new)
 slack_notifier.notify("Deployment completed")
 ```
 
@@ -81,28 +71,30 @@ Use the environment controls to avoid sending notifications in non-production en
 Enable notifications only in specific environments:
 
 ```ruby
-Nautilfer.to_teams(
-  message: "Release deployed",
+notifier = Nautilfer.new(
   endpoint: "#{workflow_endpoint}",
+  adapter: Nautilfer::Adapters::Teams.new,
   environment: 'production',
   enabled_environments: ['production']
 )
+notifier.notify("Release deployed")
 ```
 
 Or disable notifications for certain environments:
 
 ```ruby
-Nautilfer.to_slack(
-  message: "Smoke tests running",
+slack_notifier = Nautilfer.new(
   endpoint: "#{slack_webhook_url}",
+  adapter: Nautilfer::Adapters::Slack.new,
   environment: 'test',
   disabled_environments: ['test', 'development']
 )
+slack_notifier.notify("Smoke tests running")
 ```
 
 ### Configure defaults once
 
-Persist your environment preferences by configuring defaults up front. New instances and helper calls will reuse these values unless you override them per call.
+Persist your environment preferences by configuring defaults up front. New instances will reuse these values unless you override them per call.
 
 ```ruby
 Nautilfer.configure do |config|
@@ -113,20 +105,24 @@ end
 
 notifier = Nautilfer.new(endpoint: "#{workflow_endpoint}", adapter: :teams)
 notifier.notify("Deployment finished")
-
-# Helpers will also reuse the configured defaults
-Nautilfer.to_slack(message: "Deployment finished", endpoint: "#{slack_webhook_url}")
 ```
 
 ## Chatwork Notification Integration
 
-To enable Chatwork notifications, configure the API token and room ID:
+To enable Chatwork notifications using the unified adapter interface, initialize `Nautilfer` with the Chatwork adapter and tar
+get a room-specific endpoint:
 
 ```ruby
-notifier = Nautilfer::ChatworkNotifier.new('your_api_token', 'your_room_id')
+endpoint = "https://api.chatwork.com/v2/rooms/#{room_id}/messages"
+notifier = Nautilfer.new(
+  endpoint: endpoint,
+  adapter: Nautilfer::Adapters::Chatwork.new(api_token: ENV['CHATWORK_API_TOKEN'])
+)
 notifier.notify('This is a test message from Nautilfer!')
 ```
 
+You can also pass `adapter: :chatwork` when `CHATWORK_API_TOKEN` is set in your environment.
+
 ## Features
 - More features coming soon!
 

data/lib/nautilfer/adapters/base.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+class Nautilfer
+  module Adapters
+    class Base
+      def headers
+        { 'Content-Type' => 'application/json' }
+      end
+
+      def payload(_message)
+        raise NotImplementedError, "Adapters must implement #payload"
+      end
+
+      def body(payload)
+        payload.to_json
+      end
+    end
+  end
+end

data/lib/nautilfer/adapters/chatwork.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+require 'uri'
+
+class Nautilfer
+  module Adapters
+    class Chatwork < Base
+      API_ENDPOINT = "https://api.chatwork.com/v2"
+
+      def initialize(api_token:)
+        @api_token = api_token
+      end
+
+      def headers
+        {
+          'X-ChatWorkToken' => api_token,
+          'Content-Type' => 'application/x-www-form-urlencoded'
+        }
+      end
+
+      def payload(message)
+        { body: message }
+      end
+
+      def body(payload)
+        URI.encode_www_form(payload)
+      end
+
+      private
+
+      attr_reader :api_token
+    end
+  end
+end

data/lib/nautilfer/adapters/slack.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+class Nautilfer
+  module Adapters
+    class Slack < Base
+      def payload(message)
+        {
+          "text": message
+        }
+      end
+    end
+  end
+end

data/lib/nautilfer/adapters/teams.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+class Nautilfer
+  module Adapters
+    class Teams < Base
+      def payload(message)
+        {
+          "attachments": [
+            {
+              "contentType": "application/vnd.microsoft.card.adaptive",
+              "content": {
+                "$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
+                "type": "AdaptiveCard",
+                "version": "1.2",
+                "body": [
+                  {
+                    "type": "TextBlock",
+                    "text": message,
+                    "wrap": true,
+                    "markdown": true
+                  }
+                ]
+              }
+            }
+          ]
+        }
+      end
+    end
+  end
+end

data/lib/nautilfer/version.rb

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

data/lib/nautilfer.rb

@@ -1,6 +1,10 @@
 # frozen_string_literal: true
 
 require_relative "nautilfer/version"
+require_relative "nautilfer/adapters/base"
+require_relative "nautilfer/adapters/teams"
+require_relative "nautilfer/adapters/slack"
+require_relative "nautilfer/adapters/chatwork"
 require "json/add/core"
 require "net/http"
 require "uri"
@@ -29,11 +33,11 @@ class Nautilfer
     @configuration = Configuration.new
   end
 
-  def initialize(endpoint:, adapter: :teams, environment: nil, enabled_environments: nil, disabled_environments: nil)
+  def initialize(endpoint:, adapter: Adapters::Teams.new, environment: nil, enabled_environments: nil, disabled_environments: nil)
     config = self.class.configuration
 
     @endpoint = URI.parse(endpoint)
-    @adapter = adapter
+    @adapter = resolve_adapter(adapter)
     @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)
@@ -46,29 +50,42 @@ class Nautilfer
     perform_request(payload, headers)
   end
 
-  def self.to_teams(message:, endpoint:, environment: nil, enabled_environments: nil, disabled_environments: nil)
-    new(
-      endpoint: endpoint,
-      adapter: :teams,
-      environment: environment,
-      enabled_environments: enabled_environments,
-      disabled_environments: disabled_environments
-    ).notify(message)
+  private
+
+  attr_reader :endpoint, :adapter, :environment, :enabled_environments, :disabled_environments
+
+  def resolve_adapter(adapter)
+    resolved_adapter =
+      case adapter
+      when Symbol
+        adapter_from_symbol(adapter)
+      when Class
+        adapter.new
+      else
+        adapter
+      end
+
+    validate_adapter!(resolved_adapter)
   end
 
-  def self.to_slack(message:, endpoint:, environment: nil, enabled_environments: nil, disabled_environments: nil)
-    new(
-      endpoint: endpoint,
-      adapter: :slack,
-      environment: environment,
-      enabled_environments: enabled_environments,
-      disabled_environments: disabled_environments
-    ).notify(message)
+  def adapter_from_symbol(adapter)
+    case adapter
+    when :teams
+      Adapters::Teams.new
+    when :slack
+      Adapters::Slack.new
+    when :chatwork
+      Adapters::Chatwork.new(api_token: ENV.fetch('CHATWORK_API_TOKEN') { raise Error, 'CHATWORK_API_TOKEN is required for chatwork adapter' })
+    else
+      raise Error, "Unsupported adapter: #{adapter}"
+    end
   end
 
-  private
+  def validate_adapter!(adapter)
+    return adapter if adapter.respond_to?(:payload) && adapter.respond_to?(:headers) && adapter.respond_to?(:body)
 
-  attr_reader :endpoint, :adapter, :environment, :enabled_environments, :disabled_environments
+    raise Error, "Unsupported adapter: #{adapter.inspect}"
+  end
 
   def normalize_env_list(custom_value, configured_value)
     Array(custom_value.nil? ? configured_value : custom_value).compact
@@ -82,18 +99,7 @@ class Nautilfer
   end
 
   def build_payload(message)
-    case adapter
-    when :teams
-      [teams_payload(message), default_headers]
-    when :slack
-      [slack_payload(message), default_headers]
-    else
-      raise Error, "Unsupported adapter: #{adapter}"
-    end
-  end
-
-  def default_headers
-    { 'Content-Type' => 'application/json' }
+    [adapter.payload(message), adapter.headers]
   end
 
   def perform_request(payload, headers)
@@ -101,37 +107,8 @@ class Nautilfer
     http.use_ssl = endpoint.scheme == 'https'
     http.start do |connection|
       request = Net::HTTP::Post.new(endpoint.request_uri, headers)
-      request.body = payload.to_json
+      request.body = adapter.body(payload)
       connection.request(request)
     end
   end
-
-  def teams_payload(message)
-    {
-      "attachments": [
-        {
-          "contentType": "application/vnd.microsoft.card.adaptive",
-          "content": {
-            "$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
-            "type": "AdaptiveCard",
-            "version": "1.2",
-            "body": [
-              {
-                "type": "TextBlock",
-                "text": message,
-                "wrap": true,
-                "markdown": true
-              }
-            ]
-          }
-        }
-      ]
-    }
-  end
-
-  def slack_payload(message)
-    {
-      "text": message
-    }
-  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nautilfer
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Yusuke Abe
@@ -28,7 +28,10 @@ files:
 - Rakefile
 - compose.yml
 - lib/nautilfer.rb
-- lib/nautilfer/chatwork_notifier.rb
+- lib/nautilfer/adapters/base.rb
+- lib/nautilfer/adapters/chatwork.rb
+- lib/nautilfer/adapters/slack.rb
+- lib/nautilfer/adapters/teams.rb
 - lib/nautilfer/version.rb
 homepage: https://github.com/slidict/nautilfer
 licenses:

data/lib/nautilfer/chatwork_notifier.rb

@@ -1,29 +0,0 @@
-require 'net/http'
-require 'uri'
-require 'json'
-
-class Nautilfer
-  class ChatworkNotifier
-    CHATWORK_API_ENDPOINT = "https://api.chatwork.com/v2"
-
-    def initialize(api_token, room_id)
-      @api_token = api_token
-      @room_id = room_id
-    end
-
-    def notify(message)
-      uri = URI("#{CHATWORK_API_ENDPOINT}/rooms/#{@room_id}/messages")
-      request = Net::HTTP::Post.new(uri)
-      request['X-ChatWorkToken'] = @api_token
-      request.set_form_data(body: message)
-
-      response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
-        http.request(request)
-      end
-
-      raise "Failed to send notification: #{response.body}" unless response.is_a?(Net::HTTPSuccess)
-
-      JSON.parse(response.body)
-    end
-  end
-end