dmarc 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9a12630bf22487064d3d35386f55e7af00f6b542
-  data.tar.gz: 35f68803f6820445c7e38d9e37078737075807e4
+  metadata.gz: 97e07c7f904e46b02faa4ce8358e3420b4ae4869
+  data.tar.gz: 41f067c094fcf208cf93d7f06c2c3fdd139d2c18
 SHA512:
-  metadata.gz: 3214787e24b80ce2eb162473d43e9e77f152d8e1ff6cfcf1fbbb2fadfe8d565b27c4e0b97c3c17180783e10ff6c62a18714c8be3925a97309a886f79a7d2eee4
-  data.tar.gz: f7ed4b603e8541e97c7d29d733f45d5b7f93ee1d737f9cc70916c1459098a570a01e1cdece1b2b182dd683c8b2322d279ed4db2c3fbe5187ec8be9eb2389d7fe
+  metadata.gz: 3083a287ebfbf9aa267721fb7383f17404ce392c3481aa76e4873ac135bf2cad67a7148bfc787100447b6351b6e9459dc3a2d1c62f628b94543310831d42aabd
+  data.tar.gz: ba197f0a39720736446c499cecb1b93e2f8b41826f3113a2014e4655503da3837a9c2501d42ea0218c963dd5337dd832f82a84fdc233855784f4542827f66072

data/.travis.yml

@@ -1,9 +1,8 @@
 language: ruby
 rvm:
-- 1.9.3
-- 2.0
-- 2.1
-- 2.2
+- 2.1.8
+- 2.2.4
+- 2.3.0
 - jruby
 - rbx-2
 matrix:

data/ChangeLog.md

@@ -1,3 +1,17 @@
+### 0.4.0 / 2016-07-10
+
+* Added {DMARC::Record#to_h}.
+* Added {DMARC::Record#adkim?}.
+* Added {DMARC::Record#aspf?}.
+* Added {DMARC::Record#fo?}.
+* Added {DMARC::Record#p?}.
+* Added {DMARC::Record#pct?}.
+* Added {DMARC::Record#rf?}.
+* Added {DMARC::Record#ri?}.
+* Added {DMARC::Record#rua?}.
+* Added {DMARC::Record#ruf?}.
+* Added {DMARC::Record#sp?}.
+
 ### 0.3.0 / 2015-07-01
 
 * Added {DMARC::Record.query}.

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014 Trail of Bits
+Copyright (c) 2014-2016 Trail of Bits
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

data/lib/dmarc/record.rb

@@ -61,67 +61,199 @@ module DMARC
     # @option attributes [:DMARC1] :v
     #
     def initialize(attributes={})
-      @adkim, @aspf, @fo, @p, @pct, @rf, @ri, @rua, @ruf, @sp, @v = attributes.values_at(:adkim, :aspf, :fo, :p, :pct, :rf, :ri, :rua, :ruf, :sp, :v)
+      @v     = attributes.fetch(:v)
+      @adkim = attributes[:adkim]
+      @aspf  = attributes[:aspf]
+      @fo    = attributes[:fo]
+      @p     = attributes[:p]
+      @pct   = attributes[:pct]
+      @rf    = attributes[:rf]
+      @ri    = attributes[:ri]
+      @rua   = attributes[:rua]
+      @ruf   = attributes[:ruf]
+      @sp    = attributes[:sp]
     end
 
+    #
+    # Determines if the `sp=` field was specified?
+    #
+    # @return [Boolean]
+    #
+    # @since 0.4.0
+    #
+    def sp?
+      !@sp.nil?
+    end
+
+    #
+    # The `sp=` field.
+    #
+    # @return [:none, :quarantine, :reject]
+    #   The value of the `sp=` field, or that of {#p} if the field was omitted.
+    #
     def sp
       @sp || @p
     end
 
+    #
+    # Determines whether the `adkim=` field was specified.
+    #
+    # @return [Boolean]
+    #
+    # @since 0.4.0
+    #
+    def adkim?
+      !@adkim.nil?
+    end
+
     #
     # `adkim=` field.
     #
     # @return [:r, :s]
+    #   The value of the `adkim=` field, or `:r` if the field was omitted.
     #
     def adkim
       @adkim || :r
     end
 
+    #
+    # Determines whether the `aspf=` field was specified.
+    #
+    # @return [Boolean]
+    #
+    # @since 0.4.0
+    #
+    def aspf?
+      !@aspf.nil?
+    end
+
     #
     # `aspf` field.
     #
     # @return [:r, :s]
+    #   The value of the `aspf=` field, or `:r` if the field was omitted.
     #
     def aspf
       @aspf || :r
     end
 
+    #
+    # Determines whether the `fo=` field was specified.
+    #
+    # @return [Boolean]
+    #
+    # @since 0.4.0
+    #
+    def fo?
+      !@fo.nil?
+    end
+
     #
     # `fo` field.
     #
     # @return [Array<'0', '1', 'd', 's'>]
+    #   The value of the `fo=` field, or `["0"]` if the field was omitted.
     #
     def fo
       @fo || %w[0]
     end
 
+    #
+    # Determines if the `p=` field was specified?
+    #
+    # @return [Boolean]
+    #
+    # @since 0.4.0
+    #
+    def p?
+      !@p.nil?
+    end
+
+    #
+    # Determines whether the `pct=` field was specified.
+    #
+    # @return [Boolean]
+    #
+    # @since 0.4.0
+    #
+    def pct?
+      !@pct.nil?
+    end
+
     #
     # `pct` field.
     #
     # @return [Integer]
+    #   The value of the `pct=` field, or `100` if the field was omitted.
     #
     def pct
       @pct || 100
     end
 
+    #
+    # Determines whether the `rf=` field was specified.
+    #
+    # @return [Boolean]
+    #
+    # @since 0.4.0
+    #
+    def rf?
+      !@rf.nil?
+    end
+
     #
     # `rf` field.
     # 
     # @return [:afrf, :iodef]
+    #   The value of the `rf=` field, or `:afrf` if the field was omitted.
     #
     def rf
       @rf || :afrf
     end
 
+    #
+    # Determines whether the `ri=` field was specified.
+    #
+    # @return [Boolean]
+    #
+    # @since 0.4.0
+    #
+    def ri?
+      !@ri.nil?
+    end
+
     #
     # `ri` field.
     #
     # @return [Integer]
+    #   The value of the `ri=` field, or `86400` if the field was omitted.
     #
     def ri
       @ri || 86400
     end
 
+    #
+    # Determines if the `rua=` field was specified?
+    #
+    # @return [Boolean]
+    #
+    # @since 0.4.0
+    #
+    def rua?
+      !@rua.nil?
+    end
+
+    #
+    # Determines if the `ruf=` field was specified?
+    #
+    # @return [Boolean]
+    #
+    # @since 0.4.0
+    #
+    def ruf?
+      !@ruf.nil?
+    end
+
     #
     # Parses a DMARC record.
     #
@@ -177,6 +309,31 @@ module DMARC
       end
     end
 
+    #
+    # Converts the record to a Hash.
+    #
+    # @return [Hash{Symbol => Object}]
+    #
+    # @since 0.4.0
+    #
+    def to_h
+      hash = {}
+
+      hash[:v]     = @v     if @v
+      hash[:p]     = @p     if @p
+      hash[:sp]    = @sp    if @sp
+      hash[:rua]   = @rua   if @rua
+      hash[:ruf]   = @ruf   if @ruf
+      hash[:adkim] = @adkim if @adkim
+      hash[:aspf]  = @aspf  if @aspf
+      hash[:ri]    = @ri    if @ri
+      hash[:fo]    = @fo    if @fo
+      hash[:rf]    = @rf    if @rf
+      hash[:pct]   = @pct   if @pct
+
+      return hash
+    end
+
     #
     # Converts the record back to a DMARC String.
     #
@@ -185,17 +342,17 @@ module DMARC
     def to_s
       tags = []
 
-      tags << "v=#{@v}" if @v
-      tags << "p=#{@p}" if @p
-      tags << "sp=#{@sp}" if @sp
+      tags << "v=#{@v}"               if @v
+      tags << "p=#{@p}"               if @p
+      tags << "sp=#{@sp}"             if @sp
       tags << "rua=#{@rua.join(',')}" if @rua
       tags << "ruf=#{@ruf.join(',')}" if @ruf
-      tags << "adkim=#{@adkim}" if @adkim
-      tags << "aspf=#{@aspf}" if @aspf
-      tags << "ri=#{@ri}" if @ri
-      tags << "fo=#{@fo.join(':')}" if @fo
-      tags << "rf=#{@rf}" if @rf
-      tags << "pct=#{@pct}" if @pct
+      tags << "adkim=#{@adkim}"       if @adkim
+      tags << "aspf=#{@aspf}"         if @aspf
+      tags << "ri=#{@ri}"             if @ri
+      tags << "fo=#{@fo.join(':')}"   if @fo
+      tags << "rf=#{@rf}"             if @rf
+      tags << "pct=#{@pct}"           if @pct
 
       return tags.join('; ')
     end

data/lib/dmarc/version.rb

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

data/spec/dmarc_spec.rb

@@ -11,7 +11,7 @@ describe DMARC do
       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'
+        expect(record).to be == 'v=DMARC1; p=reject; rua=mailto:mailauth-reports@google.com'
       end
     end
 

data/spec/record_spec.rb

@@ -25,6 +25,8 @@ describe Record do
   end
 
   context 'with default values' do
+    subject { described_class.new(v: :DMARC1) }
+
     describe "#adkim" do
       it "should return :r" do
         expect(subject.adkim).to be == :r
@@ -104,6 +106,72 @@ describe Record do
     end
   end
 
+  shared_examples "question mark method" do |field,value|
+    describe "#{field}?" do
+      context "when #{field} is set" do
+        subject do
+          described_class.new(v: :DMARC1, field => value)
+        end
+
+        it { expect(subject.send(:"#{field}?")).to be(true) }
+      end
+
+      context "when #{field} is omitted" do
+        subject { described_class.new(v: :DMARC1) }
+
+        it { expect(subject.send(:"#{field}?")).to be(false) }
+      end
+    end
+  end
+
+  include_examples "question mark method", :adkim, :r
+  include_examples "question mark method", :aspf, :r
+  include_examples "question mark method", :fo, %w[0 1 d]
+  include_examples "question mark method", :p, :reject
+  include_examples "question mark method", :pct, 100
+  include_examples "question mark method", :rf, :afrf
+  include_examples "question mark method", :ri, 86400
+  include_examples "question mark method", :rua, [URI("mailto:bob@example.com")]
+  include_examples "question mark method", :ruf, [URI("mailto:bob@example.com")]
+  include_examples "question mark method", :sp, :reject
+
+  describe "#sp?" do
+    context "when sp is set" do
+    end
+  end
+
+  describe "#to_h" do
+    let(:v) { :DMARC1 }
+    let(:p) { :reject }
+    let(:rua) { [URI.parse('mailto:d@rua.agari.com')] }
+    let(:ruf) { [URI.parse('mailto:d@rua.agari.com')] }
+    let(:fo)  { %w[0 1 d] }
+
+    subject do
+      described_class.new(
+        v: v,
+        p: p,
+        rua: rua,
+        ruf: ruf,
+        fo: fo
+      )
+    end
+
+    it "should return a Hash" do
+      expect(subject.to_h).to be_kind_of(Hash)
+    end
+
+    it "should only include fields that have values" do
+      expect(subject.to_h).to be == {
+        v: v,
+        p: p,
+        rua: rua,
+        ruf: ruf,
+        fo: fo
+      }
+    end
+  end
+
   describe "#to_s" do
     let(:v) { :DMARC1 }
     let(:p) { :reject }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dmarc
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Davis Gallinghouse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-01 00:00:00.000000000 Z
+date: 2016-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parslet
@@ -88,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.7
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: DMARC Record Parser