feishu-rails 0.1.4 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 257e57680f67a6b05f24836a5f765fac25c6d6effaa4ae7e88843bc2df4e861c
-  data.tar.gz: 0f81c2bdd6e4a3cf560fa530b78366e11d2df0f36208f159afc4736724fb3975
+  metadata.gz: 6804988e9d3dcce71102da60cdf71cac5e9b1e1627835f022c082e9e0585310f
+  data.tar.gz: 9dfe63a9194bcb9c6f8bfd4f75bc5bd76d4112748c9fe792d0e7f5e9a4f4e610
 SHA512:
-  metadata.gz: d4aedc5c5524d3552cb99789a27513e7693eda443aa10f2ac7f19b6118024891b80019aa37a6eaa461750ca20bbea93cb331a561be8914f88f0794e0e45d102a
-  data.tar.gz: 152aec5445a385cc3f5fc543616c14fac8b459da4085fb6f6f001711da0d2055fc82766f561488f4dd7e31f1c771ffd483e48094357899377d6343816cba61b8
+  metadata.gz: b633d47d579b2a9f9fb3539880976fc4084bbeb6c8141f852bfd99c6886823d4b1ca851fb17bcb263d3d3d47b8dd4d96e9821edcb4287016955ab53d8ae3f303
+  data.tar.gz: 9f1819889b23fec6163fef128db9cf30640eeac0decc881f036cf9f3e44872e8193b56e9470f0cbbe0ebf36917d317d14cc19f584ede94d297bbcb8a85b6858f

data/README.md

@@ -1,28 +1,55 @@
-# Feishu
-Short description and motivation.
+# feishu-Rails
+
+对接飞书机器人，实现告警推送
 
 ## Usage
-How to use my plugin.
+
+- include Feishu::Connector 到模块或者类对象；
+- 主要实现的方法：[:user_id, :send_text, :group_members, :request, :send_alert, :access_token, :chat_id, :upload_image, :send_message, :group_list]
+- 群内推送 send_alert(chat_id, title, content, image_path)
+- 上传图片到飞书 upload_image(path) ，建议使用图片绝对路径
 
 ## Installation
+
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "feishu"
+gem "feishu-rails"
 ```
 
 And then execute:
+
 ```bash
 $ bundle
 ```
 
 Or install it yourself as:
+
 ```bash
-$ gem install feishu
+$ gem install feishu-rails
+```
+
+add feishu_rails.rb in config/initializers
+
+```ruby
+Feishu.config do |f|
+  f.app_id      = "xxx"
+  f.app_secret  = "yyy"
+  f.encrypt_key = "zzz"
+end
+```
+
+推送群组告警消息：
+
+```ruby
+include Feishu::Connector
+
+Feishu::Connector.send_alert("oc_xxx", "title", "content", "/home/xxx/Codes/xxx.png")
+
 ```
 
 ## Contributing
-Contribution directions go here.
 
 ## License
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/feishu/connector.rb

@@ -4,6 +4,7 @@ require "active_support/concern"
 
 module Feishu
   extend ActiveSupport::Concern
+
   module Connector
     # 定义常用的 URL
     AUTH_URL    = "https://open.feishu.cn/open-apis/auth/v3/tenant_access_token/internal"
@@ -16,18 +17,9 @@ module Feishu
     GROUP_INFO = "https://open.feishu.cn/open-apis/chat/v4/info"
     SEND_TEXT  = "https://open.feishu.cn/open-apis/message/v4/send"
 
-    # 获取飞书 TOKEN 并缓存
-    def access_token
-      Rails.cache.fetch("feishu_token", expires_in: 2.hours) do
-        # res = HTTP.post(AUTH_URL, json: { app_id: app_id, app_secret: app_secret })
-        res = HTTP.post(AUTH_URL, json: { app_id: Config.app_id, app_secret: Config.app_secret })
-        JSON.parse(res.body.readpartial)["tenant_access_token"]
-      end
-    end
-
     # 认证成功后，后续请求都携带 TOKEN
     def request
-      HTTP.headers(Authorization: "Bearer #{access_token}")
+      HTTP.headers(Authorization: "Bearer #{feishu_token}")
     end
 
     # 根据手机号码查询用户的 USER_ID
@@ -37,18 +29,20 @@ module Feishu
       res = request.get(url)
       # 序列化
       ret = JSON.parse(res.body.readpartial)
+
       # 返回数据
       ret["data"]["mobile_users"].try(:[], mobile).try(:[], 0).try(:[], "user_id")
     end
 
-    # 获取用户 CHAT_ID
-    def chat_id
+    # 获取群组的 chat_id
+    def chat_id(name)
       # 请求后端
       res = request.get(CHAT_ID)
       # 序列化
       ret = JSON.parse(res.body.readpartial)
+
       # 返回数据
-      ret["data"]["groups"].try(:[], 0).try(:[], "chat_id")
+      ret["data"]["groups"].select { |i| i["name"] == name }.try(:[], 0).try(:[], "chat_id")
     end
 
     # 上传图片到飞书后台
@@ -59,8 +53,11 @@ module Feishu
       # 请求后端
       res = request.post(IMAGE_ID, form: { image_type: "message", image: data })
       ret = JSON.parse res.body.readpartial
+
       # 返回上传后的序列号
       ret["data"]["image_key"]
+    rescue => e
+      Rails.logger("上传图片期间捕捉到异常：#{e}")
     end
 
     # 获取机器人所在的群列表
@@ -74,7 +71,7 @@ module Feishu
     end
 
     # 获取群信息
-    def group_info(chat_id)
+    def group_members(chat_id)
       # 请求后端
       res = request.get(GROUP_INFO, params: { chat_id: chat_id })
       # 序列化
@@ -83,14 +80,6 @@ module Feishu
       ret["data"]["members"]
     end
 
-    #  获取群成员信息
-    # def member_list(chat_id)
-    #   res = request.get("https://open.feishu.cn/open-apis/chat/v4/members", :params => {:chat_id=> chat_id})
-    #   group_users_content = JSON.parse(res.body.readpartial)
-
-    #   member_ids = group_users_content["data"]
-    # end
-
     # 发送文本消息
     def send_text(open_id, text)
       # 请求后端
@@ -100,93 +89,72 @@ module Feishu
     end
 
     # 使用推荐的消息接口
-    def send_message(receive_type, receive_id, msg_type, content)
+    def send_message(receive_type = "chat_id", receive_id, msg_type, content)
       # 请求后端
       res = request.post(MESSAGE_URL, params: { receive_id_type: receive_type }, json: { receive_id: receive_id, msg_type: msg_type, content: content })
       # 序列化
       JSON.parse(res.body.readpartial)
     end
 
-    # 发生富文本消息
-    def send_alert(chat_id)
-      data = {
-        "chat_id":  chat_id,
-        "msg_type": "post",
-        "content":  {
-          "post": {
-            "zh_cn": {
-              "title":   "title",
-              "content": [
-                           [
-                             {
-                               "tag":       "text",
-                               "un_escape": true,
-                               "text":      "content"
-                             },
-                             {
-                               "tag":     "at",
-                               "user_id": user_id("15673443571")
-
-                             },
-                           ],
-                           [
-                             {
-                               "tag":       "img",
-                               "image_key": upload_image("/home/careline/Codes/mojo.png"),
-                               "width":     1000,
-                               "height":    600
-                             }
-                           ]
-                         ]
-            }
-          }
-        }
-      }
-      # 请求后端
-      res = request.post(SEND_TEXT, json: data)
-      # 序列化
-      JSON.parse(res.body.readpartial)
-    end
+    # 向特定群组发生消息
+    def send_alert(chat_id, title, content, image_path)
+      # 获取上传文件路径
+      uploaded_image_path = upload_image(image_path)
 
-    # 告警恢复提醒
-    def send_recovery_message(title, content)
+      # 初始化数据结构
       data = {
-        "chat_id":  self.chat_id,
-        "msg_type": "post",
-        "content":  {
-          "post": {
-            "zh_cn": {
-              "title":   title,
-              "content": [
-                           [
-                             {
-                               "tag":       "text",
-                               "un_escape": true,
-                               "text":      content
-                             },
-                             {
-                               "tag":     "at",
-                               "user_id": user_id("15673443571")
-
-                             },
-                           ],
-                           [
-                             {
-                               "tag":       "img",
-                               "image_key": upload_image("/home/careline/Codes/mojo.png"),
-                               "width":     1000,
-                               "height":    600
-                             }
-                           ]
+        chat_id:  chat_id,
+        msg_type: "post",
+        content:  {
+          post: {
+            zh_cn: {
+              title:   title,
+              content: [
+                         [
+                           {
+                             tag:       "text",
+                             un_escape: true,
+                             text:      content
+                           },
+                           {
+                             tag:     "at",
+                             user_id: "all"
+                           },
+                         ],
+                         [
+                           {
+                             tag:       "img",
+                             image_key: upload_image(image_path),
+                             width:     1000,
+                             height:    600
+                           }
                          ]
+                       ]
             }
           }
         }
       }
+      # 如果图片不存在则移除相关属性
+      data[:content][:post][:zh_cn][:content].pop if uploaded_image_path.blank?
+
       # 请求后端
       res = request.post(SEND_TEXT, json: data)
+
       # 序列化
-      JSON.parse(res.body.readpartial)
+      JSON.parse(res.body.readpartial).to_query
+
+    rescue => e
+      Rails.logger("群发消息期间捕捉到异常：#{e}")
     end
   end
+
+  private
+    def feishu_token
+      # 获取飞书 TOKEN 并缓存
+      Rails.cache.fetch("feishu_token", expires_in: 30.minutes) do
+        # res = HTTP.post(AUTH_URL, json: { app_id: app_id, app_secret: app_secret })
+        res = HTTP.post(AUTH_URL, json: { app_id: Feishu.app_id, app_secret: Feishu.app_secret })
+        JSON.parse(res.body.readpartial)["tenant_access_token"]
+      end
+    end
 end

data/lib/feishu/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Feishu
-  VERSION = "0.1.4"
+  VERSION = "0.1.7"
 end

data/lib/feishu-rails.rb

@@ -1,13 +1,14 @@
 # frozen_string_literal: true
 
 require "feishu/version"
-require "feishu/config"
 require "feishu/connector"
 
 module Feishu
   class << self
-    def configure(&block)
-      Config.configure(&block)
+    attr_accessor :app_id, :app_secret, :encrypt_key
+
+    def config
+      yield self
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: feishu-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.7
 platform: ruby
 authors:
 - WENWU.YAN
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-28 00:00:00.000000000 Z
+date: 2022-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -34,7 +34,6 @@ files:
 - README.md
 - Rakefile
 - lib/feishu-rails.rb
-- lib/feishu/config.rb
 - lib/feishu/connector.rb
 - lib/feishu/version.rb
 - lib/tasks/feishu_tasks.rake

data/lib/feishu/config.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module Feishu
-  class Config
-    class << self
-      attr_accessor :app_id, :app_secret, :encrypt_key
-
-      def configure
-        yield self
-      end
-    end
-  end
-end