RubyGems - sisimai - Versions diffs - 4.25.3 → 4.25.8 - Mend

sisimai 4.25.3 → 4.25.8

Potentially problematic release.

This version of sisimai might be problematic. Click here for more details.

Files changed (731) hide show

data/lib/sisimai/message/json.rb DELETED

@@ -1,198 +0,0 @@
-module Sisimai
-  class Message
-    # Sisimai::Message::JSON convert from a bounce object (decoded JSON) which is
-    # retrieved from some Cloud Email Deliveries API to data structure.
-    class JSON
-      # Imported from p5-Sisimail/lib/Sisimai/Message/JSON.pm
-      require 'sisimai/order/json'
-      @@ToBeLoaded = []
-      @@TryOnFirst = []
-      DefaultSet = Sisimai::Order::JSON.default
-      ObjectKeys = Sisimai::Order::JSON.by('keyname')
-      # Make data structure from decoded JSON object
-      # @param         [Hash] argvs   Bounce object
-      # @options argvs [Hash]   data  Decoded JSON
-      # @options argvs [Array]  load  User defined MTA(JSON) module list
-      # @options argvs [Array]  order The order of MTA(JSON) modules
-      # @options argvs [Code]   hook  Reference to callback method
-      # @return        [Hash]         Resolved data structure
-      def self.make(argvs)
-        hookmethod = argvs['hook'] || nil
-        processing = {
-          'from'   => '',  # From_ line
-          'header' => {},  # Email header
-          'rfc822' => '',  # Original message part
-          'ds'     => [],  # Parsed data, Delivery Status
-          'catch'  => nil, # Data parsed by callback method
-        }
-        methodargv = {
-          'load'  => argvs['load'] || [],
-          'order' => argvs['order'] || []
-        }
-        @@ToBeLoaded = Sisimai::Message::JSON.load(methodargv)
-        @@TryOnFirst = Sisimai::Message::JSON.makeorder(argvs['data'])
-        # Rewrite message body for detecting the bounce reason
-        methodargv = { 'hook' => hookmethod, 'json' => argvs['data'] }
-        return nil unless bouncedata = Sisimai::Message::JSON.parse(methodargv)
-        return nil if bouncedata.empty?
-        processing['ds']     = bouncedata['ds']
-        processing['catch']  = bouncedata['catch']
-        processing['rfc822'] = bouncedata['rfc822']
-        return processing
-      end
-      # Load MTA(JSON) modules which specified at 'order' and 'load' in the argument
-      # @param         [Hash] argvs       Module information to be loaded
-      # @options argvs [Array]  load      User defined MTA(JSON) module list
-      # @options argvs [Array]  order     The order of MTA(JSON) modules
-      # @return        [Array]            Module list
-      # @since v4.20.0
-      def self.load(argvs)
-        modulelist = []
-        tobeloaded = []
-        %w[load order].each do |e|
-          # The order of MTA(JSON) modules specified by user
-          next unless argvs.key?(e)
-          next unless argvs[e].is_a? Array
-          next if argvs[e].empty?
-          modulelist += argvs['order'] if e == 'order'
-          next unless e == 'load'
-          # Load user defined MTA(JSON) module
-          argvs['load'].each do |v|
-            # Load user defined MTA(JSON) module
-            begin
-              require v.to_s.gsub('::', '/').downcase
-            rescue LoadError
-              warn ' ***warning: Failed to load ' << v
-              next
-            end
-            tobeloaded << v
-          end
-        end
-        modulelist.each do |e|
-          # Append the custom order of MTA(JSON) modules
-          next if tobeloaded.index(e)
-          tobeloaded << e
-        end
-        return tobeloaded
-      end
-      # Check the decoded JSON strucutre for detecting MTA(JSON) modules and
-      # returns the order of modules to be called.
-      # @param         [Hash] heads   Decoded JSON object
-      # @return        [Array]        Order of MTA(JSON) modules
-      def self.makeorder(argvs)
-        return [] unless argvs
-        return [] if argvs.empty?
-        order = []
-        # Seek some key names from given argument
-        ObjectKeys.each_key do |e|
-          # Get MTA(JSON) module list matched with a specified key
-          next unless argvs.key?(e)
-          order += ObjectKeys[e] # Matched and push it into the order list
-          break
-        end
-        return order
-      end
-      # Parse bounce object with each MTA(JSON) module
-      # @param               [Hash] argvs    Processing message entity.
-      # @param options argvs [Hash] json     Decoded bounce object
-      # @param options argvs [Proc] hook     Hook method to be called
-      # @return              [Hash]          Parsed and structured bounce mails
-      def self.parse(argvs)
-        bouncedata = argvs['json'] || {}
-        hookmethod = argvs['hook'] || nil
-        havecaught = nil
-        haveloaded = {}
-        hasadapted = nil
-        # Call the hook method
-        if hookmethod.is_a? Proc
-          # Execute hook method
-          begin
-            p = {
-              'datasrc' => 'json',
-              'headers' => nil,
-              'message' => nil,
-              'bounces' => argvs['json']
-            }
-            havecaught = hookmethod.call(p)
-          rescue StandardError => ce
-            warn ' ***warning: Something is wrong in hook method :' << ce.to_s
-          end
-        end
-        catch :ADAPTOR do
-          while true
-            # 1. User-Defined Module
-            # 2. MTA(JSON) Module Candidates to be tried on first
-            # 3. Sisimai::Bite::JSON::*
-            #
-            @@ToBeLoaded.each do |r|
-              # Call user defined MTA(JSON) modules
-              next if haveloaded[r]
-              begin
-                require r.gsub('::', '/').downcase
-              rescue LoadError => ce
-                warn ' ***warning: Failed to load ' << ce.to_s
-                next
-              end
-              hasadapted = Module.const_get(r).adapt(bouncedata)
-              haveloaded[r] = true
-              throw :ADAPTOR if hasadapted
-            end
-            @@TryOnFirst.each do |r|
-              # Try MTA(JSON) module candidates which are detected from object
-              # key names
-              next if haveloaded.key?(r)
-              begin
-                require r.gsub('::', '/').downcase
-              rescue LoadError => ce
-                warn ' ***warning: ' << ce.to_s
-                next
-              end
-              hasadapted = Module.const_get(r).adapt(bouncedata)
-              haveloaded[r] = true
-              throw :ADAPTOR if hasadapted
-            end
-            DefaultSet.each do |r|
-              # Default order of MTA(JSON) modules
-              next if haveloaded.key?(r)
-              begin
-                require r.gsub('::', '/').downcase
-              rescue => ce
-                warn ' ***warning: ' << ce.to_s
-                next
-              end
-              hasadapted = Module.const_get(r).adapt(bouncedata)
-              haveloaded[r] = true
-              throw :ADAPTOR if hasadapted
-            end
-            break # as of now, we have no sample JSON data for coding this block
-          end
-        end
-        hasadapted['catch'] = havecaught if hasadapted
-        return hasadapted
-      end
-    end
-  end
-end

data/lib/sisimai/order/email.rb DELETED

@@ -1,205 +0,0 @@
-module Sisimai
-  module Order
-    # Sisimai::Order::Email makes optimized order list which include MTA modules
-    # to be loaded on first from MTA specific headers in the bounce mail headers
-    # such as X-Failed-Recipients.
-    # This module are called from only Sisimai::Message::Email.
-    module Email
-      # Imported from p5-Sisimail/lib/Sisimai/Order/Email.pm
-      class << self
-        require 'sisimai/bite/email'
-        EngineOrder1 = [
-          # These modules have many subject patterns or have MIME encoded subjects
-          # which is hard to code as regular expression
-          'Sisimai::Bite::Email::Exim',
-          'Sisimai::Bite::Email::Exchange2003',
-        ].freeze
-        EngineOrder2 = [
-          # These modules have no MTA specific header and did not listed in the
-          # following subject header based regular expressions.
-          'Sisimai::Bite::Email::Exchange2007',
-          'Sisimai::Bite::Email::Facebook',
-          'Sisimai::Bite::Email::KDDI',
-        ].freeze
-        EngineOrder3 = [
-          # These modules have no MTA specific header but listed in the following
-          # subject header based regular expressions.
-          'Sisimai::Bite::Email::Sendmail',
-          'Sisimai::Bite::Email::Postfix',
-          'Sisimai::Bite::Email::Qmail',
-          'Sisimai::Bite::Email::SendGrid',
-          'Sisimai::Bite::Email::Courier',
-          'Sisimai::Bite::Email::OpenSMTPD',
-          'Sisimai::Bite::Email::Notes',
-          'Sisimai::Bite::Email::MessagingServer',
-          'Sisimai::Bite::Email::Domino',
-          'Sisimai::Bite::Email::Bigfoot',
-          'Sisimai::Bite::Email::EinsUndEins',
-          'Sisimai::Bite::Email::MXLogic',
-          'Sisimai::Bite::Email::Amavis',
-          'Sisimai::Bite::Email::IMailServer',
-          'Sisimai::Bite::Email::X4',
-        ].freeze
-        EngineOrder4 = [
-          # These modules have no MTA specific headers and there are few samples or
-          # too old MTA
-          'Sisimai::Bite::Email::Verizon',
-          'Sisimai::Bite::Email::InterScanMSS',
-          'Sisimai::Bite::Email::MailFoundry',
-          'Sisimai::Bite::Email::ApacheJames',
-          'Sisimai::Bite::Email::Biglobe',
-          'Sisimai::Bite::Email::EZweb',
-          'Sisimai::Bite::Email::X5',
-          'Sisimai::Bite::Email::X3',
-          'Sisimai::Bite::Email::X2',
-          'Sisimai::Bite::Email::X1',
-          'Sisimai::Bite::Email::V5sendmail',
-        ].freeze
-        EngineOrder5 = [
-          # These modules have one or more MTA specific headers but other headers
-          # also required for detecting MTA name
-          'Sisimai::Bite::Email::Outlook',
-          'Sisimai::Bite::Email::MailRu',
-          'Sisimai::Bite::Email::MessageLabs',
-          'Sisimai::Bite::Email::MailMarshalSMTP',
-          'Sisimai::Bite::Email::MFILTER',
-          'Sisimai::Bite::Email::Google',
-        ].freeze
-        EngineOrder9 = [
-          # These modules have one or more MTA specific headers
-          'Sisimai::Bite::Email::Aol',
-          'Sisimai::Bite::Email::Yahoo',
-          'Sisimai::Bite::Email::AmazonSES',
-          'Sisimai::Bite::Email::GMX',
-          'Sisimai::Bite::Email::Yandex',
-          'Sisimai::Bite::Email::Office365',
-          'Sisimai::Bite::Email::ReceivingSES',
-          'Sisimai::Bite::Email::AmazonWorkMail',
-          'Sisimai::Bite::Email::Zoho',
-          'Sisimai::Bite::Email::McAfee',
-          'Sisimai::Bite::Email::Activehunter',
-          'Sisimai::Bite::Email::SurfControl',
-        ].freeze
-        # This variable don't hold MTA name which have one or more MTA specific
-        # header such as X-AWS-Outgoing, X-Yandex-Uniq.
-        PatternTable = {
-          'subject' => {
-            'delivery' => [
-              'Sisimai::Bite::Email::Exim',
-              'Sisimai::Bite::Email::Outlook',
-              'Sisimai::Bite::Email::Courier',
-              'Sisimai::Bite::Email::Domino',
-              'Sisimai::Bite::Email::OpenSMTPD',
-              'Sisimai::Bite::Email::EinsUndEins',
-              'Sisimai::Bite::Email::InterScanMSS',
-              'Sisimai::Bite::Email::MailFoundry',
-              'Sisimai::Bite::Email::X4',
-              'Sisimai::Bite::Email::X3',
-              'Sisimai::Bite::Email::X2',
-              'Sisimai::Bite::Email::Google',
-            ],
-            'noti' => [
-              'Sisimai::Bite::Email::Sendmail',
-              'Sisimai::Bite::Email::Qmail',
-              'Sisimai::Bite::Email::Outlook',
-              'Sisimai::Bite::Email::Courier',
-              'Sisimai::Bite::Email::MessagingServer',
-              'Sisimai::Bite::Email::OpenSMTPD',
-              'Sisimai::Bite::Email::X4',
-              'Sisimai::Bite::Email::X3',
-              'Sisimai::Bite::Email::MFILTER',
-              'Sisimai::Bite::Email::Google',
-            ],
-            'return' => [
-              'Sisimai::Bite::Email::Postfix',
-              'Sisimai::Bite::Email::Sendmail',
-              'Sisimai::Bite::Email::SendGrid',
-              'Sisimai::Bite::Email::Bigfoot',
-              'Sisimai::Bite::Email::EinsUndEins',
-              'Sisimai::Bite::Email::X1',
-              'Sisimai::Bite::Email::Biglobe',
-              'Sisimai::Bite::Email::V5sendmail',
-            ],
-            'undeliver' => [
-              'Sisimai::Bite::Email::Postfix',
-              'Sisimai::Bite::Email::Office365',
-              'Sisimai::Bite::Email::Exchange2007',
-              'Sisimai::Bite::Email::Exchange2003',
-              'Sisimai::Bite::Email::SendGrid',
-              'Sisimai::Bite::Email::Notes',
-              'Sisimai::Bite::Email::Verizon',
-              'Sisimai::Bite::Email::Amavis',
-              'Sisimai::Bite::Email::IMailServer',
-              'Sisimai::Bite::Email::MailMarshalSMTP',
-            ],
-            'failure' => [
-              'Sisimai::Bite::Email::Qmail',
-              'Sisimai::Bite::Email::Outlook',
-              'Sisimai::Bite::Email::MailRu',
-              'Sisimai::Bite::Email::Domino',
-              'Sisimai::Bite::Email::X4',
-              'Sisimai::Bite::Email::X2',
-              'Sisimai::Bite::Email::MFILTER',
-              'Sisimai::Bite::Email::Google',
-            ],
-            'warning' => [
-              'Sisimai::Bite::Email::Postfix',
-              'Sisimai::Bite::Email::Sendmail',
-              'Sisimai::Bite::Email::Exim',
-            ],
-          },
-        }.freeze
-        Skips = { 'return-path' => 1, 'x-mailer' => 1 }.freeze
-        # @abstract Make default order of MTA modules to be loaded
-        # @return   [Array] Default order list of MTA modules
-        def default
-          return Sisimai::Bite::Email.index.map { |e| 'Sisimai::Bite::Email::' << e }
-        end
-        # @abstract Get regular expression patterns for specified field
-        # @param    [String] group  Group name for "ORDER BY"
-        # @return   [Hash]          Pattern table for the group
-        def by(group = '')
-          return {} if group.empty?
-          return PatternTable[group] if PatternTable.key?(group)
-          return {}
-        end
-        # @abstract Make MTA module list as a spare
-        # @return   [Array] Ordered module list
-        def another
-          rv = []
-          [EngineOrder1, EngineOrder2, EngineOrder3, EngineOrder4, EngineOrder5, EngineOrder9].each do |e|
-            rv += e
-          end
-          return rv
-        end
-        # @abstract Make email header list in each MTA module
-        # @return   [Hash] Header list to be parsed
-        def headers
-          order = Sisimai::Bite::Email.heads.map { |e| 'Sisimai::Bite::Email::' << e }
-          table = {}
-          while e = order.shift do
-            # Load email headers from each MTA module
-            require e.gsub('::', '/').downcase
-            Module.const_get(e).headerlist.each do |v|
-              # Get header name which required each MTA module
-              next if Skips.key?(v)
-              table[v] ||= []
-              table[v] << e
-            end
-          end
-          return table
-        end
-      end
-    end
-  end
-end

data/lib/sisimai/order/json.rb DELETED

@@ -1,52 +0,0 @@
-module Sisimai
-  module Order
-    # Sisimai::Order::JSON - Make optimized order list for calling MTA modules
-    # for JSON formatted bounce objects
-    module JSON
-      # Imported from p5-Sisimail/lib/Sisimai/Order/JSON.pm
-      class << self
-        require 'sisimai/bite/json'
-        PatternTable = {
-          'keyname' => { 'notificationType' => ['Sisimai::Bite::JSON::AmazonSES'] },
-        }.freeze
-        make_default_order = lambda do
-          # Make default order of MTA(JSON) modules to be loaded
-          rv = []
-          begin
-            rv += Sisimai::Bite::JSON.index.map { |e| 'Sisimai::Bite::JSON::' << e }
-          rescue
-            # Failed to load MTA(JSON) module
-            next
-          end
-          return rv
-        end
-        DefaultOrder = make_default_order.call
-        # @abstract Make default order of MTA(JSON) modules to be loaded
-        # @return   [Array] Default order list of MTA(JSON) modules
-        def default; return DefaultOrder; end
-        # @abstract Make MTA(JSON) module list as a spare
-        # @return   [Array] Ordered module list
-        def another; return []; end
-        # Make email header list in each MTA(JSON) module
-        # @return   [Hash] Header list to be parsed
-        def headers; return {}; end
-        # Get regular expression patterns for specified key name
-        # @param    [String] group  Group name for "ORDER BY"
-        # @return   [Hash]          Pattern table for the group
-        def by(group = '')
-          return {} if group.empty?
-          return PatternTable[group] if PatternTable.key?(group)
-          return {}
-        end
-      end
-    end
-  end
-end