dingtalk-robot 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5610c1eb754261c791d47dea3e5d27f3f42b51e7865ea250b49a9acf52d919b2
-  data.tar.gz: ab3d436f7ea8acc7ddb1aec8521547845da90c89713671e30222f6b109d15f82
+  metadata.gz: 97b1c273fef2a375e19ecd2381ddc54d2fa63e24e75e009950c7f7d90344abb6
+  data.tar.gz: 37727da06b77aa56244ed350b6b521afee42e7a446c16caa1bff822de72d6dc7
 SHA512:
-  metadata.gz: 80806218ea40567fa48584dd7c5af3b45ba750d00f4bf2d6f47ea2bb185b8c0580c4a58a1ef791c5697a9b444925b8d97bb27123a4f7feb0f5e66959d6dc951d
-  data.tar.gz: b05e185d0d1eefd1588548013bbeafdc44e6c613573c6f028f3bce94cb7718d96f2b8fa7ea23cd5d27e4ed9752a5257b0fd12c842cb2e240be302ebba7b426d5
+  metadata.gz: d668b0fa121bf6d758657668f4c99d0fa9604b3161a3a25c04667710d0290d906e91916c3d87f260f1ba276fb9b505608ea3f4e41ccabfdbef4f5dc1d8d242a7
+  data.tar.gz: c132ab63e4a0eddf88f459c24c4cb3e76a25261f6bdd25b2651aad5d84aa22d9ac84851328ce8bd760580acacc4e8b0fb024a3bfbfbad9681f971a56482135e7

data/.gitignore

@@ -6,3 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+/.byebug_history
+/.DS_Store
+/Gemfile.lock
+/.ruby-version

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.3
 Metrics/LineLength:
   Max: 120
 Metrics/MethodLength:

data/Gemfile

@@ -7,7 +7,6 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 # Specify your gem's dependencies in active_notifier.gemspec
 gemspec
 
-gem 'bundler', '~> 1.16'
 gem 'byebug'
 gem 'codecov', '>= 0.1.10', require: false
 gem 'rake', '~> 10.0'

data/README.md

@@ -1,6 +1,6 @@
-# Dingtalk::Robot
+# Dingtalk Robot
 
-A simple wrapper for [DingTalk Group Robot](https://open-doc.dingtalk.com/microapp/serverapi2/qf2nxq).
+A simple wrapper for [Dingtalk Group Robot](https://open-doc.dingtalk.com/microapp/serverapi2/qf2nxq).
 
 [![Gem Version](https://badge.fury.io/rb/dingtalk-robot.svg)](https://rubygems.org/gems/dingtalk-robot)
 [![Build Status](https://travis-ci.org/pinewong/dingtalk-robot.svg)](https://travis-ci.org/pinewong/dingtalk-robot)
@@ -29,7 +29,20 @@ $ gem install dingtalk-robot
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+# Config api token and message template directory
+Dingtalk::Robot.config.tokens       = { order: 'WEBHOOK...' }
+Dingtalk::Robot.config.template_dir = '.'
+system %q(echo 'hello, <%= @name %>' > order.text.erb)
+
+# Notify message
+robot = Dingtalk::Robot.new(:order) { @name = 'Pine Wong' }
+robot.notify
+```
+
+## Help and Docs
+
+* [RDoc](https://www.rubydoc.info/github/pinewong/dingtalk-robot)
 
 ## Development
 

data/dingtalk-robot.gemspec

@@ -10,8 +10,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Pine Wong']
   spec.email         = ['pinewong@163.com']
 
-  spec.summary       = 'A simple wrapper for DingTalk Group Robot.'
-  spec.description   = 'A simple wrapper for DingTalk Group Robot.'
+  spec.summary       = 'A simple wrapper for Dingtalk Group Robot.'
+  spec.description   = 'A simple wrapper for Dingtalk Group Robot.'
   spec.homepage      = 'https://github.com/pinewong/dingtalk-robot'
 
   # Specify which files should be added to the gem when it is released.
@@ -23,5 +23,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '>= 2.3'
+  spec.add_dependency 'activesupport', '~> 5.0'
   spec.add_development_dependency 'bundler', '~> 1.16'
 end

data/lib/dingtalk/robot.rb

@@ -1,11 +1,78 @@
 # frozen_string_literal: true
 
-require 'dingtalk/robot/version'
+require 'active_support/all'
+require 'net/http'
+require 'dingtalk/robot/configurable'
+require 'dingtalk/robot/errors'
+require 'dingtalk/robot/strategies/text_strategy'
+require 'dingtalk/robot/strategies/markdown_strategy'
 
 module Dingtalk
   # DingTalk Group Robot
   # @see https://open-doc.dingtalk.com/microapp/serverapi2/qf2nxq
-  module Robot
-    # Your code goes here...
+  class Robot
+    include Configurable
+    delegate :notify, to: :message_strategy
+
+    # @param channel      [#to_sym] Set both api token and message template
+    # @param message_type [#to_sym] (:text) Message type
+    # @example
+    #   # Config api token and message template directory
+    #   Dingtalk::Robot.config.tokens       = { order: 'WEBHOOK...' }
+    #   Dingtalk::Robot.config.template_dir = '.'
+    #   system %q(echo 'hello, <%= @name %>' > order.text.erb)
+    #
+    #   # Notify message
+    #   robot = Dingtalk::Robot.new(:order) { @name = 'Pine Wong' }
+    #   robot.notify
+    def initialize(channel, message_type = nil, &context_block)
+      @channel = channel.to_sym
+      self.message_type = message_type&.to_sym
+      @context_block = context_block
+    end
+
+    private
+
+    attr_reader :channel, :message_type, :context_block
+    delegate :config, to: :class
+
+    # @param message_type [Symbol, nil]
+    def message_type=(message_type)
+      @message_type = message_type || begin
+        template_paths = Dir["#{config.template_dir}/#{channel}.*.erb"]
+        if template_paths.empty?
+          raise ArgumentError, "Undefined channel template, channel: #{channel}, template_dir: #{config.template_dir}"
+        end
+        types = template_paths.map do |template_path|
+          template_path[%r{#{config.template_dir}/#{channel}.([a-zA-Z]+).erb}, 1].to_sym
+        end
+        types.include?(config.message_type) ? config.message_type : types.first
+      end
+      valid = VALID_MESSAGE_TYPES.include?(@message_type)
+      raise ConfigurationError.new(:message_type, @message_type, VALID_MESSAGE_TYPES) unless valid
+    end
+
+    def message_strategy
+      self.class.const_get("#{message_type.to_s.camelize}Strategy").new(webhook_url, message)
+    end
+
+    def webhook_url
+      token = config.tokens[channel]
+      raise ArgumentError, "Undefined channel token, channel: #{channel}, tokens: #{config.tokens}" unless token
+      "#{WEBHOOK_BASE_URL}#{token}"
+    end
+
+    def message
+      path = "#{config.template_dir}/#{channel}.#{message_type}.erb"
+      ERB.new(File.read(path)).result(context)
+    rescue Errno::ENOENT
+      raise ArgumentError, "Undefined channel template, channel: #{channel}, path: #{path}"
+    end
+
+    def context
+      blank_object = Object.new
+      blank_object.instance_eval(&context_block) if context_block
+      blank_object.instance_eval { binding }
+    end
   end
 end

data/lib/dingtalk/robot/configurable.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Dingtalk
+  class Robot
+    VALID_MESSAGE_TYPES = Dir["#{__dir__}/strategies/*"].map { |path| File.basename(path, '_strategy.rb').to_sym }
+    WEBHOOK_BASE_URL = 'https://oapi.dingtalk.com/robot/send?access_token='
+
+    # @example Config single item
+    #   Dingtalk::Robot.tokens = { default: 'TOKENXXXXXXXXXXX' }
+    # @example Config multiple items
+    #   Dingtalk::Robot.configure do |config|
+    #     config.tokens       = { defautl: 'TOKENXXXXXXXXX' }
+    #     config.message_type = :markdown
+    #     config.template_dir = 'app/views/dingtalk/robot'
+    #   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_reader :message_type
+
+        def initialize
+          self.message_type = :text
+        end
+
+        def tokens=(tokens)
+          @tokens = tokens.to_h.symbolize_keys!
+        end
+
+        def tokens
+          @tokens.presence || (raise ConfigurationError.new(:tokens, @tokens, Hash))
+        end
+
+        def template_dir=(template_dir)
+          @template_dir = template_dir.to_s
+        end
+
+        def template_dir
+          @template_dir.presence || (raise ConfigurationError.new(:template_dir, @template_dir, String))
+        end
+
+        def message_type=(message_type)
+          unless VALID_MESSAGE_TYPES.include?(message_type.to_sym)
+            raise ConfigurationError.new(:message_type, message_type, VALID_MESSAGE_TYPES)
+          end
+          @message_type = message_type.to_sym
+        end
+      end
+    end
+  end
+end

data/lib/dingtalk/robot/errors.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Dingtalk
+  class Robot
+    # 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/robot/strategies/markdown_strategy.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Dingtalk
+  class Robot
+    # Markdown type strategy for sending message
+    class MarkdownStrategy
+      def initialize(webhook_url, message)
+        @webhook_url = webhook_url
+        @message = message
+      end
+
+      # @option options [String]        :title      (required)
+      # @option options [Array<String>] :at_mobiles
+      # @option options [Boolean]       :is_at_all
+      def notify(**options)
+        title = options[:title].to_s
+        raise ArgumentError, 'title must be present, strategy: markdown' if title.empty?
+        at_mobiles = options[:at_mobiles].to_a
+        is_at_all  = options[:is_at_all] ? true : false
+        body = generate_body(title, at_mobiles, is_at_all)
+        headers = {
+          'Content-Type': 'application/json',
+          Accept: 'application/json'
+        }
+        Net::HTTP.post(URI(webhook_url), body.to_json, headers).body
+      end
+
+      private
+
+      attr_reader :webhook_url, :message
+
+      def generate_body(title, at_mobiles, is_at_all)
+        {
+          msgtype: :markdown,
+          markdown: {
+            title: title,
+            text: message
+          },
+          at: {
+            atMobiles: at_mobiles,
+            isAtAll: is_at_all
+          }
+        }
+      end
+    end
+  end
+end

data/lib/dingtalk/robot/strategies/text_strategy.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Dingtalk
+  class Robot
+    # Text type strategy for sending message
+    class TextStrategy
+      def initialize(webhook_url, message)
+        @webhook_url = webhook_url
+        @message = message
+      end
+
+      # @option options [Array<String>] :at_mobiles
+      # @option options [Boolean]       :is_at_all
+      def notify(**options)
+        at_mobiles = options[:at_mobiles].to_a
+        is_at_all  = options[:is_at_all] ? true : false
+        body = generate_body(at_mobiles, is_at_all)
+        headers = {
+          'Content-Type': 'application/json',
+          Accept: 'application/json'
+        }
+        Net::HTTP.post(URI(webhook_url), body.to_json, headers).body
+      end
+
+      private
+
+      attr_reader :webhook_url, :message
+
+      def generate_body(at_mobiles, is_at_all)
+        {
+          msgtype: :text,
+          text: {
+            content: message
+          },
+          at: {
+            atMobiles: at_mobiles,
+            isAtAll: is_at_all
+          }
+        }
+      end
+    end
+  end
+end

data/lib/dingtalk/robot/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Dingtalk
-  module Robot
-    VERSION = '0.1.0'
+  class Robot
+    VERSION = '0.2.0'
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: dingtalk-robot
 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-09-16 00:00:00.000000000 Z
+date: 2018-09-17 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -24,7 +38,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.16'
-description: A simple wrapper for DingTalk Group Robot.
+description: A simple wrapper for Dingtalk Group Robot.
 email:
 - pinewong@163.com
 executables: []
@@ -33,17 +47,19 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
-- ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - dingtalk-robot.gemspec
 - lib/dingtalk/robot.rb
+- lib/dingtalk/robot/configurable.rb
+- lib/dingtalk/robot/errors.rb
+- lib/dingtalk/robot/strategies/markdown_strategy.rb
+- lib/dingtalk/robot/strategies/text_strategy.rb
 - lib/dingtalk/robot/version.rb
 homepage: https://github.com/pinewong/dingtalk-robot
 licenses: []
@@ -56,7 +72,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -67,5 +83,5 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: A simple wrapper for DingTalk Group Robot.
+summary: A simple wrapper for Dingtalk Group Robot.
 test_files: []

data/.ruby-version

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

data/Gemfile.lock

@@ -1,69 +0,0 @@
-PATH
-  remote: .
-  specs:
-    dingtalk-robot (0.1.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.0)
-    byebug (10.0.2)
-    codecov (0.1.10)
-      json
-      simplecov
-      url
-    diff-lcs (1.3)
-    docile (1.3.1)
-    jaro_winkler (1.5.1)
-    json (2.1.0)
-    parallel (1.12.1)
-    parser (2.5.1.2)
-      ast (~> 2.4.0)
-    powerpack (0.1.2)
-    rainbow (3.0.0)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    rubocop (0.58.2)
-      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)
-    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)
-    unicode-display_width (1.4.0)
-    url (0.3.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.16)
-  byebug
-  codecov (>= 0.1.10)
-  dingtalk-robot!
-  rake (~> 10.0)
-  rspec (~> 3.7)
-  rubocop (~> 0.58.1)
-  simplecov
-
-BUNDLED WITH
-   1.16.2