Class: SPF::Mech::Include

Inherits:
SPF::Mech show all
Defined in:
lib/spf/model.rb

Constant Summary collapse

NAME = 
'include'

Constants inherited from SPF::Mech

DEFAULT_QUALIFIER, EXPLANATION_TEMPLATES_BY_RESULT_CODE, NAME_PATTERN, QUALIFIER_PATTERN

Constants inherited from Term

Term::DOMAIN_END_PATTERN, Term::DOMAIN_SPEC_PATTERN, Term::HEXWORD_PATTERN, Term::IPV4_ADDRESS_PATTERN, Term::IPV6_ADDRESS_PATTERN, Term::MACRO_DELIMITER, Term::MACRO_EXPAND_PATTERN, Term::MACRO_LITERAL_PATTERN, Term::MACRO_STRING_PATTERN, Term::MACRO_TRANSFORMERS_PATTERN, Term::NAME_PATTERN, Term::QNUM_PATTERN, Term::TOPLABEL_PATTERN, Term::TWO_HEXWORDS_OR_IPV4_ADDRESS_PATTERN

Instance Attribute Summary

Attributes inherited from Term

#domain_spec, #errors, #ip_address, #ip_netblocks, #ip_network, #ipv4_prefix_length, #ipv6_prefix_length

Instance Method Summary collapse

Methods inherited from SPF::Mech

#default_ipv4_prefix_length, #default_ipv6_prefix_length, #explain, #explanation_template, #initialize, #match_in_domain, #parse, #parse_end, #parse_name, #parse_qualifier, #qualifier, #to_s

Methods inherited from Term

#domain, #error, #initialize, new_from_string, #parse_domain_spec, #parse_ipv4_address, #parse_ipv4_ipv6_prefix_lengths, #parse_ipv4_network, #parse_ipv4_prefix_length, #parse_ipv6_address, #parse_ipv6_network, #parse_ipv6_prefix_length, #text

Constructor Details

This class inherits a constructor from SPF::Mech

Instance Method Details

#intitialize(options = {}) ⇒ Object 



469
470
471
472
 
# File 'lib/spf/model.rb', line 469

def intitialize(options = {})
  super(options)
  @nested_record = nil
end

#match(server, request, want_result = true) ⇒ Object 



482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
 
# File 'lib/spf/model.rb', line 482

def match(server, request, want_result = true)

  server.count_dns_interactive_term(request)

  # Create sub-request with mutated authority domain:
  authority_domain = self.domain(server, request)
  sub_request = request.new_sub_request({:authority_domain => authority_domain})

  # Process sub-request:
  result = server.process(sub_request)

  # Translate result of sub-request (RFC 4408, 5.9):

  return false unless want_result

  return true if SPF::Result::Pass === result

  return false if
    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
    SPF::Result::None === result

  # Propagate any other results (including {Perm,Temp}Error) as-is:
  raise result
end

#nested_record(server = nil, request = nil) ⇒ Object 



512
513
514
515
516
517
 
# File 'lib/spf/model.rb', line 512

def nested_record(server=nil, request=nil)
  return @nested_record if @nested_record
  authority_domain = self.domain(server, request)
  sub_request = request.new_sub_request({:authority_domain => authority_domain})
  return @nested_record = server.select_record(sub_request)
end

#params ⇒ Object 



478
479
480
 
# File 'lib/spf/model.rb', line 478

def params
  return @domain_spec ? ':' + @domain_spec : nil
end

#parse_params(required = true) ⇒ Object 



474
475
476
 
# File 'lib/spf/model.rb', line 474

def parse_params(required = true)
  self.parse_domain_spec(required)
end