stanislav-web/phalcon-sms-factory

Multiple gateway SMS Sender factory. Provide any SMS services inside your Phalcon's projects

1.2.3-stable 2015-04-15 15:16 UTC

README

Multiple SMS Sender factory

Scrutinizer Code Quality Code Coverage Build Status Total Downloads Latest Stable Version Phalconist License

Description

This service makes SMS through a variety of providers. You can easily implement your own providers using the interface design. At the moment, provides an interface to send and check your balance for the next:

- BulkSMS
- Clickatell
- MessageBird
- Nexmo
- SmsAero
- SMSC
- SmsUkraine
- SMS.ru

Change Log

In Future

- Support SMS mass mailing

[v 1.2.3-stable] 2015-04-15

- Add single error handler
- Add SMS.ru provider
- Send SMS Unit Tests

[v 1.2.2-beta] 2015-02-08

- Add view balance
- Add development info (API) / UML
- Reformat to PSR-1/PSR-2

[v 1.1-beta] 2015-02-07

- Add response debugger (Show server response headers)

[v 1.0-beta] 2015-02-06

- Sending SMS use multiple providers

Compatible

  • PSR-0, PSR-1, PSR-2, PSR-4 Standards

System requirements

  • PHP 5.4 >
  • Phalcon extension 1.3.x
  • PHP libcurl or Stream Socket client

Install

First update your dependencies through composer. Add to your composer.json:

"require": {
    "stanislav-web/phalcon-sms-factory": "1.2.*@stable",
}

Then run to update dependency and autoloader

php composer.phar update
php composer.phar install

or just

php composer.phar require stanislav-web/phalcon-sms-factory 1.2.*@stable

(Do not forget to include the composer autoloader)

You can create an injectable service

    $di->set('SMS', function () use ($di) {

        return new SMSFactory\Sender($di);
    });

Usage

Configure providers

SMS services have a variety of settings, both mandatory and optional. You can select them in the global configuration file of your project. I intentionally did not make the settings in each provider, as this service will be maintained and no time to change. Therefore, when updating via the composer, your settings will not be overwritten, if you will be making their to global application config. See example:

<?php
    // add to your app config and write down your settings .The key 'sms' is required
    'sms'   =>  [
    
                'Nexmo'         =>  [
                    'from'      => '',
                    'api_key'   => '',
                    'api_secret'=> '',
                    'type'      => '',
                    'request_method' => ''
                ],
                'BulkSMS'   =>  [
                    'username'  => '',
                    'password'  => '',
                ],
                'SmsAero' => [
                    'from'          => '',
                    'user'          => '',
                    'password'      => '',
                ],
                
                'SmsUkraine'       =>  [
                    'from'          => '',
                    'login'         => '',
                    'password'      => '',
                    'version'       => '',
                ],
                
                'SMSC'       =>  [
                    'login'     => '',
                    'psw'       => '',
                    'charset'   => '',
                    'sender'    => '',
                ],
        
                'SMSRu' => [
                    'api_id'    => ''
                ],
                
                'Clickatell'    => [
                    'api_id'    => '',
                    'user'      => '',
                    'password'  => '',
                    'from'      => '',
                    'request_method' => ''
                ],
                'MessageBird'   => [
                    'originator'   => '',
                    'access_key'   => '',
                    'request_method' => ''
                ]           
    ];

Send SMS and view balance

Now you can call your created service of sending sms.

<?php

    // get sms service
    $sms = $this->di->get('SMS');

    // send message via SmsAero (available 7 providers)
    $response = $sms->call('SmsAero')->setRecipient('NUMBER')->send('MESSAGE'));

    // get balance of SmsAero account
    $response = $sms->call('SmsAero')->balance();

    // use debug to show headers
    $response = $sms->call('SmsProvider')->debug(true)->setRecipient('NUMBER')->send('MESSAGE'));
    $response = $sms->call('SmsProvider')->debug(true)->balance();

Unit Test

Also available in /phpunit directory. Run command to start

phpunit --configuration phpunit.xml.dist --coverage-text

##Change Log

Contributing and development

I have enclosed instructions API and related classes Diagram.

I am accept bug reports, new feature requests and pull requests in GitHub.

If you have a question about how to use this service, please see this README.

If you have a change or new feature in mind, please see this README again and follow DRI (development rules interfaces).

You can add new providers following interfaces:

You can add own or choise exists of request's client. Also available:

##Issues