README.md in dingbot-0.1.1 vs README.md in dingbot-0.2.0
- old
+ new
@@ -1,6 +1,8 @@
# DingTalk Bot
+[](https://badge.fury.io/rb/dingbot.svg)
+[](https://raw.githubusercontent.com/thierryxing/dingtalk-bot/master/LICENSE.txt)
DingTalk Bot是阿里钉钉自定义机器人的Ruby库
官方文档：[阿里钉钉自定义机器人](https://open-doc.dingtalk.com/docs/doc.htm?spm=a219a.7629140.0.0.karFPe&treeId=257&articleId=105735&docType=1).
@@ -20,59 +22,90 @@
## 用法
初始化客户端:
```ruby
-access_token = 'xxxxxxxxxxxxxxx'
-client = DingBot.client(access_token)
+DingBot.configure do |config|
+ config.endpoint = 'https://oapi.dingtalk.com/robot/send' # API endpoint URL, default: ENV['DINGTALK_API_ENDPOINT'] or https://oapi.dingtalk.com/robot/send
+ config.access_token = '3ddef428f1478056e858450e07272834c79bd538e8055a04e989573c469xxxx' # access token, default: ENV['DINGTALK_ACCESS_TOKEN']
+end
```
发送消息
```ruby
-# 发送Text消息
-message = DingBot::Message::Text.new('我就是我, 是不一样的烟火',
- ['156xxxx8827'],
- false)
-client.send_msg(message)
+# 快速发送一套只包含文本的Text消息（不需要构造Message对象）
+def send_simple_text
+ DingBot.send_text('我就是我, 是不一样的烟火')
+end
+# 发送复杂Text消息
+def send_text
+ message = DingBot::Message::Text.new(
+ '我就是我, 是不一样的烟火',
+ ['13718896117'],
+ false
+ )
+ DingBot.send_msg(message)
+end
+
# 发送Link消息
-message = DingBot::Message::Link.new('我就是我, 是不一样的烟火',
- '这个即将发布的新版本，创始人陈航（花名“无招”）称它为“红树林”。',
- 'https://www.dingtalk.com/',
- 'https://avatars1.githubusercontent.com/u/64818')
-client.send_msg(message)
+def send_link
+ message = DingBot::Message::Link.new(
+ '我就是我, 是不一样的烟火',
+ '这个即将发布的新版本，创始人陈航（花名“无招”）称它为“红树林”。',
+ 'https://mp.weixin.qq.com/s?__biz=MzA4NjMwMTA2Ng==&mid=2650316842&idx=1&sn=60da3ea2b29f1dcc43a7c8e4a7c97a16&scene=2&srcid=09189AnRJEdIiWVaKltFzNTw&from=timeline&isappinstalled=0&key=&ascene=2&uin=&devicetype=android-23&version=26031933&nettype=WIFI',
+ 'https://avatars1.githubusercontent.com/u/64818'
+ )
+ DingBot.send_msg(message)
+end
# 发送Markdown消息
-message = DingBot::Message::Markdown.new('我就是我, 是不一样的烟火', '### 我就是我, 是不一样的烟火')
-client.send_msg(message)
+def send_markdown
+ DingBot.send_markdown('我就是我, 是不一样的烟火', '### 我就是我, 是不一样的烟火')
+end
# 发送整体跳转ActionCard消息
-message = DingBot::Message::WholeActionCard.new('乔布斯 20 年前想打造一间苹果咖啡厅，而它正是 Apple Store 的前身',
- ' ### 乔布斯 20 年前想打造的苹果咖啡厅',
- '0',
- '0',
- '阅读全文',
- 'https://www.dingtalk.com/')
-client.send_msg(message)
-
+def send_whole_action_card
+ message = DingBot::Message::WholeActionCard.new(
+ '乔布斯 20 年前想打造一间苹果咖啡厅，而它正是 Apple Store 的前身',
+ ' ### 乔布斯 20 年前想打造的苹果咖啡厅',
+ '阅读全文',
+ 'https://www.dingtalk.com/'
+ )
+ DingBot.send_msg(message)
+end
+
# 发送独立跳转ActionCard类型消息
-message = DingBot::Message::IndependentActionCard.new('乔布斯 20 年前想打造一间苹果咖啡厅，而它正是 Apple Store 的前身',
- ' ### 乔布斯 20 年前想打造的苹果咖啡厅',
- '0',
- '0',
- [
- DingBot::Message::ActionBtn.new('内容不错', 'https://www.dingtalk.com/'),
- DingBot::Message::ActionBtn.new('不感兴趣', 'https://www.dingtalk.com/')
- ])
-client.send_msg(message)
+def send_independent_action_card
+ message = DingBot::Message::IndependentActionCard.new(
+ '乔布斯 20 年前想打造一间苹果咖啡厅，而它正是 Apple Store 的前身',
+ ' ### 乔布斯 20 年前想打造的苹果咖啡厅',
+ [
+ DingBot::Message::ActionBtn.new('内容不错', 'https://www.dingtalk.com/'),
+ DingBot::Message::ActionBtn.new('不感兴趣', 'https://www.dingtalk.com/')
+ ]
+ )
+ DingBot.send_msg(message)
+end
-# 发送FeedCard类型
-message = DingBot::Message::FeedCard.new([
- DingBot::Message::FeedCardLink.new('时代的火车向前开',
- 'https://avatars1.githubusercontent.com/u/64818',
- 'https://www.dingtalk.com/')
- ])
-client.send_msg(message)
+# 发送FeedCard类型
+def send_feed_card
+ message = DingBot::Message::FeedCard.new(
+ [
+ DingBot::Message::FeedCardLink.new(
+ '时代的火车向前开',
+ 'https://avatars1.githubusercontent.com/u/64818',
+ 'https://www.dingtalk.com/'
+ ),
+ DingBot::Message::FeedCardLink.new(
+ '时代的火车向前开',
+ 'https://avatars1.githubusercontent.com/u/64818',
+ 'https://www.dingtalk.com/'
+ )
+ ]
+ )
+ DingBot.send_msg(message)
+end
```
更为详细的用法请见此链接：[https://github.com/thierryxing/dingtalk-bot/blob/master/test/dingbot_test.rb](https://github.com/thierryxing/dingtalk-bot/blob/master/test/dingbot_test.rb)
## License
Released under the MIT license. See LICENSE.txt for details.
\ No newline at end of file