Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tomshaw/google-api
A Laravel Google API Client.
https://github.com/tomshaw/google-api
Last synced: 11 days ago
JSON representation
A Laravel Google API Client.
- Host: GitHub
- URL: https://github.com/tomshaw/google-api
- Owner: tomshaw
- License: mit
- Created: 2023-10-16T16:41:15.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-04-03T07:47:01.000Z (8 months ago)
- Last Synced: 2024-04-14T04:44:28.906Z (7 months ago)
- Language: PHP
- Homepage:
- Size: 63.5 KB
- Stars: 55
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# GoogleApi ☁️
[](https://github.com/tomshaw/google-api/blob/master/LICENSE)
A Google OAuth 2.0 Laravel Service Client.
## Installation
You can install the package via composer:
```bash
composer require tomshaw/google-api
```
If you're facing a timeout error then increase the timeout for composer:
```json
{
"config": {
"process-timeout": 600
}
}
```
Next publish the configuration file:
```
php artisan vendor:publish --provider="TomShaw\GoogleApi\Providers\GoogleApiServiceProvider" --tag=config
```
Run the migration if you wish to use database token storage adapter:
```
php artisan migrate
```
To avoid shipping all 200 Google API's you should specify the services you wish to use in your `composer.json`:
```json
{
"scripts": {
"pre-autoload-dump": "Google\\Task\\Composer::cleanup"
},
"extra": {
"google/apiclient-services": [
"Gmail",
"Calendar"
]
}
}
```
## Configuration
Here's a brief explanation of the application configuration file used to set up a Google API client:
- `token_storage_adapter`: Sets the default token storage adapter to use. Developers can implement their own custom solution.
- `auth_config`: This is the path to the JSON file that contains your Google API client credentials.
- `application_name`: This is the name of your application.
- `prompt`: This is the type of prompt that will be presented to the user during the OAuth2.0 flow. The 'consent' prompt asks the user to grant your application access to the scopes you're requesting.
- `approval_prompt`: This is another setting for the OAuth2.0 flow. The 'auto' setting means that the user will only be prompted for approval the first time they authenticate your application.
- `access_type`: This is set to 'offline' to allow your application to access the user's data when the user is not present.
- `include_grant_scopes`: This is set to true to include the scopes from the initial authorization in the refresh token request.
- `service_scopes`: These are the scopes your application is requesting access to.
The Google API client uses these settings to handle the OAuth2.0 flow and interact with the Google APIs.
## Basic Usage
Authorizing the application and persisting the token.
> Google APIs must have OAuth 2.0 authorization credentials downloaded from the [Google Developer Console](https://console.cloud.google.com/apis). See the application configuration to specify the location of your credentials.
```php
namespace App\Http\Controllers;
use App\Http\Controllers\Controller;
use TomShaw\GoogleApi\GoogleClient;
use Illuminate\Http\Request;
class GoogleAuthController extends Controller
{
public function index(GoogleClient $client)
{
return $client->createAuthUrl();
}
public function callback(Request $request, GoogleClient $client)
{
$authCode = $request->get('code');
$accessToken = $client->fetchAccessTokenWithAuthCode($authCode);
if ($accessToken) {
$client->setAccessToken($accessToken);
}
return redirect()->route('homepage');
}
}
```
## Storage Adapters
You can provide your own storage mechanism such as file or Redis by setting the `token_storage_adapter` configuration option.
> Storage adapters must implement the `StorageAdapterInterface`.
```php
'token_storage_adapter' => TomShaw\GoogleApi\Storage\DatabaseTokenStorage::class,
```
## Services Adapters
This package includes a Google `Calendar` and `Gmail` adapter classes. Feel free to send a pull request if you would like to add your own.
> Using the client to create a calendar event for the following day 1:00PM.
```php
public function add()
{
$calendar = GoogleApi::calendar()->setCalendarId('[email protected]');
$summary = 'Test Event';
$location = '123 Test St, Test City, TS';
$description = 'This is a test event.';
$from = Carbon::now()->timezone('America/Chicago')->addDay()->startOfDay()->addHours(13);
$to = $from->copy()->addHour();
$event = $calendar->addEvent($summary, $location, $description, $from, $to);
// save event id for event updates.
}
```
> Using the client to send emails.
```php
public function mount(Order $id)
{
$model = Order::with(['user'])->where('id', $id)->first();
$attachments = [
storage_path('app/public/discount.jpg'),
storage_path('app/public/invoice.pdf'),
];
$gmail = GoogleApi::gmail();
$gmail->from('[email protected]', 'Company Name');
$gmail->to($model->user->email, $model->user->name);
$gmail->cc('[email protected]');
$gmail->bcc('[email protected]');
$gmail->subject('Thank you for your order.');
$gmail->mailable(new OrderMailable($model, 'template-name'));
$gmail->attachments($attachments);
$gmail->send();
}
```
## Changelog
For changes made to the project, see the [Changelog](CHANGELOG.md).
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## License
The MIT License (MIT). See [License File](LICENSE) for more information.