active_notifier 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8919ed9bb7359c3c50bc1501c733507015b25f9b158f309dd522f38fc4058663
-  data.tar.gz: 6b7e4c32efce34c3b111a1b9a52ddcb6e119a8302c1053411f8132be02e0d37d
+  metadata.gz: 254bfd0c06440a25f2cf53153898e2010418ca96a56cbe6c7827825e5f9e818a
+  data.tar.gz: 258b87d6e0eb00c59eb50f52d2bc42f2394e9ee04f8d0bee741521f97c1d81dc
 SHA512:
-  metadata.gz: e943777261d19d6ac66da441ffbb899cee74a686b46a91aad7b0a871863b06cc8b7ea9ad5d255ee0a59644307a502fe6965b428d7a9c1bff28a05bad9f5542d9
-  data.tar.gz: 32a64dcc3fde456796fba803c42b1a347e33206b9170f490491c577b111e9c4a72d2a72124fa08bbfc03ae6a2f08f00d007a39af14cd398bc72b879b2f6e136c
+  metadata.gz: 9663e46179b67b36a7e6ac2314e1543f2e5e36e45e664e679aaf0d2df111c3007dc294fad8c806cf800b00735ff6bf87efa53b502cf5b404505ad26c2d9eb949
+  data.tar.gz: ed3b18444058d482c8876325611b9cee248ae8e628d4828009515db942ffd90fbd259819b3d7afef0318600309904f234e8ed9d495666cbe83b168b0b9da0b42

data/README.md

@@ -16,47 +16,72 @@ gem 'active_notifier'
 
 And then execute:
 
-    $ bundle
+```shell
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install active_notifier
+```shell
+$ gem install active_notifier
+```
+
+## Support
+
+| Notifier adapter | message type   | support options |
+| ---------------- | -------------- | --------------- |
+| Dingtalk         | text, markdown | all             |
 
 ## Basic Usage
 
 Just notify the message through a webhook token, ActiveNotifier use Dingtalk by default, the webhook token
 need be a accessible dingtalk webhook token.
 
+In your IRB environment:
+
 ```ruby
 ActiveNotifier.exec(token: "your-webhook-token", message: "your-message")
 ```
 
 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.
 
+For token, ActiveNotifier use `channel_tokens` to store it, and for message, we can use the ERB template and `data` option for locals, like the familiar Rails does.
+
+In any file you want to config ActiveNotifier:
 
 ```ruby
 ActiveNotifier.configure do |config|
   config.channel_tokens = { my_channel: "xxx" }
-  config.template_home = Rails.root.join("app", "views", "active_notifier")
+  config.template_home = SOME_DIR
 end
 ```
 
+Edit the template of `my_channel`:
+
 ```shell
-echo "## #{data[:title]\n> #{data[:body]}}" > app/views/active_notifier/my_channel.markdown.erb
+$ echo "## #{data[:title]\n> #{data[:body]}}" > SOME_DIR/my_channel.markdown.erb
 ```
 
+Then execute it in IRB:
+
 ```ruby
 ActiveNotifier.exec(token_channel: :my_channel, template: :my_channel, data: { title: "Message Title", body: "Message Body" })
 ```
 
-Also when token_channel and template is the same, we can simplify it by using the first optional argument channel
+Also when token_channel name and template name is the same, we can simplify it by using the first optional argument `channel`
 
 ```ruby
 ActiveNotifier.exec(:my_channel, data: { title: "Message Title", body: "Message Body" })
 ```
+### For Rails application
+
+There are generators that simplify the above operations:
+
+```shell
+$ rails generate active_notifier:install
+```
 
-## Advanced knowledge
+## More knowledge
 
 ### Send message with dynamic type
 
@@ -103,7 +128,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.4.1)
+* [Gem RDoc](http://www.rubydoc.info/gems/active_notifier/0.4.2)
 
 ## Development
 

data/active_notifier.gemspec

@@ -30,6 +30,8 @@ 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 "active_adapter", "~> 0.1.0"
   spec.add_dependency "activesupport", "~> 5.0"
 end

data/lib/active_notifier/version.rb

@@ -1,3 +1,3 @@
 module ActiveNotifier
-  VERSION = "0.4.1".freeze
+  VERSION = "0.4.2".freeze
 end

data/lib/generators/active_notifier/install_generator.rb

@@ -0,0 +1,17 @@
+module ActiveNotifier
+  module Generators
+    # ActiveNotifier generator for Rails application
+    class InstallGenerator < ::Rails::Generators::Base
+      desc "Generates ActiveNotifier configuration files."
+      source_root File.expand_path("../../", __dir__)
+
+      def copy_initializer
+        template "generators/active_notifier/templates/active_notifier.rb", "config/initializers/active_notifier.rb"
+      end
+
+      def copy_templates
+        directory "active_notifier/templates", "app/views/active_notifier"
+      end
+    end
+  end
+end

data/lib/generators/active_notifier/templates/active_notifier.rb

@@ -0,0 +1,23 @@
+ActiveNotifier.configure do |config|
+  # Set alias const for ActiveNotifier
+  # Default: :Notifier
+  # config.const_name = :Notifier
+  #
+  # Set message Adapter
+  # Default: :dingtalk
+  # config.adapter = :dingtalk
+  #
+  # The webhook tokens of channel
+  # config.channel_tokens = {
+  #   default: "dingtalk_token_xxxxxxxxxxxxxxxxx",
+  #   order:   "dingtalk_token_for_order_xxxxxxx",
+  # }
+  #
+  # The template home directory
+  config.template_home = Rails.root.join("app", "views", "active_notifier")
+  #
+  # The priority type for message, if notifier execute without type option and there are multiple valid types,
+  # then ActiveNotifier will use the template with this type first
+  # Default: :markdown
+  # config.priority_type = :markdown
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_notifier
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Pine Wong
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-31 00:00:00.000000000 Z
+date: 2018-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_adapter
@@ -67,6 +67,8 @@ files:
 - lib/active_notifier/templates/default.markdown.erb
 - lib/active_notifier/templates/default.text.erb
 - lib/active_notifier/version.rb
+- lib/generators/active_notifier/install_generator.rb
+- lib/generators/active_notifier/templates/active_notifier.rb
 homepage: https://github.com/pinewong/active_notifier
 licenses: []
 metadata: {}
@@ -78,7 +80,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:
   - - ">="