sisimai 4.14.2 → 4.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: faf11e9c4b60a2cf7a6ff9c6cd97be17e7fbabdd
-  data.tar.gz: 49293749aa97fca7cc7e669404a22c4ae61674bd
+  metadata.gz: 0ec1fa777a75634e47ecb872e204b2a984bc5e7f
+  data.tar.gz: fe7c0c885e57e2ce3f1d71097bc3aea0f9172f09
 SHA512:
-  metadata.gz: d88a85a854489597d10283fd240d61d5f9d124a5f3b64f4a540f392630a085990089c31acd5e23401133b36231ccbfad225c380b9aed078ee3c79b05298dff52
-  data.tar.gz: b06a3af3f6f121ade857f753504075e2da6dea3782121f448b110f2ff378919287c2a6217d4de17be41bdd92af2ca576737fa51fff10c5962b5a6218b7441751
+  metadata.gz: 626b2742d7733d7345aa8aa4fc9ab06e3966854cf1a1bd778bce4c8603f14173167ec610997c2561dbd80010b4534e1c099c607f57dddb03e0c751bbfbe66bda
+  data.tar.gz: 93e4f36be4ee5787f0f2172fed282cde3e239e4190b65ea4ee32a19c77f92d00f1762a67a761cc772fb6627984e4a5cff27b9530fc8385bbad30a8357f3df0ff

data/.rubocop.yml

@@ -12,6 +12,9 @@ AllCops:
 Lint/AssignmentInCondition:
   Enabled: false
 
+Metrics/AbcSize:
+  Max: 30
+
 Metrics/CyclomaticComplexity:
   Enabled: false
 
@@ -32,9 +35,20 @@ Metrics/ModuleLength:
 Metrics/PerceivedComplexity:
   Enabled: false
 
+Style/AsciiComments:
+  Exclude:
+    - 'lib/sisimai/mta/*.rb'
+    - 'lib/sisimai/msp/ru/*.rb'
+
 # Configuration parameters: EnforcedStyle, SupportedStyles.
 Style/ClassAndModuleChildren:
-    EnforcedStyle: nested
+  EnforcedStyle: nested
+  Exclude:
+    - 'lib/sisimai/datetime.rb'
+    - 'lib/sisimai/rfc5322.rb'
+    - 'lib/sisimai/rhost.rb'
+    - 'lib/sisimai/string.rb'
+    - 'lib/sisimai/msp/*/*.rb'
 
 Style/ClassVars:
   Enabled: false
@@ -87,6 +101,9 @@ Style/FileName:
 Style/FormatString:
   EnforcedStyle: sprintf
 
+Style/HashSyntax:
+  Enabled: false
+
 # Cop supports --auto-correct.
 Style/LeadingCommentSpace:
   Enabled: false
@@ -134,7 +151,7 @@ Style/SingleLineMethods:
     - 'lib/sisimai/msp.rb'
     - 'lib/sisimai/mta/*'
     - 'lib/sisimai/msp/*/*'
-    - 'lib/sisimai/rfc3463.rb'
+    - 'lib/sisimai/rfc3464.rb'
     - 'lib/sisimai/rfc3834.rb'
     - 'lib/sisimai/reason/*.rb'
 

data/.travis.yml

@@ -4,7 +4,6 @@ rvm:
   - 2.2.2
   - 2.2.4
   - 2.3.0
-  - jruby-9.0.0.0
   - jruby-9.0.4.0
 before_install:
   - gem update bundler

data/Changes

@@ -1,5 +1,21 @@
 Revision history for Ruby version of Sisimai
 
+4.15.0  Sat, 13 Feb 2016 12:40:15 +0900 (JST)
+    - Beginning with this version, Sisimai requires Oj(MRI) or JrJackson(JRuby)
+      for encoding parsed data to JSON string more faster (about 10%-20% faster
+      than before). Implemented at pull-request #44 and discussed in issue #42.
+      Thanks to @hiroyuki-sato.
+    - Implement new MTA/MSP module "Sisimai::MSP::US::AmazonWorkMail" to parse
+      bounce mails via Amazon WorkMail. The module and test codes are imported
+      from https://github.com/sisimai/p5-Sisimai/pull/162.
+    - Implement new MTA/MSP module "Sisimai::MSP::US::Office365" to parse error
+      mails via Microsoft Office 365. The module, test codes, and sample emails
+      are imported from https://github.com/sisimai/p5-Sisimai/pull/164.
+    - New method Sisimai::Address#to_s to get a email address as String, it is
+      implemented at pull-request #39. Thanks to @hiroyuki-sato.
+    - Almost all of the class variables are removed for resolving issue #40 and
+      merged pull-request #43, thanks to @hiroyuki-sato.
+
 4.14.2  Wed,  3 Feb 2016 13:29:17 +0900 (JST)
     - The first release of rb-Sisimai.
 

data/README.md

@@ -3,6 +3,7 @@
 [![Build Status](https://travis-ci.org/sisimai/rb-Sisimai.svg?branch=master)](https://travis-ci.org/sisimai/rb-Sisimai) 
 [![Codacy Badge](https://api.codacy.com/project/badge/grade/38340177e6284a65be69c0c7c3dc2b58)](https://www.codacy.com/app/azumakuniyuki/rb-Sisimai)
 [![Ruby](https://img.shields.io/badge/ruby-v2.1.0--v2.3.0-red.svg)](https://www.ruby-lang.org/)
+[![Gem Version](https://badge.fury.io/rb/sisimai.svg)](https://badge.fury.io/rb/sisimai)
 
 ![](http://41.media.tumblr.com/45c8d33bea2f92da707f4bbe66251d6b/tumblr_nuf7bgeyH51uz9e9oo1_1280.png)
 
@@ -23,7 +24,12 @@ Key Features | 主な特徴的機能
 * __Easy to Install, Use.__ | __インストールも使用も簡単__
   * gem install
   * git clone & make
-
+* __High Precision of Analysis__ | __高い解析精度__
+  * 2 times higher than bounceHammer | 解析精度はbounceHammerの二倍
+  * Support 21 known MTAs and 5 unknown MTAs | 26種類のMTAに対応
+  * Support 21 major MSPs(Mail Service Providers) | 21種類の著名なMSPに対応
+  * Support Feedback Loop Message(ARF) | Feedback Loopにも対応
+  * Can detect 25 error reasons | 25種類のエラー理由を検出
 
 Setting Up Sisimai | シシマイを使う準備
 =======================================
@@ -35,8 +41,50 @@ More details about system requirements are available at available at
 [Sisimai | Getting Started](http://libsisimai.org/start) page.
 
 * [Ruby 2.1.0 or later](http://www.ruby-lang.org/)
-* Also works on JRuby 9.0.0.0 or later
+  * [__Oj | The fastest JSON parser and object serializer__](https://rubygems.org/gems/oj)
+* Also works on [JRuby 9.0.0.0 or later](http://jruby.org)
+  * [__JrJackson | A mostly native JRuby wrapper for the java jackson json processor jar__](https://rubygems.org/gems/jrjackson)
+
+Install | インストール
+----------------------
+
+### From RubyGems.org
+
+```shell
+% sudo gem install sisimai
+Fetching: sisimai-4.14.2.gem (100%)
+Successfully installed sisimai-4.14.2
+Parsing documentation for sisimai-4.14.2
+Installing ri documentation for sisimai-4.14.2
+Done installing documentation for sisimai after 6 seconds
+1 gem installed
+```
 
+### From GitHub
+
+```shell
+% cd /usr/local/src
+% git clone https://github.com/sisimai/rb-Sisimai.git
+% cd ./rb-Sisimai
+% sudo make depend install-from-local
+gem install bundle rake rspec coveralls
+Successfully installed bundle-0.0.1
+Parsing documentation for bundle-0.0.1
+Done installing documentation for bundle after 0 seconds
+Successfully installed rake-10.5.0
+Parsing documentation for rake-10.5.0
+Done installing documentation for rake after 1 seconds
+Successfully installed rspec-3.4.0
+Parsing documentation for rspec-3.4.0
+Done installing documentation for rspec after 0 seconds
+Successfully installed coveralls-0.8.10
+Parsing documentation for coveralls-0.8.10
+Done installing documentation for coveralls after 0 seconds
+4 gems installed
+bundle exec rake install
+sisimai 4.14.2 built to pkg/sisimai-4.14.2.gem.
+sisimai (4.14.2) installed.
+```
 
 Usage | 使い方
 ==============
@@ -93,17 +141,18 @@ Differences between Perl version and Ruby version | Perl版との違い
 The following table show the differences between Perl version of Sisimai
 and Ruby version of Sisimai.
 
-| Features                                       | Ruby version  | Perl version|
-|------------------------------------------------|---------------|-------------|
-| System requirements                            | Ruby 2.1-2.3  | Perl 5.10 - |
-| Analytical precision ratio(2000 emails)[1]     | 1.00          | 1.00        |
-| The speed of parsing email(1000 emails)        | 3.93s         | 2.50s       |
-| How to install                                 | gem install   | cpanm       |
-| Dependencies (Except core modules)             | 0 modules     | 2 modules   |
-| LOC:Source lines of code                       | 11400 lines   | 8900 lines  |
-| The number of tests in t/, xt/ directory       | 89570 tests   | 160500 tests|
-| License                                        | The BSD 2-Clause License    |
-| Support Contract provided by Developer         | Coming soon   | Available   |
+| Features                                       | Ruby version  | Perl version |
+|------------------------------------------------|---------------|--------------|
+| System requirements                            | Ruby 2.1-2.3  | Perl 5.10 -  |
+|                                                | JRuby 9.0.0.0-|              |
+| Analytical precision ratio(2000 emails)[1]     | 1.00          | 1.00         |
+| The speed of parsing email(1000 emails)        | 3.81s         | 2.50s        |
+| How to install                                 | gem install   | cpanm        |
+| Dependencies (Except core modules)             | 1 modules     | 2 modules    |
+| LOC:Source lines of code                       | 11700 lines   | 9100 lines   |
+| The number of tests in t/, xt/ directory       | 90700 tests   | 162400 tests |
+| License                                        | BSD 2-Clause  | BSD 2-Clause |
+| Support Contract provided by Developer         | Coming soon   | Available    |
 
 1. See ./ANALYTICAL-PRECISION
 
@@ -113,12 +162,13 @@ and Ruby version of Sisimai.
 | 機能                                           | Ruby version  | Perl version|
 |------------------------------------------------|---------------|-------------|
 | 動作環境                                       | Ruby 2.1-2.3  | Perl 5.10 - |
+|                                                | JRuby 9.0.0.0-|             |
 | 解析精度の割合(2000通のメール)[1]              | 1.00          | 1.00        |
-| メール解析速度(1000通のメール)                 | 3.93秒        | 2.50秒      |
+| メール解析速度(1000通のメール)                 | 3.81秒        | 2.50秒      |
 | インストール方法                               | gem install   | cpanm       |
-| 依存モジュール数(コアモジュールを除く)         | 0モジュール   | 2モジュール |
-| LOC:ソースコードの行数                         | 11400行       | 8900行      |
-| テスト件数(t/,xt/ディレクトリ)                 | 89570件       | 160500件    |
+| 依存モジュール数(コアモジュールを除く)         | 1モジュール   | 2モジュール |
+| LOC:ソースコードの行数                         | 11700行       | 9100行      |
+| テスト件数(t/,xt/ディレクトリ)                 | 90700件       | 162400件    |
 | ライセンス                                     | 二条項BSD     | 二条項BSD   |
 | 開発会社によるサポート契約                     | 準備中        | 提供中      |
 
@@ -167,10 +217,12 @@ details about these modules are available at
 | MSP::RU::Yandex          | Yandex.Mail: http://www.yandex.ru                 |
 | MSP::UK::MessageLabs     | Symantec.cloud http://www.messagelabs.com         |
 | MSP::US::AmazonSES       | AmazonSES(Sending): http://aws.amazon.com/ses/    |
+| MSP::US::AmazonWorkMail  | Amazon WorkMail: https://aws.amazon.com/workmail/ |
 | MSP::US::Aol             | Aol Mail: http://www.aol.com                      |
 | MSP::US::Bigfoot         | Bigfoot: http://www.bigfoot.com                   |
 | MSP::US::Facebook        | Facebook: https://www.facebook.com                |
 | MSP::US::Google          | Google Gmail: https://mail.google.com             |
+| MSP::US::Office365       | Microsoft Office 365: http://office.microsoft.com/|
 | MSP::US::Outlook         | Microsoft Outlook.com: https://www.outlook.com/   |
 | MSP::US::ReceivingSES    | AmazonSES(Receiving): http://aws.amazon.com/ses/  |
 | MSP::US::SendGrid        | SendGrid: http://sendgrid.com/                    |

data/appveyor.yml

@@ -0,0 +1,23 @@
+version: '{build}'
+
+install:
+  - SET PATH=C:\Ruby%ruby_version%\bin;%PATH%
+  - "%devkit%\\devkitvars.bat"
+  - ruby --version
+  - gem --version
+  - bundle install
+build: off
+test_script:
+  - bundle exec rake spec TESTOPTS=-v
+
+environment:
+  matrix:
+    - ruby_version: "22-x64"
+      devkit: C:\Ruby21-x64\DevKit
+    - ruby_version: "22"
+      devkit: C:\Ruby21\DevKit
+    - ruby_version: "21-x64"
+      devkit: C:\Ruby21-x64\DevKit
+    - ruby_version: "21"
+      devkit: C:\Ruby21\DevKit
+

data/lib/sisimai.rb

@@ -46,14 +46,16 @@ module Sisimai
     def dump(path)
       return nil unless path
 
-      require 'json'
       parseddata = Sisimai.make(path) || []
-      jsonoption = JSON::state.new
-
-      jsonoption.space = ' '
-      jsonoption.object_nl = ' '
-
-      return JSON.generate(parseddata, jsonoption)
+      if RUBY_PLATFORM =~ /java/
+        # java-based ruby environment like JRuby.
+        require 'jrjackson'
+        jsonstring = JrJackson::Json.dump(parseddata)
+      else
+        require 'oj'
+        jsonstring = Oj.dump(parseddata, :mode => :compat)
+      end
+      return jsonstring
     end
   end
 

data/lib/sisimai/address.rb

@@ -10,7 +10,7 @@ module Sisimai
     #                           Undef when the $argv1 is neither 'r' nor 's'
     def self.undisclosed(argv1)
       return nil unless argv1
-      return nil unless ['r', 's'].index(argv1)
+      return nil unless %w|r s|.index(argv1)
 
       local = argv1 == 'r' ? 'recipient' : 'sender'
       return sprintf('undisclosed-%s-in-headers@dummy-domain.invalid', local)
@@ -210,7 +210,13 @@ module Sisimai
 
     # Returns the value of address as String
     # @return [String] Email address
-    def to_json
+    def to_json(*)
+      return to_s
+    end
+
+    # Returns the value of address as String
+    # @return [String] Email address
+    def to_s
       return self.address.to_s
     end
 

data/lib/sisimai/arf.rb

@@ -88,8 +88,6 @@ module Sisimai
         require 'sisimai/address'
         dscontents = []; dscontents << Sisimai::MTA.DELIVERYSTATUS
         hasdivided = mbody.split("\n")
-        havepassed = ['']
-        rfc822next = { 'from' => false, 'to' => false, 'subject' => false }
         rfc822part = ''   # (String) message/rfc822-headers part
         previousfn = ''   # (String) Previous field name
         readcursor = 0    # (Integer) Points the current cursor position
@@ -130,9 +128,6 @@ module Sisimai
         #      this specification is set to "1".
         #
         hasdivided.each do |e|
-          # Save the current line for the next loop
-          havepassed << e; p = havepassed[-2]
-
           if readcursor == 0
             # Beginning of the bounce message or delivery status part
             if e =~ Re1[:begin]
@@ -323,7 +318,7 @@ module Sisimai
           if mhead['received'].size > 0
             # Get localhost and remote host name from Received header.
             r0 = mhead['received']
-            ['lhost', 'rhost'].each { |a| e[a] ||= '' }
+            %w|lhost rhost|.each { |a| e[a] ||= '' }
             e['lhost'] = Sisimai::RFC5322.received(r0[0]).shift if e['lhost'].empty?
             e['rhost'] = Sisimai::RFC5322.received(r0[-1]).pop  if e['rhost'].empty?
           end

data/lib/sisimai/data.rb

@@ -13,29 +13,29 @@ module Sisimai
     require 'sisimai/datetime'
 
     @@rwaccessors = [
-      'token',          # [String] Message token/MD5 Hex digest value
-      'lhost',          # [String] local host name/Local MTA
-      'rhost',          # [String] Remote host name/Remote MTA
-      'alias',          # [String] Alias of the recipient address
-      'listid',         # [String] List-Id header of each ML
-      'reason',         # [String] Bounce reason
-      'action',         # [String] The value of Action: header
-      'subject',        # [String] UTF-8 Subject text
-      'timestamp',      # [Sisimai::Time] Date: header in the original message
-      'addresser',      # [Sisimai::Address] From address
-      'recipient',      # [Sisimai::Address] Recipient address which bounced
-      'messageid',      # [String] Message-Id: header
-      'replycode',      # [String] SMTP Reply Code
-      'smtpagent',      # [String] MTA name
-      'softbounce',     # [Integer] 1 = Soft bounce, 0 = Hard bounce, -1 = ?
-      'smtpcommand',    # [String] The last SMTP command
-      'destination',    # [String] The domain part of the "recipinet"
-      'senderdomain',   # [String] The domain part of the "addresser"
-      'feedbacktype',   # [String] Feedback Type
-      'diagnosticcode', # [String] Diagnostic-Code: Header
-      'diagnostictype', # [String] The 1st part of Diagnostic-Code: Header
-      'deliverystatus', # [String] Delivery Status(DSN)
-      'timezoneoffset', # [Integer] Time zone offset(seconds)
+      :token,           # [String] Message token/MD5 Hex digest value
+      :lhost,           # [String] local host name/Local MTA
+      :rhost,           # [String] Remote host name/Remote MTA
+      :alias,           # [String] Alias of the recipient address
+      :listid,          # [String] List-Id header of each ML
+      :reason,          # [String] Bounce reason
+      :action,          # [String] The value of Action: header
+      :subject,         # [String] UTF-8 Subject text
+      :timestamp,       # [Sisimai::Time] Date: header in the original message
+      :addresser,       # [Sisimai::Address] From address
+      :recipient,       # [Sisimai::Address] Recipient address which bounced
+      :messageid,       # [String] Message-Id: header
+      :replycode,       # [String] SMTP Reply Code
+      :smtpagent,       # [String] MTA name
+      :softbounce,      # [Integer] 1 = Soft bounce, 0 = Hard bounce, -1 = ?
+      :smtpcommand,     # [String] The last SMTP command
+      :destination,     # [String] The domain part of the "recipinet"
+      :senderdomain,    # [String] The domain part of the "addresser"
+      :feedbacktype,    # [String] Feedback Type
+      :diagnosticcode,  # [String] Diagnostic-Code: Header
+      :diagnostictype,  # [String] The 1st part of Diagnostic-Code: Header
+      :deliverystatus,  # [String] Delivery Status(DSN)
+      :timezoneoffset,  # [Integer] Time zone offset(seconds)
     ]
     @@rwaccessors.each { |e| attr_accessor e }
 
@@ -236,7 +236,7 @@ module Sisimai
           # Convert from the date string to an object then calculate time
           # zone offset.
           t = Sisimai::Time.strptime(datestring, '%a, %d %b %Y %T')
-          p['timestamp'] = ( t.to_time.to_i - zoneoffset ) || nil
+          p['timestamp'] = (t.to_time.to_i - zoneoffset) || nil
         rescue
           warn ' ***warning: Failed to strptime ' + datestring.to_s
         end
@@ -244,7 +244,7 @@ module Sisimai
 
         # OTHER_TEXT_HEADERS:
         # Remove square brackets and curly brackets from the host variable
-        ['rhost', 'lhost'].each do |v|
+        %w|rhost lhost|.each do |v|
           p[v] = p[v].delete('[]()')    # Remove square brackets and curly brackets from the host variable
           p[v] = p[v].sub(/\A.+=/, '')  # Remove string before "="
           p[v] = p[v].gsub(/\r\z/, '')  # Remove CR at the end of the value
@@ -316,7 +316,7 @@ module Sisimai
           # not have the value of "deliverystatus".
           if o.softbounce.to_s.empty?
             # The value is not set yet
-            ['deliverystatus', 'diagnosticcode'].each do |v|
+            %w|deliverystatus diagnosticcode|.each do |v|
               # Set the value of softbounce
               next unless p[v].size > 0
               r = Sisimai::SMTP.is_softbounce(p[v])
@@ -361,35 +361,24 @@ module Sisimai
     # Convert from object to hash reference
     # @return   [Hash] Data in Hash reference
     def damn
-      data = nil
-      begin
-        v = {}
-        stringdata = %w[
-          token lhost rhost listid alias reason subject messageid smtpagent
-          smtpcommand destination diagnosticcode senderdomain deliverystatus
-          timezoneoffset feedbacktype diagnostictype action replycode softbounce
-        ]
-
-        stringdata.each do |e|
-          # Copy string data
-          v[e] = self.send(e) || ''
-        end
-        v['addresser'] = self.addresser.address
-        v['recipient'] = self.recipient.address
-        v['timestamp'] = self.timestamp.to_time.to_i
-        data = v
-      rescue
-        warn '***warning: Failed to damn()'
+      data = {}
+      @@rwaccessors.each do |e|
+        next if e.to_s =~ /(?:addresser|recipient|timestamp)/
+        data[e.to_s] = self.send(e) || ''
       end
+      data['addresser'] = self.addresser.address
+      data['recipient'] = self.recipient.address
+      data['timestamp'] = self.timestamp.to_time.to_i
       return data
     end
+    alias :to_hash :damn
 
     # Data dumper
     # @param    [String] type   Data format: json, yaml
     # @return   [String, Undef] Dumped data or Undef if the value of first
     #                           argument is neither "json" nor "yaml"
     def dump(type = 'json')
-      return nil unless ['json', 'yaml'].index(type)
+      return nil unless %w|json yaml|.index(type)
       referclass = sprintf('Sisimai::Data::%s', type.upcase)
 
       begin
@@ -403,7 +392,6 @@ module Sisimai
     end
 
     # JSON handler
-    # @param    [JSON::State] argv  JSON::Ext::Generator::State object
     # @return   [String]            JSON string converted from Sisimai::Data
     def to_json(*)
       return self.dump('json')