automatic 14.12.2 → 26.09

data/plugins/notify/ikachan.rb

@@ -1,87 +1,125 @@
 # -*- coding: utf-8 -*-
+# Name::        Automatic::Plugin::Notify::Ikachan
+# Author:       id774 (More info: https://id774.net)
+# Source Code:: https://github.com/id774/automaticruby
+# License::     The GPL version 3, or LGPL version 3 (Dual License).
+# Contact::     idnanashi@gmail.com
+# Created::     Mar  7, 2012
+# Updated::     Aug 15, 2026
+# Copyright::   Copyright (c) 2012-2026 Automatic Ruby Developers.
+#
+# Description:: Posts each item to an IRC channel through an ikachan
+#               HTTP-to-IRC gateway, which the operator runs themselves.
 
-require 'active_support'
-require 'active_support/core_ext'
-require 'active_support/deprecation'
+require 'net/http'
+require 'uri'
 
 module Automatic::Plugin
   class Ikachan
-    require 'rubygems'
-    require 'time'
-    require 'net/http'
-    require 'uri'
+    OPEN_TIMEOUT = 10
+    READ_TIMEOUT = 30
 
     attr_accessor :params
 
     def initialize
-      @params = {
-        "url"      => "",
-        "port"     => "",
-        "channels" => [],
-        "command"  => "",
-      }
+      @params = { 'url' => '', 'port' => '', 'channels' => [], 'command' => '' }
     end
 
-    def post(link, title = "")
-      message     = build_message(link, title)
-      uri         = URI.parse(endpoint_url)
-      proxy_class = Net::HTTP::Proxy(ENV["PROXY"], 8080)
-      http        = proxy_class.new(uri.host, uri.port)
-      http.start do |http|
-        @params['channels'].split(",").each do|channel|
-          # send join command to make sure when if ikachan is not in the channel
-          http.post("/join", "channel=#{channel}")
-          res = http.post(uri.path, %Q(channel=#{channel}&message=#{message}))
-          if res.code == "200"
-            Automatic::Log.puts(:info, "Success: #{message}")
-          else
-            Automatic::Log.puts(:error, "#{res.code} Error: #{message}")
-          end
+    def post(link, title = '')
+      message = build_message(link, title)
+      uri     = endpoint
+
+      start(uri) do |http|
+        channels.each do |channel|
+          # Join first, in case the gateway is not in the channel.
+          http.request(form('/join', channel: channel))
+          response = http.request(form(uri.path, channel: channel, message: message))
+          log(response, message)
         end
       end
     end
 
     private
 
-    def endpoint_url
-      "#{@params['url']}:#{@params['port']}/#{@params['command']}"
+    # A gateway reached over https is spoken to over https. The earlier
+    # version built a plain connection whatever the URL said.
+    def start(uri, &block)
+      proxy = Net::HTTP.Proxy(ENV.fetch('PROXY', nil), 8080)
+      proxy.start(uri.host, uri.port,
+                  use_ssl: uri.scheme == 'https',
+                  open_timeout: OPEN_TIMEOUT,
+                  read_timeout: READ_TIMEOUT, &block)
+    end
+
+    # Form-encoded by Net::HTTP rather than interpolated into the body, so
+    # that a title carrying an ampersand or a space reaches the channel as it
+    # was written instead of splitting the request.
+    def form(path, params)
+      request = Net::HTTP::Post.new(path)
+      request.set_form_data(params)
+      request
+    end
+
+    def channels
+      value = @params['channels']
+      value.is_a?(Array) ? value : value.to_s.split(',')
+    end
+
+    def endpoint
+      URI.parse("#{@params['url']}:#{@params['port']}/#{@params['command']}")
+    end
+
+    def log(response, message)
+      if response.code == '200'
+        Automatic::Log.puts(:info, "Success: #{message}")
+      else
+        Automatic::Log.puts(:error, "#{response.code} Error: #{message}")
+      end
     end
 
     def build_message(link, title)
-      message = ""
-      message += "#{title.to_s} - " unless title.blank?
-      message += link.to_s
-      message
+      message = ''
+      message += "#{title} - " unless title.nil? || title.to_s.empty?
+      message + link.to_s
     end
   end
 
   class NotifyIkachan
     attr_accessor :ikachan
 
-    def initialize(config, pipeline=[])
-      @config   = config
+    def initialize(config, pipeline = [])
+      @config   = config || {}
       @pipeline = pipeline
 
       @ikachan = Ikachan.new
       @ikachan.params = {
-        "url"      => @config['url'],
-        "port"     => @config['port'] || "4979",
-        "channels" => @config['channels'].split(',').map{ |v| v.match(/^#/) ? v : "#" + v }, # Prifixing '#'
-        "command"  => @config['command'] || "notice",
+        'url'      => @config['url'],
+        'port'     => @config['port'] || '4979',
+        'channels' => channels,
+        'command'  => @config['command'] || 'notice'
       }
     end
 
+    # Returns the pipeline unchanged: a Notify plugin sends a notification and
+    # nothing else.
     def run
-      @pipeline.each {|feeds|
-        unless feeds.nil?
-          feeds.items.each {|feed|
-            Automatic::Log.puts("info", %Q(Ikachan: [#{feed.link}] sending with params #{ikachan.params.to_s}...))
-            ikachan.post(feed.link, feed.title)
-            sleep ||= @config['interval'].to_i
-          }
+      @pipeline.each do |feeds|
+        next if feeds.nil?
+
+        feeds.items.each do |feed|
+          Automatic::Log.puts('info', "Ikachan: [#{feed.link}] sending to #{channels.join(',')}...")
+          ikachan.post(feed.link, feed.title)
+          sleep(@config['interval'].to_i)
         end
-      }
+      end
       @pipeline
     end
+
+    private
+
+    # Comma separated, with a leading '#' added where it is absent.
+    def channels
+      @config['channels'].to_s.split(',').map { |name| name.start_with?('#') ? name : "##{name}" }
+    end
   end
 end

data/plugins/provide/fluentd.rb

@@ -1,37 +1,56 @@
 # -*- coding: utf-8 -*-
-# Name::      Automatic::Plugin::Provide::Fluentd
-# Author::    774 <http://id774.net>
-# Created::   Jul 12, 2013
-# Updated::   May 16, 2014
-# Copyright:: Copyright (c) 2012-2014 Automatic Ruby Developers.
-# License::   Licensed under the GNU GENERAL PUBLIC LICENSE, Version 3.0.
+# Name::        Automatic::Plugin::Provide::Fluentd
+# Author:       id774 (More info: https://id774.net)
+# Source Code:: https://github.com/id774/automaticruby
+# License::     The GPL version 3, or LGPL version 3 (Dual License).
+# Contact::     idnanashi@gmail.com
+# Created::     Jul 12, 2013
+# Updated::     Aug 15, 2026
+# Copyright::   Copyright (c) 2012-2026 Automatic Ruby Developers.
 
 module Automatic::Plugin
   class ProvideFluentd
-    require 'fluent-logger'
+    Automatic.require_optional('fluent-logger', needed_by: 'ProvideFluentd')
 
-    def initialize(config, pipeline=[])
-      @config = config
+    def initialize(config, pipeline = [])
+      @config   = config || {}
       @pipeline = pipeline
-      @mode = @config['mode']
-      @fluentd = Fluent::Logger::FluentLogger.open(nil,
-        host = @config['host'],
-        port = @config['port']) unless @mode == 'test'
+      @mode     = @config['mode']
+      @fluentd  = open_logger unless test?
     end
 
+    # Posts each item's content_encoded to Fluentd, which must be something
+    # Fluentd accepts as a record. Distinct from PublishFluentd, which posts
+    # the item's fields.
     def run
-      @pipeline.each {|feeds|
-        unless feeds.nil?
-          feeds.items.each {|feed|
-            begin
-              @fluentd.post(@config['tag'], feed.content_encoded) unless @mode == 'test'
-            rescue
-              Automatic::Log.puts("error", "Fluent::Logger.post failed, the content_encoded of item may be not kind of Hash.")
-            end
-          }
-        end
-      }
+      @pipeline.each do |feeds|
+        next if feeds.nil?
+
+        feeds.items.each { |feed| post(feed) }
+      end
       @pipeline
     end
+
+    private
+
+    def open_logger
+      Fluent::Logger::FluentLogger.open(nil,
+                                        host: @config['host'],
+                                        port: @config['port'].to_i)
+    end
+
+    def post(feed)
+      return if test?
+
+      @fluentd.post(@config['tag'], feed.content_encoded)
+    rescue StandardError => e
+      Automatic::Log.puts('error',
+                          'Fluent::Logger.post failed, the content_encoded of item may ' \
+                          "be not kind of Hash: #{e.message}")
+    end
+
+    def test?
+      @mode == 'test'
+    end
   end
 end

data/plugins/publish/amazon_s3.rb

@@ -1,58 +1,97 @@
 # -*- coding: utf-8 -*-
-# Name::      Automatic::Plugin::Publish::AmazonS3
-# Author::    774 <http://id774.net>
-# Created::   Feb 24, 2014
-# Updated::   Feb 24, 2014
-# Copyright:: Copyright (c) 2012-2014 Automatic Ruby Developers.
-# License::   Licensed under the GNU GENERAL PUBLIC LICENSE, Version 3.0.
+# Name::        Automatic::Plugin::Publish::AmazonS3
+# Author:       id774 (More info: https://id774.net)
+# Source Code:: https://github.com/id774/automaticruby
+# License::     The GPL version 3, or LGPL version 3 (Dual License).
+# Contact::     idnanashi@gmail.com
+# Created::     Feb 24, 2014
+# Updated::     Sep  9, 2026
+# Copyright::   Copyright (c) 2012-2026 Automatic Ruby Developers.
 
 module Automatic::Plugin
   class PublishAmazonS3
     require 'uri'
-    require 'aws-sdk'
 
-    def initialize(config, pipeline=[])
-      @config = config
+    FILE_URI_ESCAPER = URI::RFC2396_Parser.new
+
+    def initialize(config, pipeline = [])
+      @config   = config || {}
       @pipeline = pipeline
-      s3 = AWS::S3.new(
-        :access_key_id => @config['access_key'],
-        :secret_access_key => @config['secret_key']
-      )
-      @bucket = s3.buckets[@config['bucket_name']]
-      @mode = @config['mode']
+      @mode     = @config['mode']
     end
 
+    # Uploads the files whose link is a file URI, normally after StoreFile.
     def run
-      @pipeline.each {|feeds|
-        unless feeds.nil?
-          feeds.items.each {|feed|
-            unless feed.link.nil?
-              begin
-                uri = URI.parse(feed.link)
-                if uri.scheme == 'file'
-                  upload_amazons3(uri.path, @config['target_path'])
-                else
-                  Automatic::Log.puts("warn", "Skip feed due to uri scheme is not file.")
-                end
-              rescue
-                Automatic::Log.puts("error", "Error detected with #{feed.link} in uploading AmazonS3.")
-              end
-            end
-          }
-        end
-      }
+      @pipeline.each do |feeds|
+        next if feeds.nil?
+
+        feeds.items.each { |feed| publish(feed) }
+      end
       @pipeline
     end
 
     private
 
-    def upload_amazons3(filename, target_path)
-      target = File.join(target_path, File.basename(filename))
-      object = @bucket.objects[target]
-      source = Pathname.new(filename)
-      object.write(source) unless @mode == "test"
-      Automatic::Log.puts("info", "Uploaded: file #{source} to the bucket #{target} on #{@bucket.name}.")
-      return source, target
+    def publish(feed)
+      return if feed.link.nil?
+
+      uri = URI.parse(feed.link)
+      if uri.scheme == 'file'
+        upload(file_path(uri))
+      else
+        Automatic::Log.puts('warn', 'Skip feed due to uri scheme is not file.')
+      end
+    rescue StandardError => e
+      Automatic::Log.puts('error',
+                          "Error detected with #{feed.link} in uploading AmazonS3: #{e.message}")
+    end
+
+    def file_path(uri)
+      FILE_URI_ESCAPER.unescape(uri.path.to_s)
+    end
+
+    def upload(path)
+      key = target_key(path)
+      File.open(path, 'rb') { |body| s3.put_object(bucket: bucket, key: key, body: body) } unless test?
+      Automatic::Log.puts('info', "Uploaded: file #{path} to the key #{key} on #{bucket}.")
+      [path, key]
+    end
+
+    def target_key(path)
+      File.join(@config['target_path'].to_s, File.basename(path)).sub(%r{\A/}, '')
+    end
+
+    def bucket
+      @config['bucket_name'].to_s
+    end
+
+    def test?
+      @mode == 'test'
+    end
+
+    # AWS SDK for Ruby v3, which is the SDK AWS publishes and maintains. The
+    # gem is required here rather than at the top of the file, so that a
+    # Recipe running this plugin in `mode: test` -- and this plugin's own
+    # specs -- need neither the gem nor an account.
+    #
+    # Credentials are the Recipe's where it carries them, and the SDK's
+    # default chain -- environment, shared profile, instance role -- where it
+    # does not, which is the way to run this without a secret in a file.
+    def s3
+      @s3 ||= begin
+        Automatic.require_optional('aws-sdk-s3', needed_by: 'PublishAmazonS3')
+        Aws::S3::Client.new(**client_options)
+      end
+    end
+
+    def client_options
+      options = {}
+      options[:region] = @config['region'].to_s unless @config['region'].nil?
+      unless @config['access_key'].nil?
+        options[:access_key_id]     = @config['access_key'].to_s
+        options[:secret_access_key] = @config['secret_key'].to_s
+      end
+      options
     end
   end
 end

data/plugins/publish/console.rb

@@ -1,29 +1,32 @@
 # -*- coding: utf-8 -*-
-# Name::      Automatic::Plugin::Publish::Console
-# Author::    774 <http://id774.net>
-# Created::   Feb 23, 2012
-# Updated::   Feb 24, 2012
-# Copyright:: Copyright (c) 2012-2013 Automatic Ruby Developers.
-# License::   Licensed under the GNU GENERAL PUBLIC LICENSE, Version 3.0.
+# Name::        Automatic::Plugin::Publish::Console
+# Author:       id774 (More info: https://id774.net)
+# Source Code:: https://github.com/id774/automaticruby
+# License::     The GPL version 3, or LGPL version 3 (Dual License).
+# Contact::     idnanashi@gmail.com
+# Created::     Feb 23, 2012
+# Updated::     Aug 15, 2026
+# Copyright::   Copyright (c) 2012-2026 Automatic Ruby Developers.
 
 module Automatic::Plugin
   class PublishConsole
     require 'pp'
 
-    def initialize(config, pipeline=[])
-      @config = config
+    def initialize(config, pipeline = [])
+      @config   = config || {}
       @pipeline = pipeline
-      @output = STDOUT
+      # Held in an instance variable rather than written to $stdout directly,
+      # so that a spec can substitute it. See doc/PLUGINS.md section 3.6.
+      @output   = $stdout
     end
 
+    # Prints each item, the plugin to end a Recipe with while writing it.
     def run
-      @pipeline.each {|feeds|
-        unless feeds.nil?
-          feeds.items.each {|feed|
-            @output.puts("info", feed.pretty_inspect)
-          }
-        end
-      }
+      @pipeline.each do |feeds|
+        next if feeds.nil?
+
+        feeds.items.each { |feed| @output.puts(feed.pretty_inspect) }
+      end
       @pipeline
     end
   end

data/plugins/publish/console_link.rb

@@ -1,29 +1,32 @@
 # -*- coding: utf-8 -*-
-# Name::      Automatic::Plugin::Publish::ConsoleLink
-# Author::    soramugi <http://soramugi.net>
-# Created::   Jun 02, 2013
-# Updated::   Jun 02, 2013
-# Copyright:: Copyright (c) 2012-2013 Automatic Ruby Developers.
-# License::   Licensed under the GNU GENERAL PUBLIC LICENSE, Version 3.0.
+# Name::        Automatic::Plugin::Publish::ConsoleLink
+# Author:       soramugi (More info: http://soramugi.net)
+# Source Code:: https://github.com/id774/automaticruby
+# License::     The GPL version 3, or LGPL version 3 (Dual License).
+# Contact::     idnanashi@gmail.com
+# Created::     Jun 02, 2013
+# Updated::     Aug 15, 2026
+# Copyright::   Copyright (c) 2012-2026 Automatic Ruby Developers.
 
 module Automatic::Plugin
   class PublishConsoleLink
-    require 'pp'
-
-    def initialize(config, pipeline=[])
-      @config = config
+    def initialize(config, pipeline = [])
+      @config   = config || {}
       @pipeline = pipeline
-      @output = STDOUT
+      @output   = $stdout
     end
 
+    # Prints each item's link, one per line, and nothing else. Useful in a
+    # pipe, which is why an item whose link a filter has blanked prints
+    # nothing rather than an empty line.
     def run
-      @pipeline.each {|feeds|
-        unless feeds.nil?
-          feeds.items.each {|feed|
-            @output.puts("info", feed.link)
-          }
+      @pipeline.each do |feeds|
+        next if feeds.nil?
+
+        feeds.items.each do |feed|
+          @output.puts(feed.link) unless feed.link.nil?
         end
-      }
+      end
       @pipeline
     end
   end

data/plugins/publish/eject.rb

@@ -1,42 +1,64 @@
 # -*- coding: utf-8 -*-
-# Name::      Automatic::Plugin::Publish::Eject
-# Author::    soramugi <http://soramugi.net>
-#             774 <http://id774.net>
-# Created::   Jun  9, 2013
-# Updated::   May 16, 2014
-# Copyright:: Copyright (c) 2012-2014 Automatic Ruby Developers.
-# License::   Licensed under the GNU GENERAL PUBLIC LICENSE, Version 3.0.
+# Name::        Automatic::Plugin::Publish::Eject
+# Author:       soramugi (More info: http://soramugi.net)
+# Source Code:: https://github.com/id774/automaticruby
+# License::     The GPL version 3, or LGPL version 3 (Dual License).
+# Contact::     idnanashi@gmail.com
+# Created::     Jun  9, 2013
+# Updated::     Aug 15, 2026
+# Copyright::   Copyright (c) 2012-2026 Automatic Ruby Developers.
 
 module Automatic::Plugin
   class PublishEject
+    # The command that opens the tray and the command that closes it again,
+    # per platform, as argument vectors. Nothing here goes through a shell.
+    COMMANDS = {
+      'eject'  => [%w[eject], %w[eject -t]],           # GNU/Linux
+      'drutil' => [%w[drutil tray eject], %w[drutil tray close]] # macOS
+    }.freeze
 
-    def initialize(config, pipeline=[])
-      @config   = config
+    def initialize(config, pipeline = [])
+      @config   = config || {}
       @pipeline = pipeline
     end
 
+    # Opens and closes the optical drive once per item. A physical
+    # notification, and the plugin that needs a machine with a tray.
     def run
-      @pipeline.each {|feeds|
-        unless feeds.nil?
-          feeds.items.each {|feed|
-            unless feed.link.nil?
-              `#{eject_cmd}`
-              Automatic::Log.puts('info', "Eject: #{feed.link}")
-
-              interval = @config['interval'].to_i unless @config['interval'].nil? unless @config.nil?
-              sleep ||= @config['interval'].to_i
-            end
-          }
+      @pipeline.each do |feeds|
+        next if feeds.nil?
+
+        feeds.items.each do |feed|
+          next if feed.link.nil?
+
+          eject
+          Automatic::Log.puts('info', "Eject: #{feed.link}")
+          sleep(@config['interval'].to_i)
         end
-      }
+      end
       @pipeline
     end
 
-    def eject_cmd
-      if `which eject` != '' # linux
-        'eject ; eject -t'
-      elsif `which drutil` != '' # mac
-        'drutil tray eject ; drutil tray close'
+    private
+
+    def eject
+      commands = COMMANDS[command_name]
+      if commands.nil?
+        Automatic::Log.puts('warn', 'No eject command found on this system.')
+        return
+      end
+
+      commands.each { |command| system(*command) }
+    end
+
+    # Looked up on PATH rather than by running `which` in a shell.
+    def command_name
+      @command_name ||= COMMANDS.keys.find { |name| executable?(name) }
+    end
+
+    def executable?(name)
+      ENV['PATH'].to_s.split(File::PATH_SEPARATOR).any? do |dir|
+        File.executable?(File.join(dir, name))
       end
     end
   end