Base architecture

.github/ISSUE_TEMPLATE/bug.yaml

@@ -0,0 +1,75 @@
+name: "🐛 Bug Report"
+description: "Submit a bug report to help us improve"
+title: "🐛 Bug Report: "
+labels: [bug]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out our bug report form 🙏
+  - type: textarea
+    id: steps-to-reproduce
+    validations:
+      required: true
+    attributes:
+      label: "👟 Reproduction steps"
+      description: "How do you trigger this bug? Please walk us through it step by step."
+      placeholder: "When I ..."
+  - type: textarea
+    id: expected-behavior
+    validations:
+      required: true
+    attributes:
+      label: "👍 Expected behavior"
+      description: "What did you think would happen?"
+      placeholder: "It should ..."
+  - type: textarea
+    id: actual-behavior
+    validations:
+      required: true
+    attributes:
+      label: "👎 Actual Behavior"
+      description: "What did actually happen? Add screenshots, if applicable."
+      placeholder: "It actually ..."
+  - type: textarea
+    id: version
+    attributes:
+      label: "🎲 Version"
+      description: "What version of are you running?"
+    validations:
+      required: true
+  - type: dropdown
+    id: operating-system
+    attributes:
+      label: "💻 Operating system"
+      description: "What OS is your server / device running on?"
+      options:
+        - Linux
+        - MacOS
+        - Windows
+        - Something else
+    validations:
+      required: true
+  - type: textarea
+    id: environment
+    validations:
+      required: false
+    attributes:
+      label: "🧱 Your Environment"
+      description: "Is your environment customized in any way?"
+      placeholder: "I use Cloudflare for ..."
+  - type: checkboxes
+    id: no-duplicate-issues
+    attributes:
+      label: "👀 Have you spent some time to check if this issue has been raised before?"
+      description: "Have you Googled for a similar issue or checked our older issues for a similar bug?"
+      options:
+        - label: "I checked and didn't find similar issue"
+          required: true
+  - type: checkboxes
+    id: read-code-of-conduct
+    attributes:
+      label: "🏢 Have you read the Code of Conduct?"
+      options:
+        - label: "I have read the [Code of Conduct](https://github.com/utopia-php/messaging/blob/HEAD/CODE_OF_CONDUCT.md)"
+          required: true

.github/ISSUE_TEMPLATE/documentation.yaml

@@ -0,0 +1,32 @@
+name: "📚 Documentation"
+description: "Report an issue related to documentation"
+title: "📚 Documentation: "
+labels: [documentation]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to make our documentation better 🙏
+  - type: textarea
+    id: issue-description
+    validations:
+      required: true
+    attributes:
+      label: "💭 Description"
+      description: "A clear and concise description of what the issue is."
+      placeholder: "Documentation should not ..."
+  - type: checkboxes
+    id: no-duplicate-issues
+    attributes:
+      label: "👀 Have you spent some time to check if this issue has been raised before?"
+      description: "Have you Googled for a similar issue or checked our older issues for a similar bug?"
+      options:
+        - label: "I checked and didn't find similar issue"
+          required: true
+  - type: checkboxes
+    id: read-code-of-conduct
+    attributes:
+      label: "🏢 Have you read the Code of Conduct?"
+      options:
+        - label: "I have read the [Code of Conduct](https://github.com/utopia-php/messaging/blob/HEAD/CODE_OF_CONDUCT.md)"
+          required: true

.github/ISSUE_TEMPLATE/feature.yaml

@@ -0,0 +1,40 @@
+name: 🚀 Feature
+description: "Submit a proposal for a new feature"
+title: "🚀 Feature: "
+labels: [feature]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out our feature request form 🙏
+  - type: textarea
+    id: feature-description
+    validations:
+      required: true
+    attributes:
+      label: "🔖 Feature description"
+      description: "A clear and concise description of what the feature is."
+      placeholder: "You should add ..."
+  - type: textarea
+    id: pitch
+    validations:
+      required: true
+    attributes:
+      label: "🎤 Pitch"
+      description: "Please explain why this feature should be implemented and how it would be used. Add examples, if applicable."
+      placeholder: "In my use-case, ..."
+  - type: checkboxes
+    id: no-duplicate-issues
+    attributes:
+      label: "👀 Have you spent some time to check if this issue has been raised before?"
+      description: "Have you Googled for a similar issue or checked our older issues for a similar bug?"
+      options:
+        - label: "I checked and didn't find similar issue"
+          required: true
+  - type: checkboxes
+    id: read-code-of-conduct
+    attributes:
+      label: "🏢 Have you read the Code of Conduct?"
+      options:
+        - label: "I have read the [Code of Conduct](https://github.com/utopia-php/messaging/blob/HEAD/CODE_OF_CONDUCT.md)"
+          required: true

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,26 @@
+<!--
+Thank you for sending the PR! We appreciate you spending the time to work on these changes.
+
+Help us understand your motivation by explaining why you decided to make this change.
+
+You can learn more about contributing to appwrite here: https://github.com/utopia-php/messaging/blob/master/CONTRIBUTING.md
+
+Happy contributing!
+
+-->
+
+## What does this PR do?
+
+(Provide a description of what this PR does.)
+
+## Test Plan
+
+(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work.)
+
+## Related PRs and Issues
+
+(If this PR is related to any other PR or resolves any issue or related to any issue link all related PR and issues here.)
+
+### Have you read the [Contributing Guidelines on issues](https://github.com/utopia-php/messaging/blob/master/CONTRIBUTING.md)?
+
+(Write your answer here.)

.github/workflows/linter.yml

@@ -0,0 +1,18 @@
+name: "Linter"
+
+on: [pull_request]
+jobs:
+  lint:
+    name: Linter
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+      with:
+        fetch-depth: 2
+    - run: git checkout HEAD^2
+    - name: Run Linter
+      run: |
+        docker run --rm -v $PWD:/app composer sh -c \
+        "composer install --profile --ignore-platform-reqs && composer lint"

.github/workflows/tests.yml

@@ -0,0 +1,19 @@
+name: "Tests"
+
+on: [pull_request]
+jobs:
+  tests:
+    name: Unit & E2E
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+      with:
+        fetch-depth: 2
+    - run: git checkout HEAD^2
+    - name: Run Tests
+      run: |
+        docker compose up -d --build
+        sleep 5
+        docker compose exec tests vendor/bin/phpunit

.gitignore

@@ -0,0 +1,3 @@
+.idea
+vendor
+.phpunit.result.cache

Dockerfile

@@ -0,0 +1,25 @@
+FROM composer:2.0 as composer
+
+ARG TESTING=false
+ENV TESTING=$TESTING
+
+WORKDIR /usr/local/src/
+
+COPY composer.lock /usr/local/src/
+COPY composer.json /usr/local/src/
+
+RUN composer install \
+    --ignore-platform-reqs \
+    --optimize-autoloader \
+    --no-plugins  \
+    --no-scripts \
+    --prefer-dist
+
+FROM php:8.0-cli-alpine
+
+WORKDIR /usr/local/src/
+
+COPY --from=composer /usr/local/src/vendor /usr/local/src/vendor
+COPY . /usr/local/src/
+
+CMD [ "tail", "-f", "/dev/null" ]

README.md

@@ -0,0 +1,147 @@
+# Utopia Messaging
+
+[![Build Status](https://travis-ci.org/utopia-php/abuse.svg?branch=master)](https://travis-ci.com/utopia-php/database)
+![Total Downloads](https://img.shields.io/packagist/dt/utopia-php/messaging.svg)
+[![Discord](https://img.shields.io/discord/564160730845151244?label=discord)](https://appwrite.io/discord)
+
+Utopia Messaging library is simple and lite library for sending messages using multiple messaging adapters. This library is aiming to be as simple and easy to learn and use. This library is maintained by the [Appwrite team](https://appwrite.io).
+
+Although this library is part of the [Utopia Framework](https://github.com/utopia-php/framework) project it is dependency free, and can be used as standalone with any other PHP project or framework.
+
+## Getting Started
+
+Install using composer:
+```bash
+composer require utopia-php/messaging
+```
+
+## Email
+
+```php
+<?php
+
+use \Utopia\Messaging\Messages\Email;
+use \Utopia\Messaging\Adapters\Email\SendGrid;
+use \Utopia\Messaging\Adapters\Email\Mailgun;
+
+$message = new Email(
+    to: ['[email protected]'],
+    subject: 'Hello World',
+    content: '<h1>Hello World</h1>'
+);
+
+$messaging = new Sendgrid('YOUR_API_KEY');
+$messaging->send($message);
+
+$messaging = new Mailgun('YOUR_API_KEY', 'YOUR_DOMAIN');
+$messaging->send($message);
+```
+
+## SMS
+
+```php
+<?php
+
+use \Utopia\Messaging\Messages\SMS;
+use \Utopia\Messaging\Adapters\SMS\Twilio;
+use \Utopia\Messaging\Adapters\SMS\Telesign;
+
+$message = new SMS(
+    to: ['+12025550139'],
+    content: 'Hello World'
+);
+
+$messaging = new Twilio('YOUR_ACCOUNT_SID', 'YOUR_AUTH_TOKEN');
+$messaging->send($message);
+
+$messaging = new Telesign('YOUR_USERNAME', 'YOUR_PASSWORD');
+$messaging->send($message);
+```
+
+## Push
+
+```php
+<?php
+
+use \Utopia\Messaging\Messages\Push;
+use \Utopia\Messaging\Adapters\Push\FCM;
+
+$message = new Push(
+    to: ['eyJhGc...ssw5c'],
+    content: 'Hello World'
+);
+
+$messaging = new FCM('YOUR_SERVER_KEY');
+$messaging->send($message);
+```
+
+## Adapters
+
+> Want to implement any of the missing adapters or have an idea for another? We would love to hear from you! Please check out our [contribution guide](./CONTRIBUTING.md) and [new adapter guide](./docs/add-new-adapter.md) for more information.
+
+### Email
+- [x] [SendGrid](https://sendgrid.com/)
+- [x] [Mailgun](https://www.mailgun.com/)
+- [ ] [Mailjet](https://www.mailjet.com/)
+- [ ] [Mailchimp](https://www.mailchimp.com/)
+- [ ] [Postmark](https://postmarkapp.com/)
+- [ ] [SparkPost](https://www.sparkpost.com/)
+- [ ] [SendinBlue](https://www.sendinblue.com/)
+- [ ] [MailSlurp](https://www.mailslurp.com/)
+- [ ] [ElasticEmail](https://elasticemail.com/)
+- [ ] [SES](https://aws.amazon.com/ses/)
+
+### SMS
+- [x] [Twilio](https://www.twilio.com/)
+- [x] [Twilio Notify](https://www.twilio.com/notify)
+- [x] [Telesign](https://www.telesign.com/)
+- [x] [TextMagic](https://www.textmagic.com/)
+- [x] [Msg91](https://msg91.com/)
+- [x] [Vonage](https://www.vonage.com/)
+- [ ] [Plivo](https://www.plivo.com/)
+- [ ] [Infobip](https://www.infobip.com/)
+- [ ] [Clickatell](https://www.clickatell.com/)
+- [ ] [AfricasTalking](https://africastalking.com/)
+- [ ] [Sinch](https://www.sinch.com/)
+- [ ] [Sms77](https://www.sms77.io/)
+- [ ] [SmsGlobal](https://www.smsglobal.com/)
+
+### Push
+- [x] [FCM](https://firebase.google.com/docs/cloud-messaging)
+- [ ] [APNS](https://developer.apple.com/documentation/usernotifications)
+- [ ] [OneSignal](https://onesignal.com/)
+- [ ] [Pusher](https://pusher.com/)
+- [ ] [WebPush](https://developer.mozilla.org/en-US/docs/Web/API/Push_API)
+- [ ] [UrbanAirship](https://www.urbanairship.com/)
+- [ ] [Pushwoosh](https://www.pushwoosh.com/)
+- [ ] [PushBullet](https://www.pushbullet.com/)
+- [ ] [Pushy](https://pushy.me/)
+
+## System Requirements
+
+Utopia Messaging requires PHP 8.0 or later. We recommend using the latest PHP version whenever possible.
+
+## Tests
+
+To run all unit tests, use the following Docker command:
+
+```bash
+composer test
+```
+
+To run static code analysis, use the following Psalm command:
+
+```bash
+composer lint
+```
+
+## Authors
+
+**Jake Barnby**
+
++ [https://github.com/abnegate](https://github.com/abnegate)
++ [https://nz.linkedin.com/in/jakebarnby](https://nz.linkedin.com/in/jakebarnby)
+
+## Copyright and license
+
+The MIT License (MIT) [http://www.opensource.org/licenses/mit-license.php](http://www.opensource.org/licenses/mit-license.php)