coppertone 0.0.7 → 0.0.12

data/Rakefile

@@ -23,15 +23,16 @@ desc 'Parse OpenSPF tests'
 
 def spec_file_name(doc, output_path)
   description = doc['description']
-  file_name = description.gsub(/[^\w\s_-]+/, '')
-                         .gsub(/(^|\b\s)\s+($|\s?\b)/, '\\1\\2')
-                         .gsub(/\s+/, '_') + '_spec.rb'
+  file_prefix = description.gsub(/[^\w\s_-]+/, '')
+                           .gsub(/(^|\b\s)\s+($|\s?\b)/, '\\1\\2')
+                           .gsub(/\s+/, '_')
+  file_name = "#{file_prefix}_spec.rb"
   File.join(output_path, file_name)
 end
 
 INDENT_STRING = '  '.freeze
 def indented_string(num_indents = 1)
-  Array.new(num_indents) { INDENT_STRING }.join('')
+  Array.new(num_indents) { INDENT_STRING }.join
 end
 
 def puts_prefixed_string(f, s, indent = 0)
@@ -57,21 +58,25 @@ end
 
 def escape_quote(val)
   return unless val
+
   val.gsub(/'/) { |_s| "\\'" }
 end
 
 def clean_description(description)
   return unless description
+
   description.tr("\n", ' ').delete("'")
 end
 
 def as_array(val)
   return [] unless val
+
   val.is_a?(Array) ? val : [val]
 end
 
 def write_comment(f, comment, indent)
   return unless comment
+
   comment.lines do |comment_line|
     puts_prefixed_string(f, "# #{comment_line}", indent)
   end
@@ -85,10 +90,11 @@ def write_result(f, host, mailfrom, helo, indent)
 end
 
 def write_expects(f, results, explanation, indent)
-  results_array = "[#{results.map { |r| ':' + r } .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
+
   exp_expect = "expect(result.explanation).to eq('#{explanation}')"
   puts_prefixed_string(f, exp_expect, indent)
 end
@@ -116,7 +122,7 @@ def write_spec(f, spec, indent = 1)
 end
 
 def write_doc(doc, output_path)
-  open(spec_file_name(doc, output_path), 'w') do |f|
+  File.open(spec_file_name(doc, output_path), 'w') do |f|
     puts_prefixed_string(f, "require 'spec_helper'")
     empty_line(f)
     description = doc['description']

data/coppertone.gemspec

@@ -1,5 +1,4 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'coppertone/version'
 
@@ -7,22 +6,23 @@ Gem::Specification.new do |spec|
   spec.name          = 'coppertone'
   spec.version       = Coppertone::VERSION
   spec.authors       = ['Peter M. Goldstein']
-  spec.email         = ['peter.m.goldstein@gmail.com']
+  spec.email         = ['peter@valimail.com']
   spec.summary       = 'A Sender Policy Framework (SPF) toolkit'
   spec.description   = 'Coppertone includes tools for parsing SPF DNS records, evaluating the result of SPF checks for received emails, and creating appropriate email headers from SPF results.'
-  spec.homepage      = 'https://github.com/petergoldstein/coppertone'
-  spec.license       = 'Apache'
+  spec.homepage      = 'https://github.com/ValiMail/coppertone'
+  spec.license       = 'MIT'
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.7'
 
+  spec.add_runtime_dependency 'activesupport', '>= 3.0'
+  spec.add_runtime_dependency 'addressable'
   spec.add_runtime_dependency 'dns_adapter'
   spec.add_runtime_dependency 'i18n'
-  spec.add_runtime_dependency 'addressable'
-  spec.add_runtime_dependency 'activesupport', '>= 3.0'
   spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'flay'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '>= 3.0'
-  spec.add_development_dependency 'rubocop'
 end

data/lib/coppertone/class_builder.rb

@@ -12,8 +12,10 @@ module Coppertone
 
     def build(type, attributes)
       return nil unless type
+
       klass = map[type]
       return nil unless klass
+
       klass.create(attributes)
     end
   end

data/lib/coppertone/directive.rb

@@ -7,6 +7,7 @@ module Coppertone
   # SPF specification (see section 4.6.1).
   class Directive
     attr_reader :qualifier, :mechanism
+
     delegate :context_dependent?, :dns_lookup_term?,
              :includes_ptr?, to: :mechanism
 
@@ -25,6 +26,7 @@ module Coppertone
 
     def target_domain
       raise NeedsContextError unless dns_lookup_term?
+
       mechanism.target_domain
     end
 
@@ -37,17 +39,20 @@ module Coppertone
       qualifier.default? ? mechanism_s : "#{qualifier}#{mechanism_s}"
     end
 
-    DIRECTIVE_REGEXP = /\A([\+\-\~\?]?)([a-zA-Z0-9]*)((:?)\S*)\z/
+    DIRECTIVE_REGEXP = /\A([+\-~?]?)([a-zA-Z0-9]*)((:?)\S*)\z/.freeze
     def self.matching_term(text)
       return nil if text.include?('=')
+
       matches = DIRECTIVE_REGEXP.match(text)
       return nil unless matches
+
       qualifier_txt = matches[1]
       mechanism_type = matches[2].downcase
       attributes = matches[3]
       qualifier = Qualifier.find_by_text(qualifier_txt)
       mechanism = Mechanism.build(mechanism_type, attributes)
       return nil unless qualifier && mechanism
+
       new(qualifier, mechanism)
     end
   end

data/lib/coppertone/domain_spec.rb

@@ -15,10 +15,11 @@ module Coppertone
 
     def validate_domain_spec_restrictions
       return if only_allowed_macros? && ends_in_allowed_term?
+
       raise Coppertone::DomainSpecParsingError
     end
 
-    EXP_ONLY_MACRO_LETTERS = %w(c r t).freeze
+    EXP_ONLY_MACRO_LETTERS = %w[c r t].freeze
     def only_allowed_macros?
       @macros.select { |m| m.is_a?(Coppertone::MacroString::MacroExpand) }
              .none? { |m| EXP_ONLY_MACRO_LETTERS.include?(m.macro_letter) }
@@ -29,6 +30,7 @@ module Coppertone
       return true unless lm
       return false if lm.is_a?(Coppertone::MacroString::MacroStaticExpand)
       return true if lm.is_a?(Coppertone::MacroString::MacroExpand)
+
       ends_with_top_label?
     end
 
@@ -37,8 +39,10 @@ module Coppertone
       ends_with = ends_with[0..-2] if ends_with[-1] == '.'
       _, match, tail = ends_with.rpartition('.')
       return false if match.blank?
+
       hostname = Coppertone::Utils::DomainUtils.valid_tld?(tail)
       return false unless hostname
+
       true
     end
   end

data/lib/coppertone/error.rb

@@ -4,11 +4,13 @@ module Coppertone
 
   # Error classes mapping to the SPF result codes
   class TemperrorError < Coppertone::Error; end
+
   class PermerrorError < Coppertone::Error; 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.
@@ -42,8 +44,11 @@ module Coppertone
 
   # Errors generated when certain spec-defined limits are exceeded.
   class LimitExceededError < Coppertone::PermerrorError; end
+
   class TermLimitExceededError < PermerrorError; end
+
   class VoidLimitExceededError < PermerrorError; end
+
   class MXLimitExceededError < PermerrorError; end
 
   # Raised when context is required to evaluate a value, but

data/lib/coppertone/ip_address_wrapper.rb

@@ -10,9 +10,11 @@ module Coppertone
   # will fail if passed an address with a non-trivial network prefix
   class IPAddressWrapper
     attr_reader :string_representation, :ip
+
     def initialize(s)
       @ip = self.class.parse(s)
       raise ArgumentError unless @ip
+
       @string_representation = s
     end
 
@@ -26,6 +28,7 @@ module Coppertone
     def self.parse(s)
       return nil unless s
       return nil if s.index('/')
+
       ip_addr = IPAddr.new(s)
       normalize_ip(ip_addr)
     rescue IP_PARSE_ERROR
@@ -33,7 +36,8 @@ module Coppertone
     end
 
     def self.normalize_ip(parsed_ip)
-      return parsed_ip unless parsed_ip && parsed_ip.ipv6?
+      return parsed_ip unless parsed_ip&.ipv6?
+
       parsed_ip.ipv4_mapped? ? parsed_ip.native : parsed_ip
     end
 

data/lib/coppertone/macro_context.rb

@@ -7,7 +7,7 @@ module Coppertone
   # A context used to evaluate MacroStrings.  Responds to all of the
   # macro letter directives except 'p'.
   class MacroContext
-    attr_reader :domain, :ip_address_wrapper, :sender_identity, :helo_domain
+    attr_reader :domain, :ip_address_wrapper, :sender_identity, :helo_domain, :hostname
 
     delegate :s, :l, :o, to: :sender_identity
     alias d domain
@@ -16,7 +16,6 @@ module Coppertone
              to: :ip_address_wrapper
     alias h helo_domain
 
-    attr_reader :hostname
     def initialize(domain, ip_as_s, sender, helo_domain = 'unknown',
                    options = {})
       @ip_address_wrapper = IPAddressWrapper.new(ip_as_s)
@@ -37,10 +36,18 @@ module Coppertone
     end
 
     RESERVED_REGEXP = Regexp.new("[^#{URI::PATTERN::UNRESERVED}]")
-    %w(s l o d i v h c r t).each do |m|
+
+    def escape(string)
+      encoding = string.encoding
+      string.b.gsub(RESERVED_REGEXP) do |m|
+        "%#{m.unpack('H2' * m.bytesize).join('%').upcase}"
+      end.force_encoding(encoding)
+    end
+
+    %w[s l o d i v h c r t].each do |m|
       define_method(m.upcase) do
         unencoded = send(m)
-        unencoded ? ::URI.escape(unencoded, RESERVED_REGEXP) : nil
+        unencoded ? escape(unencoded) : nil
       end
     end
 

data/lib/coppertone/macro_string.rb

@@ -9,6 +9,7 @@ module Coppertone
   # context for interpolation.
   class MacroString
     attr_reader :macro_text
+
     def initialize(macro_text)
       @macro_text = macro_text
       macros
@@ -19,11 +20,11 @@ module Coppertone
     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('')
+      macros.map(&:to_s).join
     end
 
     def context_dependent?
@@ -39,6 +40,7 @@ module Coppertone
 
     def ==(other)
       return false unless other.instance_of? self.class
+
       macro_text == other.macro_text
     end
     alias eql? ==

data/lib/coppertone/macro_string/macro_expand.rb

@@ -9,10 +9,10 @@ module Coppertone
     # grammer defined in section 7.1.
     class MacroExpand
       MACRO_LETTER_CHAR_SET = '[slodiphcrtvSLODIPHCRTV]'.freeze
-      PTR_MACRO_CHAR_SET = %w(p P).freeze
+      PTR_MACRO_CHAR_SET = %w[p P].freeze
       DELIMITER_CHAR_SET = '[\.\-\+\,\/\_\=]'.freeze
       VALID_BODY_REGEXP =
-        /\A(#{MACRO_LETTER_CHAR_SET})(\d*)(r?)(#{DELIMITER_CHAR_SET}*)\z/
+        /\A(#{MACRO_LETTER_CHAR_SET})(\d*)(r?)(#{DELIMITER_CHAR_SET}*)\z/.freeze
 
       attr_reader :macro_letter, :digit_transformers, :reverse,
                   :delimiter_regexp
@@ -20,6 +20,7 @@ module Coppertone
       def initialize(s)
         matches = VALID_BODY_REGEXP.match(s)
         raise Coppertone::MacroStringParsingError if matches.nil?
+
         @macro_letter = matches[1]
         initialize_digit_transformers(matches[2])
         @reverse = (matches[3] == 'r')
@@ -29,6 +30,7 @@ module Coppertone
 
       def initialize_digit_transformers(raw_value)
         return unless raw_value
+
         @digit_transformers = raw_value.to_i unless raw_value.empty?
         return unless @digit_transformers
         raise Coppertone::MacroStringParsingError if @digit_transformers.zero?
@@ -44,6 +46,7 @@ module Coppertone
           Coppertone::Utils::ValidatedDomainFinder
           .new(context, request, false).find(context.d)
         return 'unknown' unless ptr
+
         @macro_letter == 'P' ? ::Addressable::URI.encode_component(ptr) : ptr
       end
 
@@ -64,6 +67,7 @@ module Coppertone
 
       def ==(other)
         return false unless other.instance_of? self.class
+
         to_s == other.to_s
       end
 

data/lib/coppertone/macro_string/macro_literal.rb

@@ -17,6 +17,7 @@ module Coppertone
 
       def ==(other)
         return false unless other.instance_of? self.class
+
         to_s == other.to_s
       end
     end

data/lib/coppertone/macro_string/macro_parser.rb

@@ -9,6 +9,7 @@ module Coppertone
     # in the context of a particular SPF check.
     class MacroParser
       attr_reader :macros
+
       def initialize(s)
         @s = s.dup
         @macros = []
@@ -31,20 +32,23 @@ module Coppertone
 
       def parse_contextual_interpolated_macro
         raise MacroStringParsingError unless @s[1] == '{'
+
         closing_index = @s.index('}')
         raise MacroStringParsingError unless closing_index
+
         interpolated_body = @s[2, closing_index - 2]
         @macros << MacroExpand.new(interpolated_body)
-        @s = @s[(closing_index + 1)..-1]
+        @s = @s[(closing_index + 1)..]
       end
 
-      SIMPLE_MACRO_LETTERS = %w(% _ -).freeze
+      SIMPLE_MACRO_LETTERS = %w[% _ -].freeze
       def parse_interpolated_macro
         raise MacroStringParsingError if @s.length == 1
+
         macro_code = @s[0, 2]
         if MacroStaticExpand.exists_for?(macro_code)
           @macros << MacroStaticExpand.macro_for(macro_code)
-          @s = @s[2..-1]
+          @s = @s[2..]
         else
           parse_contextual_interpolated_macro
         end
@@ -54,7 +58,7 @@ module Coppertone
         new_idx = @s.index('%')
         new_idx ||= @s.length
         @macros << MacroLiteral.new(@s[0, new_idx])
-        @s = @s[new_idx..-1]
+        @s = @s[new_idx..]
         new_idx
       end
     end

data/lib/coppertone/macro_string/macro_static_expand.rb

@@ -28,14 +28,16 @@ module Coppertone
       # Replaces '%-' in a macro string
       URL_ENCODED_SPACE_MACRO = new('%-'.freeze, '%20'.freeze)
 
-      SIMPLE_INTERPOLATED_MACRO_LETTERS = %w(% _ -).freeze
+      SIMPLE_INTERPOLATED_MACRO_LETTERS = %w[% _ -].freeze
       def self.exists_for?(x)
         return false unless x && (x.length == 2) && (x[0] == '%')
+
         SIMPLE_INTERPOLATED_MACRO_LETTERS.include?(x[1])
       end
 
       def self.macro_for(x)
         raise Coppertone::MacroStringParsingError unless exists_for?(x)
+
         case x[1]
         when '%'
           PERCENT_MACRO

data/lib/coppertone/mechanism.rb

@@ -18,6 +18,7 @@ module Coppertone
 
     def self.register(klass)
       raise ArgumentError unless klass < self
+
       class_builder.register(klass.label, klass)
     end
 
@@ -26,6 +27,7 @@ module Coppertone
     end
 
     attr_reader :arguments
+
     def initialize(arguments)
       @arguments = arguments
     end

data/lib/coppertone/mechanism/all.rb

@@ -5,6 +5,7 @@ module Coppertone
     class All < Mechanism
       def self.create(attributes)
         raise InvalidMechanismError unless attributes.blank?
+
         SINGLETON
       end