slappy 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 26e15337ee96df3976f78672ee576f6eb247e475
-  data.tar.gz: 6fd8714fcf6a87aa094b11db890d511bb1aab457
+  metadata.gz: a38d4528b56aac0bc940bc257f66da45dc0d904f
+  data.tar.gz: a476d2ae9b9da850a08d5fdba7342d1ae019817d
 SHA512:
-  metadata.gz: f73b384121b7fa2d7f48a53e9e265ac5206ddee17184f659a546db34f7f710e13ac026444e9fbbd6a28c5d8101aca185391956bec7cf686a8ef6142560ca9b5a
-  data.tar.gz: 50b4a56ec88f0d5ab1158d14e57f451768ce4d1e4134bf4aa256238200e268f3aca15d4a37f600ffde2cef7f85fbffa52a5d3e4b413d470758897d47d3a0dddf
+  metadata.gz: 84194d504736578922db692aabf5649bbb395bc15a3dc4ea936405ffdf021ff67a9341f72064a783cf7707f84e1f6a5d5e7f1da5fc0e5ea338c6708f1b7f528f
+  data.tar.gz: 1915ef726371fa9e4bda4e8642b430054e955f60809c4e3fc7790e9c4c95510e4546c11a02342e83d923e9168cddfc5a6a9bb5619028f269e92cdfd5ef42b131

data/.hound.yml

@@ -5,6 +5,7 @@ AllCops:
     - "Guardfile"
     - "slappy.gemspec"
   DisplayCopNames: true
+  RunRailsCops: false
 
 ##################### Style ##################################
 

data/.travis.yml

@@ -1,17 +1,20 @@
 language: ruby
 rvm:
-  - 2.0
-  - 2.1
-  - 2.2
-  - ruby-head
+- 2.0
+- 2.1
+- 2.2
+- ruby-head
 before_install: gem install bundler -v "~> 1.10"
-bundler_args: --jobs=2
+bundler_args: "--jobs=2"
 cache: bundler
 before_script:
-  - export CODECLIMATE_REPO_TOKEN=46e09f028aadd0d0f7e8aa4d917dc6f053c0a3d9ab0f82aab41f0918acc0384a
+- export CODECLIMATE_REPO_TOKEN=46e09f028aadd0d0f7e8aa4d917dc6f053c0a3d9ab0f82aab41f0918acc0384a
 script:
-  - ruby --version
-  - bundle exec rspec
+- ruby --version
+- bundle exec rspec
 branches:
   only:
-    - master
+  - master
+notifications:
+  slack:
+    secure: T6QhA+PdJTpGYjOk6d9uwt/p02OLcfieVUuNOY2po6KUsw9erMXCCuCGn1TXrRwFfnSVbuA7L3zjECMvaeDlsUURLVaZZduYHCpn6VXFfKlqzFxWr51Pk1qyE1feZCDPNNkr6PbgtFPHNWzZ/NUMrG0Z8Lo91PAr/RDolAa44MvLGq1ZDfAunITBRvGz8DhAu1Uf3EMPOqKtkN8NdEHp8pkns0XhmcqNLXwohdqXJY9R/TQ1gGJBc1hx3wZAqYCy0Eda44VBuzCg72QPUVQ3seGOts+2rgksNjnNLedB4F7bL7YZUjsam5OXKppnWt5HyE5bqkG1xrh6RguGVULBUTLRG5rY+FFtgJqgg2Qp4Ttu49Iyzh2DYhYleY6lsh1B/hsxzIjP+ojD4OXFKnb93IWxRvLrvPZGT2Q9V7zTo04Xa4cl7Zz33aPk59mZ/9ZmOlUCBtUFmYMslghOyIBSdqJHvHgXiVtheu231MuWdK7jg2U/aGnPKVh0jah9aEqNBmSmDbW2xfYEA+WINJmIKEktpQLyj8S3ajsdvZUuFcKdvZ0SEPoYuJGfaxiCKvPydm5yJFstlIYmgDlpFJh7Jh+LJy1trAvWGPcQMXs1MrZsc+c/UFs7zfrr/Uh74IxfdkIztNT2ZANYQ6zfXN2ZCT2ax9iE63gSgcCRGnEJ/R0=

data/Guardfile

@@ -26,7 +26,8 @@
 
 guard :rspec, cmd: 'bundle exec rspec'  do
   watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)/(.+)\.rb$})     { |m| "spec/#{m[1]}/#{m[2]}_spec.rb" }
+  watch(%r{^lib/(.+)/(.+)\.rb$}) { |m| "spec/#{m[1]}/#{m[2]}_spec.rb" }
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { 'spec' }
 end
 

data/README.md

@@ -6,8 +6,35 @@
 [![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)
 
-This gem support to make slack bot with hubot like interface.
-Use the Slack Realtime API(see the [official-documentation](https://api.slack.com/rtm)).
+This gem support to make slack bot, inspire from [hubot](https://github.com/github/hubot) and [sinatra](https://github.com/sinatra/sinatra).
+
+Use the Slack Realtime API and Web API(see the [official-documentation](https://api.slack.com)).
+
+## Quick Start
+
+### 1. Generate Slack API Token
+
+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.
+
+(If you want to setting in code, we offer way to you).
+
+### 3. Written Code
+
+```ruby
+require 'slappy'
+require 'slappy/dsl'
+
+# catch pattern
+hear '^hello, slappy!' do |event|
+  say 'hello!!', channel: event.channel #=> respond message to channel
+end
+
+start
+```
 
 ## Installation
 
@@ -33,8 +60,6 @@ Store configuration value in environment variables. They are easy to change betw
 SLACK_TOKEN - required (when not configured)
 ```
 
-Slack API Token generated in [this page](https://api.slack.com/web).
-
 ### Configure
 Configure default settings.
 There configrations effect on send message to slack when use `say` method and should override when option given.
@@ -64,7 +89,8 @@ channel    - default: '#general'
 icon_url   - default: nil
 ```
 
-### Example Code
+### Example
+#### Basic
 
 ```ruby
 require 'slappy'
@@ -75,45 +101,45 @@ Slappy.hello do
 end
 
 # called when match message
-Slappy.hear(/foo/) do
+Slappy.hear 'foo' do
   puts 'foo'
 end
 
-# called when match message with pattern match
-Slappy.hear(/bar (.*)/) do |event|
+# use regexp in string literal
+Slappy.hear 'bar (.*)' do |event|
   puts event.matches[1] #=> Event#matches return MatchData object
 end
 
-# event object is slack event JSON (convert to [hashie](https://github.com/intridea/hashie))
-Slappy.hear(/bar (.*)/) do |event|
+# event object is slack event JSON (convert to Hashie::Mash)
+Slappy.hear '^bar (.*)' do |event|
   puts event.channel #=> channel id
   Slappy.say 'slappy!', channel: event.channel #=> to received message channel
   Slappy.say 'slappy!', channel: '#general'
   Slappy.say 'slappy!', username: 'slappy!', icon_emoji: ':slappy:'
 end
 
+# use regexp literal
+Slappy.hear /^foobar/ do
+  puts 'slappppy!'
+end
+
 Slappy.start
 ```
 
-## How to run tests
-
-Please create a file named .env on the root of this repository. You can use .env.example file as a template
-
-```
-cp .env.example .env
-```
+#### Use Slappy DSL
 
-and edit `.env` file properly.
+Please require `'slappy/dsl'`, if you want short code
 
-```
-SLACK_TOKEN=abcd-1234567890-1234567890-1234567890
-```
+```ruby
+require 'slappy'
+require 'slappy/dsl'
 
-Then run tests.
+# Omit 'Slappy' keyward, when delegator required
+hear 'foo' do
+  say 'slappy!'
+end
 
-```
-bundle install
-bundle exec rspec
+start
 ```
 
 ## Feature
@@ -123,11 +149,11 @@ bundle exec rspec
 - [ ] Generate template settings
 - [ ] CLI commands
 - [ ] Add bot name
-- [ ] client#respond (hubot#respond)
+- [ ] client#respond (hubot#respond like)
 
 ## Contributing
 
-1. Fork it ( http://github.com/aki017/slack-ruby-gem/fork )
+1. Fork it ( http://github.com/yuemori/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/lib/slappy/client.rb

@@ -1,13 +1,10 @@
-require 'slack'
-require 'slappy/event'
-require 'slappy/listener'
-require 'slappy/configuration'
-
 module Slappy
   class Client
+    attr_reader :start_time
+
     def initialize
       Slack.configure { |slack| slack.token = config.token }
-      @listeners = {}
+      @callbacks = {}
     end
 
     def client
@@ -15,25 +12,22 @@ module Slappy
     end
 
     def start
-      @listeners.each do |key, array|
-        client.on key do |data|
-          array.each do |listener|
-            event = Event.new(data, listener.pattern) if key == :message
-            listener.call(event)
-          end
-        end
+      @start_time = Time.now
+      @callbacks.each do |event_name, listeners|
+        register_event event_name, listeners
       end
+      set_signal_trap
       client.start
     end
 
     def hello(&block)
-      @listeners[:hello] ||= []
-      @listeners[:hello].push block
+      @callbacks[:hello] ||= []
+      @callbacks[:hello].push block
     end
 
-    def hear(regexp, &block)
-      @listeners[:message] ||= []
-      @listeners[:message].push Listener.new(regexp, block)
+    def hear(pattern, &block)
+      @callbacks[:message] ||= []
+      @callbacks[:message].push Listener.new(pattern, block)
     end
 
     def say(text, options = {})
@@ -44,6 +38,28 @@ module Slappy
 
     private
 
+    def set_signal_trap
+      [:TERM, :INT].each do |signal|
+        Signal.trap(signal) do
+          EventMachine.stop
+        end
+      end
+    end
+
+    def register_event(event_name, listeners)
+      client.on event_name do |data|
+        listeners.each do |listener|
+          case event_name
+          when :hello
+            listener.call
+          when :message
+            event = Event.new(data, listener.pattern)
+            listener.call(event)
+          end
+        end
+      end
+    end
+
     def config
       Slappy.configuration
     end

data/lib/slappy/dsl.rb

@@ -0,0 +1,9 @@
+module Slappy
+  module DSL
+    extend Forwardable
+
+    def_delegators :Slappy, :hello, :hear, :say, :start
+  end
+end
+
+extend Slappy::DSL

data/lib/slappy/event.rb

@@ -1,6 +1,3 @@
-require 'hashie'
-require 'forwardable'
-
 module Slappy
   class Event
     extend Forwardable

data/lib/slappy/listener.rb

@@ -1,11 +1,13 @@
 module Slappy
   class Listener
-    def initialize(regexp, callback)
-      @regexp = regexp
+    def initialize(pattern, callback)
+      pattern = /#{pattern}/ if pattern.is_a? String
+      @regexp = pattern
       @callback = callback
     end
 
     def call(event)
+      return unless Time.at(event.ts.to_f) > Slappy.start_time
       return unless event.text.match @regexp
       @callback.call(event)
     end

data/lib/slappy/version.rb

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

data/lib/slappy.rb

@@ -1,6 +1,6 @@
-require 'slappy/client'
-require 'slappy/configuration'
-require 'slappy/version'
+require 'forwardable'
+require 'hashie'
+require 'slack'
 
 module Slappy
   class << self
@@ -18,10 +18,6 @@ module Slappy
       @configuration || configure
     end
 
-    def client
-      @client ||= Client.new
-    end
-
     def method_missing(method, *args, &block)
       return super unless client.respond_to?(method)
       client.send(method, *args, &block)
@@ -30,5 +26,17 @@ module Slappy
     def respond_to?(method)
       client.respond_to?(method) || super
     end
+
+    private
+
+    def client
+      @client ||= Client.new
+    end
   end
 end
+
+require 'slappy/client'
+require 'slappy/configuration'
+require 'slappy/event'
+require 'slappy/listener'
+require 'slappy/version'

data/slappy.gemspec

@@ -10,13 +10,12 @@ Gem::Specification.new do |spec|
   spec.email         = ["yuemori@aiming-inc.com"]
 
   spec.summary       = %q{Simple Slack Bot Framework}
-  spec.description   = %q{Simple Slack Bot Framework. Use Slack RealTime API}
+  spec.description   = %q{Simple Slack Bot Framework. Use Slack RealTime API and Web API.}
   spec.homepage      = "https://github.com/yuemori/slappy"
   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.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   spec.add_dependency 'slack-api'
@@ -28,6 +27,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "guard-rspec"
   spec.add_development_dependency "rubocop"
   spec.add_development_dependency "guard-rubocop"
-  spec.add_development_dependency "dotenv"
   spec.add_development_dependency "codeclimate-test-reporter"
+  spec.add_development_dependency "timecop"
+  spec.add_development_dependency "activesupport"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slappy
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - yuemori
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2015-11-07 00:00:00.000000000 Z
+date: 2015-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slack-api
@@ -137,7 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: dotenv
+  name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -151,7 +151,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: timecop
+  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: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -164,7 +178,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Simple Slack Bot Framework. Use Slack RealTime API
+description: Simple Slack Bot Framework. Use Slack RealTime API and Web API.
 email:
 - yuemori@aiming-inc.com
 executables: []
@@ -183,11 +197,10 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - lib/slappy.rb
 - lib/slappy/client.rb
 - lib/slappy/configuration.rb
+- lib/slappy/dsl.rb
 - lib/slappy/event.rb
 - lib/slappy/listener.rb
 - lib/slappy/version.rb

data/bin/console

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

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