feishu-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 13d0624f83504106d2aea9ab11e7f46ace5279b941b7c96d3b7079d46aa5192e
+  data.tar.gz: 4cebc28b90e6dc24064b173e84f7b2ed4828c16ad88d662f3a80b3e54ccbd982
+SHA512:
+  metadata.gz: f3712e077e07abd86249f8e61743e849ffd07d0c8bf00e38c0f54d3603218888fc8e1ef5ff0a4d29b3f4836a27e19363d3e810f5dc80e4b15a5276e49ef4fe9b
+  data.tar.gz: 24bfd38c27a267a439b912ebb313567695403396da4a71f07475509ee8faa220b3117fd1fc2b169942ca2bed558818f57a88e86f8b5abaa9e31290cc3ab78ac6

data/README.md

@@ -0,0 +1,42 @@
+# FeishuApi
+
+FeishuApi is a integration of commonly used feishu open platform's APIs, easy to call.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add feishu-api
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install feishu-api
+
+## Usage
+
+Add feishu-api.rb in config/initializers
+
+```ruby
+ FeishuApi.configure do |config|
+   config.app_id = ''
+   config.app_secret = ''
+ end
+```
+
+Example:
+
+```ruby
+FeishuApi.send_text_by_group('oc_xxx', 'hello')
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ruilisi/feishu-api. 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/ruilisi/feishu-api/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the FeishuApi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ruilisi/feishu-api/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+task default: %i[]

data/lib/feishu-api/api.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+module FeishuApi
+  class << self
+    API_HOST = 'https://open.feishu.cn/open-apis'
+
+    API_TENANT_ACCESS_TOKEN = '/auth/v3/tenant_access_token/internal'
+    API_APP_ACCESS_TOKEN = '/auth/v3/app_access_token/internal'
+    API_SEND_MESSAGES = '/im/v1/messages'
+    API_CUSTOM_BOT_SEND = '/bot/v2/hook'
+
+    def api(interface)
+      "#{API_HOST}#{interface}"
+    end
+
+    def post(url, data, headers = {}, timeout = 30)
+      HTTParty.post(api(url),
+                    body: data.to_json,
+                    headers: { 'Content-Type' => 'application/json', 'Accept' => 'application/json' }.merge(headers),
+                    timeout: timeout,
+                    verify: false)
+    end
+
+    def post_with_token(url, data, _timeout = 30)
+      headers = { Authorization: "Bearer #{tenant_access_token}" }
+      post(url,
+           data,
+           headers)
+    end
+
+    def tenant_access_token
+      Rails.cache.fetch('tenant_access_token', expires_in: 2.hours) do
+        res = post(API_TENANT_ACCESS_TOKEN, {
+                     app_id: Config.app_id,
+                     app_secret: Config.app_secret
+                   })
+
+        return nil if res.code != 200
+
+        body = JSON.parse(res.body)
+        token = (body['code']).zero? ? body['tenant_access_token'] : nil
+        token
+      end
+    end
+
+    def app_access_token
+      Rails.cache.fetch('app_access_token', expires_in: 2.hours) do
+        res = post(API_APP_ACCESS_TOKEN, {
+                     app_id: Config.app_id,
+                     app_secret: Config.app_secret
+                   })
+        return nil if res.code != 200
+
+        body = JSON.parse(res.body)
+        token = (body['code']).zero? ? body['app_access_token'] : nil
+        token
+      end
+    end
+
+    # 发送消息
+    def send_message(receive_type, receive_id, msg_type, content)
+      res = post_with_token("#{API_SEND_MESSAGES}?receive_id_type=#{receive_type}",
+                            { receive_id: receive_id, msg_type: msg_type, content: content })
+      return nil if res.code != 200
+
+      JSON.parse(res.body)
+    end
+
+    # 发消息到指定群聊
+    def send_message_by_group(receive_id, msg_type, content)
+      send_message('chat_id', receive_id, msg_type, content)
+    end
+
+    # 发文本消息到指定群聊
+    def send_text_by_group(receive_id, text)
+      send_message_by_group(receive_id, 'text', JSON.generate({ text: text }))
+    end
+
+    # 通过邮箱识别用户, 发消息到指定用户
+    def send_message_by_email(receive_id, msg_type, content)
+      send_message('email', receive_id, msg_type, content)
+    end
+
+    # 自定义机器人接口 发送消息
+    def custom_robot_send(data, hook_id)
+      post("#{API_CUSTOM_BOT_SEND}/#{hook_id}", data)
+      return nil if res.code != 200
+
+      JSON.parse(res.body)
+    end
+
+    # 自定义机器人接口 发送文本消息
+    def custom_robot_send_text(text, hook_id)
+      custom_robot_send({
+                          msg_type: 'post',
+                          content: {
+                            post: {
+                              'zh-CN': {
+                                title: '',
+                                content: [
+                                  [
+                                    {
+                                      tag: 'text',
+                                      text: text
+                                    }
+                                  ]
+                                ]
+                              }
+                            }
+                          }
+                        }, hook_id)
+    end
+
+    # 自定义机器人接口 发送卡片消息
+    def custom_robot_send_card(title = '标题', theme = 'blue', elements = [], hook_id = '')
+      custom_robot_send({
+                          msg_type: 'interactive',
+                          card: {
+                            config: {
+                              wide_screen_mode: true
+                            },
+                            header: {
+                              title: {
+                                tag: 'plain_text',
+                                content: title
+                              },
+                              template: theme
+                            },
+                            elements: elements
+                          }
+                        }, hook_id)
+    end
+  end
+end

data/lib/feishu-api/config.rb

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

data/lib/feishu-api/engine.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module FeishuApi
+  class Engine < ::Rails::Engine
+    isolate_namespace FeishuApi
+
+    initializer('feishu-api', after: :load_config_initializers) do |_app|
+      Rails.application.routes.prepend do
+        mount FeishuApi::Engine, at: '/feishu-api'
+      end
+    end
+  end
+end

data/lib/feishu-api/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module FeishuApi
+  VERSION = '0.1.0'
+end

data/lib/feishu-api.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'feishu-api/engine'
+require 'feishu-api/config'
+require 'feishu-api/api'
+
+require 'httparty'
+
+module FeishuApi
+  # Your code goes here...
+  class << self
+    def configure(&block)
+      Config.configure(&block)
+    end
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: feishu-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- msk
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: FeishuApi is a integration of commonly used feishu open platform's APIs,
+  easy to call.
+email:
+- msk1143667241@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/feishu-api.rb
+- lib/feishu-api/api.rb
+- lib/feishu-api/config.rb
+- lib/feishu-api/engine.rb
+- lib/feishu-api/version.rb
+homepage: https://github.com/ruilisi/feishu-api
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'false'
+  homepage_uri: https://github.com/ruilisi/feishu-api
+  source_code_uri: https://github.com/ruilisi/feishu-api.git
+  changelog_uri: https://github.com/ruilisi/feishu-api/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: feishu open api
+test_files: []