rounders 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1848b1a79ddcaa6da0ea0ea7504a91e8bc2d627c
-  data.tar.gz: 8c7146f3cf50f54d99e4c77a313e61d24849a4f9
+  metadata.gz: 45547d405ca80484bf5a309a7f0784b0c6d0d16d
+  data.tar.gz: b1935a235c262dc8517499725dd60c56701b5a1a
 SHA512:
-  metadata.gz: b063b78cc4418e6cfb8410ae63b71c6d87e362a0552dfbbc39a6d1136185926eafb7d6956bdbeca84ae1dcbb42d00331b0f84887f0f60305c920eaaff5ed0134
-  data.tar.gz: 32aef46a039116f55d600022e0c3e6deb875113736d236384ab6a807d785e2f2e90fdebfb95e61713e3cd946e6d2a170c3415ce6639a72875bcb58434f66e128
+  metadata.gz: e5ddda05355cc11f219ff0cc6e62a77c8161a8034535f4c9f4277a92a6ca0eaec6e46805ea1c1d05053324958e85e6889a6fa48cfbfe86df1f2342a932fa369c
+  data.tar.gz: '049ab0e60c9eb09a101909ec29cde953285824520b04e2a86a34f3c6fd4715226a60cd40953d54a6b0dad48886dd6326b02ce2f3767e2f8635c492e41e8732b7'

data/.gitignore

@@ -8,15 +8,15 @@
 /spec/reports/
 /tmp/
 ### https://raw.github.com/github/gitignore/0aeefb48c0ac885a516fb92f7f5bfd7e85ce7a37/Rails.gitignore
+/verndor/bundle
 
 *.rbc
 *.sassc
 .sass-cache
 capybara-*.html
-.rspec
 .rvmrc
 /.bundle
-/vendor/bundle
+/vendor/bundle/
 /log/*
 /tmp/*
 /db/*.sqlite3

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -4,7 +4,7 @@ AllCops:
      - 'vendor/**/*'
      - 'spec/fixtures/**/*'
      - 'tmp/**/*'
-     - 'templates/*'
+     - 'templates/**/*'
 ##################### Metrics ##################################
 
 Metrics/LineLength:
@@ -35,3 +35,12 @@ Style/DotPosition:
 
 Style/FrozenStringLiteralComment:
   Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'rounders.gemspec'
+    - 'spec/**/*'
+
+Metrics/MethodLength:
+  CountComments: false  # count full line comments?
+  Max: 30

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.3.3
+  - 2.4.0
+before_install:
+  - gem install bundler -v 1.13.1
+  - gem update --system
+env:
+  - CI=true

data/README.ja.md

@@ -0,0 +1,196 @@
+# Rounders [![Build Status](https://travis-ci.org/rike422/rounders.svg?branch=master)](https://travis-ci.org/rike422/rounders)  [![Code Climate](https://codeclimate.com/github/rike422/rounders/badges/gpa.svg)](https://codeclimate.com/github/rike422/rounders) [![Coverage Status](https://coveralls.io/repos/github/rike422/rounders/badge.svg?branch=master)](https://coveralls.io/github/rike422/rounders?branch=master)
+
+Roundersは拡張性を重視した、メール処理フレームワークです。
+RubotyなどのBotを参考に作られました。
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rounders'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rounders
+
+## Usage
+
+### botの作成
+
+botを作成するには、下記のコマンドを実行します。
+
+```
+rounders new [name]
+```
+
+### メールアカウントの設定
+
+生成されたbotの`config/initiarizers/mail.rb`にメールアカウント情報を設定します。
+```
+Rounders::Receivers::Mail.configure do |config|
+  # please show more option
+  #
+  config.protocol = :imap
+  # メールアカウント情報を設定します。
+  config.mail_server_setting = {
+    address:    'imap.gmail.com',
+    port:       993,
+    user_name:  ENV['GMAIL_USER_NAME'],
+    password:   ENV['GMAIL_PASSWORD'],
+    enable_ssl: true
+  }
+  config.options = {
+    # flag for whether to delete each receive mail after find Default: false
+    # delete_after_find: true
+  }
+end
+
+```
+
+### botの実行
+
+`bundle exec rounders start`でbotをスタートできます。
+
+## Modules
+
+Roundersはそれぞれのモジュールの基底クラスを継承することにより、
+Hookが行われ、システム内に組み込むことができます。
+
+各モジュールのテンプレートを作成するジェネレータを用意しています。
+
+#### Handlers
+
+Handlersはメールのハンドングを行うモジュールです。
+`.on`の第一引数で渡した条件で下記のMatcherインスタンスを作成し、
+マッチしたメールを、第二引数で渡したメソッドに引き渡します
+
+#### Generate Command
+
+下記のように`rounders generate handler`をroudersディレクトリ内で実行することで、
+./app/handlersの中にテンプレートファイルが生成されます。
+
+```
+rounders generate handler [name] [method1, method2...] `
+```
+
+##### example
+
+```ruby
+module Rounders
+  module Handlers
+    class MyHandler < Rounders::Handlers::Handler
+      # mail.body is include 'exmpale'
+      on({ body: 'example' }, :callback_method1)
+      # body include 'exmpale' AND subject match the /programing (?<name>.+)$/
+      on({ 
+		  body: 'example',
+		  subject: /programing (?<name>.+)$/},
+		  :callback_method2)
+​
+      def method1(mail)
+        # BodyMatcherの戻り値画が格納されています。
+        matches[:body]
+        # => #<MatchData "example">
+       	# 引数のmail、matchesを利用して処理を行えます。
+      end
+​
+      def method2(mail)
+        matches[:subject]
+      	# => <MatchData "programing ruby" name:"ruby">
+      	matches[:subject][:name]
+      	# => "ruby"
+      end
+    end
+  end
+end
+
+```
+
+#### Matchers 
+
+Matcherはメールのフィルタリングを行うモジュールです。
+`#match`メソッドを実装する必要があり、このメソッドが返した値は、
+Handlersメソッド内で扱えるmatchesに格納されます。
+
+#### Generate Command
+
+下記のように`rounders generate matchers`をroudersディレクトリ内で実行することで、
+./app/matchers/の中にテンプレートファイルが生成されます。
+
+```
+rounders generate matchers [name]`
+```
+
+下記はHTMLメールに対して、CSSセレクタでフィルタ・抽出を行うためのMatcherの実装例です。
+
+#### exmaple
+
+/app/matchers/css_selector.rb
+
+```ruby
+module Rounders
+  module Matchers
+    # クラス名をsnake_caseにした値が、handlerでのkeyになります。
+    class CssSelector < Rounders::Matchers::Matcher
+      attr_reader :pattern
+
+      def initialize(pattern)
+        @pattern = pattern
+      end
+
+      def match(mail)
+        return if mail.html_part.blank?
+        html_part = Nokogiri::HTML(mail.html_part.body.to_s)
+        node = html_part.css(pattern)
+        # 戻り値がmatches[:css_selector]に格納されます。
+        node.present? ? node : nil
+      end
+    end
+  end
+end
+
+```
+
+/app/handlers/your_hander.rb
+```ruby
+module Rounders
+  module Handlers
+    class YourHandler < Rounders::Handlers::Handler
+      # 上記のCssSelectorを利用するためにキーを指定して、CSSセレクタを値として渡します。
+      on({ css_selector: 'body .header h2' }, method1)
+		  
+      def method1(mail)
+        # CssSelectorの戻り値が格納されています。
+        matches[:css_selector]
+        # =>[#<Nokogiri::XML::Element:0x3fc6d77f6ccc name="h2" children=[#<Nokogiri::XML::Text:0x3fc6d77f6ad8 " head text ">]>]
+        matches[:css_selector].to_s
+        # => '<h2> head text </h2>'
+      end
+    end
+  end
+end
+
+```
+
+#### Gems
+
+RoundersのモジュールはGemとして配布できます。
+上記のCssSelectorをGemにしたものが下記のリポジトリになります。
+- [rounders-css_selector_matcher](https://github.com/rike422/rounders-css_selector_matcher)
+
+#### reciever
+
+coming soon...
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/README.md

@@ -1,6 +1,9 @@
-# Rounders [![Circle CI](https://circleci.com/gh/rike422/rounders.svg?style=svg)](https://circleci.com/gh/rike422/rounders)  [![Code Climate](https://codeclimate.com/github/rike422/rounders/badges/gpa.svg)](https://codeclimate.com/github/rike422/rounders) [![Coverage Status](https://coveralls.io/repos/github/rike422/rounders/badge.svg?branch=master)](https://coveralls.io/github/rike422/rounders?branch=master)
+# Rounders [![Build Status](https://travis-ci.org/rike422/rounders.svg?branch=master)](https://travis-ci.org/rike422/rounders)  [![Code Climate](https://codeclimate.com/github/rike422/rounders/badges/gpa.svg)](https://codeclimate.com/github/rike422/rounders) [![Coverage Status](https://coveralls.io/repos/github/rike422/rounders/badge.svg?branch=master)](https://coveralls.io/github/rike422/rounders?branch=master)
 
-The pluggalbe mail processing framework
+[日本語README](https://github.com/rike422/rounders/blob/master/README.ja.md)
+
+Rounders is a mail handling framework that emphasizes pluggability.
+ It was made with reference to Bot such as [Ruboty](https://github.com/r7kamura/ruboty),[Lita](https://github.com/litaio/lita).
 
 ## Installation
 
@@ -22,16 +25,53 @@ Or install it yourself as:
 
 ### create bot
 
-create a new bot by running the rounders new command after installing rounders.
+To create a bot, execute the following command.
 
 ```
 rounders new [name]
 ```
 
-### generator
+### Mail account settings
+
+Set mail account information in `bot/config/initiarizers/ mail.rb` of the generated bot.
+
+```
+Rounders::Receivers::Mail.configure do |config|
+  # please show more option
+  #
+  config.protocol = :imap
+  # メールアカウント情報を設定します。
+  config.mail_server_setting = {
+    address:    'imap.gmail.com',
+    port:       993,
+    user_name:  ENV['GMAIL_USER_NAME'],
+    password:   ENV['GMAIL_PASSWORD'],
+    enable_ssl: true
+  }
+  config.options = {
+    # flag for whether to delete each receive mail after find Default: false
+    # delete_after_find: true
+  }
+end
+
+```
+
+### start bot
+
+You can start the bot with `bundle exec rounders start`.
+
+### Modules
+
+
+If you want to extend the processing of Rounders. inherit the base class of following modules.
+it is hooked and can be incorporated into the Rounders.
 
 #### Handlers
 
+Handlers is a module that handles mails.
+Create the Matcher instance with the condition passed as the first argument of `.on`,
+If there is a matching email, If there is a matching email, It passe to the method that passed as the second argument
+
 The `rounders generate handler` command create template of handler into ./plugins/handlers/
 
 ```
@@ -44,14 +84,15 @@ module Rounders
   module Handlers
     class MyHandler < Rounders::Handlers::Handler
       # mail.body is include 'exmpale'
-      on({ body: 'example' }, :callback_method1)
+      on({ body: 'example' }, :method1)
       # body include 'exmpale' AND subject match the /programing (?<name>.+)$/
       on({ 
 		  body: 'example',
 		  subject: /programing (?<name>.+)$/},
-		  :callback_method2)
+		  :method2)
 ​
       def method1(mail)
+       # The return value of BodyMatcher is assign to Handler#matches.
         matches[:body]
         # => #<MatchData "example">
        	# any process
@@ -71,13 +112,18 @@ end
 
 #### Matchers 
 
+Matcher is a module that performs mail filtering.
+The Matcher must implement 'match' method, and the value returned by this method which returns value assign to Handler#matches
+
+
 The `rounders generate matchers` command create template of matchers into ./plugins/matchers/
 
 ```
 rounders generate matchers [name]`
 ```
 
-your writen the matcher plugins that usable some handlers
+
+Below is an example of Matcher for filtering / extracting with CSSSelector for HTML mail.
 
 #### exmaple
 
@@ -111,7 +157,7 @@ module Rounders
   module Handlers
     class YourHandler < Rounders::Handlers::Handler
       # css selector match 
-      on({ css_selector: 'body .header h2' }, method1)
+      on({ css_selector: 'body .header h2' }, :method1)
 		  
       def method1(mail)
         matches[:css_selector]
@@ -127,6 +173,8 @@ end
 
 #### Gems
 
+Rounder's module can be distributed as Gem.
+
 - [rounders-css_selector_matcher](https://github.com/rike422/rounders-css_selector_matcher)
 
 #### reciever

data/lib/rounders.rb

@@ -3,25 +3,30 @@ require 'rounders/version'
 module Rounders
   # Your code goes here...
   CONFIG_DIR_PATH = File.join(Dir.pwd, 'config').freeze
-  PLUGIN_DIR_PATH = File.join(Dir.pwd, 'plugins').freeze
+  APP_PATH = File.join(Dir.pwd, 'app').freeze
   class << self
     def handlers
-      @handlers ||= []
+      @_handlers ||= []
     end
 
     def matchers
-      @matchers ||= {}
+      @_matchers ||= {}
+    end
+
+    def receivers
+      @_receivers ||= []
     end
   end
 end
 
-require 'active_support/core_ext/object'
-require 'active_support/inflector'
 require 'thor'
+require 'thor/group'
+require 'dry-configurable'
 require 'forwardable'
 require 'mail'
 require 'dotenv'
 
+require 'rounders/util'
 require 'rounders/mail'
 require 'rounders/plugins/plugin_loader'
 require 'rounders/plugins/pluggable'
@@ -33,11 +38,14 @@ require 'rounders/matchers/from'
 require 'rounders/matchers/to'
 require 'rounders/handlers/handler'
 require 'rounders/commander'
-require 'rounders/receiver'
+require 'rounders/receivers/receiver'
+require 'rounders/receivers/mail'
 require 'rounders/rounder'
 require 'rounders/brains/base'
 
-require 'rounders/generators/generator'
-require 'rounders/generators/app'
-require 'rounders/generators/handler'
-require 'rounders/generators/matcher'
+require 'rounders/generators/base'
+require 'rounders/generators/app/app_generator'
+require 'rounders/generators/plugin/plugin_generator'
+require 'rounders/generators/handler/handler_generator'
+require 'rounders/generators/matcher/matcher_generator'
+require 'rounders/generators/receiver/receiver_generator'

data/lib/rounders/commands/global_command.rb

@@ -4,11 +4,19 @@ module Rounders
       class_option :help, type: :boolean, aliases: '-h', desc: 'Help message.'
       package_name 'rounders'
 
-      desc 'new [Path]', 'Generate new application'
-      method_option aliases: '-n'
-      def new(name)
-        Rounders::Generators::App.new(name).generate!
-      end
+      register(
+        Rounders::Generators::AppGenerator,
+        'new',
+        'new <name> <path>',
+        'generate new application'
+      )
+
+      register(
+        Rounders::Generators::PluginGenerator,
+        'plugin',
+        'plugin <name>',
+        'Generate new rounders plugin'
+      )
     end
   end
 end