README

此软件包提出了一种数据模型，用于通过 Scoop.it 账户导入和同步本地管理的内容

特性

依赖关系

此软件包依赖于 Guzzle 6.x 版本。

安装

使用 Composer 安装

通过 composer 安装此扩展是首选方式。

运行以下命令

$ php composer.phar require humanized/yii2-scoop-it "dev-master"

或者

"humanized/yii2-scoop-it": "dev-master"

将以下内容添加到您的 composer.json 文件的 require 部分。

将模块添加到配置文件

将以下行添加到配置文件以进行最小化集成

'modules' => [
    'scoopit' => [
        'class' => 'humanized\scoopit\ScoopIt',
    ],
],

有关模块配置的更多信息，请参阅此存储库的 CONFIG 文件。

运行迁移

$ php yii migrate/up --migrationPath=@vendor/humanized/yii2-scoop-it/migrations

设置 Scoop.it 凭据

账户凭据作为本地参数存储，例如，在 common/config/params-local 中存储。注意，这些凭据是个人凭据，绝不应存储在公共软件存储库中！

'params' => [
    'scoopit' =>
    [
        // Scoop.it API account base url here (suffixed with /api/1)
        'remoteUri' => 'https://acme-corp.scoop.it/api/1/',
        // Scoop.it Consumer Key/Secret (allows anonymous mode and mandatory for authenticated mode)
        'consumerKey' => '',
        'consumerSecret' => '',
        // URL root of local website instance, used for three-legged authententication callback
         'authorisationCallbackUri' => "path-to-website",
        // Scoop.it Consumer Key/Secret (mandatory for authenticated mode)
        'token' => '',
        'tokenSecret' => '',
    ],
],

配置这些详细信息允许客户端以受限匿名模式与远程 Scoop.it 账户交互，提供对远程账户的（部分）只读访问。

要启用认证模式，该模式提供对远程账户的最大访问权限，则遵循三脚 OAuth 认证程序。

为此，设置适当的 authorisationCallbackUri 值，它必须设置为本地实例的根路径。例如，如果本地实例部署具有如下路由定义 https://example.com/path/to/webapp/module/controller/view，则 authorisationCallbackUri 设置为 https://example.com/path/to/webapp/。

配置完成后，获取令牌和令牌密钥值的流程如下

第1步

从命令行，在应用根目录下运行以下命令。

$ php yii scoopit/oauth

系统随后会显示指向远程 Scoop.it 账户的外部 URL，并提示用户输入验证码。

第2步

要获取授权验证码，请在一个图形浏览器中跟随外部链接，授权本地应用程序实例对远程 Scoop.it 账户的访问。授权后，会使用先前设置的 authorisationCallbackUrl 将用户重定向到本地实例，显示一个（临时）令牌和提示中请求的验证码。

第3步

在第一步获取的提示中提供第二步获取的验证码，随后会显示令牌和令牌密钥值，用于本地配置设置。

为验证目的，在设置完成后运行以下命令。

$ php yii scoopit/test

人性化 / yii2-scoop-it

维护者

详细信息