dingbot 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6fde2528dbfb40522dd9de78bf0445be9a091ec1
-  data.tar.gz: da075b21786be72f62909ffeefa5195e33c09c02
+  metadata.gz: 7f9a46ca05f2961d757a47927595c3300ebd59b1
+  data.tar.gz: 7a5114129dcfe3883f9269419f233a7d701a2609
 SHA512:
-  metadata.gz: 2cff4f93367b5cc9f44a092e1059bbd8294df0a4c8ecf1cd0f249090a52e53b16e9a388e219df23632e23879474dc19b39de5ef007ae8961236e0a2bf23a0bce
-  data.tar.gz: ea07b506bcee57bde8a0d3b886a0aa15469f36ba1ff800d7658c35e8cfa60fcd17e1ca64c123336e15b0cc810582316f4278730a7f15769f9a5738c8fa3ee355
+  metadata.gz: 9de7eead38333a685c6b28f5e53d0edf81193201ea7434647045d7b166a50bdf0eeb652964f54699b39bfe761a1873e7b4e3ae43caa07c664183d7b281f79d45
+  data.tar.gz: 35f8cbd6429e2197e3e44463188c323d29e76fc13904ee41093c520cad2cc07a689d09e0c20bbb8e36b4d6bec35174a7baa324f3aaaf061b304a30495bc60ec8

data/.gitignore

@@ -8,3 +8,4 @@
 /spec/reports/
 /tmp/
 .idea
+*.gem

data/README.md

@@ -1,4 +1,6 @@
 # DingTalk Bot
+[![Gem Version](https://badge.fury.io/rb/dingbot.svg)](https://badge.fury.io/rb/dingbot.svg)
+[![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). 
@@ -22,56 +24,87 @@ gem 'dingbot'
 初始化客户端:
 
 ```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 的前身',
-                                                '![screenshot](@lADOpwk3K80C0M0FoA) ### 乔布斯 20 年前想打造的苹果咖啡厅',
-                                                '0',
-                                                '0',
-                                                '阅读全文',
-                                                'https://www.dingtalk.com/')
-client.send_msg(message)
-    
+def send_whole_action_card
+  message = DingBot::Message::WholeActionCard.new(
+      '乔布斯 20 年前想打造一间苹果咖啡厅，而它正是 Apple Store 的前身',
+      '![screenshot](@lADOpwk3K80C0M0FoA) ### 乔布斯 20 年前想打造的苹果咖啡厅',
+      '阅读全文',
+      'https://www.dingtalk.com/'
+  )
+  DingBot.send_msg(message)
+end
+
 # 发送独立跳转ActionCard类型消息
-message = DingBot::Message::IndependentActionCard.new('乔布斯 20 年前想打造一间苹果咖啡厅，而它正是 Apple Store 的前身',
-                                                      '![screenshot](@lADOpwk3K80C0M0FoA) ### 乔布斯 20 年前想打造的苹果咖啡厅',
-                                                      '0',
-                                                      '0',
-                                                      [
-                                                         DingBot::Message::ActionBtn.new('内容不错', 'https://www.dingtalk.com/'),
-                                                         DingBot::Message::ActionBtn.new('不感兴趣', 'https://www.dingtalk.com/')
-                                                      ])
-client.send_msg(message)                                                                 
-
-# 发送FeedCard类型                                            
-message = DingBot::Message::FeedCard.new([
-                                           DingBot::Message::FeedCardLink.new('时代的火车向前开',
-                                                                              'https://avatars1.githubusercontent.com/u/64818',
-                                                                              'https://www.dingtalk.com/')
-                                         ])
-client.send_msg(message)                              
+def send_independent_action_card
+  message = DingBot::Message::IndependentActionCard.new(
+      '乔布斯 20 年前想打造一间苹果咖啡厅，而它正是 Apple Store 的前身',
+      '![screenshot](@lADOpwk3K80C0M0FoA) ### 乔布斯 20 年前想打造的苹果咖啡厅',
+      [
+          DingBot::Message::ActionBtn.new('内容不错', 'https://www.dingtalk.com/'),
+          DingBot::Message::ActionBtn.new('不感兴趣', 'https://www.dingtalk.com/')
+      ]
+  )
+  DingBot.send_msg(message)
+end
+
+# 发送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)
 

data/dingbot.gemspec

@@ -29,8 +29,9 @@ Gem::Specification.new do |spec|
   spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{^exe/}) {|f| File.basename(f)}
   spec.require_paths = ["lib"]
+  spec.required_ruby_version = ">= 2.0.0"
 
-  spec.add_runtime_dependency 'httparty', "~> 0.15.5"
+  spec.add_runtime_dependency "httparty"
   spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"

data/lib/dingbot.rb

@@ -1,6 +1,7 @@
 require "dingbot/version"
 require 'dingbot/error'
 require 'dingbot/client'
+require 'dingbot/configuration'
 require 'dingbot/message/text'
 require 'dingbot/message/link'
 require 'dingbot/message/markdown'
@@ -8,14 +9,13 @@ require 'dingbot/message/action_card'
 require 'dingbot/message/feed_card'
 
 module DingBot
-
-  ENDPOINT = "https://oapi.dingtalk.com/robot/send"
+  extend Configuration
 
   # Alias for DingBot::Client.new
   #
   # @return [DingBot::Client]
-  def self.client(access_token='')
-    DingBot::Client.new(access_token)
+  def self.client(options={})
+    DingBot::Client.new(options)
   end
 
   # Delegate to DingBot::Client
@@ -38,7 +38,7 @@ module DingBot
   #
   # @return [Array<Symbol>]
   def self.actions
-    hidden = /access_token|post|validate|set_request_defaults|httparty/
+    hidden = /access_token|post|validate|httparty/
     (DingBot::Client.instance_methods - Object.methods).reject {|e| e[hidden]}
   end
 

data/lib/dingbot/client.rb

@@ -1,5 +1,8 @@
 require 'httparty'
+require 'dingbot/configuration'
 require 'dingbot/message/base'
+require 'dingbot/message/text'
+require 'dingbot/message/markdown'
 
 module DingBot
   # @private
@@ -11,8 +14,16 @@ module DingBot
 
     attr_accessor :access_token
 
-    def initialize(access_token='')
-      @access_token = access_token
+    # @private
+    attr_accessor(*Configuration::VALID_OPTIONS_KEYS)
+
+    # Creates a new API.
+    # @raise [Error:MissingCredentials]
+    def initialize(options={})
+      options = DingBot.options.merge(options)
+      (Configuration::VALID_OPTIONS_KEYS).each do |key|
+        send("#{key}=", options[key]) if options[key]
+      end
     end
 
     # Parse response body.
@@ -32,7 +43,17 @@ module DingBot
     end
 
     def send_msg(message)
-      validate self.class.post(DingBot::ENDPOINT, {query: {access_token: @access_token}, body: message.to_json})
+      validate self.class.post(@endpoint, {query: {access_token: @access_token}, body: message.to_json})
+    end
+
+    def send_text(content)
+      message = DingBot::Message::Text.new(content)
+      send_msg(message)
+    end
+
+    def send_markdown(title, text)
+      message = DingBot::Message::Markdown.new(title, text)
+      send_msg(message)
     end
 
     # Checks the response code for common errors.

data/lib/dingbot/configuration.rb

@@ -0,0 +1,40 @@
+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
+
+    # The user agent that will be sent to the API endpoint if none is set.
+    DEFAULT_USER_AGENT = "DingBot Ruby Gem #{DingBot::VERSION}".freeze
+
+    DEFAULT_ENDPOINT = "https://oapi.dingtalk.com/robot/send"
+
+    # @private
+    attr_accessor(*VALID_OPTIONS_KEYS)
+
+    # Sets all configuration options to their default values
+    # when this module is extended.
+    def self.extended(base)
+      base.reset
+    end
+
+    # Convenience method to allow configuration options to be set in a block.
+    def configure
+      yield self
+    end
+
+    # Creates a hash of options and their values.
+    def options
+      VALID_OPTIONS_KEYS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+    # Resets all configuration options to the defaults.
+    def reset
+      self.endpoint = ENV['DINGTALK_ENDPOINT'] || DEFAULT_ENDPOINT
+      self.access_token = ENV['DINGTALK_ACCESS_TOKEN']
+    end
+
+  end
+end

data/lib/dingbot/error.rb

@@ -1,6 +1,6 @@
 module DingBot
   module Error
-    # Custom error class for rescuing from all Sentry errors.
+    # Custom error class for rescuing from all errors.
     class Error < StandardError;
     end
 

data/lib/dingbot/message/action_card.rb

@@ -17,12 +17,14 @@ module DingBot
       end
 
       def body_params
-        super.merge(actionCard: {
-            title: @title,
-            text: @text,
-            "hideAvatar": @hide_avatar,
-            "btnOrientation": @btn_orientation,
-        })
+        super.merge(
+            actionCard: {
+                title: @title,
+                text: @text,
+                "hideAvatar": @hide_avatar,
+                "btnOrientation": @btn_orientation,
+            }
+        )
       end
     end
 
@@ -30,17 +32,19 @@ module DingBot
     class WholeActionCard < ActionCard
       attr_accessor :single_title, :single_url
 
-      def initialize(title='', text='', btn_orientation='0', hide_avatar='0', 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)
         @single_title = single_title
         @single_url = single_url
       end
 
       def body_params
-        action_card = super[:actionCard].merge({
-                                                   singleTitle: @single_title,
-                                                   singleURL: @single_url
-                                               })
+        action_card = super[:actionCard].merge(
+            {
+                singleTitle: @single_title,
+                singleURL: @single_url
+            }
+        )
         super.merge(actionCard: action_card)
       end
     end
@@ -49,7 +53,7 @@ module DingBot
     class IndependentActionCard < ActionCard
       attr_accessor :buttons
 
-      def initialize(title='', text='', btn_orientation='0', hide_avatar='0', buttons=[])
+      def initialize(title='', text='', buttons=[], btn_orientation='0', hide_avatar='0')
         super(title, text, btn_orientation, hide_avatar)
         @buttons = buttons
       end

data/lib/dingbot/message/link.rb

@@ -26,12 +26,14 @@ module DingBot
       end
 
       def body_params
-        super.merge(link: {
-            text: @text,
-            title: @title,
-            picUrl: @pic_url,
-            messageUrl: @message_url
-        })
+        super.merge(
+            link: {
+                text: @text,
+                title: @title,
+                picUrl: @pic_url,
+                messageUrl: @message_url
+            }
+        )
       end
     end
 

data/lib/dingbot/message/markdown.rb

@@ -25,10 +25,12 @@ module DingBot
       end
 
       def body_params
-        super.merge(markdown: {
-            text: @text,
-            title: @title,
-        })
+        super.merge(
+            markdown: {
+                text: @text,
+                title: @title,
+            }
+        )
       end
     end
 

data/lib/dingbot/message/text.rb

@@ -17,7 +17,7 @@ module DingBot
     # }
     class Text < Base
       attr_accessor :content, :at_mobiles, :is_at_all
-
+      
       def initialize(content='', at_mobiles=[], is_at_all=false)
         @content = content
         @at_mobiles = at_mobiles
@@ -29,15 +29,17 @@ module DingBot
       end
 
       def body_params
-        super.merge({
-                        text: {
-                            "content": @content
-                        },
-                        at: {
-                            atMobiles: @at_mobiles,
-                            isAtAll: @is_at_all
-                        }
-                    })
+        super.merge(
+            {
+                text: {
+                    "content": @content
+                },
+                at: {
+                    atMobiles: @at_mobiles,
+                    isAtAll: @is_at_all
+                }
+            }
+        )
       end
     end
 

data/lib/dingbot/version.rb

@@ -1,5 +1,5 @@
 module DingBot
 
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: dingbot
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Thierry Xing
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-18 00:00:00.000000000 Z
+date: 2017-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.15.5
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.15.5
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -104,6 +104,7 @@ files:
 - dingbot.gemspec
 - lib/dingbot.rb
 - lib/dingbot/client.rb
+- lib/dingbot/configuration.rb
 - lib/dingbot/error.rb
 - lib/dingbot/message/action_card.rb
 - lib/dingbot/message/base.rb
@@ -125,7 +126,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="