Class: Mollie::SMS

Inherits:

Object

• Object
• Mollie::SMS

show all

Defined in:

lib/mollie/sms.rb,
lib/mollie/sms/test_helper.rb

Overview

Defined Under Namespace

Modules: Exceptions, TestHelper Classes: Response

Constant Summary

GATEWAY_URI =

The SSL URI to which the parameters of a SMS are posted.

Note that the certificate is not verified.

URI.parse("https://secure.mollie.nl/xml/sms")

GATEWAYS =

The possible values that indicate which SMS gateway should be used.

See Also:

• http://www.mollie.nl/sms-diensten/sms-gateway/gateways

{
  'basic'     => '2',
  'business'  => '4',
  'business+' => '1',
  'landline'  => '8'
}

REQUIRED_PARAMS =

A list of paramaters that must to be included in the parameters send to the gateway.

%w{ username

Class Attribute Summary (collapse)

• + (String) charset

  A character set name, describing the message???s body encoding.

• + (String) gateway

  The gateway that should be used to send messages.

• + (String) originator

  The number, or display name, that will be used to indicate the originator of a message.

• + (String) password

  A MD5 hashed version of your password for the Mollie.nl SMS webservice.

• + (String) type

  The type of messages that will be send.

• + (String) username

  Your username for the Mollie.nl SMS webservice.

Instance Attribute Summary (collapse)

• - (Hash) params readonly

  The parameters that will be send to the gateway.

Class Method Summary (collapse)

• + (Hash) default_params

  Returns the default parameters that will be we merged with each instance???s params.

Instance Method Summary (collapse)

• - (Boolean) ==(other)

  Compares whether or not this and the other Mollie::SMS instance are equal in recipient, body, and other parameters.

• - (String) body

  The message body.

• - (String) body=(body)

  Assigns the message???s body.

• - (Response) deliver

  Posts the parameters to the gateway, through SSL.

• - (Response) deliver!

  Posts the parameters through #deliver, but raises a DeliveryFailure in case the request fails.

• - (SMS) initialize(telephone_number = nil, body = nil, extra_params = {}) constructor

  Initializes a new Mollie::SMS instance.

• - (String) inspect

  A `inspect' string representation of this instance.

• - (String) telephone_number

  The recipient???s telephone number.

• - (String) telephone_number=(telephone_number)

  Assigns the recipient???s telephone number.

• - (String) to_s

  A string representation of this instance.

• - (nil) validate_params!

  Checks if all required parameters are present and if the SMS.originator is of the right size.

161
162
163
164
165

# File 'lib/mollie/sms.rb', line 161

def initialize(telephone_number = nil, body = nil, extra_params = {})
  @params = self.class.default_params.merge(extra_params)
  self.telephone_number = telephone_number if telephone_number
  self.body = body if body
end

96
97
98

# File 'lib/mollie/sms.rb', line 96

def charset
  @charset
end

122
123
124

# File 'lib/mollie/sms.rb', line 122

def gateway
  @gateway
end

92
93
94

# File 'lib/mollie/sms.rb', line 92

def originator
  @originator
end

78
79
80

# File 'lib/mollie/sms.rb', line 78

def password
  @password
end

109
110
111

# File 'lib/mollie/sms.rb', line 109

def type
  @type
end

74
75
76

# File 'lib/mollie/sms.rb', line 74

def username
  @username
end

148
149
150

# File 'lib/mollie/sms.rb', line 148

def params
  @params
end

131
132
133
134
135
136
137
138
139
140

# File 'lib/mollie/sms.rb', line 131

def default_params
  {
    'username'     => @username,
    'md5_password' => @password,
    'originator'   => @originator,
    'gateway'      => @gateway,
    'charset'      => @charset,
    'type'         => @type
  }
end

198
199
200

# File 'lib/mollie/sms.rb', line 198

def ==(other)
  other.is_a?(SMS) && other.params == params
end

181
182
183

# File 'lib/mollie/sms.rb', line 181

def body
  @params['message']
end

189
190
191

# File 'lib/mollie/sms.rb', line 189

def body=(body)
  @params['message'] = body
end

219
220
221
222
223
224
225
226
227
228
229
230
231

# File 'lib/mollie/sms.rb', line 219

def deliver
  validate_params!

  post = Net::HTTP::Post.new(GATEWAY_URI.path)
  post.form_data = params
  request = Net::HTTP.new(GATEWAY_URI.host, GATEWAY_URI.port)
  request.use_ssl = true
  request.verify_mode = OpenSSL::SSL::VERIFY_NONE
  request.start do |http|
    response = http.request(post)
    Response.new(response)
  end
end

244
245
246
247
248

# File 'lib/mollie/sms.rb', line 244

def deliver!
  response = deliver
  raise Exceptions::DeliveryFailure.new(self, response) unless response.success?
  response
end

208
209
210

# File 'lib/mollie/sms.rb', line 208

def inspect
  %{#<#{self.class.name} #{to_s}>}
end

168
169
170

# File 'lib/mollie/sms.rb', line 168

def telephone_number
  @params['recipients']
end

176
177
178

# File 'lib/mollie/sms.rb', line 176

def telephone_number=(telephone_number)
  @params['recipients'] = telephone_number
end

203
204
205

# File 'lib/mollie/sms.rb', line 203

def to_s
  %{from: <#{params['originator']}> to: <#{telephone_number}> body: "#{body}"}
end

258
259
260
261
262
263
264
265
266
267
268
269
270
271

# File 'lib/mollie/sms.rb', line 258

def validate_params!
  params.slice(*REQUIRED_PARAMS).each do |key, value|
    raise Exceptions::ValidationError, "The required parameter `#{key}' is missing." if value.blank?
  end

  originator = params['originator']
  if originator =~ /^\d+$/
    if originator.size > 14
      raise Exceptions::ValidationError, "Originator may have a maximimun of 14 numerical characters."
    end
  elsif originator.size > 11
    raise Exceptions::ValidationError, "Originator may have a maximimun of 11 alphanumerical characters."
  end
end