Class: Bushido::Mailroute

Inherits:
Object
  • Object
show all
Defined in:
lib/bushido/mail_route.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Mailroute

Returns a new instance of Mailroute.



94
95
96
 
# File 'lib/bushido/mail_route.rb', line 94

def initialize
  @routes ||= ActiveSupport::OrderedHash.new
end

Instance Attribute Details

#constraints ⇒ Object

Returns the value of attribute constraints.



66
67
68
 
# File 'lib/bushido/mail_route.rb', line 66

def constraints
  @constraints
end

#current_target ⇒ Object

Returns the value of attribute current_target.



66
67
68
 
# File 'lib/bushido/mail_route.rb', line 66

def current_target
  @current_target
end

#params ⇒ Object

Returns the value of attribute params.



66
67
68
 
# File 'lib/bushido/mail_route.rb', line 66

def params
  @params
end

#reply ⇒ Object

Returns the value of attribute reply.



66
67
68
 
# File 'lib/bushido/mail_route.rb', line 66

def reply
  @reply
end

#routes ⇒ Object

Returns the value of attribute routes.



66
67
68
 
# File 'lib/bushido/mail_route.rb', line 66

def routes
  @routes
end

Class Method Details

.clear_routes! ⇒ Object 



14
15
16
 
# File 'lib/bushido/mail_route.rb', line 14

def self.clear_routes!
  @@routes = self.new
end

.field_matcher(*field_names) ⇒ Object 



53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/bushido/mail_route.rb', line 53

def self.field_matcher(*field_names)
  self.class_eval do
    field_names.each do |field_name|
      define_method field_name do |line, *args|
        constraints = args.first || {}
        required    = args[1]

        add_route_rule(field_name.to_s, build_matcher(line, constraints), required)
      end
    end
  end
end

.map {|@@routes| ... } ⇒ Object

Yields:

Raises:

  • (StandardError) 


3
4
5
6
7
8
 
# File 'lib/bushido/mail_route.rb', line 3

def self.map(&block)
  raise StandardError.new("Mailroute only supported in Ruby >= 1.9.1") if RUBY_VERSION < "1.9.1"
  
  @@routes ||= self.new
  yield @@routes
end

.pretty_print_contraint(constraint, prefix = "") ⇒ Object 



35
36
37
38
 
# File 'lib/bushido/mail_route.rb', line 35

def self.pretty_print_contraint(constraint, prefix="")
  output = "#{prefix}Constraint: #{constraint.inspect}"
  puts output
end

.pretty_print_routes ⇒ Object 



18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/bushido/mail_route.rb', line 18

def self.pretty_print_routes
  @@routes.routes.each_pair do |route_name, definition|
    puts "#{route_name} => "
    definition[:rules].each do |rule|
      pretty_print_rule(rule, "\t\t")
    end
    definition[:constraints].each do |constraint|
      pretty_print_contraint(constraint, "\t\t")
    end
  end
end

.pretty_print_rule(rule, prefix = "") ⇒ Object 



30
31
32
33
 
# File 'lib/bushido/mail_route.rb', line 30

def self.pretty_print_rule(rule, prefix="")
  output = "#{prefix}#{rule.first} => #{string_to_regex(rule[1]).inspect}, required? #{rule.last == true}"
  puts output
end

.routes ⇒ Object 



10
11
12
 
# File 'lib/bushido/mail_route.rb', line 10

def self.routes
  @@routes
end

.string_to_regex(string) ⇒ Object

Taken from somewhere on stackoverflow, props to the author!



41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/bushido/mail_route.rb', line 41

def self.string_to_regex(string)
  return nil unless string.strip.match(/\A\/(.*)\/(.*)\Z/mx)
  regexp , flags = $1 , $2
  return nil if !regexp || flags =~ /[^xim]/m

  x = /x/.match(flags) && Regexp::EXTENDED
  i = /i/.match(flags) && Regexp::IGNORECASE
  m = /m/.match(flags) && Regexp::MULTILINE

  Regexp.new regexp , [x,i,m].inject(0){|a,f| f ? a+f : a }
end

Instance Method Details

#add_constraint(params_field_name, requirement_type) ⇒ Object

Maybe add_requirement is better? Constraint procs must return true if the mail should be allowed

Raises:

  • (StandardError) 


105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/bushido/mail_route.rb', line 105

def add_constraint(params_field_name, requirement_type)
  checkers = {
    :not_allowed => Proc.new { |params| params[params_field_name.to_s].nil? },
    :required    => Proc.new { |params| not params[params_field_name.to_s].nil? },
    :custom      => Proc.new { |params| requirement_type.call(params[params_field_name.to_s]) }
  }

  checker = requirement_type.is_a?(Proc) ? checkers[:custom] : checkers[requirement_type]

  raise StandardError if checker.nil?

  @routes[@current_target][:constraints] << checker
  @routes[@current_target][:constraints].flatten! # In case we've added a nil
end

#ampm ⇒ Object

Regex shortcuts



70
71
72
 
# File 'lib/bushido/mail_route.rb', line 70

def ampm
  /\d+[apmAPM]{2}/
end

#month ⇒ Object 



86
87
88
 
# File 'lib/bushido/mail_route.rb', line 86

def month
  /((?:Jan(?:uary)?|Feb(?:ruary)?|Mar(?:ch)?|Apr(?:il)?|May|Jun(?:e)?|Jul(?:y)?|Aug(?:ust)?|Sep(?:tember)?|Sept|Oct(?:ober)?|Nov(?:ember)?|Dec(?:ember)?))/
end

#number ⇒ Object 



78
79
80
 
# File 'lib/bushido/mail_route.rb', line 78

def number
  /\d+/
end

#process(mail) ⇒ Object 



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/bushido/mail_route.rb', line 120

def process(mail)
  @params = preprocess_mail(mail)

  # Iterate through the routes and test each rule for each route against current mail
  @routes.each_pair do |route_name, definition|
    _matches = true

    # route: {'name-of-route' => {:rules => [[:field, matcher]], :constraints => []}}
    definition[:rules].each do |matcher|
      result = self.class.string_to_regex(matcher[1]).match(mail[matcher.first])
      if result.nil?
        _matches = false
        break
      end
      
      # Only Ruby 1.9 support named capture groups
      result.names.each { |key| @params[key] = result[key] }
    end
    
    # Run param-based constraints
    if _matches and constraints_pass?(definition[:constraints], params)
      @params['mail'] = mail
      puts "Firing: #{@params.inspect}, #{route_name}"
      return Bushido::Data.fire(params, "mail_#{route_name.gsub('.', '_')}")
      break
    end

  end
end

#route(target) {|_self| ... } ⇒ Object

Yields:

  • (_self)

Yield Parameters:



98
99
100
101
 
# File 'lib/bushido/mail_route.rb', line 98

def route(target, &block)
  @routes[@current_target = target] = {:rules => [], :constraints => []}
  yield self
end

#word ⇒ Object 



74
75
76
 
# File 'lib/bushido/mail_route.rb', line 74

def word
  /\w+/
end

#words_and_spaces ⇒ Object 



82
83
84
 
# File 'lib/bushido/mail_route.rb', line 82

def words_and_spaces
  /[\w|\s]+/
end

#year ⇒ Object 



90
91
92
 
# File 'lib/bushido/mail_route.rb', line 90

def year
  /((?:(?:[1]{1}\\d{1}\\d{1}\\d{1})|(?:[2]{1}\\d{3})))(?![\\d])/
end