ruboty-slack_take_turns 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fbecdea07ac49e879c4cb05ad2c25d041a90da2d
+  data.tar.gz: 86e6f32d3d1cf351e144b290ec09157f9636ee0f
+SHA512:
+  metadata.gz: 647821d34aedd620f87ee9afbeb3850bbee49c4a7fba3744f687c55fc97cb61520de6bcf6d701aadfec5f63a4d2b003f0372e97e00c8999b8e2a9a59f0e4d4f3
+  data.tar.gz: e7c2f156a73c6444459e7f79b807b3b3d278881ee86fdb2b623f5ca3d672e40aad13dc9bfa51c41f109c4bbf105ac62a65d941b30e1a4c0aa2032213fa2af211

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ruboty-slack_take_turns.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 oharato
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,34 @@
+# Ruboty::SlackTakeTurns
+
+Ruboty plugin to manage a duty that members in a slack channel take turns on
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruboty-slack_take_turns'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruboty-slack_take_turns
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ruboty-slack_take_turns.
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ruboty/slack_take_turns"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ruboty/handlers/slack_take_turns.rb

@@ -0,0 +1,68 @@
+module Ruboty
+  module Handlers
+    # manage a duty that members in a slack channel take turns on
+    class SlackTakeTurns < Base
+      NAMESPACE = "slack_take_turns"
+
+      on(
+        /members/,
+        name: "members",
+        description: "member list in a channel(order by slack-user-id asc)"
+      )
+      on(
+        /force (?<user_name>.+?)\z/,
+        name: "force",
+        description: "make a specified member to be on duty",
+      )
+      on(
+        /current/,
+        name: "current",
+        description: "show who is on duty currently",
+      )
+      on(
+        /next/,
+        name: "next",
+        description: "pass on a duty to the next member",
+      )
+      on(
+        /exclude (?<user_name>.+?)\z/,
+        name: "exclude",
+        description: "make a specified member to not be on duty after this",
+      )
+      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.",
+        all: true,
+      )
+
+      env :SLACK_TOKEN, "Browse Apps > Custom Integrations > Bots > API Token"
+      env :ASSIGN_REGEX, "e.g. .*http:\/\/github.com.*"
+
+      def members(message)
+        Ruboty::SlackTakeTurns::Actions::Members.new(message).call
+      end
+
+      def force(message)
+        Ruboty::SlackTakeTurns::Actions::Force.new(message).call
+      end
+
+      def current(message)
+        Ruboty::SlackTakeTurns::Actions::Current.new(message).call
+      end
+
+      def next(message)
+        Ruboty::SlackTakeTurns::Actions::Next.new(message).call
+      end
+
+      def exclude(message)
+        Ruboty::SlackTakeTurns::Actions::Exclude.new(message).call
+      end
+
+      def assign(message)
+        Ruboty::SlackTakeTurns::Actions::Assign.new(message).call
+      end
+
+    end
+  end
+end

data/lib/ruboty/slack_take_turns.rb

@@ -0,0 +1,17 @@
+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/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...
+  end
+end

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

@@ -0,0 +1,30 @@
+module Ruboty
+  module SlackTakeTurns
+    module Actions
+      class Assign < Base
+        def call
+          message.reply(assign)
+        rescue ActionBaseError => e
+          message.reply(e.message)
+          Ruboty.logger.info e.to_s
+        rescue => e
+          message.reply(e.message)
+          raise e
+        end
+
+        private
+
+        def assign
+          # 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
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,95 @@
+module Ruboty
+  module SlackTakeTurns
+    module Actions
+      class Base
+        NAMESPACE = 'slack_duty'
+
+        attr_reader :message
+
+        def initialize(message)
+          @message = message
+        end
+
+        def channel
+          message.to
+        end
+
+        def sender_id
+          message.from
+        end
+
+        def data
+          message.robot.brain.data[NAMESPACE] ||= {}
+        end
+
+        def channel_data
+          data[channel] ||= {}
+        end
+
+        def current_user_id
+          channel_data[:current_user_id]
+        end
+
+        def current_user_id=(id)
+          channel_data[:current_user_id] = id
+        end
+
+        def slack_client
+          @slack_client ||= Ruboty::SlackTakeTurns::SlackClient.new(channel)
+        end
+
+        def target_user_ids
+          slack_client.channel_user_ids - excluded_user_ids
+        end
+
+        def excluded_user_ids
+          channel_data[:excluded_user_ids] ||= []
+        end
+
+        def current_user_name
+          find_user_by_user_id(current_user_id)['name']
+        rescue
+          raise CurrentUserNotFound.new(chat_message: message)
+        end
+
+        def find_user_by_user_id(user_id)
+          slack_client.all_users_hash[user_id] || raise(UserNotFound.new(user_id: user_id, chat_message: message))
+        end
+
+        def find_user_id_by_user_name(user_name)
+          user = slack_client.all_users.find{|u| u['name'] == user_name}
+          user ? user['id'] : raise(UserNotFound.new(user_name: user_name, chat_message: message))
+        end
+
+        class ActionBaseError < StandardError
+          def initialize(chat_message: nil, user_id: nil, user_name: nil)
+            @chat_message = chat_message
+            @user_id = user_id
+            @user_name = user_name
+          end
+
+          def to_s
+            <<~"EOF"
+            #{self.class.to_s}
+            user_id:#{@user_id}, user_name:#{@user_name}, from:#{@chat_message.from_name}, channel:#{@chat_message.to}, body:#{@chat_message.body}
+            #{backtrace.take(4).join("\n")}
+            EOF
+          end
+        end
+
+        class CurrentUserNotFound < ActionBaseError
+          def message
+            "not specified who is on duty. use 'force' command"
+          end
+        end
+
+        class UserNotFound < ActionBaseError
+          def message
+            "#{@user_name} is not found. spelling mistake?"
+          end
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+module Ruboty
+  module SlackTakeTurns
+    module Actions
+      class Current < Base
+        def call
+          message.reply(current)
+        rescue ActionBaseError => e
+          message.reply(e.message)
+          Ruboty.logger.info e.to_s
+        rescue => e
+          message.reply(e.message)
+          raise e
+        end
+
+        private
+
+        def current
+          "@#{current_user_name} is on duty now."
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+module Ruboty
+  module SlackTakeTurns
+    module Actions
+      class Exclude < Base
+        def call
+          message.reply(exclude)
+        rescue ActionBaseError => e
+          message.reply(e.message)
+          Ruboty.logger.info e.to_s
+        rescue => e
+          message.reply(e.message)
+          raise e
+        end
+
+        private
+
+        def exclude
+          user_name = message[:user_name]
+          user_id = find_user_id_by_user_name(user_name)
+          unless excluded_user_ids.include? user_id
+            excluded_user_ids << user_id
+          end
+          "made @#{user_name} to not be on duty after this"
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+module Ruboty
+  module SlackTakeTurns
+    module Actions
+      class Force < Base
+        def call
+          message.reply(force)
+        rescue ActionBaseError => e
+          message.reply(e.message)
+          Ruboty.logger.info e.to_s
+        rescue => e
+          message.reply(e.message)
+          raise e
+        end
+
+        private
+
+        def force
+          user_name = message[:user_name]
+          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"
+          else
+            "#{user_name} is free from a duty"
+          end
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+module Ruboty
+  module SlackTakeTurns
+    module Actions
+      class Members < Base
+        def call
+          message.reply(members)
+        rescue ActionBaseError => e
+          message.reply(e.message)
+          Ruboty.logger.info e.to_s
+        rescue => e
+          message.reply(e.message)
+          raise e
+        end
+
+        private
+        def members
+          user_names = target_user_ids.map do |id|
+            name = find_user_by_user_id(id)['name']
+            name = ":triangular_flag_on_post:#{name}" if id == current_user_id
+            name
+          end
+          user_names.join(', ')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+module Ruboty
+  module SlackTakeTurns
+    module Actions
+      class Next < Base
+        def call
+          message.reply(_next)
+        rescue ActionBaseError => e
+          message.reply(e.message)
+          Ruboty.logger.info e.to_s
+        rescue => e
+          message.reply(e.message)
+          raise e
+        end
+
+        private
+
+        def _next
+          self.current_user_id = find_next
+          "passed on a duty to the next member. @#{current_user_name} is on duty now."
+        end
+
+        def find_next
+          raise(CurrentUserNotFound.new(chat_message: message)) unless current_user_id
+          idx = target_user_ids.index(current_user_id)
+          raise UserNotFound.new(chat_message: message, user_id: current_user_id) unless idx
+          if idx == target_user_ids.size - 1
+            target_user_ids.first
+          else
+            target_user_ids[idx+1]
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/ruboty/slack_take_turns/slack_client.rb

@@ -0,0 +1,57 @@
+module Ruboty
+  module SlackTakeTurns
+    class SlackClient
+
+      attr_reader :client, :channel
+
+      def initialize(channel)
+        @client ||= Slack::Client.new(token: ENV['SLACK_TOKEN'])
+        @channel = channel
+      end
+
+      def all_users
+        @all_users ||= client.users_list['members']
+      end
+
+      # ユーザを取得しやすくするためにユーザIDとユーザオブジェクトのハッシュテーブルを作る
+      def all_users_hash
+        @all_users_hash ||= {}.tap do |h|
+          all_users.each{|u| h[u['id']] = u}
+        end
+      end
+
+      # チャンネル内の全ユーザid
+      def channel_user_ids
+        unless @channel_user_ids&.dig(channel)
+          @channel_user_ids = {} unless @channel_user_ids
+          ids = private_channel? ? private_channel_user_ids : public_channel_user_ids
+          @channel_user_ids[channel] = ids.sort
+        end
+        @channel_user_ids[channel]
+      end
+
+      def channels_info
+        @channels_info ||= client.channels_info(channel: channel)
+      end
+
+      def public_channel_user_ids
+        channels_info['channel']['members']
+      end
+
+      def private_channel_user_ids
+        private_channels = groups_list
+        current_channel = private_channels.find{|c| c['id'] == channel}
+        current_channel['members']
+      end
+
+      def groups_list
+        @groups_list ||= client.groups_list['groups']
+      end
+
+      def private_channel?
+        channels_info['error'] == "channel_not_found"
+      end
+
+    end
+  end
+end

data/lib/ruboty/slack_take_turns/version.rb

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

data/ruboty-slack_take_turns.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ruboty/slack_take_turns/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruboty-slack_take_turns"
+  spec.version       = Ruboty::SlackTakeTurns::VERSION
+  spec.authors       = ["oharato"]
+  spec.email         = ["oharato@live.jp"]
+
+  spec.summary       = %q{Ruboty plugin to manage a duty that members in a slack channel take turns on}
+  spec.description   = %q{Ruboty plugin to manage a duty that members in a slack channel take turns on}
+  spec.homepage      = "https://github.com/oharato/ruboty-slack_take_turns"
+  spec.license = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency "ruboty-slack_rtm"
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: ruboty-slack_take_turns
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- oharato
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: ruboty-slack_rtm
+  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:
+- oharato@live.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ruboty/handlers/slack_take_turns.rb
+- lib/ruboty/slack_take_turns.rb
+- lib/ruboty/slack_take_turns/actions/assign.rb
+- lib/ruboty/slack_take_turns/actions/base.rb
+- 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/members.rb
+- lib/ruboty/slack_take_turns/actions/next.rb
+- lib/ruboty/slack_take_turns/slack_client.rb
+- lib/ruboty/slack_take_turns/version.rb
+- ruboty-slack_take_turns.gemspec
+homepage: https://github.com/oharato/ruboty-slack_take_turns
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Ruboty plugin to manage a duty that members in a slack channel take turns
+  on
+test_files: []