sisimai 4.19.0 → 4.20.0

data/lib/sisimai/message/json.rb

@@ -0,0 +1,201 @@
+module Sisimai
+  # Sisimai::Message::JSON convert from a bounce object (decoded JSON) which is
+  # retrieved from some Cloud Email Deliveries API to data structure.
+  class Message
+    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 CED module list
+      # @options argvs [Array]  order The order of CED 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'] }
+        bouncedata = Sisimai::Message::JSON.parse(methodargv)
+
+        return nil unless bouncedata
+        return nil if bouncedata.empty?
+        processing['ds']     = bouncedata['ds']
+        processing['catch']  = bouncedata['catch']
+        processing['rfc822'] = bouncedata['rfc822']
+
+        return processing
+      end
+
+      # Load CED  modules which specified at 'order' and 'load' in the argument
+      # @param         [Hash] argvs       Module information to be loaded
+      # @options argvs [Array]  load      User defined CED module list
+      # @options argvs [Array]  order     The order of CED modules
+      # @return        [Array]            Module list
+      # @since v4.20.0
+      def self.load(argvs)
+        modulelist = []
+        tobeloaded = []
+
+        %w|load order|.each do |e|
+          # The order of CED modules specified by user
+          next unless argvs.key?(e)
+          next unless argvs[e].is_a? Array
+          next if argvs[e].empty?
+
+          modulelist.concat(argvs['order']) if e == 'order'
+          next unless e == 'load'
+
+          # Load user defined CED module
+          argvs['load'].each do |v|
+            # Load user defined CED 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 CED modules
+          next if tobeloaded.index(e)
+          tobeloaded << e
+        end
+
+        return tobeloaded
+      end
+
+      # Check the decoded JSON strucutre for detecting CED modules and returns
+      # the order of modules to be called.
+      # @param         [Hash] heads   Decoded JSON object
+      # @return        [Array]        Order of CED modules
+      def self.makeorder(argvs)
+        return [] unless argvs
+        return [] unless argvs.keys.size > 0
+        order = []
+
+        # Seek some key names from given argument
+        ObjectKeys.each_key do |e|
+          # Get CED module list matched with a specified key
+          next unless argvs.key?(e)
+
+          # Matched and push it into the order list
+          order.concat(ObjectKeys[e])
+          break
+        end
+        return order
+      end
+
+      # Parse bounce object with each CED 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 sprintf(" ***warning: Something is wrong in hook method :%s", ce.to_s)
+          end
+        end
+
+        catch :ADAPTOR do
+          loop do
+            # 1. User-Defined Module
+            # 2. CED Module Candidates to be tried on first
+            # 3. Sisimai::CED::*
+            #
+            @@ToBeLoaded.each do |r|
+              # Call user defined CED 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 CED 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 CED 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/msp.rb

@@ -3,39 +3,12 @@ module Sisimai
   module MSP
     class << self
       # Imported from p5-Sisimail/lib/Sisimai/MSP.pm
+      require 'sisimai/skeleton'
       require 'sisimai/rfc5322'
 
-      # Flags for position variable for
-      # @return   [Hash] Position flag data
-      # @private
-      def INDICATORS
-        return {
-          :'deliverystatus' => (1 << 1),
-          :'message-rfc822' => (1 << 2),
-        }
-      end
-
-      # Data structure for parsed bounce messages
-      # @return [Hash] Data structure for delivery status
-      # @private
-      def DELIVERYSTATUS
-        return {
-          'spec'         => nil,  # Protocl specification
-          'date'         => nil,  # The value of Last-Attempt-Date header
-          'rhost'        => nil,  # The value of Remote-MTA header
-          'lhost'        => nil,  # The value of Received-From-MTA header
-          'alias'        => nil,  # The value of alias entry(RHS)
-          'agent'        => nil,  # MTA name
-          'action'       => nil,  # The value of Action header
-          'status'       => nil,  # The value of Status header
-          'reason'       => nil,  # Temporary reason of bounce
-          'command'      => nil,  # SMTP command in the message body
-          'diagnosis'    => nil,  # The value of Diagnostic-Code header
-          'recipient'    => nil,  # The value of Final-Recipient header
-          'softbounce'   => nil,  # Soft bounce or not
-          'feedbacktype' => nil,  # FeedBack Type
-        }
-      end
+      def INDICATORS;        return Sisimai::Skeleton.INDICATORS;     end
+      def DELIVERYSTATUS;    return Sisimai::Skeleton.DELIVERYSTATUS; end
+      def smtpagent(v = ''); return v.to_s.sub(/\ASisimai::/, '');    end
 
       # MSP list
       # @return   [Array] MSP list with order

data/lib/sisimai/msp/de/einsundeins.rb

@@ -24,7 +24,7 @@ module Sisimai
         Indicators = Sisimai::MSP.INDICATORS
 
         def description; return '1&1: http://www.1and1.de'; end
-        def smtpagent;   return 'DE::EinsUndEins'; end
+        def smtpagent;   return Sisimai::MSP.smtpagent(self); end
         # X-UI-Out-Filterresults: unknown:0;
         def headerlist;  return []; end
         def pattern;     return Re0; end

data/lib/sisimai/msp/de/gmx.rb

@@ -23,7 +23,7 @@ module Sisimai
         Indicators = Sisimai::MSP.INDICATORS
 
         def description; return 'GMX: http://www.gmx.net'; end
-        def smtpagent;   return 'DE::GMX'; end
+        def smtpagent;   return Sisimai::MSP.smtpagent(self); end
 
         # Envelope-To: <kijitora@mail.example.com>
         # X-GMX-Antispam: 0 (Mail was not recognized as spam); Detail=V3;

data/lib/sisimai/msp/jp/biglobe.rb

@@ -25,7 +25,7 @@ module Sisimai
         Indicators = Sisimai::MSP.INDICATORS
 
         def description; return 'BIGLOBE: http://www.biglobe.ne.jp'; end
-        def smtpagent;   return 'JP::Biglobe'; end
+        def smtpagent;   return Sisimai::MSP.smtpagent(self); end
         def headerlist;  return []; end
         def pattern;     return Re0; end
 

data/lib/sisimai/msp/jp/ezweb.rb

@@ -49,7 +49,7 @@ module Sisimai
         Indicators = Sisimai::MSP.INDICATORS
 
         def description; return 'au EZweb: http://www.au.kddi.com/mobile/'; end
-        def smtpagent;   return 'JP::EZweb'; end
+        def smtpagent;   return Sisimai::MSP.smtpagent(self); end
         def headerlist;  return ['X-SPASIGN']; end
         def pattern;     return Re0; end
 

data/lib/sisimai/msp/jp/kddi.rb

@@ -32,7 +32,7 @@ module Sisimai
         Indicators = Sisimai::MSP.INDICATORS
 
         def description; return 'au by KDDI: http://www.au.kddi.com'; end
-        def smtpagent;   return 'JP::KDDI'; end
+        def smtpagent;   return Sisimai::MSP.smtpagent(self); end
         def headerlist;  return []; end
         def pattern;     return Re0; end
 

data/lib/sisimai/msp/ru/mailru.rb

@@ -63,7 +63,7 @@ module Sisimai
         Indicators = Sisimai::MSP.INDICATORS
 
         def description; return '@mail.ru: https://mail.ru'; end
-        def smtpagent;   return 'RU::MailRu'; end
+        def smtpagent;   return Sisimai::MSP.smtpagent(self); end
         def headerlist;  return ['X-Failed-Recipients']; end
         def pattern;     return Re0; end
 

data/lib/sisimai/msp/ru/yandex.rb

@@ -19,7 +19,7 @@ module Sisimai
         Indicators = Sisimai::MSP.INDICATORS
 
         def description; return 'Yandex.Mail: http://www.yandex.ru'; end
-        def smtpagent;   return 'RU::Yandex'; end
+        def smtpagent;   return Sisimai::MSP.smtpagent(self); end
 
         # X-Yandex-Front: mxback1h.mail.yandex.net
         # X-Yandex-TimeMark: 1417885948

data/lib/sisimai/msp/uk/messagelabs.rb

@@ -25,7 +25,7 @@ module Sisimai
         Indicators = Sisimai::MSP.INDICATORS
 
         def description; return 'Symantec.cloud http://www.messagelabs.com'; end
-        def smtpagent;   return 'UK::MessageLabs'; end
+        def smtpagent;   return Sisimai::MSP.smtpagent(self); end
 
         # X-Msg-Ref: server-11.tower-143.messagelabs.com!1419367175!36473369!1
         # X-Originating-IP: [10.245.230.38]

data/lib/sisimai/msp/us/amazonses.rb

@@ -30,7 +30,7 @@ module Sisimai
         Indicators = Sisimai::MSP.INDICATORS
 
         def description; return 'Amazon SES(Sending): http://aws.amazon.com/ses/'; end
-        def smtpagent;   return 'US::AmazonSES'; end
+        def smtpagent;   return Sisimai::MSP.smtpagent(self); end
 
         # X-SenderID: Sendmail Sender-ID Filter v1.0.0 nijo.example.jp p7V3i843003008
         # X-Original-To: 000001321defbd2a-788e31c8-2be1-422f-a8d4-cf7765cc9ed7-000000@email-bounces.amazonses.com

data/lib/sisimai/msp/us/amazonworkmail.rb

@@ -22,7 +22,7 @@ module Sisimai
         Indicators = Sisimai::MSP.INDICATORS
 
         def description; return 'Amazon WorkMail: https://aws.amazon.com/workmail/'; end
-        def smtpagent;   return 'US::AmazonWorkMail'; end
+        def smtpagent;   return Sisimai::MSP.smtpagent(self); end
 
         # X-Mailer: Amazon WorkMail
         # X-Original-Mailer: Amazon WorkMail

data/lib/sisimai/msp/us/aol.rb

@@ -23,7 +23,7 @@ module Sisimai
         Indicators = Sisimai::MSP.INDICATORS
 
         def description; return 'Aol Mail: http://www.aol.com'; end
-        def smtpagent;   return 'US::Aol'; end
+        def smtpagent;   return Sisimai::MSP.smtpagent(self); end
 
         # X-AOL-IP: 192.0.2.135
         # X-AOL-VSS-INFO: 5600.1067/98281

data/lib/sisimai/msp/us/bigfoot.rb

@@ -21,7 +21,7 @@ module Sisimai
         Indicators = Sisimai::MSP.INDICATORS
 
         def description; return 'Bigfoot: http://www.bigfoot.com'; end
-        def smtpagent;   return 'US::Bigfoot'; end
+        def smtpagent;   return Sisimai::MSP.smtpagent(self); end
         def headerlist;  return []; end
         def pattern;     return Re0; end
 

data/lib/sisimai/msp/us/facebook.rb

@@ -80,7 +80,7 @@ module Sisimai
         Indicators = Sisimai::MSP.INDICATORS
 
         def description; return 'Facebook: https://www.facebook.com'; end
-        def smtpagent;   return 'US::Facebook'; end
+        def smtpagent;   return Sisimai::MSP.smtpagent(self); end
         def headerlist;  return []; end
         def pattern;     return Re0; end
 

data/lib/sisimai/msp/us/google.rb

@@ -112,7 +112,7 @@ module Sisimai
         Indicators = Sisimai::MSP.INDICATORS
 
         def description; return 'Google Gmail: https://mail.google.com'; end
-        def smtpagent;   return 'US::Google'; end
+        def smtpagent;   return Sisimai::MSP.smtpagent(self); end
         def headerlist;  return ['X-Failed-Recipients']; end
         def pattern;     return Re0; end
 

data/lib/sisimai/msp/us/office365.rb

@@ -55,7 +55,7 @@ module Sisimai
         Indicators = Sisimai::MSP.INDICATORS
 
         def description; return 'Microsoft Office 365: http://office.microsoft.com/'; end
-        def smtpagent;   return 'US::Office365'; end
+        def smtpagent;   return Sisimai::MSP.smtpagent(self); end
 
         def headerlist
           # X-MS-Exchange-Message-Is-Ndr:

data/lib/sisimai/msp/us/outlook.rb

@@ -26,7 +26,7 @@ module Sisimai
         Indicators = Sisimai::MSP.INDICATORS
 
         def description; return 'Microsoft Outlook.com: https://www.outlook.com/'; end
-        def smtpagent;   return 'US::Outlook'; end
+        def smtpagent;   return Sisimai::MSP.smtpagent(self); end
 
         # X-Message-Delivery: Vj0xLjE7RD0wO0dEPTA7U0NMPTk7bD0xO3VzPTE=
         # X-Message-Info: AuEzbeVr9u5fkDpn2vR5iCu5wb6HBeY4iruBjnutBzpStnUabbM...

data/lib/sisimai/msp/us/receivingses.rb

@@ -29,7 +29,7 @@ module Sisimai
         Indicators = Sisimai::MSP.INDICATORS
 
         def description; return 'Amazon SES(Receiving): http://aws.amazon.com/ses/'; end
-        def smtpagent;   return 'US::ReceivingSES'; end
+        def smtpagent;   return Sisimai::MSP.smtpagent(self); end
 
         # X-SES-Outgoing: 2015.10.01-54.240.27.7
         # Feedback-ID: 1.us-west-2.HX6/J9OVlHTadQhEu1+wdF9DBj6n6Pa9sW5Y/0pSOi8=:AmazonSES

data/lib/sisimai/msp/us/sendgrid.rb

@@ -22,7 +22,7 @@ module Sisimai
         Indicators = Sisimai::MSP.INDICATORS
 
         def description; return 'SendGrid: http://sendgrid.com/'; end
-        def smtpagent;   return 'US::SendGrid'; end
+        def smtpagent;   return Sisimai::MSP.smtpagent(self); end
 
         # Return-Path: <apps@sendgrid.net>
         # X-Mailer: MIME-tools 5.502 (Entity 5.502)

data/lib/sisimai/msp/us/verizon.rb

@@ -21,7 +21,7 @@ module Sisimai
         Indicators = Sisimai::MSP.INDICATORS
 
         def description; return 'Verizon Wireless: http://www.verizonwireless.com'; end
-        def smtpagent;   return 'US::Verizon'; end
+        def smtpagent;   return Sisimai::MSP.smtpagent(self); end
         def headerlist;  return []; end
         def pattern
           return {

data/lib/sisimai/msp/us/yahoo.rb

@@ -19,7 +19,7 @@ module Sisimai
         Indicators = Sisimai::MSP.INDICATORS
 
         def description; return 'Yahoo! MAIL: https://www.yahoo.com'; end
-        def smtpagent;   return 'US::Yahoo'; end
+        def smtpagent;   return Sisimai::MSP.smtpagent(self); end
 
         # X-YMailISG: YtyUVyYWLDsbDh...
         # X-YMail-JAS: Pb65aU4VM1mei...