slack-ruby-client 0.7.9 → 0.16.0

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 <% desc = group['desc'] || "#{group['name'].gsub(".", "_").camelize} methods." %>
@@ -7,11 +8,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 %>
@@ -20,8 +22,8 @@ command '<%= group['name'].gsub(".", "_") %>' do |g|
   g.long_desc %( <%= data["desc"].split("\n").join(" ") %> )
   g.command '<%= name %>' do |c|
   <% data["args"].each do |arg_name, arg_v| %>
-    <% if arg_v["desc"].include?("'")  %>
-    c.flag '<%= arg_name %>', desc: "<%= arg_v["desc"] %>"
+    <% if arg_v["desc"].include?("'") %>
+    c.flag '<%= arg_name %>', desc: "<%= arg_v["desc"].gsub('"', '\'') %>"
     <% else %>
     c.flag '<%= arg_name %>', desc: '<%= arg_v["desc"] %>'
     <% end %>

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

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
 # 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,18 +1,20 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
-<% files.each do |f| %>
-require 'slack/web/api/endpoints/<%= f %>'
+<% files.sort.each do |f| %>
+require_relative 'endpoints/<%= f %>'
 <% end %>
 
 module Slack
   module Web
     module Api
       module Endpoints
+        include Slack::Web::Api::Mixins::Conversations
         include Slack::Web::Api::Mixins::Channels
         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/errors.erb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Errors
+        <% errors.each do |e| %>
+        class <%= e.camelize %> < SlackError; end
+        <% end %>
+
+        ERROR_CLASSES = {
+          <% errors.each do |e| %>
+          '<%= e %>' => <%= e.camelize %>,
+          <% end %>
+        }.freeze
+      end
+    end
+  end
+end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 module Slack
@@ -5,13 +6,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 +27,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?
@@ -34,12 +40,28 @@ module Slack
 <% if data['group'] == 'groups' && data['args']['channel'] && !data['args']['channel']['desc'].include?('Can be an encoded ID, or a name.') %>
             options = options.merge(channel: groups_id(options)['group']['id']) if options[:channel]
 <% elsif data['args']['channel'] && !data['args']['channel']['desc'].include?('Can be an encoded ID, or a name.') %>
-            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
+            options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
 <% end %>
 <% if data['args']['user'] %>
             options = options.merge(user: users_id(options)['user']['id']) if options[:user]
 <% end %>
+<% if data['undocumented'] %>
+            logger.warn('The <%= group %>.<%= name %> method is undocumented.')
+<% end %>
+<% if data['deprecated'] %>
+            logger.warn('<%= group %>.<%= name %>: <%= data['deprecation']['deprecation_warning']%> Alternative methods: <%= data['deprecation']['alternative_methods'].join(', ')%>.')
+<% end %>
+<% if data['args'].keys.include?('cursor') %>
+            if block_given?
+              Pagination::Cursor.new(self, :<%= group.gsub(".", "_") %>_<%= name %>, options).each do |page|
+                yield page
+              end
+            else
+              post('<%= group %>.<%= name %>', options)
+            end
+<% else %>
             post('<%= group %>.<%= name %>', options)
+<% end %>
           end
 <% end %>
         end

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

@@ -1,17 +1,18 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 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? %>
   context '<%= group %>_<%= name %>' do
 <% required_params.each do |arg_name, arg_v| %>
     it 'requires <%= arg_name %>' do
-<% params_except_required = required_params.reject{ |name, _| name == arg_name  }.map{|var, opts| "#{var}: '#{opts['example']}'"}.join(', ') %>
+<% params_except_required = required_params.reject{ |name, _| name == arg_name  }.map{ |var, opts| "#{var}: %q[#{opts['example']}]"}.join(', ') %>
       expect { client.<%= group.gsub(".", "_") %>_<%= name %><%= params_except_required.empty? ? '' : "(#{params_except_required})" %> }.to raise_error ArgumentError, /Required arguments :<%= arg_name %> missing/
     end
 <% end %>

data/lib/slack/web/client.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Slack
   module Web
     class Client
@@ -9,7 +10,7 @@ module Slack
 
       def initialize(options = {})
         Slack::Web::Config::ATTRIBUTES.each do |key|
-          send("#{key}=", options[key] || Slack::Web.config.send(key))
+          send("#{key}=", options.fetch(key, Slack::Web.config.send(key)))
         end
         @logger ||= Slack::Config.logger || Slack::Logger.default
         @token ||= Slack.config.token

data/lib/slack/web/config.rb

@@ -1,16 +1,22 @@
+# frozen_string_literal: true
 module Slack
   module Web
     module Config
       extend self
 
-      ATTRIBUTES = [
-        :proxy,
-        :user_agent,
-        :ca_path,
-        :ca_file,
-        :logger,
-        :endpoint,
-        :token
+      ATTRIBUTES = %i[
+        proxy
+        user_agent
+        ca_path
+        ca_file
+        logger
+        endpoint
+        token
+        timeout
+        open_timeout
+        default_page_size
+        default_max_retries
+        adapter
       ].freeze
 
       attr_accessor(*Config::ATTRIBUTES)
@@ -18,11 +24,16 @@ module Slack
       def reset
         self.endpoint = 'https://slack.com/api/'
         self.user_agent = "Slack Ruby Client/#{Slack::VERSION}"
-        self.ca_path = `openssl version -a | grep OPENSSLDIR | awk '{print $2}'|sed -e 's/\"//g'`
-        self.ca_file = "#{ca_path}/ca-certificates.crt"
+        self.ca_path = defined?(OpenSSL) ? OpenSSL::X509::DEFAULT_CERT_DIR : nil
+        self.ca_file = defined?(OpenSSL) ? OpenSSL::X509::DEFAULT_CERT_FILE : nil
         self.token = nil
         self.proxy = nil
         self.logger = nil
+        self.timeout = nil
+        self.open_timeout = nil
+        self.default_page_size = 100
+        self.default_max_retries = 100
+        self.adapter = ::Faraday.default_adapter
       end
     end
 

data/lib/slack/web/faraday/connection.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Slack
   module Web
     module Faraday
@@ -5,24 +6,32 @@ module Slack
         private
 
         def connection
-          options = {
-            headers: { 'Accept' => 'application/json; charset=utf-8' }
-          }
+          @connection ||=
+            begin
+              options = {
+                headers: { 'Accept' => 'application/json; charset=utf-8' }
+              }
 
-          options[:headers]['User-Agent'] = user_agent if user_agent
-          options[:proxy] = proxy if proxy
-          options[:ssl] = { ca_path: ca_path, ca_file: ca_file }
+              options[:headers]['User-Agent'] = user_agent if user_agent
+              options[:proxy] = proxy if proxy
+              options[:ssl] = { ca_path: ca_path, ca_file: ca_file } if ca_path || ca_file
 
-          ::Faraday::Connection.new(endpoint, options) do |connection|
-            connection.use ::Faraday::Request::Multipart
-            connection.use ::Faraday::Request::UrlEncoded
-            connection.use ::Slack::Web::Faraday::Response::RaiseError
-            connection.use ::FaradayMiddleware::Mashify, mash_class: Slack::Messages::Message
-            connection.use ::FaradayMiddleware::ParseJson
-            connection.use ::Faraday::Response::RaiseError
-            connection.response :logger, logger if logger
-            connection.adapter ::Faraday.default_adapter
-          end
+              request_options = {}
+              request_options[:timeout] = timeout if timeout
+              request_options[:open_timeout] = open_timeout if open_timeout
+              options[:request] = request_options if request_options.any?
+
+              ::Faraday::Connection.new(endpoint, options) do |connection|
+                connection.use ::Faraday::Request::Multipart
+                connection.use ::Faraday::Request::UrlEncoded
+                connection.use ::Slack::Web::Faraday::Response::WrapError
+                connection.use ::Slack::Web::Faraday::Response::RaiseError
+                connection.use ::FaradayMiddleware::Mashify, mash_class: Slack::Messages::Message
+                connection.use ::FaradayMiddleware::ParseJson
+                connection.response :logger, logger if logger
+                connection.adapter adapter
+              end
+            end
         end
       end
     end

data/lib/slack/web/faraday/request.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Slack
   module Web
     module Faraday
@@ -30,6 +31,7 @@ module Slack
               request.path = path
               request.body = options unless options.empty?
             end
+            request.options.merge!(options.delete(:request)) if options.key?(:request)
           end
           response.body
         end

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

@@ -1,12 +1,34 @@
+# frozen_string_literal: true
 module Slack
   module Web
     module Faraday
       module Response
         class RaiseError < ::Faraday::Response::Middleware
           def on_complete(env)
+            raise Slack::Web::Api::Errors::TooManyRequestsError, env.response if env.status == 429
+
+            return unless env.success?
+
             body = env.body
+            return unless body
             return if body['ok']
-            fail Slack::Web::Api::Error.new(body['error'], env.response)
+
+            error_message =
+              body['error'] || body['errors'].map { |message| message['error'] }.join(',')
+
+            error_class = Slack::Web::Api::Errors::ERROR_CLASSES[error_message]
+            error_class ||= Slack::Web::Api::Errors::SlackError
+            raise error_class.new(error_message, env.response)
+          end
+
+          def call(env)
+            super
+          rescue Slack::Web::Api::Errors::SlackError, Slack::Web::Api::Errors::TooManyRequestsError
+            raise
+          rescue ::Faraday::ParsingError
+            raise Slack::Web::Api::Errors::ParsingError.new('parsing_error', env.response)
+          rescue ::Faraday::TimeoutError, ::Faraday::ConnectionFailed
+            raise Slack::Web::Api::Errors::TimeoutError.new('timeout_error', env.response)
           end
         end
       end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+module Slack
+  module Web
+    module Faraday
+      module Response
+        class WrapError < ::Faraday::Response::RaiseError
+          def on_complete(env)
+            super
+          rescue Slack::Web::Api::Errors::SlackError
+            raise
+          rescue ::Faraday::ServerError
+            raise Slack::Web::Api::Errors::UnavailableError.new('unavailable_error', env.response)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slack/web/pagination/cursor.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+module Slack
+  module Web
+    module Api
+      module Pagination
+        class Cursor
+          include Enumerable
+
+          attr_reader :client
+          attr_reader :verb
+          attr_reader :sleep_interval
+          attr_reader :max_retries
+          attr_reader :params
+
+          def initialize(client, verb, params = {})
+            @client = client
+            @verb = verb
+            @params = params.dup
+            @sleep_interval = @params.delete(:sleep_interval)
+            @max_retries = @params.delete(:max_retries) || client.default_max_retries
+          end
+
+          def each
+            next_cursor = nil
+            retry_count = 0
+            loop do
+              query = { limit: client.default_page_size }.merge(params).merge(cursor: next_cursor)
+              begin
+                response = client.send(verb, query)
+              rescue Slack::Web::Api::Errors::TooManyRequestsError => e
+                raise e if retry_count >= max_retries
+
+                client.logger.debug("#{self.class}##{__method__}") { e.to_s }
+                retry_count += 1
+                sleep(e.retry_after)
+                next
+              end
+              yield response
+              break unless response.response_metadata
+
+              next_cursor = response.response_metadata.next_cursor
+              break if next_cursor.nil? || next_cursor == ''
+
+              retry_count = 0
+              sleep(sleep_interval) if sleep_interval
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slack_ruby_client.rb

@@ -1 +1,2 @@
+# frozen_string_literal: true
 require 'slack-ruby-client'

data/lib/tasks/git.rake

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
 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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # largely from https://github.com/aki017/slack-ruby-gem
 require 'json-schema'
 require 'erubis'
@@ -5,22 +6,26 @@ require 'erubis'
 namespace :slack do
   namespace :real_time do
     namespace :api do
-      REAL_TIME_EVENTS_MARKER = '### RealTime Events'.freeze
+      REAL_TIME_EVENTS_MARKER = '### RealTime Events'
 
-      desc 'Update API.'
+      desc 'Update Real Time API.'
       task update: [:git_update] do
         event_schema = JSON.parse(File.read('lib/slack/real_time/api/schema/event.json'))
-        events = Dir.glob('lib/slack/web/api/slack-api-ref/events/**/*.json').each_with_object({}) do |path, result|
+        dirglob = 'lib/slack/web/api/slack-api-ref/events/**/*.json'
+        events = Dir.glob(dirglob).each_with_object({}) do |path, result|
           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
 
-        event_handler_template = Erubis::Eruby.new(File.read('lib/slack/real_time/api/templates/event_handler.erb'))
+        event_handler_template =
+          Erubis::Eruby.new(File.read('lib/slack/real_time/api/templates/event_handler.erb'))
         Dir.glob('lib/slack/real_time/stores/**/*.rb').each do |store_file|
           next if File.basename(store_file) == 'base.rb'
+
           STDOUT.write "#{File.basename(store_file)}:"
 
           store_file_contents = File.read(store_file)
@@ -35,7 +40,12 @@ namespace :slack do
                 desc: event_data['desc']
               )
 
-              store_file_contents.gsub! REAL_TIME_EVENTS_MARKER, REAL_TIME_EVENTS_MARKER + "\n\n" + rendered_event_handler.rstrip
+              store_file_contents.gsub!(
+                REAL_TIME_EVENTS_MARKER,
+                REAL_TIME_EVENTS_MARKER +
+                  "\n\n" +
+                  rendered_event_handler.rstrip
+              )
             end
           end