Class: SmsCarrier::MessageDelivery

Inherits:
Delegator
  • Object
show all
Defined in:
lib/sms_carrier/message_delivery.rb

Overview

The SmsCarrier::MessageDelivery class is used by SmsCarrier::Base when creating a new carrier. MessageDelivery is a wrapper (Delegator subclass) around a lazy created Sms. You can get direct access to the Sms, deliver the SMS or schedule the SMS to be sent through Active Job.

Notifier.welcome(User.first)               # an SmsCarrier::MessageDelivery object
Notifier.welcome(User.first).deliver_now   # sends the email
Notifier.welcome(User.first).deliver_later # enqueue email delivery as a job through Active Job
Notifier.welcome(User.first).message       # a Sms object

Instance Method Summary collapse

Constructor Details

#initialize(carrier, sms_method, *args) ⇒ MessageDelivery

:nodoc:



16
17
18
19
20
 
# File 'lib/sms_carrier/message_delivery.rb', line 16

def initialize(carrier, sms_method, *args)  #:nodoc:
  @carrier = carrier
  @sms_method = sms_method
  @args = args
end

Instance Method Details

#__getobj__ ⇒ Object

:nodoc:



22
23
24
 
# File 'lib/sms_carrier/message_delivery.rb', line 22

def __getobj__  #:nodoc:
  @obj ||= @carrier.send(:new, @sms_method, *@args).message
end

#__setobj__(obj) ⇒ Object

:nodoc:



26
27
28
 
# File 'lib/sms_carrier/message_delivery.rb', line 26

def __setobj__(obj)  #:nodoc:
  @obj = obj
end

#deliver_later(options = {}) ⇒ Object

Enqueues the SMS to be delivered through Active Job. When the job runs it will send the SMS using deliver_now.

Notifier.welcome(User.first).deliver_later
Notifier.welcome(User.first).deliver_later(wait: 1.hour)
Notifier.welcome(User.first).deliver_later(wait_until: 10.hours.from_now)

Options:

  • :wait - Enqueue the SMS to be delivered with a delay.

  • :wait_until - Enqueue the SMS to be delivered at (after) a specific date / time.

  • :queue - Enqueue the SMS on the specified queue.



65
66
67
 
# File 'lib/sms_carrier/message_delivery.rb', line 65

def deliver_later(options={})
  enqueue_delivery :deliver_now, options
end

#deliver_later!(options = {}) ⇒ Object

Enqueues the SMS to be delivered through Active Job. When the job runs it will send the SMS using deliver_now!. That means that the message will be sent bypassing checking perform_deliveries and raise_delivery_errors, so use with caution.

Notifier.welcome(User.first).deliver_later!
Notifier.welcome(User.first).deliver_later!(wait: 1.hour)
Notifier.welcome(User.first).deliver_later!(wait_until: 10.hours.from_now)

Options:

  • :wait - Enqueue the SMS to be delivered with a delay

  • :wait_until - Enqueue the SMS to be delivered at (after) a specific date / time

  • :queue - Enqueue the SMS on the specified queue



49
50
51
 
# File 'lib/sms_carrier/message_delivery.rb', line 49

def deliver_later!(options={})
  enqueue_delivery :deliver_now!, options
end

#deliver_now ⇒ Object

Delivers an SMS:

Notifier.welcome(User.first).deliver_now



82
83
84
 
# File 'lib/sms_carrier/message_delivery.rb', line 82

def deliver_now
  message.deliver
end

#deliver_now! ⇒ Object

Delivers an SMS without checking perform_deliveries and raise_delivery_errors, so use with caution.

Notifier.welcome(User.first).deliver_now!



74
75
76
 
# File 'lib/sms_carrier/message_delivery.rb', line 74

def deliver_now!
  message.deliver!
end

#message ⇒ Object

Returns the Message object



31
32
33
 
# File 'lib/sms_carrier/message_delivery.rb', line 31

def message
  __getobj__
end