README

OAuthAdapter 是一个服务库，它使用 Guzzle HTTP 客户端 通过 OAuth1 获取访问 PUMA/BibSonomy API 的权限。此外，OAuthAdapter 还可以帮助您进行令牌交换。

理解 OAuth

BibSonomy 和 PUMA 支持OAuth 1.0a机制，也称为三脚 OAuth。实际上，您不需要确切了解它是如何工作的，但了解一些基础知识对于防止在OAuth使用中出现故障是有好处的。

您可以在 https://github.com/Mashape/mashape-oauth/blob/master/FLOWS.md#oauth-10a-three-legged 找到有帮助的概述。

安装

使用 composer 将 OAuthAdapter 添加到您的 PHP 项目中。

$ composer require academicpuma/oauthadapter
$ composer update

如何使用 OAuthAdapter

包含自动加载器

<?php
$projectPath = 'projectpath';
include $projectPath.'vendor/autoload.php';
include $projectPath.'config.php';
?>

初始化 OAuthAdapter

<?php
use AcademicPuma\OAuth\OAuthAdapter;
$client = new OAuthAdapter([
    'consumerKey'       => CONSUMER_KEY,
    'consumerSecret'    => CONSUMER_SECRET,
    'callbackUrl'       => CALLBACK_URL,
    'baseUrl'           => BASE_URL
]);
?>

获取请求令牌并重定向

<?php
try {
    $requestToken = $client->getRequestToken(); //get Request Token
    session_start();
    $_SESSION['REQUEST_TOKEN'] = serialize($requestToken); //save Request Token in the session
    
} catch(\Exception $e) {
    //do something
}
$client->redirect($requestToken); //redirect to PUMA/BibSonomy to verify user authorization
?>

创建 PUMA/BibSonomy 获取用户授权后调用的回调脚本

<?php

include $projectPath.'vendor/autoload.php';
include $projectPath.'config.php';

use AcademicPuma\OAuth\OAuthAdapter;

session_start(); //resume session

// Get the RequestToken from session
$requestToken = unserialize($_SESSION['REQUEST_TOKEN']); 

$client = new OAuthAdapter([
    'consumerKey'       => CONSUMER_KEY,
    'consumerSecret'    => CONSUMER_SECRET,
    'callbackUrl'       => CALLBACK_URL,
    'baseUrl'           => BASE_URL
]);

$accessToken = $client->getAccessToken($requestToken); //fetch Access Token

//persist the Access Token 
$_SESSION['ACCESS_TOKEN'] = serialize($accessToken); //better: save it into a database

使用 OAuthAdapter 请求 API

<?php
include $projectPath.'vendor/autoload.php';
include $projectPath.'config.php';

use AcademicPuma\OAuth\OAuthAdapter;

session_start(); //resume session

// Get the Access Token from session
$accessToken = unserialize($_SESSION['ACCESS_TOKEN']); 

/**
 * @var AcademicPuma\OAuth\OAuthAdapter
 */
$adapter = new OAuthAdapter([
    'consumerKey'       => CONSUMER_KEY,
    'consumerSecret'    => CONSUMER_SECRET,
    'callbackUrl'       => CALLBACK_URL,
    'baseUrl'           => BASE_URL
]);

$adapter->prepareClientForOAuthRequests($accessToken); //attach accessToken
$jsonString = $adapter->get(BASE_URL.'api/groups?format=json')->json();
$object = json_decode($jsonString);
var_dump($object);
?>