active_notifier 0.1.0.pre → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99ed29b22b337b7a33b7d90f08a2a59cbb1b281ee1c3f2245d241ac3e1148d7a
-  data.tar.gz: c65c631aba93cf5f449db75c1b23e207847af6d8fcb5777750ec445be986f2af
+  metadata.gz: bbb1a3370063f78b39543cb4d5fc05d8acea444503c2f230f9bfd2d19abdd979
+  data.tar.gz: 81999de8ce52f5cee7ec78f6fadbab107b9ca74fdceef9d34eaee7dc70074867
 SHA512:
-  metadata.gz: 899b5bf5ee71a079e64e570d3c9a7ba0c7b4293a165253a5ad4c582bedec3725ba6e571c5b6e8dd46852573f4682b07355737bad76084dd7117441cd8e78623d
-  data.tar.gz: b8ce6d62b6f320363c010a52217d7506cf449f577b462003c0275ca82283e02a2919f2ccef3905375743e20d29e3cc1695e50c8707b82a27408be589a519f042
+  metadata.gz: 885d46d316433753c76d29c8be098b1f1b8d9c67da748fc0122ce1d54253ad76aaa4b0be76a4f13efe56286ea1284637ca47ed773f58cfcb3cfc9dde1ca87f7f
+  data.tar.gz: d98d5c3cf396d0e8d71fdf29c5121d2fda78e029a3fdfa80a5d9a59935e8274e9a04de877da0ad9d2302999f0dbb2abc012e9f7144fa88e038e6ed93eb3a0992

data/README.md

@@ -32,8 +32,8 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/active_notifier. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/pinewong/active_notifier. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## Code of Conduct
 
-Everyone interacting in the ActiveNotifier project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/active_notifier/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the ActiveNotifier project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/pinewong/active_notifier/blob/master/CODE_OF_CONDUCT.md).

data/bin/console

@@ -2,6 +2,7 @@
 
 require "bundler/setup"
 require "active_notifier"
+Bundler.require(:default, :development)
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/lib/active_notifier.rb

@@ -14,11 +14,10 @@ module ActiveNotifier
       autoload :Error
       autoload :ConfigureError
       autoload :TemplateNotFoundError
-      autoload :ChannelUndefinedError
       autoload :MessageBlankError
-      autoload :AdapterWebhookInvalidError
       autoload :AdapterTypeInvalidError
       autoload :AdapterOptionsInvalidError
+      autoload :UndefinedTokenError
     end
   end
 
@@ -32,6 +31,6 @@ module ActiveNotifier
   include Adaptable
 
   ActiveSupport.on_load(:after_initialize) do
-    Kernel.const_set(ActiveNotifier.config.const_name, ActiveNotifier)
+    Kernel.const_set(ActiveNotifier.config.const_name || :Notifier, ActiveNotifier)
   end
 end

data/lib/active_notifier/adaptable.rb

@@ -12,7 +12,6 @@ module ActiveNotifier
       def adapt(adapter)
         adapters[adapter.to_sym] ||= begin
           adapter_class = get_adapter_class(adapter)
-          adapter_class.abstract_adapter = abstract_adapter_class
           abstract_adapter_class.new(adapter_class)
         end
       end

data/lib/active_notifier/adapters/abstract_adapter.rb

@@ -6,8 +6,8 @@ module ActiveNotifier
       @adapter = adapter_class.new
     end
 
-    def notify(webhook, type, message, **options)
-      adapter.notify(webhook, type, message, **options)
+    def notify(token, type, message, **options)
+      adapter.notify(token, type, message, **options)
     end
   end
 end

data/lib/active_notifier/adapters/dingtalk_adapter.rb

@@ -1,15 +1,21 @@
 module ActiveNotifier
   class DingtalkAdapter
-    VALID_WEBHOOK_HOSTS = %w[oapi.dingtalk.com].freeze
     VALID_TYPES = %i[markdown].freeze
-    delegate :abstract_adapter, to: :class
 
-    def notify(webhook, type, message, **options)
-      webhook, type, message, options = process_args(webhook, type, message, options)
+    def notify(token, type, message, **options)
+      webhook = "#{ActiveNotifier.config.adapters_with_base_url.fetch(:dingtalk)}#{token}"
+      unless VALID_TYPES.include?(type)
+        error_message = "适配器 type 暂时只支持：#{VALID_TYPES.join(', ')}"
+        raise ActiveNotifier::AdapterTypeInvalidError, error_message
+      end
+      raise ActiveNotifier::MessageBlankError, "消息不能为空, 请检查 template 模板" if message.empty?
+      title = options[:title].to_s
+      raise ActiveNotifier::AdapterOptionsInvalidError, "钉钉适配器还需提供必须值：title" if title.empty?
+
       body = {
         'msgtype' => type,
         type => {
-          'title': options[:title],
+          'title': title,
           'text': message
         }
       }
@@ -19,27 +25,5 @@ module ActiveNotifier
       }
       Net::HTTP.post(URI(webhook), body.to_json, headers)
     end
-
-    private
-
-    def process_args(webhook, type, message, options)
-      if VALID_WEBHOOK_HOSTS.none? { |valid_host| webhook.include?(valid_host) }
-        error_message = "适配器 host 暂时只支持：#{VALID_WEBHOOK_HOSTS.join(', ')}, 如果第三方 API 新增或改变，请联系维护者"
-        raise ActiveNotifier::AdapterWebhookInvalidError, error_message
-      end
-      unless VALID_TYPES.include?(type)
-        error_message = "适配器 type 暂时只支持：#{VALID_TYPES.join(', ')}"
-        raise ActiveNotifier::AdapterTypeInvalidError, error_message
-      end
-      raise ActiveNotifier::MessageBlankError, "消息不能为空, 请检查 template 模板" if message.empty?
-      options[:title] = options[:title].to_s
-      raise ActiveNotifier::AdapterOptionsInvalidError, "适配器选项必须值：title" if options[:title].empty?
-
-      [webhook, type, message, options]
-    end
-
-    class << self
-      attr_accessor :abstract_adapter
-    end
   end
 end

data/lib/active_notifier/configurable.rb

@@ -16,16 +16,12 @@ module ActiveNotifier
 
     class Configuration
       # 常量名, 简化调用, 符号，默认 :Notifier (如果被占用请更换)
-      def const_name
-        @const_name || :Notifier
-      end
+      attr_reader :const_name
 
       def const_name=(const_name)
         const_name = const_name.to_sym
         const_name = "Notifier" if const_name.empty?
-        if Kernel.const_defined?(const_name)
-          raise ActiveNotifier::ConfigureError, "const_name 已经存在，请在 initializers 中定义其他值"
-        end
+        raise ActiveNotifier::ConfigureError, "const_name 已经存在，请配置其他值" if Kernel.const_defined?(const_name)
         Kernel.const_set(const_name, ActiveNotifier)
         @const_name = const_name
       end
@@ -37,28 +33,25 @@ module ActiveNotifier
 
       def adapter=(adapter)
         adapter = adapter.to_sym
-        unless valid_adapters.include?(adapter)
-          raise ActiveNotifier::ConfigureError, "adapter 当前只支持：#{valid_adapters.join(', ')}"
+        unless adapters_with_base_url.key?(adapter)
+          raise ActiveNotifier::ConfigureError, "adapter 当前只支持：#{adapters_with_base_url.keys.join(', ')}"
         end
         @adapter = adapter
       end
 
-      # 消息渠道的 webhook 设置
-      def channel_webhooks
-        @channel_webhooks || {}
+      # 消息渠道的 channel_tokens 设置
+      def channel_tokens
+        @channel_tokens || {}
       end
 
-      def channel_webhooks=(channel_webhooks)
-        channel_webhooks = channel_webhooks.to_h.symbolize_keys
-        unless channel_webhooks.key?(:default) && channel_webhooks[:default].present?
-          raise ActiveNotifier::ConfigureError, "channel_webhooks 请至少设置 default 键"
-        end
-        @channel_webhooks = channel_webhooks
+      def channel_tokens=(channel_tokens)
+        channel_tokens = channel_tokens.to_h.symbolize_keys
+        @channel_tokens = channel_tokens
       end
 
       # 消息模版主目录, 字符串, 默认 views/notifier/application), 不需要加模版后缀
       def template_home
-        @template_home || "#{__dir__}/templates"
+        @template_home || "#{File.expand_path(__dir__)}/templates"
       end
 
       def template_home=(template_home)
@@ -67,17 +60,6 @@ module ActiveNotifier
         @template_home = template_home
       end
 
-      # 消息模版, 字符串, 默认 default($template_home/default), 不需要加模版后缀
-      def template
-        @template || "default"
-      end
-
-      def template=(template)
-        template = template.to_s
-        raise ActiveNotifier::ConfigureError, "模板名不能为空" if template.empty?
-        @template = template
-      end
-
       # 消息优先类型, 字符串, 默认 :markdown, 对应模板后缀名，如果未指定该参数且存在多个模板，则优先选择此类型
       def priority_type
         @priority_type || :markdown
@@ -87,13 +69,11 @@ module ActiveNotifier
         @priority_type = priority_type.to_sym
       end
 
-      private
-
-      def valid_adapters
-        @valid_adapters ||= begin
-          found_adapters = Dir["*_adapter.rb", base: "#{__dir__}/adapters"]
-          found_adapters.map { |adapter| adapter.sub("_adapter.rb", "").to_sym } - [:abstract]
-        end
+      # 适配器以及基本连接
+      def adapters_with_base_url
+        @adapters_with_base_url ||= {
+          dingtalk: "https://oapi.dingtalk.com/robot/send?access_token="
+        }
       end
     end
   end

data/lib/active_notifier/core.rb

@@ -6,35 +6,40 @@ module ActiveNotifier
 
     module ClassMethods
       # Params:
+      #   channel: 消息渠道, 符号,
+      #            例如设置为 :order, 则使用 channel_tokens[:order] 和 order.markdown.erb 模板发送消息
       #   options:
-      #     channel: 消息渠道, 符号, 默认 :default, 请参照 initializers 中的配置选择
-      #     template: 消息模版, 符号, 默认 :application(views/notifier/application), 不需要加模版后缀
-      #     type: 消息类型, 符号, 默认 :type, 对应模板后缀名
+      #     template: 消息模版, 字符串, 默认 "default", 不需要加模版后缀
+      #     token: webhook token, 类型符号则取 chanenl_tokens[:symbol] 值，类型字符串则使用原值
+      #     type: 消息类型, 符号, 默认 :markdown, 对应模板后缀名
       #     data: 传递数据, Hash, 默认 {}
       #     其他键的值会被当成适配器选项值，直接传到适配器中处理
-      def exec(**options)
-        webhook = get_webhook(options[:channel])
-        template = options[:template]&.to_sym || ActiveNotifier.config.template
-        type = options[:type]&.to_sym || guess_type_by_files(template)
+      def exec(channel, **options)
+        channel = channel&.to_sym
+        raise ArgumentError, "Channel 不能为空" if channel.blank?
+        template = options[:template].to_s.presence || channel.to_s
+        token = get_token(channel, options[:token])
+        raise UndefinedTokenError, "Token 值未定义" if token.blank?
+        type = options[:type]&.to_sym.presence || guess_type_by_files(template)
         data = options[:data].to_h
 
         message = get_message(template, type, data)
         adapter = ActiveNotifier.adapt(ActiveNotifier.config.adapter)
-        adapter_options = options.except(:channel, :template, :type, :data)
-        adapter.notify(webhook, type, message, adapter_options)
+        adapter_options = options.except(:token, :template, :type, :data)
+        adapter.notify(token, type, message, adapter_options)
       end
 
       private
 
-      def get_webhook(channel)
-        if ActiveNotifier.config.channel_webhooks.empty?
-          raise ActiveNotifier::ConfigureError, "请在 initializers 中为 channel_webhooks 至少设置 default 键"
+      def get_token(channel, options_token)
+        case options_token
+        when String
+          options_token
+        when Symbol
+          ActiveNotifier.config.channel_tokens[options_token]
+        else
+          ActiveNotifier.config.channel_tokens[channel]
         end
-        channel = channel&.to_sym
-        return ActiveNotifier.config.channel_webhooks[:default] unless channel
-        error_message = "使用 #{channel} 前，请先在 initializers 中定义"
-        raise ChannelUndefinedError, error_message unless ActiveNotifier.config.channel_webhooks.key?(channel)
-        ActiveNotifier.config.channel_webhooks[channel]
       end
 
       def guess_type_by_files(template)

data/lib/active_notifier/errors.rb

@@ -8,18 +8,15 @@ module ActiveNotifier
   # 模板未找到
   class TemplateNotFoundError < Error; end
 
-  # 使用未定义 channel
-  class ChannelUndefinedError < Error; end
-
   # 消息为空
   class MessageBlankError < Error; end
 
-  # 适配器 webhook 无效
-  class AdapterWebhookInvalidError < Error; end
-
   # 适配器 type 无效
   class AdapterTypeInvalidError < Error; end
 
   # 适配器 options 无效
   class AdapterOptionsInvalidError < Error; end
+
+  # Token 未定义
+  class UndefinedTokenError < Error; end
 end

data/lib/active_notifier/templates/default.markdown.erb

@@ -1 +1 @@
-<%= data[:message].presence || "......" %>
+<%= data %>

data/lib/active_notifier/version.rb

@@ -1,3 +1,3 @@
 module ActiveNotifier
-  VERSION = "0.1.0.pre".freeze
+  VERSION = "0.1.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_notifier
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre
+  version: 0.1.0
 platform: ruby
 authors:
 - Pine Wong
@@ -181,9 +181,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.6