dingtalk-client 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d022dedfab5d7f9a0d748cd6b4980d06e31cd6d9da60f4ab7f2ff0f993649251
-  data.tar.gz: 9cd2078604639e907cf88e3ace74da9d6d263faf4acba459595efaa60d0be3ef
+  metadata.gz: 9bfd72745e2e87e8bf338fa656d911879121f390179fd1627241f951c85c8e02
+  data.tar.gz: 502532b3b827eb0da21fd3560b679ac1f91f5d27f9beafa664f71810d0745f8b
 SHA512:
-  metadata.gz: 3fc278827c664dacbccce92268eebd7bc824ec851bdad1d541b292c3244ed94aa6cd2993919797f58aad75925be78262b989658d4d2fd4b5a44886a0c6d9676a
-  data.tar.gz: 4cf5370fbe4e8367b7468b822b6d07718696ae2dce42c7dbdc3b098886571fd50b86834a116d9fd1e3447bc42d7ccc890f45af7c48a90f6fd294d23ce5843ee5
+  metadata.gz: aa1d0e914f5d267f41e4fbd2d118dbee9ece415a4f886bc32870bf6b91b197a3ce5acfd300f1847204fef74298b4105ce652d52c9897694ed8f8ee0f9c137cb7
+  data.tar.gz: 629963615bee02162628f74f85fb85f1b3444e0a2a965d6c6e23506db9050dcb6b617694d9de1ee95191a4d4aae1c871a0ec5c9849b6c0157871d35b1a04dbfc

data/.gitignore

@@ -6,3 +6,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+/.ruby-version
+/.byebug_history

data/.travis.yml

@@ -1,8 +1,8 @@
 language: ruby
 rvm:
-  - 2.3.7
-  - 2.4.4
-  - 2.5.1
+  - 2.3.8
+  - 2.4.5
+  - 2.5.3
 cache: bundler
 script:
   - bundle exec rspec

data/Gemfile

@@ -11,5 +11,5 @@ gem 'byebug'
 gem 'codecov', '>= 0.1.10', require: false
 gem 'rake', '~> 10.0'
 gem 'rspec', '~> 3.7', require: false
-gem 'rubocop', '~> 0.58.1', require: false
+gem 'rubocop', '~> 0.60.0', require: false
 gem 'simplecov', require: false

data/Gemfile.lock

@@ -1,23 +1,37 @@
 PATH
   remote: .
   specs:
-    dingtalk-client (0.1.0)
+    dingtalk-client (0.2.0)
+      activesupport (~> 5.2.1)
+      httparty (~> 0.16.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (5.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
     ast (2.4.0)
     byebug (10.0.2)
     codecov (0.1.10)
       json
       simplecov
       url
+    concurrent-ruby (1.0.5)
     diff-lcs (1.3)
     docile (1.3.1)
+    httparty (0.16.2)
+      multi_xml (>= 0.5.2)
+    i18n (1.1.1)
+      concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.1)
     json (2.1.0)
+    minitest (5.11.3)
+    multi_xml (0.6.0)
     parallel (1.12.1)
-    parser (2.5.1.2)
+    parser (2.5.3.0)
       ast (~> 2.4.0)
     powerpack (0.1.2)
     rainbow (3.0.0)
@@ -35,20 +49,23 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
-    rubocop (0.58.2)
+    rubocop (0.60.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
       parser (>= 2.5, != 2.5.1.1)
       powerpack (~> 0.1)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.0, >= 1.0.1)
+      unicode-display_width (~> 1.4.0)
     ruby-progressbar (1.10.0)
     simplecov (0.16.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
     unicode-display_width (1.4.0)
     url (0.3.2)
 
@@ -62,8 +79,8 @@ DEPENDENCIES
   dingtalk-client!
   rake (~> 10.0)
   rspec (~> 3.7)
-  rubocop (~> 0.58.1)
+  rubocop (~> 0.60.0)
   simplecov
 
 BUNDLED WITH
-   1.16.6
+   1.17.1

data/dingtalk-client.gemspec

@@ -25,4 +25,6 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.5'
   spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_dependency 'activesupport', '~> 5.2.1'
+  spec.add_dependency 'httparty',      '~> 0.16.2'
 end

data/lib/dingtalk/client.rb

@@ -1,11 +1,21 @@
 # frozen_string_literal: true
 
-require 'dingtalk/client/version'
+require 'httparty'
+require 'active_support/all'
+require 'dingtalk/client/errors'
+require 'dingtalk/client/result'
+require 'dingtalk/client/configurable'
 
 module Dingtalk
   # DingTalk Client
   # @see https://open-doc.dingtalk.com/
   module Client
-    # Your code goes here...
+    extend ActiveSupport::Autoload
+    autoload :GroupRobotClient
+    include Configurable
+
+    def self.included(base)
+      base.include GroupRobotClient
+    end
   end
 end

data/lib/dingtalk/client/configurable.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Dingtalk
+  module Client
+    # @example Config single item
+    #   Dingtalk::Client.group_robot_tokens = { default: 'TOKENXXXXXXXXXXX' }
+    # @example Config multiple items
+    #   Dingtalk::Client.configure do |config|
+    #     config.group_robot_tokens         = { default: 'TOKENXXXXXXXBBXX' }
+    #     config.group_robot_webhook_prefix = 'http://dingtalk.com?access_token='
+    #   end
+    module Configurable
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      # @see Configurable
+      module ClassMethods
+        def configure
+          yield config
+        end
+
+        def config
+          @config ||= Configuration.new
+        end
+      end
+
+      # @see Configurable
+      class Configuration
+        attr_writer :group_robot_tokens, :group_robot_webhook_prefix, :template_dir
+
+        def initialize
+          @group_robot_webhook_prefix = 'https://oapi.dingtalk.com/robot/send?access_token='
+          @template_dir               = '.'
+        end
+
+        def group_robot_tokens
+          return @group_robot_tokens.symbolize_keys if @group_robot_tokens.is_a?(Hash)
+
+          raise ConfigurationError.new(:group_robot_tokens, @group_robot_tokens, Hash)
+        end
+
+        def group_robot_webhook_prefix
+          String(@group_robot_webhook_prefix)
+        end
+
+        def template_dir
+          String(@template_dir)
+        end
+      end
+    end
+  end
+end

data/lib/dingtalk/client/errors.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Dingtalk
+  module Client
+    # Basic exception
+    class Error < StandardError; end
+
+    # :nodoc:
+    class ConfigurationError < Error
+      attr_reader :key, :value, :valid_values
+
+      def initialize(key, value, valid_values)
+        @key          = key
+        @valud        = value
+        @valid_values = valid_values
+        valid_values_str = Array(valid_values).join(', ')
+        message = if value.blank?
+                    "#{key} not configured or configured with blank value, valid_values: #{valid_values_str}"
+                  else
+                    "Configure #{key} with value #{value} failed, valid_values: #{valid_values_str}"
+                  end
+        super(message)
+      end
+    end
+  end
+end

data/lib/dingtalk/client/group_robot_client.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'dingtalk/client/group_robot_client/core'
+require 'dingtalk/client/group_robot_client/notify_text'
+require 'dingtalk/client/group_robot_client/notify_markdown'
+require 'dingtalk/client/group_robot_client/notify_feedcard'
+
+module Dingtalk
+  module Client
+    # @see https://open-doc.dingtalk.com/microapp/serverapi2/qf2nxq
+    module GroupRobotClient
+      include HTTParty
+      include Core
+      include NotifyText
+      include NotifyMarkdown
+      include NotifyFeedcard
+      base_uri Dingtalk::Client.config.group_robot_webhook_prefix
+      headers  'Content-Type' => 'application/json'
+      logger   ::Logger.new($stdout), :debug, :curl
+    end
+  end
+end

data/lib/dingtalk/client/group_robot_client/core.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Dingtalk
+  module Client
+    module GroupRobotClient
+      # Group Bobot core functions
+      module Core
+        private
+
+        # @param token_code [Symbol]
+        def fetch_token(token_code)
+          Dingtalk::Client.config.group_robot_tokens[token_code].tap do |token|
+            raise ArgumentError, "Not found token code: #{token_code}" unless token
+          end
+        end
+
+        # @param token [String]
+        # @param body  [Hash]
+        def notify(token, body)
+          response = GroupRobotClient.post(token, body: body.to_json)
+          if response.parsed_response.try(:[], 'errcode').try(:zero?)
+            Result.new(true)
+          else
+            message = <<-MESSAGE.gsub(/^\s+/, '')
+              HTTP Status:   #{response.code} #{response.message}
+              Response Body: #{response.body}
+            MESSAGE
+            Result.new(false, message: message)
+          end
+        rescue StandardError => exception
+          Result.new(false, message: exception.inspect)
+        end
+      end
+    end
+  end
+end

data/lib/dingtalk/client/group_robot_client/notify_feedcard.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Dingtalk
+  module Client
+    module GroupRobotClient
+      # @see https://open-doc.dingtalk.com/microapp/serverapi2/qf2nxq#a-nameytovydamarkdown%E7%B1%BB%E5%9E%8B
+      module NotifyFeedcard
+        # @param code    [Symbol] set token_code and template_file
+        # @param links   [Array<Hash>, Hash]
+        def notify_feedcard(code, links)
+          token_code = code.to_sym
+          token = fetch_token(token_code)
+          links = Array.wrap(links).map do |link|
+            Hash(link).symbolize_keys.tap do |hash|
+              required_keys = %i[title messageURL picURL]
+              keys_valid = required_keys.all? { |arg| hash[arg].present? }
+              raise ArgumentError, "links requires these keys present: #{required_keys.join(', ')}" unless keys_valid
+            end
+          end
+          body = get_feedcard_body(links)
+          notify(token, body)
+        end
+
+        private
+
+        # @param links [Array<Hash>]
+        # @return [Hash]
+        def get_feedcard_body(links)
+          {
+            msgtype: 'feedCard',
+            feedCard: {
+              links: links
+            }
+          }
+        end
+      end
+    end
+  end
+end

data/lib/dingtalk/client/group_robot_client/notify_markdown.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Dingtalk
+  module Client
+    module GroupRobotClient
+      # @see https://open-doc.dingtalk.com/microapp/serverapi2/qf2nxq#a-nameytovydamarkdown%E7%B1%BB%E5%9E%8B
+      module NotifyMarkdown
+        # @param code  [Symbol] set token_code and template_file
+        # @param title [String]
+        # @option options [String]  template_file (code)  without file suffix
+        # @option options [Boolean] is_at_all     (false)
+        # @option options [Array]   at_mobiles    ([])
+        def notify_markdown(code, title, **options)
+          options.with_defaults!(
+            template_file: code,
+            is_at_all: false,
+            at_mobiles: []
+          )
+          token_code = code.to_sym
+          token = fetch_token(token_code)
+          title = String(title)
+          template_file = String(options[:template_file])
+          is_at_all = is_at_all != false
+          at_mobiles = Array(at_mobiles)
+          content = get_markdown_content(template_file)
+          body = get_markdown_body(title, content, is_at_all, at_mobiles)
+          notify(token, body)
+        end
+
+        private
+
+        # @param template_file [String]
+        def get_markdown_content(template_file)
+          path = "#{Dingtalk::Client.config.template_dir}/#{template_file}.markdown.erb"
+          ERB.new(File.read(path)).result(binding)
+        rescue Errno::ENOENT
+          raise ArgumentError, "Not found template: #{File.expand_path(path)}"
+        end
+
+        # @param title      [String]
+        # @param content    [String]
+        # @param is_at_all  [Boolean]
+        # @param at_mobiles [Array]
+        # @return [Hash]
+        def get_markdown_body(title, content, is_at_all, at_mobiles)
+          {
+            msgtype: 'markdown',
+            markdown: {
+              title: title,
+              text: content
+            },
+            at: {
+              atMobiles: at_mobiles,
+              isAtAll: is_at_all
+            }
+          }
+        end
+      end
+    end
+  end
+end

data/lib/dingtalk/client/group_robot_client/notify_text.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Dingtalk
+  module Client
+    module GroupRobotClient
+      # @see https://open-doc.dingtalk.com/microapp/serverapi2/qf2nxq#a-nameytovydamarkdown%E7%B1%BB%E5%9E%8B
+      module NotifyText
+        # @param code    [Symbol] set token_code and template_file
+        # @param content [String]
+        # @option options [String]  template_file (code)  without file suffix
+        # @option options [Boolean] is_at_all     (false)
+        # @option options [Array]   at_mobiles    ([])
+        def notify_text(code, content, **options)
+          options.with_defaults!(
+            is_at_all: false,
+            at_mobiles: []
+          )
+          token_code = code.to_sym
+          token = fetch_token(token_code)
+          content = String(content)
+          is_at_all = is_at_all != false
+          at_mobiles = Array(at_mobiles)
+          body = get_text_body(content, is_at_all, at_mobiles)
+          notify(token, body)
+        end
+
+        private
+
+        # @param content    [String]
+        # @param is_at_all  [Boolean]
+        # @param at_mobiles [Array]
+        # @return [Hash]
+        def get_text_body(content, is_at_all, at_mobiles)
+          {
+            msgtype: 'text',
+            text: {
+              content: content
+            },
+            at: {
+              atMobiles: at_mobiles,
+              isAtAll: is_at_all
+            }
+          }
+        end
+      end
+    end
+  end
+end

data/lib/dingtalk/client/result.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Dingtalk
+  module Client
+    # HTTP Response result
+    class Result
+      attr_reader :status, :message
+
+      # @param status  [Boolean]
+      # @param message [String]  ('')
+      def initialize(status, message: '')
+        @status  = status != false
+        @message = message.to_s
+      end
+
+      def failed?
+        !success?
+      end
+
+      def success?
+        status
+      end
+    end
+  end
+end

data/lib/dingtalk/client/version.rb

@@ -2,6 +2,6 @@
 
 module Dingtalk
   module Client
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dingtalk-client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Pine Wong
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-29 00:00:00.000000000 Z
+date: 2018-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.1
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.2
 description: A simple HTTP client wrapper for Dingtalk.
 email:
 - pinewong@163.com
@@ -33,7 +61,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
-- ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -44,6 +71,14 @@ files:
 - bin/setup
 - dingtalk-client.gemspec
 - lib/dingtalk/client.rb
+- lib/dingtalk/client/configurable.rb
+- lib/dingtalk/client/errors.rb
+- lib/dingtalk/client/group_robot_client.rb
+- lib/dingtalk/client/group_robot_client/core.rb
+- lib/dingtalk/client/group_robot_client/notify_feedcard.rb
+- lib/dingtalk/client/group_robot_client/notify_markdown.rb
+- lib/dingtalk/client/group_robot_client/notify_text.rb
+- lib/dingtalk/client/result.rb
 - lib/dingtalk/client/version.rb
 homepage: https://github.com/pinewong/dingtalk-client
 licenses: []
@@ -64,7 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: A simple HTTP client wrapper for Dingtalk.

data/.ruby-version

@@ -1 +0,0 @@
-2.5.1