ruboty-slack_take_turns 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fbecdea07ac49e879c4cb05ad2c25d041a90da2d
-  data.tar.gz: 86e6f32d3d1cf351e144b290ec09157f9636ee0f
+  metadata.gz: c02cb32a888758f34bd395c531d2302001e116f8
+  data.tar.gz: 975ef1517ccb6e3ce4326ed2dc83e5784a06c0ca
 SHA512:
-  metadata.gz: 647821d34aedd620f87ee9afbeb3850bbee49c4a7fba3744f687c55fc97cb61520de6bcf6d701aadfec5f63a4d2b003f0372e97e00c8999b8e2a9a59f0e4d4f3
-  data.tar.gz: e7c2f156a73c6444459e7f79b807b3b3d278881ee86fdb2b623f5ca3d672e40aad13dc9bfa51c41f109c4bbf105ac62a65d941b30e1a4c0aa2032213fa2af211
+  metadata.gz: 45016c4328a08599f893afc974ecb34446177b252d7865718f8fdd95207e91a06849f2ba951b38dac16aabb7183816ca0747c4b185cc54f900c47509ecf717eb
+  data.tar.gz: '029b04eeb7b19020613d8fa0dab444e6fe91703887688dd473e83b361fdb5858d56327237f809535c197d243c47cc327b3c96444aaa4f8518d406fc32423bc38'

data/README.md

@@ -2,6 +2,10 @@
 
 Ruboty plugin to manage a duty that members in a slack channel take turns on
 
+## Dependencies
+- ruboty
+- ruboty-slack_rtm
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -18,9 +22,65 @@ Or install it yourself as:
 
     $ gem install ruboty-slack_take_turns
 
+## ENV
+```
+SLACK_TOKEN - Browse Apps > Custom Integrations > Bots > API Token
+ASSIGN_REGEX - e.g. .*http:\/\/example.com\/issues.*
+# Default language is English. If you add below, messages is displayed in Japanese.
+SLACK_TAKE_TURNS_LANG=ja
+```
+
+## Commands
+```
+ruobty /current/ - show who is on duty currently
+ruobty /exclude (?<user_name>.+?)\z/ - make a specified member to not be on duty after this
+ruobty /include (?<user_name>.+?)\z/ - make a specified member to be on duty after this
+ruobty /force (?<user_name>.+?)\z/ - make a specified member to be on duty
+ruobty /members/ - member list in a channel(order by slack-user-id asc)
+ruobty /next/ - pass on a duty to the next member
+/(?<keyword>.*http:\/\/example.com\/issues.*)/m - When a macthed keyword is posted, the bot assigns a person on duty to a task related the keyword.
+```
+
 ## Usage
 
-TODO: Write usage instructions here
+### check members
+```
+> ruboty members
+oharato, jimmy, ellen, ruboty
+```
+
+### set the first person on duty
+```
+> ruboty force oharato
+made @oharato to take over a duty
+```
+
+check current status
+```
+> ruboty current
+@oharato is on duty now.
+```
+
+```
+> ruboty members
+[flag]oharato, jimmy, ellen, ruboty
+```
+
+### post a keyword you set in .env
+```
+> http://example.com/issues/42
+@oharato, please deal with the task below.
+http://example.com/issues/42
+```
+
+### pass on a duty to the next member
+```
+> ruboty next
+passed on a duty to the next member. @jimmy is on duty now.
+```
+
+## Notice
+- You should use a ruboty brain plugin such as ruboty-local_yaml and ruboty-redis.
 
 ## Development
 
@@ -30,5 +90,5 @@ 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]/ruboty-slack_take_turns.
+Bug reports and pull requests are welcome on GitHub at https://github.com/oharato/ruboty-slack_take_turns.
 

data/lib/ruboty/handlers/slack_take_turns.rb

@@ -7,32 +7,37 @@ module Ruboty
       on(
         /members/,
         name: "members",
-        description: "member list in a channel(order by slack-user-id asc)"
+        description: "#{I18n.t 'messages.handlers.members'}"
       )
       on(
         /force (?<user_name>.+?)\z/,
         name: "force",
-        description: "make a specified member to be on duty",
+        description: "#{I18n.t 'messages.handlers.force'}",
       )
       on(
         /current/,
         name: "current",
-        description: "show who is on duty currently",
+        description: "#{I18n.t 'messages.handlers.current'}",
       )
       on(
         /next/,
         name: "next",
-        description: "pass on a duty to the next member",
+        description: "#{I18n.t 'messages.handlers.next'}",
       )
       on(
         /exclude (?<user_name>.+?)\z/,
         name: "exclude",
-        description: "make a specified member to not be on duty after this",
+        description: "#{I18n.t 'messages.handlers.exclude'}",
+      )
+      on(
+        /include (?<user_name>.+?)\z/,
+        name: "include",
+        description: "#{I18n.t 'messages.handlers.include'}",
       )
       on(
         /(?<keyword>#{ENV['ASSIGN_REGEX']})/m,
         name: "assign",
-        description: "When a macthed keyword is posted, the bot assigns a person on duty to a task related the keyword.",
+        description: "#{I18n.t 'messages.handlers.assign'}",
         all: true,
       )
 
@@ -59,6 +64,10 @@ module Ruboty
         Ruboty::SlackTakeTurns::Actions::Exclude.new(message).call
       end
 
+      def include(message)
+        Ruboty::SlackTakeTurns::Actions::Include.new(message).call
+      end
+
       def assign(message)
         Ruboty::SlackTakeTurns::Actions::Assign.new(message).call
       end

data/lib/ruboty/slack_take_turns/actions/assign.rb

@@ -18,10 +18,7 @@ module Ruboty
           # avoid self-repeating
           return if message.from_name == message.robot.name
           keyword = message[:keyword]
-          <<~"EOF"
-          @#{current_user_name}, please deal with the task below.
-          #{keyword}
-          EOF
+          "#{I18n.t 'messages.actions.assign', current_user_name: current_user_name, keyword: keyword}"
         end
 
       end

data/lib/ruboty/slack_take_turns/actions/base.rb

@@ -2,7 +2,7 @@ module Ruboty
   module SlackTakeTurns
     module Actions
       class Base
-        NAMESPACE = 'slack_duty'
+        NAMESPACE = 'slack_take_turns'
 
         attr_reader :message
 
@@ -79,13 +79,13 @@ module Ruboty
 
         class CurrentUserNotFound < ActionBaseError
           def message
-            "not specified who is on duty. use 'force' command"
+            "#{I18n.t 'errors.current_user_not_found'}"
           end
         end
 
         class UserNotFound < ActionBaseError
           def message
-            "#{@user_name} is not found. spelling mistake?"
+            "#{I18n.t 'errors.user_not_found', user_name: @user_name}"
           end
         end
 

data/lib/ruboty/slack_take_turns/actions/current.rb

@@ -15,7 +15,7 @@ module Ruboty
         private
 
         def current
-          "@#{current_user_name} is on duty now."
+          "#{I18n.t 'messages.actions.current', current_user_name: current_user_name}"
         end
 
       end

data/lib/ruboty/slack_take_turns/actions/exclude.rb

@@ -20,7 +20,7 @@ module Ruboty
           unless excluded_user_ids.include? user_id
             excluded_user_ids << user_id
           end
-          "made @#{user_name} to not be on duty after this"
+          "#{I18n.t 'messages.actions.exclude', user_name: user_name}"
         end
 
       end

data/lib/ruboty/slack_take_turns/actions/force.rb

@@ -19,9 +19,9 @@ module Ruboty
           user_id = find_user_id_by_user_name(user_name)
           if target_user_ids.include? user_id
             channel_data[:current_user_id] = user_id
-            "made @#{user_name} to take over a duty"
+            "#{I18n.t 'messages.actions.force.ok', user_name: user_name}"
           else
-            "#{user_name} is free from a duty"
+            "#{I18n.t 'messages.actions.force.ng', user_name: user_name}"
           end
         end
 

data/lib/ruboty/slack_take_turns/actions/include.rb

@@ -0,0 +1,29 @@
+module Ruboty
+  module SlackTakeTurns
+    module Actions
+      class Include < Base
+        def call
+          message.reply(include)
+        rescue ActionBaseError => e
+          message.reply(e.message)
+          Ruboty.logger.info e.to_s
+        rescue => e
+          message.reply(e.message)
+          raise e
+        end
+
+        private
+
+        def include
+          user_name = message[:user_name]
+          user_id = find_user_id_by_user_name(user_name)
+          if excluded_user_ids.include? user_id
+            excluded_user_ids.delete user_id
+          end
+          "#{I18n.t 'messages.actions.include', user_name: user_name}"
+        end
+
+      end
+    end
+  end
+end

data/lib/ruboty/slack_take_turns/actions/next.rb

@@ -16,7 +16,7 @@ module Ruboty
 
         def _next
           self.current_user_id = find_next
-          "passed on a duty to the next member. @#{current_user_name} is on duty now."
+          "#{I18n.t 'messages.actions.next', current_user_name: current_user_name}"
         end
 
         def find_next

data/lib/ruboty/slack_take_turns/locale/en.yml

@@ -0,0 +1,23 @@
+en:
+  messages:
+    handlers:
+      members: member list in a channel(order by slack-user-id asc)
+      force: make a specified member to be on duty
+      current: show who is on duty currently
+      next: pass on a duty to the next member
+      exclude: make a specified member to not be on duty after this
+      assign: When a macthed keyword is posted, the bot assigns a person on duty to a task related the keyword.
+    actions:
+      assign: |
+        @%{current_user_name}, please deal with the task below.
+        %{keyword}
+      current: "@%{current_user_name} is on duty now."
+      exclude: made @%{user_name} to not be on duty after this
+      include: made @%{user_name} to be on duty after this
+      force:
+        ok: made @%{user_name} to take over a duty
+        ng: "%{user_name} is free from a duty"
+      next: passed on a duty to the next member. @%{current_user_name} is on duty now.
+  errors:
+    current_user_not_found: not specified who is on duty. use 'force' command
+    user_not_found: "%{user_name} is not found. spelling mistake?"

data/lib/ruboty/slack_take_turns/locale/ja.yml

@@ -0,0 +1,24 @@
+ja:
+  messages:
+    handlers:
+      members: 当番一覧 (slackユーザIDの昇順)
+      force: 当番を指定します
+      current: 現在の当番を表示します
+      next: 当番をまわします
+      exclude: メンバーを当番から除外します
+      include: メンバーを当番に加えます
+      assign: キーワードが投稿されると、現在の当番にキーワードに関する当番の依頼をします
+    actions:
+      assign: |
+        @%{current_user_name}さん、下記の対応をお願いします。
+        %{keyword}
+      current: "現在の当番は@%{current_user_name}さんです"
+      exclude: "@%{user_name}さんを当番から除外しました"
+      include: "@%{user_name}さんを当番に加えました"
+      force:
+        ok: "@%{user_name}さんを当番にしました"
+        ng: "%{user_name}さんは当番から除外されています"
+      next: 当番をまわしました。現在の当番は@%{current_user_name}さんです
+  errors:
+    current_user_not_found: 当番が指定されていません。'force'コマンドを使ってください
+    user_not_found: "%{user_name}さんが見つかりませんでした。スペルミス？"

data/lib/ruboty/slack_take_turns/version.rb

@@ -1,5 +1,5 @@
 module Ruboty
   module SlackTakeTurns
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/ruboty/slack_take_turns.rb

@@ -1,15 +1,24 @@
+require "i18n"
+I18n.load_path = []
+Dir.glob("#{File.expand_path('../slack_take_turns', __FILE__)}/locale/*.yml").each do |f|
+  lang = []
+  lang << f
+  I18n.load_path << lang
+end
+I18n.enforce_available_locales = false
+I18n.default_locale = ENV['SLACK_TAKE_TURNS_LANG'] ? ENV['SLACK_TAKE_TURNS_LANG'].to_sym : :en
 require "ruboty"
 require "ruboty/slack_take_turns/slack_client"
 require "ruboty/slack_take_turns/actions/base"
 require "ruboty/slack_take_turns/actions/assign"
 require "ruboty/slack_take_turns/actions/current"
 require "ruboty/slack_take_turns/actions/exclude"
+require "ruboty/slack_take_turns/actions/include"
 require "ruboty/slack_take_turns/actions/force"
 require "ruboty/slack_take_turns/actions/members"
 require "ruboty/slack_take_turns/actions/next"
 require "ruboty/slack_take_turns/version"
 require "ruboty/handlers/slack_take_turns"
-
 module Ruboty
   module SlackTakeTurns
     # Your code goes here...

data/ruboty-slack_take_turns.gemspec

@@ -25,4 +25,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
 
   spec.add_dependency "ruboty-slack_rtm"
+  spec.add_dependency "i18n"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruboty-slack_take_turns
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - oharato
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-11 00:00:00.000000000 Z
+date: 2017-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruboty plugin to manage a duty that members in a slack channel take turns
   on
 email:
@@ -74,8 +88,11 @@ files:
 - lib/ruboty/slack_take_turns/actions/current.rb
 - lib/ruboty/slack_take_turns/actions/exclude.rb
 - lib/ruboty/slack_take_turns/actions/force.rb
+- lib/ruboty/slack_take_turns/actions/include.rb
 - lib/ruboty/slack_take_turns/actions/members.rb
 - lib/ruboty/slack_take_turns/actions/next.rb
+- lib/ruboty/slack_take_turns/locale/en.yml
+- lib/ruboty/slack_take_turns/locale/ja.yml
 - lib/ruboty/slack_take_turns/slack_client.rb
 - lib/ruboty/slack_take_turns/version.rb
 - ruboty-slack_take_turns.gemspec
@@ -99,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Ruboty plugin to manage a duty that members in a slack channel take turns