coppertone 0.0.7 → 0.0.12

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
@@ -9,11 +10,12 @@ module Coppertone
     end
 
     def target
-      @redirect_target ||= redirect.evaluate(macro_context, request_context)
+      @target ||= redirect.evaluate(macro_context, request_context)
     end
 
     def record
       return unless target
+
       @record ||= RecordFinder.new(request_context.dns_client, target).record
     end
   end

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
@@ -16,13 +16,15 @@ module Coppertone
 
     def process_helo
       check_spf_for_helo
-      return nil if helo_result && helo_result.none?
+      return nil if helo_result&.none?
+
       helo_result
     end
 
     def process_mailfrom
       check_spf_for_mailfrom
-      return nil if mailfrom_result && mailfrom_result.none?
+      return nil if mailfrom_result&.none?
+
       mailfrom_result
     end
 
@@ -34,25 +36,6 @@ module Coppertone
       helo_result.nil? && mailfrom_result.nil?
     end
 
-    def check_spf_for_helo
-      @helo_result ||= check_spf_for_context(helo_context, 'helo')
-    end
-
-    def check_spf_for_mailfrom
-      @mailfrom_result ||= check_spf_for_context(mailfrom_context, 'mailfrom')
-    end
-
-    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
-      Result.temperror(e.message)
-    rescue Coppertone::PermerrorError => e
-      Result.permerror(e.message)
-    end
-
     def request_context
       @request_context ||= RequestContext.new(options)
     end
@@ -72,9 +55,29 @@ module Coppertone
 
     def spf_request(macro_context, record, identity)
       return Result.new(:none) if record.nil?
+
       r = RecordEvaluator.new(record).evaluate(macro_context, request_context)
       r.identity = identity
       r
     end
+
+    private
+
+    def check_spf_for_helo
+      @helo_result = check_spf_for_context(helo_context, 'helo')
+    end
+
+    def check_spf_for_mailfrom
+      @mailfrom_result = check_spf_for_context(mailfrom_context, 'mailfrom')
+    end
+
+    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, Coppertone::TemperrorError => e
+      Result.temperror(e.message)
+    rescue Coppertone::PermerrorError => e
+      Result.permerror(e.message)
+    end
   end
 end

data/lib/coppertone/request_context.rb

@@ -60,6 +60,7 @@ module Coppertone
 
     def config_value(k)
       return @options[k] if @options.key?(k)
+
       Coppertone.config.send(k)
     end
   end

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
@@ -26,6 +27,7 @@ module Coppertone
 
     def exceeded?
       return false unless limited?
+
       count > limit
     end
 

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
@@ -45,7 +46,7 @@ module Coppertone
       Result.new(:neutral)
     end
 
-    %w(none pass fail softfail neutral temperror permerror).each do |t|
+    %w[none pass fail softfail neutral temperror permerror].each do |t|
       define_method("#{t}?") do
         self.class.const_get(t.upcase) == send(:code)
       end

data/lib/coppertone/sender_identity.rb

@@ -4,9 +4,10 @@ module Coppertone
   # for the macro letters.
   class SenderIdentity
     DEFAULT_LOCALPART = 'postmaster'.freeze
-    EMAIL_ADDRESS_SPLIT_REGEXP = /^(.*)@(.*?)$/
+    EMAIL_ADDRESS_SPLIT_REGEXP = /^(.*)@(.*?)$/.freeze
 
     attr_reader :sender, :localpart, :domain
+
     def initialize(sender)
       @sender = sender
       initialize_localpart_and_domain

data/lib/coppertone/term.rb

@@ -7,6 +7,7 @@ module Coppertone
   class Term
     def self.build_from_token(token)
       return nil unless token
+
       Directive.matching_term(token) || Modifier.matching_term(token)
     end
   end

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
@@ -11,12 +12,13 @@ module Coppertone
     end
 
     def tokens
-      text.split(/ /).select { |s| !s.blank? }
+      text.split(/ /).reject(&:blank?)
     end
 
     def parse_token(token)
       term = Term.build_from_token(token)
       raise RecordParsingError unless term
+
       term
     end
   end

data/lib/coppertone/utils/domain_utils.rb

@@ -7,12 +7,17 @@ module Coppertone
     class DomainUtils
       def self.valid?(domain)
         return false if domain.blank?
-        labels = to_ascii_labels(domain)
-        return false if labels.length <= 1
         return false if domain.length > 253
-        return false if labels.any? { |l| !valid_label?(l) }
+
+        labels_valid?(to_ascii_labels(domain))
+      end
+
+      def self.labels_valid?(labels)
+        return false if labels.length <= 1
+        return false if labels.first == '*'
         return false unless valid_tld?(labels.last)
-        true
+
+        labels.all? { |l| valid_label?(l) }
       end
 
       def self.to_labels(domain)
@@ -22,6 +27,7 @@ module Coppertone
       def self.parent_domain(domain)
         labels = to_labels(domain)
         return '.' if labels.size == 1
+
         labels.shift
         labels.join('.')
       end
@@ -34,33 +40,38 @@ module Coppertone
         to_ascii_labels(domain).join('.')
       end
 
-      NO_DASH_NONNUMERIC_REGEXP = /\A[a-zA-Z0-9]*[a-zA-Z]+[a-zA-Z0-9]*\z/
-      NO_DASH_REGEXP = /\A[a-zA-Z0-9]+\z/
-      DASH_REGEXP = /\A[a-zA-Z0-9]+\-[a-zA-Z0-9\-]*[a-zA-Z0-9]+\z/
+      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
 
       def self.valid_hostname_label?(l)
         return false unless valid_label?(l)
+
         NO_DASH_REGEXP.match(l) || DASH_REGEXP.match(l)
       end
 
       def self.valid_tld?(l)
         return false unless valid_label?(l)
+
         NO_DASH_NONNUMERIC_REGEXP.match(l) || DASH_REGEXP.match(l)
       end
 
       def self.valid_ldh_domain?(domain)
         return false unless valid?(domain)
+
         labels = to_ascii_labels(domain)
         return false unless valid_tld?(labels.last)
+
         labels.all? { |l| valid_hostname_label?(l) }
       end
 
       def self.valid_label?(l)
-        (l.length >= 0) && (l.length <= 63) && !l.match(/\s/)
+        !l.empty? && (l.length <= 63) && !l.match(/\s/)
       end
 
       def self.macro_expanded_domain(domain)
         return nil if domain.blank?
+
         labels = to_ascii_labels(domain)
         domain = labels.join('.')
         while domain.length > 253
@@ -75,12 +86,14 @@ module Coppertone
         domain_labels = to_ascii_labels(domain)
         num_labels_in_domain = domain_labels.length
         return false if subdomain_labels.length <= domain_labels.length
+
         subdomain_labels.last(num_labels_in_domain) == domain_labels
       end
 
       def self.subdomain_or_same?(candidate, domain)
         return false unless valid?(domain) && valid?(candidate)
         return true if normalized_domain(domain) == normalized_domain(candidate)
+
         subdomain_of?(candidate, domain)
       end
     end

data/lib/coppertone/utils/ip_in_domain_checker.rb

@@ -49,7 +49,7 @@ module Coppertone
         ips = recs.map do |r|
           IPAddr.new(r[:address]).mask(cidr_length.to_i)
         end
-        ips.select { |i| !i.nil? }
+        ips.reject(&:nil?)
       end
     end
   end

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.7'.freeze
+  VERSION = '0.0.12'.freeze
 end

data/spec/domain_spec_spec.rb

@@ -26,7 +26,7 @@ describe Coppertone::DomainSpec do
   end
 
   it 'raises an error when the macro string contains forbidden macros' do
-    %w(c r t).each do |m|
+    %w[c r t].each do |m|
       expect do
         Coppertone::DomainSpec.new("%{#{m}}")
       end.to raise_error(Coppertone::DomainSpecParsingError)

data/spec/macro_string/macro_static_expand_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe Coppertone::MacroString::MacroStaticExpand do
   context '#exists_for?' do
-    %w(%% %_ %-).each do |x|
+    ['%%', '%_', '%-'].each do |x|
       it "should resolve a macro for the key #{x}" do
         expect(Coppertone::MacroString::MacroStaticExpand.exists_for?(x))
           .to eq(true)
@@ -16,7 +16,7 @@ describe Coppertone::MacroString::MacroStaticExpand do
   end
 
   context 'macro_for' do
-    %w(%% %_ %-).each do |x|
+    ['%%', '%_', '%-'].each do |x|
       it "should resolve a macro for the key #{x}" do
         expect(Coppertone::MacroString::MacroStaticExpand.macro_for(x))
           .not_to be_nil

data/spec/mechanism/ip4_spec.rb

@@ -23,6 +23,7 @@ describe Coppertone::Mechanism::IP4 do
     it 'should not fail if called with an IP v6' do
       mech = Coppertone::Mechanism::IP4.new(':fe80::202:b3ff:fe1e:8329')
       expect(mech.netblock).to eq(IPAddr.new('fe80::202:b3ff:fe1e:8329'))
+      expect(mech.cidr_length).to eq(128)
       expect(mech.to_s).to eq('ip4:fe80::202:b3ff:fe1e:8329')
       expect(mech).not_to be_includes_ptr
       expect(mech).not_to be_context_dependent
@@ -32,6 +33,7 @@ describe Coppertone::Mechanism::IP4 do
     it 'should work if called with an IP4' do
       mech = Coppertone::Mechanism::IP4.new(':1.2.3.4')
       expect(mech.netblock).to eq(IPAddr.new('1.2.3.4'))
+      expect(mech.cidr_length).to eq(32)
       expect(mech.to_s).to eq('ip4:1.2.3.4')
       expect(mech).not_to be_includes_ptr
       expect(mech).not_to be_context_dependent
@@ -41,6 +43,7 @@ describe Coppertone::Mechanism::IP4 do
     it 'should work if called with an IP4 with a pfxlen' do
       mech = Coppertone::Mechanism::IP4.new(':1.2.3.4/4')
       expect(mech.netblock).to eq(IPAddr.new('1.2.3.4/4'))
+      expect(mech.cidr_length).to eq(4)
       expect(mech.to_s).to eq('ip4:1.2.3.4/4')
       expect(mech).not_to be_includes_ptr
       expect(mech).not_to be_context_dependent

data/spec/mechanism/ip6_spec.rb

@@ -23,6 +23,7 @@ describe Coppertone::Mechanism::IP6 do
     it 'should not fail if called with an IP v4' do
       mech = Coppertone::Mechanism::IP6.new(':1.2.3.4')
       expect(mech.netblock).to eq(IPAddr.new('1.2.3.4'))
+      expect(mech.cidr_length).to eq(32)
       expect(mech).not_to be_dns_lookup_term
     end
 
@@ -30,6 +31,7 @@ describe Coppertone::Mechanism::IP6 do
       mech = Coppertone::Mechanism::IP6.new(':fe80::202:b3ff:fe1e:8329')
       expect(mech.netblock)
         .to eq(IPAddr.new('fe80::202:b3ff:fe1e:8329'))
+      expect(mech.cidr_length).to eq(128)
       expect(mech).not_to be_dns_lookup_term
     end
 
@@ -37,6 +39,7 @@ describe Coppertone::Mechanism::IP6 do
       mech = Coppertone::Mechanism::IP6.new(':fe80::202:b3ff:fe1e:8329/64')
       expect(mech.netblock)
         .to eq(IPAddr.new('fe80::202:b3ff:fe1e:8329/64'))
+      expect(mech.cidr_length).to eq(64)
       expect(mech).not_to be_dns_lookup_term
     end
 

data/spec/null_macro_context_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe Coppertone::NullMacroContext do
-  %w(s l o d i p v h c r t).each do |i|
+  %w[s l o d i p v h c r t].each do |i|
     it "should raise an error for #{i}" do
       expect do
         Coppertone::NullMacroContext::NULL_CONTEXT.send(i)

data/spec/open_spf/Initial_processing_spec.rb

@@ -1,5 +1,3 @@
-# -- encoding : utf-8 --
-
 require 'spec_helper'
 
 describe 'Initial processing' do

data/spec/open_spf/Semantics_of_exp_and_other_modifiers_spec.rb

@@ -1,5 +1,3 @@
-# -- encoding : utf-8 --
-
 require 'spec_helper'
 
 describe 'Semantics of exp and other modifiers' do

data/spec/record_spec.rb

@@ -141,7 +141,7 @@ describe Coppertone::Record do
           .new('v=spf1 include:_spf.domain1.com ip4:1.2.3.4 include:_spf.domain2.com ~all exp=explain._spf.%{d}')
       includes = r.includes
       expect(includes.map(&:mechanism).all? { |i| i.is_a?(Coppertone::Mechanism::Include) }).to be_truthy
-      expect(includes.map(&:target_domain)).to eq(%w(_spf.domain1.com _spf.domain2.com))
+      expect(includes.map(&:target_domain)).to eq(%w[_spf.domain1.com _spf.domain2.com])
     end
   end
 

data/spec/spec_helper.rb

@@ -1,8 +1,19 @@
 require 'simplecov'
-require 'codeclimate-test-reporter'
-CodeClimate::TestReporter.start || SimpleCov.start
+
+if ENV['CI'] == 'true'
+  require 'codecov'
+  SimpleCov.formatter = SimpleCov::Formatter::Codecov
+end
+
+# save to CircleCI's artifacts directory if we're on CircleCI
+if ENV['CIRCLE_ARTIFACTS']
+  dir = File.join(ENV['CIRCLE_ARTIFACTS'], 'coverage')
+  SimpleCov.coverage_dir(dir)
+end
+
+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 }