slack-ruby-client 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59058e21912e23e38cc9fe877b7edbb463b07c5b
-  data.tar.gz: beb3d5ee788708f684f10430764a7c9c8a70263e
+  metadata.gz: f3ede2b9aafcaacd0d2186d80106272f0faa2857
+  data.tar.gz: 171278a9d042e8c5ef793bebe7b844152bf0f263
 SHA512:
-  metadata.gz: 7df8114e487363c6e5cd5b4ea6a650247ffe4c0062c58b472f2a715888246c1d906658531db405a544ac5952923dade5bb1241a71b4b64a200310e5ac5d0e2a7
-  data.tar.gz: 1d180b4b25cf3c8cd514e40ebe2bb98bab04d0e0f2588f1ac733f61f97de0f1a3e1115266cec3d1b5bbf64e6ee22ce24b6630c1207956042e6eb72f494360ca0
+  metadata.gz: 0f6e90d7c8a2242f2ccb912824f9de373f5a0100cac4f9caf543e62b2029fee95ced93948422a3bd8c44e15f455e96ae650606697e1962784748346c03ad840c
+  data.tar.gz: 8c3506854646e6608207a00fdc9968087378b7e090ec14f7dee0c450368c051dd358c32b66c079c52f6be57149982490f877714537b65ee490fc3ca83fcfa5fa

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### 0.2.1 (8/2/2015)
+
+* Set Slack API token via `Slack::RealTime::Client.new(token: 'token')` and `Slack::Web::Client.new(token: 'token')` - [@dblock](https://github.com/dblock).
+* Set Slack API token via `Slack::RealTime::Client.configure` and `Slack::Web::Client.configure` - [@dblock](https://github.com/dblock).
+
 ### 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).

data/README.md

@@ -32,6 +32,8 @@ Slack.configure do |config|
 end
 ```
 
+This sets a global default token. You can also pass a token into the initializer of both `Slack::Web::Client` and `Slack::RealTime::Client` or configure those separately via `Slack::Web::Config.configure` and `Slack::RealTime::Config.configure`. The instance token will be used over the client type token over the global default.
+
 ### Web Client
 
 The Slack Web API allows you to build applications that interact with Slack. For example, send messages with [chat_PostMessage](https://api.slack.com/methods/chat.postMessage).
@@ -68,6 +70,7 @@ The following settings are supported.
 
 setting      | description
 -------------|-------------------------------------------------------------------------------------------------
+token        | Slack API token.
 user_agent   | User-agent, defaults to _Slack Ruby Client/version_.
 proxy        | Optional HTTP proxy.
 ca_path      | Optional SSL certificates path.
@@ -138,6 +141,7 @@ The following settings are supported.
 
 setting         | description
 ----------------|-----------------------------------------------------------------------------------------------------
+token           | Slack API token.
 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`.
 
@@ -180,6 +184,6 @@ See [CONTRIBUTING](CONTRIBUTING.md).
 
 ## Copyright and License
 
-Copyright (c) 2015, Daniel Doubrovkine, Artsy and [Contributors](CHANGELOG.md).
+Copyright (c) 2015, [Daniel Doubrovkine](https://twitter.com/dblockdotorg), [Artsy](https://www.artsy.net) and [Contributors](CHANGELOG.md).
 
 This project is licensed under the [MIT License](LICENSE.md).

data/lib/slack/real_time/client.rb

@@ -14,10 +14,11 @@ module Slack
 
       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
+        @token ||= Slack.config.token
+        @web_client = Slack::Web::Client.new(token: token)
       end
 
       [:url, :team, :self, :users, :channels, :groups, :ims, :bots].each do |attr|

data/lib/slack/real_time/config.rb

@@ -4,6 +4,7 @@ module Slack
       extend self
 
       ATTRIBUTES = [
+        :token,
         :websocket_ping,
         :websocket_proxy
       ]
@@ -12,6 +13,8 @@ module Slack
 
       def reset
         self.websocket_ping = 30
+        self.websocket_proxy = nil
+        self.token = nil
       end
     end
 

data/lib/slack/version.rb

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

data/lib/slack/web/client.rb

@@ -11,6 +11,7 @@ module Slack
         Slack::Web::Config::ATTRIBUTES.each do |key|
           send("#{key}=", options[key] || Slack::Web.config.send(key))
         end
+        @token ||= Slack.config.token
       end
 
       class << self

data/lib/slack/web/config.rb

@@ -8,7 +8,8 @@ module Slack
         :user_agent,
         :ca_path,
         :ca_file,
-        :endpoint
+        :endpoint,
+        :token
       ]
 
       attr_accessor(*Config::ATTRIBUTES)
@@ -18,6 +19,8 @@ module Slack
         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.token = nil
+        self.proxy = nil
       end
     end
 

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

@@ -21,7 +21,7 @@ module Slack
         private
 
         def request(method, path, options)
-          options = options.merge(token: Slack.config.token)
+          options = options.merge(token: token)
           response = connection.send(method) do |request|
             case method
             when :get, :delete

data/spec/slack/real_time/client_spec.rb

@@ -1,92 +1,123 @@
 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, on: true) }
   let(:url) { 'wss://ms173.slack-msgs.com/websocket/lqcUiAvrKTP-uuid=' }
   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(Slack::RealTime::Socket).to receive(:new).with(url, ping: 30).and_return(socket)
-        allow(socket).to receive(:connect!).and_yield(ws)
-        client.start!
+  context 'token' do
+    before do
+      Slack.configure do |config|
+        config.token = 'global default'
       end
-      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
+    it 'defaults token to global default' do
+      client = Slack::RealTime::Client.new
+      expect(client.token).to eq 'global default'
+      expect(client.web_client.token).to eq 'global default'
+    end
+    context 'with real time config' do
+      before do
+        Slack::RealTime::Client.configure do |config|
+          config.token = 'custom real time token'
         end
       end
-      it 'uses web client to fetch url' do
-        expect(client.web_client).to be_a Slack::Web::Client
+      it 'overrides token to real time config' do
+        client = Slack::RealTime::Client.new
+        expect(client.token).to eq 'custom real time token'
+        expect(client.web_client.token).to eq 'custom real time token'
       end
-      it 'remembers socket' do
-        expect(client.instance_variable_get('@socket')).to eq socket
+      it 'overrides token to specific token' do
+        client = Slack::RealTime::Client.new(token: 'local token')
+        expect(client.token).to eq 'local token'
+        expect(client.web_client.token).to eq 'local token'
       end
-      it 'cannot be invoked twice' do
-        expect do
-          client.start!
-        end.to raise_error Slack::RealTime::Client::ClientAlreadyStartedError
-      end
-      describe '#stop!' do
+    end
+  end
+  context 'client' do
+    let(:client) { Slack::RealTime::Client.new }
+    context 'started' do
+      describe '#start!' do
+        let(:socket) { double(Slack::RealTime::Socket, connected?: true) }
         before do
-          expect(socket).to receive(:disconnect!)
-          client.stop!
+          allow(Slack::RealTime::Socket).to receive(:new).with(url, ping: 30).and_return(socket)
+          allow(socket).to receive(:connect!).and_yield(ws)
+          client.start!
+        end
+        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
+        end
+        it 'remembers socket' do
+          expect(client.instance_variable_get('@socket')).to eq socket
         end
         it 'cannot be invoked twice' do
-          client.instance_variable_set('@socket', nil) # caused by a :close callback
           expect do
+            client.start!
+          end.to raise_error Slack::RealTime::Client::ClientAlreadyStartedError
+        end
+        describe '#stop!' do
+          before do
+            expect(socket).to receive(:disconnect!)
             client.stop!
-          end.to raise_error Slack::RealTime::Client::ClientNotStartedError
+          end
+          it 'cannot be invoked twice' do
+            client.instance_variable_set('@socket', nil) # caused by a :close callback
+            expect do
+              client.stop!
+            end.to raise_error Slack::RealTime::Client::ClientNotStartedError
+          end
         end
-      end
-      describe '#next_id' do
-        it 'increments' do
-          previous_id = client.send(:next_id)
-          expect(client.send(:next_id)).to eq previous_id + 1
+        describe '#next_id' do
+          it 'increments' do
+            previous_id = client.send(:next_id)
+            expect(client.send(:next_id)).to eq previous_id + 1
+          end
         end
       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)
+    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

data/spec/slack/web/client_spec.rb

@@ -51,6 +51,32 @@ RSpec.describe Slack::Web::Client do
         end
       end
     end
+    context 'token' do
+      before do
+        Slack.configure do |config|
+          config.token = 'global default'
+        end
+      end
+      it 'defaults token to global default' do
+        client = Slack::Web::Client.new
+        expect(client.token).to eq 'global default'
+      end
+      context 'with web config' do
+        before do
+          Slack::Web::Client.configure do |config|
+            config.token = 'custom web token'
+          end
+        end
+        it 'overrides token to web config' do
+          client = Slack::Web::Client.new
+          expect(client.token).to eq 'custom web token'
+        end
+        it 'overrides token to specific token' do
+          client = Slack::Web::Client.new(token: 'local token')
+          expect(client.token).to eq 'local token'
+        end
+      end
+    end
     context 'proxy' do
       before do
         Slack::Web::Client.configure do |config|

data/spec/support/token.rb

@@ -0,0 +1,10 @@
+RSpec.configure do |config|
+  config.before do
+    @old_token = Slack::Config.token
+  end
+  config.after do
+    Slack::Config.token = @old_token
+    Slack::Web::Config.reset
+    Slack::RealTime::Config.reset
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-31 00:00:00.000000000 Z
+date: 2015-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -245,6 +245,7 @@ files:
 - spec/slack/web/client_spec.rb
 - spec/spec_helper.rb
 - spec/support/real_time/connected_client.rb
+- spec/support/token.rb
 - spec/support/vcr.rb
 homepage: http://github.com/dblock/slack-ruby-client
 licenses:
@@ -285,4 +286,5 @@ test_files:
 - spec/slack/web/client_spec.rb
 - spec/spec_helper.rb
 - spec/support/real_time/connected_client.rb
+- spec/support/token.rb
 - spec/support/vcr.rb