feishu-rails 0.1.3 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9ffbd5349b1725eff7ac29f5822779d3566dd3a3dca6bb7577845d5b62015cf
-  data.tar.gz: 787d901f41edd64c8b5e19e5f2b2aa27066fa35840a356d055a994bfbee12ad5
+  metadata.gz: 7b49a7ba4343fbd7ae4e4d35d00e999cbdd54a568cff97634bcbf6fdda102862
+  data.tar.gz: 2b1117e10d4c5b2cd6f6097dd3f8c66313fac00c2058cd138af6e661cc4836d7
 SHA512:
-  metadata.gz: 636d3abd7ce1658069e20f818fd176d48311900d5e559a2281ba460fd2c9a349d5cb553820ece62e7367875684758c0c01cb6d182161329ad746848b776b75ee
-  data.tar.gz: bb5dbb5d2049ba3fec04bcccbe0a4723b7072b8319bd65c098a74edc1ee1f7acdb6ff02ed0888a71e04d80a5bf29fbb328df0c194222006de1068dd3ef3637bf
+  metadata.gz: 41c6b52e05e546e709f3993cec155858be0d898069dafc83e9e64c576343045e1f3cda5fcc940c685b0a3793abe5b73d75f871c4444ee6ffa4b2c1bc3df7d6cd
+  data.tar.gz: c040c72e826d829ccee8bd2cfb6773c05cc28156659abc0fd5a3a82b022b74f1637b1f7deb38f085a85993e270131c55b577481bf0cdbc2ff51a7756b633ae35

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/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler/setup"
 
 require "bundler/gem_tasks"

data/lib/feishu/connector.rb

@@ -1,21 +1,27 @@
+# frozen_string_literal: true
+
 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/"
-    USER_INFO   = "https://open.feishu.cn/open-apis/contact/v1/user/batch_get"
-    GROUP_LIST  = "https://open.feishu.cn/open-apis/chat/v4/list"
-    GROUP_INFO  = "https://open.feishu.cn/open-apis/chat/v4/info"
-    SEND_TEXT   = "https://open.feishu.cn/open-apis/message/v4/send/"
-    IMAGE_URL   = "https://open.feishu.cn/open-apis/im/v1/images"
+    AUTH_URL    = "https://open.feishu.cn/open-apis/auth/v3/tenant_access_token/internal"
+    USER_ID     = "https://open.feishu.cn/open-apis/user/v1/batch_get_id?mobiles="
+    CHAT_ID     = "https://open.feishu.cn/open-apis/chat/v4/list?page_size=20"
+    IMAGE_ID    = "https://open.feishu.cn/open-apis/im/v1/images"
     MESSAGE_URL = "https://open.feishu.cn/open-apis/im/v1/messages"
 
+    GROUP_LIST = "https://open.feishu.cn/open-apis/im/v1/chats"
+    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: Config.app_id, app_secret: Config.app_secret })
+      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
@@ -25,51 +31,62 @@ module Feishu
       HTTP.headers(Authorization: "Bearer #{access_token}")
     end
 
-    def batch_user_info(open_ids)
-      res   = request.get(USER_INFO, params: { open_ids: open_ids })
-      users = JSON.parse(res.body.readpartial)
-
-      users["data"]
-    end
-
-    # 获取机器人所在的群列表
-    def group_list(page_size = 200, page = nil)
+    # 根据手机号码查询用户的 USER_ID
+    def user_id(mobile)
+      url = "#{USER_ID}#{mobile}"
       # 请求后端
-      res = request.get(GROUP_LIST, params: { page_size: page_size, page_token: page })
+      res = request.get(url)
       # 序列化
-      group_content = JSON.parse(res.body.readpartial)
+      ret = JSON.parse(res.body.readpartial)
 
-      group_content["data"]
+      # 返回数据
+      ret["data"]["mobile_users"].try(:[], mobile).try(:[], 0).try(:[], "user_id")
     end
 
-    # 获取群信息
-    def group_info(chat_id)
+    # 获取群组的 chat_id
+    def chat_id(name)
       # 请求后端
-      res = request.get(GROUP_INFO, params: { chat_id: chat_id })
+      res = request.get(CHAT_ID)
       # 序列化
-      group_users_content = JSON.parse(res.body.readpartial)
+      ret = JSON.parse(res.body.readpartial)
 
-      group_users_content["data"]["members"]
+      # 返回数据
+      ret["data"]["groups"].select { |i| i["name"] == name }.try(:[], 0).try(:[], "chat_id")
     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 upload_image(image_path)
       # 读取图片
       data = HTTP::FormData::File.new image_path
 
       # 请求后端
-      res = request.post(IMAGE_URL, form: { image_type: "message", image: data })
+      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
+
+    # 获取机器人所在的群列表
+    def group_list(page_size = 20, page = nil)
+      # 请求后端
+      res = request.get(GROUP_LIST, params: { page_size: page_size, page_token: page })
+      # 序列化
+      ret = JSON.parse(res.body.readpartial)
+      # 返回数据
+      ret["data"]
+    end
+
+    # 获取群信息
+    def group_members(chat_id)
+      # 请求后端
+      res = request.get(GROUP_INFO, params: { chat_id: chat_id })
+      # 序列化
+      ret = JSON.parse(res.body.readpartial)
+      # 返回数据
+      ret["data"]["members"]
     end
 
     # 发送文本消息
@@ -81,48 +98,55 @@ 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": self.user_id
-    #
-    #                          },
-    #                        ],
-    #                        [
-    #                          {
-    #                            "tag":       "img",
-    #                            "image_key": self.image_key,
-    #                            "width":     1000,
-    #                            "height":    600
-    #                          }
-    #                        ]
-    #                      ]
-    #         }
-    #       }
-    #     }
-    #   }
-    # end
+    # 向特定群组发生消息
+    def send_alert(chat_id, title, content, image_path)
+      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: "all"
+                           },
+                         ],
+                         [
+                           {
+                             tag:       "img",
+                             image_key: upload_image(image_path),
+                             width:     1000,
+                             height:    600
+                           }
+                         ]
+                       ]
+            }
+          }
+        }
+      }
+      # 请求后端
+      res = request.post(SEND_TEXT, json: data)
+
+      # 序列化
+      JSON.parse(res.body.readpartial).to_query
+
+    rescue => e
+      Rails.logger("群发消息期间捕捉到异常：#{e}")
+    end
   end
 end

data/lib/feishu/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Feishu
-  VERSION = "0.1.3"
+  VERSION = "0.1.6"
 end

data/lib/feishu-rails.rb

@@ -1,11 +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

data/lib/tasks/feishu_tasks.rake

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # desc "Explaining what the task does"
 # task :feishu do
 #   # Task goes here

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: feishu-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.6
 platform: ruby
 authors:
 - WENWU.YAN
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-26 00:00:00.000000000 Z
+date: 2022-04-05 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,11 +0,0 @@
-module Feishu
-  class Config
-    class << self
-      attr_accessor :app_id, :app_secret, :encrypt_key
-
-      def configure
-        yield self
-      end
-    end
-  end
-end