refactored some constants for outer access and done some cleanup

Author: matthiez

README.md

@@ -1,12 +1,5 @@
-<p align='center'>
-    <img
-         width="400" 
-         height="79" 
-         src="https://www.sms77.io/wp-content/uploads/2019/07/sms77-Logo-400x79.png" alt="sms77io Logo"
-      />
-</p>
-
-<h1 align='center'>sms77io PHP API Client</h1>
+![](https://www.sms77.io/wp-content/uploads/2019/07/sms77-Logo-400x79.png "Sms77.io Logo")
+#sms77io PHP API Client
 
 ## Installation
 
@@ -21,7 +14,16 @@ $client = new Client('MYVERYSECRETAPIKEY1234!?');
 $client->sms('+4901234567890', 'HI2U');
 ```
 
-#### Implemented Endpoints
+#### Tests
+Some basic tests are implemented. Run them like this:
+```shell script
+SMS77_API_KEY= SMS77_RECIPIENT= SMS77_MSG_ID= php vendor/bin/phpunit tests/Client
+```
+Make sure to fill in the values.
+SMS77_MSG_ID refers to a message ID sent from this particular API key.
+SMS77_RECIPIENT is the recipient of the test SMS.
+
+##### Implemented Endpoints
 
 - sms
 - status

src/Client.php

@@ -10,29 +10,45 @@
 use Sms77\Api\Validator\ValidateForVoiceValidator;
 use Sms77\Api\Validator\VoiceValidator;
 
-class Client
-{
+class Client {
+    const BASE_URI = 'https://gateway.sms77.io/api';
     /* @var string $apiKey */
     private $apiKey;
-
     /* @var string $sendWith */
     private $sendWith;
 
-    const BASE_URI = 'https://gateway.sms77.io/api';
-
-    public function __construct($apiKey, $sendWith = 'php-api')
-    {
+    public function __construct($apiKey, $sendWith = 'php-api') {
         $this->apiKey = $apiKey;
         $this->sendWith = $sendWith;
     }
 
-    public function balance()
-    {
+    public function balance() {
         return $this->request('balance', $this->buildOptions([]));
     }
 
-    public function contacts($action, array $extra = [])
-    {
+    private function request($path, $options = []) {
+        $curl_get_contents = static function($url) {
+            $ch = curl_init();
+            curl_setopt($ch, CURLOPT_URL, $url);
+            curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
+            $output = curl_exec($ch);
+            curl_close($ch);
+            return $output;
+        };
+
+        return $curl_get_contents(self::BASE_URI . '/' . $path . '?' . http_build_query($options));
+    }
+
+    private function buildOptions(array $required, array $extra = []) {
+        $required = array_merge($required, [
+            'p' => $this->apiKey,
+            'sendwith' => '' === $this->sendWith ? 'unknown' : $this->sendWith,
+        ]);
+
+        return array_merge($required, $extra);
+    }
+
+    public function contacts($action, array $extra = []) {
         $options = $this->buildOptions([
             'action' => $action,
         ], $extra);
@@ -42,8 +58,7 @@ public function contacts($action, array $extra = [])
         return $this->request('contacts', $options);
     }
 
-    public function lookup($type, $number, array $extra = [])
-    {
+    public function lookup($type, $number, array $extra = []) {
         $options = $this->buildOptions([
             'type' => $type,
             'number' => $number,
@@ -54,29 +69,26 @@ public function lookup($type, $number, array $extra = [])
         return $this->request('lookup', $options);
     }
 
-    public function pricing(array $extra = [])
-    {
+    public function pricing(array $extra = []) {
         $options = $this->buildOptions([], $extra);
 
         (new PricingValidator($options))->validate();
 
         return $this->request('pricing', $options);
     }
 
-    public function sms($to, $text, array $extra = [])
-    {
+    public function sms($to, $text, array $extra = []) {
         $options = $this->buildOptions([
             'to' => $to,
-            'text' => $text
+            'text' => $text,
         ], $extra);
 
         (new SmsValidator($options))->validate();
 
         return $this->request('sms', $options);
     }
 
-    public function status($msgId)
-    {
+    public function status($msgId) {
         $options = $this->buildOptions([
             'msg_id' => $msgId,
         ]);
@@ -86,8 +98,7 @@ public function status($msgId)
         return $this->request('status', $options);
     }
 
-    public function validateForVoice($number, array $extra = [])
-    {
+    public function validateForVoice($number, array $extra = []) {
         $options = $this->buildOptions([
             'number' => $number,
         ], $extra);
@@ -97,39 +108,14 @@ public function validateForVoice($number, array $extra = [])
         return $this->request('validate_for_voice', $options);
     }
 
-    public function voice($to, $text, array $extra = [])
-    {
+    public function voice($to, $text, array $extra = []) {
         $options = $this->buildOptions([
             'to' => $to,
-            'text' => $text
+            'text' => $text,
         ], $extra);
 
         (new VoiceValidator($options))->validate();
 
         return $this->request('voice', $options);
     }
-
-    private function buildOptions(array $required, array $extra = [])
-    {
-        $required = array_merge($required, [
-            'p' => $this->apiKey,
-            'sendwith' => '' === $this->sendWith ? 'unknown' : $this->sendWith
-        ]);
-
-        return array_merge($required, $extra);
-    }
-
-    private function request($path, $options = [])
-    {
-        $curl_get_contents = static function ($url) {
-            $ch = curl_init();
-            curl_setopt($ch, CURLOPT_URL, $url);
-            curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
-            $output = curl_exec($ch);
-            curl_close($ch);
-            return $output;
-        };
-
-        return $curl_get_contents(self::BASE_URI . '/' . $path . '?' . http_build_query($options));
-    }
 }

src/Constant/MnpType.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Sms77\Api\Constant;
+
+use Sms77\Api\Reflectable;
+
+class MnpType {
+    use Reflectable;
+
+    const D1 = 'd1';
+    const D2 = 'd2';
+    const O2 = 'o2';
+    const Eplus = 'eplus';
+    const NotAvailable = 'N/A';
+    const Int = 'int';
+}

src/Constant/NetworkType.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Sms77\Api\Constant;
+
+use Sms77\Api\Reflectable;
+
+class NetworkType {
+    use Reflectable;
+
+    const FixedLine = 'fixed_line';
+    const FixedLineOrMobile = 'fixed_line_or_mobile';
+    const Mobile = 'mobile';
+    const Pager = 'pager';
+    const PersonalNumber = 'personal_number';
+    const PremiumRate = 'premium_rate';
+    const SharedCost = 'shared_cost';
+    const TollFree = 'toll_free';
+    const Uan = 'uan';
+    const Unknown = 'unknown';
+    const Voicemail = 'voicemail';
+    const Voip = 'voip';
+}

src/Constant/PortingStatus.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Sms77\Api\Constant;
+
+use Sms77\Api\Reflectable;
+
+class PortingStatus {
+    use Reflectable;
+
+    const Unknown = 'unknown';
+    const Ported = 'ported';
+    const NotPorted = 'not_ported';
+    const AssumedNotPorted = 'assumed_not_ported';
+    const AssumedPorted = 'assumed_ported';
+}

src/Constant/ReachableStatus.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Sms77\Api\Constant;
+
+use Sms77\Api\Reflectable;
+
+class ReachableStatus {
+    use Reflectable;
+
+    const Unknown = 'unknown';
+    const Reachable = 'reachable';
+    const Undeliverable = 'undeliverable';
+    const Absent = 'absent';
+    const BadNumber = 'bad_number';
+    const Blacklisted = 'blacklisted';
+}

src/Constant/RoamingStatus.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Sms77\Api\Constant;
+
+use Sms77\Api\Reflectable;
+
+class RoamingStatus {
+    use Reflectable;
+
+    const Unknown = 'unknown';
+    const Roaming = 'roaming';
+    const NotRoaming = 'not_roaming';
+}

src/SmsOptions.php renamed to src/Constant/SmsOptions.php

@@ -1,9 +1,12 @@
 <?php
 
-namespace Sms77\Api;
+namespace Sms77\Api\Constant;
+
+use Sms77\Api\Reflectable;
+
+class SmsOptions {
+    use Reflectable;
 
-abstract class SmsOptions
-{
     const Debug = 'debug';
     const Delay = 'delay';
     const Details = 'details';

src/Constant/SmsType.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace Sms77\Api\Constant;
+
+use Sms77\Api\Reflectable;
+
+class SmsType {
+    use Reflectable;
+
+    const Direct = 'direct';
+    const Economy = 'economy';
+}

src/Constant/StatusCode.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Sms77\Api\Constant;
+
+use Sms77\Api\Reflectable;
+
+class StatusCode {
+    use Reflectable;
+
+    const SmsCarrierTemporarilyUnavailable = 11;
+    const Sent = 100;
+    const SentPartially = 101;
+    const FromIsInvalid = 201;
+    const ToIsInvalid = 202;
+    const ToIsMissing = 301;
+    const TextIsMissing = 305;
+    const TextIsTooLong = 401;
+    const ReloadLockPrevention = 402;
+    const DailyNumberLimitReached = 403;
+    const NotEnoughCredits = 500;
+    const CarrierDeliveryFailed = 600;
+    const UnknownError = 700;
+    const AuthError = 900;
+    const HttpApiIsDisabled = 902;
+    const InvalidServerIp = 903;
+}

src/Constant/StatusMessage.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Sms77\Api\Constant;
+
+use Sms77\Api\Reflectable;
+
+class StatusMessage {
+    use Reflectable;
+
+    const Delivered = 'DELIVERED';
+    const NotDelivered = 'NOTDELIVERED';
+    const Buffered = 'BUFFERED';
+    const Transmitted = 'TRANSMITTED';
+    const Accepted = 'ACCEPTED';
+    const Expired = 'EXPIRED';
+    const Rejected = 'REJECTED';
+    const Failed = 'FAILED';
+    const Unknown = 'UNKNOWN';
+}