dingbot 0.2.3 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0f3900000e1d35173b8444d6895f2abc081d3d4a
-  data.tar.gz: bb25170d9dacb52ec4680df49c411707a4ae06f1
+SHA256:
+  metadata.gz: d5786404b17bd985d218ca86427d9295b8aa0e3c62e5de0d1a9a711bbc68b912
+  data.tar.gz: f1b404b5ef785d3239f9e8dcbfffea5fac403d117537b89b1122a01a1b42f006
 SHA512:
-  metadata.gz: 9584951d70aebb491bcf6eb4184b1779b33ae79f6b525b70b6695c3816b1cce47c925980648224d939235abeab2f32d4987745e52f93156b75041d3b618b43c9
-  data.tar.gz: f377b6f1a43757fe38ae38c54b01c19a4981c3e61c6309732b5ee3165f25d667785c4fd96a0b7b8d8f768c5a89a4239e3ccd811ea0b54bca1a567f760fe9c088
+  metadata.gz: 43acda49cef2e0496a98cdff8136fd2e8cf58a247fa78bcf850690d71443aebff784d5dd79ab895df3e378ab4b125dd810f359dd62b93f0d75cd4e1fe98a6751
+  data.tar.gz: d4f9c6a4cabee5ebaf06a0b3837fa2c584440d18d3e6676bc51fd9197e3b50f428b7f657ef66bcd9b45c8545841440bcdc2d9a3afcfbccf23d7f3fbb427b6a20

data/README.md

@@ -4,7 +4,7 @@
 [![GitHub license](https://img.shields.io/badge/license-MIT-blue.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). 
+官方文档：[阿里钉钉自定义机器人](https://developers.dingtalk.com/document/robots/robot-overview). 
 
 
 ## 安装
@@ -28,12 +28,14 @@ gem 'dingbot'
 # 全局配置方式
 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']
+  config.access_token = 'your access token' # access token, default: ENV['DINGTALK_ACCESS_TOKEN']
+  config.secret = "your sign secret" # sign secret
 end
 
 # 局部配置方式
  DingBot.endpoint='https://oapi.dingtalk.com/robot/send'
- DingBot.access_token = '3ddef428f1478056e858450e07272834c79bd538e8055a04e989573c469xxxx'
+ DingBot.access_token = 'your access token'
+ DingBot.secret = "your sign secret" # sign secret
 ```
 
 发送消息

data/lib/dingbot/client.rb

@@ -1,4 +1,5 @@
 require 'httparty'
+require 'json'
 require 'dingbot/configuration'
 require 'dingbot/message/base'
 require 'dingbot/message/text'
@@ -12,7 +13,8 @@ module DingBot
     format :json
     headers "Content-Type" => "application/json"
 
-    attr_accessor :access_token
+    # attr_accessor :access_token
+    # attr_accessor :secret
 
     # @private
     attr_accessor(*Configuration::VALID_OPTIONS_KEYS)
@@ -43,7 +45,20 @@ module DingBot
     end
 
     def send_msg(message)
-      validate self.class.post(@endpoint, {query: {access_token: @access_token}, body: message.to_json})
+      query = {
+        access_token: @access_token,
+      }
+
+      if !@secret.nil? and !@secret.empty?
+        timestamp = (Time.now.to_f * 1000).to_i
+
+        query.merge!({
+          timestamp: timestamp,
+          sign: Base64.encode64(OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha256'), @secret, "#{timestamp}\n#{@secret}")).strip
+        })
+      end
+
+      validate self.class.post(@endpoint, { query: query, body: message.to_json })
     end
 
     def send_text(content)
@@ -83,8 +98,12 @@ module DingBot
                     end
 
       fail error_klass.new(response) if error_klass
-
       parsed = response.parsed_response
+      
+      body = JSON.parse(response.body)
+      errcode = body["errcode"]
+      fail body["errmsg"] if errcode != 0
+
       parsed.client = self if parsed.respond_to?(:client=)
       parsed.parse_headers!(response.headers) if parsed.respond_to?(:parse_headers!)
       parsed

data/lib/dingbot/configuration.rb

@@ -1,8 +1,8 @@
 module DingBot
   # Defines constants and methods related to configuration.
   module Configuration
-    # An array of valid keys in the options hash when configuring a Sentry::API.
-    VALID_OPTIONS_KEYS = [:endpoint, :access_token, :httparty].freeze
+    # An array of valid keys in the options hash when configuring a DingBot::API.
+    VALID_OPTIONS_KEYS = [:endpoint, :access_token, :httparty, :secret].freeze
 
     # The user agent that will be sent to the API endpoint if none is set.
     DEFAULT_USER_AGENT = "DingBot Ruby Gem #{DingBot::VERSION}".freeze
@@ -34,6 +34,7 @@ module DingBot
     def reset
       self.endpoint = ENV['DINGTALK_ENDPOINT'] || DEFAULT_ENDPOINT
       self.access_token = ENV['DINGTALK_ACCESS_TOKEN']
+      self.secret = ENV['DINGTALK_SECRET']
     end
 
   end

data/lib/dingbot/error.rb

@@ -36,23 +36,9 @@ module DingBot
         message = parsed_response.message || parsed_response.error
 
         "Server responded with code #{@response.code}, message: " \
-        "#{handle_message(message)}. " \
         "Request URI: #{@response.request.base_uri}#{@response.request.path}"
       end
 
-      # Handle error response message in case of nested hashes
-      def handle_message(message)
-        case message
-          when SentryApi::ObjectifiedHash
-            message.to_h.sort.map do |key, val|
-              "'#{key}' #{(val.is_a?(Hash) ? val.sort.map {|k, v| "(#{k}: #{v.join(' ')})"} : val).join(' ')}"
-            end.join(', ')
-          when Array
-            message.join(' ')
-          else
-            message
-        end
-      end
     end
 
     # Raised when API endpoint returns the HTTP status code 400.

data/lib/dingbot/message/action_card.rb

@@ -2,14 +2,35 @@ module DingBot
   module Message
 
     # ActionCard基类
+    #   {
+    #     "msgtype": "actionCard",
+    #     "actionCard": {
+    #       "title": "乔布斯 20 年前想打造一间苹果咖啡厅，而它正是 Apple Store 的前身",
+    #       "text": "![screenshot](https://img.alicdn.com/tfs/TB1NwmBEL9TBuNjy1zbXXXpepXa-2400-1218.png) \n\n #### 乔布斯 20 年前想打造的苹果咖啡厅 \n\n Apple Store 的设计正从原来满满的科技感走向生活化，而其生活化的走向其实可以追溯到 20 年前苹果一个建立咖啡馆的计划", 
+    #       "btnOrientation": "0",
+    #       "btns": [
+    #           {
+    #               "title": "内容不错",
+    #               "actionURL": "https://www.dingtalk.com/"
+    #           },
+    #           {
+    #               "title": "不感兴趣",
+    #               "actionURL": "https://www.dingtalk.com/"
+    #           }
+    #       ]
+    #     }
+    #     "at":{
+    #        "atMobiles":["137188xxxxx"]
+    #      }
+    # }
     class ActionCard < Base
-      attr_accessor :title, :text, :btn_orientation, :hide_avatar
+      attr_accessor :title, :text, :btn_orientation, :at_mobiles
 
-      def initialize(title='', text='', btn_orientation='0', hide_avatar='0')
+      def initialize(title='', text='', btn_orientation='0', at_mobiles=[])
         @title = title
         @text = text
         @btn_orientation = btn_orientation
-        @hide_avatar = hide_avatar
+        @at_mobiles = at_mobiles
       end
 
       def msg_type
@@ -17,13 +38,16 @@ module DingBot
       end
 
       def body_params
-        super.merge(
+        super.merge({
             actionCard: {
                 title: @title,
                 text: @text,
-                hideAvatar: @hide_avatar,
                 btnOrientation: @btn_orientation,
+            },
+            at: {
+              atMobiles: @at_mobiles,
             }
+          }
         )
       end
     end
@@ -32,8 +56,8 @@ module DingBot
     class WholeActionCard < ActionCard
       attr_accessor :single_title, :single_url
 
-      def initialize(title='', text='', single_title='', single_url='', btn_orientation='0', hide_avatar='0')
-        super(title, text, btn_orientation, hide_avatar)
+      def initialize(title='', text='', single_title='', single_url='', at_mobiles=[], btn_orientation='0')
+        super(title, text, btn_orientation, at_mobiles)
         @single_title = single_title
         @single_url = single_url
       end
@@ -53,8 +77,8 @@ module DingBot
     class IndependentActionCard < ActionCard
       attr_accessor :buttons
 
-      def initialize(title='', text='', buttons=[], btn_orientation='0', hide_avatar='0')
-        super(title, text, btn_orientation, hide_avatar)
+      def initialize(title='', text='', buttons=[], at_mobiles=[], btn_orientation='0')
+        super(title, text, btn_orientation, at_mobiles)
         @buttons = buttons
       end
 

data/lib/dingbot/version.rb

@@ -1,5 +1,5 @@
 module DingBot
 
-  VERSION = "0.2.3"
+  VERSION = "0.2.5"
 
 end

data/lib/dingbot.rb

@@ -38,7 +38,7 @@ module DingBot
   #
   # @return [Array<Symbol>]
   def self.actions
-    hidden = /access_token|post|validate|httparty/
+    hidden = /access_token|post|validate|httparty|secret/
     (DingBot::Client.instance_methods - Object.methods).reject {|e| e[hidden]}
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dingbot
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.5
 platform: ruby
 authors:
 - Thierry Xing
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-29 00:00:00.000000000 Z
+date: 2021-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -133,8 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: 钉钉自定义机器人Ruby库