oauth-io/oauth

OAuth that just works !

Friday, February 27, 2015
by oauth-io
Repository
13 Watchers
90 Stars
57,277 Installations

PHP
1 Dependents
0 Suggesters
8 Forks
12 Open issues
9 Versions
2 % Grown

The README.md

OAuth.io PHP SDK

OAuth that just works !, _(*1)

This SDK allows you to use OAuth.io from a PHP backend, to handle the authentication and API calls from your server instead of from your front-end, for 100+ API providers., _(*2)

The current version of the SDK is 0.3.2. Older versions are deprecated., _(*3)

You can also get nightlies by checking out our develop branch., _(*4)

To get more information about this SDK and its method, please refer to its reference documentation on OAuth.io., _(*5)

Features

Server-side OAuth authentication flow
Requests to API from the backend
Unified user information (.me() method) requests when available
Access token renewal with the refresh_token when available

Common use-Case

You don't want to use APIs directly from the front-end, but rather through web-services inside your PHP backend., _(*6)

Installation

First of all, you'll need to set your app's backend to PHP in your OAuth.io dashboard., _(*7)

This allows you to get a refresh token from the provider if available., _(*8)

You can install it through Composer by adding the following dependency to your composer.json :, _(*9)

 "require": {
        ...
        "oauth-io/oauth": "0.3.0"
        ...
    },

Then run in the console :, _(*10)

$ composer install

Using the SDK

The OAuth class is stored in the OAuth_io namespace. You need to include it in your file like this (make sure you have required the Composer autoloader file):, _(*11)

PSR-0 support, _(*12)

If you're using Composer with an autoloader, you can use the PSR-0 notation to use this package. Just put the following code at the top of your script :, _(*13)

Initialization, _(*14)

To initialize the SDK, you have to give it your OAuth.io's app's key and secret (you can grab them on the oauth.io Key-Manager) :, _(*15)

<?php
$oauth = new OAuth();
$oauth->initialize('your_key', 'your_secret');
//?>

Note on session, _(*16)

You can give your own managed session array to the constructor so that if you already have a session manager, the SDK doesn't mess around with it :, _(*17)

Note on certificates, _(*18)

If you're using oauthd (the open source version of oauth.io) and that you don't have a verified ssl certificate yet (you should in the future if you want to put your code in production), you can disable the SSL certificate verification like this :, _(*19)

<?php
$oauth = new OAuth(null, false);
//?>

Authenticating the user, _(*20)

The first thing you need to do is to create an endpoint that will redirect your user to the provider's authentication page, so that the user can accept the permissions your app needs., _(*21)

In this endpoint, call the redirect method like this:, _(*22)

$oauth->redirect('the_provider', '/callback/url');

This will automatically redirect your user to the provider's website. Once he has accepted the permissions, he will be redirected to the '/callback/url' on your app, where you'll be able to retrieve a request object., _(*23)

In an endpoint associated to the '/callback/url', call the auth method with the redirect option set to true to get a request object, like this:, _(*24)

$request_object = $oauth->auth('the_provider', array(
    'redirect' => true
));

$request_object is an object that allows you to perform requests (see further down to learn how to), and that contains the user's credentials., _(*25)

Using the session to get a request object, _(*26)

Usually, you'll want to make calls to the API several times while the user is connected to your app. Once you've authenticated the user once with a code, the session is automatically configured to work with the SDK., _(*27)

Thus, you just need to do this to get a request object:, _(*28)

$request_object = $oauth->auth('the_provider');

Saving credentials to re-generate a request object, _(*29)

You can also save the user's credentials to make requests in a cron. You can get the credentials array from a request object like this :, _(*30)

$credentials = $request_object->getCredentials();
// Here save the $credentials array for later use

Then, when you want to reuse these credentials, you can rebuild a $request_object from them:, _(*31)

$request_object = $oauth->auth('the_provider', array(
    'credentials' => $credentials
));

Making requests to the API, _(*32)

Once you have a request object, you can make requests to the API., _(*33)

get('https://theprovider.com/api/endpoint');

$response_POST = $request_object->post('https://theprovider.com/api/endpoint', array('some' => 'data'));
$response_PUT = $request_object->put('https://theprovider.com/api/endpoint', array('some' => 'data'));
$response_DELETE = $request_object->del('https://theprovider.com/api/endpoint');
$response_PATCH = $request_object->patch('https://theprovider.com/api/endpoint', array('some' => 'data'));
//?>

You can also call the me(array $filters) method from that request object. This method returns a unified array containing information about the user., _(*34)

auth('facebook', array(
    'redirect' => true
));

$result = $facebook_requester->me(array('firstname', 'lastname', 'email'));

// you'll have $result["firstname"], $result["lastname"] and $result["email"] set with the user's facebook information.
//?>

You can refer to the OAuth.io me() feature to get more information about the fields that are returned by this method., _(*35)

Refreshing the token, _(*36)

If a refresh token is available and the access token is expired, the auth method will automatically use that refresh token to get a new access token., _(*37)

You can force the renewal by passing the force_refresh field in the options array:, _(*38)

$request_object = $oauth->auth('the_provider', array(
    'credentials' => $credentials,
    'force_refresh' => true
));

You can also directly refresh a credentials array like this:, _(*39)

$refreshed_credentials = $oauth->refreshCredentials($old_credentials);

Contributing to this SDK

Issues, _(*40)

Please discuss issues and features on Github Issues. We'll be happy to answer to your questions and improve the SDK based on your feedback., _(*41)

Pull requests, _(*42)

You are welcome to fork and make pull requests. We appreciate the time you spend working on this project and we will be happy to review your code and merge it if it brings nice improvements :), _(*43)

If you want to do a pull request, please mind these simple rules :, _(*44)

One feature per pull request
Write clear commit messages
Unit test your feature : if it's a bug fix for example, write a test that proves the bug exists and that your fix resolves it.
Write a clear description of the pull request

If you do so, we'll be able to merge your pull request more quickly :), _(*45)

The SDK is written as a Composer module. You can install its dependencies like this :, _(*46)