slatan 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 762a507d89d22855482240d036c69e467bf28f41
+  data.tar.gz: 1b914cd1ac32ea6681d160421190a40db5a230c2
+SHA512:
+  metadata.gz: ea1474306a99a0a8fcbf8f208cfa1402e2d022be4675f7710ec6be5c6f85eeae705eeace8ea6941bb524f08769913c2ae773e5104ee93a6bad0494ad63848a2e
+  data.tar.gz: 1ca277268fc5caf17644bfe8334bcb1b651b3689e44c6465ac162297e99f1ee004e04827bdaff8e159be8bbca430b702ff91547efead1a901a6060ea087a506f

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+.DS_Store
+/concerns/
+config.json
+/exe/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.2
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 kudohamu
+
+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,59 @@
+# Slatan
+
+Ruby gem to create bot for Slack easily and flexibly.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'slatan'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install slatan
+
+## Usage
+
+#### 1. Add 'Bot' integration and cory API token on Slack.
+
+#### 2. Generate event subscriber class.
+
+```
+$ rake slatan:generate['/path/to/your/preference/test.rb']
+```
+
+#### 3. Write code to running slatan.
+
+```ruby
+require 'slatan'
+require 'path/to/your/preference/test.rb'
+
+Slatan::Spirit.slack_token = 'xxxx-xxxxxx-xxxxxxxxxx'   #or `export SLACK_TOKEN=xxxxx-xxxx-xxxxxxxxxx`
+
+Slatan::Ear.register(Test.new)   #register event subscriber
+
+Slatan.run   #write 'Slatan.run({ daemonize: true })' if you want to run daemonize mode.
+```
+
+#### 4. type 'ping' on Slack
+
+![slatan example](https://dl.dropboxusercontent.com/u/74925506/slatan_invitation.png)
+
+##Documentation
+Under construction...
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kudohamu/slatan.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,26 @@
+require "bundler/gem_tasks"
+require 'erb'
+require 'active_support/core_ext/object'
+require 'slatan/utils/string_ex'
+
+using Slatan::Utils::StringEx
+namespace :slatan do
+  desc "Kill slatan daemon process."
+  task :stop do
+    path = ENV['SLATAN_PID_FILE_PATH'].presence || '/tmp/slatan.pid'
+    sh "kill `cat #{path}`"
+  end
+
+  desc "Generate event subscriber of slack message."
+  task :generate, [:file_path] do |task, args|
+    file_name = File.basename(args.file_path, '.*')
+    class_name = file_name.camelize
+    dir_path = File.dirname(args.file_path)
+    File.open('./lib/slatan/template/concern.rb.erb') do |file|
+      erb = ERB.new(file.read).result(binding)
+      File.open(File.join(dir_path, "#{file_name}.rb"), 'w') do |file|
+        file << erb
+      end
+    end
+  end
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "slatan"
+
+# 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,6 @@
+#!/bin/bash
+
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install

data/lib/slatan/affiliation/channels.rb

@@ -0,0 +1,36 @@
+module Slatan
+  module Affiliation
+    module Channels
+      @channels = {}
+
+      class << self
+        def get()
+          @channels
+        end
+
+        def set(channels)
+          @channels = channels
+        end
+
+        ## return id of channel name
+        # @param name: channel name
+        def get_id(name)
+          @channels.each do |channel|
+            return channel[:id] if channel[:name] == name
+          end
+          nil
+        end
+
+        ## return name of channel id
+        # @param id: channel id
+        def get_name(id)
+          @channels.each do |channel|
+            return channel[:name] if channel[:id] == id
+          end
+          nil
+        end
+
+      end
+    end
+  end
+end

data/lib/slatan/affiliation/self.rb

@@ -0,0 +1,17 @@
+module Slatan
+  module Affiliation
+    module Self
+      @self = {}
+
+      class << self
+        def get()
+          @self
+        end
+
+        def set(celf)
+          @self = celf
+        end
+      end
+    end
+  end
+end

data/lib/slatan/affiliation/sub_teams.rb

@@ -0,0 +1,17 @@
+module Slatan
+  module Affiliation
+    module SubTeams
+      @sub_teams = {}
+
+      class << self
+        def get()
+          @sub_teams
+        end
+
+        def set(sub_teams)
+          @sub_teams = sub_teams
+        end
+      end
+    end
+  end
+end

data/lib/slatan/affiliation/team.rb

@@ -0,0 +1,17 @@
+module Slatan
+  module Affiliation
+    module Team
+      @team = {}
+
+      class << self
+        def get()
+          @team
+        end
+
+        def set(team)
+          @team = team
+        end
+      end
+    end
+  end
+end

data/lib/slatan/affiliation/users.rb

@@ -0,0 +1,54 @@
+module Slatan
+  module Affiliation
+    module Users
+      @users = {}
+
+      class << self
+        def get()
+          @users
+        end
+
+        def set(users)
+          @users = users
+        end
+
+        ## return id of user name
+        # @param name: user name
+        def get_id(name)
+          @users.each do |user|
+            return user[:id] if user[:name] == name
+          end
+          nil
+        end
+
+        ## return name of user id
+        # @param id: user id
+        def get_name(id)
+          @users.each do |user|
+            return user[:name] if user[:id] == id
+          end
+          nil
+        end
+
+        ## check bot or human
+        # @return bool true: bot, false: human
+        def is_bot?(ident)
+          key = if is_id?(ident) then :id else :name end
+          @users.each do |user|
+            if user[key] == ident
+              return user[:is_bot]
+            end
+          end
+
+          return false
+        end
+
+        ## check id or name
+        # @return bool true: id, false: name
+        def is_id?(key)
+          key =~ /^[A-Z0-9]+$/
+        end
+      end
+    end
+  end
+end

data/lib/slatan/affiliation.rb

@@ -0,0 +1,15 @@
+require 'slatan/affiliation/self'
+require 'slatan/affiliation/team'
+require 'slatan/affiliation/channels'
+require 'slatan/affiliation/sub_teams'
+require 'slatan/affiliation/users'
+
+module Slatan
+  module Affiliation
+    include Self
+    include Team
+    include Channels
+    include SubTeams
+    include Users
+  end
+end

data/lib/slatan/buttocks.rb

@@ -0,0 +1,75 @@
+require 'slatan/spirit'
+require 'logger'
+
+module Slatan
+  ## Wrapper class of Logger
+  class Buttocks
+    @@use_log = Spirit.use_log
+
+    @@color = {
+      reset: 0,
+      fatal: 31,  #red
+      error: 31,  #red
+      warn:  33,  #yellow
+      info:  32,  #green
+      debug: 37   #white
+    }
+
+    class << self
+      def init()
+        if @@use_log
+          path = Spirit.log_file_path
+          @@log = Logger.new(path)
+
+          @@log.level = const_level(Spirit.log_level)
+        end
+      end
+
+      def debug(msg)
+        @@log.debug(msg) if @@use_log
+        stdoutput('debug', msg)
+      end
+
+      def info(msg)
+        @@log.info(msg) if @@use_log
+        stdoutput('info', msg)
+      end
+
+      def warn(msg)
+        @@log.warn(msg) if @@use_log
+        stdoutput('warn', msg)
+      end
+
+      def error(msg)
+        @@log.error(msg) if @@use_log
+        stdoutput('error', msg)
+      end
+
+      def fatal(msg)
+        @@log.fatal(msg) if @@use_log
+        stdoutput('fatal', msg)
+      end
+
+      private
+      def const_level(level)
+        case level
+        when 'debug'
+          Logger::DEBUG
+        when 'info'
+          Logger::INFO
+        when 'warn'
+          Logger::WARN
+        when 'error'
+          Logger::ERROR
+        else
+          Logger::FATAL
+        end
+      end
+
+      def stdoutput(level, msg)
+        puts "\e[#{@@color[level.to_sym]}m[#{level}] #{DateTime.now.strftime('%Y-%m-%d %H:%M:%S')}: #{msg}"
+        print "\e[#{@@color[:reset]}m"
+      end
+    end
+  end
+end

data/lib/slatan/ear.rb

@@ -0,0 +1,27 @@
+require 'active_support/core_ext/object/blank'
+
+module Slatan
+  ## class to Event Dispatching for concerns
+  module Ear
+    @concerns = []
+
+    class << self
+      ## register subscriber
+      # @param concern subscriber
+      # @param options option
+      #          cond: <Kernel.#lambda> call hear method of concern if cond.call(msg) is true
+      def register(concern, options={})
+        @concerns << [concern, options[:cond]]
+      end
+
+      ## publish to subscribers
+      def hear(msg)
+        @concerns.each do |concern, cond|
+          if cond.blank? || cond.call(msg)
+            concern.hear(msg)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slatan/heart.rb

@@ -0,0 +1,88 @@
+require 'slatan/spirit'
+require 'slatan/buttocks'
+require 'slatan/affiliation'
+
+require 'faye/websocket'
+require 'eventmachine'
+require 'json'
+
+module Slatan
+  class Heart
+    def beat()
+      Signal.trap(:INT)  { EM.stop }
+      Signal.trap(:TERM) { EM.stop }
+
+      req = Net::HTTP.post_form URI("#{Spirit.slack_api_url}/rtm.start"), token: Spirit.slack_token
+      parsed_body = JSON.parse(req.body, symbolize_names: true)
+      Buttocks.fatal "failed rtm.start (#{parsed_body[:error]})" if !parsed_body[:ok]
+      set_affiliation parsed_body
+      ws_url = parsed_body[:url]
+      EM.run {
+        @ws = Faye::WebSocket::Client.new(ws_url)
+
+        @ws.on :open do |event|
+          Buttocks.info('open')
+        end
+
+        @ws.on :message do |event|
+          Buttocks.debug("message: #{event.data}")
+          data = JSON.parse(event.data, symbolize_names: true)
+          Ear.hear(data) if enable_dispatch data
+        end
+
+        @ws.on :close do |event|
+          Buttocks.warn("close: #{event.code}(#{event.reason})")
+          @ws = nil
+          EM.stop
+        end
+      }
+    end
+
+    private
+
+    def set_affiliation(affiliation)
+      Affiliation::Self.set affiliation[:self]
+      Affiliation::Team.set affiliation[:team]
+      Affiliation::SubTeams.set affiliation[:sub_teams]
+      Affiliation::Channels.set affiliation[:channels]
+      Affiliation::Users.set affiliation[:users]
+    end
+
+    # check whether data enable dispatching
+    # @param [hash] received data
+    def enable_dispatch(data)
+      if Spirit.ignore_bot_reply && is_bot_reply?(data)
+        return false
+      end
+
+      if Spirit.ignore_self_message && is_self_message?(data)
+        return false
+      end
+
+      true
+    end
+
+    # check whether message is bot retry
+    # @return [bool]
+    def is_bot_reply?(data)
+      if data[:type] != 'message'
+        return false
+      end
+
+      if data[:text] =~ /^\s*<@#{Affiliation::Self.get[:id]}>:?.*$/ && Affiliation::Users.is_bot?(data[:user])
+        return true
+      end
+
+      false
+    end
+
+    # check whether self message
+    # @return [bool]
+    def is_self_message?(data)
+      if data[:type] == 'message' && data[:user] == Affiliation::Self.get[:id]
+        return true
+      end
+      false
+    end
+  end
+end

data/lib/slatan/mouth/api.rb

@@ -0,0 +1,19 @@
+module Slatan
+  module Mouth
+    module Api
+      @category = 'api'
+
+      class << self
+        ## @see https://api.slack.com/methods/api.test
+        def test(options={})
+          send('test', options)
+        end
+
+        private
+        def send(method, msg)
+          Mouth.send(@category, method, msg)
+        end
+      end
+    end
+  end
+end

data/lib/slatan/mouth/auth.rb

@@ -0,0 +1,19 @@
+module Slatan
+  module Mouth
+    module Auth
+      @category = 'auth'
+
+      class << self
+        ## @see https://api.slack.com/methods/auth.test
+        def test(options={})
+          send('test', options)
+        end
+
+        private
+        def send(method, msg)
+          Mouth.send(@category, method, msg)
+        end
+      end
+    end
+  end
+end

data/lib/slatan/mouth/channels.rb

@@ -0,0 +1,57 @@
+module Slatan
+  module Mouth
+    module Channels
+      @category = 'channels'
+
+      class << self
+        ## @see https://api.slack.com/methods/channels.history
+        def history(channel, options={})
+          send('history', {
+            channel: channel
+          }.merge(options))
+        end
+
+        ## @see https://api.slack.com/methods/channels.info
+        def info(channel, options={})
+          send('info', {
+            channel: channel
+          }.merge(options))
+        end
+        
+        ## @see https://api.slack.com/methods/channels.list
+        def list(options={})
+          send('list', options)
+        end
+
+        ## @see https://api.slack.com/methods/channels.mark
+        def mark(channel, ts, options={})
+          send('mark', {
+            channel: channel,
+            ts: ts
+          }.merge(options))
+        end
+
+        ## @see https://api.slack.com/methods/channels.setPurpose
+        def set_purpose(channel, purpose, options={})
+          send('setPurpose', {
+            channel: channel,
+            purpose: purpose
+          }.merge(options))
+        end
+
+        ## @see https://api.slack.com/methods/channels.setTopic
+        def set_topic(channel, topic, options={})
+          send('setTopic', {
+            channel: channel,
+            topic: topic
+          }.merge(options))
+        end
+
+        private
+        def send(method, msg)
+          Mouth.send(@category, method, msg)
+        end
+      end
+    end
+  end
+end

data/lib/slatan/mouth/chat.rb

@@ -0,0 +1,39 @@
+module Slatan
+  module Mouth
+    module Chat
+      @category = 'chat'
+
+      class << self
+        ## @see https://api.slack.com/methods/chat.postMessage
+        def post_message(channel, text, options={})
+          send('postMessage', {
+            channel: channel,
+            text: text
+          }.merge(options))
+        end
+
+        ## @see https://api.slack.com/methods/chat.update
+        def update(ts, channel, text, options={})
+          send('update', {
+            ts: ts,
+            channel: channel,
+            text: text
+          }.merge(options))
+        end
+
+        ## @see https://api.slack.com/methods/chat.delete
+        def delete(channel, ts, options={})
+          send('delete', {
+            ts: ts,
+            channel: channel
+          }.merge(options))
+        end
+
+        private
+        def send(method, msg)
+          Mouth.send(@category, method, msg)
+        end
+      end
+    end
+  end
+end