coppertone 0.0.11 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8802307a322cafa013376ddb5f67bfd134996b4f51b9753f04c4c024158c6f5
-  data.tar.gz: 4a426ab5a166b4e896417bd004f2ea597d77074929f389f7f152698b65258c64
+  metadata.gz: 3752897202805df2380313ece71a3fda42830bc636b29f6c48c92a3d4b4e91d6
+  data.tar.gz: 76cf7084e4f25c8198c9f534a66eb9cbf6584df5b3004aa4d07317aabd89fd99
 SHA512:
-  metadata.gz: 260ff1c6805f0f74cc9c8939b66b99ab903f83f548b22e3a05a8ed4fec45867549e4d8b01ea66b06fdf17096f1e08fb094c292070209684c5531ad9e481d37c4
-  data.tar.gz: c4753800b5357e24aed9a964d00ea0f7ae5a91056407edd38b325a5b6dee1c0fdc33edfa5c79644b6dee00b4104cca2497d7933fd18e89eabc21216888281308
+  metadata.gz: 1d9b2a1e83a88e89c6226183ecf64db0cbe7206049dd34c922cbb707add141277c0b69edcffafb46100122a348fbecbe0a4ca339108882c389781514314ea324
+  data.tar.gz: 71c1abefd7b43713bc00933d9448d3746da5d52d15552ffa9a18918fbb4ec1afbd105a0b0738a412f42d7df05208ab01badedc8fa3d3ae52bb83546af2045981

data/.circleci/config.yml

@@ -1,10 +1,7 @@
 version: 2
 aliases:
   - &current_ruby_image
-    circleci/ruby:2.5.1
-
-  - &previous_ruby_image
-    circleci/ruby:2.4.4
+    circleci/ruby:2.7.2
 
   - &defaults
     working_directory: ~/repo
@@ -72,12 +69,6 @@ jobs:
       - *step_store_test_artifacts
       - *step_store_coverage_artifacts
 
-  previous_ruby-job:
-    working_directory: ~/repo
-    docker:
-      - image: *previous_ruby_image
-    steps: *test_run_steps
-
 workflows:
     version: 2
     build-test_current-ruby:
@@ -86,6 +77,3 @@ workflows:
         - code-quality-job:
             requires:
               - current_ruby-job # let primary job fetch all dependencies first
-    build-test_previous-ruby:
-      jobs:
-        - previous_ruby-job

data/.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily 
+  open-pull-requests-limit: 99

data/.rubocop.yml

@@ -1,32 +1,61 @@
 AllCops:
-  TargetRubyVersion: 2.5
+  NewCops: enable
+  TargetRubyVersion: 2.7
 
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+Layout/LineLength:
+  Enabled: false
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+Lint/EmptyBlock:
+  Enabled: false
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+Lint/UriEscapeUnescape:
+  Enabled: false
 Metrics/AbcSize:
   Exclude:
     - 'Rakefile'
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*'
-Metrics/LineLength:
-  Enabled: false
 Metrics/MethodLength:
   Exclude:
     - 'Rakefile'
-Style/Documentation:
+Naming/FileName:
+  Exclude:
+    - 'spec/open_spf/**/*'
+Naming/MethodParameterName:
   Enabled: false
-Rails/HttpPositionalArguments:
+Style/Documentation:
   Enabled: false
+Style/ExponentialNotation:
+  Enabled: true
 Style/FrozenStringLiteralComment:
   Enabled: false
-Naming/FileName:
-  Exclude:
-    - 'spec/open_spf/**/*'
 Style/FormatStringToken:
   Enabled: false
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+Style/RedundantFetchBlock:
+  Enabled: true
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+Style/RedundantRegexpEscape:
+  Enabled: true
+Style/SlicingWithRange:
+  Enabled: true
 Style/SymbolArray:
   Exclude:
     - 'spec/open_spf/**/*'
-Naming/UncommunicativeMethodParamName:
-  Enabled: false
-Lint/UriEscapeUnescape:
-  Enabled: false

data/Gemfile

@@ -6,6 +6,8 @@ gemspec
 group :development, :test do
   gem 'brakeman', require: false
   gem 'rubocop', require: false
+  gem 'rubocop-rake', require: false
+  gem 'rubocop-rspec', require: false
 end
 
 group :test do

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)
@@ -89,7 +90,7 @@ 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

data/coppertone.gemspec

@@ -15,6 +15,7 @@ Gem::Specification.new do |spec|
   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'
@@ -22,6 +23,6 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'i18n'
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'flay'
-  spec.add_development_dependency 'rake', '~> 12.3'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '>= 3.0'
 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
 
@@ -38,7 +39,7 @@ module Coppertone
       qualifier.default? ? mechanism_s : "#{qualifier}#{mechanism_s}"
     end
 
-    DIRECTIVE_REGEXP = /\A([\+\-\~\?]?)([a-zA-Z0-9]*)((:?)\S*)\z/.freeze
+    DIRECTIVE_REGEXP = /\A([+\-~?]?)([a-zA-Z0-9]*)((:?)\S*)\z/.freeze
     def self.matching_term(text)
       return nil if text.include?('=')
 

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,6 +10,7 @@ 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

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}]")
+
+    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?

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 = []
@@ -37,7 +38,7 @@ module Coppertone
 
         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
@@ -47,7 +48,7 @@ module Coppertone
         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
@@ -57,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/mechanism.rb

@@ -27,6 +27,7 @@ module Coppertone
     end
 
     attr_reader :arguments
+
     def initialize(arguments)
       @arguments = arguments
     end

data/lib/coppertone/mechanism/domain_spec_mechanism.rb

@@ -15,7 +15,7 @@ module Coppertone
       def trim_domain_spec(raw_domain_spec)
         return nil if raw_domain_spec.blank?
 
-        raw_domain_spec[1..-1]
+        raw_domain_spec[1..]
       end
 
       def self.dns_lookup_term?

data/lib/coppertone/mechanism/include_matcher.rb

@@ -19,6 +19,7 @@ module Coppertone
       end
 
       attr_reader :record
+
       def initialize(record)
         @record = record
       end

data/lib/coppertone/mechanism/ip_mechanism.rb

@@ -3,6 +3,7 @@ module Coppertone
     # Implements the ip4 mechanism.
     class IPMechanism < Mechanism
       attr_reader :netblock, :cidr_length
+
       def self.create(attributes)
         new(attributes)
       end
@@ -10,13 +11,13 @@ module Coppertone
       def initialize(attributes)
         super(attributes)
         unless attributes.blank?
-          attributes = attributes[1..-1] if attributes[0] == ':'
+          attributes = attributes[1..] if attributes[0] == ':'
           @netblock, @cidr_length = parse_netblock(attributes)
         end
         raise Coppertone::InvalidMechanismError if @netblock.nil?
       end
 
-      LEADING_ZEROES_IN_CIDR_REGEXP = %r{\/0\d}.freeze
+      LEADING_ZEROES_IN_CIDR_REGEXP = %r{/0\d}.freeze
       def validate_no_leading_zeroes_in_cidr(ip_as_s)
         return unless LEADING_ZEROES_IN_CIDR_REGEXP.match?(ip_as_s)
 

data/lib/coppertone/modifier.rb

@@ -14,7 +14,7 @@ module Coppertone
       class_builder.register(klass.label, klass)
     end
 
-    MODIFIER_REGEXP = /\A([a-zA-Z]+[a-zA-Z0-9\-\_\.]*)=(\S*)\z/.freeze
+    MODIFIER_REGEXP = /\A([a-zA-Z]+[a-zA-Z0-9\-_.]*)=(\S*)\z/.freeze
     def self.matching_term(text)
       matches = MODIFIER_REGEXP.match(text)
       return nil unless matches
@@ -29,6 +29,7 @@ module Coppertone
     end
 
     attr_reader :arguments
+
     def initialize(arguments)
       @arguments = arguments
     end

data/lib/coppertone/modifier/base.rb

@@ -3,6 +3,7 @@ module Coppertone
     # Base class including logic common to modifiers
     class Base < Modifier
       attr_reader :domain_spec
+
       def initialize(attributes)
         super(attributes)
         raise InvalidModifierError if attributes.blank?

data/lib/coppertone/modifier/unknown.rb

@@ -4,6 +4,7 @@ module Coppertone
     # defined by the SPF spec
     class Unknown < Modifier
       attr_reader :label
+
       def initialize(label, attributes)
         super(attributes)
         @label = label

data/lib/coppertone/qualifier.rb

@@ -22,6 +22,7 @@ module Coppertone
     end
 
     attr_reader :text, :result_code
+
     def initialize(text, result_code)
       @text = text
       @result_code = result_code

data/lib/coppertone/record.rb

@@ -3,6 +3,7 @@ module Coppertone
   # record from a text string.
   class Record
     attr_reader :text
+
     def initialize(raw_text)
       @terms = Coppertone::RecordTermParser.new(raw_text).terms
       normalize_terms

data/lib/coppertone/record_evaluator.rb

@@ -2,6 +2,7 @@ module Coppertone
   # A helper class for finding SPF records for a domain.
   class RecordEvaluator
     attr_reader :record
+
     def initialize(record)
       @record = record
     end

data/lib/coppertone/record_finder.rb

@@ -2,6 +2,7 @@ module Coppertone
   # A helper class for finding SPF records for a domain.
   class RecordFinder
     attr_reader :dns_client, :domain
+
     def initialize(dns_client, domain)
       @dns_client = dns_client
       @domain = domain
@@ -12,9 +13,7 @@ module Coppertone
         begin
           validate_txt_records
           spf_dns_record = txt_records.first
-          return nil unless spf_dns_record
-
-          Record.new(spf_dns_record)
+          spf_dns_record ? Record.new(spf_dns_record) : nil
         end
     end
 

data/lib/coppertone/record_term_parser.rb

@@ -7,11 +7,13 @@ module Coppertone
 
     def self.record?(text)
       return false if text.blank?
+      return true if RECORD_REGEXP.match?(text.strip)
 
-      RECORD_REGEXP.match?(text.strip) ? true : false
+      false
     end
 
     attr_reader :text, :terms
+
     def initialize(text)
       raise RecordParsingError unless self.class.record?(text)
       raise RecordParsingError unless ALLOWED_CHARACTERS.match?(text)
@@ -21,7 +23,7 @@ module Coppertone
     end
 
     def terms_segment
-      text[VERSION_STR.length..-1].strip
+      text[VERSION_STR.length..].strip
     end
   end
 end

data/lib/coppertone/redirect_record_finder.rb

@@ -2,6 +2,7 @@ module Coppertone
   # A helper class for finding SPF records for a redirect modifier.
   class RedirectRecordFinder
     attr_reader :redirect, :macro_context, :request_context
+
     def initialize(redirect, macro_context, request_context)
       @redirect = redirect
       @macro_context = macro_context

data/lib/coppertone/request.rb

@@ -1,8 +1,8 @@
 module Coppertone
   # Represents an SPF request.
   class Request
-    attr_reader :ip_as_s, :sender, :helo_domain, :options, :result
-    attr_reader :helo_result, :mailfrom_result
+    attr_reader :ip_as_s, :sender, :helo_domain, :options, :result, :helo_result, :mailfrom_result
+
     def initialize(ip_as_s, sender, helo_domain, options = {})
       @ip_as_s = ip_as_s
       @sender = sender
@@ -74,9 +74,7 @@ module Coppertone
     def check_spf_for_context(macro_context, identity)
       record = spf_record(macro_context)
       @result = spf_request(macro_context, record, identity) if record
-    rescue DNSAdapter::Error => e
-      Result.temperror(e.message)
-    rescue Coppertone::TemperrorError => e
+    rescue DNSAdapter::Error, Coppertone::TemperrorError => e
       Result.temperror(e.message)
     rescue Coppertone::PermerrorError => e
       Result.permerror(e.message)

data/lib/coppertone/request_count_limiter.rb

@@ -3,6 +3,7 @@ module Coppertone
   # used to track and limit the number of DNS queries of various types.
   class RequestCountLimiter
     attr_accessor :count, :limit, :counter_description
+
     def initialize(limit = nil, counter_description = nil)
       self.limit = limit
       self.counter_description = counter_description

data/lib/coppertone/result.rb

@@ -16,6 +16,7 @@ module Coppertone
 
     attr_reader :code, :mechanism
     attr_accessor :explanation, :problem, :identity
+
     def initialize(code, mechanism = nil)
       @code = code
       @mechanism = mechanism

data/lib/coppertone/sender_identity.rb

@@ -7,6 +7,7 @@ module Coppertone
     EMAIL_ADDRESS_SPLIT_REGEXP = /^(.*)@(.*?)$/.freeze
 
     attr_reader :sender, :localpart, :domain
+
     def initialize(sender)
       @sender = sender
       initialize_localpart_and_domain

data/lib/coppertone/terms_parser.rb

@@ -2,6 +2,7 @@ module Coppertone
   # Parses a un-prefixed string into terms
   class TermsParser
     attr_reader :text
+
     def initialize(text)
       @text = text
     end

data/lib/coppertone/utils/domain_utils.rb

@@ -42,7 +42,7 @@ module Coppertone
 
       NO_DASH_NONNUMERIC_REGEXP = /\A[a-zA-Z0-9]*[a-zA-Z]+[a-zA-Z0-9]*\z/.freeze
       NO_DASH_REGEXP = /\A[a-zA-Z0-9]+\z/.freeze
-      DASH_REGEXP = /\A[a-zA-Z0-9]+\-[a-zA-Z0-9\-]*[a-zA-Z0-9]+\z/.freeze
+      DASH_REGEXP = /\A[a-zA-Z0-9]+-[a-zA-Z0-9\-]*[a-zA-Z0-9]+\z/.freeze
 
       def self.valid_hostname_label?(l)
         return false unless valid_label?(l)

data/lib/coppertone/utils/validated_domain_finder.rb

@@ -4,7 +4,8 @@ module Coppertone
     # section 5.5 of the RFC.
     class ValidatedDomainFinder
       attr_reader :subdomain_only
-      def initialize(macro_context, request_context, subdomain_only = true)
+
+      def initialize(macro_context, request_context, subdomain_only = true) # rubocop:disable Style/OptionalBooleanParameter
         @mc = macro_context
         @request_context = request_context
         @subdomain_only = subdomain_only

data/lib/coppertone/version.rb

@@ -1,3 +1,3 @@
 module Coppertone
-  VERSION = '0.0.11'.freeze
+  VERSION = '0.0.12'.freeze
 end

data/spec/spec_helper.rb

@@ -16,4 +16,4 @@ SimpleCov.start
 require 'coppertone'
 
 # Support files
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].sort.each { |f| require f }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coppertone
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.12
 platform: ruby
 authors:
 - Peter M. Goldstein
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-07-31 00:00:00.000000000 Z
+date: 2021-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -133,6 +133,7 @@ extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
 - ".codeclimate.yml"
+- ".github/dependabot.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
@@ -253,7 +254,7 @@ homepage: https://github.com/ValiMail/coppertone
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -261,15 +262,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
-signing_key: 
+rubygems_version: 3.2.8
+signing_key:
 specification_version: 4
 summary: A Sender Policy Framework (SPF) toolkit
 test_files: