Class: Newman::Controller

Inherits:
Object
  • Object
show all
Defined in:
lib/newman/controller.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params) ⇒ Controller

A ‘Newman::Controller` object is initialized with parameters that match what is provided by the low level `Newman::Server` object. Generally speaking, you won’t instantiate controller objects yourself, but instead will rely on ‘Newman::Application` to instantiate them for you.



19
20
21
22
23
24
 
# File 'lib/newman/controller.rb', line 19

def initialize(params)
  self.settings = params.fetch(:settings)
  self.request  = params.fetch(:request)
  self.response = params.fetch(:response)
  self.logger   = params.fetch(:logger)
end

Instance Attribute Details

#logger ⇒ Object

All of the fields on ‘Newman::Controller` are public, so that they can freely be manipulated by callbacks. We may lock this down a bit more in a future version of Newman once we figure out what data actually needs to be exposed in callbacks, but for now you can feel free to depend on any of these fields.



34
35
36
 
# File 'lib/newman/controller.rb', line 34

def logger
  @logger
end

#params ⇒ Object

All of the fields on ‘Newman::Controller` are public, so that they can freely be manipulated by callbacks. We may lock this down a bit more in a future version of Newman once we figure out what data actually needs to be exposed in callbacks, but for now you can feel free to depend on any of these fields.



34
35
36
 
# File 'lib/newman/controller.rb', line 34

def params
  @params
end

#request ⇒ Object

All of the fields on ‘Newman::Controller` are public, so that they can freely be manipulated by callbacks. We may lock this down a bit more in a future version of Newman once we figure out what data actually needs to be exposed in callbacks, but for now you can feel free to depend on any of these fields.



34
35
36
 
# File 'lib/newman/controller.rb', line 34

def request
  @request
end

#response ⇒ Object

All of the fields on ‘Newman::Controller` are public, so that they can freely be manipulated by callbacks. We may lock this down a bit more in a future version of Newman once we figure out what data actually needs to be exposed in callbacks, but for now you can feel free to depend on any of these fields.



34
35
36
 
# File 'lib/newman/controller.rb', line 34

def response
  @response
end

#settings ⇒ Object

All of the fields on ‘Newman::Controller` are public, so that they can freely be manipulated by callbacks. We may lock this down a bit more in a future version of Newman once we figure out what data actually needs to be exposed in callbacks, but for now you can feel free to depend on any of these fields.



34
35
36
 
# File 'lib/newman/controller.rb', line 34

def settings
  @settings
end

Instance Method Details

#domain ⇒ Object

‘Newman::Controller#domain` is used as a convenient shortcut for referencing `settings.service.domain`.



130
131
132
 
# File 'lib/newman/controller.rb', line 130

def domain
  settings.service.domain 
end

#forward_message(params = {}) ⇒ Object

‘Newman::Controller#forward_message` works in a similar fashion to `Newman::Controller#response`, but copies the request FROM, SUBJECT and BODY fields and sets the REPLY TO field to be equal to `settings.service.default_sender`. This feature is convenient for implementing mailing-list style functionality, such as in the following example:

if list.subscriber?(sender)
  forward_message :bcc => list.subscribers.join(", ")
else
  respond :subject => "You are not subscribed",
          :body    => template("non-subscriber-error")
end



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/newman/controller.rb', line 99

def forward_message(params={})
  response.from      = request.from
  response.reply_to  = settings.service.default_sender 
  response.subject   = request.subject

  params.each do |k,v|
    response.send("#{k}=", v)
  end

  if request.multipart?
    response.text_part = request.text_part
    response.html_part = request.html_part
  else
    response.body = request.body.to_s
  end
end

#respond(params) ⇒ Object

‘Newman::Controller#respond` is used to modify the response email object, and is used in the manner shown below:

respond :subject => "Hello There", 
        :body    => "It's nice to meet you, pal!"

Because this method simply provides syntactic sugar on top of the ‘Mail::Message` object’s interface, you should be sure to take a look at the documentation for the [mail gem](github.com/mikel/mail) to discover what options are available.



50
51
52
 
# File 'lib/newman/controller.rb', line 50

def respond(params)
  params.each { |k,v| response.send("#{k}=", v) }
end

#sender ⇒ Object

‘Newman::Controller#sender` is used as a convenient shortcut for retrieving the sender’s email address from the request object.



121
122
123
 
# File 'lib/newman/controller.rb', line 121

def sender
  request.from.first.to_s
end

#skip_response ⇒ Object

‘Newman::Controller#skip_response` is used for disabling the delivery of the response email. Use this for situations where no response is required, such as when a spam email or a bounce has been detected, or if you are building an application which simply passively monitors incoming email rather than replying to it.



79
80
81
 
# File 'lib/newman/controller.rb', line 79

def skip_response
  response.perform_deliveries = false
end

#template(name, locals = {}) ⇒ Object

‘Newman::Controller#template` is used to invoke a template file within the context of the current controller object using Tilt. A `name` for the template is provided and then looked up in the directory referenced by `settings.service.templates_dir`. If a `locals` hash is provided, these local variables will be made available in templates.

**NOTE: This is feature is one we haven’t adequately used in Newman, if you have trouble with it, please let us know via our [issue tracker](github.com/mendicant-university/newman/issues).**



66
67
68
69
 
# File 'lib/newman/controller.rb', line 66

def template(name,locals={})
  Tilt.new(Dir.glob("#{settings.service.templates_dir}/#{name}.*").first)
      .render(self,locals)
end