slack-ruby-client-bhe 0.5.4

data/bin/commands/team.rb

@@ -0,0 +1,32 @@
+# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+
+desc 'Team methods.'
+command 'team' do |g|
+  g.desc 'This method is used to get the access logs for users on a team.'
+  g.long_desc %( This method is used to get the access logs for users on a team. )
+  g.command 'accessLogs' do |c|
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.team_accessLogs(options))
+    end
+  end
+
+  g.desc 'This method provides information about your team.'
+  g.long_desc %( This method provides information about your team. )
+  g.command 'info' do |c|
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.team_info(options))
+    end
+  end
+
+  g.desc 'This method lists the integration activity logs for a team, including when integrations are added, modified and removed. This method can only be called by Admins.'
+  g.long_desc %( This method lists the integration activity logs for a team, including when integrations are added, modified and removed. This method can only be called by Admins. )
+  g.command 'integrationLogs' do |c|
+    c.flag 'service_id', desc: 'Filter logs to this service. Defaults to all logs.'
+    c.flag 'app_id', desc: 'Filter logs to this Slack app. Defaults to all logs.'
+    c.flag 'user', desc: "Filter logs generated by this user's actions. Defaults to all logs."
+    c.flag 'change_type', desc: 'Filter logs with this change type. Defaults to all logs.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.team_integrationLogs(options))
+    end
+  end
+end

data/bin/commands/usergroups.rb

@@ -0,0 +1,73 @@
+# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+
+desc "Get info on your team's user groups."
+command 'usergroups' do |g|
+  g.desc 'This method is used to create a user group.'
+  g.long_desc %( This method is used to create a user group. )
+  g.command 'create' do |c|
+    c.flag 'name', desc: 'A name for the user group. Must be unique among user groups.'
+    c.flag 'handle', desc: 'A mention handle. Must be unique among channels, users and user groups.'
+    c.flag 'description', desc: 'A short description of the user group.'
+    c.flag 'channels', desc: 'A comma separated string of encoded channel IDs for which the user group uses as a default.'
+    c.flag 'include_count', desc: 'Include the number of users in each user group.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.usergroups_create(options))
+    end
+  end
+
+  g.desc 'This method disables an existing user group.'
+  g.long_desc %( This method disables an existing user group. )
+  g.command 'disable' do |c|
+    c.flag 'usergroup', desc: 'The encoded ID of the user group to disable.'
+    c.flag 'include_count', desc: 'Include the number of users in the user group.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.usergroups_disable(options))
+    end
+  end
+
+  g.desc 'This method enables a user group which was previously disabled.'
+  g.long_desc %( This method enables a user group which was previously disabled. )
+  g.command 'enable' do |c|
+    c.flag 'usergroup', desc: 'The encoded ID of the user group to enable.'
+    c.flag 'include_count', desc: 'Include the number of users in the user group.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.usergroups_enable(options))
+    end
+  end
+
+  g.desc 'This method returns a list of all user groups in the team. This can optionally include disabled user groups.'
+  g.long_desc %( This method returns a list of all user groups in the team. This can optionally include disabled user groups. )
+  g.command 'list' do |c|
+    c.flag 'include_disabled', desc: 'Include disabled user groups.'
+    c.flag 'include_count', desc: 'Include the number of users in each user group.'
+    c.flag 'include_users', desc: 'Include the list of users for each user group.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.usergroups_list(options))
+    end
+  end
+
+  g.desc 'This method updates the properties of an existing user group.'
+  g.long_desc %( This method updates the properties of an existing user group. )
+  g.command 'update' do |c|
+    c.flag 'usergroup', desc: 'The encoded ID of the user group to update.'
+    c.flag 'name', desc: 'A name for the user group. Must be unique among user groups.'
+    c.flag 'handle', desc: 'A mention handle. Must be unique among channels, users and user groups.'
+    c.flag 'description', desc: 'A short description of the user group.'
+    c.flag 'channels', desc: 'A comma separated string of encoded channel IDs for which the user group uses as a default.'
+    c.flag 'include_count', desc: 'Include the number of users in the user group.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.usergroups_update(options))
+    end
+  end
+
+  g.desc 'This method updates the list of users that belong to a user group. This method replaces all users in a user group with the list of users provided in the users parameter.'
+  g.long_desc %( This method updates the list of users that belong to a user group. This method replaces all users in a user group with the list of users provided in the users parameter. )
+  g.command 'users' do |c|
+    c.flag 'usergroup', desc: 'The encoded ID of the user group to update.'
+    c.flag 'users', desc: 'A comma separated string of encoded user IDs that represent the entire list of users for the user group.'
+    c.flag 'include_count', desc: 'Include the number of users in the user group.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.usergroups_users(options))
+    end
+  end
+end

data/bin/commands/users.rb

@@ -0,0 +1,57 @@
+# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+
+desc 'Get info on members of your Slack team.'
+command 'users' do |g|
+  g.desc "This method lets you find out information about a user's presence."
+  g.long_desc %( This method lets you find out information about a user's presence. Consult the presence documentation for more details. )
+  g.command 'getPresence' do |c|
+    c.flag 'user', desc: 'User to get presence info on. Defaults to the authed user.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.users_getPresence(options))
+    end
+  end
+
+  g.desc 'This method returns information about a team member.'
+  g.long_desc %( This method returns information about a team member. )
+  g.command 'info' do |c|
+    c.flag 'user', desc: 'User to get info on.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.users_info(options))
+    end
+  end
+
+  g.desc 'This method returns a list of all users in the team. This includes deleted/deactivated users.'
+  g.long_desc %( This method returns a list of all users in the team. This includes deleted/deactivated users. )
+  g.command 'list' do |c|
+    c.flag 'presence', desc: 'Whether to include presence data in the output.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.users_list(options))
+    end
+  end
+
+  g.desc 'This method lets the slack messaging server know that the authenticated user'
+  g.long_desc %( This method lets the slack messaging server know that the authenticated user is currently active. Consult the presence documentation for more details. )
+  g.command 'setActive' do |c|
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.users_setActive(options))
+    end
+  end
+
+  g.desc "This method lets you set the calling user's manual presence."
+  g.long_desc %( This method lets you set the calling user's manual presence. Consult the presence documentation for more details. )
+  g.command 'setPresence' do |c|
+    c.flag 'presence', desc: 'Either auto or away.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.users_setPresence(options))
+    end
+  end
+
+  g.desc 'This method returns the ID of a team user.'
+  g.long_desc %( This method returns the ID of a team user. )
+  g.command 'id' do |c|
+    c.flag 'user', desc: 'User to get ID for, prefixed with @.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.users_id(options))
+    end
+  end
+end

data/bin/slack

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+
+require 'gli'
+require 'slack-ruby-client'
+
+include GLI::App
+
+program_desc 'Slack client.'
+
+default_command :help
+
+switch [:d, :debug], desc: 'Enable debug-level logging.', default_value: false
+flag [:t, 'slack-api-token'], desc: 'Slack API token.', default_value: ENV['SLACK_API_TOKEN']
+flag ['vcr-cassette-name'], desc: 'Offline VCR cassette.'
+
+pre do |global_options, _command, options, _args|
+  # global Slack configuration
+  Slack.config.token = global_options['slack-api-token']
+  help_now! 'Set Slack API token via --slack-api-token or SLACK_API_TOKEN.' unless Slack.config.token && Slack.config.token.length > 0
+
+  if global_options['debug']
+    require 'logger'
+    logger = Logger.new(STDOUT)
+    logger.level = Logger::DEBUG
+    Slack::Web::Client.config.logger = logger
+  end
+
+  $client = Slack::Web::Client.new
+
+  # Offline VCR cassette
+  if global_options['vcr-cassette-name']
+    require 'vcr'
+    VCR.configure do |config|
+      config.cassette_library_dir = 'spec/fixtures/slack'
+      config.hook_into :webmock
+      config.default_cassette_options = { record: :new_episodes }
+    end
+    VCR.insert_cassette global_options['vcr-cassette-name']
+  end
+
+  # remove any nil values from options
+  options.select! { |_k, v| v }
+
+  true
+end
+
+$LOAD_PATH.push File.expand_path('..', __FILE__)
+require 'commands'
+
+exit run(ARGV)

data/examples/hi_real_time/Gemfile

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

data/examples/hi_real_time/hi.rb

@@ -0,0 +1,32 @@
+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, welcome '#{client.self['name']}' to the '#{client.team['name']}' team at https://#{client.team['domain']}.slack.com."
+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.on :close do |_data|
+  puts 'Connection closed, exiting.'
+  EM.stop
+end
+
+client.start!

data/examples/hi_real_time_and_web/Gemfile

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

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, welcome '#{client.self['name']}' to the '#{client.team['name']}' team at https://#{client.team['domain']}.slack.com."
+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_real_time_async/Gemfile

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

data/examples/hi_real_time_async/hi.rb

@@ -0,0 +1,29 @@
+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, welcome '#{client.self['name']}' to the '#{client.team['name']}' team at https://#{client.team['domain']}.slack.com."
+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
+
+EM.run do
+  client.start_async
+end

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,12 @@
+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
+
+client.chat_postMessage(channel: '#general', text: 'Hello World', as_user: true)

data/examples/new_ticket/Gemfile

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

data/examples/new_ticket/new_ticket.rb

@@ -0,0 +1,25 @@
+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
+
+client.chat_postMessage(
+  channel: '#general',
+  as_user: true,
+  attachments: [
+    {
+      fallback: "Ticket #1943: Can't rest my password - https://groove.hq/path/to/ticket/1943",
+      pretext: 'New ticket from Andrea Lee',
+      title: "Ticket #1943: Can't reset my password",
+      title_link: 'https://groove.hq/path/to/ticket/1943',
+      text: 'Help! I tried to reset my password but nothing happened!',
+      color: '#7CD197'
+    }
+  ]
+)

data/lib/slack-ruby-client.rb

@@ -0,0 +1,29 @@
+require 'slack/version'
+require 'slack/config'
+
+# Messages
+require 'slack/messages/formatting'
+
+# Web API
+require 'faraday'
+require 'faraday_middleware'
+require 'json'
+require 'logger'
+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/mixins'
+require 'slack/web/api/endpoints'
+require 'slack/web/client'
+
+# RealTime API
+require 'slack/real_time/concurrency'
+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/config'
+require 'slack/real_time/client'

data/lib/slack.rb

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

data/lib/slack/config.rb

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

data/lib/slack/messages/formatting.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+module Slack
+  module Messages
+    module Formatting
+      class << self
+        #
+        # Unescape a message.
+        # @see https://api.slack.com/docs/formatting
+        #
+        def unescape(message)
+          CGI.unescapeHTML(message.gsub(/[“”]/, '"')
+            .gsub(/[‘’]/, "'")
+            .gsub(/<(?<sign>[?@#!]?)(?<dt>.*?)>/) do |match|
+              sign = $~[:sign]
+              dt = $~[:dt]
+              rhs = dt.split('|', 2).last
+              case sign
+              when '@', '!'
+                "@#{rhs}"
+              when '#'
+                "##{rhs}"
+              else
+                rhs
+              end
+            end)
+        end
+      end
+    end
+  end
+end