coppertone 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3bcbc913e28d44152b2f68d954533ec5ece2d454
-  data.tar.gz: f2d0f7ab141c086ceb8476e7e7c091185d3fd67a
+  metadata.gz: 70afc7cde39b4b1374dd4b0a580b9908a15b8745
+  data.tar.gz: ef5687a65195e0c2291f68bad0671b5448b35af6
 SHA512:
-  metadata.gz: 128de64f9739785af238106d2ed7b8297a3bc98a41e58193833f8c4ec07dcfa402d847de56a4fccc0d4347a437fbbcd1f00f2d276ae93a06fde290dbf4e9746a
-  data.tar.gz: 5e8e211d963dc5f1135a8e870e3b176f9349a220c1d0eac4822c5c0884ed8f91353728b71d8169e17a44352ec7bfb052a11cc8a18b6033402cd247ac42283954
+  metadata.gz: f441c6616fe2346f55fa5251c74a15c5f77701684d612441a918572da57675a89b1cb956a4c7aee006e59f496dfd33b4378a133005eb703a66dbee9f7dde0ce4
+  data.tar.gz: c9b568748213933e23c29ca8028cf96b8b179357cd02c0c7915dd05bba7adf033a5005be97f2677de9f70e6fb8afa17192765b59bb4251de1fd9410662c0b4d1

data/.travis.yml

@@ -4,4 +4,5 @@ env:
 rvm:
   - 2.0.0
   - 2.1.2
+  - jruby-19mode
 

data/LICENSE

@@ -186,7 +186,7 @@ Apache License
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright {yyyy} {name of copyright owner}
+   Copyright 2014 Peter M. Goldstein
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

data/Rakefile

@@ -48,7 +48,7 @@ def write_zonedata(f, zonedata, indent = 1)
   puts_prefixed_string(f, zonedata, indent + 1)
   puts_prefixed_string(f, 'end', indent)
   empty_line(f)
-  dns_line = 'let(:dns_client) { Coppertone::DNS::MockClient.new(zonefile) }'
+  dns_line = 'let(:dns_client) { DNSAdapter::MockClient.new(zonefile) }'
   puts_prefixed_string(f, dns_line, indent)
   puts_prefixed_string(f, 'let(:options) { { dns_client: dns_client } }',
                        indent)
@@ -85,7 +85,7 @@ def write_result(f, host, mailfrom, helo, indent)
 end
 
 def write_expects(f, results, explanation, indent)
-  results_array = "%i(#{results.join(' ')})"
+  results_array = "[#{results.map { |r| ':' + r } .join(',')}]"
   code_expect = "expect(#{results_array}).to include(result.code)"
   puts_prefixed_string(f, code_expect, indent)
   return unless explanation

data/coppertone.gemspec

@@ -17,6 +17,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
   spec.require_paths = ['lib']
 
+  spec.add_runtime_dependency 'dns_adapter'
   spec.add_runtime_dependency 'i18n'
   spec.add_runtime_dependency 'addressable'
   spec.add_runtime_dependency 'activesupport', '>= 3.0'

data/lib/coppertone/directive.rb

@@ -12,13 +12,20 @@ module Coppertone
     end
 
     def evaluate(context, options)
-      code =
-        if mechanism.match?(context, options)
-          qualifier.result_code
-        else
-          Result::NONE
-        end
-      Coppertone::Result.from_directive(self, code)
+      if mechanism.match?(context, options)
+        Coppertone::Result.from_directive(self)
+      else
+        Result.none
+      end
+    end
+
+    def all?
+      mechanism.is_a?(Coppertone::Mechanism::All)
+    end
+
+    def to_s
+      mechanism_s = mechanism.to_s
+      qualifier.default? ? mechanism_s : "#{qualifier}#{mechanism_s}"
     end
 
     DIRECTIVE_REGEXP = /\A([\+\-\~\?]?)([a-zA-Z0-9]*)((:?)\S*)\z/

data/lib/coppertone/error.rb

@@ -2,26 +2,45 @@ module Coppertone
   class Error < ::StandardError
   end
 
+  # Error classes mapping to the SPF result codes
   class TemperrorError < Coppertone::Error; end
   class PermerrorError < Coppertone::Error; end
 
-  class InvalidSenderError < Coppertone::Error; end
-  class MissingNameError < Coppertone::PermerrorError; end
-  class MissingQualifierError < Coppertone::PermerrorError; end
-
+  # Errors occurring when the string representation of a MacroString
+  # or DomainSpec does not obey the syntax requirements.
   class MacroStringParsingError < Coppertone::PermerrorError; end
   class DomainSpecParsingError < MacroStringParsingError; end
 
+  # Occurs when an SPF record cannot be parsed.
   class RecordParsingError < Coppertone::PermerrorError; end
+
+  # Occurs when an individual mechanism cannot be parsed, usually
+  # because the arguments passed to the mechanism are not syntactically
+  # valid.
   class InvalidMechanismError < Coppertone::RecordParsingError; end
+
+  # Occurs when an individual modifier cannot be parsed, usually
+  # because the arguments passed to the modifier are not syntactically
+  # valid.
   class InvalidModifierError < Coppertone::RecordParsingError; end
 
-  class MissingSpfRecordError < Coppertone::Error; end
+  # Occurs when an SPF record cannot be parsed because of a duplicate
+  # modifier.
+  class DuplicateModifierError < Coppertone::RecordParsingError; end
+
+  # Occurs when more than one potential SPF record is found for a
+  # domain.
   class AmbiguousSpfRecordError < Coppertone::PermerrorError; end
 
+  # Occurs when the SPF record referenced by an include mechanism
+  # yields a 'none' result.  This results in a permerror.
   class NoneIncludeResultError < Coppertone::PermerrorError; end
+
+  # Occurs when an SPF record cannot be found for the domain
+  # referenced in a redirect macro.
   class InvalidRedirectError < Coppertone::PermerrorError; end
 
+  # Errors generated when certain spec-defined limits are exceeded.
   class LimitExceededError < Coppertone::PermerrorError; end
   class TermLimitExceededError < PermerrorError; end
   class VoidLimitExceededError < PermerrorError; end

data/lib/coppertone/ip_address_wrapper.rb

@@ -7,7 +7,7 @@ module Coppertone
   # of IPs in mechanism evaluation and macro string evaluation.
   #
   # Note: This class should only be used with a single IP address, and
-  # will fail if passed an address with a prefix
+  # will fail if passed an address with a non-trivial network prefix
   class IPAddressWrapper
     attr_reader :string_representation, :ip
     def initialize(s)
@@ -16,12 +16,19 @@ module Coppertone
       @string_representation = s
     end
 
+    # Hack for JRuby - remove when JRuby moves to 2.0.x
+    if RUBY_VERSION < '2.0'
+      IP_PARSE_ERROR = ArgumentError
+    else
+      IP_PARSE_ERROR = IPAddr::InvalidAddressError
+    end
+
     def self.parse(s)
       return nil unless s
       return nil if s.index('/')
       ip_addr = IPAddr.new(s)
       normalize_ip(ip_addr)
-    rescue IPAddr::InvalidAddressError
+    rescue IP_PARSE_ERROR
       nil
     end
 
@@ -48,10 +55,6 @@ module Coppertone
       original_ipv4? ? 'in-addr' : 'ip6'
     end
 
-    def p
-      fail NotImplementedError
-    end
-
     def ip_v4
       original_ipv4? ? @ip : nil
     end

data/lib/coppertone/macro_context.rb

@@ -5,13 +5,13 @@ require 'uri'
 
 module Coppertone
   # A context used to evaluate MacroStrings.  Responds to all of the
-  # macro letter directives.
+  # macro letter directives except 'p'.
   class MacroContext
     attr_reader :domain, :ip_address_wrapper, :sender_identity, :helo_domain
 
     delegate :s, :l, :o, to: :sender_identity
     alias_method :d, :domain
-    delegate :i, :p, :v, :c, to: :ip_address_wrapper
+    delegate :i, :v, :c, to: :ip_address_wrapper
     delegate :ip_v4, :ip_v6, :original_ipv4?, :original_ipv6?,
              to: :ip_address_wrapper
     alias_method :h, :helo_domain
@@ -28,25 +28,19 @@ module Coppertone
 
     UNKNOWN_HOSTNAME = 'unknown'
     def r
-      if Coppertone::Utils::DomainUtils.valid?(raw_hostname)
-        raw_hostname
-      else
-        UNKNOWN_HOSTNAME
-      end
+      valid = Coppertone::Utils::DomainUtils.valid?(raw_hostname)
+      valid ? raw_hostname : UNKNOWN_HOSTNAME
     end
 
     def t
       Time.now.to_i
     end
 
-    %w(s l o d i p v h c r t).each do |m|
+    RESERVED_REGEXP = Regexp.new("[^#{URI::PATTERN::UNRESERVED}]")
+    %w(s l o d i v h c r t).each do |m|
       define_method(m.upcase) do
         unencoded = send(m)
-        if unencoded
-          ::URI.escape(unencoded, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
-        else
-          nil
-        end
+        unencoded ? ::URI.escape(unencoded, RESERVED_REGEXP) : nil
       end
     end
 

data/lib/coppertone/macro_string/macro_expand.rb

@@ -39,9 +39,10 @@ module Coppertone
       end
 
       def expand_ptr(context, request)
+        context.send(@macro_letter) if context.respond_to?(@macro_letter)
         ptr =
           Coppertone::Utils::ValidatedDomainFinder
-            .new(context, request).find(context.d)
+            .new(context, request, false).find(context.d)
         return 'unknown' unless ptr
         @macro_letter == 'P' ? ::Addressable::URI.encode_component(ptr) : ptr
       end
@@ -58,7 +59,7 @@ module Coppertone
       end
 
       def to_s
-        @body
+        "%{#{@body}}"
       end
 
       def ==(other)

data/lib/coppertone/macro_string.rb

@@ -11,16 +11,23 @@ module Coppertone
     attr_reader :macro_text
     def initialize(macro_text)
       @macro_text = macro_text
-      parse_macros
+      macros
     end
 
-    def parse_macros
-      # Build an array of expandable macros
-      @macros = MacroParser.new(macro_text).macros
+    def macros
+      @macros ||= MacroParser.new(macro_text).macros
     end
 
     def expand(context, request = nil)
-      @macros.map { |m| m.expand(context, request) }.join('')
+      macros.map { |m| m.expand(context, request) }.join('')
+    end
+
+    def to_s
+      macros.map(&:to_s).join('')
+    end
+
+    def context_dependent?
+      macros.any? { |m| m.is_a?(Coppertone::MacroString::MacroExpand) }
     end
 
     def ==(other)

data/lib/coppertone/mechanism/a.rb

@@ -10,7 +10,11 @@ module Coppertone
           .new(macro_context, request_context)
           .check(target_name, ip_v4_cidr_length, ip_v6_cidr_length)
       end
+
+      def self.label
+        'a'
+      end
     end
-    register('a', Coppertone::Mechanism::A)
+    register(Coppertone::Mechanism::A)
   end
 end

data/lib/coppertone/mechanism/all.rb

@@ -3,9 +3,6 @@ module Coppertone
     # Implements the All mechanism.  To reduce unnecessary object creation, this
     # class is a singleton since all All mechanisms behave identically.
     class All < Mechanism
-      SINGLETON = new
-      private_class_method :new
-
       def self.create(attributes)
         fail InvalidMechanismError unless attributes.blank?
         SINGLETON
@@ -15,10 +12,20 @@ module Coppertone
         SINGLETON
       end
 
+      def self.label
+        'all'
+      end
+
+      def initialize
+        super('')
+      end
+      SINGLETON = new
+      private_class_method :new
+
       def match?(_macro_context, _request_context)
         true
       end
     end
-    register('all', Coppertone::Mechanism::All)
+    register(Coppertone::Mechanism::All)
   end
 end

data/lib/coppertone/mechanism/cidr_parser.rb

@@ -7,7 +7,7 @@ module Coppertone
         if length_as_i < 0 || length_as_i > max_val
           fail Coppertone::InvalidMechanismError
         end
-        length_as_i.to_s
+        length_as_i
       end
     end
   end

data/lib/coppertone/mechanism/domain_spec_mechanism.rb

@@ -13,6 +13,15 @@ module Coppertone
         return nil if raw_domain_spec.blank?
         raw_domain_spec[1..-1]
       end
+
+      def self.dns_lookup_term?
+        true
+      end
+
+      def context_dependent?
+        return true unless domain_spec
+        domain_spec.context_dependent?
+      end
     end
   end
 end

data/lib/coppertone/mechanism/domain_spec_optional.rb

@@ -8,6 +8,7 @@ module Coppertone
       end
 
       def initialize(attributes)
+        super(attributes)
         return if attributes.blank?
         raw_domain_spec = trim_domain_spec(attributes)
         @domain_spec = Coppertone::DomainSpec.new(raw_domain_spec)

data/lib/coppertone/mechanism/domain_spec_required.rb

@@ -6,6 +6,7 @@ module Coppertone
       end
 
       def initialize(attributes)
+        super(attributes)
         raw_domain_spec = trim_domain_spec(attributes)
         fail InvalidMechanismError if raw_domain_spec.blank?
         @domain_spec = Coppertone::DomainSpec.new(raw_domain_spec)

data/lib/coppertone/mechanism/domain_spec_with_dual_cidr.rb

@@ -10,6 +10,7 @@ module Coppertone
       end
 
       def initialize(attributes)
+        super(attributes)
         return if attributes.blank?
         parse_argument(attributes)
       rescue Coppertone::MacroStringParsingError

data/lib/coppertone/mechanism/exists.rb

@@ -8,7 +8,11 @@ module Coppertone
         records = request_context.dns_client.fetch_a_records(target_name)
         records.any?
       end
+
+      def self.label
+        'exists'
+      end
     end
-    register('exists', Coppertone::Mechanism::Exists)
+    register(Coppertone::Mechanism::Exists)
   end
 end

data/lib/coppertone/mechanism/include.rb

@@ -7,12 +7,24 @@ module Coppertone
     # Implements the include mechanism.
     class Include < DomainSpecRequired
       def match_target_name(macro_context, request_context, target_name)
-        context_for_include = macro_context.with_domain(target_name)
-        record =
-          RecordFinder.new(request_context.dns_client, target_name).record
-        IncludeMatcher.new(record).match?(context_for_include, request_context)
+        record = included_record(request_context, target_name)
+        IncludeMatcher.new(record)
+          .match?(context_for_include(macro_context, target_name),
+                  request_context)
+      end
+
+      def context_for_include(macro_context, target_name)
+        macro_context.with_domain(target_name)
+      end
+
+      def included_record(request_context, target_name)
+        RecordFinder.new(request_context.dns_client, target_name).record
+      end
+
+      def self.label
+        'include'
       end
     end
-    register('include', Coppertone::Mechanism::Include)
+    register(Coppertone::Mechanism::Include)
   end
 end

data/lib/coppertone/mechanism/ip4.rb

@@ -7,7 +7,11 @@ module Coppertone
       def ip_for_match(macro_context)
         macro_context.ip_v4
       end
+
+      def self.label
+        'ip4'
+      end
     end
-    register('ip4', Coppertone::Mechanism::IP4)
+    register(Coppertone::Mechanism::IP4)
   end
 end

data/lib/coppertone/mechanism/ip6.rb

@@ -7,7 +7,11 @@ module Coppertone
       def ip_for_match(macro_context)
         macro_context.ip_v6
       end
+
+      def self.label
+        'ip6'
+      end
     end
-    register('ip6', Coppertone::Mechanism::IP6)
+    register(Coppertone::Mechanism::IP6)
   end
 end

data/lib/coppertone/mechanism/ip_mechanism.rb

@@ -8,6 +8,7 @@ module Coppertone
       end
 
       def initialize(attributes)
+        super(attributes)
         unless attributes.blank?
           attributes = attributes[1..-1] if attributes[0] == ':'
           @ip_network = parse_ip_network(attributes)
@@ -21,6 +22,13 @@ module Coppertone
         fail Coppertone::InvalidMechanismError
       end
 
+      # Hack for JRuby - remove when JRuby moves to 2.0.x
+      if RUBY_VERSION < '2.0'
+        IP_PARSE_ERROR = ArgumentError
+      else
+        IP_PARSE_ERROR = IPAddr::Error
+      end
+
       def parse_ip_network(ip_as_s)
         validate_no_leading_zeroes_in_cidr(ip_as_s)
         addr, cidr_length, dual = ip_as_s.split('/')
@@ -28,7 +36,7 @@ module Coppertone
         network = IPAddr.new(addr)
         network = network.mask(cidr_length.to_i) unless cidr_length.blank?
         network
-      rescue IPAddr::Error
+      rescue IP_PARSE_ERROR
         nil
       end
 

data/lib/coppertone/mechanism/mx.rb

@@ -34,7 +34,11 @@ module Coppertone
         return unless limit && count > limit
         fail Coppertone::MXLimitExceededError
       end
+
+      def self.label
+        'mx'
+      end
     end
-    register('mx', Coppertone::Mechanism::MX)
+    register(Coppertone::Mechanism::MX)
   end
 end

data/lib/coppertone/mechanism/ptr.rb

@@ -11,7 +11,11 @@ module Coppertone
             .find(target_name)
         !matching_name.nil?
       end
+
+      def self.label
+        'ptr'
+      end
     end
-    register('ptr', Coppertone::Mechanism::Ptr)
+    register(Coppertone::Mechanism::Ptr)
   end
 end

data/lib/coppertone/mechanism.rb

@@ -16,8 +16,31 @@ module Coppertone
       class_builder.build(type, attributes)
     end
 
-    def self.register(type, klass)
-      class_builder.register(type, klass)
+    def self.register(klass)
+      fail ArgumentError unless klass < self
+      class_builder.register(klass.label, klass)
+    end
+
+    def self.dns_lookup_term?
+      false
+    end
+
+    attr_reader :arguments
+    def initialize(arguments)
+      @arguments = arguments
+    end
+
+    def dns_lookup_term?
+      self.class.dns_lookup_term?
+    end
+
+    def to_s
+      mech_label = self.class.label
+      arguments.blank? ? mech_label : "#{mech_label}#{arguments}"
+    end
+
+    def context_dependent?
+      false
     end
   end
 end

data/lib/coppertone/modifier/base.rb

@@ -3,6 +3,7 @@ module Coppertone
     class Base < Modifier
       attr_reader :domain_spec
       def initialize(attributes)
+        super(attributes)
         fail InvalidModifierError if attributes.blank?
         @domain_spec = Coppertone::DomainSpec.new(attributes)
       rescue Coppertone::MacroStringParsingError

data/lib/coppertone/modifier/exp.rb

@@ -17,7 +17,7 @@ module Coppertone
         expanded = macro_string.expand(macro_context, request_context)
         return nil unless ASCII_REGEXP.match(expanded)
         expanded
-      rescue Coppertone::Error
+      rescue DNSAdapter::Error
         nil
       end
 
@@ -28,7 +28,11 @@ module Coppertone
         return nil if records.size > 1
         MacroString.new(records.first[:text])
       end
+
+      def self.label
+        'exp'
+      end
     end
-    register('exp', Coppertone::Modifier::Exp)
+    register(Coppertone::Modifier::Exp)
   end
 end

data/lib/coppertone/modifier/redirect.rb

@@ -11,7 +11,11 @@ module Coppertone
         request_context.register_dns_lookup_term
         target_name_from_domain_spec(macro_context, request_context)
       end
+
+      def self.label
+        'redirect'
+      end
     end
-    register('redirect', Coppertone::Modifier::Redirect)
+    register(Coppertone::Modifier::Redirect)
   end
 end

data/lib/coppertone/modifier/unknown.rb

@@ -6,11 +6,16 @@ module Coppertone
       end
 
       def initialize(attributes)
+        super(attributes)
         @macro_string = Coppertone::MacroString.new(attributes)
       rescue Coppertone::MacroStringParsingError
         raise Coppertone::InvalidModifierError
       end
+
+      def self.label
+        'unknown'
+      end
     end
-    register('unknown', Coppertone::Modifier::Unknown)
+    register(Coppertone::Modifier::Unknown)
   end
 end

data/lib/coppertone/modifier.rb

@@ -10,8 +10,8 @@ module Coppertone
       class_builder.build(type, attributes)
     end
 
-    def self.register(type, klass)
-      class_builder.register(type, klass)
+    def self.register(klass)
+      class_builder.register(klass.label, klass)
     end
 
     MODIFIER_REGEXP = /\A([a-zA-Z]+[a-zA-Z0-9\-\_\.]*)=(\S*)\z/
@@ -22,6 +22,15 @@ module Coppertone
       attributes = matches[2]
       build(type, attributes) || build('unknown', attributes)
     end
+
+    attr_reader :arguments
+    def initialize(arguments)
+      @arguments = arguments
+    end
+
+    def to_s
+      "#{self.class.label}=#{arguments}"
+    end
   end
 end
 

data/lib/coppertone/null_macro_context.rb

@@ -0,0 +1,23 @@
+module Coppertone
+  # A context used to evaluate records, directives, and modifiers that do not have
+  # contextual dependence.
+  class NullMacroContext
+
+    RESERVED_REGEXP = Regexp.new("[^#{URI::PATTERN::UNRESERVED}]")
+    %w(s l o d i p v h c r t).each do |m|
+      define_method(m.upcase) do
+        fail ArgumentError
+      end
+
+      define_method(m) do
+        fail ArgumentError
+      end
+    end
+
+    def with_domain(new_domain)
+      self
+    end
+
+    NULL_CONTEXT = new
+  end
+end