Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/peter279k/servicebundle
Integrating with mailing service,uploading image service and so on.
https://github.com/peter279k/servicebundle
composer guzzle imageshack imgur mailgun shorten-urls
Last synced: about 1 month ago
JSON representation
Integrating with mailing service,uploading image service and so on.
- Host: GitHub
- URL: https://github.com/peter279k/servicebundle
- Owner: peter279k
- License: mit
- Created: 2016-01-29T07:35:19.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2018-10-08T04:48:59.000Z (about 6 years ago)
- Last Synced: 2024-11-02T10:31:59.025Z (about 2 months ago)
- Topics: composer, guzzle, imageshack, imgur, mailgun, shorten-urls
- Language: PHP
- Homepage: https://packagist.org/packages/lee/service-bundle
- Size: 140 KB
- Stars: 9
- Watchers: 2
- Forks: 7
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# serviceBundle
[](https://travis-ci.org/peter279k/serviceBundle) [](https://packagist.org/packages/lee/service-bundle) [](https://packagist.org/packages/lee/service-bundle) [](https://packagist.org/packages/lee/service-bundle) [](https://packagist.org/packages/lee/service-bundle) [](https://codecov.io/gh/peter279k/serviceBundle)
[](https://gitter.im/peter279k/serviceBundle?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
[](https://insight.sensiolabs.com/projects/f29371ba-ab1c-4203-84d3-7c903e919824)
Integrating with mailing service, uploading image service and so on.
It's based on [Guzzle](https://github.com/guzzle/guzzle),HTTP client.
## Following service table is about supporting status
| service-name|support|service-type|
|-------------|-------|------------|
| [mailgun](https://www.mailgun.com/)| Yes | mailing service |
| [mailjet](http://dev.mailjet.com/guides/?php#about-the-mailjet-restful-api) | No | mailing service |
| [sendgrid](https://sendgrid.com/) | Yes | mailing service |
| [Imgur](http://imgur.com/) | Yes | uploading images service |
| [Imageshack](https://www.imageshack.us) | Yes | uploading images service |
| [bit.ly](https://bitly.com/) | Yes | shorten url service |
|[McAf.ee](https://community.mcafee.com/docs/DOC-1991)| Yes | shorten url service |
## Usage
### Install Package
We strongly recommended using [composer](https://getcomposer.org)
Getting composer
```bash
curl -sS https://getcomposer.org/installer | php
```
Using this command
```bash
php composer.phar require lee/service-bundle
```
## Sample code
Mailgun: a sending mail service
```php
require 'vendor/autoload.php';
$config = [
'service-name' => 'Mailgun',
//e.g. key-98dXXXXXXX
'api-key' => 'mailgun-api-key',
//e.g. sandbox5099cXXXXXXXXXXXXXXXXXXX
'domain-name' => 'mailgun-domain-name',
'from' => '[email protected]',
'to' => '[email protected]',
'subject' => 'Hello',
//contents supported only plain text now.
'contents' => 'Mailgun is awesome !'
];
$bundle = new \peter\components\serviceBundle\ServiceBundle($config);
//return json format (mailgun standard api response via cURL)
var_dump($bundle->sendReq());
```
SendGrid: a sending mail service
```php
require 'vendor/autoload.php';
$config = [
'api-key' => 'sendgrid-api-key',
'from-name' => 'John Doe',
'from-email' => '[email protected]',
'to-name' => 'John Doe',
'to-email' => '[email protected]',
'subject' => 'SendGrid Test',
'contents' => 'Sendgrid is awesome!',
];
$service = (new peter\components\serviceBundle\Services\ServiceFactory)->create('SendGrid');
$service->setConfig($config);
//return json format (SendGrid standard api response via cURL)
var_dump($service->sendReq());
```
Mailjet: a sending mail service
```php
require 'vendor/autoload.php';
$config = [
'api-key-public' => 'mailjet-public-api-key',
'api-key-private' => 'mailjet-privave-api-key',
'from-name' => 'John Doe',
'from-email' => '[email protected]',
'to-name' => 'John Doe',
'to-email' => '[email protected]',
'subject' => 'Mailjet Test',
'contents' => 'Mailjet is awesome!',
];
$service = (new peter\components\serviceBundle\Services\ServiceFactory)->create('Mailjet');
$service->setConfig($config);
//return json format (Mailjet standard api response via cURL)
var_dump($service->sendReq());
```
Imgur: an uploading images service
```php
require 'vendor/autoload.php';
$config = [
'service-name' => 'Imgur',
'clientID' => 'imgur-client-id',
'filePath' => '/path/to/image.png'
];
$bundle = new \peter\components\serviceBundle\ServiceBundle($config);
//return json format (Imgur standard api response via cURL)
var_dump($bundle -> sendReq());
```
ImageShack: an uploading images service
```php
require 'vendor/autoload.php';
$config = [
'service-name' => 'ImageShack',
'key' => 'your-Imageshack-api-key',
//specify the image max file size
'maxFileSize' => '5242880'
'filePath' => '/path/to/image.png'
];
$bundle = new \peter\components\serviceBundle\ServiceBundle($config);
//return json format (Imgur standard api response via cURL)
var_dump($bundle -> sendReq());
```
McAfee: a shorten url service
```php
require 'vendor/autoload.php';
$config = [
'service-name' => 'McAfee',
'longUrl' => 'your-long-url'
];
$bundle = new \peter\components\serviceBundle\ServiceBundle($config);
//return json format (McAf standard api response via cURL)
var_dump($bundle->sendReq());
```
Bitly: a shorten url service
```php
require 'vendor/autoload.php';
$config = [
'service-name' => 'Bitly',
'login' => 'your-login',
'apiKey' => 'your-api-key',
'longUrl' => 'your-long-url'
];
$bundle = new \peter\components\serviceBundle\ServiceBundle($config);
//return json format (bit.ly standard api response via cURL)
var_dump($bundle -> sendReq());
```
## Run TestCase
```
composer test
```
### Changelog
#### 2016/07/20
+ version: v1.2.7
+ Using the new version of Guzzle 5 and avoid the Httpoxy vulnerability.
#### 2016/07/21
+ version: v1.2.8
+ Fix the uploading image via imgur service bug.
#### 2016/07/21
+ version: v1.2.9
+ adding some information images
#### 2016/07/21
+ version: v1.3.1
+ supporting the Imageshack API
#### 2017/11/11
+ version: v1.4.0
+ Change the namespace and see the sample code to know this.
+ Change the source code(code refactoring)
+ Using the PHPUnit ```Mock``` to test the HTTP API requests.
+ The version 2.x is deprecated.
+ Update the Guzzle version to 6.2
+ Change the ```service-name``` value in ```$config``` array.
## Version Guidance
| Version | Status | Packagist | Namespace | PSR-7 |
|---------|-------------|---------------------|--------------|-------|
| 1.x | Maintained | `lee/service-bundle` | `peter\components\serviceBundle` | No |
| 2.x | **Deprecated | `lee/service-bundle` | `peter\components\ServiceBundle` | No |
[serviceBundle-1-repo](https://github.com/peter279k/serviceBundle/tree/master)
[serviceBundle-2-repo(deprecated)](https://github.com/peter279k/serviceBundle/tree/guzzle6)