lark-sdk 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 828ec452f22dfb002801e9c322f540b0eca669f45529f4111a8bc6dfc3842372
-  data.tar.gz: ef2f9b167e6129e4cad649769d019b743dd7a3f9e365affc9f0662cf1626fc39
+  metadata.gz: e01c411acf1296eed034499a8d51dfbfcd3ad456bee82aa78645a4e08f13bfb8
+  data.tar.gz: 2a593ea76f2239e3e978d6c0576ab0acbb3e9a7f5f774a26712d5dacc699b7a1
 SHA512:
-  metadata.gz: bd756a5a651c2906d3d383a707ca8c9166bf3f94128213d1285160565f0cad259b109f9581da499e2ab7eda867ad4e4242b6268424bb22c518fd988ecaa8bd51
-  data.tar.gz: 6e38c2ae9693319fdaf8344954bef8fbfef1e67b2f4f3929eb8ccd89561e9036c63ed6626c5f77f1cf243689448c6cf46308dfd5c3bdbc3fde3d1430867c5ae3
+  metadata.gz: 24cc174b337c06d9e25bba7451157ca4de96380ca9b46475306d82584eb61d56431710102a3936b4519e9872e290d804399887d1696b6d5233e5858d347a7649
+  data.tar.gz: 820e8ad03c5d89f95f4baf00d3ae54ad07b99c25a184606dd31fa76ad43863e9bcb8b9b7bd64eb4e9a883048d4973b05598c0395b15c69e4cbe9c7dd5ae87d59

data/README.md

@@ -1,6 +1,6 @@
-# Lark
+[![Gem Version](https://badge.fury.io/rb/lark-sdk.svg)](https://badge.fury.io/rb/lark-sdk)
 
-Unofficial ruby SDKs for Lark API [飞书](https://open.feishu.cn/document)
+> Ruby SDKs for Lark(飞书) API https://open.feishu.cn/
 
 ## 安装
 
@@ -20,9 +20,9 @@ Or install it yourself as:
 
 	require 'lark/sdk'
 
-## 使用说明
+## 使用
 
-初始化配置：
+初始化：
 
 ```ruby
 # config/initializers/lark.rb
@@ -33,7 +33,7 @@ Lark.configure do |config|
 end
 ```
 
-新建 Lark API 接口实例：
+实例化 API：
 
 ```ruby
 api = Lark::Api.new(
@@ -57,148 +57,15 @@ cipher.decrypt(message)
 cipher.encrypt(message)
 ```
 
-## Api 列表
-
-### 授权
-[`lib/lark/apis/auth.rb`](lib/lark/apis/auth.rb)
-
-| 名称 | 接口 |
-| --- | --- |
-| [获取 app_access_token](https://open.feishu.cn/document/ukTMukTMukTM/uADN14CM0UjLwQTN) | `api.app_access_token` |
-| [获取 tenant_access_token](https://open.feishu.cn/document/ukTMukTMukTM/uEjNz4SM2MjLxYzM) | `api.tenant_access_token` |
-| 更新 app_ticket | `api.app_ticket=` |
-| 获取 app_ticket | `api.app_ticket` |
-| [重新推送 app_ticket](https://open.feishu.cn/document/ukTMukTMukTM/uQjNz4CN2MjL0YzM) | `api.auth.app_ticket_resend` |
-
-### 身份验证
-[`lib/lark/apis/authen.rb`](lib/lark/apis/authen.rb)
-
-| 名称 | 接口 |
-| --- | --- |
-| [请求身份验证](https://open.feishu.cn/document/ukTMukTMukTM/ukzN4UjL5cDO14SO3gTN) | `api.authen.index(redirect_uri, state)` |
-| [获取登录用户身份](https://open.feishu.cn/document/ukTMukTMukTM/uEDO4UjLxgDO14SM4gTN) | `api.authen.access_token(code)` |
-| [刷新 access_token](https://open.feishu.cn/document/ukTMukTMukTM/uQDO4UjL0gDO14CN4gTN) | `api.authen.refresh_access_token(refresh_token)` |
-| [获取用户信息](https://open.feishu.cn/document/ukTMukTMukTM/uIDO4UjLygDO14iM4gTN) | `api.authen.user_info(user_access_token)` |
-
-
-### 通讯录
-[`lib/lark/apis/contact.rb`](lib/lark/apis/contact.rb)
-
-| 名称 | 接口 |
-| --- | --- |
-| [获取通讯录授权范围](https://open.feishu.cn/document/ukTMukTMukTM/ugjNz4CO2MjL4YzM) | `api.contact.scope_get` |
-| [新增部门](https://open.feishu.cn/document/ukTMukTMukTM/uYzNz4iN3MjL2czM) | `api.contact.department_add` |
-| [批量新增部门](https://open.feishu.cn/document/ukTMukTMukTM/uMDOwUjLzgDM14yM4ATN) | `api.contact.department_batch_add` |
-| [删除部门](https://open.feishu.cn/document/ukTMukTMukTM/ugzNz4CO3MjL4czM) | `api.contact.department_delete` |
-| [更新部门信息](https://open.feishu.cn/document/ukTMukTMukTM/uczNz4yN3MjL3czM) | `api.contact.department_update` |
-| [获取部门详情](https://open.feishu.cn/document/ukTMukTMukTM/uAzNz4CM3MjLwczM) | `api.contact.department_get` |
-| [获取子部门列表](https://open.feishu.cn/document/ukTMukTMukTM/ugzN3QjL4czN04CO3cDN) | `api.contact.department_children` |
-| [获取子部门 ID 列表](https://open.feishu.cn/document/ukTMukTMukTM/ukjNz4SO2MjL5YzM) | `api.contact.department_children_ids` |
-| [批量获取部门详情](https://open.feishu.cn/document/ukTMukTMukTM/uczN3QjL3czN04yN3cDN) | `api.contact.department_batch_get` |
-| [获取部门用户列表](https://open.feishu.cn/document/ukTMukTMukTM/uEzNz4SM3MjLxczM) | `api.contact.department_user_list` |
-| [获取部门用户详情](https://open.feishu.cn/document/ukTMukTMukTM/uYzN3QjL2czN04iN3cDN) | `api.contact.department_user_detail_list` |
-| [新增用户](https://open.feishu.cn/document/ukTMukTMukTM/uMzNz4yM3MjLzczM) | `api.contact.user_add` |
-| [批量新增用户](https://open.feishu.cn/document/ukTMukTMukTM/uIDOwUjLygDM14iM4ATN) | `api.contact.user_batch_add` |
-| [删除用户](https://open.feishu.cn/document/ukTMukTMukTM/uUzNz4SN3MjL1czM) | `api.contact.user_delete` |
-| [更新用户信息](https://open.feishu.cn/document/ukTMukTMukTM/uQzNz4CN3MjL0czM) | `api.contact.user_update` |
-| [批量获取用户信息](https://open.feishu.cn/document/ukTMukTMukTM/uIzNz4iM3MjLyczM) | `api.contact.user_batch_get` |
-| [获取企业自定义用户属性配置](https://open.feishu.cn/document/ukTMukTMukTM/ucTN3QjL3UzN04yN1cDN) | `api.contact.tenant_custom_attr_get` |
-| [查询批量任务执行状态](https://open.feishu.cn/document/ukTMukTMukTM/uUDOwUjL1gDM14SN4ATN) | `api.contact.task_get` |
-| [获取应用管理员管理范围](https://open.feishu.cn/document/ukTMukTMukTM/uMzN3QjLzczN04yM3cDN) | `api.contact.user_admin_scope_get` |
-| [获取角色列表](https://open.feishu.cn/document/ukTMukTMukTM/uYzMwUjL2MDM14iNzATN) | `api.contact.role_list` |
-| [获取角色成员列表](https://open.feishu.cn/document/ukTMukTMukTM/uczMwUjL3MDM14yNzATN) | `api.contact.role_members` |
-| [使用手机号或邮箱获取用户 ID](https://open.feishu.cn/document/ukTMukTMukTM/uUzMyUjL1MjM14SNzITN) | `api.user.batch_get_id` |
+[Api 列表](https://github.com/mycolorway/lark-ruby-sdk/wiki/API-List)
 
 
-### 用户群组
-[`lib/lark/apis/user.rb`](lib/lark/apis/user.rb)
-
-| 名称 | 接口 |
-| --- | --- |
-| [获取用户所在的群列表](https://open.feishu.cn/document/ukTMukTMukTM/uQzMwUjL0MDM14CNzATN) | `api.user.group_list` |
-| [获取群成员列表](https://open.feishu.cn/document/ukTMukTMukTM/uUzMwUjL1MDM14SNzATN) | `api.chat.members` |
-| [搜索用户所在的群列表](https://open.feishu.cn/document/ukTMukTMukTM/uUTOyUjL1kjM14SN5ITN) | `api.chat.search` |
-
-
-### 应用管理
-[`lib/lark/apis/application.rb`](lib/lark/apis/application.rb)
-
-| 名称 | 接口 |
-| --- | --- |
-| [校验应用管理员](https://open.feishu.cn/document/ukTMukTMukTM/uITN1EjLyUTNx4iM1UTM) | `api.application.is_user_admin` |
-| [获取应用在企业内的可用范围](https://open.feishu.cn/document/ukTMukTMukTM/uIjM3UjLyIzN14iMycTN) | `api.application.app_visibility` |
-| [获取用户可用的应用](https://open.feishu.cn/document/ukTMukTMukTM/uMjM3UjLzIzN14yMycTN) | `api.application.user_visible_apps` |
-| [获取企业安装的应用](https://open.feishu.cn/document/ukTMukTMukTM/uYDN3UjL2QzN14iN0cTN) | `api.application.app_list` |
-| [更新应用可用范围](https://open.feishu.cn/document/ukTMukTMukTM/ucDN3UjL3QzN14yN0cTN) | `api.application.app_update_visibility` |
-
-
-### 应用商店
-[`lib/lark/apis/pay.rb`](lib/lark/apis/pay.rb)
-
-| 名称 | 接口 |
-| --- | --- |
-| [查询用户是否在应用开通范围](查询用户是否在应用开通范围) | `api.pay.paid_scope_check_user` |
-| [查询租户购买的付费方案](https://open.feishu.cn/document/ukTMukTMukTM/uETNwUjLxUDM14SM1ATN) | `api.pay.order_list` |
-| [查询订单详情](https://open.feishu.cn/document/ukTMukTMukTM/uITNwUjLyUDM14iM1ATN) | `api.pay.order_get` |
-
-
-### 机器人 → 群信息和群管理
-[`lib/lark/apis/chat.rb`](lib/lark/apis/chat.rb)
-
-| 名称 | 接口 |
-| --- | --- |
-| [创建群](https://open.feishu.cn/document/ukTMukTMukTM/ukDO5QjL5gTO04SO4kDN) | `api.chat.create` |
-| [获取群列表](https://open.feishu.cn/document/ukTMukTMukTM/uITO5QjLykTO04iM5kDN) | `api.chat.list` |
-| [获取群信息](https://open.feishu.cn/document/ukTMukTMukTM/uMTO5QjLzkTO04yM5kDN) | `api.chat.info` |
-| [更新群信息](https://open.feishu.cn/document/ukTMukTMukTM/uYTO5QjL2kTO04iN5kDN) | `api.chat.update` |
-| [拉用户进群](https://open.feishu.cn/document/ukTMukTMukTM/ucTO5QjL3kTO04yN5kDN) | `api.chat.chatter_add` |
-| [移除用户出群](https://open.feishu.cn/document/ukTMukTMukTM/uADMwUjLwADM14CMwATN) | `api.chat.chatter_delete` |
-| [解散群](https://open.feishu.cn/document/ukTMukTMukTM/uUDN5QjL1QTO04SN0kDN) | `api.chat.disband` |
-
-
-### 机器人信息和管理
-[`lib/lark/apis/bot.rb`](lib/lark/apis/bot.rb)
-
-| 名称 | 接口 |
-| --- | --- |
-| [获取机器人信息](https://open.feishu.cn/document/ukTMukTMukTM/uAjMxEjLwITMx4CMyETM) | `api.bot.info` |
-| [拉机器人进群](https://open.feishu.cn/document/ukTMukTMukTM/uYDO04iN4QjL2gDN) | `api.bot.add` |
-| [将机器人移出群](https://open.feishu.cn/document/ukTMukTMukTM/ucDO04yN4QjL3gDN) | `api.bot.remove` |
-
-
-### 消息
-[`lib/lark/apis/message.rb`](lib/lark/apis/message.rb)
-
-| 名称 | 接口 |
-| --- | --- |
-| [批量发送消息](https://open.feishu.cn/document/ukTMukTMukTM/ucDO1EjL3gTNx4yN4UTM) | `api.message.batch_send` |
-| [发送消息（文本/图片/富文本/名片/卡片）](https://open.feishu.cn/document/ukTMukTMukTM/uUjNz4SN2MjL1YzM) | `api.message.direct_send` |
-
-
-### 图片
-[`lib/lark/apis/image.rb`](lib/lark/apis/image.rb)
-
-| 名称 | 接口 |
-| --- | --- |
-| [上传图片](https://open.feishu.cn/document/ukTMukTMukTM/uEDO04SM4QjLxgDN) | `api.image.upload` |
-| [获取图片](https://open.feishu.cn/document/ukTMukTMukTM/uYzN5QjL2cTO04iN3kDN) | `api.image.download` |
-
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/lark. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/lark/blob/master/CODE_OF_CONDUCT.md).
+## 贡献
 
+如果你有好的意见或建议，欢迎给我们提issue或pull request。
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
+The MIT License(http://opensource.org/licenses/MIT)
 
-Everyone interacting in the Lark project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/lark/blob/master/CODE_OF_CONDUCT.md).
+请自由地享受和参与开源

data/lark.gemspec

@@ -6,8 +6,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Sean Dong"]
   spec.email         = ["sindon@gmail.com"]
 
-  spec.summary       = %q{Lark API SDKs for ruby}
-  spec.description   = %q{Unofficial ruby SDKs for Lark API [飞书](https://open.feishu.cn)}
+  spec.summary       = %q{Lark(飞书) API SDKs for ruby}
+  spec.description   = %q{Lark(飞书) API SDKs for ruby https://open.feishu.cn}
   spec.homepage      = "https://github.com/mycolorway/lark-ruby-sdk"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")

data/lib/lark/apis/contact.rb

@@ -39,7 +39,7 @@ module Lark
       end
 
       def department_batch_get(department_ids=[])
-        get 'contact/v1/department/detail/batch_get', params: {department_id: department_ids}
+        get 'contact/v1/department/detail/batch_get', params: {department_ids: department_ids}
       end
 
       def department_user_list(department_id:, offset:, page_size:, fetch_child: false)
@@ -76,7 +76,7 @@ module Lark
         post 'contact/v1/user/update', payload
       end
 
-      def user_batch_get(params=[])
+      def user_batch_get(params={})
         get 'contact/v1/user/batch_get', params: params
       end
 
@@ -105,4 +105,4 @@ module Lark
       end
     end
   end
-end
+end

data/lib/lark/apis/image.rb

@@ -2,7 +2,7 @@ module Lark
   module Apis
     module Image
       def upload(image, image_type)
-        post_file 'image/v4/put/', file, params: { image_type: image_type }
+        post_file 'image/v4/put/', image, params: { image_type: image_type }
       end
 
       def download(image_key)

data/lib/lark/version.rb

@@ -1,3 +1,3 @@
 module Lark
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.0.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lark-sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Sean Dong
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-18 00:00:00.000000000 Z
+date: 2020-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -94,7 +94,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.10'
-description: Unofficial ruby SDKs for Lark API [飞书](https://open.feishu.cn)
+description: Lark(飞书) API SDKs for ruby https://open.feishu.cn
 email:
 - sindon@gmail.com
 executables: []
@@ -160,5 +160,5 @@ requirements: []
 rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Lark API SDKs for ruby
+summary: Lark(飞书) API SDKs for ruby
 test_files: []