dmarc 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 97e07c7f904e46b02faa4ce8358e3420b4ae4869
-  data.tar.gz: 41f067c094fcf208cf93d7f06c2c3fdd139d2c18
+SHA256:
+  metadata.gz: 2e3b30301fd8b3d2ab7d423ed7afbda2cc5222047256e947f18870290c48c69d
+  data.tar.gz: 31b591fb978c4ff538b5d36bea8c896dff0e7bc30a196c64e501215abd0610d2
 SHA512:
-  metadata.gz: 3083a287ebfbf9aa267721fb7383f17404ce392c3481aa76e4873ac135bf2cad67a7148bfc787100447b6351b6e9459dc3a2d1c62f628b94543310831d42aabd
-  data.tar.gz: ba197f0a39720736446c499cecb1b93e2f8b41826f3113a2014e4655503da3837a9c2501d42ea0218c963dd5337dd832f82a84fdc233855784f4542827f66072
+  metadata.gz: 3c1c83f438dfdbe45f58a3382e9404d6113ffbefa0d79174673867d3efc399a76128a38cadf0e6ddc06baa45a5719193be48784cc96361cad732e543bd6c4bd5
+  data.tar.gz: 37437cba5c79511cd060c4dc49aaead5356f76ff45c746f147349c19f3b28e1529cae4ec1b6f2f4c16fe1c41d089f441b28483809f24f78e833385dc41d54685

data/.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: CI
+
+on:
+  push:
+    branches: master
+  pull_request: []
+
+jobs:
+  tests:
+    strategy:
+      matrix:
+        ruby:
+          - "2.6"
+          - "2.7"
+          - "3.0"
+          - "3.1"
+    runs-on: ubuntu-latest
+    steps:
+    - name: Set up Git repository
+      uses: actions/checkout@main
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+
+    - name: Run tests
+      run: bundle exec rake spec

data/.gitignore

@@ -1,19 +1,7 @@
-Gemfile.lock
+/Gemfile.lock
+/.bundle/
+/doc/
+/coverage/
+/pkg/
+/.yardoc/
 *.gem
-*.rbc
-.bundle
-.config
-coverage
-InstalledFiles
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-
-# YARD artifacts
-.yardoc
-_yardoc
-doc/

data/CODEOWNERS

@@ -0,0 +1 @@
+* @postmodern @woodruffw

data/ChangeLog.md

@@ -1,4 +1,12 @@
-### 0.4.0 / 2016-07-10
+### 0.6.0 / 2024-01-24
+
+* {DMARC::Record.parse} now allows trailing whitespace, per DMARC spec.
+
+### 0.5.0 / 2016-06-16
+
+* Added {DMARC::Uri} to represent `mailto:dmarc@example.com!10m` URIs.
+
+### 0.4.0 / 2016-06-10
 
 * Added {DMARC::Record#to_h}.
 * Added {DMARC::Record#adkim?}.

data/Gemfile

@@ -4,14 +4,16 @@ gemspec
 
 group :development do
   gem 'rake'
+  gem 'rubygems-tasks', '~> 0.2'
+
   gem 'nokogiri'
   gem 'rspec', '~> 3.0'
 
   gem 'kramdown'
-  gem 'yard', '~> 0.8'
+  gem 'yard', '~> 0.9'
 end
 
 group :test do
   gem 'json'
-  gem 'codeclimate-test-reporter', require: nil
+  gem 'simplecov', require: nil
 end

data/README.md

@@ -12,7 +12,7 @@ parser for DMARC records.
 
 ## Example
 
-Parse a SPF record:
+Parse a DMARC record:
 
     require 'dmarc'
 
@@ -43,18 +43,18 @@ Parse a SPF record:
     # => 86400
 
     record.rua
-    # => [#<URI::MailTo:0x000000034a1cc8 URL:mailto:d@rua.agari.com>]
+    # => [#<DMARC::Uri:0x0055ede60711e0 @uri=#<URI::MailTo mailto:d@rua.agari.com>, @size=nil, @unit=nil>]
 
     record.ruf
-    # => [#<URI::MailTo:0x000000034a02b0 URL:mailto:d@ruf.agari.com>]
+    # => [#<DMARC::Uri:0x0055ede606f138 @uri=#<URI::MailTo mailto:d@ruf.agari.com>, @size=nil, @unit=nil>]
 
     record.sp
     # => :reject
 
-Query the SPF record for a domain:
+Query the DMARC record for a domain:
 
     record = DMARC::Record.query('twitter.com')
-    # => #<DMARC::Record:0x0000000313bd90 @adkim=:r, @aspf=:r, @fo=["1"@79], @p=:reject, @pct=100, @rf=:afrf, @ri=86400, @rua=[#<URI::MailTo:0x00000003124e38 URL:mailto:d@rua.agari.com>], @ruf=[#<URI::MailTo:0x00000003132678 URL:mailto:d@ruf.agari.com>], @sp=:reject, @v=:DMARC1>
+    # => #<DMARC::Record:0x0055ede6b808b0 @v=:DMARC1, @adkim=nil, @aspf=nil, @fo=["1"@79], @p=:reject, @pct=nil, @rf=nil, @ri=nil, @rua=[#<DMARC::Uri:0x0055ede6ba1c40 @uri=#<URI::MailTo mailto:d@rua.agari.com>, @size=nil, @unit=nil>], @ruf=[#<DMARC::Uri:0x0055ede6b8b760 @uri=#<URI::MailTo mailto:d@ruf.agari.com>, @size=nil, @unit=nil>], @sp=nil>
 
 ## Requirements
 

data/Rakefile

@@ -11,7 +11,8 @@ rescue LoadError => e
 end
 
 require 'rake'
-require 'bundler/gem_tasks'
+require 'rubygems/tasks'
+Gem::Tasks.new
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new

data/dmarc.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.required_ruby_version = '>= 1.9.1'
 
-  gem.add_dependency 'parslet', '~> 1.5'
+  gem.add_dependency 'parslet', '>= 1.0.0', '< 3.0.0'
 
-  gem.add_development_dependency 'bundler', '~> 1.0'
+  gem.add_development_dependency 'bundler', '~> 2.0'
 end

data/lib/dmarc/parser.rb

@@ -1,5 +1,6 @@
-require 'parslet'
+require 'dmarc/uri'
 
+require 'parslet'
 require 'uri'
 
 module DMARC
@@ -15,7 +16,8 @@ module DMARC
     rule(:dmarc_record) do
       dmarc_version.repeat(1,1) >>
       (dmarc_sep >> dmarc_tag).repeat >>
-      dmarc_sep.maybe
+      dmarc_sep.maybe >>
+      wsp?.maybe
     end
 
     rule(:dmarc_sep) { wsp? >> str(';') >> wsp? }
@@ -183,7 +185,20 @@ module DMARC
       rule(pct: simple(:pct)) { {pct: pct.to_i} }
       rule(ri:  simple(:ri))  { {ri:  ri.to_i}  }
 
-      rule(uri: simple(:uri)) { URI.parse(uri) }
+      rule(uri: simple(:uri), size: simple(:size), unit: simple(:unit)) do
+        Uri.new(
+          URI.parse(uri),
+          size.to_i,
+          unit.to_sym
+        )
+      end
+      rule(uri: simple(:uri), size: simple(:size)) do
+        Uri.new(
+          URI.parse(uri),
+          size.to_i
+        )
+      end
+      rule(uri: simple(:uri)) { Uri.new(URI.parse(uri)) }
       rule(rua: subtree(:uris)) { {rua: Array(uris)} }
       rule(ruf: subtree(:uris)) { {ruf: Array(uris)} }
 

data/lib/dmarc/record.rb

@@ -14,12 +14,12 @@ module DMARC
 
     # `rua` field.
     #
-    # @return [Array<URI::MailTo>]
+    # @return [Array<Uri>]
     attr_reader :rua
 
     # `rua` field.
     #
-    # @return [Array<URI::MailTo>]
+    # @return [Array<Uri>]
     attr_reader :ruf
 
     # `sp` field.
@@ -52,9 +52,9 @@ module DMARC
     #
     # @option attributes [Integer] :ri (86400)
     #
-    # @option attributes [Array<URI::MailTo>] :rua
+    # @option attributes [Array<Uri>] :rua
     #
-    # @option attributes [Array<URI::MailTo>] :ruf
+    # @option attributes [Array<Uri>] :ruf
     #
     # @option attributes [:none, :quarantine, :reject] :sp
     #

data/lib/dmarc/uri.rb

@@ -0,0 +1,105 @@
+module DMARC
+  #
+  # Represents a DMARC URI.
+  #
+  # @see https://tools.ietf.org/html/rfc7489#section-6.2
+  #
+  # @since 0.5.0
+  #
+  class Uri
+
+    # The `mailto:` URI.
+    #
+    # @return [URI::MailTo]
+    attr_reader :uri
+
+    # The optional maximum-size.
+    #
+    # @return [Integer, nil]
+    attr_reader :size
+
+    # The optional unit.
+    #
+    # @return [:k, :m, :g, :t, nil]
+    attr_reader :unit
+
+    #
+    # Initializes the DMARC URI.
+    #
+    # @param [URI::MailTo] uri
+    #   The `mailto:` URI.
+    #
+    # @param [Integer] size
+    #   The optional maximum-size.
+    #
+    # @param [:k, :m, :g, :t] unit
+    #   The optional size unit.
+    #
+    def initialize(uri,size=nil,unit=nil)
+      @uri = uri
+
+      @size = size
+      @unit = unit
+    end
+
+    #
+    # Determines if a maximum-size was set.
+    #
+    # @return [Boolean]
+    #
+    def size?
+      !@size.nil?
+    end
+
+    #
+    # Determines if a size unit was set.
+    #
+    # @return [Boolean]
+    #
+    def unit?
+      !@unit.nil?
+    end
+
+    #
+    # Determines if the DMARC URI matches the other.
+    #
+    # @param [Object] other
+    #   the other DMARC URI to compare against.
+    #
+    # @return [Boolean]
+    #
+    def ==(other)
+      (self.class == other.class) &&
+      (@uri == other.uri) &&
+      (@size == other.size) &&
+      (@unit == other.unit)
+    end
+
+    #
+    # Converts the DMARC URI back into a String.
+    #
+    # @return [String]
+    #
+    def to_s
+      str = @uri.to_s
+
+      if (@size || @unit)
+        str << "!"
+        str << "#{@size}" if @size
+        str << "#{@unit}" if @unit
+      end
+
+      return str
+    end
+
+    protected
+
+    #
+    # Pass all missing methods to {#uri}.
+    #
+    def method_missing(name,*arguments,&block)
+      @uri.send(name,*arguments,&block)
+    end
+
+  end
+end

data/lib/dmarc/version.rb

@@ -1,4 +1,4 @@
 module DMARC
   # dmarc version
-  VERSION = '0.4.0'
+  VERSION = '0.6.0'
 end

data/spec/parser_spec.rb

@@ -80,6 +80,15 @@ describe Parser do
         ])
       end
 
+      it 'ignores trailing spacing without final separator' do
+        record = 'v=DMARC1; p=none '
+
+        expect(subject.parse(record)).to eq([
+          {v: 'DMARC1'},
+          {p: 'none'}
+        ])
+      end
+
       it "ignores unknown tags" do
         record = 'v=DMARC1;p=none;foo=xxx;sp=reject;bar=xxx;adkim=r;aspf=r'
         expect(subject.parse(record)).to eq([
@@ -365,8 +374,8 @@ describe Parser do
       expect(subject).to include(aspf: :r)
     end
 
-    it "should convert {uri: ...} to URI objects" do
-      expect(subject).to include(rua: [URI("mailto:d@rua.agari.com")])
+    it "should convert {uri: ...} to Uri objects" do
+      expect(subject).to include(rua: [Uri.new(URI("mailto:d@rua.agari.com"))])
     end
   end
 

data/spec/spec_helper.rb

@@ -1,5 +1,5 @@
-require "codeclimate-test-reporter"
-CodeClimate::TestReporter.start
+require 'simplecov'
+SimpleCov.start
 
 require 'rspec'
 require 'dmarc'

data/spec/uri_spec.rb

@@ -0,0 +1,141 @@
+require 'spec_helper'
+require 'dmarc/uri'
+
+describe DMARC::Uri do
+  let(:uri)  { URI("mailto:d@ruf.agari.com") }
+  let(:size) { 10 }
+  let(:unit) { :m }
+
+  subject { described_class.new(uri,size,unit) }
+
+  describe "#initialize" do
+    it "should set the uri" do
+      expect(subject.uri).to be uri
+    end
+
+    it "should set the size" do
+      expect(subject.size).to be size
+    end
+
+    it "should set the unit" do
+      expect(subject.unit).to be unit
+    end
+
+    context "when size is omitted" do
+      subject { described_class.new(uri) }
+
+      it "should set size to nil" do
+        expect(subject.size).to be(nil)
+      end
+
+      it "should set unit to nil" do
+        expect(subject.unit).to be(nil)
+      end
+    end
+
+    context "when unit is omitted" do
+      subject { described_class.new(uri,size) }
+
+      it "should set size" do
+        expect(subject.size).to be(size)
+      end
+
+      it "should set unit to nil" do
+        expect(subject.unit).to be(nil)
+      end
+    end
+  end
+
+  describe "#size?" do
+    context "when size is nil" do
+      subject { described_class.new(uri) }
+
+      it { expect(subject.size?).to be(false) }
+    end
+
+    context "when size is set" do
+      subject { described_class.new(uri,size) }
+
+      it { expect(subject.size?).to be(true) }
+    end
+  end
+
+  describe "#unit?" do
+    context "when unit is nil" do
+      subject { described_class.new(uri,size) }
+
+      it { expect(subject.unit?).to be(false) }
+    end
+
+    context "when unit is set" do
+      subject { described_class.new(uri,size,unit) }
+
+      it { expect(subject.unit?).to be(true) }
+    end
+  end
+
+  describe "#==" do
+    context "when other is a #{described_class}" do
+      context "and all fields match" do
+        let(:other) { described_class.new(uri.dup,size,unit) }
+
+        it { expect(subject == other).to be(true) }
+      end
+
+      context "but the uri is different" do
+        let(:other_uri) { URI("mailto:foo@example.com")            }
+        let(:other)     { described_class.new(other_uri,size,unit) }
+
+        it { expect(subject == other).to be(false) }
+      end
+
+      context "but the size is different" do
+        let(:other) { described_class.new(uri,42,unit) }
+
+        it { expect(subject == other).to be(false) }
+      end
+
+      context "but the unit is different" do
+        let(:other) { described_class.new(uri,size,:t) }
+
+        it { expect(subject == other).to be(false) }
+      end
+    end
+
+    context "when other is a different class" do
+      let(:other) { Object.new }
+
+      it { expect(subject == other).to be(false) }
+    end
+  end
+
+  describe "#to_s" do
+    context "when only the uri is set" do
+      subject { described_class.new(uri) }
+
+      it "should return the uri" do
+        expect(subject.to_s).to be == uri.to_s
+      end
+    end
+
+    context "when uri and size are set" do
+      subject { described_class.new(uri,size) }
+
+      it "should return the uri!size" do
+        expect(subject.to_s).to be == "#{uri}!#{size}"
+      end
+    end
+
+    context "when uri, size and unit are set" do
+      it "should return the uri!size" do
+        expect(subject.to_s).to be == "#{uri}!#{size}#{unit}"
+      end
+    end
+  end
+
+  describe "#method_missing" do
+    it "should pass through methods to uri" do
+      expect(subject.host).to be(uri.host)
+    end
+  end
+end

metadata

@@ -1,43 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: dmarc
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Davis Gallinghouse
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-06-11 00:00:00.000000000 Z
+date: 2024-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parslet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 description: DMARC Record Parser
 email:
 - davis@trailofbits.com
@@ -46,10 +52,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".document"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - ".yardopts"
+- CODEOWNERS
 - ChangeLog.md
 - Gemfile
 - LICENSE.txt
@@ -61,18 +68,20 @@ files:
 - lib/dmarc/exceptions.rb
 - lib/dmarc/parser.rb
 - lib/dmarc/record.rb
+- lib/dmarc/uri.rb
 - lib/dmarc/version.rb
 - spec/data/alexa.csv
 - spec/dmarc_spec.rb
 - spec/parser_spec.rb
 - spec/record_spec.rb
 - spec/spec_helper.rb
+- spec/uri_spec.rb
 - tasks/alexa.rb
 homepage: https://github.com/trailofbits/dmarc#readme
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -87,9 +96,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: DMARC Record Parser
 test_files:
@@ -98,4 +106,4 @@ test_files:
 - spec/parser_spec.rb
 - spec/record_spec.rb
 - spec/spec_helper.rb
-has_rdoc: 
+- spec/uri_spec.rb

data/.travis.yml

@@ -1,16 +0,0 @@
-language: ruby
-rvm:
-- 2.1.8
-- 2.2.4
-- 2.3.0
-- jruby
-- rbx-2
-matrix:
-  allow_failures:
-  - rvm: rbx-2
-addons:
-  code_climate:
-    repo_token: 27519af871c1d9576b91e6f264e841eb7b7babbdcda315bf94fcbd095c202949
-notifications:
-  slack:
-    secure: Jqj30lwH2fnyu8adMI2nXa7rfF70o5JSrL0ZOe425XVu3YMMpfIp8J4DD0Ks/nCxgGRhJpq35oAHXjKmJAEHyda9oxx7GV9QwOuu2oviUrW3VUQQj9UsXPQP0sc0GD9BPI+KVNp4dbGki1ik90I6HVVsqDauek/z5MWt6MJY+tA=