slack-ruby-client 0.10.0 → 0.11.0

data/lib/slack/web/api/endpoints/users_prefs.rb

@@ -0,0 +1,19 @@
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module UsersPrefs
+          #
+          # Returns the user's preferences (undocumented)
+          #
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/undocumented/users.prefs/users.prefs.get.json
+          def users_prefs_get(options = {})
+            post('users.prefs.get', options)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slack/web/api/endpoints/users_profile.rb

@@ -13,7 +13,7 @@ module Slack
           # @option options [user] :user
           #   User to retrieve profile info for.
           # @see https://api.slack.com/methods/users.profile.get
-          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/users.profile/users.profile.get.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/users.profile/users.profile.get.json
           def users_profile_get(options = {})
             options = options.merge(user: users_id(options)['user']['id']) if options[:user]
             post('users.profile.get', options)
@@ -31,7 +31,7 @@ module Slack
           # @option options [Object] :value
           #   Value to set a single key to. Usable only if profile is not passed.
           # @see https://api.slack.com/methods/users.profile.set
-          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/users.profile/users.profile.set.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/users.profile/users.profile.set.json
           def users_profile_set(options = {})
             options = options.merge(user: users_id(options)['user']['id']) if options[:user]
             post('users.profile.set', options)

data/lib/slack/web/api/endpoints.rb

@@ -7,12 +7,14 @@ require_relative 'endpoints/bots'
 require_relative 'endpoints/channels'
 require_relative 'endpoints/chat'
 require_relative 'endpoints/conversations'
+require_relative 'endpoints/dialog'
 require_relative 'endpoints/dnd'
 require_relative 'endpoints/emoji'
-require_relative 'endpoints/files_comments'
 require_relative 'endpoints/files'
+require_relative 'endpoints/files_comments'
 require_relative 'endpoints/groups'
 require_relative 'endpoints/im'
+require_relative 'endpoints/migration'
 require_relative 'endpoints/mpim'
 require_relative 'endpoints/oauth'
 require_relative 'endpoints/pins'
@@ -26,6 +28,8 @@ require_relative 'endpoints/team_profile'
 require_relative 'endpoints/usergroups'
 require_relative 'endpoints/usergroups_users'
 require_relative 'endpoints/users'
+require_relative 'endpoints/users_admin'
+require_relative 'endpoints/users_prefs'
 require_relative 'endpoints/users_profile'
 
 module Slack
@@ -43,12 +47,14 @@ module Slack
         include Channels
         include Chat
         include Conversations
+        include Dialog
         include Dnd
         include Emoji
-        include FilesComments
         include Files
+        include FilesComments
         include Groups
         include Im
+        include Migration
         include Mpim
         include Oauth
         include Pins
@@ -62,6 +68,8 @@ module Slack
         include Usergroups
         include UsergroupsUsers
         include Users
+        include UsersAdmin
+        include UsersPrefs
         include UsersProfile
       end
     end

data/lib/slack/web/api/mixins/ids.id.rb

@@ -14,7 +14,7 @@ module Slack
               end
             end
 
-            fail Slack::Web::Api::Errors::SlackError, not_found_error
+            raise Slack::Web::Api::Errors::SlackError, not_found_error
           end
         end
       end

data/lib/slack/web/api/mixins/users.search.rb

@@ -1,43 +1,45 @@
-module Slack
-  module Web
-    module Api
-      module Mixins
-        module Users
-          Member = Struct.new :id, :name, :first_name, :last_name, :real_name, :email
+if defined?(Picky)
+  module Slack
+    module Web
+      module Api
+        module Mixins
+          module Users
+            Member = Struct.new :id, :name, :first_name, :last_name, :real_name, :email
 
-          #
-          # This method searches for users.
-          #
-          # @option options [user] :user
-          #   Free-formed text to search for.
-          def users_search(options = {})
-            query = options[:user]
-            throw ArgumentError.new('Required arguments :user missing') if query.nil?
-            index = Picky::Index.new(:users) do
-              category :name
-              category :first_name
-              category :last_name
-              category :real_name
-              category :email
+            #
+            # This method searches for users.
+            #
+            # @option options [user] :user
+            #   Free-formed text to search for.
+            def users_search(options = {})
+              query = options[:user]
+              throw ArgumentError.new('Required arguments :user missing') if query.nil?
+              index = Picky::Index.new(:users) do
+                category :name
+                category :first_name
+                category :last_name
+                category :real_name
+                category :email
+              end
+              members = users_list.members
+              members.each_with_index do |member, id|
+                user = Member.new(
+                  id,
+                  member.name,
+                  member.profile.first_name,
+                  member.profile.last_name,
+                  member.profile.real_name,
+                  member.profile.email
+                )
+                index.add(user)
+              end
+              ids = Picky::Search.new(index).search(query, 5, 0, unique: true).ids
+              results = ids.map { |id| members[id] }
+              Slack::Messages::Message.new('ok' => true, 'members' => results)
             end
-            members = users_list.members
-            members.each_with_index do |member, id|
-              user = Member.new(
-                id,
-                member.name,
-                member.profile.first_name,
-                member.profile.last_name,
-                member.profile.real_name,
-                member.profile.email
-              )
-              index.add(user)
-            end
-            ids = Picky::Search.new(index).search(query, 5, 0, unique: true).ids
-            results = ids.map { |id| members[id] }
-            Slack::Messages::Message.new('ok' => true, 'members' => results)
           end
         end
       end
     end
   end
-end if defined?(Picky)
+end

data/lib/slack/web/api/patches/chat.1.text-attachments-required.patch

@@ -3,7 +3,7 @@ index 1f7a8d7..2ec4bed 100644
 --- a/lib/slack/web/api/endpoints/chat.rb
 +++ b/lib/slack/web/api/endpoints/chat.rb
 @@ -49,7 +49,7 @@ module Slack
-           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/chat/chat.postMessage.json
+           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/chat/chat.postMessage.json
            def chat_postMessage(options = {})
              throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
 -            throw ArgumentError.new('Required arguments :text missing') if options[:text].nil?

data/lib/slack/web/api/patches/chat.3.update-attachments-support.patch

@@ -3,7 +3,7 @@ index 5186416..490bc91 100644
 --- a/lib/slack/web/api/endpoints/chat.rb
 +++ b/lib/slack/web/api/endpoints/chat.rb
 @@ -154,9 +154,15 @@ module Slack
-           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/chat/chat.update.json
+           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/chat/chat.update.json
            def chat_update(options = {})
              throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
 -            throw ArgumentError.new('Required arguments :text missing') if options[:text].nil?

data/lib/slack/web/api/patches/dialog.1.open-json-support.patch

@@ -0,0 +1,17 @@
+diff --git a/lib/slack/web/api/endpoints/dialog.rb b/lib/slack/web/api/endpoints/dialog.rb
+index 01f9dfd..d017adf 100644
+--- a/lib/slack/web/api/endpoints/dialog.rb
++++ b/lib/slack/web/api/endpoints/dialog.rb
+@@ -17,6 +17,12 @@ module Slack
+           def dialog_open(options = {})
+             throw ArgumentError.new('Required arguments :dialog missing') if options[:dialog].nil?
+             throw ArgumentError.new('Required arguments :trigger_id missing') if options[:trigger_id].nil?
++            # dialog must be passed as an encoded JSON string
++            if options.key?(:dialog)
++              dialog = options[:dialog]
++              dialog = JSON.dump(dialog) unless dialog.is_a?(String)
++              options = options.merge(dialog: dialog)
++            end
+             post('dialog.open', options)
+           end
+         end

data/lib/slack/web/api/templates/command.erb

@@ -7,11 +7,12 @@ desc "<%= desc %>"
 desc '<%= desc %>'
 <% end %>
 command '<%= group['name'].gsub(".", "_") %>' do |g|
-<% names.each_with_index do |(name, data), index| %>
+<% names.sort.each_with_index do |(name, data), index| %>
 <% if index > 0 %>
 
 <% end %>
   <% short_desc = data["desc"].split("\n").first %>
+  <% short_desc += ' (undocumented)' if data['undocumented'] %>
   <% if short_desc.include?("'")  %>
   g.desc "<%= short_desc %>"
   <% else %>

data/lib/slack/web/api/templates/commands.erb

@@ -1,5 +1,5 @@
 # This file was auto-generated by lib/tasks/web.rake
 
-<% files.each do |f| %>
+<% files.sort.each do |f| %>
 require 'commands/<%= f %>'
 <% end %>

data/lib/slack/web/api/templates/endpoints.erb

@@ -1,6 +1,6 @@
 # This file was auto-generated by lib/tasks/web.rake
 
-<% files.each do |f| %>
+<% files.sort.each do |f| %>
 require_relative 'endpoints/<%= f %>'
 <% end %>
 
@@ -12,7 +12,7 @@ module Slack
         include Slack::Web::Api::Mixins::Users
         include Slack::Web::Api::Mixins::Groups
 
-<% files.each do |f| %>
+<% files.sort.each do |f| %>
         include <%= f.camelize %>
 <% end %>
       end

data/lib/slack/web/api/templates/method.erb

@@ -5,13 +5,14 @@ module Slack
     module Api
       module Endpoints
         module <%= group.gsub(".", "_").camelize %>
-<% names.each_with_index do |(name, data), index| %>
+<% names.sort.each_with_index do |(name, data), index| %>
 <% next if data['mixin'] %>
 <% if index > 0 %>
 
 <% end %>
           #
-<% data['desc'].split("\n").each do |line| %>
+<% data['desc'].split("\n").each_with_index do |line, index| %>
+  <% line += ' (undocumented)' if data['undocumented'] && index == 0 %>
           # <%= line %>
 <% end %>
           #
@@ -25,8 +26,12 @@ module Slack
 <% end %>
 <% end %>
 <% end %>
+<% if data['undocumented'] %>
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/undocumented/<%= group %>/<%= group %>.<%= name %>.json
+<% else %>
           # @see https://api.slack.com/methods/<%= group %>.<%= name %>
-          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/<%= group %>/<%= group %>.<%= name %>.json
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/<%= group %>/<%= group %>.<%= name %>.json
+<% end %>
           def <%= group.gsub(".", "_") %>_<%= name %>(options = {})
 <% data['args'].select{ |k, v| v['required'] }.each do |arg_name, arg_v| %>
             throw ArgumentError.new('Required arguments :<%= arg_name %> missing') if options[:<%= arg_name %>].nil?

data/lib/slack/web/api/templates/method_spec.erb

@@ -4,7 +4,7 @@ require 'spec_helper'
 
 RSpec.describe Slack::Web::Api::Endpoints::<%= group.gsub(".", "_").camelize %> do
   let(:client) { Slack::Web::Client.new }
-<% names.each_with_index do |(name, data), index| %>
+<% names.sort.each_with_index do |(name, data), index| %>
 <% next if data['mixin'] %>
 <% required_params = data['args'].select{ |k, v| v['required'] } %>
 <% next if required_params.none? %>

data/lib/slack/web/config.rb

@@ -3,18 +3,18 @@ module Slack
     module Config
       extend self
 
-      ATTRIBUTES = [
-        :proxy,
-        :user_agent,
-        :ca_path,
-        :ca_file,
-        :logger,
-        :endpoint,
-        :token,
-        :timeout,
-        :open_timeout,
-        :default_page_size,
-        :default_max_retries
+      ATTRIBUTES = %i[
+        proxy
+        user_agent
+        ca_path
+        ca_file
+        logger
+        endpoint
+        token
+        timeout
+        open_timeout
+        default_page_size
+        default_max_retries
       ].freeze
 
       attr_accessor(*Config::ATTRIBUTES)

data/lib/slack/web/faraday/response/raise_error.rb

@@ -5,11 +5,11 @@ module Slack
         class RaiseError < ::Faraday::Response::Middleware
           def on_complete(env)
             if env.status == 429
-              fail Slack::Web::Api::Errors::TooManyRequestsError, env.response
+              raise Slack::Web::Api::Errors::TooManyRequestsError, env.response
             elsif (body = env.body) && body['ok']
-              return
+              nil
             else
-              fail Slack::Web::Api::Errors::SlackError.new(body['error'], env.response)
+              raise Slack::Web::Api::Errors::SlackError.new(body['error'], env.response)
             end
           end
         end

data/lib/tasks/git.rake

@@ -1,5 +1,5 @@
 namespace :slack do
-  # update slack-api-ref from https://github.com/dblock/slack-api-ref
+  # update slack-api-ref from https://github.com/slack-ruby/slack-api-ref
   task :git_update do
     sh 'git submodule update --init --recursive'
     sh 'git submodule foreach git pull origin master'

data/lib/tasks/real_time.rake

@@ -14,7 +14,7 @@ namespace :slack do
           name = File.basename(path, '.json')
           parsed = JSON.parse(File.read(path))
           JSON::Validator.validate(event_schema, parsed, insert_defaults: true)
-          next if %w(message hello).include?(name)
+          next if %w[message hello].include?(name)
           result[name] = parsed
         end
 

data/lib/tasks/web.rake

@@ -13,6 +13,7 @@ namespace :slack do
         groups = Dir.glob('lib/slack/web/api/slack-api-ref/groups/**/*.json').each_with_object({}) do |path, result|
           name = File.basename(path, '.json')
           parsed = JSON.parse(File.read(path))
+          parsed['undocumented'] = true if path =~ /undocumented/
           JSON::Validator.validate(group_schema, parsed, insert_defaults: true)
           result[name] = parsed
         end
@@ -27,6 +28,7 @@ namespace :slack do
           name = file_name.split('.')[-1]
           result[prefix] ||= {}
           parsed = JSON.parse(File.read(path))
+          parsed['undocumented'] = true if path =~ /undocumented/
           JSON::Validator.validate(method_schema, parsed, insert_defaults: true)
           result[prefix][name] = parsed
         end
@@ -47,9 +49,10 @@ namespace :slack do
           end
           Dir.glob("lib/slack/web/api/patches/#{group}*.patch").sort.each do |patch|
             puts "- patching #{patch}"
-            system("git apply #{patch}") || fail('failed to apply patch')
+            system("git apply #{patch}") || raise('failed to apply patch')
           end
           # command
+          raise "Missing group #{group}" unless groups.key?(group)
           rendered_command = command_template.result(group: groups[group], names: names)
           File.write "bin/commands/#{snaked_group}.rb", rendered_command
         end

data/slack-ruby-client.gemspec

@@ -19,15 +19,14 @@ Gem::Specification.new do |s|
   s.add_dependency 'activesupport'
   s.add_dependency 'faraday', '>= 0.9'
   s.add_dependency 'faraday_middleware'
-  s.add_dependency 'json'
-  s.add_dependency 'websocket-driver'
   s.add_dependency 'gli'
   s.add_dependency 'hashie'
+  s.add_dependency 'websocket-driver'
   s.add_development_dependency 'erubis'
   s.add_development_dependency 'json-schema'
   s.add_development_dependency 'rake', '~> 10'
   s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rubocop', '0.51.0'
   s.add_development_dependency 'vcr'
   s.add_development_dependency 'webmock'
-  s.add_development_dependency 'rubocop', '0.35.0'
 end

data/spec/slack/messages/formatting_spec.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+
 require 'spec_helper'
 
 describe Slack::Messages::Formatting do

data/spec/slack/real_time/client_spec.rb

@@ -235,7 +235,7 @@ RSpec.describe Slack::RealTime::Client do
       it 'sets default store_class' do
         expect(client.send(:store_class)).to eq Slack::RealTime::Store
       end
-      (Slack::RealTime::Config::ATTRIBUTES - [:logger, :store_class]).each do |key|
+      (Slack::RealTime::Config::ATTRIBUTES - %i[logger store_class]).each do |key|
         it "sets #{key}" do
           expect(client.send(key)).to eq Slack::RealTime::Config.send(key)
         end
@@ -304,7 +304,8 @@ RSpec.describe Slack::RealTime::Client do
             proxy: {
               origin: 'http://username:password@proxy.example.com',
               headers: { 'User-Agent' => 'ruby' }
-            }).and_return(ws)
+            }
+          ).and_return(ws)
           client.start!
         end
       end

data/spec/slack/real_time/concurrency/celluloid_spec.rb

@@ -13,7 +13,7 @@ begin
           let(:test_socket) do
             Class.new(described_class) do
               def read
-                fail options[:err]
+                raise options[:err]
               end
             end
           end