slappy 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2cda9ebb75413427151ae533a04d020a9e9db638
-  data.tar.gz: 582468f8b8eb1760fceb92b3b26f6dd83aa07957
+  metadata.gz: f8af98612f787abf18da9970dae3c2774eb02617
+  data.tar.gz: b293a5cba0cc0c58fab718447b2d1646f1a73fa5
 SHA512:
-  metadata.gz: 85575d21f7b3e1c04d65f9a685e133eeb941e42e8bdffbe5637690be61c09f7e9995d0cc963f1c63a6db035ee3b55c2d7e98218f209f93432ae0575e1c9cd971
-  data.tar.gz: 526f35c3436c164a3df4846a7a3641a5107130b04d8c8f204191c666d9cca1e10de4d6837e9b0dad265bee7eb6a20ac20f458f9e1f3eec9060db13647e83455a
+  metadata.gz: 0838f8be93626934b4b8d8c0322ad19db775140536ae31764b0ba7f72e70938d2e26bf68130e488bed397beb4135e1249d8d32893bf16205bc9a0eeb4143f528
+  data.tar.gz: b95e4c625e0a4f32d35844885cfafd3533538396e64c7439169e3ce025d156d70f937019b89260529b835b99a5c4f2506ebddab22e456d13dbcd8f39bcb30337

data/README.md

@@ -151,7 +151,7 @@ hear(/^foobar/) do
 end
 ```
 
-#### Monitoring Subtypes Event
+#### Monitoring Types Event
 
 ```ruby
 monitor 'channel_joined' do |event|
@@ -169,7 +169,19 @@ end
 schedule '* * * * *' do
   logger.info 'Slappy alive...' #=> Repeat every minutes.
 end
+```
+
+#### Sleep Event
+
+There conditions, this event be called:
+
+- `raise StandardError` in script
+- trap SIGTERM or SIGINT
 
+```
+goodnight do
+  logger.info 'goodnight'
+end
 ```
 
 ### DSL Methods
@@ -178,8 +190,27 @@ end
 |:---:|:---|
 |hello|start up|
 |hear|message (match pattern)|
+|respond|message (match pattern and botname prefix given)|
 |monitor|[Slack RTM event](https://api.slack.com/rtm)|
 |schedule|specify time ([Syntax is here](https://github.com/r7kamura/chrono)) - Thanks to Chrono!|
+|goodinight|bot dead (StandardError, SIGTERM, and SIGINT received)|
+
+### Event Methods
+
+```
+hear 'slappy' do |event|
+  return if event.bot_message? #=> check message from webhook or integration
+  event.relpy 'slappy'         #=> relpy to event channel
+  event.reaction 'thumbsup'    #=> add reaction to event message
+end
+```
+
+|method|description|
+|:---:|:---|
+|bot_message?|check message from bot (webhook or integration is true)|
+|reply|reply message to event channel|
+|reaction|add reaction to event message|
+
 
 ### In your Application
 
@@ -199,6 +230,22 @@ Slappy.start #=> Start WebSocket connection
 
 ## Release Note
 
+- v0.6.0
+  - respond method
+    - respond event call when add message to botname prefix
+  - goodnight method
+    - goodnight event call when bod dead (StandardError, SIGTERM, and SIGINT received)
+  - New SlackAPI
+    - File
+    - Pin
+  - New Event methods
+    - bot_message? (contribute from [dnond](https://github.com/dnond))
+      - check message from bot(webhook, and integration)
+    - reaction
+      - reaction to event(add emoji reaction)
+    - reply
+      - relpy to event
+
 - v0.5.2
   - Add debug logging
   - Fix schedule id is not normality
@@ -238,15 +285,6 @@ Slappy.start #=> Start WebSocket connection
 - v0.1.0
   - Release
 
-## Feature
-
-- [ ] Execute in shell (because testable).
-- [ ] Support private channel
-- [ ] Support Schedule event (cron like)
-- [ ] Add bot name
-- [ ] client#respond (hubot#respond like)
-- [ ] Split chat adapter
-
 ## Contributing
 
 1. Fork it ( http://github.com/wakaba260/slappy/fork )

data/lib/slappy/client.rb

@@ -20,30 +20,42 @@ module Slappy
       end
       set_signal_trap
       Debug.log 'Slappy start'
-      client.start
+      begin
+        client.start
+      rescue StandardError => e
+        @callbacks[:goodnight].each(&:call) if @callbacks[:goodnight]
+        STDERR.puts e.backtrace.slice!(0) + ': ' + e.message
+        STDERR.puts "\tfrom " + e.backtrace.join("\n\tfrom ")
+        exit 1
+      end
     end
 
     def hello(&block)
-      @callbacks[:hello] ||= []
-      @callbacks[:hello].push block
-      Debug.log "Add hello event(#{@callbacks[:hello].size})"
+      register_callback(:hello, :hello, block)
     end
 
-    def hear(pattern, &block)
-      @callbacks[:message] ||= []
-      @callbacks[:message].push Listener::TextListener.new(pattern, block)
-      Debug.log "Add here event(#{@callbacks[:message].size}): #{pattern}"
+    def goodnight(&block)
+      register_callback(:goodnight, :goodnight, block)
     end
 
-    def monitor(type, &block)
-      @callbacks[type.to_sym] ||= []
-      @callbacks[type.to_sym].push Listener::TypeListener.new(type, block)
-      Debug.log "Add monitor event(#{@callbacks[type.to_sym].size}): #{type}"
+    def hear(pattern, options = {}, &block)
+      register_callback(:hear, :message, Listener::TextListener.new(pattern, options, &block))
+    end
+
+    def respond(pattern, options = {}, &block)
+      bot_name = options[:bot_name] || config.robot.botname || config.robot.username
+
+      pattern = "^#{bot_name}[[:blank:]]#{pattern}"
+      register_callback(:respond, :message, Listener::TextListener.new(pattern, options, &block))
+    end
+
+    def monitor(type, options = {}, &block)
+      register_callback(:monitor, type.to_sym, Listener::TypeListener.new(type, options, &block))
     end
 
     def say(text, options = {})
       options[:text] = text
-      Messanger.new(options).message
+      Messenger.new(options).message
     end
 
     def schedule(pattern, options = {}, &block)
@@ -54,9 +66,19 @@ module Slappy
 
     private
 
+    def register_callback(name, type, callback)
+      @callbacks[type] ||= []
+      @callbacks[type].push callback
+      Debug.log "Add #{name} event(#{@callbacks[type.to_sym].size}): #{type}"
+    end
+
     def set_signal_trap
       [:TERM, :INT].each do |signal|
         Signal.trap(signal) do
+          @callbacks[:goodnight].try(:each) do |callback|
+            th = Thread.new { callback.call }
+            th.join
+          end
           EventMachine.stop
         end
       end

data/lib/slappy/dsl.rb

@@ -2,7 +2,8 @@ module Slappy
   module DSL
     extend Forwardable
 
-    def_delegators :Slappy, :hello, :hear, :say, :start, :logger, :schedule, :monitor
+    def_delegators :Slappy, :hello, :hear, :say, :start, :logger,
+                   :schedule, :monitor, :goodnight, :respond
   end
 end
 

data/lib/slappy/event.rb

@@ -1,6 +1,7 @@
 module Slappy
   class Event
     extend Forwardable
+    include Debuggable
 
     attr_accessor :matches
 
@@ -27,5 +28,20 @@ module Slappy
     def ts
       Time.at(@data['ts'].to_f)
     end
+
+    def reply(text, options = {})
+      options[:text] = text
+      options[:channel] = channel
+      Messenger.new(options).message
+    end
+
+    def reaction(emoji)
+      result = ::Slack.reactions_add name: emoji, channel: @data['channel'], timestamp: @data['ts']
+      Debug.log "Reaction response: #{result}"
+    end
+
+    def bot_message?
+      @data['subtype'] && @data['subtype'] == 'bot_message'
+    end
   end
 end

data/lib/slappy/listener.rb

@@ -1,4 +1,3 @@
-require 'slappy/listeners/concerns/listenable'
 require 'slappy/listeners/base'
 require 'slappy/listeners/text_listener'
 require 'slappy/listeners/type_listener'

data/lib/slappy/listeners/base.rb

@@ -1,7 +1,38 @@
+require 'slappy/listeners/concerns/targettable'
+require 'slappy/listeners/concerns/validatable'
+
 module Slappy
   module Listener
     class Base
-      include Listenable
+      include Validatable
+      include Targettable
+
+      def initialize(pattern, options = {}, &callback)
+        self.pattern = pattern
+        if options[:from]
+          target.channel = options[:from][:channel]
+          target.user = options[:from][:user]
+        end
+        @callback = callback
+      end
+
+      def call(event)
+        channel = "channel: #{event.try(:channel).try(:name)}"
+        element = "#{target_element}: #{event.try(target_element)}"
+        Debug.log "Listen event call(#{channel} / #{element})"
+
+        return unless valid?(event)
+        return unless target?(event)
+
+        Debug.log "Callback event call: #{pattern}"
+        @callback.call(event)
+      end
+
+      private
+
+      def target_element
+        self.class.name.split('::').last.gsub(/Listener$/, '').underscore.to_sym
+      end
     end
   end
 end

data/lib/slappy/listeners/concerns/targettable.rb

@@ -0,0 +1,67 @@
+module Slappy
+  module Listener
+    module Targettable
+      include Slappy::Debuggable
+
+      def target?(event)
+        target.valid? event
+      end
+
+      def target
+        @target ||= Target.new
+      end
+
+      private
+
+      class Target
+        def valid?(event)
+          return true if channel.blank? && user.blank?
+
+          result = []
+
+          result << false unless validation(:channel, event)
+          result << false unless validation(:user, event)
+
+          result.blank?
+        end
+
+        def validation(target, event)
+          return true if send(target).compact.blank?
+          unless send(:list, target).include? event.send target
+            Debug.log "Message from restrict #{target}(expect: #{target_names(target)})"
+            return false
+          end
+          true
+        end
+
+        def channel=(value)
+          value = [value] unless value.instance_of? Array
+          @channel = value
+        end
+
+        def list(target)
+          send(target).each_with_object([]) do |t, result|
+            result << Slappy::SlackAPI.find(t)
+          end
+        end
+
+        def channel
+          @channel ||= []
+        end
+
+        def target_names(target)
+          send(target).join(',')
+        end
+
+        def user=(value)
+          value = [value] unless value.instance_of? Array
+          @user = value
+        end
+
+        def user
+          @user ||= []
+        end
+      end
+    end
+  end
+end

data/lib/slappy/listeners/concerns/{listenable.rb → validatable.rb}

@@ -1,48 +1,35 @@
 module Slappy
   module Listener
-    module Listenable
-      include ActiveSupport::Concern
+    module Validatable
       include Slappy::Debuggable
 
-      attr_reader :pattern
-
-      def initialize(target, callback)
-        @pattern = target
-        @callback = callback
-      end
-
-      def call(event)
-        Debug.log "Listen event call: #{target_element}:#{event.send(target_element)}"
+      attr_accessor :pattern
 
+      def valid?(event)
         unless time_valid?(event)
           Debug.log 'Event happend in before start time'
-          return
+          return false
         end
 
         target = event.send(target_element)
         unless target
           Debug.log 'Target is nil'
-          return
+          return false
         end
 
         event.matches = target.match pattern
         unless event.matches
           Debug.log "Target is not match pattern(#{pattern})"
-          return
+          return false
         end
 
-        Debug.log "Callback event call: #{pattern}"
-        @callback.call(event)
-      end
-
-      def time_valid?(event)
-        event.ts > Slappy.client.start_time
+        true
       end
 
       private
 
-      def target_element
-        self.class.name.split('::').last.gsub(/Listener$/, '').underscore.to_sym
+      def time_valid?(event)
+        event.ts > Slappy.client.start_time
       end
     end
   end

data/lib/slappy/{messanger.rb → messenger.rb}

@@ -1,5 +1,5 @@
 module Slappy
-  class Messanger
+  class Messenger
     class MissingChannelException < StandardError; end
 
     CHANNEL_APIS = [SlackAPI::Channel, SlackAPI::Group, SlackAPI::Direct]
@@ -27,7 +27,8 @@ module Slappy
       end
 
       options[:channel] = id
-      Slack.chat_postMessage options
+      response = Slack.chat_postMessage options
+      fail SlackAPI::SlackError.new, response['error'] unless response['ok']
     end
 
     private

data/lib/slappy/slack_api/base.rb

@@ -2,6 +2,11 @@ module Slappy
   module SlackAPI
     class Base
       include Findable
+
+      def ==(other)
+        return false unless other.instance_of? self.class
+        other.id == id
+      end
     end
   end
 end

data/lib/slappy/slack_api/channel.rb

@@ -1,7 +1,8 @@
 module Slappy
   module SlackAPI
     class Channel < Base
-      self.monitor_event = 'channel_created'
+      self.monitor_event =
+        %w(channel_created channel_deleted channel_rename channel_archive channel_unarchieve)
 
       def name
         '#' + @data.name

data/lib/slappy/slack_api/concerns/findable.rb

@@ -11,7 +11,7 @@ module Slappy
       end
 
       module ClassMethods
-        attr_reader :list_name, :api_name, :monitor_event
+        attr_reader :list_name, :api_name, :monitor_event, :monitor_registerd
 
         def api_name=(api_name)
           @api_name = api_name
@@ -26,23 +26,41 @@ module Slappy
           @monitor_event = target
         end
 
-        def list(options = {})
+        def register_monitor
+          return if @monitor_registerd
           @monitor_event.each do |event|
             Slappy.monitor event do
               @list = nil
             end
           end
+          @monitor_registerd = true
+        end
+
+        def list(options = {})
+          register_monitor
 
           unless @list
-            api_name    = self.api_name || name.split('::').last.downcase + 's'
-            list_name   = self.list_name || api_name
             method_name = "#{api_name}_list"
 
-            @list = Slack.send(method_name, options)[list_name].map { |data| new(data) }
+            options[:channel] = SlackAPI.find(options[:channel]).id if options[:channel]
+            result = Slack.send(method_name, options)
+            unless result['ok']
+              exception = SlackError.new "Error message from slack (#{result['error']})"
+              fail exception, exception.message
+            end
+            @list = result[list_name].map { |data| new(data) }
           end
           @list
         end
 
+        def api_name
+          @api_name || name.split('::').last.downcase + 's'
+        end
+
+        def list_name
+          @list_name || api_name
+        end
+
         def find(arg)
           return find_by_keyword(arg) if arg.instance_of? Hash
           find id: arg

data/lib/slappy/slack_api/file.rb

@@ -0,0 +1,8 @@
+module Slappy
+  module SlackAPI
+    class File < Base
+      self.monitor_event =
+        %w(file_created file_deleted file_change file_public file_shared file_unshared)
+    end
+  end
+end

data/lib/slappy/slack_api/group.rb

@@ -1,7 +1,7 @@
 module Slappy
   module SlackAPI
     class Group < Base
-      self.monitor_event = %w(group_joined group_open)
+      self.monitor_event = %w(group_joined group_open group_rename group_unarchive group_archieve)
     end
   end
 end

data/lib/slappy/slack_api/pin.rb

@@ -0,0 +1,8 @@
+module Slappy
+  module SlackAPI
+    class Pin < Base
+      self.list_name = 'items'
+      self.monitor_event = %w(pin_added pin_removed)
+    end
+  end
+end

data/lib/slappy/slack_api/user.rb

@@ -2,7 +2,7 @@ module Slappy
   module SlackAPI
     class User < Base
       self.list_name = 'members'
-      self.monitor_event = 'team_join'
+      self.monitor_event = %w(team_join user_change)
 
       def name
         '@' + @data.name

data/lib/slappy/slack_api.rb

@@ -0,0 +1,28 @@
+require 'slappy/slack_api/concerns/findable'
+require 'slappy/slack_api/base'
+require 'slappy/slack_api/channel'
+require 'slappy/slack_api/direct'
+require 'slappy/slack_api/file'
+require 'slappy/slack_api/group'
+require 'slappy/slack_api/user'
+require 'slappy/slack_api/pin'
+
+module Slappy
+  module SlackAPI
+    class SlackError < StandardError
+      def exception(error_message = nil)
+        error_message = "#{error_message}. Error detail is see: https://api.slack.com/methods"
+        super(error_message)
+      end
+    end
+
+    def self.find(value)
+      [:Channel, :Group, :Direct, :User].each do |klass|
+        klass = "Slappy::SlackAPI::#{klass}".constantize
+        result = (klass.find(id: value) || klass.find(name: value))
+        return result if result
+      end
+      nil
+    end
+  end
+end

data/lib/slappy/version.rb

@@ -1,3 +1,3 @@
 module Slappy
-  VERSION = '0.5.2'
+  VERSION = '0.6.0'
 end

data/lib/slappy.rb

@@ -12,7 +12,7 @@ module Slappy
     extend Forwardable
 
     def_delegators :configuration, :logger
-    def_delegators :client, :start, :hello, :hear, :say, :schedule, :monitor
+    def_delegators :client, :start, :hello, :hear, :say, :schedule, :monitor, :goodnight, :respond
 
     def configure
       @configuration = Configuration.new
@@ -33,12 +33,7 @@ module Slappy
 end
 
 require 'slappy/concerns/debuggable'
-require 'slappy/slack_api/concerns/findable'
-require 'slappy/slack_api/base'
-require 'slappy/slack_api/channel'
-require 'slappy/slack_api/direct'
-require 'slappy/slack_api/group'
-require 'slappy/slack_api/user'
+require 'slappy/slack_api'
 require 'slappy/cli'
 require 'slappy/client'
 require 'slappy/configuration'
@@ -47,6 +42,6 @@ require 'slappy/commands/generator.rb'
 require 'slappy/commands/run.rb'
 require 'slappy/event'
 require 'slappy/listener'
-require 'slappy/messanger'
+require 'slappy/messenger'
 require 'slappy/schedule'
 require 'slappy/version'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slappy
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - wakaba260
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-18 00:00:00.000000000 Z
+date: 2015-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slack-api
@@ -252,17 +252,21 @@ files:
 - lib/slappy/event.rb
 - lib/slappy/listener.rb
 - lib/slappy/listeners/base.rb
-- lib/slappy/listeners/concerns/listenable.rb
+- lib/slappy/listeners/concerns/targettable.rb
+- lib/slappy/listeners/concerns/validatable.rb
 - lib/slappy/listeners/subtype_listener.rb
 - lib/slappy/listeners/text_listener.rb
 - lib/slappy/listeners/type_listener.rb
-- lib/slappy/messanger.rb
+- lib/slappy/messenger.rb
 - lib/slappy/schedule.rb
+- lib/slappy/slack_api.rb
 - lib/slappy/slack_api/base.rb
 - lib/slappy/slack_api/channel.rb
 - lib/slappy/slack_api/concerns/findable.rb
 - lib/slappy/slack_api/direct.rb
+- lib/slappy/slack_api/file.rb
 - lib/slappy/slack_api/group.rb
+- lib/slappy/slack_api/pin.rb
 - lib/slappy/slack_api/user.rb
 - lib/slappy/version.rb
 - slappy.gemspec