first commit

Author: hebertcisco

.gitattributes

@@ -0,0 +1,15 @@
+*.sh linguist-vendored
+*.cache linguist-vendored
+*.xml linguist-vendored
+
+*.blade linguist-language=php
+*.neon linguist-language=php
+*.php linguist-language=php
+*.php5 linguist-language=php
+*.phtml linguist-language=php
+*.inc linguist-language=php
+*.module linguist-language=php
+*.install linguist-language=php
+*.profile linguist-language=php
+*.test linguist-language=php
+*.info linguist-language=php

.github/workflows/php.yml

@@ -0,0 +1,36 @@
+name: PHP Composer
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Validate composer.json and composer.lock
+      run: composer validate --strict
+
+    - name: Cache Composer packages
+      id: composer-cache
+      uses: actions/cache@v3
+      with:
+        path: vendor
+        key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-php-
+
+    - name: Install dependencies
+      run: composer install --prefer-dist --no-progress
+
+    - name: Run test suite
+      run: composer run-script test

.gitignore

@@ -0,0 +1,17 @@
+.env
+.idea
+vendor
+composer.lock
+composer.phar
+
+# phpunit
+*.cache
+
+# composer
+composer.phar
+/vendor/
+.phpunit.cache
+example.php
+logs/
+**.log
+package.xml

CONTRIBUTING.md

@@ -0,0 +1,22 @@
+# Contributing
+
+Contributions are **welcome** and will be fully **credited**.
+
+We accept contributions via Pull Requests on [GitHub](https://github.com/usevalid-email/php-sdk).
+
+## Pull Requests
+
+- **[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).
+- **Document any change in behaviour** - Make sure the README and any other relevant documentation are kept up-to-date.
+- **Create topic branches** - Don't ask us to pull from your master branch.
+- **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 before submitting.
+
+## Security
+
+If you discover any security related issues, please email [hebert@hotbrains.com.br](mailto:hebert@hotbrains.com.br) instead of using the issue tracker.
+
+## Credits
+
+- [Hebert Barros](https://github.com/hebertcisco)
+- [All Contributors](https://github.com/usevalid-email/php-sdk/graphs/contributors)

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 usevalid.email
+
+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.

README.md

@@ -0,0 +1,78 @@
+# usevalid.email
+
+[![Latest Version on Packagist](https://img.shields.io/packagist/v/usevalid-email/sdk.svg?style=flat-square)](https://packagist.org/packages/usevalid-email/sdk)
+[![Total Downloads](https://img.shields.io/packagist/dt/usevalid-email/sdk.svg?style=flat-square)](https://packagist.org/packages/usevalid-email/sdk)
+[![License](https://img.shields.io/packagist/l/usevalid-email/sdk.svg?style=flat-square)](https://packagist.org/packages/usevalid-email/sdk)
+
+Validate Your Emails with Confidence
+
+## Installation
+
+You can install the package via composer:
+
+```bash
+composer require usevalid-email/sdk
+```
+
+## Usage
+
+### Initialization
+
+```php
+use UseValidEmail\Sdk;
+
+$token = 'your-access-token';
+$sdk = new Sdk($token);
+```
+### Validate Email
+    
+```php
+use UseValidEmail\Sdk\Exceptions\AccessTokenException;
+use UseValidEmail\Sdk\Exceptions\ForbiddenException;
+use UseValidEmail\Sdk\Exceptions\UnauthorizedException;
+use GuzzleHttp\Exception\GuzzleException;
+
+try {
+    $email = 'example@example.com';
+    $response = $sdk->emailValidator->validate($email);
+    print_r($response->toArray());
+} catch (Exception $e) {
+    // Handle exception
+}
+```
+
+### Using Helper Function
+
+```php
+use GuzzleHttp\Exception\GuzzleException;
+use UseValidEmail\Sdk\Exceptions\AccessTokenException;
+use UseValidEmail\Sdk\Exceptions\ForbiddenException;
+use UseValidEmail\Sdk\Exceptions\UnauthorizedException;
+use UseValidEmail\Sdk\Responses\Validation\ValidationResponse;
+
+try {
+    $email = 'example@example.com';
+    $response = validateEmail($email);
+    print_r($response->toArray());
+} catch (Exception $e) {
+    // Handle exception
+}
+```
+## Testing
+
+```bash
+composer test
+```
+
+## Contributing
+
+Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
+
+## Credits
+
+- [Hebert Barros](https://github.com/hebertcisco)
+- [All Contributors](https://github.com/usevalid-email/php-sdk/graphs/contributors)
+
+## License
+
+The MIT License (MIT). Please see [License File](LICENSE) for more information.

composer.json

@@ -0,0 +1,55 @@
+{
+  "name": "usevalid-email/php-sdk",
+  "type": "library",
+  "description": "Validate Your Emails with Confidence",
+  "keywords": [
+    "email",
+    "validation",
+    "sdk",
+    "api",
+    "usevalid.email"
+  ],
+  "homepage": "https://usevalid.email",
+  "license": "MIT",
+  "authors": [
+    {
+      "name": "Contact",
+      "email": "contact@usevalid.email",
+      "homepage": "https://usevalid.email"
+    }
+  ],
+  "scripts": {
+    "test": "vendor/bin/pest",
+    "test:coverage": "vendor/bin/pest --coverage",
+    "test:unit": "vendor/bin/pest --testsuite=unit"
+  },
+  "require": {
+    "php": ">=7.4",
+    "localtools/php-http-client": "^0.0.1",
+    "ext-json": "*"
+  },
+  "require-dev": {
+    "pestphp/pest": "^3.2 || ^v3.5.1",
+    "laravel/pint": "^1.18",
+    "phpunit/phpunit": "^8.5.40 || ^11.4.3",
+    "mockery/mockery": "^1.6"
+  },
+  "autoload": {
+    "psr-4": {
+      "UseValidEmail\\Sdk\\": "src/"
+    },
+    "files": [
+      "src/Utils/helpers.php"
+    ]
+  },
+  "autoload-dev": {
+    "psr-4": {
+      "UseValidEmail\\Sdk\\Tests\\": "tests/"
+    }
+  },
+  "config": {
+    "allow-plugins": {
+      "pestphp/pest-plugin": true
+    }
+  }
+}

phpunit.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="./vendor/phpunit/phpunit/phpunit.xsd" bootstrap="vendor/autoload.php" colors="true" cacheDirectory=".phpunit.cache">
+  <testsuites>
+    <testsuite name="Test Suite">
+      <directory suffix="Test.php">./tests</directory>
+    </testsuite>
+  </testsuites>
+  <source>
+    <include>
+      <directory suffix=".php">./app</directory>
+      <directory suffix=".php">./src</directory>
+    </include>
+  </source>
+</phpunit>

src/Dtos/ValidateEmailDto.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace UseValidEmail\Sdk\Dtos;
+
+class ValidateEmailDto
+{
+    public string $email;
+
+    public function __construct(
+        string $email
+
+    ) {
+        $this->email = $email;
+    }
+
+    public function toArray(): array
+    {
+        return [
+            'email' => $this->email,
+        ];
+    }
+}

src/EmailValidator.php

@@ -0,0 +1,51 @@
+<?php
+
+namespace UseValidEmail\Sdk;
+
+use GuzzleHttp\Exception\GuzzleException;
+use UseValidEmail\Sdk\Dtos\ValidateEmailDto;
+use UseValidEmail\Sdk\Exceptions\ForbiddenException;
+use UseValidEmail\Sdk\Exceptions\UnauthorizedException;
+use UseValidEmail\Sdk\Requests\HttpClient;
+use UseValidEmail\Sdk\Responses\Validation\ValidationResponse;
+
+/**
+ * Class EmailValidator
+ */
+class EmailValidator
+{
+    protected bool $logs;
+
+    protected HttpClient $api;
+
+    public function __construct(HttpClient $api, bool $logs = false)
+    {
+        $this->api = $api;
+        $this->logs = $logs;
+    }
+
+    /**
+     * Create a Charge
+     *
+     * @throws GuzzleException
+     * @throws UnauthorizedException
+     * @throws ForbiddenException
+     */
+    public function validate(string $email): ValidationResponse
+    {
+        $data = new ValidateEmailDto($email);
+        $response = $this->api->post('EmailValidator@validate', '/verify/v1', $data->toArray(), $this->logs);
+
+        if ($response->getStatusCode() === 401) {
+            throw new UnauthorizedException;
+        }
+
+        if ($response->getStatusCode() === 403) {
+            throw new ForbiddenException;
+        }
+
+        $data = json_decode($response->getBody()->getContents(), true);
+
+        return ValidationResponse::fromArray($data);
+    }
+}