dmarc 0.2.0 → 0.3.0

data/lib/dmarc/version.rb

@@ -1,4 +1,4 @@
 module DMARC
   # dmarc version
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/spec/dmarc_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+require 'dmarc'
+
+describe DMARC do
+  subject { described_class }
+
+  describe ".query" do
+    context "when given a domain" do
+      let(:domain) { 'google.com' }
+
+      it "should query and parse the DMARC record" do
+        record = subject.query(domain)
+
+        expect(record).to be == 'v=DMARC1; p=quarantine; rua=mailto:mailauth-reports@google.com'
+      end
+    end
+
+    context "when given a bad domain" do
+      it "should raise a DNS error" do
+        expect(subject.query('foobar.com')).to be_nil
+      end
+    end
+  end
+end

data/spec/parser_spec.rb

@@ -2,301 +2,322 @@ require 'spec_helper'
 require 'dmarc/parser'
 
 describe Parser do
-  describe '#dmarc_uri' do
-    subject { described_class.new.dmarc_uri }
+  describe "rules" do
+    describe 'dmarc_uri' do
+      subject { described_class.new.dmarc_uri }
 
-    let(:uri) { 'mailto:user@example.org' }
+      let(:uri) { 'mailto:user@example.org' }
 
-    it 'parses mailto URIs' do
-      expect(subject.parse(uri)).to eq(uri: uri)
-    end
+      it 'parses mailto URIs' do
+        expect(subject.parse(uri)).to eq(uri: uri)
+      end
 
-    it 'parses mailto URIs with size' do
-      expect(subject.parse(uri + '!20')).to eq(uri: uri, size: '20')
-    end
+      it 'parses mailto URIs with size' do
+        expect(subject.parse(uri + '!20')).to eq(uri: uri, size: '20')
+      end
 
-    it 'parses mailto URIs with size and unit' do
-      expect(subject.parse(uri + '!20k')).to eq(uri: uri, size: '20', unit: 'k')
+      it 'parses mailto URIs with size and unit' do
+        expect(subject.parse(uri + '!20k')).to eq(uri: uri, size: '20', unit: 'k')
+      end
     end
-  end
 
-  describe '#dmarc_record' do
-    subject { described_class.new.dmarc_record }
+    describe 'dmarc_record' do
+      subject { described_class.new.dmarc_record }
 
-    it 'parses version and policy' do
-      record = 'v=DMARC1;p=none'
-      expect(subject.parse record).to eq([
-        {v: 'DMARC1'},
-        {p: 'none'}
-      ])
-    end
+      it 'parses version and policy' do
+        record = 'v=DMARC1;p=none'
+        expect(subject.parse record).to eq([
+          {v: 'DMARC1'},
+          {p: 'none'}
+        ])
+      end
 
-    it 'parses version, policy, and other tags' do
-      record = 'v=DMARC1;p=none;sp=reject;adkim=r;aspf=r'
-      expect(subject.parse(record)).to eq([
-        {v: 'DMARC1'},
-        {p: 'none'},
-        {sp: 'reject'},
-        {adkim: 'r'},
-        {aspf: 'r'}
-      ])
-    end
+      it 'parses version, policy, and other tags' do
+        record = 'v=DMARC1;p=none;sp=reject;adkim=r;aspf=r'
+        expect(subject.parse(record)).to eq([
+          {v: 'DMARC1'},
+          {p: 'none'},
+          {sp: 'reject'},
+          {adkim: 'r'},
+          {aspf: 'r'}
+        ])
+      end
 
-    it 'parses version, policy, and rua' do
-      record = 'v=DMARC1;p=quarantine;rua=mailto:foo@example.com,mailto:bar@example.com'
-      expect(subject.parse record).to eq([
-        {v: 'DMARC1'},
-        {p: 'quarantine'},
-        {rua: [
-          {uri: 'mailto:foo@example.com'},
-          {uri: 'mailto:bar@example.com'}
-        ]}
-      ])
-    end
+      it 'parses version, policy, and rua' do
+        record = 'v=DMARC1;p=quarantine;rua=mailto:foo@example.com,mailto:bar@example.com'
+        expect(subject.parse record).to eq([
+          {v: 'DMARC1'},
+          {p: 'quarantine'},
+          {rua: [
+            {uri: 'mailto:foo@example.com'},
+            {uri: 'mailto:bar@example.com'}
+          ]}
+        ])
+      end
 
-    it 'ignores spacing' do
-      record1 = 'v=DMARC1;p=none;sp=reject'
-      record2 = 'v = DMARC1 ; p = none ; sp = reject'
-      expect(subject.parse record1).to eq(subject.parse record2)
-    end
+      it 'ignores order of tags' do
+        record = 'v=DMARC1; rua=mailto:foo@example.com; p=none'
 
-    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([
-        {v: 'DMARC1'},
-        {p: 'none'},
-        {sp: 'reject'},
-        {adkim: 'r'},
-        {aspf: 'r'}
-      ])
-    end
+        expect(subject.parse(record)).to eq([
+          {v: 'DMARC1'},
+          {rua: {uri: 'mailto:foo@example.com'}},
+          {p: 'none'}
+        ])
+      end
 
-    it "ignores syntax errors" do
-      record = 'v=DMARC1;p=none;sp;adkim=X;aspf='
-      expect(subject.parse(record)).to eq([
-        {v: 'DMARC1'},
-        {p: 'none'}
-      ])
-    end
-  end
+      it 'ignores spacing' do
+        record1 = 'v=DMARC1;p=none;sp=reject'
+        record2 = 'v = DMARC1 ; p = none ; sp = reject'
+        expect(subject.parse record1).to eq(subject.parse record2)
+      end
 
-  describe '#dmarc_version' do
-    subject { described_class.new.dmarc_version }
+      it 'ignores trailing separators' do
+        record = 'v=DMARC1; p=none; '
 
-    it 'parses DMARC versions' do
-      expect(subject.parse('v=DMARC1')).to eq(v: 'DMARC1')
-    end
+        expect(subject.parse(record)).to eq([
+          {v: 'DMARC1'},
+          {p: 'none'}
+        ])
+      end
 
-    it 'ignores spacing' do
-      expect(subject.parse 'v = DMARC1').to eq(subject.parse 'v=DMARC1')
+      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([
+          {v: 'DMARC1'},
+          {p: 'none'},
+          {sp: 'reject'},
+          {adkim: 'r'},
+          {aspf: 'r'}
+        ])
+      end
+
+      it "ignores syntax errors" do
+        record = 'v=DMARC1;p=none;sp;adkim=X;aspf='
+        expect(subject.parse(record)).to eq([
+          {v: 'DMARC1'},
+          {p: 'none'}
+        ])
+      end
     end
-  end
 
-  describe '#dmarc_request' do
-    subject { described_class.new.dmarc_request }
+    describe 'dmarc_version' do
+      subject { described_class.new.dmarc_version }
 
-    it 'parses "none" requests' do
-      expect(subject.parse('p=none')).to eq(p: 'none')
-    end
+      it 'parses DMARC versions' do
+        expect(subject.parse('v=DMARC1')).to eq(v: 'DMARC1')
+      end
 
-    it 'parses quarantine requests' do
-      expect(subject.parse('p=quarantine')).to eq(p: 'quarantine')
+      it 'ignores spacing' do
+        expect(subject.parse 'v = DMARC1').to eq(subject.parse 'v=DMARC1')
+      end
     end
 
-    it 'parses reject requests' do
-      expect(subject.parse('p=reject')).to eq(p: 'reject')
-    end
+    describe 'dmarc_request' do
+      subject { described_class.new.dmarc_request }
 
-    it 'ingores spacing' do
-      expect(subject.parse 'p=none').to eq(subject.parse 'p = none')
-    end
-  end
+      it 'parses "none" requests' do
+        expect(subject.parse('p=none')).to eq(p: 'none')
+      end
 
-  describe '#dmarc_srequest' do
-    subject { described_class.new.dmarc_srequest }
+      it 'parses quarantine requests' do
+        expect(subject.parse('p=quarantine')).to eq(p: 'quarantine')
+      end
 
-    it 'parses "none" requests' do
-      expect(subject.parse('sp=none')).to eq(sp: 'none')
-    end
+      it 'parses reject requests' do
+        expect(subject.parse('p=reject')).to eq(p: 'reject')
+      end
 
-    it 'parses quarantine requests' do
-      expect(subject.parse('sp=quarantine')).to eq(sp: 'quarantine')
+      it 'ingores spacing' do
+        expect(subject.parse 'p=none').to eq(subject.parse 'p = none')
+      end
     end
 
-    it 'parses reject requests' do
-      expect(subject.parse('sp=reject')).to eq(sp: 'reject')
-    end
+    describe 'dmarc_srequest' do
+      subject { described_class.new.dmarc_srequest }
 
-    it 'ignores spacing' do
-      expect(subject.parse 'sp=none').to eq(subject.parse 'sp = none')
-    end
-  end
+      it 'parses "none" requests' do
+        expect(subject.parse('sp=none')).to eq(sp: 'none')
+      end
 
-  describe '#dmarc_auri' do
-    subject { described_class.new.dmarc_auri }
+      it 'parses quarantine requests' do
+        expect(subject.parse('sp=quarantine')).to eq(sp: 'quarantine')
+      end
 
-    it 'parses one URI' do
-      expect(subject.parse('rua=mailto:user@example.org')).to eq(
-        rua: {
-          uri: 'mailto:user@example.org'
-        }
-      )
-    end
+      it 'parses reject requests' do
+        expect(subject.parse('sp=reject')).to eq(sp: 'reject')
+      end
 
-    it 'parses many URIs' do
-      expect(
-        subject.parse('rua = mailto:user1@example.org, mailto:user2@example.org')
-      ).to eq(
-        rua: [
-          {uri: 'mailto:user1@example.org'},
-          {uri: 'mailto:user2@example.org'}
-        ]
-      )
+      it 'ignores spacing' do
+        expect(subject.parse 'sp=none').to eq(subject.parse 'sp = none')
+      end
     end
 
-    it 'parses maximum report size' do
-      expect(subject.parse('rua = mailto:user1@example.com!20m')).to eq(
-        rua: {
-          uri: 'mailto:user1@example.com',
-          size: '20',
-          unit: 'm'
-        }
-      )
-    end
-  end
+    describe 'dmarc_auri' do
+      subject { described_class.new.dmarc_auri }
 
-  describe '#dmarc_ainterval' do
-    subject { described_class.new.dmarc_ainterval }
+      it 'parses one URI' do
+        expect(subject.parse('rua=mailto:user@example.org')).to eq(
+          rua: {
+            uri: 'mailto:user@example.org'
+          }
+        )
+      end
 
-    it 'parses a one digit interval' do
-      expect(subject.parse('ri=1')).to eq(ri: '1')
-    end
+      it 'parses many URIs' do
+        expect(
+          subject.parse('rua = mailto:user1@example.org, mailto:user2@example.org')
+        ).to eq(
+          rua: [
+            {uri: 'mailto:user1@example.org'},
+            {uri: 'mailto:user2@example.org'}
+          ]
+        )
+      end
 
-    it 'parses a many digit interval' do
-      expect(subject.parse('ri=86400')).to eq(ri: '86400')
+      it 'parses maximum report size' do
+        expect(subject.parse('rua = mailto:user1@example.com!20m')).to eq(
+          rua: {
+            uri: 'mailto:user1@example.com',
+            size: '20',
+            unit: 'm'
+          }
+        )
+      end
     end
 
-    it 'ignores spacing' do
-      expect(subject.parse 'ri = 86400').to eq(subject.parse 'ri=86400')
-    end
-  end
+    describe 'dmarc_ainterval' do
+      subject { described_class.new.dmarc_ainterval }
 
-  describe '#dmarc_furi' do
-    subject { described_class.new.dmarc_furi }
+      it 'parses a one digit interval' do
+        expect(subject.parse('ri=1')).to eq(ri: '1')
+      end
 
-    it 'parses one URI' do
-      expect(subject.parse('ruf=mailto:user@example.org')).to eq(
-        ruf: {
-          uri: 'mailto:user@example.org'
-        }
-      )
-    end
+      it 'parses a many digit interval' do
+        expect(subject.parse('ri=86400')).to eq(ri: '86400')
+      end
 
-    it 'parses many URIs' do
-      expect(
-        subject.parse('ruf = mailto:user1@example.org, mailto:user2@example.org')
-      ).to eq(
-        ruf: [
-          {uri: 'mailto:user1@example.org'},
-          {uri: 'mailto:user2@example.org'}
-        ]
-      )
+      it 'ignores spacing' do
+        expect(subject.parse 'ri = 86400').to eq(subject.parse 'ri=86400')
+      end
     end
 
-    it 'parses maximum report size' do
-      expect(subject.parse('ruf = mailto:user1@example.com!20m')).to eq(
-        ruf: {
-          uri: 'mailto:user1@example.com',
-          size: '20',
-          unit: 'm'
-        }
-      )
+    describe 'dmarc_furi' do
+      subject { described_class.new.dmarc_furi }
+
+      it 'parses one URI' do
+        expect(subject.parse('ruf=mailto:user@example.org')).to eq(
+          ruf: {
+            uri: 'mailto:user@example.org'
+          }
+        )
+      end
+
+      it 'parses many URIs' do
+        expect(
+          subject.parse('ruf = mailto:user1@example.org, mailto:user2@example.org')
+        ).to eq(
+          ruf: [
+            {uri: 'mailto:user1@example.org'},
+            {uri: 'mailto:user2@example.org'}
+          ]
+        )
+      end
+
+      it 'parses maximum report size' do
+        expect(subject.parse('ruf = mailto:user1@example.com!20m')).to eq(
+          ruf: {
+            uri: 'mailto:user1@example.com',
+            size: '20',
+            unit: 'm'
+          }
+        )
+      end
     end
-  end
 
-  describe '#dmarc_fo' do
-    let(:fo) { described_class.new.dmarc_fo }
+    describe 'dmarc_fo' do
+      let(:fo) { described_class.new.dmarc_fo }
 
-    context 'one value' do
-      %w[0 1 d s].each do |value|
-        it "parses #{value}" do
-          expect(fo.parse("fo=#{value}")).to eq(fo: {fo_opt: value})
+      context 'one value' do
+        %w[0 1 d s].each do |value|
+          it "parses #{value}" do
+            expect(fo.parse("fo=#{value}")).to eq(fo: {fo_opt: value})
+          end
         end
       end
-    end
 
-    it 'parses many values' do
-      expect(fo.parse('fo=0:1:d:s')).to eq(
-        fo: [{fo_opt: '0'}, {fo_opt: '1'}, {fo_opt: 'd'}, {fo_opt: 's'}]
-      )
+      it 'parses many values' do
+        expect(fo.parse('fo=0:1:d:s')).to eq(
+          fo: [{fo_opt: '0'}, {fo_opt: '1'}, {fo_opt: 'd'}, {fo_opt: 's'}]
+        )
+      end
     end
-  end
 
-  describe '#dmarc_rfmt' do
-    subject { described_class.new.dmarc_rfmt }
+    describe 'dmarc_rfmt' do
+      subject { described_class.new.dmarc_rfmt }
 
-    it 'parses afrf format' do
-      expect(subject.parse('rf=afrf')).to eq(rf: 'afrf')
-    end
+      it 'parses afrf format' do
+        expect(subject.parse('rf=afrf')).to eq(rf: 'afrf')
+      end
 
-    it 'parses iodef format' do
-      expect(subject.parse('rf=iodef')).to eq(rf: 'iodef')
-    end
+      it 'parses iodef format' do
+        expect(subject.parse('rf=iodef')).to eq(rf: 'iodef')
+      end
 
-    it 'ignores spacing' do
-      expect(subject.parse 'rf=iodef').to eq(subject.parse 'rf = iodef')
+      it 'ignores spacing' do
+        expect(subject.parse 'rf=iodef').to eq(subject.parse 'rf = iodef')
+      end
     end
-  end
 
-  describe '#dmarc_percent' do
-    subject { described_class.new.dmarc_percent }
+    describe 'dmarc_percent' do
+      subject { described_class.new.dmarc_percent }
 
-    it 'parses a one-digit percent' do
-      expect(subject.parse('pct=1')).to eq(pct: '1')
-    end
+      it 'parses a one-digit percent' do
+        expect(subject.parse('pct=1')).to eq(pct: '1')
+      end
 
-    it 'parses a two-digit percent' do
-      expect(subject.parse('pct=10')).to eq(pct: '10')
-    end
+      it 'parses a two-digit percent' do
+        expect(subject.parse('pct=10')).to eq(pct: '10')
+      end
 
-    it 'parses a three-digit percent' do
-      expect(subject.parse('pct=100')).to eq(pct: '100')
-    end
+      it 'parses a three-digit percent' do
+        expect(subject.parse('pct=100')).to eq(pct: '100')
+      end
 
-    it 'ignores spacing' do
-      expect(subject.parse 'pct = 100').to eq(subject.parse 'pct=100')
+      it 'ignores spacing' do
+        expect(subject.parse 'pct = 100').to eq(subject.parse 'pct=100')
+      end
     end
-  end
 
-  describe '#dmarc_adkim' do
-    subject { described_class.new.dmarc_adkim }
+    describe 'dmarc_adkim' do
+      subject { described_class.new.dmarc_adkim }
 
-    it 'parses a relaxed DKIM policy' do
-      expect(subject.parse('adkim=r')).to eq(adkim: 'r')
-    end
+      it 'parses a relaxed DKIM policy' do
+        expect(subject.parse('adkim=r')).to eq(adkim: 'r')
+      end
 
-    it 'parses a strict DKIM policy' do
-      expect(subject.parse('adkim=s')).to eq(adkim: 's')
-    end
+      it 'parses a strict DKIM policy' do
+        expect(subject.parse('adkim=s')).to eq(adkim: 's')
+      end
 
-    it 'ignores spacing' do
-      expect(subject.parse 'adkim=r').to eq(subject.parse 'adkim = r')
+      it 'ignores spacing' do
+        expect(subject.parse 'adkim=r').to eq(subject.parse 'adkim = r')
+      end
     end
-  end
 
-  describe '#dmarc_aspf' do
-    subject { described_class.new.dmarc_aspf }
+    describe 'dmarc_aspf' do
+      subject { described_class.new.dmarc_aspf }
 
-    it 'parses a relaxed SPF policy' do
-      expect(subject.parse('aspf=r')).to eq(aspf: 'r')
-    end
+      it 'parses a relaxed SPF policy' do
+        expect(subject.parse('aspf=r')).to eq(aspf: 'r')
+      end
 
-    it 'parses a strict SPF policy' do
-      expect(subject.parse('aspf=s')).to eq(aspf: 's')
-    end
+      it 'parses a strict SPF policy' do
+        expect(subject.parse('aspf=s')).to eq(aspf: 's')
+      end
 
-    it 'ignores spacing' do
-      expect(subject.parse 'aspf=s').to eq(subject.parse 'aspf = s')
+      it 'ignores spacing' do
+        expect(subject.parse 'aspf=s').to eq(subject.parse 'aspf = s')
+      end
     end
   end
 
@@ -305,17 +326,29 @@ describe Parser do
       [
         {v: 'DMARC1'},
         {p: 'none'},
+        {sp: 'reject'},
         {pct: '100'},
-        {fo: [{fo_opt: '0'}, {fo_opt: '1'}, {fo_opt: 'd'}, {fo_opt: 's'}]}
+        {adkim: 'r'},
+        {aspf: 'r'},
+        {fo: [{fo_opt: '0'}, {fo_opt: '1'}, {fo_opt: 'd'}, {fo_opt: 's'}]},
+        {rua: {uri: "mailto:d@rua.agari.com"}}
       ]
     end
 
     subject { described_class.new.apply(tree) }
 
+    it "should coerce :v into a Symbol" do
+      expect(subject).to include(v: :DMARC1)
+    end
+
     it "should coerce :p into a Symbol" do
       expect(subject).to include(p: :none)
     end
 
+    it "should coerce :sp into a Symbol" do
+      expect(subject).to include(sp: :reject)
+    end
+
     it "should flatten :fo options" do
       expect(subject).to include(fo: %w[0 1 d s])
     end
@@ -323,34 +356,47 @@ describe Parser do
     it "should coerce :pct into an Integer" do
       expect(subject).to include(pct: 100)
     end
+
+    it "should coerce :adkim into a Symbol" do
+      expect(subject).to include(adkim: :r)
+    end
+
+    it "should coerce :aspf into a Symbol" 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")])
+    end
   end
 
-  describe "#parse" do
+  describe ".parse" do
+    subject { described_class }
+
     let(:record) { "v=DMARC1;p=none;pct=100;fo=0:1:d:s" }
 
     it "should combine all tags into one Hash" do
       expect(subject.parse(record)).to eq(
-        v: 'DMARC1',
+        v: :DMARC1,
         p: :none,
         pct: 100,
         fo: ['0', '1', 'd', 's']
       )
     end
 
-  end
-
-  context "Alexa Top 500", :gauntlet do
-    require 'csv'
+    context "Alexa Top 500", :gauntlet do
+      require 'csv'
 
-    path = File.expand_path('../data/alexa.csv', __FILE__)
-    csv  = CSV.new(open(path), headers: false)
+      path = File.expand_path('../data/alexa.csv', __FILE__)
+      csv  = CSV.new(open(path), headers: false)
 
-    csv.each do |row|
-      rank, domain, dmarc = row
+      csv.each do |row|
+        rank, domain, dmarc = row
 
-      if dmarc
-        it "should parse #{dmarc.inspect}" do
-          expect { subject.parse(dmarc) }.to_not raise_error
+        if dmarc
+          it "should parse #{dmarc.inspect}" do
+            expect { subject.parse(dmarc) }.to_not raise_error
+          end
         end
       end
     end