spf 0.0.1 → 0.0.2

data/lib/spf/eval.rb

@@ -1,6 +1,7 @@
 require 'ip'
 require 'resolv'
 
+require 'spf/error'
 require 'spf/model'
 require 'spf/result'
 
@@ -46,7 +47,7 @@ class SPF::Server
   def initialize(options = {})
     @default_authority_explanation = options[:default_authority_explanation] ||
       DEFAULT_DEFAULT_AUTHORITY_EXPLANATION
-    unless @default_authority_explanation.is_a?(SPF::MacroString)
+    unless SPF::MacroString === @default_authority_explanation
       @default_authority_explanation = SPF::MacroString.new({
         :text           => @default_authority_explanation,
         :server         => self,
@@ -122,7 +123,7 @@ class SPF::Server
   end
 
   def dns_lookup(domain, rr_type)
-    if domain.is_a?(SPF::MacroString)
+    if SPF::MacroString === domain
       domain = domain.expand
       # Truncate overlong labels at 63 bytes (RFC 4408, 8.1/27)
       domain.gsub!(/([^.]{63})[^.]+/, "#{$1}")
@@ -132,7 +133,7 @@ class SPF::Server
 
     rr_type = self.resource_typeclass_for_rr_type(rr_type)
     
-    domain.sub(/^(.*?)\.?$/, $1 ? "#{$1}".downcase : '')
+    domain = domain.sub(/\.$/, '').downcase
 
     packet = @dns_resolver.getresources(domain, rr_type)
 
@@ -214,13 +215,13 @@ class SPF::Server
 
       if records.empty?
         # RFC 4408, 4.5/7
-        raise SPF::NoAcceptableRecordError('No applicable sender policy available')
+        raise SPF::NoAcceptableRecordError.new('No applicable sender policy available')
       end
 
       # Discard all records but the highest acceptable version:
       preferred_record_class = records[0].class
 
-      records = records.select { |record| record.is_a?(preferred_record_class) }
+      records = records.select { |record| preferred_record_class === record }
 
       if records.length != 1
         # RFC 4408, 4.5/6
@@ -242,7 +243,7 @@ class SPF::Server
     rr_type = resource_typeclass_for_rr_type(rr_type)
     records = []
     packet.each do |rr|
-      next unless rr.is_a?(rr_type)
+      next unless rr_type === rr
       text = rr.strings.join('')
       record = false
       versions.each do |version|

data/lib/spf/model.rb

@@ -85,6 +85,15 @@ class SPF::Term
  ::
   "
 
+  attr_reader :ip_address, :ip_network, :ipv4_prefix_length, :ipv6_prefix_length
+
+  def initialize
+    @ip_address         = nil
+    @ip_network         = nil
+    @ipv4_prefix_length = nil
+    @ipv6_prefix_length = nil
+  end
+
   def self.new_from_string(text, options = {})
     #term = SPF::Term.new(options, {:text => text})
     options[:text] = text
@@ -210,7 +219,7 @@ class SPF::Mech < SPF::Term
       @parse_text = @text.dup
     end
     if self.instance_variable_defined?(:@domain_spec) and
-      not @domain_spec.is_a?(SPF::MacroString)
+      not SPF::MacroString === @domain_spec
       @domain_spec = SPF::MacroString.new({:text => @domain_spec})
     end
   end
@@ -351,7 +360,7 @@ class SPF::Mech < SPF::Term
       return params
     end
 
-    def match(server, request)
+    def match(server, request, want_result = true)
       server.count_dns_interactive_term(request)
       return self.match_in_domain(server, request)
     end
@@ -366,7 +375,7 @@ class SPF::Mech < SPF::Term
       # No parameters.
     end
 
-    def match(server, request)
+    def match(server, request, want_result = true)
       return true
     end
 
@@ -384,7 +393,7 @@ class SPF::Mech < SPF::Term
       return @domain_spec ? ':' + @domain_spec : nill
     end
 
-    def match(server, request)
+    def match(server, request, want_result = true)
       server.count_dns_interactive_term(request)
 
       domain = self.domain(server, request)
@@ -414,8 +423,8 @@ class SPF::Mech < SPF::Term
       return result
     end
 
-    def match(server, request)
-      ip_network_v6 = @ip_network.is_a?(IP::V4) ?
+    def match(server, request, want_result = true)
+      ip_network_v6 = IP::V4 === @ip_network ?
         SPF::Util.ipv4_address_to_ipv6(@ip_network) :
         @ip_network
       return ip_network_v6.contains?(request.ip_address_v6)
@@ -438,7 +447,7 @@ class SPF::Mech < SPF::Term
       return params
     end
 
-    def match(server, request)
+    def match(server, request, want_result = true)
       return @ip_network.contains?(request.ip_address_v6)
     end
 
@@ -456,7 +465,8 @@ class SPF::Mech < SPF::Term
       return @domain_spec ? ':' + @domain_spec : nil
     end
 
-    def match(server, request)
+    def match(server, request, want_result = true)
+
       server.count_dns_interactive_term(request)
 
       # Create sub-request with mutated authority domain:
@@ -468,17 +478,18 @@ class SPF::Mech < SPF::Term
 
       # Translate result of sub-request (RFC 4408, 5.9):
 
-      return true if
-        result.is_a?(SPF::Result::Pass)
+      return false unless want_result
+
+      return true if SPF::Result::Pass === result
 
       return false if
-        result.is_a?(SPF::Result::Fail)     or
-        result.is_a?(SPF::Result::SoftFail) or
-        result.is_a?(SPF::Result::Neutral)
+        SPF::Result::Fail     === result or
+        SPF::Result::SoftFail === result or
+        SPF::Result::Neutral  === result or
 
       server.throw_result('permerror', request,
         "Include domain '#{authority_domain}' has no applicable sender policy") if
-        result.is_a?(SPF::Result::None)
+        SPF::Result::None === result
 
       # Propagate any other results (including {Perm,Temp}Error) as-is:
       raise result
@@ -508,7 +519,7 @@ class SPF::Mech < SPF::Term
       return params
     end
 
-    def match(server, request)
+    def match(server, request, want_result = true)
 
       server.count_dns_interactive_term(request)
 
@@ -549,7 +560,7 @@ class SPF::Mech < SPF::Term
       return @domain_spec ? ':' + @domain_spec : nil
     end
 
-    def match(server, request)
+    def match(server, request, want_result = true)
       return SPF::Util.valid_domain_for_ip_address(
         server, request, request.ip_address, self.domain(server, request)) ?
         true : false
@@ -566,7 +577,7 @@ class SPF::Mod < SPF::Term
 
     @parse_text = @text.dup unless @parse_text
 
-    if @domain_spec and not @domain_spec.is_a?(SPF::MacroString)
+    if @domain_spec and not SPF::MacroString === @domain_spec
       @domain_spec = SPF::MacroString.new({:text => @domain_spec})
     end
   end
@@ -684,7 +695,7 @@ class SPF::Mod < SPF::Term
       server.count_dns_interactive_term(request)
 
       # Only perform redirection if no mechanism matched (RFC 4408, 6.1/1):
-      return unless result.is_a?(SPF::Result::NeutralByDefault)
+      return unless SPF::Result::NeutralByDefault === result
 
       # Create sub-request with mutated authorithy domain:
       authority_domain = @domain_spec.new({:server => server, :request => request})
@@ -694,7 +705,7 @@ class SPF::Mod < SPF::Term
       result = server.process(sub_request)
 
       # Translate result of sub-request (RFC 4408, 6.1/4):
-      if result.is_a?(SPF::Result::None)
+      if SPF::Result::None === result
         server.throw_result(:permerror, request,
           "Redirect domain '#{authority_domain}' has no applicable sender policy")
       end
@@ -789,13 +800,13 @@ class SPF::Record
       if mod_class
         # Known modifier.
         mod = mod_class.new_from_string(mod_text)
-        if mod.is_a?(SPF::GlobalMod)
+        if SPF::GlobalMod === mod
           # Global modifier.
           unless @global_mods[mod_name]
             raise SPF::DuplicateGlobalMod.new("Duplicate global modifier '#{mod_name}' encountered")
           end
           @global_mods[mod_name] = mod
-        elsif mod.is_a?(SPF::PositionalMod)
+        elsif SPF::PositionalMod === mod
           # Positional modifier, queue normally:
           @terms << mod
         end
@@ -822,26 +833,26 @@ class SPF::Record
     raise SPF::OptionRequiredError.new('Request object required for record evaluation')    unless request
     begin
       @terms.each do |term|
-        if term.is_a?(SPF::Mech)
+        if SPF::Mech === term
+        #if term.is_a?(SPF::Mech)
           # Term is a mechanism.
           mech = term
-          if mech.match(server, request)
+          if mech.match(server, request, request.ip_address != nil)
             result_name = RESULTS_BY_QUALIFIER[mech.qualifier]
             result_class = server.result_class(result_name)
             result = result_class.new([server, request, "Mechanism '#{term}' matched"])
             mech.explain(server, request, result)
             raise result
           end
-        elsif term.is_a?(SPF::PositionalMod)
+        elsif SPF::PositionalMod === term
           # Term is a positional modifier.
           mod = term
           mod.process(server, request)
-        elsif term.is_a?(SPF::UnknownMod)
+        elsif SPF::UnknownMod === term
           # Term is an unknown modifier.  Ignore it (RFC 4408, 6/3).
         else
           # Invalid term object encountered:
-          raise SPF::UnexpectedTermObjectError.new(
-            "Unexpected term object '#{term}' encountered.")
+          raise SPF::UnexpectedTermObjectError.new("Unexpected term object '#{term}' encountered.")
         end
       end
     rescue SPF::Result => result
@@ -880,6 +891,10 @@ class SPF::Record
       'v=spf1'
     end
 
+    def self.version_tag
+      'v=spf1'
+    end
+
     def version_tag_pattern
       " v=spf(1) (?= \\x20+ | $ ) "
     end

data/lib/spf/request.rb

@@ -25,7 +25,7 @@ class SPF::Request
     @state             = {}
     @versions          = options[:versions]
     @scope             = options[:scope]             || :mfrom
-    @scope             = @scope.to_sym if @scope.is_a?(String)
+    @scope             = @scope.to_sym if String === @scope
     @_authority_domain = options[:authority_domain]
     @identity          = options[:identity]
     @ip_address        = options[:ip_address]
@@ -40,14 +40,13 @@ class SPF::Request
       raise SPF::InvalidScopeError.new("Invalid scope '#{@scope}'")
 
     # Versions:
-    if self.instance_variable_defined?(:@versions)
-      if @versions.is_a?(Symbol)
+    if @versions
+      if Symbol === @versions
         # Single version specified as a symbol:
         @versions = [@versions]
-      elsif not @versions.is_a?(Array)
+      elsif not Array === @versions
         # Something other than symbol or array specified:
-        raise SPF::InvalidOptionValueError.new(
-          "'versions' option must be symbol or array")
+        raise SPF::InvalidOptionValueError.new("'versions' option must be symbol or array")
       end
 
       # All requested record versions must be supported:
@@ -91,24 +90,21 @@ class SPF::Request
       @helo_identity ||= @identity
     end
 
-    # IP address:
-    if [:helo, :mfrom, :pra].find(@scope) and not self.instance_variable_defined?(:@ip_address)
-      raise SPF::OptionRequiredError.new("Missing required 'ip_address' option")
-    end
+    return unless @ip_address
 
     # Ensure ip_address is an IP object:
-    unless @ip_address.is_a?(IP)
+    unless IP === @ip_address
       @ip_address = IP.new(@ip_address)
     end
 
     # Convert IPv4 address to IPv4-mapped IPv6 address:
 
-    if SPF::Util.ipv6_address_is_ipv4_mapped(self.ip_address)
+    if SPF::Util.ipv6_address_is_ipv4_mapped(@ip_address)
       @ip_address_v6 = @ip_address # Accept as IPv6 address as-is
       @ip_address = SPF::Util.ipv6_address_to_ipv4(@ip_address)
-    elsif @ip_address.is_a?(IP::V4)
+    elsif IP::V4 === @ip_address
       @ip_address_v6 = SPF::Util.ipv4_address_to_ipv6(@ip_address)
-    elsif @ip_address.is_a?(IP::V6)
+    elsif IP::V6 === @ip_address
       @ip_address_v6 = @ip_address
     else
       raise SPF::InvalidOptionValueError.new("Unexpected IP address version");
@@ -131,7 +127,7 @@ class SPF::Request
     unless field
       raise SPF::OptionRequiredError.new('Field name required')
     end
-    if value and value === Fixnum
+    if value and Fixnum === value
       @state[field] = 0 unless @state[field]
       @state[field] += value
     else

data/lib/spf/result.rb

@@ -140,7 +140,7 @@ class SPF::Result < Exception
 
   def klass(name=nil)
     if name
-      name = name.to_sym if name.is_a?(String)
+      name = name.to_sym if String === name
       return self.RESULT_CLASSES[name]
     else
       return name
@@ -150,7 +150,7 @@ class SPF::Result < Exception
   def isa_by_name(name)
     suspect_class = self.klass(name)
     return false unless suspect_class
-    return self.is_a?(suspect_class)
+    return suspect_class === self
   end
   
   def is_code(code)

data/lib/spf/version.rb

@@ -1,5 +1,5 @@
 module SPF
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end
 
 # vim:sw=2 sts=2

data/spf.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "spf"
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andrew Flury", "Julian Mehnle"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spf
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors: