mailbounce 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e07f3db5d808f4a1d3d9f4b53fe83f3f78f619008e14de533d4101cfe1f99a6e
-  data.tar.gz: b2a4341195772ea43fe13a282a27dbcff914da3dbd232f7f0ad7ecbd144a1a59
+  metadata.gz: 4f99ac991751ae3b826fb20a5e9e9f13c0871ef50b8957abab82daddccad242a
+  data.tar.gz: 5568d4cfaf4644bf4c984116276e0142ec1d4842bf79c6fed565f5dd965c2484
 SHA512:
-  metadata.gz: f404a22a31ce871ab3e6fb948b0dc8ed5e1dafe9a85b74822fd5e30230f7d2b8ecfedea124370a349f4a139bbc7c136ea519f5ac46ad4f6f8c84518d74436abc
-  data.tar.gz: fd63774ff78d90ef852e94a1994e1282beef51b23daffae422041c0a70a3d02a4e0beb9330639d821093fdcc391afc22855f0efcf5d8a743ddb8a526765c94f1
+  metadata.gz: 19e7c1b2748c550f40c283841e869de952724c29defc24404a2c7d0f251f515150e59383f304261c2b71ffb4d6e66d1f587952dd2e35ac86bc4c4edc9f11b6d5
+  data.tar.gz: febb828d483008e5abcd932ed760f86db3f8cde575f32ef47ae901a89d62b66a67c8349515aadababf0950bd85c9ca256f52c6dbfc57bb293d2f88677057f0ab

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 0.1.2
+
+- Split a report into per-recipient blocks
+- A report is now read only up to 1 MB, which `parse` takes as `max_size`
+
+## 0.1.1
+
+Documentation
+
 ## 0.1.0
 
 Initial release.

data/README.md

@@ -1,10 +1,10 @@
 # mailbounce
 
-📭 Email delivery failures for Ruby
+📭 Email delivery failures for Ruby.
 
 Answers one question about a rejected message: whose fault was it?
 
-**mailbounce** reads the two ways mail comes back: a rejection during the SMTP session, and a delivery status notification (RFC 3464) arriving afterwards. Pure Ruby, no dependencies beyond `mail`.
+**mailbounce** reads the two ways mail comes back: a rejection during the SMTP session, and a delivery status notification (RFC 3464) arriving afterwards.
 
 ## Features
 
@@ -24,6 +24,8 @@ Answers one question about a rejected message: whose fault was it?
 - [Reading a Report](#reading-a-report)
 - [Testing](#testing)
 - [History](#history)
+- [Contributing](#contributing)
+- [License](#license)
 
 ## Getting Started
 
@@ -52,13 +54,13 @@ rejection.about_us?   # => false
 
 ## Categories
 
-| Category | What it means |
-| --- | --- |
-| `:invalid` | The mailbox doesn't exist - the one category that says something lasting about the address |
-| `:full` | The mailbox exists and is over quota |
-| `:oversized` | This message was too large; another might not be |
-| `:blocked` | Policy, reputation, or the network - about the exchange, not the address |
-| `:unknown` | Nothing matched |
+| Category     | What it means                                                                              |
+| ------------ | ------------------------------------------------------------------------------------------ |
+| `:invalid`   | The mailbox doesn't exist - the one category that says something lasting about the address |
+| `:full`      | The mailbox exists and is over quota                                                       |
+| `:oversized` | This message was too large; another might not be                                           |
+| `:blocked`   | Policy, reputation, or the network - about the exchange, not the address                   |
+| `:unknown`   | Nothing matched                                                                            |
 
 Classification reads the enhanced status code first, then falls back to wording, since plenty of servers pair a bare `5.0.0` with a diagnostic that names the cause. The wording it knows is what Postfix, Exim, and Sendmail say by default - there's no per-provider table, since those go stale silently.
 
@@ -108,6 +110,12 @@ Reports announce delays and successes by the same route and in the same shape, s
 
 A report naming several recipients speaks for a given address only when it names it; one covering a single recipient needn't name anyone. Nothing raises: a report with no machine-readable part, or bytes that aren't a message at all, reports nothing.
 
+Bounce are cappted to 1 MB. Past that a report is refused like any other it can't read. Lower it where you'd rather hold less:
+
+```ruby
+MailBounce.parse(raw_bounce, max_size: 64 * 1024)
+```
+
 ## Testing
 
 ```sh
@@ -115,21 +123,19 @@ bundle install
 rake
 ```
 
-Nothing touches the network. Fixtures in `test/fixtures/` are complete bounce messages covering permanent failure, delay, transient failure, several recipients, an unnamed recipient, and a report with no machine-readable part at all.
-
 ## History
 
-View the changelog
+View the [changelog](CHANGELOG.md).
 
 ## Contributing
 
 Everyone is encouraged to help improve this project:
 
-- [Report bugs](https://github.com/example/mailbounce/issues)
+- [Report bugs](https://github.com/mailpiece/mailbounce/issues)
 - Fix bugs and submit pull requests
 - Write, clarify, or fix documentation
 - Suggest or add new features
 
 ## License
 
-MIT. See [LICENSE](LICENSE).
+MIT. See [LICENSE](LICENSE).

data/lib/mailbounce/report.rb

@@ -1,4 +1,5 @@
 require "mail"
+require "set"
 
 require "mailbounce/recipient"
 
@@ -13,6 +14,10 @@ module MailBounce
 
     FIELD_NAME = /\A(?<name>[A-Za-z][A-Za-z0-9\-]*)[ \t]*:/
 
+    # A bounce is a notice, not a mailbox — Postfix caps its own at 50 KB.
+    # Anything past this is not a report anyone meant to send.
+    MAX_SIZE = 1024 * 1024
+
     # Value stays on its line so an empty field cannot swallow the next.
     FIELDS = {
       action: /^Action[ \t]*:[ \t]*(?<value>.+)$/i,
@@ -23,12 +28,14 @@ module MailBounce
       remote_mta: /^Remote-MTA[ \t]*:[ \t]*(?<value>.+)$/i
     }.freeze
 
-    def self.parse(raw)
-      new(raw)
+    def self.parse(raw, max_size: MAX_SIZE)
+      new(raw, max_size: max_size)
     end
 
-    def initialize(raw)
-      @mail = Mail.new(raw.to_s)
+    def initialize(raw, max_size: MAX_SIZE)
+      report = raw.to_s
+
+      @mail = Mail.new(report) if report.bytesize <= max_size
     rescue StandardError
       @mail = nil
     end
@@ -83,22 +90,30 @@ module MailBounce
       end
 
       # A block ends when a field it already has reappears (order is not fixed).
+      # The names are kept rather than matched for again: a block grows, and
+      # reading all of it per line costs the square of its length.
       def per_recipient(chunk)
-        chunk.lines.each_with_object([]) do |line, blocks|
-          if blocks.last && continues?(blocks.last, line)
-            blocks.last << line
-          else
+        blocks, named = [], Set.new
+
+        chunk.lines.each do |line|
+          name = field_name(line)
+
+          if blocks.empty? || named.include?(name)
             blocks << +line
+            named = Set.new
+          else
+            blocks.last << line
           end
+
+          named << name if name
         end
+
+        blocks
       end
 
-      def continues?(block, line)
-        if name = line[FIELD_NAME, :name]
-          !block.match?(/^#{Regexp.escape(name)}[ \t]*:/i)
-        else
-          true
-        end
+      # Field names are case-insensitive; a continuation line has none.
+      def field_name(line)
+        line[FIELD_NAME, :name]&.downcase
       end
 
       def recipient_from(block)

data/lib/mailbounce/version.rb

@@ -1,3 +1,3 @@
 module MailBounce
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

data/lib/mailbounce.rb

@@ -11,7 +11,7 @@ module MailBounce
     Rejection.new(response: response, sending_ip: sending_ip)
   end
 
-  def self.parse(raw)
-    Report.parse(raw)
+  def self.parse(raw, max_size: Report::MAX_SIZE)
+    Report.parse(raw, max_size: max_size)
   end
 end

data/mailbounce.gemspec

@@ -7,10 +7,9 @@ Gem::Specification.new do |spec|
   spec.platform = Gem::Platform::RUBY
   spec.required_ruby_version = ">= 3.3.4"
   spec.authors = [ "Simon Lev" ]
-  spec.email = [ "support@postrider.dev" ]
 
-  spec.summary = "RFC 3464 delivery status notifications, parsed and classified, in pure Ruby."
-  spec.description = "Answers one question about a rejected message: whose fault was it?"
+  spec.summary = "Email delivery failures for Ruby."
+  spec.description = "Answers one question about a rejected message: whose fault was it? Parses bounces, NDRs, and DSN reports to classify delivery failures."
 
   spec.homepage = "https://github.com/mailpiece/mailbounce"
   spec.license = "MIT"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mailbounce
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Simon Lev
@@ -23,9 +23,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.7'
-description: 'Answers one question about a rejected message: whose fault was it?'
-email:
-- support@postrider.dev
+description: 'Answers one question about a rejected message: whose fault was it? Parses
+  bounces, NDRs, and DSN reports to classify delivery failures.'
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -64,5 +63,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.3
 specification_version: 4
-summary: RFC 3464 delivery status notifications, parsed and classified, in pure Ruby.
+summary: Email delivery failures for Ruby.
 test_files: []