slappy 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a38d4528b56aac0bc940bc257f66da45dc0d904f
-  data.tar.gz: a476d2ae9b9da850a08d5fdba7342d1ae019817d
+  metadata.gz: 1f6569438c773c309cbc6946bb9b25dcb60dc59d
+  data.tar.gz: 31f3eeee45abc61e2ca093d9ae7fbab63e5e055a
 SHA512:
-  metadata.gz: 84194d504736578922db692aabf5649bbb395bc15a3dc4ea936405ffdf021ff67a9341f72064a783cf7707f84e1f6a5d5e7f1da5fc0e5ea338c6708f1b7f528f
-  data.tar.gz: 1915ef726371fa9e4bda4e8642b430054e955f60809c4e3fc7790e9c4c95510e4546c11a02342e83d923e9168cddfc5a6a9bb5619028f269e92cdfd5ef42b131
+  metadata.gz: 27ff356c54218c17816ab23e147c364dabfced2f567fe3e9cc91255ae60ede45582d2a19ab4fc848e4b7787e20eacd7ee13022181c9f173df07094178792dc5a
+  data.tar.gz: 609792027661024892179ce92f058c491fae2cb8bb6b05c57b06010ec0f047c79a8b7c9bc9ebe39cba8a17b9fb56ad62c833f4b6cb0f8c1b7ce0c83ef5752025

data/.travis.yml

@@ -8,7 +8,7 @@ before_install: gem install bundler -v "~> 1.10"
 bundler_args: "--jobs=2"
 cache: bundler
 before_script:
-- export CODECLIMATE_REPO_TOKEN=46e09f028aadd0d0f7e8aa4d917dc6f053c0a3d9ab0f82aab41f0918acc0384a
+- export CODECLIMATE_REPO_TOKEN=61e6275a25daf92ab6587d0606862139da60909212bef5f285b0ff14cbe69546
 script:
 - ruby --version
 - bundle exec rspec
@@ -17,4 +17,4 @@ branches:
   - master
 notifications:
   slack:
-    secure: T6QhA+PdJTpGYjOk6d9uwt/p02OLcfieVUuNOY2po6KUsw9erMXCCuCGn1TXrRwFfnSVbuA7L3zjECMvaeDlsUURLVaZZduYHCpn6VXFfKlqzFxWr51Pk1qyE1feZCDPNNkr6PbgtFPHNWzZ/NUMrG0Z8Lo91PAr/RDolAa44MvLGq1ZDfAunITBRvGz8DhAu1Uf3EMPOqKtkN8NdEHp8pkns0XhmcqNLXwohdqXJY9R/TQ1gGJBc1hx3wZAqYCy0Eda44VBuzCg72QPUVQ3seGOts+2rgksNjnNLedB4F7bL7YZUjsam5OXKppnWt5HyE5bqkG1xrh6RguGVULBUTLRG5rY+FFtgJqgg2Qp4Ttu49Iyzh2DYhYleY6lsh1B/hsxzIjP+ojD4OXFKnb93IWxRvLrvPZGT2Q9V7zTo04Xa4cl7Zz33aPk59mZ/9ZmOlUCBtUFmYMslghOyIBSdqJHvHgXiVtheu231MuWdK7jg2U/aGnPKVh0jah9aEqNBmSmDbW2xfYEA+WINJmIKEktpQLyj8S3ajsdvZUuFcKdvZ0SEPoYuJGfaxiCKvPydm5yJFstlIYmgDlpFJh7Jh+LJy1trAvWGPcQMXs1MrZsc+c/UFs7zfrr/Uh74IxfdkIztNT2ZANYQ6zfXN2ZCT2ax9iE63gSgcCRGnEJ/R0=
+    secure: ocTnQAT5/a3gu93ZZ0vinihMT6/NG3fp4pV2li9WSJRuImFwSTI2eAmjlOZbk/SaZIdj2alGIB2HqMH6sHFheCiUSuAzf+8aaGvBwFh//x+2uibXccoyZLIUoDb5OMHCZSilkQgx8MtsGsPCr+7ryvclxIL+3YJz2NjTpwPPoLsXUNXXzaJtYHknb62BCGGTC5wz8J5JOVKloDXVz4F2CMZqX2ylM/DxFTl5LI94kT/7pv7KfelCHsm6R0F4ALaJT0zumx+t/QAlezzlvRqu81L76yPlEgdahydY77yd7xVqUOEhvNEEiriHMR/+4xYMEieVvERlDLsk4kvywX6YbGId/5tDaQvRIkHIN/9XeKnt/DyMbBVugC0MtZGbNREtD2a9u85V0Zzv/ufBva3FHtbWsHXBtETrb3ty9yrplDkqg/H9vOfISfnSYxOk8F56DMj0h6QSaocCk/9hk31C2I66ZvmmJC5LkSNN77KFT0u32nSFAi5Maj3FhGGW2eXg/jWqBjjyYqUQtjeQguqhtPna5QSpmY17a6l7LAujoQ/romkiEIW+Qwd2tPv53DVe5q1fWNTSrr5LVhkKjkATAWlKLv8oJOj86/EcaoNCZFS7mufq16hDMW9UJbEsuqguRCZKR49FC/U80NWwx+jrkzHY41Meh6yeYd5JQyODb9E=

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 yuemori
+Copyright (c) 2015 wakaba260
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,10 +1,10 @@
 # Slappy
 
 [![Gem Version](https://badge.fury.io/rb/slappy.svg)](https://badge.fury.io/rb/slappy)
-[![Build Status](https://travis-ci.org/yuemori/slappy.svg?branch=master)](https://travis-ci.org/yuemori/slappy)
-[![Code Climate](https://codeclimate.com/repos/563cbaad1787d72930000582/badges/9753daa4ecd1a303b6ae/gpa.svg)](https://codeclimate.com/repos/563cbaad1787d72930000582/feed)
-[![Test Coverage](https://codeclimate.com/repos/563cbaad1787d72930000582/badges/9753daa4ecd1a303b6ae/coverage.svg)](https://codeclimate.com/repos/563cbaad1787d72930000582/coverage)
-[![Dependency Status](https://gemnasium.com/yuemori/slappy.svg)](https://gemnasium.com/yuemori/slappy)
+[![Build Status](https://travis-ci.org/wakaba260/slappy.svg?branch=master)](https://travis-ci.org/wakaba260/slappy)
+[![Code Climate](https://codeclimate.com/github/wakaba260/slappy/badges/gpa.svg)](https://codeclimate.com/github/wakaba260/slappy)
+[![Test Coverage](https://codeclimate.com/github/wakaba260/slappy/badges/coverage.svg)](https://codeclimate.com/github/wakaba260/slappy/coverage)
+[![Dependency Status](https://gemnasium.com/wakaba260/slappy.svg)](https://gemnasium.com/wakaba260/slappy)
 
 This gem support to make slack bot, inspire from [hubot](https://github.com/github/hubot) and [sinatra](https://github.com/sinatra/sinatra).
 
@@ -18,24 +18,45 @@ Slack API Token generate from [official page](https://api.slack.com/web).
 
 ### 2. Set environment variable to Slack API Token
 
-Slappy references `ENV['SLACK_TOKEN']` when use token.
+Slappy references `ENV['SLACK_TOKEN']` default.
 
-(If you want to setting in code, we offer way to you).
+### 3. Run generator
 
-### 3. Written Code
+Execute then command to generate project:
 
-```ruby
-require 'slappy'
-require 'slappy/dsl'
 
+    $ slappy new project-name
+
+
+If you want to use current directory, execute then command:
+
+    $ slappy new
+
+(If you use bundler, add `bundle exec` prefix)
+
+### 4. Write code
+
+Create ruby file to under `project-name/slappy-scripts`, and written code.
+
+Example:
+
+```ruby
 # catch pattern
 hear '^hello, slappy!' do |event|
   say 'hello!!', channel: event.channel #=> respond message to channel
 end
-
-start
 ```
 
+There scripts not share scopes with other scripts.
+
+### 5. Slappy start
+
+Execute then command in project root directory.
+
+    $ slappy start
+
+(Stop: Input Ctrl+c)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -70,9 +91,10 @@ There configrations effect on send message to slack when use `say` method and sh
 require 'slappy'
 
 Slappy.configure do |config|
-  config.username   = 'slappy'
-  config.channel    = '#general'
-  config.icon_emoji = ':slappy:'
+  config.token = 'foobar'
+  config.robot.username   = 'slappy'
+  config.robot.channel    = '#general'
+  config.robot.icon_emoji = ':slappy:'
 end
 
 Slappy.say 'hello!' #=> username: slappy, channel: '#general', icon_emoji: ':slappy:'
@@ -81,16 +103,19 @@ Slappy.say 'hello!' #=> username: slappy, channel: '#general', icon_emoji: ':sla
 #### Configuration Parameters
 
 ```
-token      - default: ENV['SLACK_TOKEN']
-botname    - not effect now
-username   - default: 'slappy'
-icon_emoji - default: nil
-channel    - default: '#general'
-icon_url   - default: nil
+token            - default: ENV['SLACK_TOKEN']
+scripts_dir_path - default : 'slappy-scripts'
+
+robot.botname    - not effect now
+robot.username   - default: 'slappy'
+robot.icon_emoji - default: nil
+robot.channel    - default: '#general'
+robot.icon_url   - default: nil
 ```
 
-### Example
-#### Basic
+### Basic Usage
+
+If you not want execute `slappy start` command, written by (require `'slappy/dsl'` use DSL):
 
 ```ruby
 require 'slappy'
@@ -123,37 +148,21 @@ Slappy.hear /^foobar/ do
   puts 'slappppy!'
 end
 
-Slappy.start
-```
-
-#### Use Slappy DSL
-
-Please require `'slappy/dsl'`, if you want short code
-
-```ruby
-require 'slappy'
-require 'slappy/dsl'
-
-# Omit 'Slappy' keyward, when delegator required
-hear 'foo' do
-  say 'slappy!'
-end
-
-start
+Slappy.start #=> Start slappy process
 ```
 
 ## Feature
 
+- [ ] Execute in shell (because testable).
 - [ ] Support private channel
 - [ ] Support Schedule event (cron like)
-- [ ] Generate template settings
-- [ ] CLI commands
 - [ ] Add bot name
 - [ ] client#respond (hubot#respond like)
+- [ ] Split chat adapter
 
 ## Contributing
 
-1. Fork it ( http://github.com/yuemori/slappy/fork )
+1. Fork it ( http://github.com/wakaba260/slappy/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`)

data/bin/slappy

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'slappy'
+
+Slappy::CLI.start(ARGV)

data/lib/slappy/cli.rb

@@ -0,0 +1,19 @@
+module Slappy
+  class CLI < Thor
+    desc 'start', 'slappy start'
+    def start
+      build_command(:run).call
+    end
+
+    desc 'new [DIR_NAME]', 'create new slappy project'
+    def new(dir_name = nil)
+      build_command(:generator).call(dir_name)
+    end
+
+    private
+
+    def build_command(command_name)
+      "Slappy::Commands::#{command_name.to_s.camelize}".constantize.new
+    end
+  end
+end

data/lib/slappy/commands/generator.rb

@@ -0,0 +1,74 @@
+module Slappy
+  module Commands
+    class Generator
+      def call(dir_name)
+        dir_name = './' if dir_name.nil?
+        dir_name += '/' if !dir_name.nil? && dir_name.split('').last != '/'
+        @target_dir = dir_name
+
+        mkdir target_dir unless @target_dir.nil?
+        mkdir scripts_dir_path
+
+        copy template_script_path, scripts_dir_path
+        copy config_file_path,     target_dir
+      end
+
+      private
+
+      def target_dir
+        File.expand_path @target_dir, Dir.pwd
+      end
+
+      def gem_root_dir
+        File.expand_path '../../../../', __FILE__
+      end
+
+      def template_dir
+        File.expand_path 'templates', gem_root_dir
+      end
+
+      def scripts_dir_path
+        File.expand_path Slappy.configuration.scripts_dir_path, target_dir
+      end
+
+      def config_file_path
+        File.expand_path Slappy.configuration.config_file_path, template_dir
+      end
+
+      def template_script_path
+        File.expand_path 'example.rb', template_dir
+      end
+
+      def mkdir(path)
+        generate(path) { FileUtils.mkdir path }
+      end
+
+      def copy(src, dest)
+        path = File.expand_path File.basename(src), dest
+        generate(path) { FileUtils.cp src, dest }
+      end
+
+      def status
+        @messages = {
+          create: TermColor.parse('<green>create</green>'),
+          exist: TermColor.parse('<red>exist</red>')
+        }
+      end
+
+      def generate(target, &block)
+        if FileTest.exist? target
+          result = status[:exist]
+        else
+          block.call
+          result = status[:create]
+        end
+
+        put_result result, Pathname.new(target).relative_path_from(Pathname.new(Dir.pwd))
+      end
+
+      def put_result(result, target)
+        puts "\t#{result}\t#{target}"
+      end
+    end
+  end
+end

data/lib/slappy/commands/run.rb

@@ -0,0 +1,41 @@
+module Slappy
+  module Commands
+    class Run
+      class InvalidPathError < StandardError; end
+
+      def call
+        load_config
+        load_scripts
+        Slappy.start
+      rescue InvalidPathError => e
+        puts TermColor.parse "<red>Error:</red> #{e.message}"
+      end
+
+      private
+
+      def load_config
+        file = File.expand_path Slappy.configuration.config_file_path, Dir.pwd
+        begin
+          require file
+        rescue LoadError
+          raise InvalidPathError.new, "file #{file} not found"
+        end
+      end
+
+      def load_scripts
+        script_dir = Slappy.configuration.scripts_dir_path
+
+        unless FileTest.directory? script_dir
+          message = "directory #{script_dir} not found"
+          fail InvalidPathError.new, message
+        end
+
+        script_dir = "./#{script_dir}" unless script_dir.match(%r{"./"})
+        Dir.glob("#{script_dir}/**/*.rb").each do |file|
+          block = proc { require file }
+          block.call
+        end
+      end
+    end
+  end
+end

data/lib/slappy/configuration/robot.rb

@@ -0,0 +1,15 @@
+module Slappy
+  class Configuration
+    class Robot
+      attr_accessor :botname, :username, :channel, :icon_emoji, :icon_url
+
+      def botname
+        @botname || username
+      end
+
+      def username
+        @username || 'slappy'
+      end
+    end
+  end
+end

data/lib/slappy/configuration.rb

@@ -1,21 +1,30 @@
 module Slappy
   class Configuration
-    attr_accessor :username, :botname, :token, :icon_emoji, :channel, :icon_url
+    attr_accessor :robot, :token, :scripts_dir_path
 
-    def botname
-      @botname || username
+    def initialize
+      @robot = Robot.new
     end
 
     def token
       @token || ENV['SLACK_TOKEN']
     end
 
-    def username
-      @username || 'slappy'
+    def config_file_path
+      './slappy_config.rb'
+    end
+
+    def scripts_dir_path
+      @scripts_dir_path || './slappy-scripts'
     end
 
     def send_params
-      { username: username, icon_emoji: icon_emoji, channel: channel, icon_url: icon_url }
+      {
+        username: robot.username,
+        icon_emoji: robot.icon_emoji,
+        channel: robot.channel,
+        icon_url: robot.icon_url
+      }
     end
   end
 end

data/lib/slappy/version.rb

@@ -1,3 +1,3 @@
 module Slappy
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

data/lib/slappy.rb

@@ -1,6 +1,9 @@
 require 'forwardable'
+require 'active_support/core_ext/string/inflections'
 require 'hashie'
 require 'slack'
+require 'termcolor'
+require 'thor'
 
 module Slappy
   class << self
@@ -35,8 +38,12 @@ module Slappy
   end
 end
 
+require 'slappy/cli'
 require 'slappy/client'
 require 'slappy/configuration'
+require 'slappy/configuration/robot'
+require 'slappy/commands/generator.rb'
+require 'slappy/commands/run.rb'
 require 'slappy/event'
 require 'slappy/listener'
 require 'slappy/version'

data/slappy.gemspec

@@ -6,12 +6,12 @@ require 'slappy/version'
 Gem::Specification.new do |spec|
   spec.name          = "slappy"
   spec.version       = Slappy::VERSION
-  spec.authors       = ["yuemori"]
-  spec.email         = ["yuemori@aiming-inc.com"]
+  spec.authors       = ["wakaba260"]
+  spec.email         = ["wakaba260@aiming-inc.com"]
 
   spec.summary       = %q{Simple Slack Bot Framework}
   spec.description   = %q{Simple Slack Bot Framework. Use Slack RealTime API and Web API.}
-  spec.homepage      = "https://github.com/yuemori/slappy"
+  spec.homepage      = "https://github.com/wakaba260/slappy"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
@@ -20,6 +20,9 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'slack-api'
   spec.add_dependency 'hashie'
+  spec.add_dependency 'thor'
+  spec.add_dependency "activesupport"
+  spec.add_dependency "termcolor"
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
@@ -29,5 +32,4 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "guard-rubocop"
   spec.add_development_dependency "codeclimate-test-reporter"
   spec.add_development_dependency "timecop"
-  spec.add_development_dependency "activesupport"
 end

data/templates/example.rb

@@ -0,0 +1,33 @@
+# Slappy Examples
+#
+# # called when start up
+# hello do
+#   puts 'successfly connected'
+# end
+#
+#
+# # called when match message
+# hear 'foo' do
+#   puts 'foo'
+# end
+#
+#
+# # use regexp in string literal
+# hear 'bar (.*)' do |event|
+#   puts event.matches[1] #=> Event#matches return MatchData object
+# end
+#
+#
+# # event object is slack event JSON (convert to Hashie::Mash)
+# hear '^bar (.*)' do |event|
+#   puts event.channel #=> channel id
+#   say 'slappy!', channel: event.channel #=> to received message channel
+#   say 'slappy!', channel: '#general'
+#   say 'slappy!', username: 'slappy!', icon_emoji: ':slappy:'
+# end
+#
+#
+# # use regexp literal
+# hear /^foobar/ do
+#   say 'slappppy!'
+# end

data/templates/slappy_config.rb

@@ -0,0 +1,40 @@
+require 'slappy/dsl'
+
+Slappy.configure do |config|
+  ## Slappy Settings
+  #
+  # token:
+  #   Slack API Token
+  config.token = ENV['SLACK_TOKEN']
+
+  # scripts_path_dir:
+  #   Slappy scripts directory.
+  #   Slappy load scripts in this directory.
+  config.scripts_dir_path = 'slappy-scripts'
+
+  ## Default parameters
+  #
+  # There parameters use in say method when send to Slack.
+  # Settings specified here will take precedence over those in method option
+  # And other parameters give to method option if you want.
+  #
+  #   Official API document:
+  #     https://api.slack.com/methods/chat.postMessage
+
+  # username:
+  #   Name of bot.
+  config.robot.username = 'slappy'
+
+  # channel:
+  #   Channel, private group, or IM channel to send message to.
+  #   Can be an encoded ID, or a name. See below for more details.
+  config.robot.channel = nil
+
+  # icon_emoji:
+  #   emoji to use as the icon for this message. Overrides icon_url.
+  config.robot.icon_emoji = nil
+
+  # icon_url:
+  #    URL to an image to use as the icon for this message
+  config.robot.icon_url = nil
+end

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification
 name: slappy
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
-- yuemori
+- wakaba260
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -38,6 +38,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  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: 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: termcolor
+  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
@@ -164,24 +206,11 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  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'
 description: Simple Slack Bot Framework. Use Slack RealTime API and Web API.
 email:
-- yuemori@aiming-inc.com
-executables: []
+- wakaba260@aiming-inc.com
+executables:
+- slappy
 extensions: []
 extra_rdoc_files: []
 files:
@@ -197,15 +226,22 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/slappy
 - lib/slappy.rb
+- lib/slappy/cli.rb
 - lib/slappy/client.rb
+- lib/slappy/commands/generator.rb
+- lib/slappy/commands/run.rb
 - lib/slappy/configuration.rb
+- lib/slappy/configuration/robot.rb
 - lib/slappy/dsl.rb
 - lib/slappy/event.rb
 - lib/slappy/listener.rb
 - lib/slappy/version.rb
 - slappy.gemspec
-homepage: https://github.com/yuemori/slappy
+- templates/example.rb
+- templates/slappy_config.rb
+homepage: https://github.com/wakaba260/slappy
 licenses:
 - MIT
 metadata: {}
@@ -225,7 +261,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Simple Slack Bot Framework