slack-ruby-client 0.6.0 → 0.7.0

data/lib/slack/real_time/concurrency/eventmachine.rb

@@ -5,6 +5,26 @@ module Slack
   module RealTime
     module Concurrency
       module Eventmachine
+        class Client < Faye::WebSocket::Client
+          attr_reader :logger
+          protected :logger
+
+          def initialize(url, protocols = nil, options = {})
+            @logger = options.delete(:logger) || Slack::RealTime::Config.logger || Slack::Config.logger
+            super
+          end
+
+          def parse(data)
+            logger.debug("#{self.class}##{__method__}") { data }
+            super data
+          end
+
+          def write(data)
+            logger.debug("#{self.class}##{__method__}") { data }
+            super data
+          end
+        end
+
         class Socket < Slack::RealTime::Socket
           def start_async
             thread = ensure_reactor_running
@@ -15,6 +35,7 @@ module Slack
           end
 
           def send_data(message)
+            logger.debug("#{self.class}##{__method__}") { message }
             driver.send(message)
           end
 
@@ -30,7 +51,7 @@ module Slack
           end
 
           def connect
-            @driver = ::Faye::WebSocket::Client.new(url, nil, options)
+            @driver = Client.new(url, nil, options.merge(logger: logger))
           end
         end
       end

data/lib/slack/real_time/config.rb

@@ -10,7 +10,9 @@ module Slack
         :websocket_ping,
         :websocket_proxy,
         :concurrency,
-        :start_options
+        :start_options,
+        :store_class,
+        :logger
       ]
 
       attr_accessor(*Config::ATTRIBUTES)
@@ -21,6 +23,8 @@ module Slack
         self.token = nil
         self.concurrency = method(:detect_concurrency)
         self.start_options = {}
+        self.store_class = Slack::RealTime::Store
+        self.logger = nil
       end
 
       def concurrency

data/lib/slack/real_time/socket.rb

@@ -4,14 +4,18 @@ module Slack
       attr_accessor :url
       attr_accessor :options
       attr_reader :driver
+      attr_reader :logger
+      protected :logger
 
       def initialize(url, options = {})
         @url = url
         @options = options
         @driver = nil
+        @logger = options.delete(:logger) || Slack::RealTime::Config.logger || Slack::Config.logger
       end
 
       def send_data(message)
+        logger.debug("#{self.class}##{__method__}") { message }
         case message
         when Numeric then driver.text(message.to_s)
         when String  then driver.text(message)
@@ -24,6 +28,7 @@ module Slack
         return if connected?
 
         connect
+        logger.debug("#{self.class}##{__method__}") { driver.class }
 
         yield driver if block_given?
       end

data/lib/slack/real_time/stores.rb

@@ -0,0 +1,10 @@
+require 'slack/real_time/stores/base'
+require 'slack/real_time/stores/starter'
+require 'slack/real_time/stores/store'
+
+module Slack
+  module RealTime
+    class Store < Stores::Store
+    end
+  end
+end

data/lib/slack/real_time/stores/base.rb

@@ -0,0 +1,34 @@
+module Slack
+  module RealTime
+    module Stores
+      # Doesn't store anything.
+      class Base
+        class_attribute :events
+
+        attr_accessor :users
+        attr_accessor :bots
+        attr_accessor :channels
+        attr_accessor :groups
+        attr_accessor :teams
+        attr_accessor :ims
+
+        def self
+          nil
+        end
+
+        def team
+          nil
+        end
+
+        def initialize(_attrs)
+        end
+
+        def self.on(event, &block)
+          self.events ||= {}
+          self.events[event.to_s] ||= []
+          self.events[event.to_s] << block
+        end
+      end
+    end
+  end
+end

data/lib/slack/real_time/stores/starter.rb

@@ -0,0 +1,361 @@
+module Slack
+  module RealTime
+    module Stores
+      # Only stores initial information.
+      class Starter < Base
+        attr_reader :self
+
+        attr_reader :team
+
+        def initialize(attrs)
+          @team = Models::Team.new(attrs.team)
+          @self = Models::Team.new(attrs.self)
+        end
+
+        ### RealTime Events
+
+        # A channel member is typing a message.
+        # @see https://api.slack.com/events/user_typing
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/user_typing.json
+        # on :user_typing do |data|
+
+        # A team member's data has changed.
+        # @see https://api.slack.com/events/user_change
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/user_change.json
+        # on :user_change do |data|
+
+        # A new team member has joined.
+        # @see https://api.slack.com/events/team_join
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/team_join.json
+        # on :team_join do |data|
+
+        # An existing user group has been updated or its members changed.
+        # @see https://api.slack.com/events/subteam_updated
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/subteam_updated.json
+        # on :subteam_updated do |data|
+
+        # You have been removed from a user group.
+        # @see https://api.slack.com/events/subteam_self_removed
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/subteam_self_removed.json
+        # on :subteam_self_removed do |data|
+
+        # You have been added to a user group.
+        # @see https://api.slack.com/events/subteam_self_added
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/subteam_self_added.json
+        # on :subteam_self_added do |data|
+
+        # A user group has been added to the team.
+        # @see https://api.slack.com/events/subteam_created
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/subteam_created.json
+        # on :subteam_created do |data|
+
+        # A team member removed a star.
+        # @see https://api.slack.com/events/star_removed
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/star_removed.json
+        # on :star_removed do |data|
+
+        # A team member has starred an item.
+        # @see https://api.slack.com/events/star_added
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/star_added.json
+        # on :star_added do |data|
+
+        # Experimental.
+        # @see https://api.slack.com/events/reconnect_url
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/reconnect_url.json
+        # on :reconnect_url do |data|
+
+        # A team member removed an emoji reaction.
+        # @see https://api.slack.com/events/reaction_removed
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/reaction_removed.json
+        # on :reaction_removed do |data|
+
+        # A team member has added an emoji reaction to an item.
+        # @see https://api.slack.com/events/reaction_added
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/reaction_added.json
+        # on :reaction_added do |data|
+
+        # A team member's presence changed.
+        # @see https://api.slack.com/events/presence_change
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/presence_change.json
+        # on :presence_change do |data|
+
+        # You have updated your preferences.
+        # @see https://api.slack.com/events/pref_change
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/pref_change.json
+        # on :pref_change do |data|
+
+        # A pin was removed from a channel.
+        # @see https://api.slack.com/events/pin_removed
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/pin_removed.json
+        # on :pin_removed do |data|
+
+        # A pin was added to a channel.
+        # @see https://api.slack.com/events/pin_added
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/pin_added.json
+        # on :pin_added do |data|
+
+        # You manually updated your presence.
+        # @see https://api.slack.com/events/manual_presence_change
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/manual_presence_change.json
+        # on :manual_presence_change do |data|
+
+        # You opened a direct message channel.
+        # @see https://api.slack.com/events/im_open
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/im_open.json
+        # on :im_open do |data|
+
+        # A direct message read marker was updated.
+        # @see https://api.slack.com/events/im_marked
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/im_marked.json
+        # on :im_marked do |data|
+
+        # Bulk updates were made to a DM channel's history.
+        # @see https://api.slack.com/events/im_history_changed
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/im_history_changed.json
+        # on :im_history_changed do |data|
+
+        # A direct message channel was created.
+        # @see https://api.slack.com/events/im_created
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/im_created.json
+        # on :im_created do |data|
+
+        # You closed a direct message channel.
+        # @see https://api.slack.com/events/im_close
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/im_close.json
+        # on :im_close do |data|
+
+        # A private group was unarchived.
+        # @see https://api.slack.com/events/group_unarchive
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/group_unarchive.json
+        # on :group_unarchive do |data|
+
+        # A private group was renamed.
+        # @see https://api.slack.com/events/group_rename
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/group_rename.json
+        # on :group_rename do |data|
+
+        # You opened a group channel.
+        # @see https://api.slack.com/events/group_open
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/group_open.json
+        # on :group_open do |data|
+
+        # A private group read marker was updated.
+        # @see https://api.slack.com/events/group_marked
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/group_marked.json
+        # on :group_marked do |data|
+
+        # You left a private group.
+        # @see https://api.slack.com/events/group_left
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/group_left.json
+        # on :group_left do |data|
+
+        # You joined a private group.
+        # @see https://api.slack.com/events/group_joined
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/group_joined.json
+        # on :group_joined do |data|
+
+        # Bulk updates were made to a group's history.
+        # @see https://api.slack.com/events/group_history_changed
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/group_history_changed.json
+        # on :group_history_changed do |data|
+
+        # You closed a group channel.
+        # @see https://api.slack.com/events/group_close
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/group_close.json
+        # on :group_close do |data|
+
+        # A private group was archived.
+        # @see https://api.slack.com/events/group_archive
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/group_archive.json
+        # on :group_archive do |data|
+
+        # A file was unshared.
+        # @see https://api.slack.com/events/file_unshared
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/file_unshared.json
+        # on :file_unshared do |data|
+
+        # A file was shared.
+        # @see https://api.slack.com/events/file_shared
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/file_shared.json
+        # on :file_shared do |data|
+
+        # A file was made public.
+        # @see https://api.slack.com/events/file_public
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/file_public.json
+        # on :file_public do |data|
+
+        # A file was made private.
+        # @see https://api.slack.com/events/file_private
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/file_private.json
+        # on :file_private do |data|
+
+        # A file was deleted.
+        # @see https://api.slack.com/events/file_deleted
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/file_deleted.json
+        # on :file_deleted do |data|
+
+        # A file was created.
+        # @see https://api.slack.com/events/file_created
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/file_created.json
+        # on :file_created do |data|
+
+        # A file comment was edited.
+        # @see https://api.slack.com/events/file_comment_edited
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/file_comment_edited.json
+        # on :file_comment_edited do |data|
+
+        # A file comment was deleted.
+        # @see https://api.slack.com/events/file_comment_deleted
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/file_comment_deleted.json
+        # on :file_comment_deleted do |data|
+
+        # A file comment was added.
+        # @see https://api.slack.com/events/file_comment_added
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/file_comment_added.json
+        # on :file_comment_added do |data|
+
+        # A file was changed.
+        # @see https://api.slack.com/events/file_change
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/file_change.json
+        # on :file_change do |data|
+
+        # A team custom emoji has been added or changed.
+        # @see https://api.slack.com/events/emoji_changed
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/emoji_changed.json
+        # on :emoji_changed do |data|
+
+        # Do not Disturb settings changed for a team member.
+        # @see https://api.slack.com/events/dnd_updated_user
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/dnd_updated_user.json
+        # on :dnd_updated_user do |data|
+
+        # Do not Disturb settings changed for the current user.
+        # @see https://api.slack.com/events/dnd_updated
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/dnd_updated.json
+        # on :dnd_updated do |data|
+
+        # A team slash command has been added or changed.
+        # @see https://api.slack.com/events/commands_changed
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/commands_changed.json
+        # on :commands_changed do |data|
+
+        # A team channel was unarchived.
+        # @see https://api.slack.com/events/channel_unarchive
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/channel_unarchive.json
+        # on :channel_unarchive do |data|
+
+        # A team channel was renamed.
+        # @see https://api.slack.com/events/channel_rename
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/channel_rename.json
+        # on :channel_rename do |data|
+
+        # Your channel read marker was updated.
+        # @see https://api.slack.com/events/channel_marked
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/channel_marked.json
+        # on :channel_marked do |data|
+
+        # You left a channel.
+        # @see https://api.slack.com/events/channel_left
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/channel_left.json
+        # on :channel_left do |data|
+
+        # You joined a channel.
+        # @see https://api.slack.com/events/channel_joined
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/channel_joined.json
+        # on :channel_joined do |data|
+
+        # Bulk updates were made to a channel's history.
+        # @see https://api.slack.com/events/channel_history_changed
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/channel_history_changed.json
+        # on :channel_history_changed do |data|
+
+        # A team channel was deleted.
+        # @see https://api.slack.com/events/channel_deleted
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/channel_deleted.json
+        # on :channel_deleted do |data|
+
+        # 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
+        # on :channel_created do |data|
+
+        # 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
+        # on :channel_archive do |data|
+
+        # 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
+        # on :bot_changed do |data|
+
+        # 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
+        # on :bot_added do |data|
+
+        # 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
+        # on :accounts_changed do |data|
+
+        # The team domain has changed.
+        # @see https://api.slack.com/events/team_domain_change
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/team_domain_change.json
+        on :team_domain_change do |data|
+          team.url = data.url
+          team.domain = data.domain
+        end
+
+        # The team is being migrated between servers.
+        # @see https://api.slack.com/events/team_migration_started
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/team_migration_started.json
+        # on :team_migration_started do |data|
+
+        # The team billing plan has changed.
+        # @see https://api.slack.com/events/team_plan_change
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/team_plan_change.json
+        on :team_plan_change do |data|
+          team.plan = data.plan
+        end
+
+        # A team preference has been updated.
+        # @see https://api.slack.com/events/team_pref_change
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/team_pref_change.json
+        on :team_pref_change do |data|
+          team.prefs ||= {}
+          team.prefs[data.name] = data.value
+        end
+
+        # Team profile fields have been updated.
+        # @see https://api.slack.com/events/team_profile_change
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/team_profile_change.json
+        # on :team_profile_change do |data|
+
+        # Team profile fields have been deleted.
+        # @see https://api.slack.com/events/team_profile_delete
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/team_profile_delete.json
+        # on :team_profile_delete do |data|
+
+        # Team profile fields have been reordered.
+        # @see https://api.slack.com/events/team_profile_reorder
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/team_profile_reorder.json
+        # on :team_profile_reorder do |data|
+
+        # The team name has changed.
+        # @see https://api.slack.com/events/team_rename
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/team_rename.json
+        on :team_rename do |data|
+          team.name = data.name
+        end
+
+        # The team email domain has changed.
+        # @see https://api.slack.com/events/email_domain_changed
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/email_domain_changed.json
+        on :email_domain_changed do |data|
+          team.email_domain = data.email_domain
+        end
+      end
+    end
+  end
+end