active_notifier 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11d89dfa1aff8c314539b8ff79b5cbb72ed89f98e2fdce3c324a7e8ee097c789
-  data.tar.gz: b8edd79f2f6244a442a2d4bfb603ef0f4e6504971d6c9b4a33b66330f87a60e4
+  metadata.gz: bd10b598192c1508228777489f96764cd880b15da9ab6978250abf8fa5ac19ca
+  data.tar.gz: 002bbc7be0c8a7cc89490a9b863978150d870ac3ce12afa4a641ca76bbeffbda
 SHA512:
-  metadata.gz: 53025b951b32263b901f958d9200fa0eae7c954960a39299a1d249686fdeac091bedeee457256c379a4bd44e09274a02e1c2d613e8b1003c918501cee18be66d
-  data.tar.gz: 2d83333750347d2ec943ac14a273111de68ccb02226898ffea26c4e22792efc460859b1c17306c8cd0c521c9d74ffe3a2399ff098a8338120aed489c4d3dda2d
+  metadata.gz: 14469a324d498c52244cb44053cf310e185f68053aeec83f8f286cffdf52ad2510ef9241fbef246354a9ba9cf597f19127eefa82cffa04b585c2521fbbc91c7c
+  data.tar.gz: 0aba370debb2b69d882165c7dbcc855ee1c6a5194facb0cd03007e0b23af4147996a3e18ef673a3f6f7d60d6d9f3397a1562652aadc1fefc984598c99eaa2bc3

data/.rubocop.yml

@@ -27,3 +27,5 @@ Metrics/ModuleLength:
 Metrics/BlockLength:
   Exclude:
     - "**/*_spec.rb"
+Style/DoubleNegation:
+  Enabled: false

data/Gemfile

@@ -4,3 +4,13 @@ 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"
+gem "rspec", "~> 3.7", require: false
+gem "rubocop", "~> 0.58.1", require: false
+gem "simplecov", require: false
+gem "vcr", "~> 4.0", require: false
+gem "webmock", "~> 3.4", ">= 3.4.2", require: false

data/README.md

@@ -103,7 +103,7 @@ Notifer.exec(...)
 
 * [More Examples](https://github.com/pinewong/active_notifier/blob/master/spec/active_notifier_spec.rb)
 * [RDoc](https://www.rubydoc.info/github/pinewong/active_notifier)
-* [Gem RDoc](http://www.rubydoc.info/gems/active_notifier/0.3.0)
+* [Gem RDoc](http://www.rubydoc.info/gems/active_notifier/0.4.0)
 
 ## Development
 

data/active_notifier.gemspec

@@ -30,15 +30,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "active_adapter", "~> 0.1.0"
   spec.add_dependency "activesupport", "~> 5.0"
-
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "byebug"
-  spec.add_development_dependency "codecov", ">= 0.1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.7"
-  spec.add_development_dependency "rubocop", "~> 0.58.1"
-  spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "vcr", "~> 4.0"
-  spec.add_development_dependency "webmock", "~> 3.4", ">= 3.4.2"
 end

data/lib/active_notifier/configurable.rb

@@ -35,8 +35,9 @@ module ActiveNotifier
       def const_name=(const_name)
         const_name = const_name.to_sym
         const_name = :Notifier if const_name.empty?
-        error_message = "const_name is already defined, please set another value"
-        raise ActiveNotifier::ConfigureError, error_message if Kernel.const_defined?(const_name)
+        if Kernel.const_defined?(const_name)
+          raise ActiveNotifier::ConfigureError, "const_name is already defined, please set another value"
+        end
         Kernel.const_set(const_name, ActiveNotifier)
         @const_name = const_name
       end
@@ -62,7 +63,7 @@ module ActiveNotifier
       end
 
       # Set the tokens of channel
-      # @param channel_tokens [Hash] ({})
+      # @param channel_tokens [#to_h] ({})
       # @example
       #   ActiveNotifier.config.channel_tokens = {
       #     default: "xxx",
@@ -79,7 +80,7 @@ module ActiveNotifier
       end
 
       # Set the template home directory
-      # @param template_home [String] (lib/active_notifier/templates)
+      # @param template_home [#to_s] (lib/active_notifier/templates)
       def template_home=(template_home)
         template_home = template_home.to_s
         raise ActiveNotifier::ConfigureError, "template_home value can't be blank" if template_home.empty?

data/lib/active_notifier/errors.rb

@@ -1,9 +1,11 @@
 module ActiveNotifier
   class Error < StandardError; end
+
   class ConfigureError < Error; end
+
   class TemplateNotFoundError < Error; end
-  class MessageBlankError < Error; end
-  class AdapterTypeInvalidError < Error; end
-  class AdapterOptionsInvalidError < Error; end
+
   class UndefinedTokenError < Error; end
+
+  class AdapterError < Error; end
 end

data/lib/active_notifier/{core.rb → notifiable.rb}

@@ -1,5 +1,5 @@
 module ActiveNotifier
-  module Core
+  module Notifiable
     extend ActiveSupport::Concern
 
     module ClassMethods
@@ -49,11 +49,11 @@ module ActiveNotifier
         data          = options[:data].to_h
         token = fetch_token(token, token_channel, channel)
         template ||= channel
-        type ||= get_type_by_template(template)
+        type ||= get_type_by_template(template) || :text
         message ||= get_message(template, type, data)
         adapter_options = options.except(:token, :message, :token_channel, :template, :adapter, :type, :data)
         adapter ||= ActiveNotifier.config.adapter.to_sym
-        ActiveNotifier.adapt(adapter).notify(token, type, message, adapter_options)
+        notify(adapter, token, type, message, adapter_options)
       end
 
       private
@@ -89,7 +89,7 @@ module ActiveNotifier
       # @param template [Symbol, nil]
       # @param type [Symbol]
       # @param data [Hash]
-      # @return [String, nil]
+      # @return [String]
       def get_message(template, type, data)
         return unless template
         template_data = File.read("#{ActiveNotifier.config.template_home}/#{template}.#{type}.erb")
@@ -97,6 +97,17 @@ module ActiveNotifier
       rescue Errno::ENOENT => e
         raise ActiveNotifier::TemplateNotFoundError, e
       end
+
+      # @param adapter [Symbol]
+      # @param token [String]
+      # @param type [Symbol]
+      # @param message [String]
+      # @param adapter_options [Hash]
+      # @return [Response]
+      def notify(adapter, token, type, message, adapter_options)
+        notifier = ActiveNotifier::Notifier.adapt(adapter)
+        notifier.notify(token, type, message, adapter_options)
+      end
     end
   end
 end

data/lib/active_notifier/notifier.rb

@@ -0,0 +1,7 @@
+require "active_notifier/notifier_adapters/abstract"
+require "active_notifier/notifier_adapters/dingtalk"
+
+module ActiveNotifier
+  class Notifier < ActiveAdapter::Engine
+  end
+end

data/lib/active_notifier/notifier_adapters/abstract.rb

@@ -0,0 +1,20 @@
+module ActiveNotifier
+  module NotifierAdapters
+    class Abstract < ActiveAdapter::Abstract
+      # Notify message
+      #
+      # @abstract Implement through setting a real adapter, like :dingtalk
+      # @param token [String] Channel webhook token
+      # @param type [Symbol] Message type
+      # @param message [String] Message body
+      # @param options [Hash] Adapter message options, some adapters require some another options
+      # @raise [AdapterOptionsInvalidError]
+      # @raise [AdapterTypeInvalidError]
+      # @raise [MessageBlankError]
+      # @see ActiveNotitifier::exec for usage
+      def notify(token, type, message, **options)
+        adapter.notify(token, type, message, **options)
+      end
+    end
+  end
+end

data/lib/active_notifier/notifier_adapters/dingtalk.rb

@@ -0,0 +1,68 @@
+module ActiveNotifier
+  module NotifierAdapters
+    class Dingtalk < ActiveAdapter::Implement
+      VALID_TYPES = %i[text markdown].freeze
+
+      # (see NotifierAdapters::Abstract#notify)
+      # @param title [#to_s]
+      # @param at_mobiles [#to_a] ([])
+      # @param is_at_all [Boolean] (false)
+      def notify(token, type, message, **options)
+        webhook = "#{ActiveNotifier.config.adapters_with_base_url.fetch(:dingtalk)}#{token}"
+        unless VALID_TYPES.include?(type)
+          error_message = "The Dingtalk adapter only support types: #{VALID_TYPES.join(', ')}"
+          raise ActiveNotifier::AdapterError, error_message
+        end
+        if message.empty?
+          error_message = "Message of the Dingtalk adapter can't be blank, please check template file"
+          raise ActiveNotifier::AdapterError, error_message
+        end
+        at_mobiles = options[:at_mobiles].to_a
+        is_at_all = !!options[:is_at_all]
+
+        body = case type
+               when :text
+                 get_text_body(message, at_mobiles, is_at_all)
+               when :markdown
+                 title = options[:title].to_s
+                 raise ActiveNotifier::AdapterError, "Dingtalk adapter require other options: title" if title.empty?
+                 get_markdown_body(title, message, at_mobiles, is_at_all)
+               end
+        headers = {
+          'Content-Type' => 'application/json',
+          'Accept' => 'application/json'
+        }
+        Net::HTTP.post(URI(webhook), body.to_json, headers)
+      end
+
+      private
+
+      def get_text_body(content, at_mobiles, is_at_all)
+        {
+          msgtype: "text",
+          text: {
+            content: content
+          },
+          at: {
+            atMobiles: at_mobiles,
+            isAtAll: is_at_all
+          }
+        }
+      end
+
+      def get_markdown_body(title, text, at_mobiles, is_at_all)
+        {
+          msgtype: "markdown",
+          markdown: {
+            title: title,
+            text: text
+          },
+          at: {
+            atMobiles: at_mobiles,
+            isAtAll: is_at_all
+          }
+        }
+      end
+    end
+  end
+end

data/lib/active_notifier/version.rb

@@ -1,3 +1,3 @@
 module ActiveNotifier
-  VERSION = "0.3.0".freeze
+  VERSION = "0.4.0".freeze
 end

data/lib/active_notifier.rb

@@ -1,33 +1,27 @@
-require "active_notifier/version"
+require "net/http"
 require "active_support/all"
+require "active_adapter"
+require "active_notifier/version"
+require "active_notifier/notifier"
 
 module ActiveNotifier
   extend ActiveSupport::Autoload
 
   autoload :Configurable
-  autoload :Core
-  autoload :Adaptable
+  autoload :Notifiable
 
   eager_autoload do
     autoload_at "active_notifier/errors" do
       autoload :Error
       autoload :ConfigureError
       autoload :TemplateNotFoundError
-      autoload :MessageBlankError
-      autoload :AdapterTypeInvalidError
-      autoload :AdapterOptionsInvalidError
       autoload :UndefinedTokenError
+      autoload :AdapterError
     end
   end
 
-  autoload_under "adapters" do
-    autoload :AbstractAdapter
-    autoload :DingtalkAdapter
-  end
-
   include Configurable
-  include Core
-  include Adaptable
+  include Notifiable
 
   ActiveSupport.on_load(:after_initialize) do
     Kernel.const_set(ActiveNotifier.config.const_name || :Notifier, ActiveNotifier)

metadata

@@ -1,161 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: active_notifier
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Pine Wong
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-29 00:00:00.000000000 Z
+date: 2018-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: active_adapter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 0.1.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
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: codecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.1.10
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.1.10
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.7'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.58.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.58.1
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: vcr
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-- !ruby/object:Gem::Dependency
-  name: webmock
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.4.2
-  type: :development
+        version: '5.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.4.2
+        version: '5.0'
 description: Notify message through webhooks.
 email:
 - pinewong@163.com
@@ -174,12 +56,12 @@ files:
 - bin/console
 - bin/setup
 - lib/active_notifier.rb
-- lib/active_notifier/adaptable.rb
-- lib/active_notifier/adapters/abstract_adapter.rb
-- lib/active_notifier/adapters/dingtalk_adapter.rb
 - lib/active_notifier/configurable.rb
-- lib/active_notifier/core.rb
 - lib/active_notifier/errors.rb
+- lib/active_notifier/notifiable.rb
+- lib/active_notifier/notifier.rb
+- lib/active_notifier/notifier_adapters/abstract.rb
+- lib/active_notifier/notifier_adapters/dingtalk.rb
 - lib/active_notifier/templates/default.markdown.erb
 - lib/active_notifier/templates/default.text.erb
 - lib/active_notifier/version.rb

data/lib/active_notifier/adaptable.rb

@@ -1,28 +0,0 @@
-module ActiveNotifier
-  module Adaptable
-    extend ActiveSupport::Concern
-
-    module ClassMethods
-      def adapters
-        @adapters ||= {}
-      end
-
-      def adapt(adapter)
-        adapters[adapter.to_sym] ||= begin
-          adapter_class = get_adapter_class(adapter)
-          abstract_adapter_class.new(adapter_class)
-        end
-      end
-
-      private
-
-      def get_adapter_class(adapter)
-        "ActiveNotifier::#{adapter.to_s.camelize}Adapter".constantize
-      end
-
-      def abstract_adapter_class
-        "ActiveNotifier::AbstractAdapter".constantize
-      end
-    end
-  end
-end

data/lib/active_notifier/adapters/abstract_adapter.rb

@@ -1,24 +0,0 @@
-module ActiveNotifier
-  class AbstractAdapter
-    attr_reader :adapter
-
-    def initialize(adapter_class)
-      @adapter = adapter_class.new
-    end
-
-    # Notify message
-    #
-    # @abstract Implement through setting a real adapter, like :dingtalk
-    # @param token [String] Channel webhook token
-    # @param type [Symbol] Message type
-    # @param message [String] Message body
-    # @param options [Hash] Adapter message options, some adapters require some another options
-    # @raise [AdapterOptionsInvalidError]
-    # @raise [AdapterTypeInvalidError]
-    # @raise [MessageBlankError]
-    # @see ActiveNotitifier::exec for usage
-    def notify(token, type, message, **options)
-      adapter.notify(token, type, message, **options)
-    end
-  end
-end

data/lib/active_notifier/adapters/dingtalk_adapter.rb

@@ -1,30 +0,0 @@
-module ActiveNotifier
-  class DingtalkAdapter
-    VALID_TYPES = %i[markdown].freeze
-
-    # (see AbstractAdapter#notify)
-    def notify(token, type, message, **options)
-      webhook = "#{ActiveNotifier.config.adapters_with_base_url.fetch(:dingtalk)}#{token}"
-      unless VALID_TYPES.include?(type)
-        error_message = "The Dingtalk adapter only support types: #{VALID_TYPES.join(', ')}"
-        raise ActiveNotifier::AdapterTypeInvalidError, error_message
-      end
-      raise ActiveNotifier::MessageBlankError, "message can't be blank, please check template file" if message.empty?
-      title = options[:title]&.to_s
-      raise ActiveNotifier::AdapterOptionsInvalidError, "Dingtalk adapter require other options: title" if title.empty?
-
-      body = {
-        'msgtype' => type,
-        type => {
-          'title': title,
-          'text': message
-        }
-      }
-      headers = {
-        'Content-Type' => 'application/json',
-        'Accept' => 'application/json'
-      }
-      Net::HTTP.post(URI(webhook), body.to_json, headers)
-    end
-  end
-end