slack-ruby-client 1.0.0 → 2.1.0

data/bin/slack

@@ -2,50 +2,55 @@
 require 'gli'
 require 'slack_ruby_client'
 
-include GLI::App
-
-program_desc 'Slack client.'
-
-default_command :help
-
-switch %i[d debug], desc: 'Enable debug-level logging.', default_value: false
-flag [:t, 'slack-api-token'], desc: 'Slack API token.', default_value: ENV['SLACK_API_TOKEN']
-flag ['vcr-cassette-name'], desc: 'Offline VCR cassette.'
-
-pre do |global_options, _command, options, _args|
-  # global Slack configuration
-  Slack.config.token = global_options['slack-api-token']
-  help_now! 'Set Slack API token via --slack-api-token or SLACK_API_TOKEN.' unless Slack.config.token && !Slack.config.token.empty?
-
-  if global_options['debug']
-    require 'logger'
-    logger = Logger.new(STDOUT)
-    logger.level = Logger::DEBUG
-    Slack::Web::Client.config.logger = logger
-  end
-
-  $client = Slack::Web::Client.new
-
-  # Offline VCR cassette
-  if global_options['vcr-cassette-name']
-    require 'webmock'
-    WebMock.enable!
-    require 'vcr'
-    VCR.configure do |config|
-      config.cassette_library_dir = 'spec/fixtures/slack'
-      config.hook_into :webmock
-      config.default_cassette_options = { record: :new_episodes }
+module Slack
+  module Cli
+    class App
+      extend GLI::App
+
+      program_desc 'Slack client.'
+
+      default_command :help
+
+      switch %i[d debug], desc: 'Enable debug-level logging.', default_value: false
+      flag [:t, 'slack-api-token'], desc: 'Slack API token.', default_value: ENV['SLACK_API_TOKEN']
+      flag ['vcr-cassette-name'], desc: 'Offline VCR cassette.'
+
+      commands_from File.expand_path('commands', __dir__)
+
+      pre do |global_options, _command, options, _args|
+        # global Slack configuration
+        Slack.config.token = global_options['slack-api-token']
+        help_now! 'Set Slack API token via --slack-api-token or SLACK_API_TOKEN.' unless Slack.config.token && !Slack.config.token.empty?
+
+        if global_options['debug']
+          require 'logger'
+          logger = Logger.new(STDOUT)
+          logger.level = Logger::DEBUG
+          Slack::Web::Client.config.logger = logger
+        end
+
+        @client = Slack::Web::Client.new
+
+        # Offline VCR cassette
+        if global_options['vcr-cassette-name']
+          require 'webmock'
+          WebMock.enable!
+          require 'vcr'
+          VCR.configure do |config|
+            config.cassette_library_dir = 'spec/fixtures/slack'
+            config.hook_into :webmock
+            config.default_cassette_options = { record: :new_episodes }
+          end
+          VCR.insert_cassette global_options['vcr-cassette-name']
+        end
+
+        # remove any nil values from options
+        options.compact!
+
+        true
+      end
     end
-    VCR.insert_cassette global_options['vcr-cassette-name']
   end
-
-  # remove any nil values from options
-  options.select! { |_k, v| v }
-
-  true
 end
 
-$LOAD_PATH.push File.expand_path(__dir__)
-require 'commands'
-
-exit run(ARGV)
+exit Slack::Cli::App.run(ARGV)

data/lib/slack/real_time/api/message.rb

@@ -12,8 +12,9 @@ module Slack
         # @option options [Object] :text
         #   Text of the message to send. See below for an explanation of formatting.
         def message(options = {})
-          throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
-          throw ArgumentError.new('Required arguments :text missing') if options[:text].nil?
+          raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil?
+          raise ArgumentError, 'Required arguments :text missing' if options[:text].nil?
+
           send_json({ type: 'message', id: next_id }.merge(options))
         end
       end

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

@@ -1,4 +1,8 @@
         # <%= desc %>
         # @see https://api.slack.com/events/<%= name %>
         # @see https://github.com/slack-ruby/slack-api-ref/blob/master/events/<%= name %>.json
-        # on :<%= name %> do |data|
+<% if hook %>
+<%= hook %>
+<% else %>
+          # on :<%= name %> do |data|
+<% end %>

data/lib/slack/real_time/api/typing.rb

@@ -10,7 +10,8 @@ module Slack
         #   Channel to send message to. Can be a public channel, private group or IM channel.
         #   Can be an encoded ID, or a name.
         def typing(options = {})
-          throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
+          raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil?
+
           send_json({ type: 'typing', id: next_id }.merge(options))
         end
       end

data/lib/slack/real_time/client.rb

@@ -11,15 +11,9 @@ module Slack
       include Api::Message
       include Api::Typing
 
-      @events = {}
-
-      class << self
-        attr_accessor :events
-      end
-
       attr_accessor :web_client, :store, :url, *Config::ATTRIBUTES
 
-      protected :store_class, :store_class=
+      protected :store_class, :store_class=, :store_options, :store_options=
 
       def initialize(options = {})
         @callbacks = Hash.new { |h, k| h[k] = [] }
@@ -31,7 +25,7 @@ module Slack
         @web_client = Slack::Web::Client.new(token: token, logger: logger)
       end
 
-      %i[users self channels team teams groups ims bots].each do |store_method|
+      [:self, :team, *Stores::Base::CACHES].each do |store_method|
         define_method store_method do
           store&.send(store_method)
         end
@@ -44,7 +38,7 @@ module Slack
 
       # Start RealTime client and block until it disconnects.
       def start!(&block)
-        @callback = block if block_given?
+        @callback = block if block
         build_socket
         @socket.start_sync(self)
       end
@@ -52,7 +46,7 @@ module Slack
       # Start RealTime client and return immediately.
       # The RealTime::Client will run in the background.
       def start_async(&block)
-        @callback = block if block_given?
+        @callback = block if block
         build_socket
         @socket.start_async(self)
       end
@@ -162,10 +156,10 @@ module Slack
       def restart_async
         logger.debug("#{self}##{__method__}")
         @socket.close
-        start = web_client.send(rtm_start_method, start_options)
+        start = web_client.rtm_connect(start_options)
         data = Slack::Messages::Message.new(start)
         @url = data.url
-        @store = @store_class.new(data) if @store_class
+        @store = store_class.new(data, store_options.to_h) if store_class
         @socket.restart_async(self, @url)
       end
 
@@ -173,23 +167,13 @@ module Slack
       def build_socket
         raise ClientAlreadyStartedError if started?
 
-        start = web_client.send(rtm_start_method, start_options)
+        start = web_client.rtm_connect(start_options)
         data = Slack::Messages::Message.new(start)
         @url = data.url
-        @store = @store_class.new(data) if @store_class
+        @store = store_class.new(data, store_options.to_h) if store_class
         @socket = socket_class.new(@url, socket_options)
       end
 
-      def rtm_start_method
-        if start_method
-          start_method
-        elsif @store_class && @store_class <= Slack::RealTime::Stores::Store
-          :rtm_start
-        else
-          :rtm_connect
-        end
-      end
-
       def socket_options
         socket_options = {}
         socket_options[:ping] = websocket_ping if websocket_ping
@@ -249,11 +233,9 @@ module Slack
       end
 
       def run_handlers(type, data)
-        return unless store.class.events
-
         handlers = store.class.events[type.to_s]
-        handlers&.each do |handler|
-          store.instance_exec(data, &handler)
+        handlers.each do |handler|
+          store.instance_exec(data, self, &handler)
         end
       rescue StandardError => e
         logger.error("#{self}##{__method__}") { e }

data/lib/slack/real_time/config.rb

@@ -11,9 +11,9 @@ module Slack
         websocket_ping
         websocket_proxy
         concurrency
-        start_method
         start_options
         store_class
+        store_options
         logger
       ].freeze
 
@@ -25,9 +25,9 @@ module Slack
         self.websocket_proxy = nil
         self.token = nil
         self.concurrency = method(:detect_concurrency)
-        self.start_method = nil
         self.start_options = { request: { timeout: 180 } }
-        self.store_class = Slack::RealTime::Store
+        self.store_class = Slack::RealTime::Stores::Starter
+        self.store_options = {}
         self.logger = nil
       end
 

data/lib/slack/real_time/models/channel.rb

@@ -1,8 +1,12 @@
 # frozen_string_literal: true
+
 module Slack
   module RealTime
     module Models
       class Channel < Base
+        def is_public? # rubocop:disable Naming/PredicateName
+          !is_private?
+        end
       end
     end
   end

data/lib/slack/real_time/models/{group.rb → mpim.rb}

@@ -2,7 +2,7 @@
 module Slack
   module RealTime
     module Models
-      class Group < Base
+      class Mpim < Base
       end
     end
   end

data/lib/slack/real_time/models.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
+
 require_relative 'models/base'
 require_relative 'models/user'
 require_relative 'models/bot'
 require_relative 'models/channel'
-require_relative 'models/group'
 require_relative 'models/team'
 require_relative 'models/im'
+require_relative 'models/mpim'

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

@@ -1,14 +1,36 @@
 # frozen_string_literal: true
+
 module Slack
   module RealTime
     module Stores
       # Doesn't store anything.
       class Base
+        CACHES = %i[
+          teams
+          users
+          bots
+          public_channels
+          private_channels
+          ims
+          mpims
+        ].freeze
+
+        @events = Hash.new { |h, k| h[k] = [] }
+
         class << self
-          attr_accessor :events
+          attr_reader :events
+
+          def inherited(subclass)
+            super
+            subclass.instance_variable_set :@events, events.dup
+          end
+
+          def on(event, &handler)
+            events[event.to_s] << handler
+          end
         end
 
-        attr_accessor :users, :bots, :channels, :groups, :teams, :ims
+        attr_accessor(*CACHES)
 
         def self
           nil
@@ -18,13 +40,7 @@ module Slack
           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
+        def initialize(_attrs, _options = {}); end
       end
     end
   end