chancegarcia/box-api-v2-sdk

用于与 box.com API 交互的 PHP SDK

0.10.0 2024-04-13 22:41 UTC

This package is auto-updated.

Last update: 2024-09-13 23:26:47 UTC


README

至少需要 5.6.10

用于与 box.net v2 api(http://developers.box.com/)一起使用的 php sdk

版权 (C) 2013-2016 Chance Garcia

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

任务

  • v0.4.0
    • 重构 Connection::getCurlData 以返回 HTTP 响应对象(使用 symfony/http-foundation)
      • 将 curl 头字符串转换为头数组的函数,用于在响应对象中设置
      • 根据头字符串确定状态码的函数
      • Client 类中现有的调用必须仍然仅分析响应体
    • Service 类的最终方法分析响应对象以确定错误/响应处理,例如刷新令牌尝试
      • 弃用 Service::getFinalConnectionResult 并在 v0.5.0 中添加删除警告
  • v0.4.5
    • 重构 Service::getFromBox 以接受类型 mapped
    • 重构 Service::sendUpdateToBox 以接受类型 mapped
    • 添加 Error 类
      • 添加对 409 item_name_in_use 错误的处理
      • 创建错误的工厂
    • 修复 StatusLine 解析(原因短语 Not Found 显示为 Not
  • v0.5.0
    • 添加弃用通知,表示将删除 Client 类。确切的删除版本尚未确定
    • 添加弃用通知,表示将在 v0.6.0 中删除 Collection 类,转而使用 doctrine/collections
    • 使用工厂创建类返回值,而不是将类传递给映射
    • Connection 类中设置 CURLOPT_SSL_VERIFYPEER 的方法
      • 添加弃用通知,表示在未来的版本中将默认值设置为 true 以允许时间从当前行为(false)迁移
    • 重构
  • v0.6.0
    • 切换到完整的 composer 依赖模式
    • 添加 composer doctrine/collections 依赖项
    • 使用现有的 OAuth2 for Box 客户端库进行我们的身份验证
    • BaseModelModel 类中实现映射和日志记录的 trait
    • 在抽象 Service 中实现 Retry-After 响应头处理

低于 0.4.0 版本的任务

  • Client 类
    • 注意:令牌信息以及客户端 ID 和密钥来自外部源/存储
    • 给定授权码获取访问令牌
    • 刷新令牌
    • 根据 ID 从 box 获取文件夹信息
    • 获取文件夹项数组(json 解码格式)
    • 创建新的 box 文件夹
    • 更新文件夹信息
    • 获取文件夹协作者
    • 将协作者添加到文件夹中
    • 为文件夹创建共享链接
    • 复制 box 文件夹
    • 使用令牌为连接类创建授权头
    • 销毁令牌
      • 添加错误处理
    • 身份验证查询
      • 构建身份验证查询 URI
      • 为连接设置身份验证头
        • 由于头覆盖,允许合并附加头
    • 客户端 ID
    • 客户端密钥
  • 协作类
    • 实现的接口
    • 验证状态
  • 集合类
    • 找出如何创建到数组集合库的依赖;不是可分离的,但比维护自己的/重新发明轮子更好
  • 连接类
    • 实现的接口
    • 设置额外 curl 选项的能力
    • 发送 GET 请求
    • 返回 GET 响应
    • 发送 PUT 请求
    • 返回 PUT 响应
    • 发送 POST 请求
    • 返回 POST 响应
    • 发送 DELETE 请求
    • 返回 DELETE 响应
  • Token 类
  • 文件夹类
    • 实现的接口
  • 用户类
    • 实现的接口
  • 文件类
    • 实现的接口
  • 评论类
  • 事件类
  • 共享项目交互
    • 创建共享链接(可以通过客户端完成)
  • 搜索
  • 任务类
  • 单元测试
    • 当前实现的回归测试
    • 未来实现的 TDD