walle 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: acfc85300f6cc74758be0fb2219e21f2e0beebce
+  data.tar.gz: d5d5d4eb5cd483999b3195d6cd124e4012130c04
+SHA512:
+  metadata.gz: 4de7e44960484c935ef8afd8f12ede6cdbe856b8cc923868fd5b8628c616c0bf66e4e585f574c73a399985ce1c3255a0b7a80dbe8938338f62bdef575f8a53e9
+  data.tar.gz: 077f7233901f8ce310e3f695b654bcee973f2fbad4e13c23e4d2ef8af6e2a20eedc22c786a93ca7d88f8f274d5a61ffbe2922828b29ff0ccd18b809448fd33f6

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--require spec_helper
+--color

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in walle.gemspec
+gemspec
+
+gem 'pry'
+gem 'celluloid-io'
+gem 'rspec-collection_matchers'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 undr
+
+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,170 @@
+# Walle
+
+[![Build Status](https://travis-ci.org/undr/walle.svg?branch=master)](https://travis-ci.org/undr/walle)
+
+Simple DSL for building Slack bots.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'walle'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install walle
+```
+
+## Usage
+
+Example bot class:
+
+```ruby
+class Robot < Walle::Robot
+  # Use middleware for all events
+  use Walle::Middlewares::Logger, Slack.config.logger
+
+  # catch `hello` events
+  hello { |env| }
+
+  # catch `start` events
+  start { |env| }
+
+  # catch `message` events
+  message { |env| }
+
+  # catch `close` events
+  close { |env| }
+
+  # catch `closed` events
+  closed { |env| }
+
+  routes do
+    # Use middleware ONLY for routes
+    use SomeCustomMidleware, 'arg1', 'arg2'
+
+    # Equals to match(/(?<command>convert|c)\s+(?<amount>\d+)\s*(?<from>[A-Z]{3})\s+into\s+(?<to>[A-Z]{3})/, controller: CurrencyConvertor)
+    command 'convert', 'c', amount: /\d+/, from: /[A-Z]{3}/, into: 'into', to: /[A-Z]{3}/, delimiter: /\s+/, controller: CurrencyConvertor
+
+    # Prefix all matches with bot name, eg. <@U2EU6KZDW>
+    direct do
+      # Matches string like "<@U2EU6KZDW> convert 10000 RUB into EUR"
+      match /convert\s+(?<amount>\d+)\s*(?<from>[A-Z]{3})\s+into\s+(?<to>[A-Z]{3})/ do |env|
+        # env.event   - :message
+        # env.client  - Slack::RealTime::Client
+        # env.data    - Event data (it can contain extra data that can be added in middlewares)
+        #   - type: "message"
+        #   - channel: "V2T4X87M5"
+        #   - user: "Z005UR62C"
+        #   - text: "<@U2EU6KZDW> convert 10000 RUB into EUR"
+        #   - ts: "1474580776.000003"
+        #   - team: "T020WVADD"
+        #   - ...
+        # env.matches - MatchData object with captured values:
+        #   - amount: 10000
+        #   - from: RUB
+        #   - to: EUR
+      end
+    end
+
+    # Add prefix to all routes
+    prefix 'Hi (?<name>\w+),\s+' do
+      # Matches string like "Hi Dave, blah blah blah" and "Dave" will be captured in env.matches[:name]
+      match /.*/, controller: GreetingsController
+    end
+  end
+end
+```
+
+Configure Slack client:
+
+```ruby
+Slack.configure do |c|
+  c.token = 'xxxx-9295867...'
+  c.logger = Logger.new(STDOUT)
+  c.logger.level = Logger::INFO
+end
+```
+
+And run the bot: `Robot.run`, `Robot.run(async: true)`.
+
+Also you can manually create the bot and give to him a prepared client:
+
+```ruby
+client = Slack::RealTime::Client.new(options)
+robot  = Robot.new(client, async: true)
+robot.run
+```
+
+### Routes
+
+There are three methods for creating routes: `match`, `command` and `default`:
+
+- `match(regexp, options, &block)` - Add route based on regular expression.
+  - `regexp` - Regular expression.
+  - `options` - Options that adjust route behavior.
+    - `prefix` - Add prefix for regular expression, default: `/.*/`. If you want to delete prefix you should use `prefix: false`. `prefix: nil` resets prefix to default value.
+    - `direct` -  Uses to create direct route. This’s route that directly address to bot. Messages without `<@botname>` at the start of command will be rejected.
+    - `controller` - Any class or object that has `call` method. It can be instance or class method.
+  - `block` - It will be used as controller when block is defined.
+
+
+- `command(*commands, options, block)` - Construct a regular expression using command names and add route using `match`. Check examples.
+
+  ```ruby
+  # Equals to: match(/(?<command>convert|c)\s+(?<amount>\d+)\s*(?<from>[A-Z]{3})\s+into\s+(?<to>[A-Z]{3})/) { |env| }
+  command 'convert', 'c', amount: /\d+/, from: /[A-Z]{3}/, into: 'into', to: /[A-Z]{3}/, delimiter: /\s+/ do |env|
+    # "convert 10000 RUB into EUR"
+    # `env.matches` is:
+    #  - command: "convert"
+    #  - amount: 10000
+    #  - from: "RUB"
+    #  - to: "EUR"
+  end
+  ```
+
+  Example:
+
+  ```ruby
+  command 'add', 'subtract', 'multiply', 'divide', first: /\d+/, second: /\d+/ do |env|
+    result = case env.matches[:command]
+    when 'add'
+      env.matches[:first].to_i + env.matches[:second].to_i
+    when 'subtract'
+      env.matches[:first].to_i - env.matches[:second].to_i
+    when 'multiply'
+      env.matches[:first].to_i * env.matches[:second].to_i
+    when 'divide'
+      env.matches[:first].to_i / env.matches[:second].to_i
+    end
+
+    env.client.message(channel: env.data.channel, text: result.to_s)
+  end
+  ```
+
+- `default(options, block)` - Create default route. It will be used if no one route was matched.
+
+### Controllers
+
+TODO:
+
+### Inheritance
+
+All routes and event handlers from parent class and subclass will be merged when we inherit one bot from another one.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/undr/walle.
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "walle"
+
+# 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/walle.rb

@@ -0,0 +1,6 @@
+require 'slack-ruby-client'
+require 'walle/version'
+require 'walle/robot'
+
+module Walle
+end

data/lib/walle/controller.rb

@@ -0,0 +1,26 @@
+module Walle
+  class Controller
+    attr_reader :env
+
+    def initialize(env)
+      @env = env
+    end
+
+    def call
+    end
+
+    protected
+
+    delegate :data, :client, :matches, to: :env
+
+    def message(options)
+      options[:channel] ||= data.channel
+      client.message(options)
+    end
+
+    def typing(options = {})
+      options[:channel] ||= data.channel
+      client.typing(options)
+    end
+  end
+end

data/lib/walle/middlewares/builder.rb

@@ -0,0 +1,46 @@
+module Walle
+  module Middlewares
+    class Builder
+      class Proxy
+        attr_reader :target_class, :app, :args, :block
+
+        def initialize(target_class, app, *args, &block)
+          @target_class, @app, @args, @block = target_class, app, args, block
+        end
+
+        def call(env)
+          with_env(env) do |target|
+            target.before if target.respond_to?(:before)
+            app.call(env)
+            target.after if target.respond_to?(:after)
+          end
+        end
+
+        private
+
+        def with_env(env)
+          yield target_class.new(env, *args, &block)
+        end
+      end
+
+      def initialize(default_app = nil, &block)
+        @use, @run = [], default_app
+        instance_eval(&block) if block_given?
+      end
+
+      def use(middleware, *args, &block)
+        @use << ->(app){ Proxy.new(middleware, app, *args, &block) }
+      end
+
+      def to_app(app)
+        app ||= @run
+        fail 'missing run statement' unless app
+        @use.reverse.inject(app){|a, e| e[a] }
+      end
+
+      def call(env)
+        to_app.call(env)
+      end
+    end
+  end
+end

data/lib/walle/middlewares/helper.rb

@@ -0,0 +1,16 @@
+module Walle
+  module Middlewares
+    module Helper
+      def use(middleware, *args)
+        @middlewares ||= Builder.new
+        @middlewares.use(middleware, *args)
+      end
+
+      private
+
+      def run_middlewares(env, &block)
+        @middlewares.to_app(block).call(env)
+      end
+    end
+  end
+end

data/lib/walle/middlewares/logger.rb

@@ -0,0 +1,17 @@
+module Walle
+  module Middlewares
+    class Logger
+      attr_reader :env, :logger, :options
+
+      def initialize(env, logger, options = {})
+        @env = env
+        @logger = logger
+        @options = options
+      end
+
+      def before
+        logger.info("[#{env.event}] - #{env.data.to_json}")
+      end
+    end
+  end
+end

data/lib/walle/robot.rb

@@ -0,0 +1,56 @@
+require 'walle/middlewares/helper'
+require 'walle/middlewares/builder'
+require 'walle/middlewares/logger'
+require 'walle/robot/router'
+require 'walle/robot/definitions'
+require 'walle/controller'
+
+module Walle
+  class Robot
+    Environment = Struct.new(:event, :client, :data, :matches)
+
+    class_attribute :_definitions, instance_writer: false
+    self._definitions = Definitions::Stack.new
+
+    class << self
+      delegate *Definitions::METHODS, to: :_definitions
+
+      def inherited(subclass)
+        subclass._definitions.push(Definitions.new)
+        super
+      end
+
+      def run(options = {}, &block)
+        client   = Slack::RealTime::Client.new(options)
+        instance = new(client, options)
+        instance.run(&block)
+        instance
+      end
+    end
+
+    attr_reader :client
+
+    def initialize(client, options = {})
+      @client  = client
+      @async   = !!options.delete(:async)
+      @options = options
+    end
+
+    def run(&block)
+      _definitions.apply_to(client)
+      async? ? client.start_async(&block) : client.start!(&block)
+    end
+
+    def stop
+      client.stop!
+    end
+
+    def started?
+      client.started?
+    end
+
+    def async?
+      @async
+    end
+  end
+end

data/lib/walle/robot/definitions.rb

@@ -0,0 +1,76 @@
+module Walle
+  class Robot
+    class Definitions
+      EVENTS = %i{start hello close closed message}
+      METHODS = EVENTS + %i{use routes pattern}
+
+      class Stack
+        delegate *Definitions::METHODS, to: :current
+
+        def initialize
+          @entities = []
+        end
+
+        def push(definitions)
+          @entities << definitions
+        end
+
+        def current
+          @entities.last
+        end
+
+        def apply_to(client)
+          @entities.each do |definitions|
+            definitions.apply_to(client)
+          end
+        end
+      end
+
+      include ::Walle::Middlewares::Helper
+
+      attr_reader :all_handlers
+
+      def initialize
+        @all_handlers = Hash.new { |h, k| h[k] = [] }
+      end
+
+      EVENTS.each do |event|
+        define_method(event) do |&handler|
+          handlers(event) << handler
+        end
+      end
+
+      def routes(&block)
+        router = Router.new(&block)
+        message { |env| router.call(env) }
+      end
+
+      def apply_to(client)
+        all_handlers.each do |event, event_handlers|
+          event_handlers.each do |handler|
+            client.on(event) do |data|
+              handle_event(environment(event, client, data), handler)
+            end
+          end
+        end
+      end
+
+      def handlers(event = nil)
+        return all_handlers[event] if event
+        all_handlers.values.flatten.uniq
+      end
+
+      private
+
+      def environment(event, client, data)
+        Environment.new(event, client, data)
+      end
+
+      def handle_event(env, handler)
+        run_middlewares(env) do |env|
+          handler.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/walle/robot/router.rb

@@ -0,0 +1,41 @@
+require 'walle/robot/router/route'
+require 'walle/robot/router/builder'
+
+module Walle
+  class Robot
+    class Router
+      include ::Walle::Middlewares::Helper
+
+      DEFAULT_CONTROLLER = -> (*_) {}
+      DEFAULT_ROUTER = Route.new(regexp: /.*/, controller: DEFAULT_CONTROLLER)
+
+      attr_reader :routes, :middlewares, :default
+
+      def initialize(&block)
+        @routes = []
+        @default = { true => DEFAULT_ROUTER, false => DEFAULT_ROUTER }
+        run_builder!(block)
+      end
+
+      def call(env)
+        run_middlewares(env) do |env|
+          lookup_route(env).call(env)
+        end
+      end
+
+      private
+
+      def all_routes
+        routes + default.values.uniq
+      end
+
+      def lookup_route(env)
+        all_routes.find { |route| route.match?(env) } || DEFAULT_ROUTER
+      end
+
+      def run_builder!(block)
+        Builder.new(self).build(block)
+      end
+    end
+  end
+end

data/lib/walle/robot/router/builder.rb

@@ -0,0 +1,65 @@
+module Walle
+  class Robot
+    class Router
+      class Builder
+        ROUTE_OPTIONS = %i{controller prefix direct delimiter}
+
+        instance_methods.each do |method|
+          undef_method(method) if method !~ /^(__|instance_eval|class|object_id|with_options|singleton_class|inspect)/
+        end
+
+        attr_reader :router
+
+        def initialize(router)
+          @router = router
+        end
+
+        def pattern(*patterns)
+        end
+
+        def use(middleware, *args)
+          router.use(middleware, *args)
+        end
+
+        def command(*commands, &block)
+          arguments = commands.extract_options!
+          options   = arguments.extract!(*ROUTE_OPTIONS)
+
+          regexp = { command: /#{commands.join(?|)}/ }.merge(arguments).map do |name, regexp|
+            regexp.is_a?(Regexp) ? "(?<#{name}>#{regexp.source})" : "#{regexp}"
+          end.join(options[:delimiter].try(:source) || '\s+')
+
+          match(Regexp.new(regexp), options, &block)
+        end
+
+        def direct(&block)
+          with_options(direct: true, &block)
+        end
+
+        def prefix(value, &block)
+          with_options(prefix: value, &block)
+        end
+
+        def match(regexp, options = {}, &block)
+          controller = extract_controller(options, &block)
+          router.routes << Route.new(options.slice(*ROUTE_OPTIONS).merge(controller: controller, regexp: regexp))
+        end
+
+        def default(options = {}, &block)
+          controller = extract_controller(options, &block)
+          router.default[!!options[:direct]] = Route.new(options.slice(*ROUTE_OPTIONS).merge(controller: controller))
+        end
+
+        def build(block)
+          instance_eval(&block)
+        end
+
+        private
+
+        def extract_controller(options, &block)
+          block_given? ? block : options[:controller].presence || DEFAULT_CONTROLLER
+        end
+      end
+    end
+  end
+end

data/lib/walle/robot/router/route.rb

@@ -0,0 +1,78 @@
+# TODO: Add support of this: https://github.com/andrewberls/regularity
+module Walle
+  class Robot
+    class Router
+      class Route
+        attr_reader :controller, :regexp, :options
+
+        class Mutator
+          attr_reader :env, :regexp, :options
+
+          def initialize(env, regexp, options = {})
+            @env = env
+            @regexp = regexp
+            @options = options
+          end
+        end
+
+        class Prefix < Mutator
+          def mutate
+            return regexp unless prefix
+
+            if regexp
+              Regexp.new("#{prefix}#{regexp.source}")
+            else
+              Regexp.new(prefix)
+            end
+          end
+
+          def prefix
+            return if options[:prefix] === false
+            options[:prefix] || '.*'
+          end
+        end
+
+        class Direct < Mutator
+          def mutate
+            return regexp unless direct?
+
+            robot_name = env.client.self.id
+            expr = regexp || /.*/
+            Regexp.new("<@#{robot_name}>\\s+#{expr.source}")
+          end
+
+          def direct?
+            options[:direct]
+          end
+        end
+
+        MUTATORS = [Direct, Prefix]
+
+        def initialize(controller:, regexp: nil, **options)
+          @controller = controller
+          @options = options
+          @regexp = regexp
+        end
+
+        def match?(env)
+          expr = final_regexp(env)
+          !!expr.match(env.data.text)
+        end
+
+        def call(env)
+          expr = final_regexp(env)
+          env.matches = expr.match(env.data.text) if expr
+          cntrl.respond_to?(:call) ? cntrl.call(env) : cntrl.new(env).call
+        end
+
+        alias :cntrl :controller
+
+        private
+
+        def final_regexp(env)
+          MUTATORS.reduce(regexp) { |result, mutator| mutator.new(env, result, options).mutate }
+        end
+      end
+    end
+  end
+end

data/lib/walle/version.rb

@@ -0,0 +1,3 @@
+module Walle
+  VERSION = "0.1.0"
+end

data/walle.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'walle/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'walle'
+  spec.version       = Walle::VERSION
+  spec.authors       = ['undr']
+  spec.email         = ['undr@yandex.ru']
+
+  spec.summary       = %q{Simple DSL for building Slack bots.}
+  spec.description   = %q{Simple DSL for building Slack bots.}
+  spec.homepage      = 'https://github.com/undr/walle'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'slack-ruby-client'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: walle
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- undr
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: slack-ruby-client
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Simple DSL for building Slack bots.
+email:
+- undr@yandex.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/walle.rb
+- lib/walle/controller.rb
+- lib/walle/middlewares/builder.rb
+- lib/walle/middlewares/helper.rb
+- lib/walle/middlewares/logger.rb
+- lib/walle/robot.rb
+- lib/walle/robot/definitions.rb
+- lib/walle/robot/router.rb
+- lib/walle/robot/router/builder.rb
+- lib/walle/robot/router/route.rb
+- lib/walle/version.rb
+- walle.gemspec
+homepage: https://github.com/undr/walle
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Simple DSL for building Slack bots.
+test_files: []