Class: AnySMS::Backend::Base

Inherits:

Object

• Object
• AnySMS::Backend::Base

Defined in:

lib/any_sms/backend/base.rb

Overview

Base class for any sms provider service. Provides basic structure and helper methods. While not necessary to be subclassed now, may be necessary later.

Direct Known Subclasses

Logger, NullSender

Instance Method Summary

• #initialize(params = {}) ⇒ Base constructor

  In initializer you may accept secrets which were defined in initializer or other configuration options if any.

• #send_sms(_phone, _text, _args = {}) ⇒ Object

  Interface for sending sms.

Constructor Details

#initialize(params = {}) ⇒ Base

In initializer you may accept secrets which were defined in initializer or other configuration options if any.

Parameters:

• params (Hash) (defaults to: {}) —

  List of arguments received from configure code.

# File 'lib/any_sms/backend/base.rb', line 11

def initialize(params = {}); end

Instance Method Details

#send_sms(_phone, _text, _args = {}) ⇒ Object

Interface for sending sms. Every subclass should implement method itself. Raises error in default implementation.

Parameters:

• _phone (String) —

  Phone number to send sms (not used in this implementation)

• _text (String) —

  Sms text (not used in this implementation)

Raises:

• (NotImplementedError)

# File 'lib/any_sms/backend/base.rb', line 19

def send_sms(_phone, _text, _args = {})
  raise NotImplementedError,
        "You should create your own class for every sms service you use"
end