slack-ruby-client-bhe 0.5.4

data/lib/slack/web/api/schema/method.json

@@ -0,0 +1,45 @@
+{
+  "type": "object",
+  "required": [
+    "desc",
+    "args",
+    "errors"
+  ],
+  "properties": {
+    "desc": {
+      "type": "string"
+    },
+    "args": {
+      "type": "object",
+      "default": {},
+      "patternProperties": {
+        "^.+$": {
+          "properties": {
+            "required": {
+              "type": "bool",
+              "default": false
+            },
+            "example": {
+              "type": "any",
+              "required": false,
+              "default": ""
+            },
+            "type": {
+              "type": "any",
+              "required": false,
+              "default": "Object"
+            },
+            "desc": {
+              "type": "string",
+              "required": true
+            }
+          }
+        }
+      }
+    },
+    "errors": {
+      "type": "object",
+      "default": {}
+    }
+  }
+}

data/lib/slack/web/api/tasks/generate.rake

@@ -0,0 +1,61 @@
+# largely from https://github.com/aki017/slack-ruby-gem
+require 'json-schema'
+require 'erubis'
+
+namespace :slack do
+  namespace :web do
+    namespace :api do
+      # update slack-api-ref from https://github.com/dblock/slack-api-ref
+      task :git_update do
+        sh 'git submodule update --init --recursive'
+        sh 'git submodule foreach git pull origin master'
+      end
+
+      desc 'Update API.'
+      task update: [:git_update] do
+        group_schema = JSON.parse(File.read('lib/slack/web/api/schema/group.json'))
+        groups = Dir.glob('lib/slack/web/api/slack-api-ref/groups/**/*.json').each_with_object({}) do |path, result|
+          name = File.basename(path, '.json')
+          parsed = JSON.parse(File.read(path))
+          JSON::Validator.validate(group_schema, parsed, insert_defaults: true)
+          result[name] = parsed
+        end
+
+        method_schema = JSON.parse(File.read('lib/slack/web/api/schema/method.json'))
+        data = [
+          Dir.glob('lib/slack/web/api/slack-api-ref/methods/**/*.json'),
+          Dir.glob('lib/slack/web/api/mixins/**/*.json')
+        ].flatten.each_with_object({}) do |path, result|
+          name = File.basename(path, '.json')
+          prefix, name = name.split('.')
+          result[prefix] ||= {}
+          parsed = JSON.parse(File.read(path))
+          JSON::Validator.validate(method_schema, parsed, insert_defaults: true)
+          result[prefix][name] = parsed
+        end
+
+        method_template = Erubis::Eruby.new(File.read('lib/slack/web/api/templates/method.erb'))
+        command_template = Erubis::Eruby.new(File.read('lib/slack/web/api/templates/command.erb'))
+        data.each_with_index do |(group, names), index|
+          printf "%2d/%2d %10s %s\n", index, data.size, group, names.keys
+          # method
+          rendered_method = method_template.result(group: group, names: names)
+          File.write "lib/slack/web/api/endpoints/#{group}.rb", rendered_method
+          Dir.glob("lib/slack/web/api/patches/#{group}*.patch").sort.each do |patch|
+            puts "- patching #{patch}"
+            system("git apply #{patch}") || fail('failed to apply patch')
+          end
+          # command
+          rendered_command = command_template.result(group: groups[group], names: names)
+          File.write "bin/commands/#{group}.rb", rendered_command
+        end
+
+        endpoints_template = Erubis::Eruby.new(File.read('lib/slack/web/api/templates/endpoints.erb'))
+        File.write 'lib/slack/web/api/endpoints.rb', endpoints_template.result(files: data.keys)
+
+        commands_template = Erubis::Eruby.new(File.read('lib/slack/web/api/templates/commands.erb'))
+        File.write 'bin/commands.rb', commands_template.result(files: data.keys)
+      end
+    end
+  end
+end

data/lib/slack/web/api/templates/command.erb

@@ -0,0 +1,34 @@
+# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+
+<% desc = group['desc'] || "#{group['name'].capitalize} methods." %>
+<% if desc.include?("'")  %>
+desc "<%= desc %>"
+<% else %>
+desc '<%= desc %>'
+<% end %>
+command '<%= group['name'] %>' do |g|
+<% names.each_with_index do |(name, data), index| %>
+<% if index > 0 %>
+
+<% end %>
+  <% short_desc = data["desc"].split("\n").first %>
+  <% if short_desc.include?("'")  %>
+  g.desc "<%= short_desc %>"
+  <% else %>
+  g.desc '<%= short_desc %>'
+  <% end %>
+  g.long_desc %( <%= data["desc"].split("\n").join(" ") %> )
+  g.command '<%= name %>' do |c|
+  <% data["args"].each do |arg_name, arg_v| %>
+    <% if arg_v["desc"].include?("'")  %>
+    c.flag '<%= arg_name %>', desc: "<%= arg_v["desc"] %>"
+    <% else %>
+    c.flag '<%= arg_name %>', desc: '<%= arg_v["desc"] %>'
+    <% end %>
+  <% end %>
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.<%=group['name'] %>_<%= name %>(options))
+    end
+  end
+<% end %>
+end

data/lib/slack/web/api/templates/commands.erb

@@ -0,0 +1,5 @@
+# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+
+<% files.each do |f| %>
+require 'commands/<%= f %>'
+<% end %>

data/lib/slack/web/api/templates/endpoints.erb

@@ -0,0 +1,21 @@
+# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+
+<% files.each do |f| %>
+require 'slack/web/api/endpoints/<%= f %>'
+<% end %>
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        include Slack::Web::Api::Mixins::Channels
+        include Slack::Web::Api::Mixins::Users
+        include Slack::Web::Api::Mixins::Groups
+
+<% files.each do |f| %>
+        include <%= f.capitalize %>
+<% end %>
+      end
+    end
+  end
+end

data/lib/slack/web/api/templates/method.erb

@@ -0,0 +1,49 @@
+# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module <%= group.capitalize %>
+<% names.each_with_index do |(name, data), index| %>
+<% next if data['mixin'] %>
+<% if index > 0 %>
+
+<% end %>
+          #
+<% data['desc'].split("\n").each do |line| %>
+          # <%= line %>
+<% end %>
+          #
+<% data['args'].each do |arg_name, arg_v| %>
+          # @option options [<%= arg_v['type'] %>] :<%= arg_name %>
+<% arg_v['desc'].lines.each do |l| %>
+<% if l.strip.length > 0 %>
+          #   <%= l.strip %>
+<% else %>
+          #
+<% end %>
+<% end %>
+<% end %>
+          # @see https://api.slack.com/methods/<%= group %>.<%= name %>
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/<%= group %>.<%= name %>.json
+          def <%= group %>_<%= name %>(options = {})
+<% data['args'].select{ |k, v| v['required'] }.each do |arg_name, arg_v| %>
+            throw ArgumentError.new('Required arguments :<%= arg_name %> missing') if options[:<%= arg_name %>].nil?
+<% end %>
+<% if data['group'] == 'groups' && data['args']['channel'] && !data['args']['channel']['desc'].include?('Can be an encoded ID, or a name.') %>
+            options = options.merge(channel: groups_id(options)['group']['id']) if options[:channel]
+<% elsif data['args']['channel'] && !data['args']['channel']['desc'].include?('Can be an encoded ID, or a name.') %>
+            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
+<% end %>
+<% if data['args']['user'] %>
+            options = options.merge(user: users_id(options)['user']['id']) if options[:user]
+<% end %>
+            post('<%= group %>.<%= name %>', options)
+          end
+<% end %>
+        end
+      end
+    end
+  end
+end

data/lib/slack/web/client.rb

@@ -0,0 +1,28 @@
+module Slack
+  module Web
+    class Client
+      include Faraday::Connection
+      include Faraday::Request
+      include Api::Endpoints
+
+      attr_accessor(*Config::ATTRIBUTES)
+
+      def initialize(options = {})
+        Slack::Web::Config::ATTRIBUTES.each do |key|
+          send("#{key}=", options[key] || Slack::Web.config.send(key))
+        end
+        @token ||= Slack.config.token
+      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

@@ -0,0 +1,41 @@
+module Slack
+  module Web
+    module Config
+      extend self
+
+      ATTRIBUTES = [
+        :proxy,
+        :user_agent,
+        :ca_path,
+        :ca_file,
+        :logger,
+        :endpoint,
+        :token
+      ]
+
+      attr_accessor(*Config::ATTRIBUTES)
+
+      def reset
+        self.endpoint = 'https://slack.com/api/'
+        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
+        self.logger = nil
+      end
+    end
+
+    class << self
+      def configure
+        block_given? ? yield(Config) : Config
+      end
+
+      def config
+        Config
+      end
+    end
+  end
+end
+
+Slack::Web::Config.reset

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

@@ -0,0 +1,29 @@
+module Slack
+  module Web
+    module Faraday
+      module Connection
+        private
+
+        def connection
+          options = {
+            headers: { 'Accept' => 'application/json; charset=utf-8' }
+          }
+
+          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 ::Slack::Web::Faraday::Response::RaiseError
+            connection.use ::FaradayMiddleware::ParseJson
+            connection.use ::Faraday::Response::RaiseError
+            connection.response :logger, logger if logger
+            connection.adapter ::Faraday.default_adapter
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+module Slack
+  module Web
+    module Faraday
+      module Request
+        def get(path, options = {})
+          request(:get, path, options)
+        end
+
+        def post(path, options = {})
+          request(:post, path, options)
+        end
+
+        def put(path, options = {})
+          request(:put, path, options)
+        end
+
+        def delete(path, options = {})
+          request(:delete, path, options)
+        end
+
+        private
+
+        def request(method, path, options)
+          options = options.merge(token: token)
+          response = connection.send(method) do |request|
+            case method
+            when :get, :delete
+              request.url(path, options)
+            when :post, :put
+              request.path = path
+              request.body = options unless options.empty?
+            end
+          end
+          response.body
+        end
+      end
+    end
+  end
+end

data/lib/slack/web/faraday/response/raise_error.rb

@@ -0,0 +1,15 @@
+module Slack
+  module Web
+    module Faraday
+      module Response
+        class RaiseError < ::Faraday::Response::Middleware
+          def on_complete(env)
+            body = env.body
+            return if body['ok']
+            fail Slack::Web::Api::Error.new(body['error'], env.response)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slack_ruby_client.rb

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

data/slack-ruby-client.gemspec

@@ -0,0 +1,31 @@
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'slack/version'
+
+Gem::Specification.new do |s|
+  s.name = 'slack-ruby-client-bhe'
+  s.bindir = 'bin'
+  s.executables << 'slack'
+  s.version = Slack::VERSION
+  s.authors = ['Daniel Doubrovkine']
+  s.email = 'dblock@dblock.org'
+  s.platform = Gem::Platform::RUBY
+  s.required_rubygems_version = '>= 1.3.6'
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- spec/*`.split("\n")
+  s.require_paths = ['lib']
+  s.homepage = 'http://github.com/dblock/slack-ruby-client'
+  s.licenses = ['MIT']
+  s.summary = 'Slack Web and RealTime API client.'
+  s.add_dependency 'faraday'
+  s.add_dependency 'faraday_middleware'
+  s.add_dependency 'json'
+  s.add_dependency 'websocket-driver'
+  s.add_dependency 'gli'
+  s.add_development_dependency 'erubis'
+  s.add_development_dependency 'json-schema'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'vcr'
+  s.add_development_dependency 'webmock'
+  s.add_development_dependency 'rubocop', '0.35.0'
+end

data/spec/fixtures/slack/web/429_error.yml

@@ -0,0 +1,83 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://slack.com/api/auth.test
+    body:
+      encoding: UTF-8
+      string: token=
+    headers:
+      Accept:
+      - application/json; charset=utf-8
+      User-Agent:
+      - Slack Ruby Client 0.1.0
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 429
+      message: OK
+    headers:
+      Access-Control-Allow-Origin:
+      - '*'
+      Date:
+      - Sat, 25 Jul 2015 14:42:07 GMT
+      Server:
+      - Apache
+      Connection:
+      - keep-alive
+    body:
+      encoding: US-ASCII
+      string: ''
+    http_version: 
+  recorded_at: Sat, 25 Jul 2015 14:42:08 GMT
+- request:
+    method: post
+    uri: https://slack.com/api/auth.test
+    body:
+      encoding: UTF-8
+      string: token
+    headers:
+      Accept:
+      - application/json; charset=utf-8
+      User-Agent:
+      - Slack Ruby Client/0.5.0
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Origin:
+      - '*'
+      Content-Security-Policy:
+      - referrer no-referrer;
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Tue, 24 Nov 2015 20:03:05 GMT
+      Server:
+      - Apache
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubDomains; preload
+      X-Accepted-Oauth-Scopes:
+      - identify
+      X-Content-Type-Options:
+      - nosniff
+      X-Xss-Protection:
+      - '0'
+      Content-Length:
+      - '33'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"ok":false,"error":"not_authed"}'
+    http_version: 
+  recorded_at: Tue, 24 Nov 2015 20:03:05 GMT
+recorded_with: VCR 2.9.3