sisimai 4.22.1 → 4.22.2

data/lib/sisimai/bite/email/zoho.rb

@@ -1,7 +1,7 @@
 module Sisimai::Bite::Email
+  # Sisimai::Bite::Email::Zoho parses a bounce email which created by Zoho Mail.
+  # Methods in the module are called from only Sisimai::Message.
   module Zoho
-    # Sisimai::Bite::Email::Zoho parses a bounce email which created by Zoho Mail.
-    # Methods in the module are called from only Sisimai::Message.
     class << self
       # Imported from p5-Sisimail/lib/Sisimai/Bite/Email/Zoho.pm
       require 'sisimai/bite/email'
@@ -14,15 +14,15 @@ module Sisimai::Bite::Email
             )
         }x,
         :'x-mailer' => %r/\AZoho Mail\z/,
-      }
+      }.freeze
       Re1 = {
         :begin  => %r/\AThis message was created automatically by mail delivery/,
         :rfc822 => %r/\AReceived:[ \t]*from mail[.]zoho[.]com/,
         :endof  => %r/\A__END_OF_EMAIL_MESSAGE__\z/,
-      }
+      }.freeze
       ReFailure = {
         expired: %r/Host not reachable/
-      }
+      }.freeze
       Indicators = Sisimai::Bite::Email.INDICATORS
 
       def description; return 'Zoho Mail: https://www.zoho.com'; end
@@ -68,7 +68,7 @@ module Sisimai::Bite::Email
             end
           end
 
-          if readcursor & Indicators[:'message-rfc822'] == 0
+          if (readcursor & Indicators[:'message-rfc822']).zero?
             # Beginning of the original message part
             if e =~ Re1[:rfc822]
               readcursor |= Indicators[:'message-rfc822']
@@ -87,7 +87,7 @@ module Sisimai::Bite::Email
 
           else
             # Before "message/rfc822"
-            next if readcursor & Indicators[:deliverystatus] == 0
+            next if (readcursor & Indicators[:deliverystatus]).zero?
             next if e.empty?
 
             # This message was created automatically by mail delivery software.
@@ -113,7 +113,7 @@ module Sisimai::Bite::Email
               v['recipient'] = cv[1]
               v['diagnosis'] = cv[2]
 
-              if v['diagnosis'] =~ /=\z/
+              if v['diagnosis'].end_with?('=')
                 # Quoted printable
                 v['diagnosis'] = v['diagnosis'].sub(/=\z/, '')
                 qprintable = true

data/lib/sisimai/bite/json.rb

@@ -1,11 +1,10 @@
 module Sisimai
   module Bite
+    # Sisimai::Bite::JSON - Base class for Sisimai::Bite::JSON::*
     module JSON
-      # Sisimai::Bite::JSON - Base class for Sisimai::Bite::JSON::*
       class << self
         # Imported from p5-Sisimail/lib/Sisimai/Bite/JSON.pm
         require 'sisimai/bite'
-        require 'sisimai/rfc5322'
 
         def headerlist; return []; end
         def pattern;    return []; end
@@ -17,18 +16,18 @@ module Sisimai
         end
 
         # Convert from JSON object to Sisimai::Message
-        # @param         [Hash] mhead       Message header of a bounce email
-        # @param         [String] mbody     Message body of a bounce email(JSON)
-        # @return        [Hash, Undef]      Bounce data list and message/rfc822 part
-        #                                   or Undef if it failed to parse or the
-        #                                   arguments are missing
+        # @param         [Hash] mhead   Message header of a bounce email
+        # @param         [String] mbody Message body of a bounce email(JSON)
+        # @return        [Hash, Nil]    Bounce data list and message/rfc822 part
+        #                               or nil if it failed to parse or the
+        #                               arguments are missing
         def scan; return nil; end
 
         # @abstract      Adapt bounce object for Sisimai::Message format
-        # @param         [Hash] argvs       bounce object returned from each email cloud
-        # @return        [Hash, Undef]      Bounce data list and message/rfc822 part
-        #                                   or Undef if it failed to parse or the
-        #                                   arguments are missing
+        # @param         [Hash] argvs   bounce object returned from each email cloud
+        # @return        [Hash, Nil]    Bounce data list and message/rfc822 part
+        #                               or nil if it failed to parse or the
+        #                               arguments are missing
         def adapt; return nil; end
 
       end

data/lib/sisimai/bite/json/amazonses.rb

@@ -21,7 +21,7 @@ module Sisimai::Bite::JSON
           :ContentRejected    => '',
           :AttachmentRejected => '',
         },
-      }
+      }.freeze
 
       def smtpagent;   return Sisimai::Bite.smtpagent(self); end
       def description; return 'Amazon SES(JSON): http://aws.amazon.com/ses/'; end
@@ -98,8 +98,8 @@ module Sisimai::Bite::JSON
 
       # @abstract Adapt Amazon SES bounce object for Sisimai::Message format
       # @param        [Hash] argvs  bounce object(JSON) retrieved from Amazon SNS
-      # @return       [Hash, Nil]   Bounce data list and message/rfc822 part
-      #                             or Undef if it failed to parse or the
+      # @return       [Hash, Nil]   Bounce data list and message/rfc822 part or
+      #                             nil if it failed to parse or the
       #                             arguments are missing
       # @since v4.20.0
       def adapt(argvs)
@@ -119,8 +119,8 @@ module Sisimai::Bite::JSON
 
         if argvs['notificationType'] =~ /\A(?:Bounce|Complaint)\z/
           # { "notificationType":"Bounce", "bounce": { "bounceType":"Permanent",...
-          o = argvs[ argvs['notificationType'].downcase ]
-          r = o[ labeltable[ argvs['notificationType'].to_sym ] ] || []
+          o = argvs[argvs['notificationType'].downcase]
+          r = o[labeltable[argvs['notificationType'].to_sym]] || []
 
           r.each do |e|
             # 'bouncedRecipients' => [ { 'emailAddress' => 'bounce@si...' }, ... ]
@@ -161,11 +161,11 @@ module Sisimai::Bite::JSON
 
               if BounceType.key?(o['bounceType'].to_sym) &&
                  BounceType[o['bounceType'].to_sym].key?(o['bounceSubType'].to_sym)
-                  # 'bounce' => {
-                  #       'bounceType' => 'Permanent',
-                  #       'bounceSubType' => 'General'
-                  # },
-                  v['reason'] = BounceType[o['bounceType'].to_sym][o['bounceSubType'].to_sym]
+                # 'bounce' => {
+                #       'bounceType' => 'Permanent',
+                #       'bounceSubType' => 'General'
+                # },
+                v['reason'] = BounceType[o['bounceType'].to_sym][o['bounceSubType'].to_sym]
               end
 
             else
@@ -235,7 +235,7 @@ module Sisimai::Bite::JSON
           argvs['mail']['headers'].each do |e|
             # 'headers' => [ { 'name' => 'From', 'value' => 'neko@nyaan.jp' }, ... ],
             next unless e['name'] =~ /\A(?:From|To|Subject|Message-ID|Date)\z/
-            rfc822head[ e['name'].downcase ] = e['value']
+            rfc822head[e['name'].downcase] = e['value']
           end
         end
 

data/lib/sisimai/bite/json/sendgrid.rb

@@ -11,31 +11,89 @@ module Sisimai::Bite::JSON
 
       # @abstract Adapt SendGrid bounce object for Sisimai::Message format
       # @param        [Hash] argvs  bounce object(JSON) retrieved from SendGrid API
-      # @return       [Hash, Nil]   Bounce data list and message/rfc822 part
-      #                             or Undef if it failed to parse or the
+      # @return       [Hash, Nil]   Bounce data list and message/rfc822 part or
+      #                             nil if it failed to parse or the
       #                             arguments are missing
       # @since v4.20.0
       def adapt(argvs)
         return nil unless argvs.is_a? Hash
         return nil unless argvs.keys.size > 0
         return nil unless argvs.key?('email')
-
-        dscontents = [Sisimai::Bite.DELIVERYSTATUS]
-        rfc822head = {}     # (Hash) Check flags for headers in RFC822 part
-        recipients = 0      # (Integer) The number of 'Final-Recipient' header
-        v = dscontents[-1]
+        return nil unless Sisimai::RFC5322.is_emailaddress(argvs['email'])
 
         require 'sisimai/string'
         require 'sisimai/address'
+        require 'sisimai/datetime'
+        require 'sisimai/smtp/reply'
+        require 'sisimai/smtp/status'
+
+        dscontents = nil
+        rfc822head = {}
+        v = nil
+
+        if argvs.key?('event')
+          # https://sendgrid.com/docs/API_Reference/Webhooks/event.html
+          # {
+          #   'tls' => 0,
+          #   'timestamp' => 1504555832,
+          #   'event' => 'bounce',
+          #   'email' => 'mailboxfull@example.jp',
+          #   'ip' => '192.0.2.22',
+          #   'sg_message_id' => '03_Wof6nRbqqzxRvLpZbfw.filter0017p3mdw1-11399-59ADB335-16.0',
+          #   'type' => 'blocked',
+          #   'sg_event_id' => 'S4wr46YHS0qr3BKhawTQjQ',
+          #   'reason' => '550 5.2.2 <mailboxfull@example.jp>... Mailbox Full ',
+          #   'smtp-id' => '<201709042010.v84KAQ5T032530@example.nyaan.jp>',
+          #   'status' => '5.2.2'
+          # },
+          return nil unless argvs['event'] =~ /\A(?:bounce|deferred|delivered|spamreport)\z/
+          dscontents = [Sisimai::Bite.DELIVERYSTATUS]
+          diagnostic = argvs['reason']   || ''
+          diagnostic = argvs['response'] || '' if diagnostic.empty?
+          timestamp0 = Sisimai::Time.parse(::Time.at(argvs['timestamp']).to_s)
+          v = dscontents[-1]
+
+          v['date']      = timestamp0.strftime("%a, %d %b %Y %T %z")
+          v['agent']     = self.smtpagent
+          v['lhost']     = argvs['ip'] || ''
+          v['status']    = argvs['status'] || nil
+          v['diagnosis'] = Sisimai::String.sweep(diagnostic)
+          v['recipient'] = argvs['email']
+
+          if argvs['event'] == 'delivered'
+            # "event": "delivered"
+            v['reason'] = 'delivered'
+          elsif argvs['event'] == 'spamreport'
+            # [
+            #   {
+            #     "email": "kijitora@example.com",
+            #     "timestamp": 1504837383,
+            #     "sg_message_id": "6_hrAeKvTDaB5ynBI2nbnQ.filter0002p3las1-27574-59B1FDA3-19.0",
+            #     "sg_event_id": "o70uHqbMSXOaaoveMZIjjg",
+            #     "event": "spamreport"
+            #   }
+            # ]
+            v['reason'] = 'feedback'
+            v['feedbacktype'] = 'abuse'
+          end
+          v['status']    ||= Sisimai::SMTP::Status.find(v['diagnosis']) || ''
+          v['replycode'] ||= Sisimai::SMTP::Reply.find(v['diagnosis'])  || ''
 
-        if Sisimai::RFC5322.is_emailaddress(argvs['email'])
+          # Generate pseudo message/rfc822 part
+          rfc822head = {
+            'from'       => Sisimai::Address.undisclosed('s'),
+            'message-id' => v['sg_message_id'],
+          }
+        else
           #   {
           #       "status": "4.0.0",
           #       "created": "2011-09-16 22:02:19",
           #       "reason": "Unable to resolve MX host sendgrid.ne",
           #       "email": "esting@sendgrid.ne"
           #   },
-          recipients += 1
+          dscontents = [Sisimai::Bite.DELIVERYSTATUS]
+          v = dscontents[-1]
+
           v['recipient'] = argvs['email']
           v['date'] = argvs['created'] || ''
 
@@ -51,8 +109,6 @@ module Sisimai::Bite::JSON
             v['status'] = statuscode
           end
 
-          require 'sisimai/smtp/reply'
-          require 'sisimai/smtp/status'
           v['status']    ||= Sisimai::SMTP::Status.find(diagnostic)
           v['replycode'] ||= Sisimai::SMTP::Reply.find(diagnostic)
           v['diagnosis']   = argvs['reason'] || ''
@@ -60,16 +116,10 @@ module Sisimai::Bite::JSON
 
           # Generate pseudo message/rfc822 part
           rfc822head = {
-            'to'   => argvs['email'],
             'from' => Sisimai::Address.undisclosed('s'),
             'date' => v['date'],
           }
-        else
-          # The value of $argvs->{'email'} does not seems to an email address
-          return nil
         end
-
-        return nil if recipients.zero?
         return { 'ds' => dscontents, 'rfc822' => rfc822head }
       end
 

data/lib/sisimai/data.rb

@@ -47,22 +47,20 @@ module Sisimai
     AddrHeader = {
       addresser: RFC822Head[:addresser],
       recipient: RFC822Head[:recipient],
-    }
+    }.freeze
     ActionList = %r/\A(?:failed|delayed|delivered|relayed|expanded)\z/
     ActionHead = {
       %r/\Afailure\z/ => 'failed',
       %r/\Aexpired\z/ => 'delayed',
-    }
+    }.freeze
 
     # Constructor of Sisimai::Data
     # @param    [Hash] argvs    Data
     # @return   [Sisimai::Data] Structured email data
     def initialize(argvs)
-      thing = {}
-
       # Create email address object
       as = Sisimai::Address.make(argvs['addresser'])
-      ar = Sisimai::Address.make({ address: argvs['recipient'] })
+      ar = Sisimai::Address.make(address: argvs['recipient'])
 
       return nil unless as.is_a? Sisimai::Address
       return nil unless ar.is_a? Sisimai::Address
@@ -216,7 +214,7 @@ module Sisimai
         end
 
         if datestring
-          # Get the value of timezone offset from $datestring
+          # Get the value of timezone offset from datestring
           if cv = datestring.match(/\A(.+)[ ]+([-+]\d{4})\z/)
             # Wed, 26 Feb 2014 06:05:48 -0500
             datestring = cv[1]
@@ -361,13 +359,13 @@ module Sisimai
             textasargv = textasargv.gsub(/\A[ ]/, '')
             softorhard = Sisimai::SMTP::Error.soft_or_hard(o.reason, textasargv)
 
-            if softorhard.size > 0
-              # Returned value is "soft" or "hard"
-              o.softbounce = (softorhard == 'soft') ? 1 : 0
-            else
-              # Returned value is an empty string
-              o.softbounce = (-1)
-            end
+            o.softbounce = if softorhard.size > 0
+                             # Returned value is "soft" or "hard"
+                             (softorhard == 'soft') ? 1 : 0
+                           else
+                             # Returned value is an empty string
+                             -1
+                           end
           end
 
           if o.deliverystatus.empty?
@@ -387,13 +385,13 @@ module Sisimai
                 # set the value of "softbounce" again when the value is -1
                 softorhard = Sisimai::SMTP::Error.soft_or_hard(o.reason, pseudocode)
 
-                if softorhard.size > 0
-                  # Returned value is "soft" or "hard"
-                  o.softbounce = softorhard == 'soft' ? 1 : 0
-                else
-                  # Returned value is an empty string
-                  o.softbounce = -1
-                end
+                o.softbounce = if softorhard.size > 0
+                                 # Returned value is "soft" or "hard"
+                                 softorhard == 'soft' ? 1 : 0
+                               else
+                                 # Returned value is an empty string
+                                 -1
+                               end
               end
             end
           end
@@ -427,7 +425,7 @@ module Sisimai
 
     # Data dumper
     # @param    [String] type   Data format: json, yaml
-    # @return   [String, Undef] Dumped data or Undef if the value of first
+    # @return   [String, Nil]   Dumped data or nil if the value of the first
     #                           argument is neither "json" nor "yaml"
     def dump(type = 'json')
       return nil unless %w|json yaml|.index(type)

data/lib/sisimai/data/json.rb

@@ -6,9 +6,9 @@ module Sisimai
       # Imported from p5-Sisimail/lib/Sisimai/Data/JSON.pm
       class << self
         # Data dumper(JSON)
-        # @param    [Sisimai::Data] argvs   Object
-        # @return   [String, Nil]           Dumped data or Undef if the argument
-        #                                   is missing
+        # @param    [Sisimai::Data] argvs Object
+        # @return   [String, Nil]         Dumped data or nil if the argument
+        #                                 is missing
         def dump(argvs)
           return nil unless argvs
           return nil unless argvs.is_a? Sisimai::Data

data/lib/sisimai/data/yaml.rb

@@ -8,9 +8,9 @@ module Sisimai
         require 'yaml'
 
         # Data dumper(YAML)
-        # @param    [Sisimai::Data] argvs   Object
-        # @return   [String, Undef]         Dumped data or Undef if the argument
-        #                                   is missing
+        # @param    [Sisimai::Data] argvs Object
+        # @return   [String, Nil]         Dumped data or nil if the argument
+        #                                 is missing
         def dump(argvs)
           return nil unless argvs
           return nil unless argvs.is_a? Sisimai::Data

data/lib/sisimai/datetime.rb

@@ -25,23 +25,23 @@ module Sisimai
         b: 86.4,                  # Beat, Swatch internet time: 1000b = 1d
         m: 60,                    # Minute,
         s: 1,                     # Second
-      }
+      }.freeze
 
       MathematicalConstant = {
         e: CONST_E,
         p: CONST_P,
         g: CONST_E**CONST_P,
-      }
+      }.freeze
 
       MonthName = {
         full: %w|January February March April May June July August September October November December|,
         abbr: %w|Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec|,
-      }
+      }.freeze
 
       DayOfWeek = {
         full: %w|Sunday Monday Tuesday Wednesday Thursday Friday Saturday|,
-        abbr: %w|Sun Mon Tue Wed Thu Fri Sat |,
-      }
+        abbr: %w|Sun Mon Tue Wed Thu Fri Sat|,
+      }.freeze
 
       HourName = {
         full: [
@@ -49,7 +49,7 @@ module Sisimai
           'Noon', 13, 14, 15, 16, 17, 'Evening', 19, 20, 21, 22, 23,
         ],
         abbr: [0..23],
-      }
+      }.freeze
 
       TimeZoneAbbr = {
         # http://en.wikipedia.org/wiki/List_of_time_zone_abbreviations
@@ -178,7 +178,7 @@ module Sisimai
         # WET:   '-0000', # Western European Time             UTC
         # YAKT:  '+0900', # Yakutsk Time                      UTC+09:00
         # YEKT:  '+0500', # Yekaterinburg Time                UTC+05:00
-      }
+      }.freeze
 
       # Convert to second
       # @param    [String] argv1  Digit and a unit of time
@@ -334,7 +334,7 @@ module Sisimai
             end
 
           elsif cr = p.match(/\A([0-2]\d):([0-5]\d):([0-5]\d)\z/) ||
-                cr = p.match(/\A(\d{1,2})[-:](\d{1,2})[-:](\d{1,2})\z/)
+                     p.match(/\A(\d{1,2})[-:](\d{1,2})[-:](\d{1,2})\z/)
             # Time; 12:34:56, 03:14:15, ...
             # Arrival-Date: 2014-03-26 00-01-19
 
@@ -379,10 +379,7 @@ module Sisimai
                 # ISO 8601; 2000-04-29T01:23:45
                 v[:Y] = cr[1].to_i
                 v[:M] = MonthName[:abbr][cr[2].to_i - 1]
-
-                if cr[3].to_i < 32
-                  v[:d] = cr[3].to_i
-                end
+                v[:d] = cr[3].to_i if cr[3].to_i < 32
 
                 if cr[4].to_i < 24 && cr[5].to_i < 60 && cr[6].to_i < 60
                   v[:T] = sprintf('%02d:%02d:%02d', cr[4], cr[5], cr[6])
@@ -417,13 +414,13 @@ module Sisimai
         # Adjust 2-digit Year
         if altervalue[:Y] && !v[:Y]
           # Check alternative value(Year)
-          if altervalue[:Y].to_i >= 82
-            # SMTP was born in 1982
-            v[:Y] ||= 1900 + altervalue[:Y].to_i
-          else
-            # 20XX
-            v[:Y] ||= 2000 + altervalue[:Y].to_i
-          end
+          v[:Y] ||= if altervalue[:Y].to_i >= 82
+                      # SMTP was born in 1982
+                      1900 + altervalue[:Y].to_i
+                    else
+                      # 20XX
+                      2000 + altervalue[:Y].to_i
+                    end
         end
 
         # Check each piece
@@ -445,7 +442,7 @@ module Sisimai
 
       # Abbreviation -> Tiemzone
       # @param    [String] argv1  Abbr. e.g.) JST, GMT, PDT
-      # @return   [String, Undef] +0900, +0000, -0600 or Undef if the argument is
+      # @return   [String, Nil]   +0900, +0000, -0600 or nil if the argument is
       #                           invalid format or not supported abbreviation
       # @example  Get the timezone string of "JST"
       #   abbr2tz('JST')  #=> '+0900'
@@ -456,7 +453,7 @@ module Sisimai
 
       # Convert to second
       # @param    [String] argv1  Timezone string e.g) +0900
-      # @return   [Integer,Undef] n: seconds or Undef it the argument is invalid
+      # @return   [Integer, Nil]  n: seconds or nil it the argument is invalid
       #                           format string
       # @see      second2tz
       # @example  Convert '+0900' to seconds