spf-query 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5821a96acdc66745d783eaf3e0bb03653892b421
-  data.tar.gz: 74c7214b71a9d14616290e4126a721b0a026734a
+  metadata.gz: b9a9fddefde5c33a2ad1385bab0d15ca8477ad0a
+  data.tar.gz: ed9f792eb99ef6308b07627645efb7aae4eeb695
 SHA512:
-  metadata.gz: 71780740178980f74a8ea65be8767e4ce35c3a6158f5c27bff47e1f7bf93a39775914348cb57d84f0f4035190f53a220e362ee020c40e1cd5f73190d85503eeb
-  data.tar.gz: 76f120cbca0b71028519ccbb20aeb32eb50e707c8f82ac707d272be5ac3593005bd295cb675c25f28e2c910d5a95bdcd51bdd63a2861e66c633f259a62ca0ede
+  metadata.gz: 62515f4dd785031a84487205a3f7d85608464798e53b8667f09c69cf230590d398ccebd5aaf09e95951b1630c3a048268db28b59bde3e601afe40db385730817
+  data.tar.gz: 4647bd4bc4351b6cb2032a7dac1d6b05d51e93e6cafd308423abb07d9118d5c2655057da7d2068074331e81577ee39d44489f90621fadf9cf26ab21c49ccb6ca

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,12 @@
+### 0.1.5 / 2016-07-10
+
+* Fixed a bug in {SPF::Query.query} for when the TXT record is split into
+  multiple strings. According to [RFC 7208, Section 3.3], multiple strings
+  should be joined together _without_ spaces.
+* Fixed a bug in {SPF::Query::Mechanism#to_s}.
+
+[RFC 7208, Section 3.3]: https://tools.ietf.org/html/rfc7208#section-3.3
+
 ### 0.1.4 / 2015-12-10
 
 * Prioritize TXT records on `_spf.example.com` and `example.com` over a SPF

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
@@ -17,4 +17,4 @@ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/resolv/dns/resource/in/spf.rb

@@ -1,5 +1,8 @@
 require 'resolv'
 
+#
+# Represents a `SPF` type DNS record.
+#
 class Resolv::DNS::Resource::IN::SPF < Resolv::DNS::Resource::IN::TXT
   # resolv.rb doesn't define an SPF resource type.
   TypeValue = 99

data/lib/spf/query/exceptions.rb

@@ -2,9 +2,17 @@ require 'parslet'
 
 module SPF
   module Query
+    #
+    # Exception for when the SPF record cannot be parsed.
+    #
     class InvalidRecord < Parslet::ParseFailed
     end
 
+    #
+    # Exception for when [SenderID] is found in-place of SPF.
+    #
+    # [SenderID]: http://www.openspf.org/SPF_vs_Sender_ID
+    #
     class SenderIDFound < InvalidRecord
     end
   end

data/lib/spf/query/ip.rb

@@ -1,16 +1,39 @@
 module SPF
   module Query
+    #
+    # Represents an IP address in an SPF record.
+    #
     class IP
 
+      # The address.
+      #
+      # @return [String]
       attr_reader :address
 
+      # CIDR length.
+      # 
+      # @return [Integer, nil]
       attr_reader :cidr_length
 
+      #
+      # Initializes the IP.
+      #
+      # @param [String] address
+      #   The IP address.
+      #
+      # @param [Integer, nil] cidr_length
+      #   Optional CIDR length.
+      #
       def initialize(address,cidr_length=nil)
         @address     = address
         @cidr_length = cidr_length
       end
 
+      #
+      # Converts the IP address to a String.
+      #
+      # @return [String]
+      #
       def to_s
         if @cidr_length then "#{@address}/#{@cidr_length}"
         else                 "#{@address}"

data/lib/spf/query/macro.rb

@@ -1,13 +1,43 @@
 module SPF
   module Query
+    #
+    # Represents an SPF string macro.
+    #
     class Macro
 
+      # The macro letter.
+      #
+      # @return [Symbol]
       attr_reader :letter
 
+      # Number of times the macro must be repeated.
+      #
+      # @return [Integer, nil]
       attr_reader :digits
 
+      # Macro delimiter character.
+      #
+      # @return [Array<String>]
       attr_reader :delimiters
 
+      #
+      # Initializes the macro.
+      #
+      # @param [Symbol] letter
+      #   The macro letter.
+      #
+      # @param [Hash] options
+      #   Additional options.
+      #
+      # @option options [Integer] :digits
+      #   Number of times to repeat the macro.
+      #
+      # @option options [Boolean] :reverse
+      #   Whether to reverse the value.
+      #
+      # @option options [Array<String>, String] :delimiters
+      #   Delimiter characters.
+      #
       def initialize(letter,options={})
         @letter     = letter
         @digits     = options[:digits]
@@ -15,10 +45,20 @@ module SPF
         @delimiters = Array(options[:delimiters])
       end
 
+      #
+      # Specifies if the macro should be reversed.
+      #
+      # @return [Boolean]
+      #
       def reverse?
         @reverse
       end
 
+      #
+      # Converts the macro a String.
+      #
+      # @return [String]
+      #
       def to_s
         "%{#{@letter}#{@digits}#{@delimiters.join}}"
       end

data/lib/spf/query/macro_string.rb

@@ -1,29 +1,65 @@
 module SPF
   module Query
+    #
+    # Represents a string containing SPF macros.
+    #
     class MacroString
 
       include Enumerable
 
+      #
+      # Initializes the macro string.
+      #
+      # @param [Array<String, Macro>] elements
+      #   String literals and String macros.
+      #
       def initialize(elements)
         @elements = elements
       end
 
+      #
+      # Enumerates over the macro string literals and macros.
+      #
+      # @yield [element]
+      #
+      # @yieldparam [String, Macro] element
+      #
+      # @return [Enumerator]
+      #   If no block is given, an Enumerator will be returned.
+      #
       def each(&block)
         @elements.each(&block)
       end
 
+      #
+      # Accesses the String literal or macro at the given index or range.
+      #
+      # @param [Integer, (Integer, Integer), Range] arguments
+      #   The index or range to access.
+      #
+      # @return [Array<String, Macro>, String, Macro]
+      #   The String literal(s) or macro(s) at the given index or range.
+      #
       def [](*arguments)
         @elements[*arguments]
       end
 
+      #
+      # Converts the macro string to an Array.
+      #
+      # @return [Array<String, Macro>]
+      #
       def to_a
         @elements
       end
 
-      def to_ary
-        @elements
-      end
+      alias to_ary to_a
 
+      #
+      # Converts the macro string to a String.
+      #
+      # @return [String]
+      #
       def to_s
         @elements.join
       end

data/lib/spf/query/mechanism.rb

@@ -1,18 +1,42 @@
 module SPF
   module Query
+    #
+    # Represents an SPF mechanism.
+    #
     class Mechanism
 
+      # Maps qualifier symbols to Symbols
       QUALIFIERS = {
         '+' => :pass,
         '-' => :fail,
         '~' => :soft_fail,
-        '?' => :neuatral
+        '?' => :neutral
       }
 
+      # The mechanism name.
+      #
+      # @return [Symbol]
       attr_reader :name
       
+      # The mechanism value.
+      #
+      # @return [String, MacroString, IP, nil]
       attr_reader :value
 
+      #
+      # Initializes the mechanism.
+      #
+      # @param [Symbol] name
+      #
+      # @param [Hash] options
+      #   Additional options.
+      #
+      # @option options [String, MacroString, IP] :value
+      #   Optional value.
+      #
+      # @option options [Symbol] :qualifier
+      #   Mechanism qualifier.
+      #
       def initialize(name,options={})
         @name = name
 
@@ -20,26 +44,57 @@ module SPF
         @qualifier = options[:qualifier]
       end
 
+      #
+      # The mechanism qualifier.
+      #
+      # @return [:pass, :fail, :soft_fail, :neutral]
+      #   The qualifier. Defaults to `:pass`.
+      #
       def qualifier
         @qualifier || :pass
       end
 
+      #
+      # Determines whether the qualifier is a "pass".
+      #
+      # @return [Boolean]
+      #
       def pass?
         @qualifier == :pass || @qualifier.nil?
       end
 
+      #
+      # Determines if the qualifier is a "fail".
+      #
+      # @return [Boolean]
+      #
       def fail?
         @qualifier == :fail
       end
 
+      #
+      # Determines whether the qualifier is a "soft_fail".
+      #
+      # @return [Boolean]
+      #
       def soft_fail?
         @qualifier == :soft_fail
       end
 
+      #
+      # Determines whether the qualifier is a "neutral".
+      #
+      # @return [Boolean]
+      #
       def neutral?
         @qualifier == :neutral
       end
 
+      #
+      # Converts the mechanism to a String.
+      #
+      # @return [String]
+      #
       def to_s
         str = "#{QUALIFIERS.invert[@qualifier]}#{@name}"
         str << ":#{@value}" if value

data/lib/spf/query/modifier.rb

@@ -1,15 +1,38 @@
 module SPF
   module Query
+    #
+    # Represents SPF record modifiers.
+    #
     class Modifier
 
+      # Modifier name.
+      #
+      # @return [Symbol]
       attr_reader :name
 
+      # Modifier value.
+      #
+      # @return [String, MacroString, IP, nil]
       attr_reader :value
 
+      #
+      # Initializes the modifier.
+      #
+      # @param [Symbol] name
+      #   Modifier name.
+      #
+      # @param [String, nil] value
+      #   Modifier value.
+      #
       def initialize(name,value=nil)
         @name, @value = name, value
       end
 
+      #
+      # Converts the modifier to a String.
+      #
+      # @return [String]
+      #
       def to_s
         if @value then "#{@name}=#{@value}"
         else           "#{@name}"
@@ -18,6 +41,9 @@ module SPF
 
     end
 
+    #
+    # Represents non-standard modifier names.
+    #
     class UnknownModifier < Modifier
     end
   end

data/lib/spf/query/query.rb

@@ -24,7 +24,7 @@ module SPF
           records = resolver.getresources(host, Resolv::DNS::Resource::IN::TXT)
 
           records.each do |record|
-            txt = record.strings.join(' ')
+            txt = record.strings.join
 
             if txt.include?('v=spf1')
               return txt

data/lib/spf/query/record.rb

@@ -6,6 +6,9 @@ require 'resolv'
 
 module SPF
   module Query
+    #
+    # Represents a parsed SPF record.
+    #
     class Record
 
       include Enumerable

data/lib/spf/query/version.rb

@@ -1,5 +1,6 @@
 module SPF
   module Query
-    VERSION = '0.1.4'
+    # spf-query version
+    VERSION = '0.1.5'
   end
 end

data/spec/query_spec.rb

@@ -19,6 +19,22 @@ describe SPF::Query do
       end
     end
 
+    context "when the domain.com has a TXT record" do
+      let(:domain) { 'yahoo.com' }
+
+      it "should return the TXT record containing the SPF record" do
+        expect(subject.query(domain)).to be == %{v=spf1 redirect=_spf.mail.yahoo.com}
+      end
+
+      context "and when the record is split into multiple strings" do
+        let(:domain) { 'fb.com' }
+
+        it "should join the strings, without spaces" do
+          expect(subject.query(domain)).to be == %{v=spf1 ip4:69.171.232.0/24 ip4:199.201.64.23 ip4:192.201.64.23 ip4:69.63.179.25 ip4:69.63.178.128/25 ip4:69.63.184.0/25 ip4:66.220.144.128/25 ip4:66.220.155.128/25 include:spf-00082601.pphosted.com mx -all}
+        end
+      end
+    end
+
     context "when the domain has a SPF type record" do
       let(:domain) { 'getlua.com' }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spf-query
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - nicktitle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-11 00:00:00.000000000 Z
+date: 2016-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parslet