dmarc 0.1.0 → 0.2.0

data/spec/{lib/dmarc/parser_spec.rb → parser_spec.rb}

@@ -1,22 +1,21 @@
+require 'spec_helper'
 require 'dmarc/parser'
-require 'pp'
 
-describe DMARC::Parser do
+describe Parser do
   describe '#dmarc_uri' do
     subject { described_class.new.dmarc_uri }
 
+    let(:uri) { 'mailto:user@example.org' }
+
     it 'parses mailto URIs' do
-      uri = 'mailto:user@example.org'
       expect(subject.parse(uri)).to eq(uri: uri)
     end
 
     it 'parses mailto URIs with size' do
-      uri = 'mailto:user@example.org'
       expect(subject.parse(uri + '!20')).to eq(uri: uri, size: '20')
     end
 
     it 'parses mailto URIs with size and unit' do
-      uri = 'mailto:user@example.org'
       expect(subject.parse(uri + '!20k')).to eq(uri: uri, size: '20', unit: 'k')
     end
   end
@@ -28,18 +27,30 @@ describe DMARC::Parser do
       record = 'v=DMARC1;p=none'
       expect(subject.parse record).to eq([
         {v: 'DMARC1'},
-        {p: 'none'},
+        {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([
+      expect(subject.parse(record)).to eq([
         {v: 'DMARC1'},
         {p: 'none'},
         {sp: 'reject'},
         {adkim: 'r'},
-        {aspf: '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
 
@@ -48,6 +59,25 @@ describe DMARC::Parser do
       record2 = 'v = DMARC1 ; p = none ; sp = reject'
       expect(subject.parse record1).to eq(subject.parse record2)
     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([
+        {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
 
   describe '#dmarc_version' do
@@ -116,10 +146,22 @@ describe DMARC::Parser do
     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'}},
-        {rua: {uri: 'mailto:user2@example.org'}},
-      ])
+      ).to eq(
+        rua: [
+          {uri: 'mailto:user1@example.org'},
+          {uri: 'mailto:user2@example.org'}
+        ]
+      )
+    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
 
@@ -153,10 +195,40 @@ describe DMARC::Parser do
     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'}},
-        {ruf: {uri: '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
+
+  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})
+        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'}]
+      )
     end
   end
 
@@ -227,5 +299,60 @@ describe DMARC::Parser do
       expect(subject.parse 'aspf=s').to eq(subject.parse 'aspf = s')
     end
   end
-end
 
+  describe Parser::Transform do
+    let(:tree) do
+      [
+        {v: 'DMARC1'},
+        {p: 'none'},
+        {pct: '100'},
+        {fo: [{fo_opt: '0'}, {fo_opt: '1'}, {fo_opt: 'd'}, {fo_opt: 's'}]}
+      ]
+    end
+
+    subject { described_class.new.apply(tree) }
+
+    it "should coerce :p into a Symbol" do
+      expect(subject).to include(p: :none)
+    end
+
+    it "should flatten :fo options" do
+      expect(subject).to include(fo: %w[0 1 d s])
+    end
+
+    it "should coerce :pct into an Integer" do
+      expect(subject).to include(pct: 100)
+    end
+  end
+
+  describe "#parse" do
+    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',
+        p: :none,
+        pct: 100,
+        fo: ['0', '1', 'd', 's']
+      )
+    end
+
+  end
+
+  context "Alexa Top 500", :gauntlet do
+    require 'csv'
+
+    path = File.expand_path('../data/alexa.csv', __FILE__)
+    csv  = CSV.new(open(path), headers: false)
+
+    csv.each do |row|
+      rank, domain, dmarc = row
+
+      if dmarc
+        it "should parse #{dmarc.inspect}" do
+          expect { subject.parse(dmarc) }.to_not raise_error
+        end
+      end
+    end
+  end
+end

data/spec/{lib/dmarc/record_spec.rb → record_spec.rb}

@@ -1,6 +1,7 @@
+require 'spec_helper'
 require 'dmarc/record'
 
-describe DMARC::Record do
+describe Record do
   context 'by default' do
     it 'has a relaxed DKIM alignment' do
       expect(subject.adkim).to eq('r')
@@ -29,11 +30,11 @@ describe DMARC::Record do
 
   describe '#initialize' do
     let(:parse_tree) do
-      [
-        {v: 'DMARC1'},
-        {p: 'none'},
-        {adkim: 'r'},
-      ]
+      {
+        v: 'DMARC1',
+        p: 'none',
+        adkim: 'r'
+      }
     end
 
     it 'assigns the fields to its properties' do
@@ -48,5 +49,24 @@ describe DMARC::Record do
       expect(rec.sp).to eq('none')
     end
   end
-end
 
+  describe '.from_txt' do
+    context 'with a valid record' do
+      it 'parse and returns a record' do
+        rec = described_class.from_txt('v=DMARC1; p=quarantine')
+
+        expect(rec).to be_a Record
+        expect(rec.p).to eq :quarantine
+      end
+    end
+
+    context 'with an invalid record' do
+      it 'raises an InvalidRecord error' do
+        expect { described_class.from_txt('v=DMARC1; foo=bar') }.to raise_error do |error|
+          expect(error).to be_a InvalidRecord
+          expect(error.ascii_tree).to_not be_nil
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rspec'
+require 'dmarc'
+
+include DMARC
+
+RSpec.configure do |specs|
+  specs.filter_run_excluding :gauntlet
+end

data/tasks/alexa.rb

@@ -0,0 +1,43 @@
+##
+# Adapted from gist: https://gist.github.com/zerothabhishek/3015666
+# Orginal author: zerothabhishek
+##
+
+require 'nokogiri'
+require 'open-uri'
+require 'resolv'
+require 'csv'
+
+namespace :alexa do
+  desc 'Scrapes the Alexa Top 500 and updates spec/data/alexa.csv'
+  task :scrape do
+    resolver = Resolv::DNS.new
+
+    CSV.open("spec/data/alexa.csv","w") do |csv|
+      (0..19).each do |i|
+        url = "http://www.alexa.com/topsites/global;#{i} "
+        doc = Nokogiri::HTML(open(url))
+
+        doc.css(".site-listing").each do |li|
+          begin
+            site_name = li.css(".desc-container .desc-paragraph a")[0].content
+            site_rank = li.css(".count")[0].content
+
+            puts "Resolving #{site_name} ..."
+            dmarc = begin
+                      resolver.getresource(
+                        "_dmarc.#{site_name.downcase}",
+                        Resolv::DNS::Resource::IN::TXT
+                      ).strings.join
+                    rescue Resolv::ResolvError
+                    end
+
+            csv << [site_rank, site_name, dmarc]
+          rescue => exception
+            warn exception.message
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dmarc
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Davis Gallinghouse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-25 00:00:00.000000000 Z
+date: 2014-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parslet
@@ -38,48 +38,6 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.8'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.8'
 description: DMARC Record Parser
 email:
 - davis@trailofbits.com
@@ -87,18 +45,27 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .document
 - .gitignore
+- .rspec
+- .travis.yml
+- .yardopts
+- ChangeLog.md
 - Gemfile
-- LICENSE
+- LICENSE.txt
 - README.md
 - Rakefile
 - dmarc.gemspec
 - lib/dmarc.rb
+- lib/dmarc/exceptions.rb
 - lib/dmarc/parser.rb
 - lib/dmarc/record.rb
 - lib/dmarc/version.rb
-- spec/lib/dmarc/parser_spec.rb
-- spec/lib/dmarc/record_spec.rb
+- spec/data/alexa.csv
+- spec/parser_spec.rb
+- spec/record_spec.rb
+- spec/spec_helper.rb
+- tasks/alexa.rb
 homepage: https://github.com/trailofbits/dmarc#readme
 licenses:
 - MIT
@@ -119,11 +86,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: DMARC Record Parser
 test_files:
-- spec/lib/dmarc/parser_spec.rb
-- spec/lib/dmarc/record_spec.rb
+- spec/data/alexa.csv
+- spec/parser_spec.rb
+- spec/record_spec.rb
+- spec/spec_helper.rb
 has_rdoc: