slack-ruby-client 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bfc38c6f34626b363ad4323f0fab5a791e77ca3b
-  data.tar.gz: dc37a02ec0492a1191f7fe1f495b704be45e344d
+  metadata.gz: 59058e21912e23e38cc9fe877b7edbb463b07c5b
+  data.tar.gz: beb3d5ee788708f684f10430764a7c9c8a70263e
 SHA512:
-  metadata.gz: 0b37c6b2289f5337239d52b199cbf0b224f1a7d8f4c510de22295ca2686f04f15aab992eead738cc69799e63230accdea1636ca9e3e2d9e9723f9ee3985f7e2c
-  data.tar.gz: 5441b5ebb561df58e6233b7444f154f76bd6227b7657c4d402eb444ca709954315e771dbfc99683e481a606b3897f4a14f41bc3e91f79d81380dcee61b03086d
+  metadata.gz: 7df8114e487363c6e5cd5b4ea6a650247ffe4c0062c58b472f2a715888246c1d906658531db405a544ac5952923dade5bb1241a71b4b64a200310e5ac5d0e2a7
+  data.tar.gz: 1d180b4b25cf3c8cd514e40ebe2bb98bab04d0e0f2588f1ac733f61f97de0f1a3e1115266cec3d1b5bbf64e6ee22ce24b6630c1207956042e6eb72f494360ca0

data/.rubocop_todo.yml

@@ -1,11 +1,15 @@
 # This configuration was generated by `rubocop --auto-gen-config`
-# on 2015-07-25 14:51:14 -0400 using RuboCop version 0.32.1.
+# on 2015-07-30 11:21:36 +0200 using RuboCop version 0.32.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 77
+# Offense count: 2
+Metrics/AbcSize:
+  Max: 21
+
+# Offense count: 102
 # Configuration parameters: AllowURI, URISchemes.
 Metrics/LineLength:
   Max: 153
@@ -13,9 +17,9 @@ Metrics/LineLength:
 # Offense count: 3
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 16
+  Max: 19
 
-# Offense count: 26
+# Offense count: 32
 Style/Documentation:
   Enabled: false
 
@@ -29,6 +33,6 @@ Style/FileName:
 Style/MethodName:
   Enabled: false
 
-# Offense count: 2
+# Offense count: 3
 Style/ModuleFunction:
   Enabled: false

data/.travis.yml

@@ -1,5 +1,16 @@
 rvm:
   - 2.2
+  - 2.1
+  - 2.0.0
+  - rbx-2.2.10
+  - jruby-19mode
+  - ruby-head
+  - jruby-head
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
 
 git:
   submodules: false

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+### 0.2.0 (7/31/2015)
+
+* [#2](https://github.com/dblock/slack-ruby-client/pull/2): `Slack::RealTime::Socket` now pings frames every 30s, as recommended by Slack - [@samdoiron](https://github.com/samdoiron).
+* [#3](https://github.com/dblock/slack-ruby-client/issues/3): RealTime client WebSocket frame ping frequency is now configurable with `Slack::RealTime::Client.websocket_ping` - [@dblock](https://github.com/dblock).
+* [#3](https://github.com/dblock/slack-ruby-client/issues/3): RealTime client WebSocket proxy is now configurable with `Slack::RealTime::Client.websocket_proxy` - [@dblock](https://github.com/dblock).
+* [#3](https://github.com/dblock/slack-ruby-client/issues/3): Added global `Slack::Web::Client` and `Slack::RealTime::Client` configuration options via `Slack::Web::Client.configure` and `Slack::RealTime::Client.configure` - [@dblock](https://github.com/dblock).
+* Exposed `Slack::RealTime::Client.url`, `team`, `self`, `users`, `channels`, `groups`, `ims` and `bots` - [@dblock](https://github.com/dblock).
+* Default user-agent for `Slack::Web::Client` now includes a slash, eg. _Slack Ruby Client/0.1.1_ - [@dblock](https://github.com/dblock).
+* Fix: set `Slack::Web::Client` connection options for `ca_path`, `ca_file`, and `proxy` - [@dblock](https://github.com/dblock).
+
 ### 0.1.0 (7/25/2015)
 
 * Initial public release with Web and RealTime Messaging API support - [@dblock](https://github.com/dblock).

data/CONTRIBUTING.md

@@ -1,4 +1,4 @@
-# Contributing to Slack
+# Contributing to Slack-Ruby-Client
 
 This project is work of [many contributors](https://github.com/dblock/slack-ruby-client/graphs/contributors).
 
@@ -6,7 +6,7 @@ You're encouraged to submit [pull requests](https://github.com/dblock/slack-ruby
 
 In the examples below, substitute your Github username for `contributor` in URLs.
 
-## Fork the Project
+### Fork the Project
 
 Fork the [project on Github](https://github.com/dblock/slack-ruby-client) and check out your copy.
 
@@ -16,7 +16,7 @@ cd slack-ruby-client
 git remote add upstream https://github.com/dblock/slack-ruby-client.git
 ```
 
-## Bundle Install and Test
+### Bundle Install and Test
 
 Ensure that you can build the project and run tests.
 
@@ -25,9 +25,9 @@ bundle install
 bundle exec rake
 ```
 
-## Run Slack in Development
+### Run Examples in Development
 
-Create a private slack group for yourself.
+Sign up for Slack, create a private slack group for yourself.
 
 Create a new Bot Integration under [services/new/bot](http://slack.com/services/new/bot).
 
@@ -35,11 +35,11 @@ Create a new Bot Integration under [services/new/bot](http://slack.com/services/
 
 On the next screen, note the API token.
 
-Run `SLACK_API_TOKEN=<your API token> foreman start`.
+To run [the example in examples/hi_real_time](examples/hi_real_time/hi.rb), open a terminal, cd into _examples/hi_real_time_, run `bundle install`, followed by `SLACK_API_TOKEN=<your API token> bundle exec ruby hi.rb`.
 
-You can also create a `.env` file with `SLACK_API_TOKEN=<your API token>` and just run `foreman start`.
+## Contribute Code
 
-## Create a Topic Branch
+### Create a Topic Branch
 
 Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.
 
@@ -49,32 +49,31 @@ git pull upstream master
 git checkout -b my-feature-branch
 ```
 
-## Write Tests
+### Write Tests
 
-Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build.
-Add to [spec](spec).
+Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build. Add tests to [spec](spec).
 
 We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix.
 
-## Write Code
+### Write Code
 
 Implement your feature or bug fix.
 
-Ruby style is enforced with [Rubocop](https://github.com/bbatsov/rubocop).
-Run `bundle exec rubocop` and fix any style issues highlighted.
+Ruby style is enforced with [Rubocop](https://github.com/bbatsov/rubocop). Run `bundle exec rubocop` and fix any style issues highlighted, auto-correct issues when possible with `bundle exec rubocop -a`. To silence generally ingored issues, including line lengths or code complexity metrics, run `bundle exec rubocop --auto-gen-config`.
 
 Make sure that `bundle exec rake` completes without errors.
 
-## Write Documentation
+### Write Documentation
 
 Document any external behavior in the [README](README.md).
 
-## Update Changelog
+### Update Changelog
 
-Add a line to [CHANGELOG](CHANGELOG.md) under *Next Release*.
-Make it look like every other line, including your name and link to your Github account.
+Add a line to [CHANGELOG](CHANGELOG.md) under *Next Release*. Don't remove *Your contribution here*.
 
-## Commit Changes
+Make it look like every other line, including a link to the issue being fixed, your name and link to your Github account.
+
+### Commit Changes
 
 Make sure git knows your name and email address:
 
@@ -90,28 +89,17 @@ git add ...
 git commit
 ```
 
-## Push
+### Push
 
 ```
 git push origin my-feature-branch
 ```
 
-## Make a Pull Request
-
-Go to https://github.com/contributor/slack-ruby-client and select your feature branch.
-Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
-
-## Rebase
-
-If you've been working on a change for a while, rebase with upstream/master.
+### Make a Pull Request
 
-```
-git fetch upstream
-git rebase upstream/master
-git push origin my-feature-branch -f
-```
+Go to https://github.com/contributor/slack-ruby-client and select your feature branch. Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
 
-## Update CHANGELOG Again
+### Update CHANGELOG Again
 
 Update the [CHANGELOG](CHANGELOG.md) with the pull request number. A typical entry looks as follows.
 
@@ -126,11 +114,21 @@ git commit --amend
 git push origin my-feature-branch -f
 ```
 
-## Check on Your Pull Request
+### Rebase
+
+If you've been working on a change for a while, rebase with upstream/master.
+
+```
+git fetch upstream
+git rebase upstream/master
+git push origin my-feature-branch -f
+```
+
+### Check on Your Pull Request
 
 Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI. Everything should look green, otherwise fix issues and amend your commit as described above.
 
-## Be Patient
+### Be Patient
 
 It's likely that your change will not be merged and that the nitpicky maintainers will ask you to do more, or fix seemingly benign problems. Hang on there!
 

data/README.md

@@ -52,6 +52,28 @@ See a fully working example in [examples/hi_web](examples/hi_web/hi.rb).
 
 Refer to the [Slack Web API Method Reference](https://api.slack.com/methods) for the list of all available functions.
 
+You can configure the Web client either globally or via the initializer.
+
+```ruby
+Slack::Web::Client.config do |config|
+  config.user_agent = 'Slack Ruby Client/1.0'
+end
+```
+
+```ruby
+client = Slack::Web::Client.new(user_agent: 'Slack Ruby Client/1.0')
+```
+
+The following settings are supported.
+
+setting      | description
+-------------|-------------------------------------------------------------------------------------------------
+user_agent   | User-agent, defaults to _Slack Ruby Client/version_.
+proxy        | Optional HTTP proxy.
+ca_path      | Optional SSL certificates path.
+ca_file      | Optional SSL certificates file.
+endpoint     | Slack endpoint, default is _https://slack.com/api_.
+
 ### RealTime Client
 
 The Real Time Messaging API is a WebSocket-based API that allows you to receive events from Slack in real time and send messages as user.
@@ -60,7 +82,7 @@ The Real Time Messaging API is a WebSocket-based API that allows you to receive
 client = Slack::RealTime::Client.new
 
 client.on :hello do
-  puts 'Successfully connected.'
+  puts "Successfully connected, welcome '#{client.self['name']}' to the '#{client.team['name']}' team at https://#{client.team['domain']}.slack.com."
 end
 
 client.on :message do |data|
@@ -75,19 +97,59 @@ end
 client.start!
 ```
 
-You can also send typing indicators.
+You can send typing indicators with `typing`.
 
 ```ruby
 client.typing channel: data['channel']
 ```
 
+You can send a ping with `ping`.
+
+```ruby
+client.ping
+```
+
+The client exposes the properties of [rtm.start](https://api.slack.com/methods/rtm.start) upon a successful connection.
+
+property | description
+---------|-------------------------------------------------------------------------------------------------
+url      | A WebSocket Message Server URL.
+self     | Details on the authenticated user.
+team     | Details on the authenticated user's team.
+users    | A list of user objects, one for every member of the team.
+channels | A list of channel objects, one for every channel visible to the authenticated user.
+groups   | A list of group objects, one for every group the authenticated user is in.
+ims      | A list of IM objects, one for every direct message channel visible to the authenticated user.
+bots     | Details of the integrations set up on this team.
+
+You can configure the RealTime client either globally or via the initializer.
+
+```ruby
+Slack::RealTime::Client.config do |config|
+  config.websocket_ping = 42
+end
+```
+
+```ruby
+client = Slack::RealTime::Client.new(websocket_ping: 42)
+```
+
+The following settings are supported.
+
+setting         | description
+----------------|-----------------------------------------------------------------------------------------------------
+websocket_ping  | The number of seconds that indicates how often the WebSocket should send ping frames, default is 30.
+websocket_proxy | Connect via proxy, include `:origin` and `:headers`.
+
+Note that the RealTime client uses a Web client to obtain the WebSocket URL via [rtm.start](https://api.slack.com/methods/rtm.start), configure Web client options via `Slack::Web::Client.configure` as described above.
+
 See a fullly working example in [examples/hi_real_time](examples/hi_real_time/hi.rb).
 
 ![](examples/hi_real_time/hi.gif)
 
 ### Combinging RealTime and Web Clients
 
-Since the web client is used to obtain the RealTime client's WebSocket URL, you can continue using the web client in combination with the RealTime client.
+Since the Web client is used to obtain the RealTime client's WebSocket URL, you can continue using the Web client in combination with the RealTime client.
 
 ```ruby
 client = Slack::RealTime::Client.new

data/RELEASING.md

@@ -1,6 +1,6 @@
-# Releasing SlackRubyClient
+# Releasing Slack-Ruby-Client
 
-There're no particular rules about when to release slack-ruby-client. Release bug fixes frequenty, features not so frequently and breaking API changes rarely.
+There're no hard rules about when to release slack-ruby-client. Release bug fixes frequenty, features not so frequently and breaking API changes rarely.
 
 ### Release
 

data/examples/hi_real_time/hi.rb

@@ -8,7 +8,7 @@ end
 client = Slack::RealTime::Client.new
 
 client.on :hello do
-  puts 'Successfully connected.'
+  puts "Successfully connected, welcome '#{client.self['name']}' to the '#{client.team['name']}' team at https://#{client.team['domain']}.slack.com."
 end
 
 client.on :message do |data|

data/examples/hi_real_time_and_web/hi.rb

@@ -8,7 +8,7 @@ end
 client = Slack::RealTime::Client.new
 
 client.on :hello do
-  puts 'Successfully connected.'
+  puts "Successfully connected, welcome '#{client.self['name']}' to the '#{client.team['name']}' team at https://#{client.team['domain']}.slack.com."
 end
 
 client.on :message do |data|

data/lib/slack-ruby-client.rb

@@ -20,4 +20,5 @@ require 'slack/real_time/api/message_id'
 require 'slack/real_time/api/ping'
 require 'slack/real_time/api/message'
 require 'slack/real_time/api/typing'
+require 'slack/real_time/config'
 require 'slack/real_time/client'

data/lib/slack/real_time/client.rb

@@ -10,13 +10,17 @@ module Slack
       include Api::Typing
 
       attr_accessor :web_client
+      attr_accessor(*Config::ATTRIBUTES)
 
-      def initialize
+      def initialize(options = {})
         @callbacks = {}
         @web_client = Slack::Web::Client.new
+        Slack::RealTime::Config::ATTRIBUTES.each do |key|
+          send("#{key}=", options[key] || Slack::RealTime.config.send(key))
+        end
       end
 
-      [:url, :team, :self, :users, :channels, :ims, :bots].each do |attr|
+      [:url, :team, :self, :users, :channels, :groups, :ims, :bots].each do |attr|
         define_method attr do
           @options[attr.to_s] if @options
         end
@@ -32,7 +36,11 @@ module Slack
         fail ClientAlreadyStartedError if started?
         EM.run do
           @options = web_client.rtm_start
-          @socket = Slack::RealTime::Socket.new(@options['url'])
+
+          socket_options = {}
+          socket_options[:ping] = websocket_ping if websocket_ping
+          socket_options[:proxy] = websocket_proxy if websocket_proxy
+          @socket = Slack::RealTime::Socket.new(@options['url'], socket_options)
 
           @socket.connect! do |ws|
             ws.on :open do |event|
@@ -59,6 +67,16 @@ module Slack
         @socket && @socket.connected?
       end
 
+      class << self
+        def configure
+          block_given? ? yield(Config) : Config
+        end
+
+        def config
+          Config
+        end
+      end
+
       protected
 
       def send_json(data)

data/lib/slack/real_time/config.rb

@@ -0,0 +1,30 @@
+module Slack
+  module RealTime
+    module Config
+      extend self
+
+      ATTRIBUTES = [
+        :websocket_ping,
+        :websocket_proxy
+      ]
+
+      attr_accessor(*Config::ATTRIBUTES)
+
+      def reset
+        self.websocket_ping = 30
+      end
+    end
+
+    class << self
+      def configure
+        block_given? ? yield(Config) : Config
+      end
+
+      def config
+        Config
+      end
+    end
+  end
+end
+
+Slack::RealTime::Config.reset

data/lib/slack/real_time/socket.rb

@@ -2,9 +2,11 @@ module Slack
   module RealTime
     class Socket
       attr_accessor :url
+      attr_accessor :options
 
-      def initialize(url)
+      def initialize(url, options = {})
         @url = url
+        @options = options
       end
 
       def send_data(data)
@@ -14,7 +16,7 @@ module Slack
       def connect!(&_block)
         return if connected?
 
-        @ws = Faye::WebSocket::Client.new(url)
+        @ws = Faye::WebSocket::Client.new(url, nil, options)
 
         @ws.on :close do |event|
           close(event)

data/lib/slack/version.rb

@@ -1,3 +1,3 @@
 module Slack
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/slack/web/client.rb

@@ -12,6 +12,16 @@ module Slack
           send("#{key}=", options[key] || Slack::Web.config.send(key))
         end
       end
+
+      class << self
+        def configure
+          block_given? ? yield(Config) : Config
+        end
+
+        def config
+          Config
+        end
+      end
     end
   end
 end

data/lib/slack/web/config.rb

@@ -15,7 +15,7 @@ module Slack
 
       def reset
         self.endpoint = 'https://slack.com/api/'
-        self.user_agent = "Slack Ruby Client #{Slack::VERSION}"
+        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"
       end

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

@@ -6,11 +6,14 @@ module Slack
 
         def connection
           options = {
-            headers: { 'Accept' => 'application/json; charset=utf-8', 'User-Agent' => user_agent },
-            url: endpoint
+            headers: { 'Accept' => 'application/json; charset=utf-8' }
           }
 
-          ::Faraday::Connection.new(options) do |connection|
+          options[:headers]['User-Agent'] = user_agent if user_agent
+          options[:proxy] = proxy if proxy
+          options[:ssl] = { ca_path: ca_path, ca_file: ca_file }
+
+          ::Faraday::Connection.new(endpoint, options) do |connection|
             connection.use ::Faraday::Request::Multipart
             connection.use ::Faraday::Request::UrlEncoded
             connection.use ::Faraday::Response::RaiseError

data/spec/slack/real_time/client_spec.rb

@@ -2,20 +2,48 @@ require 'spec_helper'
 
 RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_start' } do
   let(:client) { Slack::RealTime::Client.new }
-  let(:ws) { double(Faye::WebSocket::Client) }
+  let(:ws) { double(Faye::WebSocket::Client, on: true) }
   let(:url) { 'wss://ms173.slack-msgs.com/websocket/lqcUiAvrKTP-uuid=' }
-  let(:socket) { double(Slack::RealTime::Socket, connected?: true) }
+  before do
+    allow(EM).to receive(:run).and_yield
+  end
   context 'started' do
     describe '#start!' do
+      let(:socket) { double(Slack::RealTime::Socket, connected?: true) }
       before do
-        allow(EM).to receive(:run).and_yield
-        allow(Slack::RealTime::Socket).to receive(:new).with(url).and_return(socket)
+        allow(Slack::RealTime::Socket).to receive(:new).with(url, ping: 30).and_return(socket)
         allow(socket).to receive(:connect!).and_yield(ws)
-        allow(ws).to receive(:on)
         client.start!
       end
-      it 'sets url' do
-        expect(client.url).to eq url
+      context 'properties provided upon connection' do
+        it 'sets url' do
+          expect(client.url).to eq url
+        end
+        it 'sets team' do
+          expect(client.team['domain']).to eq 'dblockdotorg'
+        end
+        it 'sets self' do
+          expect(client.self['id']).to eq 'U07518DTL'
+        end
+        it 'sets users' do
+          expect(client.users.count).to eq 7
+          expect(client.users.first['id']).to eq 'U07KECJ77'
+        end
+        it 'sets channels' do
+          expect(client.channels.count).to eq 8
+          expect(client.channels.first['name']).to eq 'demo'
+        end
+        it 'sets ims' do
+          expect(client.ims.count).to eq 2
+          expect(client.ims.first['user']).to eq 'USLACKBOT'
+        end
+        it 'sets bots' do
+          expect(client.bots.count).to eq 5
+          expect(client.bots.first['name']).to eq 'bot'
+        end
+        it 'sets groups' do
+          expect(client.groups.count).to eq 0
+        end
       end
       it 'uses web client to fetch url' do
         expect(client.web_client).to be_a Slack::Web::Client
@@ -48,4 +76,83 @@ RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_start' }
       end
     end
   end
+  context 'with defaults' do
+    describe '#initialize' do
+      it 'sets ping' do
+        expect(client.websocket_ping).to eq 30
+      end
+      it "doesn't set proxy" do
+        expect(client.websocket_proxy).to be nil
+      end
+      Slack::RealTime::Config::ATTRIBUTES.each do |key|
+        it "sets #{key}" do
+          expect(client.send(key)).to eq Slack::RealTime::Config.send(key)
+        end
+      end
+    end
+  end
+  context 'with custom settings' do
+    describe '#initialize' do
+      Slack::RealTime::Config::ATTRIBUTES.each do |key|
+        context key do
+          let(:client) { Slack::RealTime::Client.new(key => 'custom') }
+          it "sets #{key}" do
+            expect(client.send(key)).to_not eq Slack::RealTime::Config.send(key)
+            expect(client.send(key)).to eq 'custom'
+          end
+        end
+      end
+    end
+  end
+  context 'global config' do
+    after do
+      Slack::RealTime::Client.config.reset
+    end
+    let(:client) { Slack::RealTime::Client.new }
+    context 'ping' do
+      before do
+        Slack::RealTime::Client.configure do |config|
+          config.websocket_ping = 15
+        end
+      end
+      describe '#initialize' do
+        it 'sets ping' do
+          expect(client.websocket_ping).to eq 15
+        end
+        it 'creates a connection with custom ping' do
+          expect(Faye::WebSocket::Client).to receive(:new).with(url, nil, ping: 15).and_return(ws)
+          client.start!
+        end
+      end
+    end
+    context 'proxy' do
+      before do
+        Slack::RealTime::Client.configure do |config|
+          config.websocket_proxy = {
+            origin: 'http://username:password@proxy.example.com',
+            headers: { 'User-Agent' => 'ruby' }
+          }
+        end
+      end
+      describe '#initialize' do
+        it 'sets proxy' do
+          expect(client.websocket_proxy).to eq(
+            origin: 'http://username:password@proxy.example.com',
+            headers: { 'User-Agent' => 'ruby' }
+          )
+        end
+        it 'creates a connection with custom proxy' do
+          expect(Faye::WebSocket::Client).to receive(:new).with(
+            url,
+            nil,
+            ping: 30,
+            proxy: {
+              origin: 'http://username:password@proxy.example.com',
+              headers: { 'User-Agent' => 'ruby' }
+            }).and_return(ws)
+          client.start!
+        end
+      end
+    end
+  end
 end

data/spec/slack/real_time/socket_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 RSpec.describe Slack::RealTime::Socket do
   context 'with url' do
     let(:url) { 'wss://ms174.slack-msgs.com/websocket/xyz' }
-    let(:socket) { Slack::RealTime::Socket.new(url) }
+    let(:socket) { Slack::RealTime::Socket.new(url, ping: 42) }
     let(:ws) { double(Faye::WebSocket::Client) }
     describe '#initialize' do
       it 'sets url' do
@@ -12,13 +12,17 @@ RSpec.describe Slack::RealTime::Socket do
     end
     describe '#connect!' do
       before do
-        allow(Faye::WebSocket::Client).to receive(:new).and_return(ws)
+        allow(ws).to receive(:on).with(:close)
       end
       it 'connects' do
-        expect(ws).to receive(:on).with(:close)
+        allow(Faye::WebSocket::Client).to receive(:new).and_return(ws)
         socket.connect!
         expect(socket.instance_variable_get('@ws')).to eq ws
       end
+      it 'pings every 30s' do
+        expect(Faye::WebSocket::Client).to receive(:new).with(url, nil, ping: 42).and_return(ws)
+        socket.connect!
+      end
     end
     describe '#disconnect!' do
       it 'closes and nils the websocket' do

data/spec/slack/web/client_spec.rb

@@ -28,4 +28,62 @@ RSpec.describe Slack::Web::Client do
       end
     end
   end
+  context 'global config' do
+    after do
+      Slack::Web::Client.config.reset
+    end
+    let(:client) { Slack::Web::Client.new }
+    context 'user-agent' do
+      before do
+        Slack::Web::Client.configure do |config|
+          config.user_agent = 'custom/user-agent'
+        end
+      end
+      describe '#initialize' do
+        it 'sets user-agent' do
+          expect(client.user_agent).to eq 'custom/user-agent'
+        end
+        it 'creates a connection with the custom user-agent' do
+          expect(client.send(:connection).headers).to eq(
+            'Accept' => 'application/json; charset=utf-8',
+            'User-Agent' => 'custom/user-agent'
+          )
+        end
+      end
+    end
+    context 'proxy' do
+      before do
+        Slack::Web::Client.configure do |config|
+          config.proxy = 'http://localhost:8080'
+        end
+      end
+      describe '#initialize' do
+        it 'sets proxy' do
+          expect(client.proxy).to eq 'http://localhost:8080'
+        end
+        it 'creates a connection with the proxy' do
+          expect(client.send(:connection).proxy.uri.to_s).to eq 'http://localhost:8080'
+        end
+      end
+    end
+    context 'SSL options' do
+      before do
+        Slack::Web::Client.configure do |config|
+          config.ca_path = '/ca_path'
+          config.ca_file = '/ca_file'
+        end
+      end
+      describe '#initialize' do
+        it 'sets ca_path and ca_file' do
+          expect(client.ca_path).to eq '/ca_path'
+          expect(client.ca_file).to eq '/ca_file'
+        end
+        it 'creates a connection with ssl options' do
+          ssl = client.send(:connection).ssl
+          expect(ssl.ca_path).to eq '/ca_path'
+          expect(ssl.ca_file).to eq '/ca_file'
+        end
+      end
+    end
+  end
 end

data/spec/support/real_time/connected_client.rb

@@ -5,7 +5,7 @@ RSpec.shared_context 'connected client' do
   let(:socket) { double(Slack::RealTime::Socket, connected?: true) }
   before do
     allow(EM).to receive(:run).and_yield
-    allow(Slack::RealTime::Socket).to receive(:new).with(url).and_return(socket)
+    allow(Slack::RealTime::Socket).to receive(:new).with(url, ping: 30).and_return(socket)
     allow(socket).to receive(:connect!).and_yield(ws)
     allow(ws).to receive(:on)
     client.start!

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-25 00:00:00.000000000 Z
+date: 2015-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -200,6 +200,7 @@ files:
 - lib/slack/real_time/api/ping.rb
 - lib/slack/real_time/api/typing.rb
 - lib/slack/real_time/client.rb
+- lib/slack/real_time/config.rb
 - lib/slack/real_time/socket.rb
 - lib/slack/version.rb
 - lib/slack/web/api/endpoints.rb