slack-ruby-client 0.1.0

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

@@ -0,0 +1,32 @@
+# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module Oauth
+          #
+          # Exchanges a temporary OAuth code for an API token.
+          #
+          # @option options [Object] :client_id
+          #   Issued when you created your application.
+          # @option options [Object] :client_secret
+          #   Issued when you created your application.
+          # @option options [Object] :code
+          #   The `code` param returned via the OAuth callback.
+          # @option options [Object] :redirect_uri
+          #   This must match the originally submitted URI (if one was sent).
+          # @see https://api.slack.com/methods/oauth.access
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/oauth.access.md
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/oauth.access.json
+          def oauth_access(options = {})
+            throw ArgumentError.new('Required arguments :client_id missing') if options[:client_id].nil?
+            throw ArgumentError.new('Required arguments :client_secret missing') if options[:client_secret].nil?
+            throw ArgumentError.new('Required arguments :code missing') if options[:code].nil?
+            post('oauth.access', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module Presence
+          #
+          # Manually set user presence
+          #
+          # @option options [Object] :presence
+          #   Either `active` or `away`
+          # @see https://api.slack.com/methods/presence.set
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/presence.set.md
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/presence.set.json
+          def presence_set(options = {})
+            throw ArgumentError.new('Required arguments :presence missing') if options[:presence].nil?
+            post('presence.set', options)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slack/web/api/endpoints/rtm.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 Rtm
+          #
+          # Starts a Real Time Messaging session.
+          #
+          # @see https://api.slack.com/methods/rtm.start
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/rtm.start.md
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/rtm.start.json
+          def rtm_start(options = {})
+            post('rtm.start', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,68 @@
+# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module Search
+          #
+          # Searches for messages and files matching a query.
+          #
+          # @option options [Object] :query
+          #   Search query. May contains booleans, etc.
+          # @option options [Object] :sort
+          #   Return matches sorted by either `score` or `timestamp`.
+          # @option options [Object] :sort_dir
+          #   Change sort direction to ascending (`asc`) or descending (`desc`).
+          # @option options [Object] :highlight
+          #   Pass a value of `1` to enable query highlight markers (see below).
+          # @see https://api.slack.com/methods/search.all
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/search.all.md
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/search.all.json
+          def search_all(options = {})
+            throw ArgumentError.new('Required arguments :query missing') if options[:query].nil?
+            post('search.all', options)
+          end
+
+          #
+          # Searches for files matching a query.
+          #
+          # @option options [Object] :query
+          #   Search query. May contains booleans, etc.
+          # @option options [Object] :sort
+          #   Return matches sorted by either `score` or `timestamp`.
+          # @option options [Object] :sort_dir
+          #   Change sort direction to ascending (`asc`) or descending (`desc`).
+          # @option options [Object] :highlight
+          #   Pass a value of `1` to enable query highlight markers (see below).
+          # @see https://api.slack.com/methods/search.files
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/search.files.md
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/search.files.json
+          def search_files(options = {})
+            throw ArgumentError.new('Required arguments :query missing') if options[:query].nil?
+            post('search.files', options)
+          end
+
+          #
+          # Searches for messages matching a query.
+          #
+          # @option options [Object] :query
+          #   Search query. May contains booleans, etc.
+          # @option options [Object] :sort
+          #   Return matches sorted by either `score` or `timestamp`.
+          # @option options [Object] :sort_dir
+          #   Change sort direction to ascending (`asc`) or descending (`desc`).
+          # @option options [Object] :highlight
+          #   Pass a value of `1` to enable query highlight markers (see below).
+          # @see https://api.slack.com/methods/search.messages
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/search.messages.md
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/search.messages.json
+          def search_messages(options = {})
+            throw ArgumentError.new('Required arguments :query missing') if options[:query].nil?
+            post('search.messages', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module Stars
+          #
+          # Lists stars for a user.
+          #
+          # @option options [user] :user
+          #   Show stars by this user. Defaults to the authed user.
+          # @see https://api.slack.com/methods/stars.list
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/stars.list.md
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/stars.list.json
+          def stars_list(options = {})
+            post('stars.list', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module Users
+          #
+          # Gets user presence information.
+          #
+          # @option options [user] :user
+          #   User to get presence info on. Defaults to the authed user.
+          # @see https://api.slack.com/methods/users.getPresence
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/users.getPresence.md
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/users.getPresence.json
+          def users_getPresence(options = {})
+            throw ArgumentError.new('Required arguments :user missing') if options[:user].nil?
+            post('users.getPresence', options)
+          end
+
+          #
+          # Gets information about a user.
+          #
+          # @option options [user] :user
+          #   User to get info on
+          # @see https://api.slack.com/methods/users.info
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/users.info.md
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/users.info.json
+          def users_info(options = {})
+            throw ArgumentError.new('Required arguments :user missing') if options[:user].nil?
+            post('users.info', options)
+          end
+
+          #
+          # Lists all users in a Slack team.
+          #
+          # @see https://api.slack.com/methods/users.list
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/users.list.md
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/users.list.json
+          def users_list(options = {})
+            post('users.list', options)
+          end
+
+          #
+          # Marks a user as active.
+          #
+          # @see https://api.slack.com/methods/users.setActive
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/users.setActive.md
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/users.setActive.json
+          def users_setActive(options = {})
+            post('users.setActive', options)
+          end
+
+          #
+          # Manually sets user presence.
+          #
+          # @option options [Object] :presence
+          #   Either `auto` or `away`
+          # @see https://api.slack.com/methods/users.setPresence
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/users.setPresence.md
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/users.setPresence.json
+          def users_setPresence(options = {})
+            throw ArgumentError.new('Required arguments :presence missing') if options[:presence].nil?
+            post('users.setPresence', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+module Slack
+  module Web
+    module Api
+      class Error < ::Faraday::Error
+      end
+    end
+  end
+end

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,37 @@
+# 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-docs from https://github.com/slackhq/slack-api-docs
+      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
+        method_schema = JSON.parse(File.read('lib/slack/web/api/schema/method.json'))
+        data = Dir.glob('lib/slack/web/api/slack-api-docs/methods/*.json').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'))
+        data.each_with_index do |(group, names), index|
+          printf "%2d/%2d %10s %s\n", index, data.size, group, names.keys
+          File.write "lib/slack/web/api/endpoints/#{group}.rb", method_template.result(group: group, names: names)
+        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)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# 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
+<% files.each do |f| %>
+        include <%= f.capitalize %>
+<% end %>
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# 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| %>
+<% if index > 0 %>
+
+<% end %>
+          #
+          # <%= data["desc"] %>
+          #
+<% 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/slackhq/slack-api-docs/blob/master/methods/<%= group %>.<%= name %>.md
+          # @see https://github.com/slackhq/slack-api-docs/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 %>
+            post('<%= group %>.<%= name %>', options)
+          end
+<% end %>
+        end
+      end
+    end
+  end
+end

data/lib/slack/web/client.rb

@@ -0,0 +1,17 @@
+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
+      end
+    end
+  end
+end

data/lib/slack/web/config.rb

@@ -0,0 +1,36 @@
+module Slack
+  module Web
+    module Config
+      extend self
+
+      ATTRIBUTES = [
+        :proxy,
+        :user_agent,
+        :ca_path,
+        :ca_file,
+        :endpoint
+      ]
+
+      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"
+      end
+    end
+
+    class << self
+      def configure
+        block_given? ? yield(Config) : Config
+      end
+
+      def config
+        Config
+      end
+    end
+  end
+end
+
+Slack::Web::Config.reset