automatic 14.12.2 → 26.08

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

data/plugins/publish/fluentd.rb

@@ -1,43 +1,63 @@
 # -*- coding: utf-8 -*-
-# Name::      Automatic::Plugin::Publish::Fluentd
-# Author::    774 <http://id774.net>
-# Created::   Jun 21, 2013
-# Updated::   Feb 25, 2014
-# Copyright:: Copyright (c) 2012-2014 Automatic Ruby Developers.
-# License::   Licensed under the GNU GENERAL PUBLIC LICENSE, Version 3.0.
+# Name::        Automatic::Plugin::Publish::Fluentd
+# Author:       id774 (More info: http://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::     Jun 21, 2013
+# Updated::     Aug 15, 2026
+# Copyright::   Copyright (c) 2012-2026 Automatic Ruby Developers.
 
 module Automatic::Plugin
   class PublishFluentd
-    require 'fluent-logger'
+    Automatic.require_optional('fluent-logger', needed_by: 'PublishFluentd')
 
-    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 title, link, description, content_encoded and a
+    # timestamp to Fluentd.
     def run
-      @pipeline.each {|feeds|
-        unless feeds.nil?
-          feeds.items.each {|feed|
-            begin
-              @fluentd.post(@config['tag'], {
-                :title => feed.title,
-                :link => feed.link,
-                :description => feed.description,
-                :content => feed.content_encoded,
-                :created_at => Time.now.strftime("%Y/%m/%d %X")
-              }) unless @mode == 'test'
-            rescue
-              Automatic::Log.puts("warn", "Skip feed due to fault in forward.")
-            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'], record(feed))
+    rescue StandardError => e
+      Automatic::Log.puts('warn', "Skip feed due to fault in forward: #{e.message}")
+    end
+
+    def record(feed)
+      {
+        title: feed.title,
+        link: feed.link,
+        description: feed.description,
+        content: feed.content_encoded,
+        created_at: Time.now.strftime('%Y/%m/%d %X')
+      }
+    end
+
+    def test?
+      @mode == 'test'
+    end
   end
 end

data/plugins/publish/hatena_bookmark.rb

@@ -1,110 +1,127 @@
 # -*- coding: utf-8 -*-
-# Name::      Automatic::Plugin::Publish::HatenaBookmark
-# Author::    774 <http://id774.net>
-# Created::   Feb 22, 2012
-# Updated::   Jan 15, 2014
-# Copyright:: Copyright (c) 2012-2014 Automatic Ruby Developers.
-# License::   Licensed under the GNU GENERAL PUBLIC LICENSE, Version 3.0.
+# Name::        Automatic::Plugin::Publish::HatenaBookmark
+# Author:       id774 (More info: http://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 22, 2012
+# Updated::     Aug 15, 2026
+# Copyright::   Copyright (c) 2012-2026 Automatic Ruby Developers.
+#
+# STATUS: Needs rework. This speaks the WSSE AtomPub interface, which Hatena
+# has superseded with an OAuth one. The service and the bookmarking API are
+# both current; this client is not, and restoring it means the current
+# endpoint and the current authentication rather than a change of a few lines.
+# See doc/PLUGINS.md section 6.7.
+#
+# The transport was corrected in the meantime: the request is made over HTTPS,
+# so that an operator who runs this does not put a password digest on the wire
+# in the clear. That is a defect worth not shipping whatever the plugin's
+# status is; it is not a claim that the plugin works.
+
+require 'digest/sha1'
+require 'net/http'
+require 'securerandom'
+require 'time'
+require 'uri'
 
 module Automatic::Plugin
   class HatenaBookmark
-    require 'rubygems'
-    require 'time'
-    require 'digest/sha1'
-    require 'net/http'
-    require 'uri'
-    #require 'nkf'
+    ENDPOINT = 'https://b.hatena.ne.jp/atom/post'
+    OPEN_TIMEOUT = 10
+    READ_TIMEOUT = 30
 
     attr_accessor :user
 
     def initialize
-      @user = {
-        "hatena_id" => "",
-        "password"  => ""
-      }
+      @user = { 'hatena_id' => '', 'password' => '' }
     end
 
     def wsse(hatena_id, password)
-      # Unique value
-      nonce = [Time.now.to_i.to_s].pack('m').gsub(/\n/, '')
-      now = Time.now.utc.iso8601
+      nonce  = SecureRandom.random_bytes(16)
+      now    = Time.now.utc.iso8601
+      digest = [Digest::SHA1.digest(nonce + now + password.to_s)].pack('m0')
 
-      # Base64 encoding for SHA1 Digested strings
-      digest = [Digest::SHA1.digest(nonce + now + password)].pack("m").gsub(/\n/, '')
+      { 'X-WSSE' => format('UsernameToken Username="%s", PasswordDigest="%s", ' \
+                           'Nonce="%s", Created="%s"',
+                           hatena_id, digest, [nonce].pack('m0'), now) }
+    end
 
-      {'X-WSSE' => sprintf(
-                           %Q<UsernameToken Username="%s", PasswordDigest="%s", Nonce="%s", Created="%s">,
-                           hatena_id, digest, nonce, now)
-      }
+    def to_xml(link, summary)
+      <<~XML
+        <entry xmlns="http://purl.org/atom/ns#">
+        <title>dummy</title>
+        <link rel="related" type="text/html" href="#{link}" />
+        <summary type="text/plain">#{summary}</summary>
+        </entry>
+      XML
     end
 
-    def toXml(link, summary)
-      %Q(
-      <entry xmlns="http://purl.org/atom/ns#">
-      <title>dummy</title>
-      <link rel="related" type="text/html" href="#{link}" />
-      <summary type="text/plain">#{summary}</summary>
-      </entry>
-    )
+    def post(url, comment)
+      Automatic::Log.puts('info', "Bookmarking: #{url}")
+      uri     = URI.parse(ENDPOINT)
+      request = Net::HTTP::Post.new(uri.path, wsse(@user['hatena_id'], @user['password']))
+      request.body = to_xml(url, comment)
+
+      response = start(uri) { |http| http.request(request) }
+      log(response, url, comment)
     end
 
-    def post(b_url, b_comment)
-      Automatic::Log.puts("info", "Bookmarking: #{b_url}")
-      url = "http://b.hatena.ne.jp/atom/post"
-      header = wsse(@user["hatena_id"], @user["password"])
-      uri = URI.parse(url)
-      proxy_class = Net::HTTP::Proxy(ENV["PROXY"], 8080)
-      http = proxy_class.new(uri.host)
-      http.start { |http|
-        # b_url = NKF.nkf('-w', b_url)
-        # b_comment = NKF.nkf('-w', b_comment)
-        res = http.post(uri.path, toXml(b_url, b_comment), header)
-        if res.code == "201" then
-          message = "Success: #{b_url}"
-          message += " Comment: #{b_comment}" unless b_comment.nil?
-          Automatic::Log.puts(:info, message)
-        else
-          Automatic::Log.puts(:error, "#{res.code} Error: #{b_url}")
-        end
-      }
+    private
+
+    def start(uri, &block)
+      proxy = Net::HTTP.Proxy(ENV.fetch('PROXY', nil), 8080)
+      proxy.start(uri.host, uri.port,
+                  use_ssl: true,
+                  open_timeout: OPEN_TIMEOUT,
+                  read_timeout: READ_TIMEOUT, &block)
+    end
+
+    def log(response, url, comment)
+      if response.code == '201'
+        message = "Success: #{url}"
+        message += " Comment: #{comment}" unless comment.nil?
+        Automatic::Log.puts(:info, message)
+      else
+        Automatic::Log.puts(:error, "#{response.code} Error: #{url}")
+      end
     end
   end
 
   class PublishHatenaBookmark
     attr_accessor :hb
 
-    def initialize(config, pipeline=[])
-      @config = config
+    def initialize(config, pipeline = [])
+      @config   = config || {}
       @pipeline = pipeline
 
       @hb = HatenaBookmark.new
       @hb.user = {
-        "hatena_id" => @config['username'],
-        "password"  => @config['password']
+        'hatena_id' => @config['username'],
+        'password'  => @config['password']
       }
     end
 
     def run
-      @pipeline.each {|feeds|
-        unless feeds.nil?
-          feeds.items.each {|feed|
-            hb.post(rewrite(feed.link), nil)
-            sleep ||= @config['interval'].to_i
-          }
+      @pipeline.each do |feeds|
+        next if feeds.nil?
+
+        feeds.items.each do |feed|
+          hb.post(absolute(feed.link), nil)
+          sleep(@config['interval'].to_i)
         end
-      }
+      end
       @pipeline
     end
 
     private
-    def rewrite(string)
-      if /^https?:\/\/.*$/ =~ string
-        return string
-      elsif /^\/\/.*$/ =~ string
-        return "http:" + string
-      else
-        return "http://" + string
-      end
+
+    def absolute(link)
+      string = link.to_s
+      return string if string.match?(%r{\Ahttps?://})
+      return "https:#{string}" if string.start_with?('//')
+
+      "https://#{string}"
     end
   end
 end

data/plugins/publish/instapaper.rb

@@ -1,88 +1,98 @@
 # -*- coding: utf-8 -*-
-# Name::      Automatic::Plugin::Publish::Instapaper
-# Author::    soramugi <http://soramugi.net>
-#             774 <http://id774.net>
-# Created::   Feb  9, 2013
-# Updated::   Jan 15, 2014
-# Copyright:: Copyright (c) 2012-2014 Automatic Ruby Developers.
-# License::   Licensed under the GNU GENERAL PUBLIC LICENSE, Version 3.0.
+# Name::        Automatic::Plugin::Publish::Instapaper
+# 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::     Feb  9, 2013
+# Updated::     Aug 15, 2026
+# Copyright::   Copyright (c) 2012-2026 Automatic Ruby Developers.
 
 module Automatic::Plugin
+  # The Instapaper Simple API: HTTPS, basic authentication, form parameters.
+  # @see https://www.instapaper.com/api/simple
   class Instapaper
-    # @see http://www.instapaper.com/api/simple
-    require "net/http"
-    require "openssl"
+    require 'net/http'
+    require 'openssl'
+    require 'uri'
+
+    HOST = 'www.instapaper.com'
+    OPEN_TIMEOUT = 10
+    READ_TIMEOUT = 30
+
+    class Error < StandardError; end
 
     def initialize(username, password = '')
       @username = username
-      @password = password
+      @password = password.to_s
       request(:authenticate)
     end
 
     def add(url, title = '', selection = '')
-      params = {
-        :url       => url,
-        :title     => title,
-        :selection => selection
-      }
-      res = request(:add, params)
-      if res.code == "201" then
-        message = "Success: #{url}"
-        message += " Title: #{title}" unless title.nil?
-        Automatic::Log.puts(:info, message)
-      else
-        Automatic::Log.puts(:error, "#{res.code} Error: #{url}")
-        raise
-      end
+      response = request(:add, url: url, title: title, selection: selection)
+      raise Error, "Instapaper answered #{response.code} for #{url}" unless response.code == '201'
+
+      message = "Success: #{url}"
+      message += " Title: #{title}" unless title.nil?
+      Automatic::Log.puts(:info, message)
+      response
     end
 
     private
 
+    # TLS with the certificate verified, which is Net::HTTP's own default and
+    # is stated here because this plugin used to turn it off.
     def request(method, params = {})
-      request          = Net::HTTP::Post.new('/api/' + method.to_s)
-      request.basic_auth(@username, @password)
-      request.set_form_data(params)
-      http             = Net::HTTP.new('www.instapaper.com', 443)
-      http.use_ssl     = true
-      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-      http.start { http.request(request) }
+      post = Net::HTTP::Post.new("/api/#{method}")
+      post.basic_auth(@username, @password)
+      post.set_form_data(params)
+
+      Net::HTTP.start(HOST, 443,
+                      use_ssl: true,
+                      verify_mode: OpenSSL::SSL::VERIFY_PEER,
+                      open_timeout: OPEN_TIMEOUT,
+                      read_timeout: READ_TIMEOUT) { |http| http.request(post) }
     end
   end
 
   class PublishInstapaper
-
     attr_accessor :instapaper
 
-    def initialize(config, pipeline=[])
-      @config   = config
-      @pipeline = pipeline
-
-      @instapaper = Instapaper.new(
-        @config['email'],
-        @config['password']
-      )
+    def initialize(config, pipeline = [])
+      @config     = config || {}
+      @pipeline   = pipeline
+      @instapaper = Instapaper.new(@config['email'], @config['password'])
     end
 
+    # Adds each item to Instapaper.
     def run
-      @pipeline.each {|feeds|
-        unless feeds.nil?
-          feeds.items.each {|feed|
-            Automatic::Log.puts("info", "add: #{feed.link}")
-            retries = 0
-            retry_max = @config['retry'].to_i || 0
-            begin
-              instapaper.add(feed.link, feed.title, feed.description)
-            rescue
-              retries += 1
-              Automatic::Log.puts("error", "ErrorCount: #{retries}, Fault in publish to instapaper.")
-              sleep ||= @config['interval'].to_i
-              retry if retries <= retry_max
-            end
-            sleep ||= @config['interval'].to_i
-          }
-        end
-      }
+      @pipeline.each do |feeds|
+        next if feeds.nil?
+
+        feeds.items.each { |feed| add(feed) }
+      end
       @pipeline
     end
+
+    private
+
+    def add(feed)
+      Automatic::Log.puts('info', "add: #{feed.link}")
+      retries   = 0
+      retry_max = @config['retry'].to_i
+      begin
+        instapaper.add(feed.link, feed.title, feed.description)
+      rescue StandardError => e
+        retries += 1
+        # The message names the item, never the account or the password.
+        Automatic::Log.puts('error',
+                            "ErrorCount: #{retries}, Fault in publish to instapaper: #{e.message}")
+        if retries <= retry_max
+          sleep(@config['interval'].to_i)
+          retry
+        end
+      end
+      sleep(@config['interval'].to_i)
+    end
   end
 end