ruboty-router 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 568959b2fc8f93452bfbe41416c1a38ed06dea0e
+  data.tar.gz: f33215897514a21b4e27a6a60d2eb4054957ebae
+SHA512:
+  metadata.gz: 78a71269d6f4554ff72233d7c84adafaea3dc6fbab9a6195767bb619294611a0391c3c42fcf05e81a2c167d1cb62ab2717059e44f4243638b311536f51b1cce8
+  data.tar.gz: 750c364db78c2a3f6b9474ccff6341d609bdb22d2a44e2b5f0f358e58f67cae720e5e641ec3bed4e04dc95300dbf679e1904c9fa3491a48b47cbfb8c343a70c8

data/.gitignore

@@ -0,0 +1,51 @@
+### https://raw.github.com/github/gitignore/68ae2ff9f7ce0176696966539b9807525002893b/Rails.gitignore
+
+*.rbc
+capybara-*.html
+.rspec
+/log
+/tmp
+/db/*.sqlite3
+/db/*.sqlite3-journal
+/public/system
+/coverage/
+/spec/tmp
+*.orig
+rerun.txt
+pickle-email-*.html
+
+# TODO Comment out this rule if you are OK with secrets being uploaded to the repo
+config/initializers/secret_token.rb
+
+# Only include if you have production secrets in this file, which is no longer a Rails default
+# config/secrets.yml
+
+# dotenv
+# TODO Comment out this rule if environment variables can be committed
+.env
+
+## Environment normalization:
+/.bundle
+/vendor/bundle
+
+# these should all be checked in to normalize the environment:
+# Gemfile.lock, .ruby-version, .ruby-gemset
+Gemfile.lock
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# if using bower-rails ignore default bower_components path bower.json files
+/vendor/assets/bower_components
+*.bowerrc
+bower.json
+
+# Ignore pow environment settings
+.powenv
+
+# Ignore Byebug command history file.
+.byebug_history
+
+# Ignore node_modules
+node_modules/
+

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ruboty-router.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 zeero
+
+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,66 @@
+[![Build Status](https://travis-ci.org/zeero/ruboty-url.svg?branch=master)](https://travis-ci.org/zeero/ruboty-url)
+[![Gem Version](https://badge.fury.io/rb/ruboty-url.svg)](https://badge.fury.io/rb/ruboty-url)
+[![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](LICENSE.txt)
+
+# Ruboty::Ruboty::Router
+
+A Ruboty Handler + Actions to enable routing function to Ruboty.
+
+[Ruboty](https://github.com/r7kamura/ruboty) is Chat bot framework. Ruby + Bot = Ruboty
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruboty-router'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Sample definition is below:
+
+```ruby
+module Ruboty
+  module Routers
+    class Sample < Base
+      route('/sample', name: 'sample', description: 'sample router.')
+      route('/sample/child', name: 'child', description: 'sample router.')
+
+      def sample(req, res)
+        res.write 'This is sample.'
+        robot.say(body: 'something to say', to: '#general')
+      end
+
+      def child(req, res)
+        res.write 'This is sample for multiple definition.'
+        robot.say(body: 'something to say for /sample/child', to: '#general')
+      end
+    end
+  end
+end
+```
+
+* `route(<path>, name: <method_name>, description: <description>)` add routing
+* `def sample(req, res)`
+  * Routing method definition
+  * Method receive [Rack::Request](http://www.rubydoc.info/gems/rack/Rack/Request) and [Rack::Response](http://www.rubydoc.info/gems/rack/Rack/Response)
+
+## ENV
+
+|Name|Description|
+|:--|:--|
+|RUBOTY_ROUTER_PORT|HTTP listen port|
+
+## Contributing
+
+1. Fork it ( https://github.com/zeero/ruboty-router/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ruboty/router"
+
+# 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(__FILE__)

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/robot.patch.rb

@@ -0,0 +1,17 @@
+module Ruboty
+  class Robot
+    alias original_adapt adapt
+
+    private
+
+    def adapt
+      server
+      original_adapt
+    end
+
+    def server
+      Ruboty::Router::Server.start(self)
+    end
+  end
+end
+

data/lib/ruboty/router.rb

@@ -0,0 +1,25 @@
+require 'active_support'
+require 'active_support/core_ext'
+require 'mem'
+require 'rack'
+require 'webrick'
+
+module Ruboty
+  module Router
+    RUBOTY_ROUTER_PORT = ENV['RUBOTY_ROUTER_PORT'] || 9292
+
+    class << self
+      include Mem
+
+      def routers
+        []
+      end
+      memoize :routers
+    end
+  end
+end
+
+require_relative 'robot.patch'
+Dir[File.expand_path('router', __dir__) << '/**/*.rb'].each { |file| require file }
+Dir[File.expand_path('routers', __dir__) << '/**/*.rb'].each { |file| require file }
+

data/lib/ruboty/router/action.rb

@@ -0,0 +1,26 @@
+module Ruboty
+  module Router
+    class Action
+      attr_reader :options, :path
+
+      def initialize(path, options = {})
+        @path = path
+        @options = options
+      end
+
+      def call(router, _options = {})
+        proc = lambda do |env|
+          req = Rack::Request.new(env)
+          res = Rack::Response.new
+          router.send(name, req, res)
+          res.to_a
+        end
+        { path => proc }
+      end
+
+      def name
+        options[:name]
+      end
+    end
+  end
+end

data/lib/ruboty/router/server.rb

@@ -0,0 +1,22 @@
+module Ruboty
+  module Router
+    class Server
+      class << self
+        def app(robot)
+          routes = Ruboty::Router.routers.inject({}) { |result, router| result.merge!(router.new(robot).call) }
+          Rack::URLMap.new(routes)
+        end
+
+        def start(robot)
+          Thread.new do
+            Rack::Server.start(
+              app: app(robot),
+              Port: Ruboty::Router::RUBOTY_ROUTER_PORT,
+            )
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/ruboty/router/version.rb

@@ -0,0 +1,5 @@
+module Ruboty
+  module Router
+    VERSION = '0.1.0'.freeze
+  end
+end

data/lib/ruboty/routers/base.rb

@@ -0,0 +1,37 @@
+module Ruboty
+  module Routers
+    class Base
+      class << self
+        include Mem
+
+        def inherited(child)
+          Ruboty::Router.routers << child
+        end
+
+        def route(path, options = {})
+          actions << Router::Action.new(path, options)
+        end
+
+        def actions
+          []
+        end
+        memoize :actions
+      end
+
+      include Env::Validatable
+
+      attr_reader :robot
+
+      def initialize(robot)
+        @robot = robot
+        validate!
+      end
+
+      def call(options = {})
+        self.class.actions.inject({}) do |routes, action|
+          routes.merge!(action.call(self, options))
+        end
+      end
+    end
+  end
+end

data/lib/ruboty/routers/root.rb

@@ -0,0 +1,15 @@
+module Ruboty
+  module Routers
+    class Root < Base
+      route('/', name: 'root', description: 'Routing for /')
+
+      def root(req, res)
+        # server response
+        res.write 'Ruboty::Router works!'
+
+        # example for reaction in chat
+        # robot.say(body: 'something to say', to: '#general')
+      end
+    end
+  end
+end

data/ruboty-router.gemspec

@@ -0,0 +1,34 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ruboty/router/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ruboty-router'
+  spec.version       = Ruboty::Router::VERSION
+  spec.authors       = ['zeero']
+  spec.email         = ['zeero26@gmail.com']
+  spec.summary       = 'Routing with Ruboty.'
+  spec.description   = 'Enable Routing function to Ruboty.'
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'mem'
+  spec.add_runtime_dependency 'rack'
+  spec.add_runtime_dependency 'ruboty'
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'minitest-reporters'
+  spec.add_development_dependency 'mocha'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'pry-theme'
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/test/ruboty/router_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class Ruboty::RouterTest < Minitest::Test
+  def test_that_it_has_a_version_number
+    refute_nil ::Ruboty::Router::VERSION
+  end
+end

data/test/ruboty/routers/root_test.rb

@@ -0,0 +1,23 @@
+require 'test_helper'
+
+describe Ruboty::Routers::Root do
+  include Rack::Test::Methods
+
+  let(:robot) { mock.tap { |mock| mock.expects(:say).never } }
+
+  before do
+  end
+
+  def app
+    Ruboty::Router::Server.app(robot)
+  end
+
+  describe 'root' do
+    it 'should return 200' do
+      get '/'
+      last_response.must_be :ok?
+      last_response.body.must_equal 'Ruboty::Router works!'
+    end
+  end
+end
+

data/test/ruboty/routers/sample_test.rb

@@ -0,0 +1,37 @@
+require 'test_helper'
+
+describe Ruboty::Routers::Sample do
+  include Rack::Test::Methods
+
+  let(:robot) { Ruboty::Robot.new }
+
+  before do
+  end
+
+  def app
+    Ruboty::Router::Server.app(robot)
+  end
+
+  describe 'sample' do
+    it 'should return 200' do
+      get '/sample'
+      last_response.must_be :ok?
+      last_response.body.must_equal 'Sample!'
+    end
+
+    it 'should be able to chat' do
+      Ruboty::Adapters::Shell.any_instance.expects(:say).with(body: 'something to say').once
+      get '/sample'
+    end
+  end
+
+  describe 'child' do
+    it 'should be able to define multiple route' do
+      Ruboty::Adapters::Shell.any_instance.expects(:say).with(body: 'something to say for child').once
+      get '/sample/child'
+      last_response.must_be :ok?
+      last_response.body.must_equal 'Child!'
+    end
+  end
+end
+

data/test/test_helper.rb

@@ -0,0 +1,30 @@
+require 'minitest/autorun'
+require 'minitest/reporters'
+require 'mocha/minitest'
+require 'rack/test'
+
+require 'ruboty'
+
+require 'ruboty/router'
+
+Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new
+
+module Ruboty
+  module Routers
+    class Sample < Base
+      route('/sample', name: 'sample', description: 'sample router for unit test.')
+      route('/sample/child', name: 'child', description: 'sample router for unit test.')
+
+      def sample(_req, res)
+        res.write 'Sample!'
+        robot.say(body: 'something to say')
+      end
+
+      def child(_req, res)
+        res.write 'Child!'
+        robot.say(body: 'something to say for child')
+      end
+    end
+  end
+end
+

metadata

@@ -0,0 +1,266 @@
+--- !ruby/object:Gem::Specification
+name: ruboty-router
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- zeero
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: mem
+  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: rack
+  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: ruboty
+  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.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-theme
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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'
+description: Enable Routing function to Ruboty.
+email:
+- zeero26@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ruboty/robot.patch.rb
+- lib/ruboty/router.rb
+- lib/ruboty/router/action.rb
+- lib/ruboty/router/server.rb
+- lib/ruboty/router/version.rb
+- lib/ruboty/routers/base.rb
+- lib/ruboty/routers/root.rb
+- ruboty-router.gemspec
+- test/ruboty/router_test.rb
+- test/ruboty/routers/root_test.rb
+- test/ruboty/routers/sample_test.rb
+- test/test_helper.rb
+homepage: ''
+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: Routing with Ruboty.
+test_files:
+- test/ruboty/router_test.rb
+- test/ruboty/routers/root_test.rb
+- test/ruboty/routers/sample_test.rb
+- test/test_helper.rb