Skip to content

Commit

Permalink
Remove faye
Browse files Browse the repository at this point in the history
Add changelog

Remove faye from CI

Improve readme
  • Loading branch information
wasabigeek committed Jan 23, 2021
1 parent cd39ecd commit 8c80837
Show file tree
Hide file tree
Showing 12 changed files with 7 additions and 225 deletions.
14 changes: 0 additions & 14 deletions .rubocop_todo.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,6 @@ Lint/RedundantCopDisableDirective:
Exclude:
- 'lib/slack-ruby-client.rb'

# Offense count: 2
# Configuration parameters: AllowComments.
Lint/SuppressedException:
Exclude:
- 'spec/slack/real_time/concurrency/celluloid_spec.rb'
- 'spec/slack/real_time/concurrency/eventmachine_spec.rb'

# Offense count: 11
# Configuration parameters: IgnoredMethods.
Metrics/AbcSize:
Expand Down Expand Up @@ -56,11 +49,6 @@ Performance/RegexpMatch:
Exclude:
- 'lib/tasks/web.rake'

# Offense count: 1
RSpec/AnyInstance:
Exclude:
- 'spec/slack/real_time/concurrency/celluloid_spec.rb'

# Offense count: 5
# Cop supports --auto-correct.
RSpec/ContextMethod:
Expand Down Expand Up @@ -134,8 +122,6 @@ RSpec/VerifiedDoubles:
Exclude:
- 'spec/slack/events/request_spec.rb'
- 'spec/slack/real_time/client_spec.rb'
- 'spec/slack/real_time/concurrency/celluloid_spec.rb'
- 'spec/slack/real_time/concurrency/eventmachine_spec.rb'
- 'spec/slack/web/faraday/response/raise_error_spec.rb'
- 'spec/support/real_time/connected_client.rb'

Expand Down
2 changes: 0 additions & 2 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ matrix:
- rvm: 2.4.1
script:
- bundle exec danger
- rvm: 2.4.1
env: CONCURRENCY=faye-websocket
- rvm: 2.5.3
env: CONCURRENCY=async-websocket
allow_failures:
Expand Down
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
### 0.16.0 (Next)

* [#348](https://github.com/slack-ruby/slack-ruby-client/pull/348): Added `admin_conversations_archive`, `admin_conversations_convertToPrivate`, `admin_conversations_create`, `admin_conversations_delete`, `admin_conversations_disconnectShared`, `admin_conversations_getConversationPrefs`, `admin_conversations_getTeams`, `admin_conversations_invite`, `admin_conversations_rename`, `admin_conversations_search`, `admin_conversations_setConversationPrefs`, `admin_conversations_unarchive`, `admin_conversations_ekm_listOriginalConnectedChannelInfo`, `admin_users_session_invalidate`, `apps_event_authorizations_list`, `conversations_mark`, `workflows_stepCompleted`, `workflows_stepFailed` and `workflows_updateStep` endpoints - [@wasabigeek](https://github.com/wasabigeek).
* [#350](https://github.com/slack-ruby/slack-ruby-client/pull/350): Handle server errors such as timouts & non-json responses (see [Upgrading to 0.16.0](UPGRADING.md#upgrading-to--0160)) - [@ojab](https://github.com/ojab).
* [#354](https://github.com/slack-ruby/slack-ruby-client/pull/354): Rewind body after checking request signature - [@sunny](https://github.com/sunny).
* [#355](https://github.com/slack-ruby/slack-ruby-client/pull/355): Removed celluloid concurrency support - [@wasabigeek](https://github.com/wasabigeek).
* [#355](https://github.com/slack-ruby/slack-ruby-client/pull/355), [#357](https://github.com/slack-ruby/slack-ruby-client/pull/357): Remove celluloid and faye-websocket support - [@wasabigeek](https://github.com/wasabigeek).
* [#356](https://github.com/slack-ruby/slack-ruby-client/pull/356): Added `admin_apps_clearResolution`, `admin_conversations_getCustomRetention`, `admin_conversations_removeCustomRetention`, `admin_conversations_setCustomRetention` and `admin_users_session_list` endpoints - [@dblock](https://github.com/dblock).
* [#348](https://github.com/slack-ruby/slack-ruby-client/pull/348): Added `admin_conversations_archive`, `admin_conversations_convertToPrivate`, `admin_conversations_create`, `admin_conversations_delete`, `admin_conversations_disconnectShared`, `admin_conversations_getConversationPrefs`, `admin_conversations_getTeams`, `admin_conversations_invite`, `admin_conversations_rename`, `admin_conversations_search`, `admin_conversations_setConversationPrefs`, `admin_conversations_unarchive`, `admin_conversations_ekm_listOriginalConnectedChannelInfo`, `admin_users_session_invalidate`, `apps_event_authorizations_list`, `conversations_mark`, `workflows_stepCompleted`, `workflows_stepFailed` and `workflows_updateStep` endpoints - [@wasabigeek](https://github.com/wasabigeek).
* Your contribution here.

### 0.15.1 (2020/9/3)
Expand Down
17 changes: 3 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,6 @@ A Ruby client for the Slack [Web](https://api.slack.com/web), [RealTime Messagin
- [Large Team Considerations](#large-team-considerations)
- [Concurrency](#concurrency)
- [Async](#async)
- [Faye::Websocket with Eventmachine](#fayewebsocket-with-eventmachine)
- [Events API](#events-api)
- [Configuring Slack::Events](#configuring-slackevents)
- [Verifying the Request Signature](#verifying-the-request-signature)
Expand Down Expand Up @@ -81,7 +80,7 @@ Add to Gemfile.
gem 'slack-ruby-client'
```

If you're going to be using the RealTime client, add either `async-websocket`, `eventmachine` and `faye-websocket`. See below for more information about concurrency. We recommend you use `async-websocket`.
If you're going to be using the RealTime client, add `async-websocket`. See below for more information about concurrency.

```
gem 'async-websocket', '~> 0.8.0'
Expand Down Expand Up @@ -494,7 +493,7 @@ See [#134](https://github.com/slack-ruby/slack-ruby-client/issues/134) for a dis

#### Concurrency

`Slack::RealTime::Client` needs help from a concurrency library and supports [Async](https://github.com/socketry/async) and [Faye::WebSocket](https://github.com/faye/faye-websocket-ruby) with [Eventmachine](https://github.com/eventmachine/eventmachine). It will auto-detect one or the other depending on the gems in your Gemfile, but you can also set concurrency explicitly.
`Slack::RealTime::Client` needs help from a concurrency library and supports [Async](https://github.com/socketry/async).

```ruby
Slack::RealTime.configure do |config|
Expand All @@ -512,24 +511,14 @@ client.start_async

##### Async

This is the recommended library. Add `async-websocket` to your Gemfile.
Add `async-websocket` to your Gemfile.

```
gem 'async-websocket'
```

See a fully working example in [examples/hi_real_time_async_async](examples/hi_real_time_async_async/hi.rb).

##### Faye::Websocket with Eventmachine

Add the following to your Gemfile.

```
gem 'faye-websocket'
```

See a fully working example in [examples/hi_real_time_async_eventmachine](examples/hi_real_time_async_eventmachine/hi.rb).

### Events API

This library provides limited support for the [Slack Events API](https://api.slack.com/events-api).
Expand Down
7 changes: 0 additions & 7 deletions examples/hi_real_time_async_eventmachine/Gemfile

This file was deleted.

2 changes: 0 additions & 2 deletions examples/hi_real_time_async_eventmachine/Procfile

This file was deleted.

39 changes: 0 additions & 39 deletions examples/hi_real_time_async_eventmachine/hi.rb

This file was deleted.

1 change: 0 additions & 1 deletion lib/slack/real_time/concurrency.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ module Slack
module RealTime
module Concurrency
autoload :Async, 'slack/real_time/concurrency/async'
autoload :Eventmachine, 'slack/real_time/concurrency/eventmachine'
end
end
end
85 changes: 0 additions & 85 deletions lib/slack/real_time/concurrency/eventmachine.rb

This file was deleted.

2 changes: 1 addition & 1 deletion lib/slack/real_time/config.rb
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ def concurrency
private

def detect_concurrency
%i[Async Eventmachine].each do |concurrency|
%i[Async].each do |concurrency|
begin
return Slack::RealTime::Concurrency.const_get(concurrency)
rescue LoadError, NameError
Expand Down
2 changes: 1 addition & 1 deletion lib/slack/web/api/slack-api-ref
Submodule slack-api-ref updated 157 files
57 changes: 0 additions & 57 deletions spec/slack/real_time/concurrency/eventmachine_spec.rb

This file was deleted.

0 comments on commit 8c80837

Please sign in to comment.