slack-ruby-client 0.15.0 → 1.0.0

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

@@ -1,142 +0,0 @@
-# frozen_string_literal: true
-require 'websocket/driver'
-require 'socket'
-require 'forwardable'
-require 'celluloid/current'
-require 'celluloid/io'
-
-module Slack
-  module RealTime
-    module Concurrency
-      module Celluloid
-        class Socket < Slack::RealTime::Socket
-          include ::Celluloid::IO
-          include ::Celluloid::Internals::Logger
-
-          BLOCK_SIZE = 4096
-
-          extend ::Forwardable
-          def_delegators :driver, :text, :binary
-
-          attr_reader :socket
-
-          def initialize(*args)
-            super
-          end
-
-          def connect!
-            super
-            run_loop
-          end
-
-          def run_loop
-            @closing = false
-            @socket = build_socket
-            @connected = @socket.connect
-            driver.start
-            loop { read } if socket
-          rescue EOFError, Errno::ECONNRESET, Errno::EPIPE => e
-            logger.debug("#{self.class}##{__method__}") { e }
-            unless @closing
-              driver.emit(
-                :close,
-                WebSocket::Driver::CloseEvent.new(1001, 'server closed connection')
-              )
-            end
-          end
-
-          def disconnect!
-            super
-            @ping_timer&.cancel
-          end
-
-          def close
-            @closing = true
-            super
-          end
-
-          def read
-            buffer = socket.readpartial(BLOCK_SIZE)
-            raise EOFError unless buffer && !buffer.empty?
-
-            async.handle_read(buffer)
-          end
-
-          def handle_read(buffer)
-            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(client)
-            @client = client
-            Actor.new(future.run_ping_loop)
-            Actor.new(future.run_client_loop)
-          end
-
-          def run_client_loop
-            @client.run_loop
-          rescue StandardError => e
-            logger.debug("#{self.class}##{__method__}") { e }
-            raise e
-          end
-
-          def run_ping_loop
-            return unless @client.run_ping?
-
-            @ping_timer = every @client.websocket_ping_timer do
-              @client.run_ping!
-            end
-          end
-
-          def restart_async(client, new_url)
-            @last_message_at = current_time
-            @url = new_url
-            @client = client
-            Actor.new(future.run_client_loop)
-          end
-
-          def connected?
-            !@connected.nil? && !@driver.nil?
-          end
-
-          protected
-
-          class Actor
-            attr_reader :future
-
-            def initialize(future)
-              @future = future
-            end
-
-            def join
-              @future.value
-            end
-          end
-
-          def build_socket
-            socket = ::Celluloid::IO::TCPSocket.new(addr, port)
-            socket = ::Celluloid::IO::SSLSocket.new(socket, build_ssl_context) if secure?
-            socket
-          end
-
-          def build_ssl_context
-            OpenSSL::SSL::SSLContext.new(:TLSv1_2_client)
-          end
-
-          def build_driver
-            ::WebSocket::Driver.client(self)
-          end
-
-          def connect
-            @driver = build_driver
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,85 +0,0 @@
-# frozen_string_literal: true
-require 'faye/websocket'
-require 'eventmachine'
-
-module Slack
-  module RealTime
-    module Concurrency
-      module Eventmachine
-        class Client < Faye::WebSocket::Client
-          def initialize(url, protocols = nil, options = {})
-            options = options.dup
-            @logger = options.delete(:logger) || Slack::RealTime::Config.logger || Slack::Config.logger
-            super url, protocols, options
-          end
-
-          def parse(data)
-            logger.debug("#{self.class}##{__method__}") { data }
-            super data
-          end
-
-          def write(data)
-            logger.debug("#{self.class}##{__method__}") { data }
-            super data
-          end
-
-          protected
-
-          attr_reader :logger
-        end
-
-        class Socket < Slack::RealTime::Socket
-          def start_async(client)
-            @thread = ensure_reactor_running
-
-            if client.run_ping?
-              EventMachine.add_periodic_timer client.websocket_ping_timer do
-                client.run_ping!
-              end
-            end
-
-            client.run_loop
-
-            @thread
-          end
-
-          def restart_async(client, new_url)
-            @url = new_url
-            @last_message_at = current_time
-            @thread = ensure_reactor_running
-
-            client.run_loop
-
-            @thread
-          end
-
-          def disconnect!
-            super
-            EventMachine.stop_event_loop if EventMachine.reactor_running?
-            @thread = nil
-          end
-
-          def send_data(message)
-            logger.debug("#{self.class}##{__method__}") { message }
-            driver.send(message)
-          end
-
-          protected
-
-          # @return [Thread]
-          def ensure_reactor_running
-            return if EventMachine.reactor_running?
-
-            reactor = Thread.new { EventMachine.run }
-            Thread.pass until EventMachine.reactor_running?
-            reactor
-          end
-
-          def connect
-            @driver = Client.new(url, nil, options.merge(logger: logger))
-          end
-        end
-      end
-    end
-  end
-end

data/lib/slack/web/api/mixins/channels.id.json

@@ -1,20 +0,0 @@
-{
-  "mixin": true,
-  "group": "channels",
-  "name": "channels.id",
-  "desc": "This method returns the ID of a team channel.",
-  "args": {
-    "channel": {
-      "required": true,
-      "example": "#general",
-      "desc": "Channel to get ID for, prefixed with #.",
-      "type": "channel"
-    }
-  },
-  "errors": {
-    "channel_not_found": "Value passed for channel was invalid.",
-    "not_authed": "No authentication token provided.",
-    "invalid_auth": "Invalid authentication token.",
-    "account_inactive": "Authentication token is for a deleted user or team."
-  }
-}

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

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-require_relative 'ids.id'
-
-module Slack
-  module Web
-    module Api
-      module Mixins
-        module Channels
-          include Ids
-          #
-          # This method returns a channel ID given a channel name.
-          #
-          # @option options [channel] :channel
-          #   Channel to get ID for, prefixed with #.
-          def channels_id(options = {})
-            name = options[:channel]
-            throw ArgumentError.new('Required arguments :channel missing') if name.nil?
-
-            id_for(:channel, name, '#', :channels, 'channel_not_found') do
-              channels_list
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/slack/web/api/mixins/groups.id.json

@@ -1,20 +0,0 @@
-{
-  "mixin": true,
-  "group": "groups",
-  "name": "groups.id",
-  "desc": "This method returns the ID of a group.",
-  "args": {
-    "channel": {
-      "required": true,
-      "example": "#general",
-      "desc": "Group channel to get ID for, prefixed with #.",
-      "type": "group"
-    }
-  },
-  "errors": {
-    "channel_not_found": "Value passed for group was invalid.",
-    "not_authed": "No authentication token provided.",
-    "invalid_auth": "Invalid authentication token.",
-    "account_inactive": "Authentication token is for a deleted user or team."
-  }
-}

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

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-require_relative 'ids.id'
-
-module Slack
-  module Web
-    module Api
-      module Mixins
-        module Groups
-          include Ids
-          #
-          # This method returns a group ID given a group name.
-          #
-          # @option options [channel] :channel
-          #   Group channel to get ID for, prefixed with #.
-          def groups_id(options = {})
-            name = options[:channel]
-            throw ArgumentError.new('Required arguments :channel missing') if name.nil?
-
-            id_for(:group, name, '#', :groups, 'channel_not_found') do
-              groups_list
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/spec/fixtures/slack/web/503_error.yml

@@ -1,14 +0,0 @@
----
-http_interactions:
-- request:
-    method: post
-    uri: https://slack.com/api/auth.test
-  response:
-    status:
-      code: 503
-      message: Service Unavailable
-    body:
-      encoding: US-ASCII
-      string: ''
-    http_version:
-  recorded_at: Thu, 30 Nov 2017 14:36:26 GMT

data/spec/fixtures/slack/web/channels_info.yml

@@ -1,139 +0,0 @@
----
-http_interactions:
-- request:
-    method: post
-    uri: https://slack.com/api/conversations.list
-    body:
-      encoding: UTF-8
-      string: token=token
-    headers:
-      Accept:
-      - application/json; charset=utf-8
-      User-Agent:
-      - Slack Ruby Client/0.15.0
-      Content-Type:
-      - application/x-www-form-urlencoded
-      Accept-Encoding:
-      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
-  response:
-    status:
-      code: 200
-      message: OK
-    headers:
-      Date:
-      - Mon, 06 Jul 2020 14:21:41 GMT
-      Server:
-      - Apache
-      X-Slack-Req-Id:
-      - d6a36df98a9b67696d158d792698542b
-      X-Oauth-Scopes:
-      - channels:read
-      X-Accepted-Oauth-Scopes:
-      - channels:read,groups:read,mpim:read,im:read,read
-      Access-Control-Expose-Headers:
-      - x-slack-req-id, retry-after
-      X-Slack-Backend:
-      - r
-      X-Content-Type-Options:
-      - nosniff
-      Expires:
-      - Mon, 26 Jul 1997 05:00:00 GMT
-      Cache-Control:
-      - private, no-cache, no-store, must-revalidate
-      X-Xss-Protection:
-      - '0'
-      Vary:
-      - Accept-Encoding
-      Pragma:
-      - no-cache
-      Access-Control-Allow-Headers:
-      - slack-route, x-slack-version-ts, x-b3-traceid, x-b3-spanid, x-b3-parentspanid,
-        x-b3-sampled, x-b3-flags
-      Strict-Transport-Security:
-      - max-age=31536000; includeSubDomains; preload
-      Referrer-Policy:
-      - no-referrer
-      Access-Control-Allow-Origin:
-      - "*"
-      Content-Length:
-      - '616'
-      Content-Type:
-      - application/json; charset=utf-8
-      X-Via:
-      - haproxy-www-xvqc,haproxy-edge-sin-605a
-    body:
-      encoding: ASCII-8BIT
-      string: '{"ok":true,"channels":[{"id":"C016K3T7XK7","name":"random","is_channel":true,"is_group":false,"is_im":false,"created":1594044322,"is_archived":false,"is_general":false,"unlinked":0,"name_normalized":"random","is_shared":false,"parent_conversation":null,"creator":"U016LEXAH5Y","is_ext_shared":false,"is_org_shared":false,"shared_team_ids":["T016DNSRF7G"],"pending_shared":[],"pending_connected_team_ids":[],"is_pending_ext_shared":false,"is_member":false,"is_private":false,"is_mpim":false,"topic":{"value":"Non-work
-        banter and water cooler conversation","creator":"U016LEXAH5Y","last_set":1594044322},"purpose":{"value":"A
-        place for non-work-related flimflam, faffing, hodge-podge or jibber-jabber
-        you''d prefer to keep out of more focused work-related channels.","creator":"U016LEXAH5Y","last_set":1594044322},"previous_names":[],"num_members":1},{"id":"C016Z3VRSSV","name":"general","is_channel":true,"is_group":false,"is_im":false,"created":1594044322,"is_archived":false,"is_general":true,"unlinked":0,"name_normalized":"general","is_shared":false,"parent_conversation":null,"creator":"U016LEXAH5Y","is_ext_shared":false,"is_org_shared":false,"shared_team_ids":["T016DNSRF7G"],"pending_shared":[],"pending_connected_team_ids":[],"is_pending_ext_shared":false,"is_member":false,"is_private":false,"is_mpim":false,"topic":{"value":"Company-wide
-        announcements and work-based matters","creator":"U016LEXAH5Y","last_set":1594044322},"purpose":{"value":"This
-        channel is for workspace-wide communication and announcements. All members
-        are in this channel.","creator":"U016LEXAH5Y","last_set":1594044322},"previous_names":[],"num_members":1},{"id":"C017AA3CCDN","name":"slack-ruby-client","is_channel":true,"is_group":false,"is_im":false,"created":1594044322,"is_archived":false,"is_general":false,"unlinked":0,"name_normalized":"slack-ruby-client","is_shared":false,"parent_conversation":null,"creator":"U016LEXAH5Y","is_ext_shared":false,"is_org_shared":false,"shared_team_ids":["T016DNSRF7G"],"pending_shared":[],"pending_connected_team_ids":[],"is_pending_ext_shared":false,"is_member":false,"is_private":false,"is_mpim":false,"topic":{"value":"","creator":"","last_set":0},"purpose":{"value":"","creator":"","last_set":0},"previous_names":[],"num_members":1}],"response_metadata":{"next_cursor":""}}'
-  recorded_at: Mon, 06 Jul 2020 14:21:41 GMT
-- request:
-    method: post
-    uri: https://slack.com/api/channels.info
-    body:
-      encoding: UTF-8
-      string: channel=C016Z3VRSSV&token=token
-    headers:
-      Accept:
-      - application/json; charset=utf-8
-      User-Agent:
-      - Slack Ruby Client/0.15.0
-      Content-Type:
-      - application/x-www-form-urlencoded
-      Accept-Encoding:
-      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
-  response:
-    status:
-      code: 200
-      message: OK
-    headers:
-      Date:
-      - Mon, 06 Jul 2020 14:21:42 GMT
-      Server:
-      - Apache
-      X-Content-Type-Options:
-      - nosniff
-      X-Slack-Req-Id:
-      - b7ad44601d7e0a60c5c68601e15c89c8
-      X-Oauth-Scopes:
-      - channels:read
-      Expires:
-      - Mon, 26 Jul 1997 05:00:00 GMT
-      Cache-Control:
-      - private, no-cache, no-store, must-revalidate
-      X-Xss-Protection:
-      - '0'
-      Vary:
-      - Accept-Encoding
-      Pragma:
-      - no-cache
-      Access-Control-Allow-Headers:
-      - slack-route, x-slack-version-ts, x-b3-traceid, x-b3-spanid, x-b3-parentspanid,
-        x-b3-sampled, x-b3-flags
-      Strict-Transport-Security:
-      - max-age=31536000; includeSubDomains; preload
-      Referrer-Policy:
-      - no-referrer
-      X-Slack-Backend:
-      - r
-      Access-Control-Expose-Headers:
-      - x-slack-req-id, retry-after
-      Access-Control-Allow-Origin:
-      - "*"
-      Content-Length:
-      - '222'
-      Content-Type:
-      - application/json; charset=utf-8
-      X-Via:
-      - haproxy-www-nu22,haproxy-edge-sin-p1t0
-    body:
-      encoding: ASCII-8BIT
-      string: '{"ok":false,"error":"method_deprecated","response_metadata":{"messages":["[ERROR]
-        This method is retired and can no longer be used. Please use conversations.info
-        instead. Learn more: https:\/\/api.slack.com\/changelog\/2020-01-deprecating-antecedents-to-the-conversations-api."]}}'
-  recorded_at: Mon, 06 Jul 2020 14:21:42 GMT
-recorded_with: VCR 6.0.0

data/spec/fixtures/slack/web/groups_info.yml

@@ -1,43 +0,0 @@
----
-http_interactions:
-- request:
-    method: post
-    uri: https://slack.com/api/groups.list
-    body:
-      encoding: UTF-8
-      string: token=token
-  response:
-    status:
-      code: 200
-      message: OK
-    headers:
-      Content-Type:
-      - application/json; charset=utf-8
-    body:
-      encoding: ASCII-8BIT
-      string: '{"ok":true,"groups":[{"id":"G0K7EV5A7","name":"mpdm-dblock--rubybot--player1-1","is_group":true,"created":1453561861,"creator":"U04KB5WQR","is_archived":false,"is_mpim":true,"members":["U04KB5WQR","U0HLFUZLJ","U07518DTL"],"topic":{"value":"Group
-        messaging","creator":"U04KB5WQR","last_set":1453561861},"purpose":{"value":"Group
-        messaging with: @dblock @rubybot @player1","creator":"U04KB5WQR","last_set":1453561861}}]}'
-    http_version:
-  recorded_at: Sat, 23 Jan 2016 15:19:10 GMT
-- request:
-    method: post
-    uri: https://slack.com/api/groups.info
-    body:
-      encoding: UTF-8
-      string: channel=G0K7EV5A7&token=token
-  response:
-    status:
-      code: 200
-      message: OK
-    headers:
-      Content-Type:
-      - application/json; charset=utf-8
-    body:
-      encoding: ASCII-8BIT
-      string: '{"ok":true,"group":{"id":"G0K7EV5A7","name":"mpdm-dblock--rubybot--player1-1","is_group":true,"created":1453561861,"creator":"U04KB5WQR","is_archived":false,"is_mpim":true,"is_open":false,"last_read":"0000000000.000000","latest":null,"unread_count":0,"unread_count_display":0,"members":["U04KB5WQR","U0HLFUZLJ","U07518DTL"],"topic":{"value":"Group
-        messaging","creator":"U04KB5WQR","last_set":1453561861},"purpose":{"value":"Group
-        messaging with: @dblock @rubybot @player1","creator":"U04KB5WQR","last_set":1453561861}}}'
-    http_version:
-  recorded_at: Sat, 23 Jan 2016 15:19:46 GMT
-recorded_with: VCR 3.0.0

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

@@ -1,116 +0,0 @@
-# frozen_string_literal: true
-require 'spec_helper'
-require_relative './it_behaves_like_a_realtime_socket'
-
-begin
-  RSpec.describe Slack::RealTime::Concurrency::Celluloid::Socket do
-    subject { socket }
-
-    let(:driver) { WebSocket::Driver::Client }
-    let(:logger) { ::Logger.new(STDOUT) }
-    let(:ws) { double(driver) }
-    let(:url) { 'wss://echo.websocket.org/websocket/xyz' }
-
-    it_behaves_like 'a realtime socket'
-
-    ['', nil].each do |data|
-      context "finishing run_loop with #{data ? 'empty' : 'nil'} read" do
-        let(:ssl_socket) do
-          Class.new(Celluloid::IO::SSLSocket) do
-            def initialize(data)
-              @data = data
-            end
-
-            def connect; end
-
-            def readpartial(_size)
-              @data
-            end
-          end
-        end
-
-        let(:test_socket) do
-          Class.new(described_class) do
-            def build_socket
-              options[:ssl_socket].new(options[:data])
-            end
-          end
-        end
-
-        let(:socket) do
-          test_socket.new(url, logger: logger, data: data, ssl_socket: ssl_socket)
-        end
-
-        context 'with a driver' do
-          before do
-            socket.instance_variable_set('@driver', ws)
-          end
-
-          context 'consumes data' do
-            it 'runs' do
-              expect(ws).to receive(:emit)
-              expect(ws).to receive(:start)
-              expect(logger).to receive(:debug).with("#{test_socket}#run_loop")
-              socket.run_loop
-            end
-          end
-        end
-      end
-    end
-
-    [EOFError, Errno::ECONNRESET, Errno::EPIPE].each do |err|
-      context "finishing run_loop with #{err}" do
-        let(:test_socket) do
-          Class.new(described_class) do
-            def read
-              raise options[:err]
-            end
-          end
-        end
-
-        let(:socket) do
-          test_socket.new(url, logger: logger, err: err)
-        end
-
-        context 'with a driver' do
-          before do
-            socket.instance_variable_set('@driver', ws)
-          end
-
-          describe '#disconnect!' do
-            it 'closes and nils the websocket' do
-              expect(ws).to receive(:emit)
-              expect(ws).to receive(:close)
-              socket.disconnect!
-            end
-          end
-
-          context 'consumes data' do
-            let(:tcp_socket) { double(::Celluloid::IO::SSLSocket, connect: true) }
-
-            before do
-              allow_any_instance_of(described_class).to(
-                receive(:build_socket).and_return(tcp_socket)
-              )
-            end
-
-            it 'runs' do
-              expect(ws).to receive(:emit)
-              expect(ws).to receive(:start)
-              expect(logger).to receive(:debug).with("#{test_socket}#run_loop")
-              socket.run_loop
-            end
-          end
-        end
-      end
-    end
-
-    describe '#connect!' do
-      pending 'connects'
-      pending 'pings every 30s'
-    end
-
-    pending 'send_data'
-  end
-rescue LoadError
-end