Ones 应用中心 API (ones-ruby-sdk)

安装

添加下面代码到应用的 Gemfile:

gem 'ones-sdk', github: 'mycolorway/ones-ruby-sdk', branch: 'master'

然后执行:

$ bundle install

使用

初始化

# config/initializers/ones.rb

Ones.configure do |config|
  # Ones 应用中心配置
  config.default_client_id     = 'xxx' # 应用 client ID
  config.default_client_secret = 'xxx' # 应用 client secret
  config.app_center_base_url   = 'http://localhost:3001/project/api/project/' # Ones 应用中心 API 地址

  # Ones API 配置
  config.api_base_url          = 'http://localhost:3001/project/api/' # Ones API 地址

  # 公共配置
  config.http_timeout_options  = { write: 2, connect: 5, read: 15 } # 请求的 timeout 参数（非必需）
end

应用身份 API

# -------------------- 应用 --------------------
#
# 用户凭证校验
Ones::Api.default.app_center.check_user('user_uuid', 'token')

# -------------------- 组织 --------------------
#
# 获取服务凭证
Ones::Api.default.org.app_credential('org_uuid')

# 获取当前应用在指定组织指定用户下的ConstraintMap
Ones::Api.default.org.constraint_by_user('org_uuid', 'user_uuid')

# 获取当前应用在指定组织的有效 License
Ones::Api.default.org.license('org_uuid')

# 获取当前应用在指定组织已授权用户的UUID列表
Ones::Api.default.org.grant_uuids('org_uuid')

# -------------------- 团队 --------------------
#
# 获取组织下属团队列表
Ones::Api.default.team.list('org_uuid')

# 批量获取团队信息
Ones::Api.default.user.teams('org_uuid', %w[aaaabbbb xxxxyyyy])

# -------------------- 部门 --------------------
#
# 获取指定团队的部门列表（产品确认过可以接受空部门）
Ones::Api.default.department.list('team_uuid')

# -------------------- 用户 --------------------
#
# 批量获取指定用户信息
Ones::Api.default.user.batch('org_uuid', %w[xxxxyyyy aaaabbbb])

# 批量获取指定用户的所属团队
Ones::Api.default.user.teams('org_uuid', %w[xxxxyyyy aaaabbbb])

# 批量获取用户在指定团队的所属部门
Ones::Api.default.user.departments('team_uuid', %w[xxxxyyyy aaaabbbb])

用户身份 API

# 使用用户在 ones 系统的 user_uuid 与 token 生成用户身份接口对象
$ones_api = Ones::Api.new(client_secret: 'user_bearer_token', mode: :api)

# -------------------- 组织 --------------------
#
# 获取组织的业务配置
# Wiki 相关主要关注：wps_config、wiz_config、wiki_config
$ones_api.org.stamps_data('org_uuid')

# -------------------- 用户 --------------------
#
# 获取用户授权信息，其中包含应用授权情况
$ones_api.auth.token_info

# 获取任务管理器列表
$ones_api.user.token_info

# -------------------- Wiki 团队 --------------------
#
# 查看团队类资源权限列表，主要关注资源类型为页面组的权限 context_type：space
$ones_api.wiki_team.evaluated_permissions('team_uuid')

# 全局模版
$ones_api.wiki_team.templates('team_uuid')

# 最新使用模版
$ones_api.wiki_team.recent_templates('team_uuid')

# 团队创建页面的数量限制
$ones_api.wiki_team.limit('team_uuid')

# -------------------- Wiki 页面组 --------------------
#
# 获取页面组列表
$ones_api.wiki_space.list('team_uuid')

# 获取页面组模版
$ones_api.wiki_space.templates('team_uuid', 'space_uuid')


# -------------------- Wiki 页面 --------------------
#
# 获取页面组内所有页面
$ones_api.wiki_page.list('team_uuid', 'space_uuid')

# 检查页面状态
$ones_api.wiki_page.check_status('team_uuid', ['7mG12EWa'])

# 创建 Wiki 协同页面
$ones_api.wiki_page.create_wiz(
  'team_uuid',
  title: "创建 Wiki 协同页面",
  space_uuid: 'space_uuid',
  parent_uuid: 'parent_uuid'
)

# 创建 Wiki 页面
$ones_api.wiki_page.create_wiki(
  'team_uuid',
  title: "创建 Wiki 页面",
  space_uuid: 'space_uuid',
  parent_uuid: 'parent_uuid'
)

# 创建文稿（wps-word）、表格（wps-sheet）、幻灯片（wps-ppt）
$ones_api.wiki_page.create_wiki(
  'team_uuid',
  title: "创建文稿",
  space_uuid: 'space_uuid',
  parent_uuid: 'parent_uuid',
  src_uuid: 'wps-word'
)

# 导入 Wiki 协同页面
$ones_api.wiki_page.import_wiz(
  'team_uuid',
  parent_uuid: 'parent_uuid',
  resource_uuid: 'resource_uuid'
)

# 导入 Wiki 页面
$ones_api.wiki_page.import_wiki(
  'team_uuid',
  parent_uuid: 'parent_uuid',
  resource_uuid: 'resource_uuid'
)

# 导入办公协同页面
$ones_api.wiki_page.import_wps(
  'team_uuid',
  space_uuid: space_uuid,
  parent_uuid: 'parent_uuid',
  resource_uuid: 'resource_uuid'
)

运行测试

$ rake