Smart SMS v1

.env.testing

@@ -0,0 +1 @@
+APP_ENV=development

.gitignore

@@ -0,0 +1,4 @@
+vendor
+.env
+composer.lock
+/.phpunit.result.cache

README.md

@@ -0,0 +1,100 @@
+# Orange SmartSMS API Client
+
+A PHP client to interact with the Orange SmartSMS API. This package allows you to send SMS messages, check their delivery status, and monitor API usage limits.
+
+## Features
+
+- Send SMS messages to various networks.
+- Check the delivery status of previously sent SMS messages.
+- Retrieve the usage limit and available requests for the SmartSMS API.
+
+## Installation
+
+1. Install via Composer:
+
+    ```bash
+    composer require kwarcek/orange-smartsms-api
+    ```
+
+## Usage
+
+### 1. Send an SMS Message
+
+You can send an SMS message by using the `sendSMS` method. The message will be delivered to the recipient's mobile phone.
+
+#### Example:
+
+```php
+use Kwarcek\OrangeSmartsmsApi\Requests\MessagingRequest;
+use Kwarcek\OrangeSmartsmsApi\DTO\SMSMessage;
+use GuzzleHttp\Client;
+
+$isDev = getenv('APP_ENV');
+
+// Create a new Guzzle client and MessagingRequest instance
+$client = new Client([
+    'base_uri' => $isDev ? 'https://apib2b-test.orange.pl/' : 'https://apib2b.orange.pl/',
+]);
+$apiKey = 'your-api-key-here';
+
+$messagingRequest = new MessagingRequest($client, $apiKey);
+
+// Define the SMS message
+$message = new SMSMessage([
+    'sender' => 'YourSenderID', 
+    'recipient' => '48510123456', // Recipient's phone number
+    'content' => 'Hello from Orange SmartSMS!',
+]);
+
+// Send the SMS
+$response = $messagingRequest->sendSMS($message, true);
+
+print_r($response);
+```
+
+### 2. Check SMS Delivery Status
+
+You can check the delivery status of a sent SMS by passing the unique ID returned in the sendSMS response.
+Example:
+
+```php
+use Kwarcek\OrangeSmartsmsApi\Requests\MessagingRequest;
+use GuzzleHttp\Client;
+
+$isDev = getenv('APP_ENV');
+
+$client = new Client([
+    'base_uri' => $isDev ? 'https://apib2b-test.orange.pl/' : 'https://apib2b.orange.pl/',
+]);
+$apiKey = 'your-api-key-here';
+
+$messagingRequest = new MessagingRequest($client, $apiKey);
+
+$id = '54510a5d0361'; // Example message ID
+$response = $messagingRequest->checkDeliveryStatus($id);
+
+print_r($response);
+```
+
+### 3. Check API Usage Limit
+
+You can check the current API usage limit for SmartSMS, including used and available requests.
+Example:
+
+```php
+use Kwarcek\OrangeSmartsmsApi\Requests\MessagingRequest;
+use GuzzleHttp\Client;
+
+$isDev = getenv('APP_ENV');
+
+$client = new Client([
+    'base_uri' => $isDev ? 'https://apib2b-test.orange.pl/' : 'https://apib2b.orange.pl/',
+]);
+$apiKey = 'your-api-key-here';
+
+$messagingRequest = new MessagingRequest($client, $apiKey);
+
+$response = $messagingRequest->checkLimit();
+
+print_r($response);
+```

composer.json

@@ -0,0 +1,26 @@
+{
+  "name": "kwarcek/smart-sms-api",
+  "description": "A PHP API client for Orange SmartSMS service.",
+  "type": "library",
+  "version": "1.0.0",
+  "require": {
+    "php": "^8.2",
+    "guzzlehttp/guzzle": "^7.0"
+  },
+  "require-dev": {
+    "phpunit/phpunit": "^9.0"
+  },
+  "autoload": {
+    "psr-4": {
+      "Kwarcek\\OrangeSmartsmsApi\\":"src/"
+    }
+  },
+  "autoload-dev": {
+    "psr-4": {
+      "Kwarcek\\OrangeSmartsmsApi\\Test\\": "tests"
+    }
+  },
+  "scripts": {
+    "test": "phpunit"
+  }
+}

docker-compose.yml

@@ -0,0 +1,11 @@
+services:
+  php:
+    container_name: orange-smartsms-api
+    build:
+      context: .
+      dockerfile: docker/Dockerfile
+    env_file:
+      - .env
+    tty: true
+    volumes:
+      - ./:/app

docker/Dockerfile

@@ -0,0 +1,20 @@
+FROM php:8.1
+
+WORKDIR /app
+
+COPY . .
+
+RUN apt-get update -y && \
+    apt-get install git -y
+
+RUN apt-get update && \
+    apt-get install -y libpq-dev       \
+            unzip                      \
+            zlib1g-dev                 \
+            zlib1g-dev                 \
+            zip                        \
+            --no-install-recommends
+
+RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
+
+CMD /bin/bash

phpunit.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+
+<phpunit bootstrap="vendor/autoload.php">
+    <testsuites>
+        <testsuite name="Unit">
+            <directory suffix="Test.php">./tests</directory>
+        </testsuite>
+    </testsuites>
+    <coverage cacheDirectory=".phpunit.cache/code-coverage"
+              processUncoveredFiles="true">
+    </coverage>
+    <php>
+        <server name="APP_ENV" value="development"/>
+    </php>
+</phpunit>

src/DTO/SMSMessage.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace Kwarcek\OrangeSmartsmsApi\DTO;
+
+class SMSMessage
+{
+    public function __construct(
+        public string $sender,
+        public string $recipient,
+        public string $content
+    )
+    {
+    }
+}

src/Exceptions/BadRequestException.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Kwarcek\OrangeSmartsmsApi\Exceptions;
+
+class BadRequestException extends Exception
+{
+
+}

src/Exceptions/Exception.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Kwarcek\OrangeSmartsmsApi\Exceptions;
+
+class Exception extends \Exception
+{
+
+}

src/Exceptions/ForbiddenException.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Kwarcek\OrangeSmartsmsApi\Exceptions;
+
+class ForbiddenException extends Exception
+{
+
+}

src/Exceptions/InternalServerException.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Kwarcek\OrangeSmartsmsApi\Exceptions;
+
+class InternalServerException extends Exception
+{
+
+}

src/Exceptions/NotFoundException.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Kwarcek\OrangeSmartsmsApi\Exceptions;
+
+class NotFoundException extends Exception
+{
+
+}

src/Exceptions/UnathorizedException.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Kwarcek\OrangeSmartsmsApi\Exceptions;
+
+class UnathorizedException extends Exception
+{
+
+}