README

SmsSender is a library which helps you send SMS through your web applications. It provides an abstraction layer for sms manipulations. The library is splitted in two parts: HttpAdapter and Provider and is really extensible.

N.B: there is also a bundle integrating this library in Symfony2 applications.

Status

If someone magically appears and wants to maintain this project, I'll gladly give access to this repository.

HttpAdapters

HttpAdapters are responsible to get data from remote APIs.

Currently, there are the following adapters:

BuzzHttpAdapter for Buzz, a lightweight PHP 5.3 library for issuing HTTP requests;
CurlHttpAdapter for cURL;

Providers

Providers contain the logic to extract useful information.

The following providers are supported:

Esendex
Nexmo
Twilio
CardBoardFish
ValueFirst (only covering India's networks)
Swisscom (based on the GSMA OneAPI Specification)
websms

Installation

The recommended way to install SmsSender is through composer.

Just create a composer.json file for your project:

{
    "require": {
        "Carpe-Hora/SmsSender": "~1.0"
    }
}

Usage

First, you need an adapter to query an API:

<?php

$adapter  = new \SmsSender\HttpAdapter\BuzzHttpAdapter();

The BuzzHttpAdapter is tweakable, actually you can pass a Browser object to this adapter:

<?php

$buzz    = new \Buzz\Browser(new \Buzz\Client\Curl());
$adapter = new \SmsSender\HttpAdapter\BuzzHttpAdapter($buzz);

Now, you have to choose your provider.

You can use one of the builtin providers or write your own. You can also register all providers and decide later. That's we'll do:

<?php

$sender = new \SmsSender\SmsSender();
$sender->registerProviders(array(
    new \SmsSender\Provider\EsendexProvider(
        $adapter, '<ESENDEX_USER>', '<ESENDEX_PASS>', '<ESENDEX_ACCOUNT>'
    ),
    new \SmsSender\Provider\OtherProvider($adapter)
));

Everything is ok, enjoy!

API

The main method is called send() which receives a phone number, a message and the name of the originator.

<?php

$result = $sender->send('0642424242', 'It\'s the answer.', 'Kévin');
// Result is:
// "id"        => string(7) "some Id"
// "sent"      => bool "true"
// "status"    => string(9) "delivered"
// "recipient" => string(10) "0642424242"
// "body"      => string(17) "It's the answer."

The send() method returns a Sms result object with the following API, this object also implements the ArrayAccess interface:

getId() will return the id;
isSent() boolean indicating if the sms was sent;
getStatus() boolean indicating the sms' status (see the ResultInterface interface for the full statuses list);
getRecipient() string representing the recipient's phone number;
getBody() the message, as sent by the provider;

The SmsSender's API is fluent, you can write:

<?php

$result = $sender
    ->registerProvider(new \My\Provider\Custom($adapter))
    ->using('custom')
    ->send('0642424242', 'It\'s the answer.', 'Kévin');

The using() method allows you to choose the adapter to use. When you deal with multiple adapters, you may want to choose one of them. The default behavior is to use the first one but it can be annoying.

Single Recipient Strategy

Sometimes you want to configure a single recipient strategy in the development environment to avoid sending SMS to real users, but still allow the developer to check the rendered message in an SMS reader.

By using the SingleRecipientSender, you'll be able to send your SMS without any other changes thanks to the decorator pattern. Just pass your in-use sender (SmsSender for instance) and a recipient phonenumber, and you're done.

<?php

$sender = new \SmsSender\SmsSender();
$sender->registerProviders(array(
    new \SmsSender\Provider\EsendexProvider(
        $adapter, '<ESENDEX_USER>', '<ESENDEX_PASS>', '<ESENDEX_ACCOUNT>'
    ),
    new \SmsSender\Provider\OtherProvider($adapter)
));

$singleRecipientSender = new \SmsSender\SingleRecipientSender($sender, '0601010101');

All SMS now will be sent to 0601010101, but in a transparent way:

<?php

$result = $singleRecipientSender>send('0642424242', 'It\'s the answer.', 'Kévin');
// Result is:
// "id"        => string(7) "some Id"
// "sent"      => bool "true"
// "status"    => string(9) "delivered"
// "recipient" => string(10) "0642424242" <== The recipient phonenumber is not the single recipient one :)
// "body"      => string(17) "It's the answer."

Delayed sendings

By default, SmsSender sends messages right when you call the send method. However, if you want to avoid the performance hit of the communication between SmsSender and the SMS providers, you can choose to use a "delayed sender".

This sender works by putting the messages in a pool instead of sending them directly. This means you can for instance wait until the response is streamed to the user before really send the messages.

Currently, the supported pool is a MemoryPool. Here is an example of how to set it up:

<?php

$sender = new \SmsSender\SmsSender();
$sender->registerProvider(new \SmsSender\Provider\DummyProvider());

$pool = new \SmsSender\Pool\MemoryPool();

$delayedSender = new \SmsSender\DelayedSender($sender, $pool);

$delayedSender->send('0601010101', 'foo'); // nothing is sent here, the message is only queued
$delayedSender->send('0601010102', 'bar'); // same here

$results = $delayedSender->flush(); // the two previous message are sent here

Extending Things

You can provide your own adapter, you just need to create a new class which implements HttpAdapterInterface.

You can also write your own provider by implementing the ProviderInterface.

Note, the AbstractProvider class can help you by providing useful features.

Unit Tests

To run unit tests, you'll need a set of dependencies you can install using composer:

php composer.phar install --dev

Once installed, just launch the following command:

./vendor/bin/phpunit

You'll obtain some skipped unit tests due to the need of API keys.

Rename the phpunit.xml.dist file to phpunit.xml, then uncomment the following lines and add your own API keys:

<php>
      <!-- <server name="TWILIO_ACCOUNT_SID" value="Your Twilio account sid" /> -->
      <!-- <server name="TWILIO_API_SECRET" value="Your Twilio API secret" /> -->
</php>

You're done.

Thanks

As this library is heavily inspired from willdurand's Geocoder, he deserves a special mention in this README ;)

Credits

Kévin Gomez contact@kevingomez.fr
All contributors

License

SmsSender is released under the MIT License. See the bundled LICENSE file for details.

avtonom / sms-sender

Maintainers

Details