active_notifier 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24d5eac70996ae751cbfac298f4bd78074b53f913c19325347bf50bfcd557eb9
-  data.tar.gz: 7716f56010b04db00fe06e7a3b5773350a9a58ffcb4b117a64bfd17ed3fe18a7
+  metadata.gz: 11d89dfa1aff8c314539b8ff79b5cbb72ed89f98e2fdce3c324a7e8ee097c789
+  data.tar.gz: b8edd79f2f6244a442a2d4bfb603ef0f4e6504971d6c9b4a33b66330f87a60e4
 SHA512:
-  metadata.gz: c4793839706e3f4fad3151255736fc0b820611997cd044e793c125b93e1375aab281dd476165525748f6229cd6b45693d0536dad31cc66a47a3924f43119adf4
-  data.tar.gz: 77e1fa443c84606455d712a7340d474b607ebcfa3fb59567f334a19a370384d5d7656fd94a9cd0f9fe4a7265c8b42139ca210e5dfe83cbf8567918e991fc00a5
+  metadata.gz: 53025b951b32263b901f958d9200fa0eae7c954960a39299a1d249686fdeac091bedeee457256c379a4bd44e09274a02e1c2d613e8b1003c918501cee18be66d
+  data.tar.gz: 2d83333750347d2ec943ac14a273111de68ccb02226898ffea26c4e22792efc460859b1c17306c8cd0c521c9d74ffe3a2399ff098a8338120aed489c4d3dda2d

data/.rubocop.yml

@@ -2,6 +2,7 @@ AllCops:
   TargetRubyVersion: 2.3
   Exclude:
     - 'bin/*'
+    - 'vendor/**/*'
 Metrics/LineLength:
   Max: 120
 Style/AsciiComments:

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+  - 2.5.1
+cache: bundler
+script:
+  - bundle exec rspec
+  - bundle exec rubocop
+deploy:
+  provider: rubygems
+  api_key:
+    secure: Kuaq/l0/f+pasOQRFpiF43o5bOqlhP3wbStxSYVAZye8YuGCMZ7wnzhNlD8cU57nc1e2tsONv78OT8qUKr8uNTeDU1RpRzAq8FEAiIHYHe2Rw/JUibE2c7GJchvpoQNCSCZZJbr6NZ5EcK6yx/mOoiZgWlAcvLWb2SdkIwDsRkucl6UEE6DP87ddkjBsE9TYAKV+Q+U76JHr20E0ANjoyTq4K6htdLuOqY2GwwhosQzZw/ixHNS+9GMCDJNJAJg5VYbv8AgCNgzkOPmPydfca1GWHSVul1QLvxC5EC7Sv8gt+uAcfxErf860hwoymenobhCMNPPmRZk65I+a2PC2O0Ni8xWriT8zsOJC15kFEGvmWFT5Vhix1fOCglB2C0CCanbfId+NjGu9AzfuT2cn7ySKbl3f2A7U3Kaopqge38z4xg0uYudfh9TkcZteUM8bq/S3Ioh3Z7NrynMfWcaFxArMkFoiAyCcJhXmQg/WXFKJjDXIC5AEWaEfv1xnBh/UZPIaqB5KC7MU2VRoesebr3EQl3rLU1AS+ga5m50lqnTIMRyH6clxvwojgfg51hkFRc16svTXshDvCq+u+ZfQUghO93jkeVHXernbiZFyzPFosBUwTxk75o5OaSKs6l6O52OIGa+mp6YqlCPXw5AGfQLBdS7qcuFokAKNesJQnts=
+  on:
+    tags: true

data/README.md

@@ -2,6 +2,10 @@
 
 Notify message through webhooks.
 
+[![Gem Version](https://badge.fury.io/rb/active_notifier.svg)](https://badge.fury.io/rb/active_notifier)
+[![Build Status](https://travis-ci.org/pinewong/active_notifier.svg)](https://travis-ci.org/pinewong/active_notifier)
+[![Test Coverage](https://codecov.io/github/pinewong/active_notifier/coverage.svg?branch=master)](https://codecov.io/github/pinewong/active_notifier?branch=master)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -18,118 +22,88 @@ Or install it yourself as:
 
     $ gem install active_notifier
 
-## Usage
+## Basic Usage
 
-### Basic
+Just notify the message through a webhook token, ActiveNotifier use Dingtalk by default, the webhook token
+need be a accessible dingtalk webhook token.
 
 ```ruby
-ActiveNotifer.config.channel_tokens = { default: "xxx" }
-ActiveNotifier.exec(:default)
-# This will notifier message, use options:
-#   token: config.channel_tokens[:default],
-#   template: "#{config.template_home}/default.*.erb"
-
-ActiveNotifier.exec(:default, template: "orders/create")
-# Use specific template file but not get by channel
-# This will notifier message, use options:
-#   token: config.channel_tokens[:default],
-#   template: "#{config.template_home}/orders/create.*.erb"
-
-ActiveNotifier.exec(:default, token: "special_token", data: { title: "Title", message: "Message" })
-# Use specific token but not get by channel
-# This will notifier message, use options:
-#   token: "special_token",
-#   template: "#{config.template_home}/default.*.erb"
-# And the Hash data will inject to template, and get a dynamic message after parse template
+ActiveNotifier.exec(token: "your-webhook-token", message: "your-message")
 ```
 
-### Use custom template
+Is it too much trouble to set the token and message always? You can save commonly used ones and access them via better ways.
+For token, ActiveNotifier use channel_tokens to store it, and for message, we can use the ERB template and locals data, like the familiar ActiveView does.
 
-Set token and template home for Rails application
 
 ```ruby
 ActiveNotifier.configure do |config|
-  config.channel_tokens = { default: "xxx" }
+  config.channel_tokens = { my_channel: "xxx" }
   config.template_home = Rails.root.join("app", "views", "active_notifier")
 end
 ```
 
-Set the default message template
-
-> app/views/active_notifier/default.markdown.erb
-
-```erb
-## #{data[:title]}
-> #{data[:message]}
+```shell
+echo "## #{data[:title]\n> #{data[:body]}}" > app/views/active_notifier/my_channel.markdown.erb
 ```
 
-Notify message
-
 ```ruby
-ActiveNotifier.exec(:default, data: { title: "Title", message: "Message" }) # => Notifer OK
+ActiveNotifier.exec(token_channel: :my_channel, template: :my_channel, data: { title: "Message Title", body: "Message Body" })
 ```
 
-### Send message with dynamic type
-
-Message type will dynamic set according by valid template files, when we
-set a template named `order.text.erb`
+Also when token_channel and template is the same, we can simplify it by using the first optional argument channel
 
 ```ruby
-ActiveNotifier.configure do |config|
-  config.channel_tokens = { order: "xxx" }
-  config.template_home = Rails.root.join("app", "views", "active_notifier")
+ActiveNotifier.exec(:my_channel, data: { title: "Message Title", body: "Message Body" })
 ```
 
-> app/views/active_notifier/order.text.erb
+## Advanced knowledge
 
-```erb
-title: #{data[:title]}
-message: #{data[:message]}
-```
+### Send message with dynamic type
 
-When there is only text type template for order, it will be OK the
-notify message without set type option
+Message type will dynamic set according to a valid template, imagine we have two template files named `order.text.erb` and `order.markdown.erb`,
+now we want use the text type of template, we need add a type option
 
 ```ruby
-ActiveNotifier.exec(:default, data: { title: "Title", message: "Message" }) # => Notifer message OK
+ActiveNotifier.exec(:order, data: { title: "Message Title", body: "Message Body" }, type: :text)
 ```
 
-Also, even though there are multiple types templates, like both `order.text.erb` and `order.markdown.erb`
-are exist, we still can make it OK which no need for type option, just
-set the priority type
+But if there is only one type of template, the type option is optional
 
-> app/views/active_notifier/order.text.erb
+```ruby
+# Now we have only template file `product.text.erb` for product channel
 
-```erb
-title: #{data[:title]}
-message: #{data[:message]}
+ActiveNotifier.exec(:product, data: { title: "Message Title", body: "Message Body" }) # Needn't type option
 ```
 
-> app/views/active_notifier/order.markdown.erb
+And also we can configure priority type for ActiveNotifier
 
-```erb
-## #{data[:title]}
-> #{data[:message]}
+```ruby
+ActiveNotifier.configure do |config|
+  # default is :markdown
+  config.priority_type = :text
+end
 ```
 
 ```ruby
-# default priority_type is :markdown
-ActiveNotifer.config.priority_type = :text
+# Now even we have template files `book.text.erb` and `book.markdown.erb` for book channel
 
-# Now this will choose text by default
-ActiveNotifier.exec(:default, data: { title: "Title", message: "Message" }) # => Notifer message OK by text type template
+ActiveNotifier.exec(:book, data: { title: "Message Title", body: "Message Body" }) # Needn't type option, and will choose the text type
 ```
 
-### Set a short constant to notify(Rails initializer will set this by default)
+### Set a short constant
+
+ActiveSupport hook `after_initialize` will set this by default
 
 ```ruby
 ActiveNotifer.config.const_name = :Notifier
 Notifer.exec(...)
 ```
 
-### Other
+## Help and Docs
 
-See complete abilities of ActiveNotifier, please follow [Spec files](https://github.com/pinewong/active_notifier/blob/master/spec/active_adapter_spec.rb)
+* [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)
 
 ## Development
 

data/active_notifier.gemspec

@@ -34,6 +34,7 @@ Gem::Specification.new do |spec|
 
   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"

data/lib/active_notifier/adapters/abstract_adapter.rb

@@ -7,15 +7,16 @@ module ActiveNotifier
     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
+    # @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

data/lib/active_notifier/adapters/dingtalk_adapter.rb

@@ -2,14 +2,15 @@ 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 = "适配器 type 暂时只支持：#{VALID_TYPES.join(', ')}"
+        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
+      title = options[:title]&.to_s
       raise ActiveNotifier::AdapterOptionsInvalidError, "Dingtalk adapter require other options: title" if title.empty?
 
       body = {

data/lib/active_notifier/configurable.rb

@@ -3,15 +3,16 @@ module ActiveNotifier
     extend ActiveSupport::Concern
 
     module ClassMethods
-      # Configure for ActiveNotifier
-      # @yield [config] Give a Configuration instance for settings
-      # @raise [ConfigureError]
+      # Configure for ActiveNotifier.
+      #
       # @example
       #   ActiveNotifier.configure do |config|
       #     config.const_name = :Message
       #     config.adapter = :slack
       #     # ...
       #   end
+      # @yield [config] Give a Configuration instance for settings
+      # @raise [ConfigureError]
       def configure
         yield config
       end

data/lib/active_notifier/core.rb

@@ -3,59 +3,77 @@ module ActiveNotifier
     extend ActiveSupport::Concern
 
     module ClassMethods
-      # Message execute
-      # @param channel [#to_sym] Message channel, it will set template and token together
-      # @param options [Hash] ({})
-      # @option options [String] :template (nil) Message template, will use `options[:channel]` when this value is blank
-      # @option options [String, Symbol] :token (nil) Message webhook token,
-      #   will use `options[:channel]` when this value is blank
-      # @option options [Symbol] :type (nil) Message type, it will use a specific template file, for example,
-      #   when type is :text and template is order, then ActiveNotifier will choose `order.text.erb` for template file
-      # @option options [Hash] :data ({}) Message variable data for template, it can used in erb template file:
-      #   ## #{data[:title]}
-      #   > #{data[:order].to_json}
-      # @option options [Anything] Other options will used in adapter message execute,
-      #   like Dingtalk require title for message, we can pass it here:
-      #   `ActiveNotifer.exec(:default, title: "dingtalk title")`
+      # Message execute.
+      #
+      # @example Command Usage
+      #   ActiveNotifier.exec(token: "your-webhook-token", message: "your-message")
+      # @example Common Usage
+      #   # Configure it
+      #   ActiveNotifier.configure do |config|
+      #     config.channel_tokens = { my_channel: "xxx" }
+      #     config.template_home = Rails.root.join("app", "views", "active_notifier")
+      #   end
+      #
+      #   # Add template
+      #   echo "## #{data[:title]\n> #{data[:body]}}" > app/views/active_notifier/my_channel.markdown.erb
+      #
+      #   # Execute it
+      #   ActiveNotifier.exec(:my_channel, data: { title: "Message Title", body: "Message Body" })
+      # @param channel [#to_sym] (nil) Message channel, it will set template and token_channel together
+      # @param options [#to_h] ({})
+      # @option options [#to_s] :token (nil) Message webhook token,
+      # @option options [#to_s] :message (nil) Message
+      # @option options [#to_sym] :token_channel (nil) Message webhook token channel,
+      #   will use `channel` when this value is blank
+      # @option options [#to_sym] :template (nil) Message template, will use `channel` when this value is blank
+      # @option options [#to_sym] :adapter (ActiveNotifier.config.adapter) Message adapter
+      # @option options [#to_sym] :type (nil) Message type, it will use a specific template file, for example,
+      #   when type is :text and template is :order, then ActiveNotifier will choose `order.text.erb` for template file
+      # @option options [#to_h] :data ({}) Message variable data for template, it can used in erb template file
+      # @option options [Anything] Other options will used in adapter message execute, like Dingtalk require title
+      #   for message, we can pass it here: `ActiveNotifer.exec(:default, title: "dingtalk title")`
       # @raise [TemplateNotFoundError]
       # @raise [UndefinedTokenError]
       # @raise [AdapterOptionsInvalidError]
       # @raise [AdapterTypeInvalidError]
       # @raise [MessageBlankError]
-      # @example
-      #   ActiveNotifer.config.channel_tokens = {
-      #     default: "xxx"
-      #   }
-      #   ActiveNotifier.exec(:default)
-      def exec(channel, **options)
-        channel = channel&.to_sym
-        raise ArgumentError, ":channel can't be blank" if channel.blank?
-        template = options[:template].to_s.presence || channel.to_s
-        token = get_token(channel, options[:token])
-        raise UndefinedTokenError 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(:token, :template, :type, :data)
-        adapter.notify(token, type, message, adapter_options)
+      # @see Get more see README
+      def exec(channel = nil, **options)
+        channel       = channel&.to_sym
+        token         = options[:token]&.to_s
+        message       = options[:message]&.to_s
+        token_channel = options[:token_channel]&.to_sym
+        template      = options[:template]&.to_sym
+        adapter       = options[:adapter]&.to_sym
+        type          = options[:type]&.to_sym
+        data          = options[:data].to_h
+        token = fetch_token(token, token_channel, channel)
+        template ||= channel
+        type ||= get_type_by_template(template)
+        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)
       end
 
       private
 
-      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
+      # @param token [String, nil]
+      # @param token_channel [Symbol, nil]
+      # @param channel [Symbol, nil]
+      # @return [String]
+      def fetch_token(token, token_channel, channel)
+        token = token ||
+                token_channel && ActiveNotifier.config.channel_tokens[token_channel]&.to_s ||
+                channel && ActiveNotifier.config.channel_tokens[channel]&.to_s
+        raise ActiveNotifier::UndefinedTokenError unless token
+        token
       end
 
-      def guess_type_by_files(template)
+      # @param template [Symbol, nil]
+      # @return [Symbol, nil]
+      def get_type_by_template(template)
+        return unless template
         template_paths = Dir["#{ActiveNotifier.config.template_home}/#{template}.*.erb"]
         raise ActiveNotifier::TemplateNotFoundError if template_paths.empty?
         types = template_paths.map do |template_path|
@@ -68,7 +86,12 @@ module ActiveNotifier
         end
       end
 
+      # @param template [Symbol, nil]
+      # @param type [Symbol]
+      # @param data [Hash]
+      # @return [String, nil]
       def get_message(template, type, data)
+        return unless template
         template_data = File.read("#{ActiveNotifier.config.template_home}/#{template}.#{type}.erb")
         ERB.new(template_data).result_with_hash(data: data)
       rescue Errno::ENOENT => e

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

@@ -1 +1 @@
-<%= data %>
+> <%= data %>

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

@@ -0,0 +1 @@
+<%= data %>

data/lib/active_notifier/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_notifier
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Pine Wong
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-24 00:00:00.000000000 Z
+date: 2018-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !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
@@ -151,6 +165,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
+- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - README.md
@@ -166,6 +181,7 @@ files:
 - lib/active_notifier/core.rb
 - lib/active_notifier/errors.rb
 - lib/active_notifier/templates/default.markdown.erb
+- lib/active_notifier/templates/default.text.erb
 - lib/active_notifier/version.rb
 homepage: https://github.com/pinewong/active_notifier
 licenses: []
@@ -186,7 +202,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: Notify message through webhooks.