sisimai 4.25.4 → 4.25.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ae7efed62436e79f66169f4330363ee5a29da001d3c27116d482691c52b41a6
-  data.tar.gz: acabb1f0447f1f077bafb00bff61184e124fe6dffc0c3333f1cb192e8c7eaf9f
+  metadata.gz: bf50fe472bdf358908619b5571800aa29c181ed59c11bcc52718c504f54ec991
+  data.tar.gz: d764cfda21b0b8c49e53f50b5ddd7527665e8c9721a5c4a1bebb8e9dc9eac2a6
 SHA512:
-  metadata.gz: 8ec06a3be887143a9d0d0cdd33ae5616003127ec4f2d9d49cfdc85d201f858f4bf43f1ef18be267ee36f39d6974dde414a884d78b200d81f5d9fcfbb3cfb678b
-  data.tar.gz: 98f96ff3685f168e7f3012ba157421d2a79fc1e35adc46da9f69eb0061717fba2bd171b7eca301b5c182746486b3bedd6c2346af0dbe66fc55fd6d86e95e8dde
+  metadata.gz: ce283bb17ad9beb4a82186e653a67c92e6357652db7148c30ad69ae5ab9d6734a49a5c88b0ac2c6302cb13274350644ca4651fafa3aa5eaf96edc0a49c73a849
+  data.tar.gz: 9cbd0b351b7166af32183255e492cd4490017a037443e867bc63d6ca13939d7d5cc123b903464c711628bb4497a14d86de027e547abe55aed788e78286b85367

data/.travis.yml

@@ -3,8 +3,8 @@ rvm:
   # See http://rubies.travis-ci.org for Precompiled Ruby Versions
   - 2.1.1
   - 2.2.4
-  - 2.3.0
-  - 2.4.0
+# - 2.3.0
+# - 2.4.0
 # - 2.5.0
   - 2.6.0
 # - jruby-9.0.5.0

data/ChangeLog.md

@@ -3,6 +3,56 @@ RELEASE NOTES for Ruby version of Sisimai
 - releases: "https://github.com/sisimai/rb-Sisimai/releases"
 - download: "https://rubygems.org/gems/sisimai"
 
+v4.25.5
+--------------------------------------------------------------------------------
+- release: "Wed, 22 Jan 2020 14:44:44 +0900 (JST)"
+- version: "4.25.5"
+- changes:
+  - **JSON READING AS A INPUT SOURCE AND JSON PARSING AS A BOUNCE OBJECT ARE NO
+    LONGER PROVIDED AS OF v4.25.5**
+  - The following obsoleted classes and modules have been removed #166 #168
+    - `Sisimai::Message::Email`
+    - `Sisimai::Message::JSON`
+    - `Sisimai::Order::Email`
+    - `Sisimai::Order::JSON`
+    - `Sisimai::Bite::Email`
+    - `Sisimai::Bite::JSON`
+  - Fix bug in code to detect whether a bounce mail was generated by Office365
+    or not at `Sisimai::Lhost::Office365`
+  - Import sisimai/p5-Sisimai#342
+    - Fix parser code to get an error message which is not beginning with `#`
+      character at Exchange2007.
+  - Import sisimai/p5-Sisimai#347
+    - Support case insensitive error code at `Sisimai::Rhost::FrancePTT`,
+  - Import sisimai/p5-Sisimai#348
+    - Code improvements at `Sisimai::Lhost::EinsUndEins` for detecting errors
+      and setting the value of `rhost`
+  - Many Pull-Requests and sample emails for French ESPs by @aderumier
+    - Add 4 error code values at `Sisimai::Rhost::FrancePTT`
+      - `102` = `blocked`
+      - `426` = `suspend`
+      - `505` = `systemerror`
+      - `999` = `blocked`
+    - Add 7 sample emails at set-of-emails/ directory: rhost-franceptt-04, 05,
+      06, 07, 08, 10, and 11 for `Sisimai::Rhost::FrancePTT` #353 #357
+    - Add many error codes and error messages from Orange and La Poste
+  - Import sisimai/p5-Sisimai#350
+    - Code improvement at `Sisimai::Lhost::Postfix` for setting `HELO` into the
+      value of `smtpcommand` in the parsed results.
+  - Import sisimai/p5-Sisimai#351
+    - Code improvements at `Sisimai::Lhost::Postfix` for parsing an email which
+      have neither delivery reports nor error messages.
+  - Import sisimai/p5-Sisimai#352
+    - Code improvements at `Sisimai::RFC3834` for parsing a vacation message
+      replied automatically from iCloud.
+  - Accessor improvements in the following classes:
+    - `Sisimai::Message`
+    - `Sisimai::Data`
+    - `Sisimai::Mail` and child classes in `sisimai/mail` directory
+  - Fix duplicated ranges in some regular expressions at `Sisimai::Address`
+  - Large scale code improvement at each modules in `Sisimai::Lhost`
+  - reduce the number of lines in code about 12%
+
 v4.25.4
 --------------------------------------------------------------------------------
 - release: "Tue,  3 Dec 2019 12:34:45 +0900 (JST)"

data/README-JA.md

@@ -19,7 +19,6 @@
 - [使い方 | Usage](#usage)
     - [基本的な使い方 | Basic usage](#basic-usage)
     - [解析結果をJSONで得る | Convert to JSON](#convert-to-json)
-    - [バウンスオブジェクトを読む | Read bounce object](#read-bounce-object)
     - [コールバック機能 | Callback feature](#callback-feature)
     - [ワンライナー | One-Liner](#one-liner)
     - [出力例 | Output example](#output-example)
@@ -56,8 +55,6 @@ Key features
   * 解析精度はbounceHammerの2倍
   * 29種類のMTAに対応
   * 22種類の著名なMSPに対応
-  * 2種類の著名なメール配信クラウドに対応(JSON)
-    * **Sisimai 4.25.5で削除予定**
   * Feedback Loopにも対応
   * 29種類のエラー理由を検出
 
@@ -81,10 +78,10 @@ Install
 
 ```shell
 $ sudo gem install sisimai
-Fetching: sisimai-4.25.2.gem (100%)
-Successfully installed sisimai-4.25.2
-Parsing documentation for sisimai-4.25.2
-Installing ri documentation for sisimai-4.25.2
+Fetching: sisimai-4.25.5.gem (100%)
+Successfully installed sisimai-4.25.5
+Parsing documentation for sisimai-4.25.5
+Installing ri documentation for sisimai-4.25.5
 Done installing documentation for sisimai after 6 seconds
 1 gem installed
 ```
@@ -100,8 +97,8 @@ gem install bundle rake rspec coveralls
 ...
 4 gems installed
 bundle exec rake install
-sisimai 4.25.2 built to pkg/sisimai-4.25.2.gem.
-sisimai (4.25.2) installed.
+sisimai 4.25.5 built to pkg/sisimai-4.25.5.gem.
+sisimai (4.25.5) installed.
 ```
 
 Usage
@@ -159,30 +156,6 @@ puts Sisimai.dump('/path/to/mbox')  # or path to Maildir/
 puts Sisimai.dump('/path/to/mbox', delivered: true)
 ```
 
-Read bounce object
--------------------------------------------------------------------------------
-**この機能はSisimai 4.25.5で削除されます**
-
-メール配信クラウドからAPIで取得したバウンスオブジェクト(JSON)を読んで解析する
-場合は、次のようなコードを書いてください。この機能はSisimai v4.20.0で実装され
-ました。
-
-```ruby
-#! /usr/bin/env ruby
-require 'json'
-require 'sisimai'
-
-j = JSON.load('{"notificationType"=>"Bounce", "bounce"=>{"...') # JSON String
-v = Sisimai.make(j, input: 'json')
-
-if v.is_a? Array
-  v.each do |e|
-    ...
-  end
-end
-```
-現時点ではAmazon SESとSendGridのみをサポートしています。
-
 Callback feature
 -------------------------------------------------------------------------------
 Sisimai 4.19.0から`Sisimai.make()`と`Sisimai.dump()`にLamda(Procオブジェクト)
@@ -244,11 +217,11 @@ Differences between Ruby version and Perl version
 | 動作環境                                    | Ruby 2.1 - 2.6 | Perl 5.10 -   |
 |                                             | JRuby 9.0.4.0- |               |
 | 解析精度の割合(2000通のメール)[1]           | 1.00           | 1.00          |
-| メール解析速度(1000通のメール)              | 2.22秒[2]      | 1.50秒        |
+| メール解析速度(1000通のメール)              | 2.22秒[2]      | 1.35秒        |
 | インストール方法                            | gem install    | cpanm, cpm    |
 | 依存モジュール数(コアモジュールを除く)      | 1モジュール    | 2モジュール   |
-| LOC:ソースコードの行数                      | 11700行        | 8300行        |
-| テスト件数(spec/,t/,xt/ディレクトリ)        | 227700件       | 250000件      |
+| LOC:ソースコードの行数                      | 10300行        | 7100行        |
+| テスト件数(spec/,t/,xt/ディレクトリ)        | 230000件       | 250000件      |
 | ライセンス                                  | 二条項BSD      | 二条項BSD     |
 | 開発会社によるサポート契約                  | 提供中         | 提供中        |
 
@@ -303,7 +276,7 @@ Author
 
 Copyright
 ===============================================================================
-Copyright (C) 2015-2019 azumakuniyuki, All Rights Reserved.
+Copyright (C) 2015-2020 azumakuniyuki, All Rights Reserved.
 
 License
 ===============================================================================

data/README.md

@@ -19,7 +19,6 @@
 - [Usage](#usage)
     - [Basic usage](#basic-usage)
     - [Convert to JSON](#convert-to-json)
-    - [Read bounce object](#read-bounce-object)
     - [Callback feature](#callback-feature)
     - [One-Liner](#one-liner)
     - [Output example](#output-example)
@@ -55,8 +54,6 @@ Key Features
   * 2 times higher than bounceHammer
   * Support 24 known MTAs and 5 unknown MTAs
   * Support 22 major MSPs(Mail Service Providers)
-  * Support 2 major Cloud Email Delivery Services(JSON format)
-    * **WILL BE REMOVED AT Sisimai 4.25.5**
   * Support Feedback Loop Message(ARF)
   * Can detect 29 error reasons
 
@@ -86,10 +83,10 @@ Install
 
 ```shell
 $ sudo gem install sisimai
-Fetching: sisimai-4.25.1.gem (100%)
-Successfully installed sisimai-4.25.1
-Parsing documentation for sisimai-4.25.1
-Installing ri documentation for sisimai-4.25.1
+Fetching: sisimai-4.25.5.gem (100%)
+Successfully installed sisimai-4.25.5
+Parsing documentation for sisimai-4.25.5
+Installing ri documentation for sisimai-4.25.5
 Done installing documentation for sisimai after 6 seconds
 1 gem installed
 ```
@@ -105,8 +102,8 @@ gem install bundle rake rspec coveralls
 ...
 4 gems installed
 bundle exec rake install
-sisimai 4.25.1 built to pkg/sisimai-4.25.1.gem.
-sisimai (4.25.1) installed.
+sisimai 4.25.5 built to pkg/sisimai-4.25.5.gem.
+sisimai (4.25.5) installed.
 ```
 
 Usage
@@ -164,30 +161,6 @@ puts Sisimai.dump('/path/to/mbox')  # or path to Maildir/
 puts Sisimai.dump('/path/to/mbox', delivered: true)
 ```
 
-Read bounce object
--------------------------------------------------------------------------------
-**THIS FEATURE WILL BE REMOVED AT SISIMAI 4.25.5**
-
-The way to read a bounce object retrived from Cloud Email Services as JSON using
-their API is the following code. This feature is available at between v4.20.0
-and **v4.25.5**.
-
-```ruby
-#! /usr/bin/env ruby
-require 'json'
-require 'sisimai'
-
-j = JSON.load('{"notificationType"=>"Bounce", "bounce"=>{"...') # JSON String
-v = Sisimai.make(j, input: 'json')
-
-if v.is_a? Array
-  v.each do |e|
-    ...
-  end
-end
-```
-As of present, Only Amazon SES and SendGrid are supported.
-
 Callback feature
 -------------------------------------------------------------------------------
 Beginning with Sisimai 4.19.0, `make()` and `dump()` methods of Sisimai accept
@@ -248,11 +221,11 @@ and bounceHammer are available at
 | System requirements                         | Ruby 2.1 - 2.6 | Perl 5.10 -   |
 |                                             | JRuby 9.0.4.0- |               |
 | Analytical precision ratio(2000 emails)[1]  | 1.00           | 1.00          |
-| The speed of parsing email(1000 emails)     | 2.22s[2]       | 1.50s         |
+| The speed of parsing email(1000 emails)     | 2.22s[2]       | 1.35s         |
 | How to install                              | gem install    | cpanm, cpm    |
 | Dependencies (Except core modules)          | 1 module       | 2 modules     |
-| LOC:Source lines of code                    | 11700 lines    | 8300 lines    |
-| The number of tests(spec/,t/,xt/) directory | 227600 tests   | 250000 tests  |
+| LOC:Source lines of code                    | 10300 lines    | 7100 lines    |
+| The number of tests(spec/,t/,xt/) directory | 230000 tests   | 250000 tests  |
 | License                                     | BSD 2-Clause   | BSD 2-Clause  |
 | Support Contract provided by Developer      | Available      | Available     |
 
@@ -309,7 +282,7 @@ Author
 
 Copyright
 ===============================================================================
-Copyright (C) 2015-2019 azumakuniyuki, All Rights Reserved.
+Copyright (C) 2015-2020 azumakuniyuki, All Rights Reserved.
 
 License
 ===============================================================================

data/lib/sisimai.rb

@@ -19,82 +19,34 @@ module Sisimai
     # @param         [Hash]   argv1      Parser options(delivered=false)
     # @options argv1 [Boolean] delivered true: Include "delivered" reason
     # @options argv1 [Lambda]  hook      Lambda object to be called back
-    # @options argv1 [String]  input     Input data format: 'email', 'json'
     # @options argv1 [Array]   field     Email header name to be captured
     # @return        [Array]             Parsed objects
     # @return        [nil]               nil if the argument was wrong or an empty array
     def make(argv0, **argv1)
       return nil unless argv0
 
-      input = argv1[:input] || nil
       field = argv1[:field] || []
       raise ' ***error: "field" accepts an array only' unless field.is_a? Array
 
-      unless input
-        klass = argv0.class
-        # "input" did not specified, try to detect automatically.
-        if klass == ::String || klass == IO
-          # The argument may be a path to email OR an email text
-          input = 'email'
-        elsif klass == Array || klass == Hash
-          # The argument may be a decoded JSON object
-          input = 'json'
-        end
-      end
-
-      delivered1 = argv1[:delivered] || false
-      hookmethod = argv1[:hook] || nil
-      bouncedata = []
-
       require 'sisimai/data'
       require 'sisimai/message'
-      if input == 'email'
-        # Path to mailbox or Maildir/, or STDIN: 'input' => 'email'
-        require 'sisimai/mail'
-        return nil unless mail = Sisimai::Mail.new(argv0)
-
-        while r = mail.read do
-          # Read and parse each mail file
-          methodargv = { data: r, hook: hookmethod, input: 'email', field: field }
-          mesg = Sisimai::Message.new(methodargv)
-          next if mesg.void
-
-          methodargv = { data: mesg, hook: hookmethod, input: 'email', delivered: delivered1 }
-          next unless data = Sisimai::Data.make(methodargv)
-          bouncedata += data unless data.empty?
-        end
-
-      elsif input == 'json'
-        # Decoded JSON object: 'input' => 'json'
-        warn ' ***warning: input: "json" is marked as obsoleted'
-        type = argv0.class.to_s
-        list = []
-
-        if type == 'Array'
-          # [ {...}, {...}, ... ]
-          while e = argv0.shift do
-            list << e
-          end
-        else
-          list << argv0
-        end
-
-        while e = list.shift do
-          methodargv = { data: e, hook: hookmethod, input: 'json' }
-          mesg = Sisimai::Message.new(methodargv)
-          next if mesg.void
-
-          methodargv = { data: mesg, hook: hookmethod, input: 'json', delivered: delivered1 }
-          next unless data = Sisimai::Data.make(methodargv)
-          bouncedata += data unless data.empty?
-        end
-      else
-        # The value of "input" neither "email" nor "json"
-        raise ' ***error: invalid value of "input"'
+      require 'sisimai/mail'
+
+      list = []
+      return nil unless mail = Sisimai::Mail.new(argv0)
+      while r = mail.read do
+        # Read and parse each mail file
+        methodargv = { data: r, hook: argv1[:hook], field: field }
+        mesg = Sisimai::Message.new(methodargv)
+        next if mesg.void
+
+        methodargv = { data: mesg, delivered: argv1[:delivered] }
+        next unless data = Sisimai::Data.make(methodargv)
+        list += data unless data.empty?
       end
 
-      return nil if bouncedata.empty?
-      return bouncedata
+      return nil if list.empty?
+      return list 
     end
 
     # Wrapper method to parse mailbox/Maildir and dump as JSON
@@ -104,7 +56,6 @@ module Sisimai
     # @param         [Hash] argv1        Parser options
     # @options argv1 [Integer] delivered true: Include "delivered" reason
     # @options argv1 [Lambda]  hook      Lambda object to be called back
-    # @options argv1 [String]  input     Input data format: 'email', 'json'
     # @return        [String]            Parsed data as JSON text
     def dump(argv0, **argv1)
       return nil unless argv0

data/lib/sisimai/address.rb

@@ -30,7 +30,7 @@ module Sisimai
     #           # => Sisimai::Address object
     def self.make(argvs)
       return nil unless argvs.is_a? Hash
-      return nil unless argvs.key?(:address)
+      return nil unless argvs[:address]
       return nil if argvs[:address].empty?
 
       thing = Sisimai::Address.new(argvs[:address])
@@ -69,7 +69,7 @@ module Sisimai
 
       while e = characters.shift do
         # Check each characters
-        if Delimiters.key?(e)
+        if Delimiters[e]
           # The character is a delimiter character
           if e == ','
             # Separator of email addresses or not
@@ -283,7 +283,7 @@ module Sisimai
     #   expand_verp('bounce+neko=example.org@example.org') #=> 'neko@example.org'
     def self.expand_verp(email)
       return nil unless email.is_a? Object::String
-      return nil unless cv = email.split('@', 2).first.match(/\A[-_\w]+?[+](\w[-._\w]+\w)[=](\w[-.\w]+\w)\z/)
+      return nil unless cv = email.split('@', 2).first.match(/\A[-\w]+?[+](\w[-.\w]+\w)[=](\w[-.\w]+\w)\z/)
       verp0 = cv[1] + '@' + cv[2]
       return verp0 if Sisimai::RFC5322.is_emailaddress(verp0)
     end
@@ -297,23 +297,19 @@ module Sisimai
       return nil unless Sisimai::RFC5322.is_emailaddress(email)
 
       local = email.split('@')
-      return nil unless cv = local[0].match(/\A([-_\w]+?)[+].+\z/)
+      return nil unless cv = local[0].match(/\A([-\w]+?)[+].+\z/)
       return cv[1] + '@' + local[1]
     end
 
-    @@roaccessors = [
-      :address, # [String] Email address
-      :user,    # [String] local part of the email address
-      :host,    # [String] domain part of the email address
-      :verp,    # [String] VERP
-      :alias,   # [String] alias of the email address
-    ]
-    @@rwaccessors = [
-      :name,    # [String] Display name
-      :comment, # [String] Comment
-    ]
-    @@roaccessors.each { |e| attr_reader   e }
-    @@rwaccessors.each { |e| attr_accessor e }
+    # :address, # [String] Email address
+    # :user,    # [String] local part of the email address
+    # :host,    # [String] domain part of the email address
+    # :verp,    # [String] VERP
+    # :alias,   # [String] alias of the email address
+    # :name,    # [String] Display name
+    # :comment, # [String] Comment
+    attr_reader   :address, :user, :host, :verp, :alias
+    attr_accessor :name, :comment
 
     # Constructor of Sisimai::Address
     # @param <str>  [String] argv1          Email address

data/lib/sisimai/arf.rb

@@ -80,7 +80,7 @@ module Sisimai
         return nil unless self.is_arf(mhead)
 
         dscontents = [Sisimai::Lhost.DELIVERYSTATUS]
-        hasdivided = mbody.split("\n")
+        bodyslices = mbody.split("\n")
         rfc822part = ''   # (String) message/rfc822-headers part
         previousfn = ''   # (String) Previous field name
         readcursor = 0    # (Integer) Points the current cursor position
@@ -120,7 +120,7 @@ module Sisimai
         #      generator is using to generate the report.  The version number in
         #      this specification is set to "1".
         #
-        while e = hasdivided.shift do
+        while e = bodyslices.shift do
           if readcursor == 0
             # Beginning of the bounce message or message/delivery-status part
             if e =~ MarkingsOf[:message]
@@ -156,7 +156,7 @@ module Sisimai
 
             elsif e.start_with?(' ', "\t")
               # Continued line from the previous line
-              rfc822part << e + "\n" if LongFields.key?(previousfn)
+              rfc822part << e + "\n" if LongFields[previousfn]
               next unless e.empty?
               rcptintext << e if previousfn == 'to'
 
@@ -167,7 +167,7 @@ module Sisimai
               lhs.downcase!
 
               previousfn = ''
-              next unless RFC822Head.key?(lhs)
+              next unless RFC822Head[lhs]
 
               previousfn  = lhs
               rfc822part << e + "\n"