1sept/oauth2-vkontakte
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

Update docs, bump PHP

Browse Source
This commit is contained in:
trogwar
2016-06-30 08:23:49 +03:00
committed by Jack Wall
parent 887aed2956
commit 8f7813faf3
4 changed files with 296 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
.travis.yml
View File

@@ -1,7 +1,6 @@
language: php language: php
php: php:
- 5.4
- 5.5 - 5.5
- 5.6 - 5.6
- hhvm - hhvm

62
README.md
View File

@@ -12,16 +12,76 @@ This package provides [Vkontakte](https://vk.com) integration for [OAuth2 Client
composer require j4k/oauth2-vkontakte composer require j4k/oauth2-vkontakte
``` ```
## Usage ## Configuration
```php ```php
$provider = new J4k\OAuth2\Client\Provider\Vkontakte([ $provider = new J4k\OAuth2\Client\Provider\Vkontakte([
'clientId' => '1234567', 'clientId' => '1234567',
'clientSecret' => 's0meRe4lLySEcRetC0De', 'clientSecret' => 's0meRe4lLySEcRetC0De',
'redirectUri' => 'https://example.org/oauth-endpoint', 'redirectUri' => 'https://example.org/oauth-endpoint',
'scopes' => ['email', 'offline', 'friends'],
]); ]);
``` ```
## Authorization
```php
// Authorize if needed
if (PHP_SESSION_NONE === session_status()) session_start();
$isSessionActive = PHP_SESSION_ACTIVE === session_status();
$code = !empty($_GET['code']) ? $_GET['code'] : null;
$state = !empty($_GET['state']) ? $_GET['state'] : null;
$sessionState = 'oauth2state';
// No code – get some
if (!$code) {
$authUrl = $provider->getAuthorizationUrl();
if ($isSessionActive) $_SESSION[$sessionState] = $provider->getState();
// Redirect user to VK
header("Location: $authUrl");
die();
}
// Anti-CSRF
elseif ($isSessionActive && (empty($state) || ($state !== $_SESSION[$sessionState]))) {
unset($_SESSION[$sessionState]);
throw new \RuntimeException('Invalid state');
}
// Exchange code to access_token
else {
try {
$providerAccessToken = $provider->getAccessToken('authorization_code', ['code' => $code]);
// Yay, got it!
var_dump([
'access_token' => $providerAccessToken->getAccessToken(),
'expires' => $providerAccessToken->getExpires(),
'user_id' => $providerAccessToken->getValues()['user_id'],
'email' => $providerAccessToken->getValues()['email'], // Only for "email" scope
]);
}
catch (IdentityProviderException $e) {
// Log error
error_log($e->getMessage());
}
}
```
## Helper methods
### Public
```php
$provider->usersGet([1234, 56789]); // => \J4k\OAuth2\Client\Provider\User[]
$provider->friendsGet(23456); // => \J4k\OAuth2\Client\Provider\User[]
```
### With additional data
```php
$providerAccessToken = new \League\OAuth2\Client\Token\AccessToken(['access_token' => 'iAmAccessTokenString']);
$provider->usersGet([1234, 56789], $providerAccessToken); // => \J4k\OAuth2\Client\Provider\User[]
$provider->friendsGet(23456, $providerAccessToken); // => \J4k\OAuth2\Client\Provider\User[]
```
## Contributions ## Contributions
Contributions are very welcome. Please submit a PR Contributions are very welcome. Please submit a PR

2
composer.json
View File

@@ -13,7 +13,7 @@
} }
], ],
"require": { "require": {
"php" : "~5.4", "php" : ">=5.5",
"league/oauth2-client": "^1.4" "league/oauth2-client": "^1.4"
}, },
"require-dev": { "require-dev": {

287
tests/VkontakteTest.php
View File

@@ -2,12 +2,11 @@
namespace J4k\OAuth2\Client\Test\Provider; namespace J4k\OAuth2\Client\Test\Provider;
use GuzzleHttp\Client;
use GuzzleHttp\Psr7\Response; use GuzzleHttp\Psr7\Response;
use League\OAuth2\Client\Token\AccessToken; use J4k\OAuth2\Client\Provider\User;
use J4k\OAuth2\Client\Provider\Vkontakte as Provider;
use League\OAuth2\Client\Provider\Exception\IdentityProviderException;
use Mockery as m; use Mockery as m;
use \J4k\OAuth2\Client\Provider\Vkontakte as Provider;
use \J4k\OAuth2\Client\Provider\User;
class VkontakteTest extends \PHPUnit_Framework_TestCase class VkontakteTest extends \PHPUnit_Framework_TestCase
{ {
@@ -15,6 +14,7 @@ class VkontakteTest extends \PHPUnit_Framework_TestCase
* @type Provider * @type Provider
*/ */
protected $provider; protected $provider;
protected $defaultScopes = ['email', 'friends', 'offline'];
protected function setUp() protected function setUp()
{ {
@@ -24,13 +24,156 @@ class VkontakteTest extends \PHPUnit_Framework_TestCase
'redirectUri' => 'none', 'redirectUri' => 'none',
]); ]);
} }
protected function tearDown()
public function tearDown()
{ {
m::close(); m::close();
parent::tearDown(); parent::tearDown();
} }
/**
* @param array $options
*
* @return Provider
*/
protected function getMockProvider(array $options = [])
{
return new Provider(array_merge([
'urlAuthorize' => 'http://example.com/authorize',
'urlAccessToken' => 'http://example.com/token',
'urlResourceOwnerDetails' => 'http://example.com/user',
], $options));
}
/**
* @return string JSON
*/
protected function getMockAccessToken()
{
return json_encode([
'access_token' => 'mock_access_token',
'expires' => 0,
'refresh_token' => 'mock_refresh_token',
'uid' => 42,
'email' => 'mock_user@example.com',
]);
}
/**
* @return string JSON
*/
protected function getMockOwner()
{
return json_encode([
'response' => [
[
'uid' => 12345,
'bdate' => '12.07.1980',
'city' => [
'id' => 42,
'title' => 'mock_city_title',
],
'country' => [
'id' => 421,
'title' => 'UK',
],
'domain' => 'id12345',
'first_name' => 'mock_first_name',
'friend_status' => 3,
'has_photo' => 1,
'home_town' => 'mock_home_town',
'is_friend' => 1,
'last_name' => 'mock_last_name',
'maiden_name' => 'mock_maiden_name',
'nickname' => 'mock_nickname',
'photo_max' => 'http::/example.com/mock/image/url.jpg?with=parameters&and=square',
'photo_max_orig' => 'http::/example.com/mock/image/url.jpg?with=parameters&and=max',
'screen_name' => 'mock_screen_name',
'sex' => 2,
],
],
]);
}
/**
* @return string JSON
*/
protected function getMockUsers()
{
return json_encode([
'response' => [
[
'uid' => 12345,
'bdate' => '12.07.1980',
'city' => [
'id' => 42,
'title' => 'mock_city_title',
],
'country' => [
'id' => 421,
'title' => 'UK',
],
'domain' => 'id12345',
'first_name' => 'mock_first_name',
'friend_status' => 3,
'has_photo' => 1,
'home_town' => 'mock_home_town',
'is_friend' => 1,
'last_name' => 'mock_last_name',
'maiden_name' => 'mock_maiden_name',
'nickname' => 'mock_nickname',
'photo_max' => 'http::/example.com/mock/image/url.jpg?with=parameters&and=square',
'photo_max_orig' => 'http::/example.com/mock/image/url.jpg?with=parameters&and=max',
'screen_name' => 'mock_screen_name',
'sex' => 2,
],
[
'uid' => 23456,
'bdate' => '12.07.1988',
'city' => [
'id' => 422,
'title' => 'mock_city_title_2',
],
'country' => [
'id' => 4212,
'title' => 'UK',
],
'domain' => 'id23456',
'first_name' => 'mock_first_name_2',
'friend_status' => 0,
'has_photo' => 1,
'home_town' => 'mock_home_town_2',
'is_friend' => 0,
'last_name' => 'mock_last_name_2',
'maiden_name' => 'mock_maiden_name_2',
'nickname' => 'mock_nickname_2',
'photo_max' => 'http::/example.com/mock/image/url2.jpg?with=parameters&and=square',
'photo_max_orig' => 'http::/example.com/mock/image/url2.jpg?with=parameters&and=max',
'screen_name' => 'mock_screen_name_2',
'sex' => 1,
],
],
]);
}
/**
* @return string JSON
*/
protected function getMockErrorFlat()
{
return json_encode([
'error' => 'mock_error_message',
'error_description' => 'mock_error_description',
]);
}
/**
* @return string JSON
*/
protected function getMockErrorTree()
{
return json_encode([
'error' => [
'error_code' => 123,
'error_msg' => 'mock_error_message',
],
]);
}
public function testAuthorizationUrl() public function testAuthorizationUrl()
{ {
$url = $this->provider->getAuthorizationUrl(); $url = $this->provider->getAuthorizationUrl();
@@ -45,7 +188,6 @@ class VkontakteTest extends \PHPUnit_Framework_TestCase
static::assertArrayHasKey('approval_prompt', $query); static::assertArrayHasKey('approval_prompt', $query);
static::assertNotNull($this->provider->getState()); static::assertNotNull($this->provider->getState());
} }
public function testUrlAccessToken() public function testUrlAccessToken()
{ {
$url = $this->provider->getBaseAccessTokenUrl([]); $url = $this->provider->getBaseAccessTokenUrl([]);
@@ -53,65 +195,98 @@ class VkontakteTest extends \PHPUnit_Framework_TestCase
static::assertEquals('/access_token', $uri['path']); static::assertEquals('/access_token', $uri['path']);
} }
public function testGetAccessToken()
{
/**
* @type Client|\Mockery\Mock $client
* @type Response|\Mockery\Mock $response
* @type AccessToken $token
*/
$response = m::mock(new Response);
$response->shouldReceive('getBody')->times(1)->andReturn('{"access_token": "mock_access_token", "expires": 3600, "refresh_token": "mock_refresh_token", "uid": 1, "email": "mock_email"}');
$client = m::mock(new Client);
$client->shouldReceive('setBaseUrl')->times(1);
$client->shouldReceive('post->send')->times(1)->andReturn($response);
$this->provider->setHttpClient($client);
$token = $this->provider->getAccessToken('authorization_code', ['code' => 'mock_authorization_code']);
static::assertEquals('mock_access_token', $token->getToken());
static::assertLessThanOrEqual(time() + 3600, $token->getExpires());
static::assertGreaterThanOrEqual(time(), $token->getExpires());
static::assertEquals('mock_refresh_token', $token->getRefreshToken());
static::assertEquals('1', $token->uid);
static::assertEquals('mock_email', $token->email);
}
public function testScopes() public function testScopes()
{ {
static::assertEquals(['email'], $this->provider->scopes); static::assertEquals($this->defaultScopes, $this->provider->scopes);
} }
public function testUserData()
{
/** /**
* @type Client|\Mockery\Mock $client * @todo Do we need this? Provider::getAccessToken() not used in project.
* @type Response|\Mockery\Mock $postResponse
* @type Response|\Mockery\Mock $getResponse
*/ */
public function testGetAccessToken()
{
// /**
// * @type Client|\Mockery\Mock $client
// * @type Response|\Mockery\Mock $response
// * @type AccessToken $token
// */
//
// $response = m::mock(Response::class);
// $response->shouldReceive('getBody')->times(1)->andReturn($this->getMockAccessToken());
//
// $client = m::mock(Client::class);
// $client->shouldReceive('setBaseUrl');
// $client->shouldReceive('post->send')->times(1)->andReturn($response);
// $this->provider->setHttpClient($client);
//
// $token = $this->provider->getAccessToken('authorization_code', ['code' => 'mock_authorization_code']);
//
// static::assertEquals('mock_access_token', $token->getToken());
// static::assertLessThanOrEqual(time() + 3600, $token->getExpires());
// static::assertEquals('mock_refresh_token', $token->getRefreshToken());
// static::assertEquals(12345, $token->getValues()['user_id']);
// static::assertEquals('mock_user@example.com', $token->getValues()['email']);
}
public function testUsersGet()
{
// $response = m::mock(Response::class);
// $response->shouldReceive('getBody')->times(2)->andReturn($this->getMockUsers());
// $response->shouldReceive('getHeader')->times(2)->andReturn(['Content-Type' => 'application/json; encoding=utf-8']);
// $response->shouldReceive('getStatusCode')->times(2)->andReturn(200);
// $response->shouldReceive('getReasonPhrase')->times(2)->andReturn('OK');
//
// $provider = $this->getMockProvider();
// $user12345 = new User(json_decode($this->getMockUsers(), true)['response'][0]);
// $user23456 = new User(json_decode($this->getMockUsers(), true)['response'][1]);
//
// static::assertEquals([$user12345, $user23456], $provider->usersGet([12345, 23456]));
}
$postResponse = m::mock(new Response); public function testCheckResponseSuccess()
$postResponse->shouldReceive('getBody')->times(1)->andReturn('{"access_token": "mock_access_token", "expires": 3600, "refresh_token": "mock_refresh_token", "uid": 1, "email": "mock_email"}'); {
$response = m::mock(Response::class);
$response->shouldReceive('getBody')->andReturn($this->getMockOwner());
$response->shouldReceive('getHeader')->andReturn(['Content-Type' => 'application/json; encoding=utf-8']);
$response->shouldReceive('getStatusCode')->andReturn(200);
$response->shouldReceive('getReasonPhrase')->andReturn('OK');
$getResponse = m::mock(new Response); $provider = $this->getMockProvider();
$getResponse->shouldReceive('getBody')->times(4)->andReturn('{"response": [{"uid": 12345, "nickname": "mock_nickname", "screen_name": "mock_name", "first_name": "mock_first_name", "last_name": "mock_last_name", "country": "UK", "status": "mock_status", "photo_200_orig": "mock_image_url"}]}'); $reflection = new \ReflectionClass(get_class($provider));
$checkResponse = $reflection->getMethod('checkResponse');
$checkResponse->setAccessible(true);
$client = m::mock(new Client); static::assertNull($checkResponse->invokeArgs($provider, [$response, []]));
$client->shouldReceive('setBaseUrl')->times(5); }
$client->shouldReceive('post->send')->times(1)->andReturn($postResponse); public function testCheckResponseErrorFlat()
$client->shouldReceive('get->send')->times(4)->andReturn($getResponse); {
$this->provider->setHttpClient($client); $response = m::mock(Response::class);
$response->shouldReceive('getHeader')->andReturn(['Content-Type' => 'application/json; encoding=utf-8']);
$response->shouldReceive('getStatusCode')->andReturn(200);
$response->shouldReceive('getReasonPhrase')->andReturn('OK');
$token = $this->provider->getAccessToken('authorization_code', ['code' => 'mock_authorization_code']); $provider = $this->getMockProvider();
/** @type User $user */ $reflection = new \ReflectionClass(get_class($provider));
$user = $this->provider->getResourceOwner($token); $checkResponse = $reflection->getMethod('checkResponse');
$checkResponse->setAccessible(true);
static::assertEquals(12345, $this->provider->userUid($getResponse, $token)); $response->shouldReceive('getBody')->andReturn($this->getMockErrorFlat());
static::assertEquals(['mock_first_name', 'mock_last_name'], $this->provider->userScreenName($getResponse, $token)); $this->setExpectedException(IdentityProviderException::class, 'mock_error_description');
static::assertEquals('mock_email', $this->provider->userEmail($getResponse, $token)); $checkResponse->invokeArgs($provider, [$response, json_decode($this->getMockErrorFlat(), true)]);
static::assertEquals('mock_email', $user->email); }
public function testCheckResponseErrorTree()
{
$response = m::mock(Response::class);
$response->shouldReceive('getHeader')->andReturn(['Content-Type' => 'application/json; encoding=utf-8']);
$response->shouldReceive('getStatusCode')->andReturn(200);
$response->shouldReceive('getReasonPhrase')->andReturn('OK');
$provider = $this->getMockProvider();
$reflection = new \ReflectionClass(get_class($provider));
$checkResponse = $reflection->getMethod('checkResponse');
$checkResponse->setAccessible(true);
$response->shouldReceive('getBody')->andReturn($this->getMockErrorTree());
$this->setExpectedException(IdentityProviderException::class, 'mock_error_message', 123);
$checkResponse->invokeArgs($provider, [$response, json_decode($this->getMockErrorTree(), true)]);
} }
} }