slack-ruby-client 0.1.0

data/examples/hi_real_time/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gem 'slack-ruby-client', path: '../..'

data/examples/hi_real_time/hi.rb

@@ -0,0 +1,27 @@
+require 'slack-ruby-client'
+
+Slack.configure do |config|
+  config.token = ENV['SLACK_API_TOKEN']
+  fail 'Missing ENV[SLACK_API_TOKEN]!' unless config.token
+end
+
+client = Slack::RealTime::Client.new
+
+client.on :hello do
+  puts 'Successfully connected.'
+end
+
+client.on :message do |data|
+  puts data
+
+  client.typing channel: data['channel']
+
+  case data['text']
+  when 'bot hi' then
+    client.message channel: data['channel'], text: "Hi <@#{data['user']}>!"
+  when /^bot/ then
+    client.message channel: data['channel'], text: "Sorry <@#{data['user']}>, what?"
+  end
+end
+
+client.start!

data/examples/hi_real_time_and_web/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gem 'slack-ruby-client', path: '../..'

data/examples/hi_real_time_and_web/hi.rb

@@ -0,0 +1,24 @@
+require 'slack-ruby-client'
+
+Slack.configure do |config|
+  config.token = ENV['SLACK_API_TOKEN']
+  fail 'Missing ENV[SLACK_API_TOKEN]!' unless config.token
+end
+
+client = Slack::RealTime::Client.new
+
+client.on :hello do
+  puts 'Successfully connected.'
+end
+
+client.on :message do |data|
+  puts data
+  case data['text']
+  when 'bot hi' then
+    client.web_client.chat_postMessage channel: data['channel'], text: "Hi <@#{data['user']}>!"
+  when /^bot/ then
+    client.web_client.chat_postMessage channel: data['channel'], text: "Sorry <@#{data['user']}>, what?"
+  end
+end
+
+client.start!

data/examples/hi_web/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gem 'slack-ruby-client', path: '../..'

data/examples/hi_web/hi.rb

@@ -0,0 +1,14 @@
+require 'slack-ruby-client'
+
+Slack.configure do |config|
+  config.token = ENV['SLACK_API_TOKEN']
+  fail 'Missing ENV[SLACK_API_TOKEN]!' unless config.token
+end
+
+client = Slack::Web::Client.new
+
+client.auth_test
+
+general_channel = client.channels_list['channels'].detect { |c| c['name'] == 't3' }
+
+client.chat_postMessage(channel: general_channel['id'], text: 'Hello World', as_user: true)

data/lib/slack-ruby-client.rb

@@ -0,0 +1,23 @@
+require 'slack/version'
+require 'slack/config'
+
+# Web API
+require 'faraday'
+require 'faraday_middleware'
+require 'slack/web/config'
+require 'slack/web/api/error'
+require 'slack/web/faraday/response/raise_error'
+require 'slack/web/faraday/connection'
+require 'slack/web/faraday/request'
+require 'slack/web/api/endpoints'
+require 'slack/web/client'
+
+# RealTime API
+require 'faye/websocket'
+require 'eventmachine'
+require 'slack/real_time/socket'
+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/client'

data/lib/slack.rb

@@ -0,0 +1 @@
+require 'slack-ruby-client'

data/lib/slack/config.rb

@@ -0,0 +1,17 @@
+module Slack
+  module Config
+    extend self
+
+    attr_accessor :token
+  end
+
+  class << self
+    def configure
+      block_given? ? yield(Config) : Config
+    end
+
+    def config
+      Config
+    end
+  end
+end

data/lib/slack/real_time/api/message.rb

@@ -0,0 +1,20 @@
+module Slack
+  module RealTime
+    module Api
+      module Message
+        #
+        # Sends a message to a channel.
+        #
+        # @option options [channel] :channel
+        #   Channel to send message to. Can be a public channel, private group or IM channel. Can be an encoded ID, or a name.
+        # @option options [Object] :text
+        #   Text of the message to send. See below for an explanation of formatting.
+        def message(options = {})
+          throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
+          throw ArgumentError.new('Required arguments :text missing') if options[:text].nil?
+          send_json({ type: 'message', id: next_id }.merge(options))
+        end
+      end
+    end
+  end
+end

data/lib/slack/real_time/api/message_id.rb

@@ -0,0 +1,14 @@
+module Slack
+  module RealTime
+    module Api
+      module MessageId
+        private
+
+        def next_id
+          @next_id ||= 0
+          @next_id += 1
+        end
+      end
+    end
+  end
+end

data/lib/slack/real_time/api/ping.rb

@@ -0,0 +1,16 @@
+module Slack
+  module RealTime
+    module Api
+      module Ping
+        #
+        # Clients should try to quickly detect disconnections, even in idle periods, so that users can easily tell the
+        # difference between being disconnected and everyone being quiet. Not all web browsers support the WebSocket
+        # ping spec, so the RTM protocol also supports ping/pong messages.
+        #
+        def ping(options = {})
+          send_json({ type: 'ping', id: next_id }.merge(options))
+        end
+      end
+    end
+  end
+end

data/lib/slack/real_time/api/typing.rb

@@ -0,0 +1,17 @@
+module Slack
+  module RealTime
+    module Api
+      module Typing
+        #
+        # Send a typing indicator to indicate that the user is currently writing a message.
+        #
+        # @option options [channel] :channel
+        #   Channel to send message to. Can be a public channel, private group or IM channel. Can be an encoded ID, or a name.
+        def typing(options = {})
+          throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
+          send_json({ type: 'typing', id: next_id }.merge(options))
+        end
+      end
+    end
+  end
+end

data/lib/slack/real_time/client.rb

@@ -0,0 +1,91 @@
+module Slack
+  module RealTime
+    class Client
+      class ClientNotStartedError < StandardError; end
+      class ClientAlreadyStartedError < StandardError; end
+
+      include Api::MessageId
+      include Api::Ping
+      include Api::Message
+      include Api::Typing
+
+      attr_accessor :web_client
+
+      def initialize
+        @callbacks = {}
+        @web_client = Slack::Web::Client.new
+      end
+
+      [:url, :team, :self, :users, :channels, :ims, :bots].each do |attr|
+        define_method attr do
+          @options[attr.to_s] if @options
+        end
+      end
+
+      def on(type, &block)
+        type = type.to_s
+        @callbacks[type] ||= []
+        @callbacks[type] << block
+      end
+
+      def start!
+        fail ClientAlreadyStartedError if started?
+        EM.run do
+          @options = web_client.rtm_start
+          @socket = Slack::RealTime::Socket.new(@options['url'])
+
+          @socket.connect! do |ws|
+            ws.on :open do |event|
+              open(event)
+            end
+
+            ws.on :message do |event|
+              dispatch(event)
+            end
+
+            ws.on :close do |event|
+              close(event)
+            end
+          end
+        end
+      end
+
+      def stop!
+        fail ClientNotStartedError unless started?
+        @socket.disconnect! if @socket
+      end
+
+      def started?
+        @socket && @socket.connected?
+      end
+
+      protected
+
+      def send_json(data)
+        fail ClientNotStartedError unless started?
+        @socket.send_data(data.to_json)
+      end
+
+      def open(_event)
+      end
+
+      def close(_event)
+        @socket = nil
+        EM.stop
+      end
+
+      def dispatch(event)
+        return false unless event.data
+        data = JSON.parse(event.data)
+        type = data['type']
+        return false unless type
+        callbacks = @callbacks[type.to_s]
+        return false unless callbacks
+        callbacks.each do |c|
+          c.call(data)
+        end
+        true
+      end
+    end
+  end
+end

data/lib/slack/real_time/socket.rb

@@ -0,0 +1,41 @@
+module Slack
+  module RealTime
+    class Socket
+      attr_accessor :url
+
+      def initialize(url)
+        @url = url
+      end
+
+      def send_data(data)
+        @ws.send(data) if @ws
+      end
+
+      def connect!(&_block)
+        return if connected?
+
+        @ws = Faye::WebSocket::Client.new(url)
+
+        @ws.on :close do |event|
+          close(event)
+        end
+
+        yield @ws if block_given?
+      end
+
+      def disconnect!
+        @ws.close if @ws
+      end
+
+      def connected?
+        !@ws.nil?
+      end
+
+      protected
+
+      def close(_event)
+        @ws = nil
+      end
+    end
+  end
+end

data/lib/slack/version.rb

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

data/lib/slack/web/api/endpoints.rb

@@ -0,0 +1,39 @@
+# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+
+require 'slack/web/api/endpoints/api'
+require 'slack/web/api/endpoints/auth'
+require 'slack/web/api/endpoints/channels'
+require 'slack/web/api/endpoints/chat'
+require 'slack/web/api/endpoints/emoji'
+require 'slack/web/api/endpoints/files'
+require 'slack/web/api/endpoints/groups'
+require 'slack/web/api/endpoints/im'
+require 'slack/web/api/endpoints/oauth'
+require 'slack/web/api/endpoints/presence'
+require 'slack/web/api/endpoints/rtm'
+require 'slack/web/api/endpoints/search'
+require 'slack/web/api/endpoints/stars'
+require 'slack/web/api/endpoints/users'
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        include Api
+        include Auth
+        include Channels
+        include Chat
+        include Emoji
+        include Files
+        include Groups
+        include Im
+        include Oauth
+        include Presence
+        include Rtm
+        include Search
+        include Stars
+        include Users
+      end
+    end
+  end
+end

data/lib/slack/web/api/endpoints/api.rb

@@ -0,0 +1,25 @@
+# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module Api
+          #
+          # Checks API calling code.
+          #
+          # @option options [Object] :error
+          #   Error response to return
+          # @option options [Object] :foo
+          #   example property to return
+          # @see https://api.slack.com/methods/api.test
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/api.test.md
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/api.test.json
+          def api_test(options = {})
+            post('api.test', options)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slack/web/api/endpoints/auth.rb

@@ -0,0 +1,21 @@
+# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module Auth
+          #
+          # Checks authentication & identity.
+          #
+          # @see https://api.slack.com/methods/auth.test
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/auth.test.md
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/auth.test.json
+          def auth_test(options = {})
+            post('auth.test', options)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slack/web/api/endpoints/channels.rb

@@ -0,0 +1,216 @@
+# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module Channels
+          #
+          # Archives a channel.
+          #
+          # @option options [channel] :channel
+          #   Channel to archive
+          # @see https://api.slack.com/methods/channels.archive
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.archive.md
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.archive.json
+          def channels_archive(options = {})
+            throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
+            post('channels.archive', options)
+          end
+
+          #
+          # Creates a channel.
+          #
+          # @option options [Object] :name
+          #   Name of channel to create
+          # @see https://api.slack.com/methods/channels.create
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.create.md
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.create.json
+          def channels_create(options = {})
+            throw ArgumentError.new('Required arguments :name missing') if options[:name].nil?
+            post('channels.create', options)
+          end
+
+          #
+          # Fetches history of messages and events from a channel.
+          #
+          # @option options [channel] :channel
+          #   Channel to fetch history for.
+          # @option options [timestamp] :latest
+          #   Latest message timestamp to include in results.
+          # @option options [timestamp] :oldest
+          #   Oldest message timestamp to include in results.
+          # @option options [Object] :count
+          #   Number of messages to return, between 1 and 1000.
+          # @see https://api.slack.com/methods/channels.history
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.history.md
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.history.json
+          def channels_history(options = {})
+            throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
+            post('channels.history', options)
+          end
+
+          #
+          # Gets information about a channel.
+          #
+          # @option options [channel] :channel
+          #   Channel to get info on
+          # @see https://api.slack.com/methods/channels.info
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.info.md
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.info.json
+          def channels_info(options = {})
+            throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
+            post('channels.info', options)
+          end
+
+          #
+          # Invites a user to a channel.
+          #
+          # @option options [channel] :channel
+          #   Channel to invite user to.
+          # @option options [user] :user
+          #   User to invite to channel.
+          # @see https://api.slack.com/methods/channels.invite
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.invite.md
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.invite.json
+          def channels_invite(options = {})
+            throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
+            throw ArgumentError.new('Required arguments :user missing') if options[:user].nil?
+            post('channels.invite', options)
+          end
+
+          #
+          # Joins a channel, creating it if needed.
+          #
+          # @option options [Object] :name
+          #   Name of channel to join
+          # @see https://api.slack.com/methods/channels.join
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.join.md
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.join.json
+          def channels_join(options = {})
+            throw ArgumentError.new('Required arguments :name missing') if options[:name].nil?
+            post('channels.join', options)
+          end
+
+          #
+          # Removes a user from a channel.
+          #
+          # @option options [channel] :channel
+          #   Channel to remove user from.
+          # @option options [user] :user
+          #   User to remove from channel.
+          # @see https://api.slack.com/methods/channels.kick
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.kick.md
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.kick.json
+          def channels_kick(options = {})
+            throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
+            throw ArgumentError.new('Required arguments :user missing') if options[:user].nil?
+            post('channels.kick', options)
+          end
+
+          #
+          # Leaves a channel.
+          #
+          # @option options [channel] :channel
+          #   Channel to leave
+          # @see https://api.slack.com/methods/channels.leave
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.leave.md
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.leave.json
+          def channels_leave(options = {})
+            throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
+            post('channels.leave', options)
+          end
+
+          #
+          # Lists all channels in a Slack team.
+          #
+          # @option options [Object] :exclude_archived
+          #   Don't return archived channels.
+          # @see https://api.slack.com/methods/channels.list
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.list.md
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.list.json
+          def channels_list(options = {})
+            post('channels.list', options)
+          end
+
+          #
+          # Sets the read cursor in a channel.
+          #
+          # @option options [channel] :channel
+          #   Channel to set reading cursor in.
+          # @option options [timestamp] :ts
+          #   Timestamp of the most recently seen message.
+          # @see https://api.slack.com/methods/channels.mark
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.mark.md
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.mark.json
+          def channels_mark(options = {})
+            throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
+            throw ArgumentError.new('Required arguments :ts missing') if options[:ts].nil?
+            post('channels.mark', options)
+          end
+
+          #
+          # Renames a channel.
+          #
+          # @option options [channel] :channel
+          #   Channel to rename
+          # @option options [Object] :name
+          #   New name for channel.
+          # @see https://api.slack.com/methods/channels.rename
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.rename.md
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.rename.json
+          def channels_rename(options = {})
+            throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
+            throw ArgumentError.new('Required arguments :name missing') if options[:name].nil?
+            post('channels.rename', options)
+          end
+
+          #
+          # Sets the purpose for a channel.
+          #
+          # @option options [channel] :channel
+          #   Channel to set the purpose of
+          # @option options [Object] :purpose
+          #   The new purpose
+          # @see https://api.slack.com/methods/channels.setPurpose
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.setPurpose.md
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.setPurpose.json
+          def channels_setPurpose(options = {})
+            throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
+            throw ArgumentError.new('Required arguments :purpose missing') if options[:purpose].nil?
+            post('channels.setPurpose', options)
+          end
+
+          #
+          # Sets the topic for a channel.
+          #
+          # @option options [channel] :channel
+          #   Channel to set the topic of
+          # @option options [Object] :topic
+          #   The new topic
+          # @see https://api.slack.com/methods/channels.setTopic
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.setTopic.md
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.setTopic.json
+          def channels_setTopic(options = {})
+            throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
+            throw ArgumentError.new('Required arguments :topic missing') if options[:topic].nil?
+            post('channels.setTopic', options)
+          end
+
+          #
+          # Unarchives a channel.
+          #
+          # @option options [channel] :channel
+          #   Channel to unarchive
+          # @see https://api.slack.com/methods/channels.unarchive
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.unarchive.md
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.unarchive.json
+          def channels_unarchive(options = {})
+            throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
+            post('channels.unarchive', options)
+          end
+        end
+      end
+    end
+  end
+end