slappy 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e79a1760b63ef1b9dc0b47ddc653346f56d972f
-  data.tar.gz: 081b83f1f491f9173a1fd25f085c42faed243013
+  metadata.gz: 279a9dc258db912d4e7ed619595d66553ea75d69
+  data.tar.gz: 1937de721354dba64d166128b34bad6b24726723
 SHA512:
-  metadata.gz: c5b60c4a6050e4df1e15f5f0d8ddd3a544edbf69669c18148dd505e05ddd152041dd14acfd662db472d73338ca32347a54cd409cdfee0e232a72374f0c78ed6b
-  data.tar.gz: af1e4362d1387b85cc69e7492ed88b9b2f0f0a8e5bae0fd8eb042c2762742b597ad90c1cc4f3fddfb01db993d293742ed575173d3eddc9af1a2da81124edfecd
+  metadata.gz: 0ce87466b06fccd78a49e18e007dab3db1ec345e9c844437a05df2bc831a86ece70ebcb55cf00906a5312c7aa4b07a951216fc270500145066c819ce4388712c
+  data.tar.gz: 2b85a23ac6d034c6c9dd623d6d61da941466ea652753ba9cdcd816cea73b78a903a0263f1dd4aec2da5bf7c89d44c7c593ae50030c85a802c14c35288a33411e

data/README.md

@@ -112,48 +112,104 @@ robot.username   - default: 'slappy'
 robot.icon_emoji - default: nil
 robot.channel    - default: '#general'
 robot.icon_url   - default: nil
+robot.as_user    - default: false
 ```
 
 ### Basic Usage
 
-If you not want execute `slappy start` command, written by (require `'slappy/dsl'` use DSL):
-
 ```ruby
-require 'slappy'
-
 # called when start up
-Slappy.hello do
-  Slappy.logger.info 'successfly connected'
+hello do
+  logger.info 'successfly connected'
 end
+```
+
+#### Send and Receive Message
 
+```ruby
 # called when match message
-Slappy.hear 'foo' do
-  Slappy.logger.info 'foo'
+hear 'foo' do
+  logger.info 'foo'
 end
 
 # use regexp in string literal
-Slappy.hear 'bar (.*)' do |event|
-  Slappy.logger.info event.matches[1] #=> Event#matches return MatchData object
+hear 'bar (.*)' do |event|
+  logger.info event.matches[1] #=> Event#matches return MatchData object
 end
 
 # event object is slack event JSON (convert to Hashie::Mash)
-Slappy.hear '^bar (.*)' do |event|
-  Slappy.logger.info 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:'
+hear '^bar (.*)' do |event|
+  say 'slappy!', channel: event.channel  #=> to received channel object
+  say 'slappy!', channel: '#general'     #=> send to public channel
+  say 'slappy!', channel: 'private-room' #=> send to private group
+  say 'slappy!', username: 'slappy!', icon_emoji: ':slappy:' #=> change config
 end
 
 # use regexp literal
-Slappy.hear /^foobar/ do
-  Slappy.logger.info 'slappppy!'
+hear(/^foobar/) do
+  logger.info 'slappppy!'
+end
+```
+
+#### Monitoring Subtypes Event
+
+```ruby
+monitor 'channel_joined' do |event|
+  say "Welcome to #{event.name}!", channel: event.channel
 end
 
-Slappy.start #=> Start slappy process
+monitor 'team_join' do |event|
+  say "Welcome to this team!", channel: "#general"
+end
+```
+
+#### Schedule Event
+
+```ruby
+schedule '* * * * *' do
+  logger.info 'Slappy alive...' #=> Repeat every minutes.
+end
+
+```
+
+### DSL Methods
+
+|method|when execute callback|
+|:---:|:---|
+|hello|start up|
+|hear|message (match pattern)|
+|monitor|[Slack RTM event](https://api.slack.com/rtm)|
+|schedule|specify time ([Syntax is here](https://github.com/r7kamura/chrono)) - Thanks to Chrono!|
+
+### In your Application
+
+If you not want execute `slappy start` command, written by (require `'slappy/dsl'` use DSL):
+
+```
+require 'slappy'
+
+Slappy.hello do
+  # In your code..
+end
+
+Slappy.say 'message to slack'
+
+Slappy.start #=> Start WebSocket connection
 ```
 
 ## Release Note
 
+- v0.5.0
+  - Support Schedule
+  - Support Slack RMT Event
+  - Support private group
+  - Support as_user option
+  - Introduce SlackAPI objects
+    - Group
+    - Channel
+    - Direct
+    - User
+
 - v0.4.0
   - Support logger
   - Support load lib directory

data/lib/slappy/client.rb

@@ -27,13 +27,22 @@ module Slappy
 
     def hear(pattern, &block)
       @callbacks[:message] ||= []
-      @callbacks[:message].push Listener.new(pattern, block)
+      @callbacks[:message].push Listener::TextListener.new(pattern, block)
+    end
+
+    def monitor(subtype, &block)
+      @callbacks[:message] ||= []
+      @callbacks[:message].push Listener::SubtypeListener.new(subtype, block)
     end
 
     def say(text, options = {})
       options[:text] = text
-      params = merge_send_params options
-      Slack.chat_postMessage params
+      Messanger.new(options).message
+    end
+
+    def schedule(schedule, options = {}, &block)
+      @schedule ||= Schedule.new
+      @schedule.register schedule, options, &block
     end
 
     private
@@ -53,7 +62,7 @@ module Slappy
           when :hello
             listener.call
           when :message
-            event = Event.new(data, listener.pattern)
+            event = Event.new(data)
             listener.call(event)
           end
         end
@@ -63,10 +72,5 @@ module Slappy
     def config
       Slappy.configuration
     end
-
-    def merge_send_params(options)
-      default = config.send_params
-      default.merge options
-    end
   end
 end

data/lib/slappy/configuration/robot.rb

@@ -1,7 +1,11 @@
 module Slappy
   class Configuration
     class Robot
-      attr_accessor :botname, :username, :channel, :icon_emoji, :icon_url
+      attr_accessor :botname, :username, :channel, :icon_emoji, :icon_url, :as_user
+
+      def as_user
+        @as_user || false
+      end
 
       def botname
         @botname || username

data/lib/slappy/configuration.rb

@@ -43,7 +43,8 @@ module Slappy
         username: robot.username,
         icon_emoji: robot.icon_emoji,
         channel: robot.channel,
-        icon_url: robot.icon_url
+        icon_url: robot.icon_url,
+        as_user: robot.as_user
       }
     end
   end

data/lib/slappy/dsl.rb

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

data/lib/slappy/event.rb

@@ -2,17 +2,30 @@ module Slappy
   class Event
     extend Forwardable
 
-    attr_reader :matches
+    attr_accessor :matches
 
     def_delegators :@data, :method_missing, :respond_to_missing?
 
-    def initialize(data, pattern)
+    def initialize(data)
       @data = Hashie::Mash.new data
-      @matches = text.match pattern
     end
 
     def text
       @data['text'].to_s
     end
+
+    def channel
+      SlackAPI::Channel.find(id: @data['channel']) ||
+        SlackAPI::Group.find(id: @data['channel']) ||
+        SlackAPI::Direct.find(id: @data['channel'])
+    end
+
+    def user
+      SlackAPI::User.find(id: @data['user'])
+    end
+
+    def ts
+      Time.at(@data['ts'].to_f)
+    end
   end
 end

data/lib/slappy/listener.rb

@@ -1,19 +1,9 @@
-module Slappy
-  class Listener
-    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.client.start_time
-      return unless event.text.match @regexp
-      @callback.call(event)
-    end
+require 'slappy/listeners/concerns/listenable'
+require 'slappy/listeners/base'
+require 'slappy/listeners/text_listener'
+require 'slappy/listeners/subtype_listener'
 
-    def pattern
-      @regexp
-    end
+module Slappy
+  module Listener
   end
 end

data/lib/slappy/listeners/base.rb

@@ -0,0 +1,7 @@
+module Slappy
+  module Listener
+    class Base
+      include Listenable
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+module Slappy
+  module Listener
+    module Listenable
+      include ActiveSupport::Concern
+
+      attr_reader :pattern
+
+      def initialize(target, callback)
+        @pattern = target
+        @callback = callback
+      end
+
+      def call(event)
+        return unless time_valid?(event)
+
+        target = event.send(target_element)
+        return unless target
+
+        event.matches = target.match pattern
+        return unless event.matches
+
+        @callback.call(event)
+      end
+
+      def time_valid?(event)
+        event.ts > Slappy.client.start_time
+      end
+
+      private
+
+      def target_element
+        self.class.name.split('::').last.gsub(/Listener$/, '').underscore.to_sym
+      end
+    end
+  end
+end

data/lib/slappy/listeners/subtype_listener.rb

@@ -0,0 +1,6 @@
+module Slappy
+  module Listener
+    class SubtypeListener < Base
+    end
+  end
+end

data/lib/slappy/listeners/text_listener.rb

@@ -0,0 +1,10 @@
+module Slappy
+  module Listener
+    class TextListener < Base
+      def pattern
+        return /#{@pattern}/ if @pattern.instance_of? String
+        @pattern
+      end
+    end
+  end
+end

data/lib/slappy/messanger.rb

@@ -0,0 +1,44 @@
+module Slappy
+  class Messanger
+    class MissingChannelException < StandardError; end
+
+    CHANNEL_APIS = [SlackAPI::Channel, SlackAPI::Group, SlackAPI::Direct]
+
+    def initialize(options)
+      @destination = {}
+      @destination = options[:channel]
+      options.delete :channel
+      @options = options
+    end
+
+    def message
+      options = merge_params(@options)
+
+      if @destination.is_a? SlackAPI::Base
+        id = @destination.id
+      else
+        instance = nil
+        CHANNEL_APIS.each do |klass|
+          instance = klass.find(name: @destination) || klass.find(id: @destination)
+          break unless instance.nil?
+        end
+        fail MissingChannelException.new, "channel / #{@destination} is not found" if instance.nil?
+        id = instance.id
+      end
+
+      options[:channel] = id
+      Slack.chat_postMessage options
+    end
+
+    private
+
+    def config
+      Slappy.configuration
+    end
+
+    def merge_params(options)
+      default = config.send_params
+      default.merge options
+    end
+  end
+end

data/lib/slappy/schedule.rb

@@ -0,0 +1,39 @@
+require 'securerandom'
+
+module Slappy
+  class Schedule
+    class OverScheduleError < StandardError; end
+    class InvalidFormatError < StandardError; end
+
+    DEFAULT_MAX_THREAD = 1000
+
+    def register(schedule, options = {}, &block)
+      id = options[:id] || generate_id
+      schedule_list[id] = Thread.new { Chrono::Trigger.new(schedule) { block.call }.run }
+      Slappy.logger.try(:debug, "Schedule registerd to #{schedule}")
+      id
+    end
+
+    def remove(id)
+      registered = @schedule_list.include? id
+      if registered
+        @schedule_list[id].kill
+        @schedule_list.delete id
+      end
+      registered
+    end
+
+    private
+
+    def schedule_list
+      @schedule_list ||= {}
+    end
+
+    def generate_id
+      figure = Math.log10(DEFAULT_MAX_THREAD) + 1
+      id = format("%0#{figure}d", SecureRandom.random_number(DEFAULT_MAX_THREAD))
+      id = generate_id if schedule_list.include? id
+      id
+    end
+  end
+end

data/lib/slappy/slack_api/base.rb

@@ -0,0 +1,7 @@
+module Slappy
+  module SlackAPI
+    class Base
+      include Findable
+    end
+  end
+end

data/lib/slappy/slack_api/channel.rb

@@ -0,0 +1,11 @@
+module Slappy
+  module SlackAPI
+    class Channel < Base
+      self.monitor_event = 'channel_created'
+
+      def name
+        '#' + @data.name
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+module Slappy
+  module SlackAPI
+    module Findable
+      extend ActiveSupport::Concern
+      extend Forwardable
+
+      def_delegators :@data, :method_missing, :respond_to?
+
+      def initialize(data)
+        @data = Hashie::Mash.new data
+      end
+
+      module ClassMethods
+        attr_reader :list_name, :api_name, :monitor_event
+
+        def api_name=(api_name)
+          @api_name = api_name
+        end
+
+        def list_name=(list_name)
+          @list_name = list_name
+        end
+
+        def monitor_event=(target)
+          target = [target] unless target.instance_of? Array
+          @monitor_event = target
+        end
+
+        def list(options = {})
+          @monitor_event.each do |event|
+            Slappy.monitor event do
+              @list = nil
+            end
+          end
+
+          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) }
+          end
+          @list
+        end
+
+        def find(arg)
+          return find_by_keyword(arg) if arg.instance_of? Hash
+          find id: arg
+        end
+
+        def find_by_keyword(hash)
+          hash.map { |key, value| list.find { |obj| obj.send(key) == value } }.first
+        end
+      end
+    end
+  end
+end

data/lib/slappy/slack_api/direct.rb

@@ -0,0 +1,9 @@
+module Slappy
+  module SlackAPI
+    class Direct < Base
+      self.api_name = 'im'
+      self.list_name = 'ims'
+      self.monitor_event = 'im_open'
+    end
+  end
+end

data/lib/slappy/slack_api/group.rb

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

data/lib/slappy/slack_api/user.rb

@@ -0,0 +1,12 @@
+module Slappy
+  module SlackAPI
+    class User < Base
+      self.list_name = 'members'
+      self.monitor_event = 'team_join'
+
+      def name
+        '@' + @data.name
+      end
+    end
+  end
+end

data/lib/slappy/version.rb

@@ -1,3 +1,3 @@
 module Slappy
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

data/lib/slappy.rb

@@ -1,5 +1,8 @@
+require 'active_support'
+require 'active_support/core_ext'
+require 'active_support/concern'
+require 'chrono'
 require 'forwardable'
-require 'active_support/core_ext/string/inflections'
 require 'hashie'
 require 'slack'
 require 'termcolor'
@@ -11,7 +14,7 @@ module Slappy
     extend Forwardable
 
     def_delegators :configuration, :logger
-    def_delegators :client, :start, :hello, :hear, :say
+    def_delegators :client, :start, :hello, :hear, :say, :schedule, :monitor
 
     def configure
       @configuration = Configuration.new
@@ -31,6 +34,12 @@ module Slappy
   end
 end
 
+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/cli'
 require 'slappy/client'
 require 'slappy/configuration'
@@ -39,4 +48,6 @@ require 'slappy/commands/generator.rb'
 require 'slappy/commands/run.rb'
 require 'slappy/event'
 require 'slappy/listener'
+require 'slappy/messanger'
+require 'slappy/schedule'
 require 'slappy/version'

data/slappy.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'thor'
   spec.add_dependency "activesupport"
   spec.add_dependency "termcolor"
+  spec.add_dependency "chrono"
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slappy
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - wakaba260
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-12 00:00:00.000000000 Z
+date: 2015-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slack-api
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: chrono
+  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
@@ -214,7 +228,6 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".env.sample"
 - ".gitignore"
 - ".hound.yml"
 - ".rspec"
@@ -237,6 +250,18 @@ files:
 - lib/slappy/dsl.rb
 - lib/slappy/event.rb
 - lib/slappy/listener.rb
+- lib/slappy/listeners/base.rb
+- lib/slappy/listeners/concerns/listenable.rb
+- lib/slappy/listeners/subtype_listener.rb
+- lib/slappy/listeners/text_listener.rb
+- lib/slappy/messanger.rb
+- lib/slappy/schedule.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/group.rb
+- lib/slappy/slack_api/user.rb
 - lib/slappy/version.rb
 - slappy.gemspec
 - templates/example.rb
@@ -261,7 +286,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Simple Slack Bot Framework

data/.env.sample

@@ -1 +0,0 @@
-SLACK_TOKEN=