laravel-notification-channels · msonowal · Aug 7, 2017 · Aug 7, 2017 · Aug 7, 2017 · Aug 7, 2017
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,8 @@
+version: 2
+updates:
+- package-ecosystem: composer
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "23:30"
+  open-pull-requests-limit: 10
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,15 @@
+# Changelog
+
+All notable changes to `Textlocal` will be documented in this file
+
+
+## 2.4.0 - 2022-08-17
+
+`public function getSenderId($notifiable)`
+
+method has changed from `public function getSenderId()`, so now the notifiable is passed as parameter
+giving more control to the imeplementation to decide based on user/recipent in case want to use some alternate deciding factor
+
+## 0.0.1 - 2017-08-07
+
+- initial release
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,55 @@
+# Contributing
+
+Contributions are **welcome** and will be fully **credited**.
+
+Please read and understand the contribution guide before creating an issue or pull request.
+
+## Etiquette
+
+This project is open source, and as such, the maintainers give their free time to build and maintain the source code
+held within. They make the code freely available in the hope that it will be of use to other developers. It would be
+extremely unfair for them to suffer abuse or anger for their hard work.
+
+Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the
+world that developers are civilized and selfless people.
+
+It's the duty of the maintainer to ensure that all submissions to the project are of sufficient
+quality to benefit the project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used.
+
+## Viability
+
+When requesting or submitting new features, first consider whether it might be useful to others. Open
+source projects are used by many developers, who may have entirely different needs to your own. Think about
+whether or not your feature is likely to be used by other users of the project.
+
+## Procedure
+
+Before filing an issue:
+
+- Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
+- Check to make sure your feature suggestion isn't already present within the project.
+- Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
+- Check the pull requests tab to ensure that the feature isn't already in progress.
+
+Before submitting a pull request:
+
+- Check the codebase to ensure that your feature doesn't already exist.
+- Check the pull requests to ensure that another person hasn't already submitted the feature or fix.
+
+## Requirements
+
+If the project maintainer has any additional requirements, you will find them listed here.
+
+- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](http://pear.php.net/package/PHP_CodeSniffer).
+
+- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
+
+- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
+
+- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
+
+- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
+
+- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
+
+**Happy coding**!
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,21 @@
+# The MIT License (MIT)
+
+Copyright (c) Manash Jyoti Sonowal <[email protected]>
+
+> Permission is hereby granted, free of charge, to any person obtaining a copy
+> of this software and associated documentation files (the "Software"), to deal
+> in the Software without restriction, including without limitation the rights
+> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+> copies of the Software, and to permit persons to whom the Software is
+> furnished to do so, subject to the following conditions:
+>
+> The above copyright notice and this permission notice shall be included in
+> all copies or substantial portions of the Software.
+>
+> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+> THE SOFTWARE.
diff --git a/README.md b/README.md
@@ -1,5 +1,174 @@
-# new-channels
+This package allows to send SMS using Textlocal API using laravel notifications channel textlocal sms
 
-Discuss about new channel proposals our share your finished channels in the [proposal issue](https://github.com/laravel-notification-channels/new-channels/issues/6).
+Supports Laravel 5.5 upto 10.x
 
-Take a look at our [FAQ](http://laravel-notification-channels.com/) to see our small list of rules, to provide top-notch notification channels.
+[![Latest Stable Version](https://poser.pugx.org/msonowal/laravel-notification-channel-textlocal/v/stable)](https://packagist.org/packages/msonowal/laravel-notification-channel-textlocal)
+[![License](https://poser.pugx.org/msonowal/laravel-notification-channel-textlocal/license)](https://packagist.org/packages/msonowal/laravel-notification-channel-textlocal)
+[![Total Downloads](https://poser.pugx.org/msonowal/laravel-notification-channel-textlocal/downloads)](https://packagist.org/packages/msonowal/laravel-notification-channel-textlocal)
+
+This package makes it easy to send notifications using [textlocal](https://www.textlocal.in/) with Laravel 5.3.+
-This package makes it easy to send notifications using [textlocal](https://www.textlocal.in/) with Laravel 5.3.+
+This package makes it easy to send notifications using [textlocal](https://www.textlocal.in/) with Laravel 5.5+ & 6.x
-This package makes it easy to send notifications using [textlocal](https://www.textlocal.in/) with Laravel 5.3.+
+This package makes it easy to send notifications using [textlocal](https://www.textlocal.in/) with Laravel 5.5+ & 6.x
+
+
+To use version ^2.3.0 onwards will require PHP 8.0
+
+for other PHP version use upto ^2.2.0
+
+## Contents
+
+- [Installation](#installation)
+	- [Setting up the textlocal service](#setting-up-the-textlocal-service)
+- [Usage](#usage)
+	- [Available Message methods](#available-message-methods)
+- [Changelog](#changelog)
+- [Testing](#testing)
+- [Security](#security)
+- [Contributing](#contributing)
+- [Credits](#credits)
+- [License](#license)
+
+
+## Installation
+
+Create an account in textlocal then create an API key or hash(password).
+
+`composer require msonowal/laravel-notification-channel-textlocal`
+
+### Setting up the textlocal service
+
+default config `textlocal.php` update where desired
+
+Important Either specify a Key OR a Hash - don't enter both!
+
+```
+return [
+	'username'  => env('TEXTLOCAL_USERNAME'),
+	'password'  => env('TEXTLOCAL_PASSWORD'),
+	'hash'      => env('TEXTLOCAL_HASH'),  //optional if api_key is set
+	'api_key'   => env('TEXTLOCAL_API_KEY'), //optional if hash is set
+	'sender'    => env('TEXTLOCAL_SENDER'),
+	'request_urls' => [
+		'IN' => 'https://api.textlocal.in/',
+		'UK' => 'https://api.txtlocal.com/'
+	],
+	'country'   => env('TEXTLOCAL_COUNTRY', 'IN'),
+    'extra' => [
+        // extra config define keys as desired for use within the textlocal client config
+        // if you want to use the custom client config for each notification or notifiable 
+        // INotificationUsesTextlocalClientConfig
+    ]public function getSenderId($notifiable)
+### Configuring .env
+```
+    TEXTLOCAL_USERNAME=Your email id or api key
+    TEXTLOCAL_HASH=get it from url '/docs/' under your API KEYS section
+    TEXTLOCAL_API_KEY get it from url '/docs/' under your API KEYS section
+    TEXTLOCAL_SENDER=Name of the Sender that will be displayed to the recipient (max 6 Characters).
+    TEXTLOCAL_COUNTRY=Your Two letter(ISO-3166-alpha-2) Country Code. It should be the Country of the TEXTLOCAL account. defaults to IN
+```
+
+### Publish Config
+```
+    php artisan vendor:publish --tag=textlocal
+```
+
+Currently, only textlocal of two country is supported IN(India) and UK(United Kingdom). 
+
+## Usage
+
+Implement this method `routeNotificationForTextlocal()` in your notifiable class/model which will return array of mobile numbers. Please make sure the mobile number contains the dial code as well (e.g +91 for India). And lastly implement `toSms()` method in the notification class which will return the (string) sms or template that is defined in textlocal account that needs to be send.
+
+
+## Usage
+
+You can use the channel in your `via()` method inside the notification:
+
+```php
+use Illuminate\Notifications\Notification;
+use NotificationChannels\Textlocal\TextlocalChannel;
+
+class TestOTPNotification extends Notification
+{
+    public function via($notifiable)
+    {
+        return [TextlocalChannel::class];
+    }
+
+    public function toSms($notifiable)
+    {
+        return 'Use 1234 as OTP for resetting your password.';
+    }
+}
+```
+
+In your notifiable model, make sure to include a `routeNotificationForTextlocal()` method, which returns a phone number or multiple numbers in array
+or an array of phone numbers.
+
+```php
+public function routeNotificationForTextlocal(): array
+{
+    return [$this->mobile_no];
+}
+```
+
+Annoynmous Notifable when say mobile no is not added to a notifiable model you can directly send to mobile no by using that
+
+```php
+Notification::route('Textlocal', $mobileNo')->notify(new VerifyMobileNotification($otp));
+```
+
+### Available Message methods
+
+And if you want to have a specific sender based on Notification, e.g. like you are sending promotional notification using one and another for transaction then you can just define this method in your notification class which will return your sender id for that notification only
+```
+public function getSenderId($notifiable)
+{
+     return 'YOUR_SENDER_ID';
+}
+```
+
+
+Unicode support
+If you want to send the notification content to have unicode support. Define this method in your notification which will return boolean based on which the sms will set the unicode mode in textlocal API
+```
+public function getUnicodeMode()
+{
+     return true;
+}
+```
+
+A list of all available options
+
+## Changelog
+
+Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
+
+## Testing
+
+``` bash
+$ composer test
+```
+
+## Security
+
+If you discover any security related issues, please email [email protected] instead of using the issue tracker.
+
+# Found any bugs or improvement open an issue or send me a PR
+
+## Contributing
+
+Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
+
+## Credits
+
+- [Manash Jyoti Sonowal](https://github.com/msonowal)
+- [Mr Ejang](https://github.com/tomonsoejang)
+- [Sinadh](https://github.com/tsainadh)
+- [All Contributors](../../contributors)
+
+## License
+
+The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
+
+## TODO
+Need to convert to Guzzle Http as a Client in core
+Add more countries
+add tests
diff --git a/composer.json b/composer.json
@@ -0,0 +1,47 @@
+{
+    "name": "msonowal/laravel-notification-channel-textlocal",
+    "description": "Textlocal Notifications Channel for Laravel",
+    "homepage": "https://github.com/laravel-notification-channels/textlocal",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Manash Jyoti Sonowal",
+            "email": "[email protected]",
+            "homepage": "https://github.com/msonowal",
+            "role": "Developer"
+        }
+    ],
+    "require": {
+        "php": ">=7.0",
+        "ext-json": "*",
+        "illuminate/notifications": "~5.5|~6.0|~7.0|~8.0|~9.0|~10.0|~11.0",
+        "illuminate/support": "~5.5|~6.0|~7.0|~8.0|~9.0|~10.0|~11.0"
+    },
+    "require-dev": {
+        "mockery/mockery": "^0.9.5|^1.0",
+        "phpunit/phpunit": "~5|^8.0|^9.0|^10.0|~11.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "NotificationChannels\\Textlocal\\": "src"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "NotificationChannels\\Textlocal\\Test\\": "tests"
+        }
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "NotificationChannels\\Textlocal\\TextlocalServiceProvider"
+            ]
+        }
+    },
+    "scripts": {
+        "test": "vendor/bin/phpunit"
+    },
+    "config": {
+        "sort-packages": true
+    }
+}
diff --git a/config/textlocal.php b/config/textlocal.php
@@ -0,0 +1,26 @@
+<?php
+
+return [
+    'username' => env('TEXTLOCAL_USERNAME'),
+    'password' => env('TEXTLOCAL_PASSWORD'),
+    'hash' => env('TEXTLOCAL_HASH'),
+    'api_key' => env('TEXTLOCAL_API_KEY'),
+    'sender' => env('TEXTLOCAL_SENDER', 'DOCONL'),
+    'request_urls' => [
+        'IN' => 'https://api.textlocal.in/',
+        'UK' => 'https://api.txtlocal.com/',
+    ],
+    'country' => env('TEXTLOCAL_COUNTRY', 'IN'),
+    /*
+    // a sample way to organize custom config when using mutliple on demand config
+    // uncomment this for that purpose or feel free to use your own implementations
+    'UK' => [
+        'username' => env('TEXTLOCAL_USERNAME_UK'),
+        'password' => env('TEXTLOCAL_PASSWORD_UK'),
+        'hash' => env('TEXTLOCAL_HASH_UK'),
+        'api_key' => env('TEXTLOCAL_API_KEY_UK'),
+        'sender' => env('TEXTLOCAL_SENDER_UK', 'DOCONL'),
+        'country' => env('TEXTLOCAL_COUNTRY_UK', 'UK'),
+    ],
+    */
+];
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit bootstrap="vendor/autoload.php"
+         backupGlobals="false"
+         backupStaticAttributes="false"
+         colors="true"
+         verbose="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="false"
+         stopOnFailure="false">
+    <testsuites>
+        <testsuite name=":service_name Test Suite">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist>
+            <directory suffix=".php">src/</directory>
+        </whitelist>
+    </filter>
+    <logging>
+        <log type="tap" target="build/report.tap"/>
+        <log type="junit" target="build/report.junit.xml"/>
+        <log type="coverage-html" target="build/coverage"/>
+        <log type="coverage-text" target="build/coverage.txt"/>
+        <log type="coverage-clover" target="build/logs/clover.xml"/>
+    </logging>
+</phpunit>