dmarcator 0.11.0 → 1.0.0

data/lib/dmarcator/report/auth_result.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../xml_helper'
+require_relative '../internal/xml_helper'
 
 module DMARCator
   class Report
@@ -8,37 +8,37 @@ module DMARCator
     # Represents an `auth_results` entry (DKIM/SPF) in a DMARC XML report.
     #
     class AuthResult
-      include XmlHelper
+      include Internal::XmlHelper
 
       # Attribute names exposed by this class.
       ATTRIBUTES = [:type, :domain, :result, :selector, :scope]
 
-      # @!attribute [rw] type
+      # @!attribute [r] type
       #   @return [String] the entry name (`dkim` or `spf`).
-      # @!attribute [rw] domain
+      # @!attribute [r] domain
       #   @return [String, nil] the authenticated domain.
-      # @!attribute [rw] result
+      # @!attribute [r] result
       #   @return [String, nil] the authentication result.
-      # @!attribute [rw] selector
+      # @!attribute [r] selector
       #   @return [String, nil] the DKIM selector.
-      # @!attribute [rw] scope
+      # @!attribute [r] scope
       #   @return [String, nil] the SPF scope.
-      ATTRIBUTES.each { |attribute| attr_accessor(attribute) }
+      ATTRIBUTES.each { |attribute| attr_reader(attribute) }
 
       def initialize(node)
         @node = node
-        self.type = node.name
+        @type = node.name.freeze
 
         node.element_children.each do |element|
           case element.name
           when 'domain'
-            self.domain ||= element.text
+            @domain ||= element.text.freeze
           when 'result'
-            self.result ||= element.text
+            @result ||= element.text.freeze
           when 'selector'
-            self.selector ||= element.text
+            @selector ||= element.text.freeze
           when 'scope'
-            self.scope ||= element.text
+            @scope ||= element.text.freeze
           end
         end
       end

data/lib/dmarcator/report/metadata.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../xml_helper'
+require_relative '../internal/xml_helper'
 
 module DMARCator
   class Report
@@ -8,7 +8,7 @@ module DMARCator
     # Represents the `report_metadata` element of a DMARC XML report.
     #
     class Metadata
-      include XmlHelper
+      include Internal::XmlHelper
 
       # Attribute names exposed by this class.
       ATTRIBUTES = [
@@ -16,45 +16,46 @@ module DMARCator
         :begin_at, :end_at, :errors
       ]
 
-      # @!attribute [rw] org_name
+      # @!attribute [r] org_name
       #   @return [String, nil] the reporting organization.
-      # @!attribute [rw] email
+      # @!attribute [r] email
       #   @return [String, nil] the reporting organization's contact address.
-      # @!attribute [rw] extra_contact_info
+      # @!attribute [r] extra_contact_info
       #   @return [String, nil] additional contact information.
-      # @!attribute [rw] report_id
+      # @!attribute [r] report_id
       #   @return [String, nil] the unique report identifier.
-      # @!attribute [rw] begin_at
+      # @!attribute [r] begin_at
       #   @return [Time, nil] the start of the reporting interval.
-      # @!attribute [rw] end_at
+      # @!attribute [r] end_at
       #   @return [Time, nil] the end of the reporting interval.
-      # @!attribute [rw] errors
+      # @!attribute [r] errors
       #   @return [Array<String>] errors reported by the reporting organization.
-      ATTRIBUTES.each { |attribute| attr_accessor(attribute) }
+      ATTRIBUTES.each { |attribute| attr_reader(attribute) }
 
       def initialize(node)
         @node = node
-        self.errors = []
+        @errors = []
 
         metadata = node.at_xpath('feedback/report_metadata')
-        return unless metadata
 
         metadata.element_children.each do |element|
           case element.name
           when 'org_name'
-            self.org_name ||= element.text
+            @org_name ||= element.text.freeze
           when 'email'
-            self.email ||= element.text
+            @email ||= element.text.freeze
           when 'extra_contact_info'
-            self.extra_contact_info ||= element.text
+            @extra_contact_info ||= element.text.freeze
           when 'report_id'
-            self.report_id ||= element.text
+            @report_id ||= element.text.freeze
           when 'error'
-            errors << element.text
+            errors << element.text.freeze
           when 'date_range'
             parse_date_range(element)
           end
         end
+      ensure
+        @errors.freeze
       end
 
       private
@@ -63,9 +64,9 @@ module DMARCator
         date_range.element_children.each do |element|
           case element.name
           when 'begin'
-            self.begin_at ||= parse_timestamp(element.text)
+            @begin_at ||= parse_timestamp(element.text.freeze)
           when 'end'
-            self.end_at ||= parse_timestamp(element.text)
+            @end_at ||= parse_timestamp(element.text.freeze)
           end
         end
       end

data/lib/dmarcator/report/policy.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../xml_helper'
+require_relative '../internal/xml_helper'
 
 module DMARCator
   class Report
@@ -8,26 +8,26 @@ module DMARCator
     # Represents the `policy_published` element of a DMARC XML report.
     #
     class Policy
-      include XmlHelper
+      include Internal::XmlHelper
 
       # Attribute names exposed by this class.
       ATTRIBUTES = [:domain, :adkim, :aspf, :p, :sp, :pct, :fo]
 
-      # @!attribute [rw] domain
+      # @!attribute [r] domain
       #   @return [String, nil] the domain the policy applies to.
-      # @!attribute [rw] adkim
+      # @!attribute [r] adkim
       #   @return [String, nil] the DKIM alignment mode (`r` or `s`).
-      # @!attribute [rw] aspf
+      # @!attribute [r] aspf
       #   @return [String, nil] the SPF alignment mode (`r` or `s`).
-      # @!attribute [rw] p
+      # @!attribute [r] p
       #   @return [String, nil] the requested policy.
-      # @!attribute [rw] sp
+      # @!attribute [r] sp
       #   @return [String, nil] the requested subdomain policy.
-      # @!attribute [rw] pct
+      # @!attribute [r] pct
       #   @return [Integer, nil] the percentage of messages the policy applied to.
-      # @!attribute [rw] fo
+      # @!attribute [r] fo
       #   @return [String, nil] the requested failure-reporting options.
-      ATTRIBUTES.each { |attribute| attr_accessor(attribute) }
+      ATTRIBUTES.each { |attribute| attr_reader(attribute) }
 
       def initialize(node)
         @node = node
@@ -38,19 +38,19 @@ module DMARCator
         policy.element_children.each do |element|
           case element.name
           when 'pct'
-            self.pct ||= parse_integer(element.text)
+            @pct ||= parse_integer(element.text.freeze)
           when 'domain'
-            self.domain ||= element.text
+            @domain ||= element.text.freeze
           when 'adkim'
-            self.adkim ||= element.text
+            @adkim ||= element.text.freeze
           when 'aspf'
-            self.aspf ||= element.text
+            @aspf ||= element.text.freeze
           when 'p'
-            self.p ||= element.text
+            @p ||= element.text.freeze
           when 'sp'
-            self.sp ||= element.text
+            @sp ||= element.text.freeze
           when 'fo'
-            self.fo ||= element.text
+            @fo ||= element.text.freeze
           end
         end
       end

data/lib/dmarcator/report/reason.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../xml_helper'
+require_relative '../internal/xml_helper'
 
 module DMARCator
   class Report
@@ -8,16 +8,16 @@ module DMARCator
     # Represents a `reason` element of a DMARC XML report record.
     #
     class Reason
-      include XmlHelper
+      include Internal::XmlHelper
 
       # Attribute names exposed by this class.
       ATTRIBUTES = [:type, :comment]
 
-      # @!attribute [rw] type
+      # @!attribute [r] type
       #   @return [String, nil] the reason type.
-      # @!attribute [rw] comment
+      # @!attribute [r] comment
       #   @return [String, nil] an optional explanatory comment.
-      ATTRIBUTES.each { |attribute| attr_accessor(attribute) }
+      ATTRIBUTES.each { |attribute| attr_reader(attribute) }
 
       def initialize(node)
         @node = node
@@ -25,9 +25,9 @@ module DMARCator
         node.element_children.each do |element|
           case element.name
           when 'type'
-            self.type ||= element.text
+            @type ||= element.text.freeze
           when 'comment'
-            self.comment ||= element.text
+            @comment ||= element.text.freeze
           end
         end
       end

data/lib/dmarcator/report/row.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../xml_helper'
+require_relative '../internal/xml_helper'
 require_relative 'auth_result'
 require_relative 'reason'
 
@@ -13,7 +13,7 @@ module DMARCator
     # DMARC TXT record.
     #
     class Row
-      include XmlHelper
+      include Internal::XmlHelper
 
       # Attribute names exposed by this class.
       ATTRIBUTES = [
@@ -21,24 +21,23 @@ module DMARCator
         :envelope_to, :envelope_from, :header_from
       ]
 
-      # @!attribute [rw] source_ip
+      # @!attribute [r] source_ip
       #   @return [String, nil] the sending IP address.
-      # @!attribute [rw] count
+      # @!attribute [r] count
       #   @return [Integer, nil] the number of messages from this source.
-      # @!attribute [rw] disposition
+      # @!attribute [r] disposition
       #   @return [String, nil] the action applied to the messages.
-      # @!attribute [rw] dkim
+      # @!attribute [r] dkim
       #   @return [String, nil] the DKIM evaluation result.
-      # @!attribute [rw] spf
+      # @!attribute [r] spf
       #   @return [String, nil] the SPF evaluation result.
-      # @!attribute [rw] envelope_to
+      # @!attribute [r] envelope_to
       #   @return [String, nil] the envelope recipient domain.
-      # @!attribute [rw] envelope_from
+      # @!attribute [r] envelope_from
       #   @return [String, nil] the envelope sender domain.
-      # @!attribute [rw] header_from
+      # @!attribute [r] header_from
       #   @return [String, nil] the `From` header domain.
-      ATTRIBUTES.each { |attribute| attr_accessor(attribute) }
-      attr_writer :auth_results, :reasons
+      ATTRIBUTES.each { |attribute| attr_reader(attribute) }
 
       def initialize(node)
         @node = node
@@ -65,7 +64,7 @@ module DMARCator
       def reasons
         return @reasons if defined?(@reasons)
 
-        @reasons = @reason_nodes.map { |reason_node| Reason.new(reason_node) }
+        @reasons = @reason_nodes.map { |reason_node| Reason.new(reason_node) }.freeze
       end
 
       #
@@ -78,7 +77,7 @@ module DMARCator
 
         @auth_results = @auth_result_nodes.map do |auth_result_node|
           AuthResult.new(auth_result_node)
-        end
+        end.freeze
       end
 
       private
@@ -87,9 +86,9 @@ module DMARCator
         row.element_children.each do |element|
           case element.name
           when 'source_ip'
-            self.source_ip ||= element.text
+            @source_ip ||= element.text.freeze
           when 'count'
-            self.count ||= parse_integer(element.text)
+            @count ||= parse_integer(element.text.freeze)
           when 'policy_evaluated'
             parse_policy_evaluated(element)
           end
@@ -100,11 +99,11 @@ module DMARCator
         policy_evaluated.element_children.each do |element|
           case element.name
           when 'disposition'
-            self.disposition ||= element.text
+            @disposition ||= element.text.freeze
           when 'dkim'
-            self.dkim ||= element.text
+            @dkim ||= element.text.freeze
           when 'spf'
-            self.spf ||= element.text
+            @spf ||= element.text.freeze
           when 'reason'
             @reason_nodes << element
           end
@@ -115,11 +114,11 @@ module DMARCator
         identifiers.element_children.each do |element|
           case element.name
           when 'envelope_to'
-            self.envelope_to ||= element.text
+            @envelope_to ||= element.text.freeze
           when 'envelope_from'
-            self.envelope_from ||= element.text
+            @envelope_from ||= element.text.freeze
           when 'header_from'
-            self.header_from ||= element.text
+            @header_from ||= element.text.freeze
           end
         end
       end

data/lib/dmarcator/report.rb

@@ -1,10 +1,9 @@
 # frozen_string_literal: true
 
 require 'nokogiri'
-require 'bigdecimal'
-require 'bigdecimal/util'
 
-require_relative 'xml_helper'
+require_relative 'config'
+require_relative 'internal/xml_helper'
 require_relative 'exceptions'
 require_relative 'report/metadata'
 require_relative 'report/policy'
@@ -18,25 +17,40 @@ module DMARCator
   # resolved or fetched; treat report XML as untrusted input.
   #
   class Report
-    include XmlHelper
+    include Internal::XmlHelper
 
     # Default maximum accepted report size in bytes (25 MiB).
-    MAX_REPORT_BYTES = 25 * 1024 * 1024
+    #
+    # @deprecated Use {Config::DEFAULT_MAX_REPORT_BYTES}. Removed in 2.0.
+    #
+    MAX_REPORT_BYTES = Config::DEFAULT_MAX_REPORT_BYTES
 
     class << self
       #
       # The maximum accepted report size in bytes.
       #
-      # Defaults to {MAX_REPORT_BYTES}. Parsing a report builds a DOM that is
-      # roughly 13x the input size, so lower this to bound memory for reports
-      # from untrusted sources.
+      # @deprecated Use {DMARCator.configure} with `config.max_report_bytes`.
+      #   Removed in 2.0.
       #
       # @return [Integer]
       #
-      attr_writer :max_report_bytes
-
       def max_report_bytes
-        @max_report_bytes || MAX_REPORT_BYTES
+        DMARCator.config.max_report_bytes
+      end
+
+      #
+      # Sets the maximum accepted report size in bytes.
+      #
+      # @deprecated Use {DMARCator.configure} with `config.max_report_bytes`.
+      #   Removed in 2.0.
+      #
+      # @param [Integer, nil] value
+      #
+      # @raise [ArgumentError]
+      #   The value is not a positive Integer or nil.
+      #
+      def max_report_bytes=(value)
+        DMARCator.config.max_report_bytes = value
       end
     end
 
@@ -47,8 +61,8 @@ module DMARCator
     #   The raw DMARC XML report.
     #
     # @raise [InvalidReport]
-    #   The report is not a String, exceeds {.max_report_bytes}, or is not
-    #   well-formed XML.
+    #   The report is not a String, exceeds
+    #   {Config#max_report_bytes}, or is not well-formed XML.
     #
     def initialize(xml)
       unless xml.is_a?(String)
@@ -57,7 +71,7 @@ module DMARCator
 
       @xml = xml
 
-      limit = self.class.max_report_bytes
+      limit = DMARCator.config.max_report_bytes
 
       if xml.bytesize > limit
         raise InvalidReport, "DMARC XML report exceeds maximum size of #{limit} bytes"
@@ -73,23 +87,22 @@ module DMARCator
     end
 
     #
-    # The report version.
+    # The report version, as published.
+    #
+    # Returned as a String because versions are opaque identifiers, not
+    # numbers to compute with.
     #
-    # @return [BigDecimal, nil]
+    # @return [String, nil]
+    #   The version, or `nil` when it is absent or not numeric.
     #
     def version
       return @version if defined?(@version)
 
       @version = begin
         value = get_text('feedback/version')
+        value = value.strip if value
 
-        if value && !value.empty?
-          begin
-            BigDecimal(value)
-          rescue ArgumentError
-            nil
-          end
-        end
+        value.freeze if value && value.match?(/\A\d+(?:\.\d+)*\z/)
       end
     end
 
@@ -119,7 +132,7 @@ module DMARCator
     def records
       @records ||= @node.xpath('feedback/record').map do |node|
         Row.new(node)
-      end
+      end.freeze
     end
   end
 end

data/lib/dmarcator/version.rb

@@ -2,5 +2,5 @@
 
 module DMARCator
   # dmarcator version
-  VERSION = '0.11.0'
+  VERSION = '1.0.0'
 end

data/lib/dmarcator.rb

@@ -3,7 +3,7 @@
 require 'dmarcator/exceptions'
 require 'dmarcator/query'
 require 'dmarcator/record'
-require 'dmarcator/parser'
+require 'dmarcator/internal/parser'
 require 'dmarcator/report'
 require 'dmarcator/version'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dmarcator
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Noah Berman
@@ -43,20 +43,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.10'
-- !ruby/object:Gem::Dependency
-  name: bigdecimal
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.0'
 description: A hardened DMARC record parser and query client, forked from the Trail
   of Bits 'dmarc' gem.
 email:
@@ -71,7 +57,8 @@ files:
 - lib/dmarcator.rb
 - lib/dmarcator/config.rb
 - lib/dmarcator/exceptions.rb
-- lib/dmarcator/parser.rb
+- lib/dmarcator/internal/parser.rb
+- lib/dmarcator/internal/xml_helper.rb
 - lib/dmarcator/query.rb
 - lib/dmarcator/record.rb
 - lib/dmarcator/report.rb
@@ -86,7 +73,6 @@ files:
 - lib/dmarcator/resolver/encrypted.rb
 - lib/dmarcator/uri.rb
 - lib/dmarcator/version.rb
-- lib/dmarcator/xml_helper.rb
 homepage: https://github.com/bermannoah/dmarcator
 licenses:
 - MIT