slack-ruby-client 0.5.4 → 0.6.0

data/bin/commands/stars.rb

@@ -1,4 +1,4 @@
-# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+# This file was auto-generated by lib/tasks/web.rake
 
 desc 'Stars methods.'
 command 'stars' do |g|

data/bin/commands/team.rb

@@ -1,4 +1,4 @@
-# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+# This file was auto-generated by lib/tasks/web.rake
 
 desc 'Team methods.'
 command 'team' do |g|

data/bin/commands/usergroups.rb

@@ -1,4 +1,4 @@
-# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+# This file was auto-generated by lib/tasks/web.rake
 
 desc "Get info on your team's user groups."
 command 'usergroups' do |g|

data/bin/commands/users.rb

@@ -1,4 +1,4 @@
-# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+# This file was auto-generated by lib/tasks/web.rake
 
 desc 'Get info on members of your Slack team.'
 command 'users' do |g|
@@ -54,4 +54,13 @@ command 'users' do |g|
       puts JSON.dump($client.users_id(options))
     end
   end
+
+  g.desc 'This method searches for users.'
+  g.long_desc %( This method searches for users. )
+  g.command 'search' do |c|
+    c.flag 'user', desc: 'User to search for.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.users_search(options))
+    end
+  end
 end

data/examples/hi_real_time/hi.rb

@@ -8,19 +8,19 @@ end
 client = Slack::RealTime::Client.new
 
 client.on :hello do
-  puts "Successfully connected, welcome '#{client.self['name']}' to the '#{client.team['name']}' team at https://#{client.team['domain']}.slack.com."
+  puts "Successfully connected, welcome '#{client.self.name}' to the '#{client.team.name}' team at https://#{client.team.domain}.slack.com."
 end
 
 client.on :message do |data|
   puts data
 
-  client.typing channel: data['channel']
+  client.typing channel: data.channel
 
-  case data['text']
+  case data.text
   when 'bot hi' then
-    client.message channel: data['channel'], text: "Hi <@#{data['user']}>!"
+    client.message channel: data.channel, text: "Hi <@#{data.user}>!"
   when /^bot/ then
-    client.message channel: data['channel'], text: "Sorry <@#{data['user']}>, what?"
+    client.message channel: data.channel, text: "Sorry <@#{data.user}>, what?"
   end
 end
 

data/examples/hi_real_time_and_web/hi.rb

@@ -8,16 +8,16 @@ end
 client = Slack::RealTime::Client.new
 
 client.on :hello do
-  puts "Successfully connected, welcome '#{client.self['name']}' to the '#{client.team['name']}' team at https://#{client.team['domain']}.slack.com."
+  puts "Successfully connected, welcome '#{client.self.name}' to the '#{client.team.name}' team at https://#{client.team.domain}.slack.com."
 end
 
 client.on :message do |data|
   puts data
-  case data['text']
+  case data.text
   when 'bot hi' then
-    client.web_client.chat_postMessage channel: data['channel'], text: "Hi <@#{data['user']}>!"
+    client.web_client.chat_postMessage channel: data.channel, text: "Hi <@#{data.user}>!"
   when /^bot/ then
-    client.web_client.chat_postMessage channel: data['channel'], text: "Sorry <@#{data['user']}>, what?"
+    client.web_client.chat_postMessage channel: data.channel, text: "Sorry <@#{data.user}>, what?"
   end
 end
 

data/examples/hi_real_time_async/hi.rb

@@ -8,19 +8,19 @@ end
 client = Slack::RealTime::Client.new
 
 client.on :hello do
-  puts "Successfully connected, welcome '#{client.self['name']}' to the '#{client.team['name']}' team at https://#{client.team['domain']}.slack.com."
+  puts "Successfully connected, welcome '#{client.self.name}' to the '#{client.team.name}' team at https://#{client.team.domain}.slack.com."
 end
 
 client.on :message do |data|
   puts data
 
-  client.typing channel: data['channel']
+  client.typing channel: data.channel
 
-  case data['text']
+  case data.text
   when 'bot hi' then
-    client.message channel: data['channel'], text: "Hi <@#{data['user']}>!"
+    client.message channel: data.channel, text: "Hi <@#{data.user}>!"
   when /^bot/ then
-    client.message channel: data['channel'], text: "Sorry <@#{data['user']}>, what?"
+    client.message channel: data.channel, text: "Sorry <@#{data.user}>, what?"
   end
 end
 

data/lib/slack-ruby-client.rb

@@ -2,6 +2,8 @@ require 'slack/version'
 require 'slack/config'
 
 # Messages
+require 'hashie'
+require 'slack/messages/message'
 require 'slack/messages/formatting'
 
 # Web API
@@ -9,6 +11,11 @@ require 'faraday'
 require 'faraday_middleware'
 require 'json'
 require 'logger'
+begin
+  require 'picky'
+rescue LoadError
+  # ignore, only used in users_search
+end
 require 'slack/web/config'
 require 'slack/web/api/error'
 require 'slack/web/faraday/response/raise_error'
@@ -25,5 +32,8 @@ require 'slack/real_time/api/message_id'
 require 'slack/real_time/api/ping'
 require 'slack/real_time/api/message'
 require 'slack/real_time/api/typing'
+require 'slack/real_time/models'
 require 'slack/real_time/config'
 require 'slack/real_time/client'
+require 'slack/real_time/store'
+require 'slack/real_time/event_handlers'

data/lib/slack/messages/message.rb

@@ -0,0 +1,9 @@
+module Slack
+  module Messages
+    class Message < Hashie::Mash
+      def presence
+        super['presence']
+      end
+    end
+  end
+end

data/lib/slack/real_time/api/schema/event.json

@@ -0,0 +1,22 @@
+{
+  "type": "object",
+  "required": [
+    "name",
+    "desc"
+  ],
+  "properties": {
+    "name": {
+      "type": "string"
+    },
+    "desc": {
+      "type": "string"
+    },
+    "long_desc": {
+      "type": "string"
+    },
+    "example": {
+      "type": "object",
+      "default": {}
+    }
+  }
+}

data/lib/slack/real_time/api/templates/event_handler.erb

@@ -0,0 +1,18 @@
+# This file was auto-generated by lib/tasks/real_time.rake
+
+# module Slack
+#   module RealTime
+#     module EventHandlers
+#       module <%= class_name %>
+#         # <%= desc %>
+#         # @see https://api.slack.com/events/<%= name %>
+#         # @see https://github.com/dblock/slack-api-ref/blob/master/events/<%= name %>.json
+#         def self.call(_client, _data)
+#           # TODO
+#         end
+#       end
+#     end
+#   end
+# end
+
+# Slack::RealTime::Client.events['<%= name %>'] = Slack::RealTime::EventHandlers::<%= class_name %>

data/lib/slack/real_time/api/templates/event_handlers.erb

@@ -0,0 +1,5 @@
+# This file was auto-generated by lib/tasks/real_time.rake
+
+<% events.each do |f| %>
+require 'slack/real_time/event_handlers/<%= f %>'
+<% end %>

data/lib/slack/real_time/client.rb

@@ -9,7 +9,15 @@ module Slack
       include Api::Message
       include Api::Typing
 
+      @events = {}
+
+      class << self
+        attr_accessor :events
+      end
+
       attr_accessor :web_client
+      attr_accessor :store
+      attr_accessor :url
       attr_accessor(*Config::ATTRIBUTES)
 
       def initialize(options = {})
@@ -17,13 +25,14 @@ module Slack
         Slack::RealTime::Config::ATTRIBUTES.each do |key|
           send("#{key}=", options[key] || Slack::RealTime.config.send(key))
         end
+        @store_class = options.key?(:store_class) ? options[:store_class] : Slack::RealTime::Store
         @token ||= Slack.config.token
         @web_client = Slack::Web::Client.new(token: token)
       end
 
-      [:url, :team, :self, :users, :channels, :groups, :ims, :bots].each do |attr|
-        define_method attr do
-          @options[attr.to_s] if @options
+      [:users, :self, :channels, :team, :teams, :groups, :ims, :bots].each do |store_method|
+        define_method store_method do
+          store.send(store_method) if store
         end
       end
 
@@ -71,9 +80,11 @@ module Slack
       # @return [Slack::RealTime::Socket]
       def build_socket
         fail ClientAlreadyStartedError if started?
-        @options = web_client.rtm_start
-
-        socket_class.new(@options.fetch('url'), socket_options)
+        start = web_client.rtm_start(start_options)
+        data = Slack::Messages::Message.new(start)
+        @url = data.url
+        @store = @store_class.new(data) if @store_class
+        socket_class.new(@url, socket_options)
       end
 
       def socket_options
@@ -137,10 +148,21 @@ module Slack
 
       def dispatch(event)
         return false unless event.data
-        data = JSON.parse(event.data)
-        type = data['type']
+        data = Slack::Messages::Message.new(JSON.parse(event.data))
+        type = data.type
         return false unless type
-        callbacks = self.callbacks[type.to_s]
+        type = type.to_s
+        run_handlers(type, data) if @store
+        run_callbacks(type, data)
+      end
+
+      def run_handlers(type, data)
+        handler = Slack::RealTime::Client.events[type]
+        handler.call(self, data) if handler
+      end
+
+      def run_callbacks(type, data)
+        callbacks = self.callbacks[type]
         return false unless callbacks
         callbacks.each do |c|
           c.call(data)

data/lib/slack/real_time/config.rb

@@ -9,7 +9,8 @@ module Slack
         :token,
         :websocket_ping,
         :websocket_proxy,
-        :concurrency
+        :concurrency,
+        :start_options
       ]
 
       attr_accessor(*Config::ATTRIBUTES)
@@ -19,6 +20,7 @@ module Slack
         self.websocket_proxy = nil
         self.token = nil
         self.concurrency = method(:detect_concurrency)
+        self.start_options = {}
       end
 
       def concurrency

data/lib/slack/real_time/event_handlers.rb

@@ -0,0 +1,66 @@
+# require 'slack/real_time/event_handlers/accounts_changed'
+require 'slack/real_time/event_handlers/bot_added'
+require 'slack/real_time/event_handlers/bot_changed'
+require 'slack/real_time/event_handlers/channel_archive'
+require 'slack/real_time/event_handlers/channel_created'
+require 'slack/real_time/event_handlers/channel_deleted'
+# require 'slack/real_time/event_handlers/channel_history_changed'
+require 'slack/real_time/event_handlers/channel_joined'
+require 'slack/real_time/event_handlers/channel_left'
+# require 'slack/real_time/event_handlers/channel_marked'
+require 'slack/real_time/event_handlers/channel_rename'
+require 'slack/real_time/event_handlers/channel_unarchive'
+# require 'slack/real_time/event_handlers/commands_changed'
+# require 'slack/real_time/event_handlers/dnd_updated'
+# require 'slack/real_time/event_handlers/dnd_updated_user'
+require 'slack/real_time/event_handlers/email_domain_changed'
+# require 'slack/real_time/event_handlers/emoji_changed'
+# require 'slack/real_time/event_handlers/file_change'
+# require 'slack/real_time/event_handlers/file_comment_added'
+# require 'slack/real_time/event_handlers/file_comment_deleted'
+# require 'slack/real_time/event_handlers/file_comment_edited'
+# require 'slack/real_time/event_handlers/file_created'
+# require 'slack/real_time/event_handlers/file_deleted'
+# require 'slack/real_time/event_handlers/file_private'
+# require 'slack/real_time/event_handlers/file_public'
+# require 'slack/real_time/event_handlers/file_shared'
+# require 'slack/real_time/event_handlers/file_unshared'
+require 'slack/real_time/event_handlers/group_archive'
+require 'slack/real_time/event_handlers/group_close'
+# require 'slack/real_time/event_handlers/group_history_changed'
+require 'slack/real_time/event_handlers/group_joined'
+require 'slack/real_time/event_handlers/group_left'
+# require 'slack/real_time/event_handlers/group_marked'
+require 'slack/real_time/event_handlers/group_open'
+require 'slack/real_time/event_handlers/group_rename'
+require 'slack/real_time/event_handlers/group_unarchive'
+require 'slack/real_time/event_handlers/im_close'
+require 'slack/real_time/event_handlers/im_created'
+# require 'slack/real_time/event_handlers/im_history_changed'
+# require 'slack/real_time/event_handlers/im_marked'
+require 'slack/real_time/event_handlers/im_open'
+require 'slack/real_time/event_handlers/manual_presence_change'
+# require 'slack/real_time/event_handlers/pin_added'
+# require 'slack/real_time/event_handlers/pin_removed'
+require 'slack/real_time/event_handlers/pref_change'
+require 'slack/real_time/event_handlers/presence_change'
+# require 'slack/real_time/event_handlers/reaction_added'
+# require 'slack/real_time/event_handlers/reaction_removed'
+# require 'slack/real_time/event_handlers/reconnect_url'
+# require 'slack/real_time/event_handlers/star_added'
+# require 'slack/real_time/event_handlers/star_removed'
+# require 'slack/real_time/event_handlers/subteam_created'
+# require 'slack/real_time/event_handlers/subteam_self_added'
+# require 'slack/real_time/event_handlers/subteam_self_removed'
+# require 'slack/real_time/event_handlers/subteam_updated'
+require 'slack/real_time/event_handlers/team_domain_change'
+require 'slack/real_time/event_handlers/team_join'
+# require 'slack/real_time/event_handlers/team_migration_started'
+require 'slack/real_time/event_handlers/team_plan_change'
+require 'slack/real_time/event_handlers/team_pref_change'
+# require 'slack/real_time/event_handlers/team_profile_change'
+# require 'slack/real_time/event_handlers/team_profile_delete'
+# require 'slack/real_time/event_handlers/team_profile_reorder'
+require 'slack/real_time/event_handlers/team_rename'
+require 'slack/real_time/event_handlers/user_change'
+# require 'slack/real_time/event_handlers/user_typing'

data/lib/slack/real_time/event_handlers/accounts_changed.rb

@@ -0,0 +1,18 @@
+# This file was auto-generated by lib/tasks/real_time.rake
+
+# module Slack
+#   module RealTime
+#     module EventHandlers
+#       module AccountsChanged
+#         # The list of accounts a user is signed into has changed.
+#         # @see https://api.slack.com/events/accounts_changed
+#         # @see https://github.com/dblock/slack-api-ref/blob/master/events/accounts_changed.json
+#         def self.call(_client, _data)
+#           # TODO
+#         end
+#       end
+#     end
+#   end
+# end
+#
+# Slack::RealTime::Client.events['accounts_changed'] = Slack::RealTime::EventHandlers::AccountsChanged

data/lib/slack/real_time/event_handlers/bot_added.rb

@@ -0,0 +1,16 @@
+module Slack
+  module RealTime
+    module EventHandlers
+      module BotAdded
+        # An integration bot was added.
+        # @see https://api.slack.com/events/bot_added
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/bot_added.json
+        def self.call(client, data)
+          client.bots[data.bot.id] = Models::Bot.new(data.bot)
+        end
+      end
+    end
+  end
+end
+
+Slack::RealTime::Client.events['bot_added'] = Slack::RealTime::EventHandlers::BotAdded

data/lib/slack/real_time/event_handlers/bot_changed.rb

@@ -0,0 +1,17 @@
+module Slack
+  module RealTime
+    module EventHandlers
+      module BotChanged
+        # An integration bot was changed.
+        # @see https://api.slack.com/events/bot_changed
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/bot_changed.json
+        def self.call(client, data)
+          bot = client.bots[data.bot.id]
+          bot.merge!(data.bot) if bot
+        end
+      end
+    end
+  end
+end
+
+Slack::RealTime::Client.events['bot_changed'] = Slack::RealTime::EventHandlers::BotChanged

data/lib/slack/real_time/event_handlers/channel_archive.rb

@@ -0,0 +1,17 @@
+module Slack
+  module RealTime
+    module EventHandlers
+      module ChannelArchive
+        # A team channel was archived.
+        # @see https://api.slack.com/events/channel_archive
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/channel_archive.json
+        def self.call(client, data)
+          channel = client.channels[data.channel]
+          channel.is_archived = true if channel
+        end
+      end
+    end
+  end
+end
+
+Slack::RealTime::Client.events['channel_archive'] = Slack::RealTime::EventHandlers::ChannelArchive

data/lib/slack/real_time/event_handlers/channel_created.rb

@@ -0,0 +1,17 @@
+module Slack
+  module RealTime
+    module EventHandlers
+      module ChannelCreated
+        # A team channel was created.
+        # @see https://api.slack.com/events/channel_created
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/channel_created.json
+        def self.call(client, data)
+          channel = Models::Channel.new(data.channel)
+          client.channels[channel.id] = channel
+        end
+      end
+    end
+  end
+end
+
+Slack::RealTime::Client.events['channel_created'] = Slack::RealTime::EventHandlers::ChannelCreated