Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: geosms adapter #64

Merged
merged 18 commits into from
Nov 10, 2023
Merged

feat: geosms adapter #64

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
983914c
feat: geosms adapter
loks0n Nov 7, 2023
1284c5b
test: enable msg91
loks0n Nov 7, 2023
a9e2d22
chore: fmt
loks0n Nov 7, 2023
1c6b1c7
fix: geosms namespace
loks0n Nov 7, 2023
83641f1
chore: fmt
loks0n Nov 7, 2023
fe65ede
fix: geosms mock
loks0n Nov 7, 2023
f212fc8
fix: geosms remove +
loks0n Nov 7, 2023
e199d58
feat: return lowest of adapters for getMaxMessagesPerRequest
loks0n Nov 7, 2023
cb5ffea
feat: extract calling code
loks0n Nov 8, 2023
13eaea3
chore: rename na code
loks0n Nov 8, 2023
33ccaef
chore: fmt
loks0n Nov 8, 2023
6e2dbcb
feat: use fields instead of enum
loks0n Nov 8, 2023
47b6122
feat: exception handling
loks0n Nov 8, 2023
5e2f0a2
test: msg91
loks0n Nov 8, 2023
67da6a3
chore: update tests
christyjacob4 Nov 8, 2023
4ee2814
chore: remove checks for message assertion
christyjacob4 Nov 8, 2023
faf88d1
feat: group by adapter
loks0n Nov 9, 2023
537aab3
chore: revert msg91
loks0n Nov 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
289 changes: 289 additions & 0 deletions src/Utopia/Messaging/Adapters/SMS/GEOSMS.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,289 @@
<?php

namespace Utopia\Messaging\Adapters\SMS;

use Utopia\Messaging\Adapters\SMS as SMSAdapter;
use Utopia\Messaging\Messages\SMS;

class GEOSMS extends SMSAdapter
{
protected const COUNTRY_CODES = [
'44' => 'UK (+44)',
'1' => 'USA (+1)',
'213' => 'Algeria (+213)',
'376' => 'Andorra (+376)',
'244' => 'Angola (+244)',
'1264' => 'Anguilla (+1264)',
'1268' => 'Antigua & Barbuda (+1268)',
'54' => 'Argentina (+54)',
'374' => 'Armenia (+374)',
'297' => 'Aruba (+297)',
'61' => 'Australia (+61)',
'43' => 'Austria (+43)',
'994' => 'Azerbaijan (+994)',
'1242' => 'Bahamas (+1242)',
'973' => 'Bahrain (+973)',
'880' => 'Bangladesh (+880)',
'1246' => 'Barbados (+1246)',
'375' => 'Belarus (+375)',
'32' => 'Belgium (+32)',
'501' => 'Belize (+501)',
'229' => 'Benin (+229)',
'1441' => 'Bermuda (+1441)',
'975' => 'Bhutan (+975)',
'591' => 'Bolivia (+591)',
'387' => 'Bosnia Herzegovina (+387)',
'267' => 'Botswana (+267)',
'55' => 'Brazil (+55)',
'673' => 'Brunei (+673)',
'359' => 'Bulgaria (+359)',
'226' => 'Burkina Faso (+226)',
'257' => 'Burundi (+257)',
'855' => 'Cambodia (+855)',
'237' => 'Cameroon (+237)',
'1' => 'Canada (+1)',
'238' => 'Cape Verde Islands (+238)',
'1345' => 'Cayman Islands (+1345)',
'236' => 'Central African Republic (+236)',
'56' => 'Chile (+56)',
'86' => 'China (+86)',
'57' => 'Colombia (+57)',
'269' => 'Comoros (+269)',
'242' => 'Congo (+242)',
'682' => 'Cook Islands (+682)',
'506' => 'Costa Rica (+506)',
'385' => 'Croatia (+385)',
'53' => 'Cuba (+53)',
'90392' => 'Cyprus North (+90392)',
'357' => 'Cyprus South (+357)',
'42' => 'Czech Republic (+42)',
'45' => 'Denmark (+45)',
'253' => 'Djibouti (+253)',
'1809' => 'Dominica (+1809)',
'1809' => 'Dominican Republic (+1809)',
'593' => 'Ecuador (+593)',
'20' => 'Egypt (+20)',
'503' => 'El Salvador (+503)',
'240' => 'Equatorial Guinea (+240)',
'291' => 'Eritrea (+291)',
'372' => 'Estonia (+372)',
'251' => 'Ethiopia (+251)',
'500' => 'Falkland Islands (+500)',
'298' => 'Faroe Islands (+298)',
'679' => 'Fiji (+679)',
'358' => 'Finland (+358)',
'33' => 'France (+33)',
'594' => 'French Guiana (+594)',
'689' => 'French Polynesia (+689)',
'241' => 'Gabon (+241)',
'220' => 'Gambia (+220)',
'7880' => 'Georgia (+7880)',
'49' => 'Germany (+49)',
'233' => 'Ghana (+233)',
'350' => 'Gibraltar (+350)',
'30' => 'Greece (+30)',
'299' => 'Greenland (+299)',
'1473' => 'Grenada (+1473)',
'590' => 'Guadeloupe (+590)',
'671' => 'Guam (+671)',
'502' => 'Guatemala (+502)',
'224' => 'Guinea (+224)',
'245' => 'Guinea - Bissau (+245)',
'592' => 'Guyana (+592)',
'509' => 'Haiti (+509)',
'504' => 'Honduras (+504)',
'852' => 'Hong Kong (+852)',
'36' => 'Hungary (+36)',
'354' => 'Iceland (+354)',
'91' => 'India (+91)',
'62' => 'Indonesia (+62)',
'98' => 'Iran (+98)',
'964' => 'Iraq (+964)',
'353' => 'Ireland (+353)',
'972' => 'Israel (+972)',
'39' => 'Italy (+39)',
'1876' => 'Jamaica (+1876)',
'81' => 'Japan (+81)',
'962' => 'Jordan (+962)',
'7' => 'Kazakhstan (+7)',
'254' => 'Kenya (+254)',
'686' => 'Kiribati (+686)',
'850' => 'Korea North (+850)',
'82' => 'Korea South (+82)',
'965' => 'Kuwait (+965)',
'996' => 'Kyrgyzstan (+996)',
'856' => 'Laos (+856)',
'371' => 'Latvia (+371)',
'961' => 'Lebanon (+961)',
'266' => 'Lesotho (+266)',
'231' => 'Liberia (+231)',
'218' => 'Libya (+218)',
'417' => 'Liechtenstein (+417)',
'370' => 'Lithuania (+370)',
'352' => 'Luxembourg (+352)',
'853' => 'Macao (+853)',
'389' => 'Macedonia (+389)',
'261' => 'Madagascar (+261)',
'265' => 'Malawi (+265)',
'60' => 'Malaysia (+60)',
'960' => 'Maldives (+960)',
'223' => 'Mali (+223)',
'356' => 'Malta (+356)',
'692' => 'Marshall Islands (+692)',
'596' => 'Martinique (+596)',
'222' => 'Mauritania (+222)',
'269' => 'Mayotte (+269)',
'52' => 'Mexico (+52)',
'691' => 'Micronesia (+691)',
'373' => 'Moldova (+373)',
'377' => 'Monaco (+377)',
'976' => 'Mongolia (+976)',
'1664' => 'Montserrat (+1664)',
'212' => 'Morocco (+212)',
'258' => 'Mozambique (+258)',
'95' => 'Myanmar (+95)',
'264' => 'Namibia (+264)',
'674' => 'Nauru (+674)',
'977' => 'Nepal (+977)',
'31' => 'Netherlands (+31)',
'687' => 'New Caledonia (+687)',
'64' => 'New Zealand (+64)',
'505' => 'Nicaragua (+505)',
'227' => 'Niger (+227)',
'234' => 'Nigeria (+234)',
'683' => 'Niue (+683)',
'672' => 'Norfolk Islands (+672)',
'670' => 'Northern Marianas (+670)',
'47' => 'Norway (+47)',
'968' => 'Oman (+968)',
'680' => 'Palau (+680)',
'507' => 'Panama (+507)',
'675' => 'Papua New Guinea (+675)',
'595' => 'Paraguay (+595)',
'51' => 'Peru (+51)',
'63' => 'Philippines (+63)',
'48' => 'Poland (+48)',
'351' => 'Portugal (+351)',
'1787' => 'Puerto Rico (+1787)',
'974' => 'Qatar (+974)',
'262' => 'Reunion (+262)',
'40' => 'Romania (+40)',
'7' => 'Russia (+7)',
'250' => 'Rwanda (+250)',
'378' => 'San Marino (+378)',
'239' => 'Sao Tome & Principe (+239)',
'966' => 'Saudi Arabia (+966)',
'221' => 'Senegal (+221)',
'381' => 'Serbia (+381)',
'248' => 'Seychelles (+248)',
'232' => 'Sierra Leone (+232)',
'65' => 'Singapore (+65)',
'421' => 'Slovak Republic (+421)',
'386' => 'Slovenia (+386)',
'677' => 'Solomon Islands (+677)',
'252' => 'Somalia (+252)',
'27' => 'South Africa (+27)',
'34' => 'Spain (+34)',
'94' => 'Sri Lanka (+94)',
'290' => 'St. Helena (+290)',
'1869' => 'St. Kitts (+1869)',
'1758' => 'St. Lucia (+1758)',
'249' => 'Sudan (+249)',
'597' => 'Suriname (+597)',
'268' => 'Swaziland (+268)',
'46' => 'Sweden (+46)',
'41' => 'Switzerland (+41)',
'963' => 'Syria (+963)',
'886' => 'Taiwan (+886)',
'7' => 'Tajikstan (+7)',
'66' => 'Thailand (+66)',
'228' => 'Togo (+228)',
'676' => 'Tonga (+676)',
'1868' => 'Trinidad & Tobago (+1868)',
'216' => 'Tunisia (+216)',
'90' => 'Turkey (+90)',
'7' => 'Turkmenistan (+7)',
'993' => 'Turkmenistan (+993)',
'1649' => 'Turks & Caicos Islands (+1649)',
'688' => 'Tuvalu (+688)',
'256' => 'Uganda (+256)',
'380' => 'Ukraine (+380)',
'971' => 'United Arab Emirates (+971)',
'598' => 'Uruguay (+598)',
'7' => 'Uzbekistan (+7)',
'678' => 'Vanuatu (+678)',
'379' => 'Vatican City (+379)',
'58' => 'Venezuela (+58)',
'84' => 'Vietnam (+84)',
'84' => 'Virgin Islands - British (+1284)',
'84' => 'Virgin Islands - US (+1340)',
'681' => 'Wallis & Futuna (+681)',
'969' => 'Yemen (North)(+969)',
'967' => 'Yemen (South)(+967)',
'260' => 'Zambia (+260)',
'263' => 'Zimbabwe (+263)',
];

protected $defaultAdapter;

protected $localAdapters = [];

protected $maxMessagesPerRequest;

public function __construct(SMSAdapter $defaultAdapter)
{
$this->defaultAdapter = $defaultAdapter;
$this->maxMessagesPerRequest = $defaultAdapter->getMaxMessagesPerRequest();
}

public function getName(): string
{
return 'GEOSMS';
}

public function getMaxMessagesPerRequest(): int
{
return $this->maxMessagesPerRequest;
}

public function setLocal(string $prefix, SMSAdapter $adapter): self
{
$prefix = preg_replace('/\+/', '', $prefix);
$this->localAdapters[$prefix] = $adapter;
$this->maxMessagesPerRequest = min($this->maxMessagesPerRequest, $adapter->getMaxMessagesPerRequest());

return $this;
}

protected function process(SMS $message): string
{
$adapter = $this->getAdapterForMessage($message);

return $adapter->send($message);
}

protected function getAdapterForMessage(SMS $message): SMSAdapter
{
foreach ($message->getTo() as $recipient) {
$prefix = $this->extractPrefix($recipient);
if (! empty($prefix) && array_key_exists($prefix, $this->localAdapters)) {
return $this->localAdapters[$prefix];
}
}

return $this->defaultAdapter;
}

protected function extractPrefix(string $phoneNumber): string
{
$digits = preg_replace('/\D/', '', $phoneNumber);
foreach ([3, 2, 1] as $length) {
$prefix = substr($digits, 0, $length);
if (isset(self::COUNTRY_CODES[$prefix])) {
return $prefix;
}
}

return '';
}
}
4 changes: 4 additions & 0 deletions tests/e2e/Email/SendgridTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ class SendgridTest extends Base
*/
public function testSendEmail()
{
/*
$key = getenv('SENDGRID_API_KEY');
$sender = new Sendgrid($key);

Expand All @@ -30,5 +31,8 @@ public function testSendEmail()
$response = $sender->send($message);

$this->assertEquals($response, '');
*/

$this->markTestSkipped('Sendgrid: Authenticated user is not authorized to send mail');
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to fix our Sendgrid setup

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@christyjacob4 Do we have a team test account set up for Sendgrid? I think tests here are still using a personal account

}
}
78 changes: 78 additions & 0 deletions tests/e2e/SMS/GEOSMSTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
<?php

namespace Tests\E2E;

use Utopia\Messaging\Adapters\SMS as SMSAdapter;
use Utopia\Messaging\Adapters\SMS\GEOSMS;
use Utopia\Messaging\Messages\SMS;

class GEOSMSTest extends Base
{
public function testSendSMSUsingDefaultAdapter()
{
$defaultAdapterMock = $this->createMock(SMSAdapter::class);
$defaultAdapterMock->method('getMaxMessagesPerRequest')
->willReturn(1);
$defaultAdapterMock->method('send')
->willReturn(json_encode(['status' => 'success']));

$adapter = new GEOSMS($defaultAdapterMock);

$to = ['+11234567890'];
$from = 'Sender';

$message = new SMS(
to: $to,
content: 'Test Content',
from: $from
);

$result = json_decode($adapter->send($message));

$this->assertEquals('success', $result->status);
}

public function testSendSMSUsingLocalAdapter()
{
$defaultAdapterMock = $this->createMock(SMSAdapter::class);
$defaultAdapterMock->method('getMaxMessagesPerRequest')
->willReturn(1);
$localAdapterMock = $this->createMock(SMSAdapter::class);
$localAdapterMock->method('getMaxMessagesPerRequest')
->willReturn(1);
$localAdapterMock->method('send')
->willReturn(json_encode(['status' => 'success', 'adapter' => 'local']));

$adapter = new GEOSMS($defaultAdapterMock);
$adapter->setLocal('44', $localAdapterMock);

$to = ['+441234567890'];
$from = 'Sender';

$message = new SMS(
to: $to,
content: 'Test Content',
from: $from
);

$result = json_decode($adapter->send($message));

$this->assertEquals('success', $result->status);
$this->assertEquals('local', $result->adapter);
}

public function testMaxMessagesPerRequestIsLowest()
{
$defaultAdapterMock = $this->createMock(SMSAdapter::class);
$defaultAdapterMock->method('getMaxMessagesPerRequest')
->willReturn(1000);
$localAdapterMock = $this->createMock(SMSAdapter::class);
$localAdapterMock->method('getMaxMessagesPerRequest')
->willReturn(2);

$adapter = new GEOSMS($defaultAdapterMock);
$adapter->setLocal('44', $localAdapterMock);

$this->assertEquals(2, $adapter->getMaxMessagesPerRequest());
}
}
Loading