slacks 0.5.0.pre → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3fa3ec9c05fdbe56d801c27cb5acbe5d879c07f7
-  data.tar.gz: 348dc602d884498580f7d72f9fba829333ab087e
+SHA256:
+  metadata.gz: e3f9538fbc719ad833d0027f5d2edb32e5c7ee3d991cb3596bb5217e58f02ba6
+  data.tar.gz: 418e0f974c5728e735c560e020429041f0c0af437201721d9d98a423b5db790a
 SHA512:
-  metadata.gz: aa37ba98e00e52d176b5481cca8793d710cc2f068242e448e1b20052d3da3654503008fd6efecf2a9ec21b230f8a4d4c13fb3fd404a79cb981262e35c5b581fd
-  data.tar.gz: 978735f54f957ee598631502c914f544aa3666f5a87ebe5f85da1c8bdea80e00b7c1331e49e2415f1749d03afab0e023c715b7c7177db5c43a442286ce5b66d1
+  metadata.gz: 6d47f55bf02c06928f9a3b7da4c1dd8968455550b9096db030945fb804cdaf9912f8b491e2782df45838b3a9ac6b82938a1edf7509e379ae8d7a7742150217f8
+  data.tar.gz: 46bc171a39e21778e9aeb1a2af25e081cc607178935cf4a8c130a5e19b777645e38199920b1b866d550f7d4ade5a316f6424dc0003a272eb2369e24c2cb50e87

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+### v0.6.2
+- Fixed a regression where groups, DMs, and private channels were not fetched
+
+### v0.6.1
+- Fixed a typo with creating a DM associated with a user
+
+### v0.6.0
+- Switched to using the Slack Conversations API

data/lib/slacks/channel.rb

@@ -12,17 +12,12 @@ module Slacks
     end
 
     def reply(*messages)
-      messages.flatten!
       return unless messages.any?
 
-      first_message = messages.shift
-      message_options = {}
-      message_options = messages.shift if messages.length == 1 && messages[0].is_a?(Hash)
-      slack.send_message(first_message, message_options.merge(channel: id))
-
-      messages.each do |message|
-        sleep message.length / slack.typing_speed
-        slack.send_message(message, channel: id)
+      if messages.first.is_a?(Array)
+        reply_many(messages[0])
+      else
+        reply_one(*messages)
       end
     end
     alias :say :reply
@@ -61,6 +56,19 @@ module Slacks
       "##{name}"
     end
 
+  protected
+
+    def reply_one(message, options={})
+      slack.send_message(message, options.merge(channel: id))
+    end
+
+    def reply_many(messages)
+      messages.each_with_index.map do |message, i|
+        sleep message.length / slack.typing_speed if i > 0
+        slack.send_message(message, channel: id)
+      end
+    end
+
   private
     attr_reader :slack
   end

data/lib/slacks/connection.rb

@@ -24,10 +24,8 @@ module Slacks
       @user_ids_dm_ids = {}
       @users_by_id = {}
       @user_id_by_name = {}
-      @groups_by_id = {}
-      @group_id_by_name = {}
-      @channels_by_id = {}
-      @channel_id_by_name = {}
+      @conversations_by_id = {}
+      @conversation_ids_by_name = {}
     end
 
 
@@ -42,7 +40,7 @@ module Slacks
         link_names: 1} # find and link channel names and user names
       params.merge!(attachments: MultiJson.dump(attachments)) if attachments.any?
       params.merge!(options.select { |key, _| SEND_MESSAGE_PARAMS.member?(key) })
-      api("chat.postMessage", params)
+      api("chat.postMessage", **params)
     end
     alias :say :send_message
 
@@ -50,7 +48,7 @@ module Slacks
       params = {
         channel: to_channel_id(channel),
         timestamp: ts }
-      api("reactions.get", params)
+      api("reactions.get", **params)
     end
 
     def update_message(ts, message, options={})
@@ -65,26 +63,34 @@ module Slacks
       params.merge!(attachments: MultiJson.dump(attachments)) if attachments.any?
       params.merge!(options.select { |key, _| [:username, :as_user, :parse, :link_names,
         :unfurl_links, :unfurl_media, :icon_url, :icon_emoji].member?(key) })
-      api("chat.update", params)
+      api("chat.update", **params)
     end
 
     def add_reaction(emojis, message)
       Array(emojis).each do |emoji|
-        api("reactions.add", {
+        api("reactions.add",
           name: emoji.gsub(/^:|:$/, ""),
           channel: message.channel.id,
-          timestamp: message.timestamp })
+          timestamp: message.timestamp)
       end
     end
 
+
+
     def typing_on(channel)
+      raise NotListeningError unless listening?
       websocket.write MultiJson.dump(type: "typing", channel: to_channel_id(channel))
     end
 
     def ping
+      raise NotListeningError unless listening?
       websocket.ping
     end
 
+    def listening?
+      !websocket.nil?
+    end
+
 
 
     def listen!
@@ -108,21 +114,16 @@ module Slacks
           # one, we'll skill it.
           next
 
-        when EVENT_GROUP_JOINED
-          group = data["channel"]
-          @groups_by_id[group["id"]] = group
-          @group_id_by_name[group["name"]] = group["id"]
+        when EVENT_GROUP_JOINED, EVENT_CHANNEL_CREATED
+          conversation = data["channel"]
+          @conversations_by_id[conversation["id"]] = conversation
+          @conversation_ids_by_name[conversation["name"]] = conversation["id"]
 
         when EVENT_USER_JOINED
           user = data["user"]
           @users_by_id[user["id"]] = user
           @user_id_by_name[user["name"]] = user["id"]
 
-        when EVENT_CHANNEL_CREATED
-          channel = data["channel"]
-          @channels_by_id[channel["id"]] = channel
-          @channel_id_by_name[channel["name"]] = channel["id"]
-
         when EVENT_MESSAGE
           # Don't respond to things that this bot said
           next if data["user"] == bot.id
@@ -149,17 +150,17 @@ module Slacks
 
 
     def channels
-      channels = user_id_by_name.keys + group_id_by_name.keys + channel_id_by_name.keys
+      channels = user_id_by_name.keys + conversation_ids_by_name.keys
       if channels.empty?
-        fetch_channels!
-        fetch_groups!
+        fetch_conversations!
         fetch_users!
       end
       channels
     end
 
     def can_see?(channel)
-      to_channel_id(channel).present?
+      channel_id = to_channel_id(channel)
+      channel_id && !channel_id.empty?
     rescue ArgumentError
       false
     end
@@ -175,21 +176,28 @@ module Slacks
           "id" => id,
           "is_im" => true,
           "name" => user.username }
-      when /^G/
-        Slacks::Channel.new(self, groups_by_id.fetch(id) do
-          raise ArgumentError, "Unable to find a group with the ID #{id.inspect}"
-        end)
       else
-        Slacks::Channel.new(self, channels_by_id.fetch(id) do
-          raise ArgumentError, "Unable to find a channel with the ID #{id.inspect}"
-        end)
+        Slacks::Channel.new(self, find_conversation(id))
+      end
+    end
+
+    def find_conversation(id)
+      conversations_by_id.fetch(id) do
+        fetch_conversations!
+        conversations_by_id.fetch(id) do
+          raise ArgumentError, "Unable to find a conversation with the ID #{id.inspect}"
+        end
       end
     end
 
     def find_user(id)
-      Slacks::User.new(self, users_by_id.fetch(id) do
-        raise ArgumentError, "Unable to find a user with the ID #{id.inspect}"
-      end)
+      user = users_by_id.fetch(id) do
+        fetch_users!
+        users_by_id.fetch(id) do
+          raise ArgumentError, "Unable to find a user with the ID #{id.inspect}"
+        end
+      end
+      Slacks::User.new(self, user)
     end
 
     def find_user_by_nickname(nickname)
@@ -200,7 +208,8 @@ module Slacks
 
     def user_exists?(username)
       return false if username.nil?
-      to_user_id(username).present?
+      user_id = to_user_id(username)
+      user_id && !user_id.empty?
     rescue ArgumentError
       false
     end
@@ -216,10 +225,8 @@ module Slacks
     attr_reader :user_ids_dm_ids,
                 :users_by_id,
                 :user_id_by_name,
-                :groups_by_id,
-                :group_id_by_name,
-                :channels_by_id,
-                :channel_id_by_name,
+                :conversations_by_id,
+                :conversation_ids_by_name,
                 :websocket_url,
                 :websocket
 
@@ -230,14 +237,8 @@ module Slacks
       @bot = BotUser.new(response.fetch("self"))
       @team = Team.new(response.fetch("team"))
 
-      @channels_by_id = Hash[response.fetch("channels").map { |attrs| [attrs.fetch("id"), attrs] }]
-      @channel_id_by_name = Hash[response.fetch("channels").map { |attrs| ["##{attrs.fetch("name")}", attrs.fetch("id")] }]
-
-      @users_by_id = Hash[response.fetch("users").map { |attrs| [attrs.fetch("id"), attrs] }]
-      @user_id_by_name = Hash[response.fetch("users").map { |attrs| ["@#{attrs.fetch("name")}", attrs.fetch("id")] }]
-
-      @groups_by_id = Hash[response.fetch("groups").map { |attrs| [attrs.fetch("id"), attrs] }]
-      @group_id_by_name = Hash[response.fetch("groups").map { |attrs| [attrs.fetch("name"), attrs.fetch("id")] }]
+      @conversations_by_id = Hash[response.fetch("channels").map { |attrs| [ attrs.fetch("id"), attrs ] }]
+      @conversation_ids_by_name = Hash[response.fetch("channels").map { |attrs| [ attrs["name"], attrs["id"] ] }]
     end
 
 
@@ -246,13 +247,9 @@ module Slacks
       return name.id if name.is_a?(Slacks::Channel)
       return name if name =~ /^[DGC]/ # this already looks like a channel id
       return get_dm_for_username(name) if name.start_with?("@")
-      return to_group_id(name) unless name.start_with?("#")
 
-      channel_id_by_name[name] || fetch_channels![name] || missing_channel!(name)
-    end
-
-    def to_group_id(name)
-      group_id_by_name[name] || fetch_groups![name] || missing_group!(name)
+      name = name.gsub(/^#/, "") # Leading hashes are no longer a thing in the conversations API
+      conversation_ids_by_name[name] || fetch_conversations![name] || missing_conversation!(name)
     end
 
     def to_user_id(name)
@@ -265,39 +262,29 @@ module Slacks
 
     def get_dm_for_user_id(user_id)
       user_ids_dm_ids[user_id] ||= begin
-        response = api("im.open", user: user_id)
+        response = api("conversations.open", users: user_id)
         response["channel"]["id"]
       end
     end
 
 
-
-    def fetch_channels!
-      response = api("channels.list")
-      @channels_by_id = response["channels"].index_by { |attrs| attrs["id"] }
-      @channel_id_by_name = Hash[response["channels"].map { |attrs| ["##{attrs["name"]}", attrs["id"]] }]
-    end
-
-    def fetch_groups!
-      response = api("groups.list")
-      @groups_by_id = response["groups"].index_by { |attrs| attrs["id"] }
-      @group_id_by_name = Hash[response["groups"].map { |attrs| [attrs["name"], attrs["id"]] }]
+    def fetch_conversations!
+      conversations, ims = api("conversations.list", types: "public_channel,private_channel,mpim,im")["channels"].partition { |attrs| attrs["is_channel"] || attrs["is_group"] }
+      user_ids_dm_ids.merge! Hash[ims.map { |attrs| attrs.values_at("user", "id") }]
+      @conversations_by_id = Hash[conversations.map { |attrs| [ attrs.fetch("id"), attrs ] }]
+      @conversation_ids_by_name = Hash[conversations.map { |attrs| [ attrs["name"], attrs["id"] ] }]
     end
 
     def fetch_users!
       response = api("users.list")
-      @users_by_id = response["members"].index_by { |attrs| attrs["id"] }
+      @users_by_id = response["members"].each_with_object({}) { |attrs, hash| hash[attrs["id"]] = attrs }
       @user_id_by_name = Hash[response["members"].map { |attrs| ["@#{attrs["name"]}", attrs["id"]] }]
     end
 
 
 
-    def missing_channel!(name)
-      raise ArgumentError, "Couldn't find a channel named #{name}"
-    end
-
-    def missing_group!(name)
-      raise ArgumentError, "Couldn't find a private group named #{name}"
+    def missing_conversation!(name)
+      raise ArgumentError, "Couldn't find a conversation named #{name}"
     end
 
     def missing_user!(name)
@@ -309,8 +296,7 @@ module Slacks
     def get_user_id_for_dm(dm)
       user_id = user_ids_dm_ids.key(dm)
       unless user_id
-        response = api("im.list")
-        user_ids_dm_ids.merge! Hash[response["ims"].map { |attrs| attrs.values_at("user", "id") }]
+        fetch_conversations!
         user_id = user_ids_dm_ids.key(dm)
       end
       raise ArgumentError, "Unable to find a user for the direct message ID #{dm.inspect}" unless user_id
@@ -319,12 +305,33 @@ module Slacks
 
 
 
-    def api(command, options={})
-      response = http.post(command, options.merge(token: token))
+    def api(command, page_limit: MAX_PAGES, **params)
+      params_with_token = params.merge(token: token)
+      response = api_post command, params_with_token
+      fetched_pages = 1
+      cursor = response.dig("response_metadata", "next_cursor")
+      while cursor && !cursor.empty? && fetched_pages < page_limit do
+        api_post(command, params_with_token.merge(cursor: cursor)).each do |key, value|
+          if value.is_a?(Array)
+            response[key].concat value
+          elsif value.is_a?(Hash)
+            response[key].merge! value
+          else
+            response[key] = value
+          end
+        end
+        fetched_pages += 1
+        cursor = response.dig("response_metadata", "next_cursor")
+      end
+      response
+    end
+
+    def api_post(command, params)
+      response = http.post(command, params)
       response = MultiJson.load(response.body)
       unless response["ok"]
         response["error"].split(/,\s*/).each do |error_code|
-          raise ::Slacks::Response.fetch(error_code).new(response)
+          raise ::Slacks::Response.fetch(error_code).new(command, params, response)
         end
       end
       response
@@ -356,5 +363,7 @@ module Slacks
       reply_broadcast
     }.freeze
 
+    MAX_PAGES = 9001
+
   end
 end

data/lib/slacks/errors.rb

@@ -3,19 +3,29 @@ require "slacks/core_ext/exception"
 module Slacks
   module Response
     class Error < RuntimeError
-      attr_reader :response
+      attr_reader :command, :params, :response
 
-      def initialize(response, message)
+      def initialize(command, params, response, message)
         super message
+        @command = command
+        @params = params
         @response = response
+        additional_information[:command] = command
+        additional_information[:params] = params
         additional_information[:response] = response
       end
     end
 
+    class UnspecifiedError < ::Slacks::Response::Error
+      def initialize(command, params, response)
+        super command, params, response, "Request failed with #{response["error"].inspect}"
+      end
+    end
+
     @_errors = {}
 
     def self.fetch(error_code)
-      @_errors.fetch(error_code, ::Slacks::Response::Error)
+      @_errors.fetch(error_code, ::Slacks::Response::UnspecifiedError)
     end
 
     {
@@ -25,6 +35,7 @@ module Slacks
       "cant_update_message"    => "Authenticated user does not have permission to update this message.",
       "channel_not_found"      => "Value passed for channel was invalid.",
       "edit_window_closed"     => "The message cannot be edited due to the team message edit settings",
+      "fatal_error"            => "",
       "file_comment_not_found" => "File comment specified by file_comment does not exist.",
       "file_not_found"         => "File specified by file does not exist.",
       "invalid_arg_name"       => "The method was passed an argument whose name falls outside the bounds of common decency. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.",
@@ -49,15 +60,15 @@ module Slacks
       "too_many_emoji"         => "The limit for distinct reactions (i.e emoji) on the item has been reached.",
       "too_many_reactions"     => "The limit for reactions a person may add to the item has been reached."
     }.each do |error_code, message|
-      class_name = error_code.classify
+      class_name = error_code.gsub(/(?:^|_)([a-z]+)/) { $1.capitalize }
       class_name = {
         "MsgTooLong" => "MessageTooLong"
       }.fetch(class_name, class_name)
 
       module_eval <<-RUBY, __FILE__, __LINE__ + 1
         class #{class_name} < ::Slacks::Response::Error
-          def initialize(response)
-            super response, "#{message}"
+          def initialize(command, params, response)
+            super command, params, response, "#{message}"
           end
         end
 
@@ -84,4 +95,10 @@ module Slacks
       super "Unable to connect to Slack; a token has no"
     end
   end
+
+  class NotListeningError < ArgumentError
+    def initialize
+      super "Not connected to the RTM API; call `listen!` first"
+    end
+  end
 end

data/lib/slacks/version.rb

@@ -1,3 +1,3 @@
 module Slacks
-  VERSION = "0.5.0.pre"
+  VERSION = "0.6.3"
 end

data/slacks.gemspec

@@ -25,8 +25,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency "faraday-raise-errors"
   spec.add_dependency "concurrent-ruby"
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "minitest-reporters"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slacks
 version: !ruby/object:Gem::Version
-  version: 0.5.0.pre
+  version: 0.6.3
 platform: ruby
 authors:
 - Bob Lail
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2017-01-28 00:00:00.000000000 Z
+date: 2021-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: websocket-driver
@@ -84,30 +84,30 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -164,7 +164,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - bob.lailfamily@gmail.com
 executables: []
@@ -173,6 +173,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -196,7 +197,7 @@ homepage: https://github.com/houston/slacks
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -207,13 +208,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: A library for communicating via Slack
 test_files: []