dmarcator 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4c6e25ca7a0fc2d77204c72ebb01906fce1ac4b537b1e011e505ed2938dda2b
-  data.tar.gz: 36f390d4c0e42c5e938df0345e9d412de2b09aed29da9ca83a424414090b88f1
+  metadata.gz: a1bd93bc4b534e2b9613241e920dd4a71c41e564c92c10ab8abaf6be7294feb8
+  data.tar.gz: fb95401f394f53189a0db431f7d31bc4ffe8c25c87ce87f825f18a99962dadba
 SHA512:
-  metadata.gz: 8f3db5da3231a84613e3a938d3e294f01da16df7aee2e633ba321e0002a8278ec28755accb08a1db2e6c72f2d0424cb34ea019b3168b32872503f59dddb6eaa4
-  data.tar.gz: 28d72632daef6199571fd1cd461c112610ebd14bd45a03b48c6b9127f571e82f8431ad35331e4c05d52482b2b5d085bb973a51aa37a888ede498b8b7a85f4eac
+  metadata.gz: c94318c4ac8a5f7089276f5d6bf91ae90ab8cf576f6367acf418e86adba5fe4bb5e28f7df4a478f8783d134b82bd9390555b3af48c713ca869fd276be4cfe08b
+  data.tar.gz: 6b10b30dfc64acd1cdef7427c4a475d7d9fa90b4c9d387cbc1e2293e8b693e66d3fa4bc23d80d254d92a5a4137ab65b1fe98adfc0e28e573bafc8342274e7995

data/ChangeLog.md

@@ -1,3 +1,21 @@
+### 0.10.0 / 2026-10-29
+
+Breaking changes, taken before 1.0 so the release does not carry them:
+
+* Add `DMARCator::Error` as the base class for every error the library raises. `InvalidRecord`, `InvalidReport` and `ResolutionError` inherit from it, so one `rescue DMARCator::Error` catches all three.
+* `InvalidRecord` no longer inherits from `Parslet::ParseFailed`, removing the parser implementation from the public exception contract. Parse failures still expose the underlying parser error as their `cause`.
+* Remove the deprecated `DMARCator.query` and `DMARCator::Record.query` aliases. Use `DMARCator.dmarc` and `DMARCator::Record.lookup`.
+* Rename `DMARCator::Report::Record` to `DMARCator::Report::Row`, so aggregate rows are not confused with `DMARCator::Record`, the parsed DMARC TXT record.
+
+Migration:
+
+| Before | After |
+|---|---|
+| `DMARCator.query(domain)` | `DMARCator.dmarc(domain)` |
+| `DMARCator::Record.query(domain)` | `DMARCator::Record.lookup(domain)` |
+| `DMARCator::Report::Record` | `DMARCator::Report::Row` |
+| `rescue Parslet::ParseFailed` | `rescue DMARCator::Error` |
+
 ### 0.9.0 / 2026-10-29
 
 * Add `DMARCator.txt_records`, which returns the TXT resource records instead of strings, so callers that cache lookups can read each record's `ttl`. `DMARCator.txt` is now defined in terms of it and behaves the same.

data/README.md

@@ -177,6 +177,22 @@ more than the lookup on a fast resolver); `Resolv::DNS` does not lock per query,
 so use one resolver per thread when parallelising; and DoT/DoH open a new TLS
 connection per lookup, so plaintext is the better choice for bulk work.
 
+### SPF and DKIM
+
+The TXT primitives also cover the other two records a checker needs. There is
+no record-type-specific API, because the semantics belong to the caller:
+
+```ruby
+DMARCator.txt("example.com")                # SPF (RFC 7208)
+DMARCator.txt("s1._domainkey.example.com")  # DKIM (RFC 6376)
+```
+
+Both need the raw list rather than a single value: more than one SPF record is
+a `permerror`, and DKIM keys can be duplicated, rotated or revoked (`p=`). A
+helper returning "the" record would hide exactly those conditions. DKIM is also
+per-selector and selectors cannot be enumerated, so any convenience method would
+have to take a selector and would only build the name above.
+
 ## Strict parsing
 
 By default, unknown tags and tags with invalid values are ignored. Pass

data/lib/dmarcator/exceptions.rb

@@ -1,30 +1,41 @@
 # frozen_string_literal: true
 
-require 'parslet'
-
 module DMARCator
+  #
+  # Base class for every error raised by this library.
+  #
+  # Rescuing this catches parse failures, report failures and DNS lookup
+  # failures alike.
+  #
+  # @since 0.10.0
+  #
+  class Error < StandardError
+  end
+
   #
   # Raised when a DMARC record cannot be parsed.
   #
   # @since 0.2.0
   #
-  class InvalidRecord < Parslet::ParseFailed
+  class InvalidRecord < Error
   end
 
   #
   # Raised when a DMARC XML report cannot be parsed.
   #
-  class InvalidReport < StandardError
+  # @since 0.3.0
+  #
+  class InvalidReport < Error
   end
 
   #
-  # Raised when an encrypted DNS transport fails to return a usable answer.
+  # Raised when a DNS transport fails to return a usable answer.
   #
   # This is deliberately distinct from a missing record: a failed lookup must
   # not be mistaken for a domain without a DMARC policy.
   #
   # @since 0.6.0
   #
-  class ResolutionError < StandardError
+  class ResolutionError < Error
   end
 end

data/lib/dmarcator/query.rb

@@ -246,16 +246,6 @@ module DMARCator
     dmarc_records.first if dmarc_records.one?
   end
 
-  #
-  # @deprecated Use {dmarc}, which names what it returns. Kept for
-  #   compatibility; it will be removed in a future release.
-  #
-  # @see dmarc
-  #
-  def self.query(domain,resolver=default_resolver)
-    dmarc(domain, resolver: resolver)
-  end
-
   #
   # Looks up the TXT records at an already-validated name.
   #

data/lib/dmarcator/record.rb

@@ -285,7 +285,8 @@ module DMARCator
 
       new(attributes)
     rescue Parslet::ParseFailed => error
-      raise InvalidRecord.new(truncate_error_message(error.message), error.cause)
+      # Raising inside the rescue sets this error as the cause automatically.
+      raise InvalidRecord, truncate_error_message(error.message)
     end
 
     # Maximum length of error messages echoed from parsing untrusted input.
@@ -342,16 +343,6 @@ module DMARCator
       end
     end
 
-    #
-    # @deprecated Use {lookup}, which names what it returns. Kept for
-    #   compatibility; it will be removed in a future release.
-    #
-    # @see lookup
-    #
-    def self.query(domain,resolver=DMARCator.default_resolver)
-      lookup(domain, resolver: resolver)
-    end
-
     #
     # Converts the record to a Hash.
     #

data/lib/dmarcator/report/{record.rb → row.rb}

@@ -9,7 +9,10 @@ module DMARCator
     #
     # Represents a single `record` element of a DMARC XML report.
     #
-    class Record
+    # Named `Row` so it is not confused with {DMARCator::Record}, the parsed
+    # DMARC TXT record.
+    #
+    class Row
       include XmlHelper
 
       # Attribute names exposed by this class.

data/lib/dmarcator/report.rb

@@ -8,7 +8,7 @@ require_relative 'xml_helper'
 require_relative 'exceptions'
 require_relative 'report/metadata'
 require_relative 'report/policy'
-require_relative 'report/record'
+require_relative 'report/row'
 
 module DMARCator
   #
@@ -114,11 +114,11 @@ module DMARCator
     #
     # The report records.
     #
-    # @return [Array<Report::Record>]
+    # @return [Array<Report::Row>]
     #
     def records
       @records ||= @node.xpath('feedback/record').map do |node|
-        Record.new(node)
+        Row.new(node)
       end
     end
   end

data/lib/dmarcator/version.rb

@@ -2,5 +2,5 @@
 
 module DMARCator
   # dmarcator version
-  VERSION = '0.9.0'
+  VERSION = '0.10.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dmarcator
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Noah Berman
@@ -78,7 +78,7 @@ files:
 - lib/dmarcator/report/metadata.rb
 - lib/dmarcator/report/policy.rb
 - lib/dmarcator/report/reason.rb
-- lib/dmarcator/report/record.rb
+- lib/dmarcator/report/row.rb
 - lib/dmarcator/resolver.rb
 - lib/dmarcator/resolver/doh.rb
 - lib/dmarcator/resolver/dot.rb