slack-ruby-client 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b713ee1b5bbc32bbb54b434199c8245d1edcc528
-  data.tar.gz: 7122943dc5dabf15ccf656be06b3df08c24e39ba
+  metadata.gz: f0aaadcdcd3f329bb20548b8041a631bb8a28519
+  data.tar.gz: 27a9e84d26d1934ee603972453f370102554cdce
 SHA512:
-  metadata.gz: 8e9b7148626db6c19db75a8688f6f4233158ce7dc7162d084525516ceb8d458e14a8a2dca875d64ac88cad5913e60f3923b28038b54201de7bfa28bb625cb99d
-  data.tar.gz: 464204c4a4285827791b0c166d958f2fafe7cdadc38af68e40f3db8798e746fd78f70eed0dc5c649f93c8523a2fe8bdda6328ee75456d872cffa7201f1b7fc48
+  metadata.gz: a26e4b6f75a481faa9ff2c2b1d45a0f6922aca6784fa88f0f5772a8ad24df56676cc694e595a7fbdeb6a21fdfcb7a74ed0d9c5b5a54cb76b6b5a8747fcf8490f
+  data.tar.gz: 70c7e4981a819f91e425a4ba19a1769aad0f5260b0b15a8a2b55085eea824bee75c50e18845e89e91265cbdc4b72e91aa34bb2592629a2b7047639ba988d6dbc

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2016-02-02 17:03:58 -0500 using RuboCop version 0.35.0.
+# on 2016-02-29 14:50:42 -0500 using RuboCop version 0.35.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -21,26 +21,34 @@ Lint/UnusedBlockArgument:
   Exclude:
     - 'lib/slack/messages/formatting.rb'
 
-# Offense count: 12
+# Offense count: 14
 Metrics/AbcSize:
-  Max: 31
+  Max: 44
 
-# Offense count: 1
+# Offense count: 2
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 131
+  Max: 159
 
-# Offense count: 586
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 9
+
+# Offense count: 542
 # Configuration parameters: AllowURI, URISchemes.
 Metrics/LineLength:
   Max: 288
 
-# Offense count: 6
+# Offense count: 8
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 24
+  Max: 32
 
-# Offense count: 80
+# Offense count: 1
+Metrics/PerceivedComplexity:
+  Max: 11
+
+# Offense count: 52
 # Configuration parameters: Exclude.
 Style/Documentation:
   Enabled: false
@@ -51,18 +59,12 @@ Style/FileName:
   Exclude:
     - 'lib/slack-ruby-client.rb'
 
-# Offense count: 90
+# Offense count: 92
 # Configuration parameters: AllowedVariables.
 Style/GlobalVars:
   Enabled: false
 
-# Offense count: 1
-# Configuration parameters: MinBodyLength.
-Style/GuardClause:
-  Exclude:
-    - 'lib/slack/real_time/store.rb'
-
-# Offense count: 15
+# Offense count: 17
 # Configuration parameters: EnforcedStyle, SupportedStyles.
 Style/MethodName:
   Enabled: false

data/.travis.yml

@@ -3,6 +3,7 @@ language: ruby
 cache: bundler
 
 rvm:
+  - 2.3.0
   - 2.2
   - 2.1
   - 2.0

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+### 0.7.0 (3/6/2016)
+
+* [#68](https://github.com/dblock/slack-ruby-client/issues/68): The `Slack::RealTime::Config#store_class` is now globally configurable - [@dblock](https://github.com/dblock).
+* [#67](https://github.com/dblock/slack-ruby-client/pull/67): Make `logger` configurable and log HTTP requests and responses as well as RealTime events and socket data - [@mikz](https://github.com/mikz), [@dblock](https://github.com/dblock).
+* Added `Slack::RealTime::Stores::Store` and `Slack::RealTime::Stores::Starter` - [@dblock](https://github.com/dblock).
+* Added `files_revokePublicURL` and `files_sharedPublicURL` to Web API - [@dblock](https://github.com/dblock).
+* [#60](https://github.com/dblock/slack-ruby-client/issues/60): Exceptions in event handlers and commands are no longer fatal - [@dblock](https://github.com/dblock).
+
 ### 0.6.0 (2/4/2016)
 
 * [#54](https://github.com/dblock/slack-ruby-client/issues/54): RealTime client maintains a local store of team data for `client.self`, `team`, `users`, `channels`, `groups`, `ims` and `bots` data - [@dblock](https://github.com/dblock).

data/README.md

@@ -18,7 +18,7 @@ A Ruby client for the Slack [Web](https://api.slack.com/web) and [RealTime Messa
 
 ## Stable Release
 
-You're reading the documentation for the **stable** release of slack-ruby-client, 0.6.0. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
+You're reading the documentation for the **stable** release of slack-ruby-client, 0.7.0. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
 
 ## Installation
 
@@ -55,6 +55,15 @@ end
 
 This sets a global default token. You can also pass a token into the initializer of both `Slack::Web::Client` and `Slack::RealTime::Client` or configure those separately via `Slack::Web::Config.configure` and `Slack::RealTime::Config.configure`. The instance token will be used over the client type token over the global default.
 
+### Global Settings
+
+The following global settings are supported via `Slack.configure`.
+
+setting      | description
+-------------|-------------------------------------------------------------------------------------------------
+token        | Slack API token.
+logger       | An optional logger, defaults to `::Logger.new(STDOUT)` at `Logger::WARN` level.
+
 ### Web Client
 
 The Slack Web API allows you to build applications that interact with Slack.
@@ -215,7 +224,17 @@ bots     | Details of the integrations set up on this team.
 
 It also tracks changes, such as users being renamed, added or deleted, therefore `client.users` is always up-to-date.
 
-Tracking with a local store can be disabled with `Slack::RealTime::Client.new(store_class: nil)`
+Tracking with a local store can be disabled with `Slack::RealTime::Client.new(store_class: nil)`. Other stores are also available.
+
+#### Slack::RealTime::Stores::Store
+
+The default store that tracks all changes.
+
+#### Slack::RealTime::Stores::Starter
+
+A smaller store that only stores and tracks information about the bot user, but not channels, users, groups, ims or bots.
+
+### Configuring Slack::RealTime::Client
 
 You can configure the RealTime client either globally or via the initializer.
 
@@ -236,10 +255,11 @@ setting         | description
 token           | Slack API token.
 websocket_ping  | The number of seconds that indicates how often the WebSocket should send ping frames, default is 30.
 websocket_proxy | Connect via proxy, include `:origin` and `:headers`.
-store_class     | Local store class name, default is an in-memory `Slack::RealTime::Store`.
+store_class     | Local store class name, default is an in-memory `Slack::RealTime::Stores::Store`.
 start_options   | Options to pass into `rtm.start`, default is `{}`.
+logger          | Optional `Logger` instance that logs RealTime requests and socket data.
 
-Note that the RealTime client uses a Web client to obtain the WebSocket URL via [rtm.start](https://api.slack.com/methods/rtm.start), configure Web client options via `Slack::Web::Client.configure` as described above.
+Note that the RealTime client uses a Web client to obtain the WebSocket URL via [rtm.start](https://api.slack.com/methods/rtm.start). While `token` and `logger` options are passed down from the RealTime client, you may also configure Web client options via `Slack::Web::Client.configure` as described above.
 
 See a fully working example in [examples/hi_real_time](examples/hi_real_time/hi.rb).
 

data/bin/commands/chat.rb

@@ -17,29 +17,30 @@ command 'chat' do |g|
   g.command 'postMessage' do |c|
     c.flag 'channel', desc: 'Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name. See below for more details.'
     c.flag 'text', desc: 'Text of the message to send. See below for an explanation of formatting.'
-    c.flag 'username', desc: 'Name of bot.'
-    c.flag 'as_user', desc: 'Pass true to post the message as the authed user, instead of as a bot.'
-    c.flag 'parse', desc: 'Change how messages are treated. See below.'
+    c.flag 'parse', desc: 'Change how messages are treated. Defaults to none. See below.'
     c.flag 'link_names', desc: 'Find and link channel names and usernames.'
     c.flag 'attachments', desc: 'Structured message attachments.'
     c.flag 'unfurl_links', desc: 'Pass true to enable unfurling of primarily text-based content.'
     c.flag 'unfurl_media', desc: 'Pass false to disable unfurling of media content.'
-    c.flag 'icon_url', desc: 'URL to an image to use as the icon for this message.'
-    c.flag 'icon_emoji', desc: 'emoji to use as the icon for this message. Overrides icon_url.'
+    c.flag 'username', desc: "Set your bot's user name. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below."
+    c.flag 'as_user', desc: 'Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See authorship below.'
+    c.flag 'icon_url', desc: 'URL to an image to use as the icon for this message. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.'
+    c.flag 'icon_emoji', desc: 'emoji to use as the icon for this message. Overrides icon_url. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.chat_postMessage(options))
     end
   end
 
-  g.desc 'This method updates a message in a channel.'
-  g.long_desc %( This method updates a message in a channel. )
+  g.desc 'This method updates a message in a channel. Though related to chat.postMessage, some parameters of chat.update are handled differently.'
+  g.long_desc %( This method updates a message in a channel. Though related to chat.postMessage, some parameters of chat.update are handled differently. )
   g.command 'update' do |c|
     c.flag 'ts', desc: 'Timestamp of the message to be updated.'
     c.flag 'channel', desc: 'Channel containing the message to be updated.'
     c.flag 'text', desc: 'New text for the message, using the default formatting rules.'
     c.flag 'attachments', desc: 'Structured message attachments.'
-    c.flag 'parse', desc: 'Change how messages are treated. See below.'
-    c.flag 'link_names', desc: 'Find and link channel names and usernames.'
+    c.flag 'parse', desc: 'Change how messages are treated. Defaults to client, unlike chat.postMessage. See below.'
+    c.flag 'link_names', desc: 'Find and link channel names and usernames. Defaults to none. This parameter should be used in conjunction with parse. To set link_names to 1, specify a parse mode of full.'
+    c.flag 'as_user', desc: 'Pass true to update the message as the authed user. Bot users in this context are considered authed users.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.chat_update(options))
     end

data/bin/commands/files.rb

@@ -25,7 +25,7 @@ command 'files' do |g|
   g.desc 'This method returns information about a file in your team.'
   g.long_desc %( This method returns information about a file in your team. )
   g.command 'info' do |c|
-    c.flag 'file', desc: 'File to fetch info for.'
+    c.flag 'file', desc: 'Specify a file by providing its ID.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.files_info(options))
     end
@@ -56,6 +56,24 @@ You can pass multiple values in the types argument, like types=posts,snippets.Th
     end
   end
 
+  g.desc 'This method disables public/external sharing for a file.'
+  g.long_desc %( This method disables public/external sharing for a file. )
+  g.command 'revokePublicURL' do |c|
+    c.flag 'file', desc: 'File to revoke.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.files_revokePublicURL(options))
+    end
+  end
+
+  g.desc 'This method enables public/external sharing for a file.'
+  g.long_desc %( This method enables public/external sharing for a file. )
+  g.command 'sharedPublicURL' do |c|
+    c.flag 'file', desc: 'File to share.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.files_sharedPublicURL(options))
+    end
+  end
+
   g.desc 'This method allows you to create or upload an existing file.'
   g.long_desc %( This method allows you to create or upload an existing file. )
   g.command 'upload' do |c|

data/examples/hi_real_time/hi.rb

@@ -2,6 +2,8 @@ require 'slack-ruby-client'
 
 Slack.configure do |config|
   config.token = ENV['SLACK_API_TOKEN']
+  config.logger = Logger.new(STDOUT)
+  config.logger.level = Logger::WARN
   fail 'Missing ENV[SLACK_API_TOKEN]!' unless config.token
 end
 

data/lib/slack-ruby-client.rb

@@ -1,4 +1,5 @@
 require 'slack/version'
+require 'slack/logger'
 require 'slack/config'
 
 # Messages
@@ -26,6 +27,8 @@ require 'slack/web/api/endpoints'
 require 'slack/web/client'
 
 # RealTime API
+require 'active_support'
+require 'active_support/core_ext'
 require 'slack/real_time/concurrency'
 require 'slack/real_time/socket'
 require 'slack/real_time/api/message_id'
@@ -33,7 +36,6 @@ 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/stores'
 require 'slack/real_time/config'
 require 'slack/real_time/client'
-require 'slack/real_time/store'
-require 'slack/real_time/event_handlers'

data/lib/slack/config.rb

@@ -3,10 +3,14 @@ module Slack
     extend self
 
     attr_accessor :token
+    attr_accessor :logger
 
     def reset
       self.token = nil
+      self.logger = nil
     end
+
+    reset
   end
 
   class << self

data/lib/slack/logger.rb

@@ -0,0 +1,13 @@
+require 'logger'
+
+module Slack
+  class Logger < ::Logger
+    def self.default
+      @logger ||= begin
+        logger = new STDOUT
+        logger.level = Logger::WARN
+        logger
+      end
+    end
+  end
+end

data/lib/slack/messages/message.rb

@@ -4,6 +4,12 @@ module Slack
       def presence
         super['presence']
       end
+
+      def to_s
+        keys.sort_by(&:to_s).map do |key|
+          "#{key}=#{self[key]}"
+        end.join(', ')
+      end
     end
   end
 end

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

@@ -20,3 +20,4 @@
     }
   }
 }
+

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

@@ -1,18 +1,4 @@
-# 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 %>
+        # <%= desc %>
+        # @see https://api.slack.com/events/<%= name %>
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/<%= name %>.json
+        # on :<%= name %> do |data|

data/lib/slack/real_time/client.rb

@@ -20,14 +20,17 @@ module Slack
       attr_accessor :url
       attr_accessor(*Config::ATTRIBUTES)
 
+      protected :logger, :logger=
+      protected :store_class, :store_class=
+
       def initialize(options = {})
         @callbacks = Hash.new { |h, k| h[k] = [] }
         Slack::RealTime::Config::ATTRIBUTES.each do |key|
-          send("#{key}=", options[key] || Slack::RealTime.config.send(key))
+          send("#{key}=", options.key?(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)
+        @logger ||= (Slack::Config.logger || Slack::Logger.default)
+        @web_client = Slack::Web::Client.new(token: token, logger: logger)
       end
 
       [:users, :self, :channels, :team, :teams, :groups, :ims, :bots].each do |store_method|
@@ -91,6 +94,7 @@ module Slack
         socket_options = {}
         socket_options[:ping] = websocket_ping if websocket_ping
         socket_options[:proxy] = websocket_proxy if websocket_proxy
+        socket_options[:logger] = logger
         socket_options
       end
 
@@ -101,15 +105,18 @@ module Slack
           yield driver if block_given?
 
           driver.on :open do |event|
+            logger.debug("#{self.class}##{__method__}") { event.class.name }
             open(event)
             callback(event, :open)
           end
 
           driver.on :message do |event|
+            logger.debug("#{self.class}##{__method__}") { "#{event.class}, #{event.data}" }
             dispatch(event)
           end
 
           driver.on :close do |event|
+            logger.debug("#{self.class}##{__method__}") { event.class.name }
             callback(event, :close)
             close(event)
           end
@@ -123,6 +130,7 @@ module Slack
 
       def send_json(data)
         fail ClientNotStartedError unless started?
+        logger.debug("#{self.class}##{__method__}") { data }
         @socket.send_data(data.to_json)
       end
 
@@ -144,6 +152,10 @@ module Slack
         callbacks.each do |c|
           c.call(event)
         end
+        true
+      rescue StandardError => e
+        logger.error e
+        false
       end
 
       def dispatch(event)
@@ -152,13 +164,22 @@ module Slack
         type = data.type
         return false unless type
         type = type.to_s
+        logger.debug("#{self.class}##{__method__}") { data.to_s }
         run_handlers(type, data) if @store
         run_callbacks(type, data)
+      rescue StandardError => e
+        logger.error e
+        false
       end
 
       def run_handlers(type, data)
-        handler = Slack::RealTime::Client.events[type]
-        handler.call(self, data) if handler
+        handlers = store.class.events[type.to_s]
+        handlers.each do |handler|
+          store.instance_exec(data, &handler)
+        end if handlers
+      rescue StandardError => e
+        logger.error e
+        false
       end
 
       def run_callbacks(type, data)
@@ -168,6 +189,9 @@ module Slack
           c.call(data)
         end
         true
+      rescue StandardError => e
+        logger.error e
+        false
       end
     end
   end

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

@@ -41,9 +41,15 @@ module Slack
 
           def read
             buffer = socket.readpartial(BLOCK_SIZE)
+            logger.debug("#{self.class}##{__method__}") { buffer }
             driver.parse buffer
           end
 
+          def write(data)
+            logger.debug("#{self.class}##{__method__}") { data }
+            socket.write(data)
+          end
+
           def start_async
             future = yield self if block_given?