slack-api 0.0.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8cc40fc79197f3f36d7830a78ae180c1164388ce
-  data.tar.gz: bcee43066b00c2f7e7b34acfd3851f12cf38653c
+  metadata.gz: d98e9d118812d8f110c8172eaa3458c983bc1bd7
+  data.tar.gz: 98b72bbd4cb361934c653d7cb771ea82fa6dce30
 SHA512:
-  metadata.gz: 2c7f59b4a155b6794a954073247268ada9ba3f4fd1158f22aab835d3f559ee5a01e3a82a40433c7921da81e5708f19c126b35a21e5b31b3985459fe15433d118
-  data.tar.gz: 150295b2ffc0ff7371e193cdc6e7b87b5c8efa0315e3bdbe75084fcf079a8f63c4545a3bc7ed5f76ba07a2d6c2555974c701f60bc13787dfb9dd24636c953324
+  metadata.gz: 8e8ee8eb9bcb66fbcee0e41b949117eef8348d0f371cdb27202f81e11f0e0fb16aff665341a12293e1f75097871f2f1a8929ced333b3d95d82a8eeabf651fa62
+  data.tar.gz: c606c98d7f298ea5915bab37eff480bdbb46fb80017f32885d42475ceab13d9868db290bb0b2da31946fe36545b3f3bcca41c4fa3827f6b2d385af8add93c474

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "slack-api-docs"]
+	path = slack-api-docs
+	url = git@github.com:slackhq/slack-api-docs.git

data/Rakefile

@@ -1 +1,2 @@
 require "bundler/gem_tasks"
+require_relative "./lib/generators/tasks/generate"

data/lib/generators/schema.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/generators/tasks/generate.rb

@@ -0,0 +1,76 @@
+require 'json-schema'
+require 'erubis'
+
+namespace :api do
+  desc "update"
+  task :update do
+    Dir.chdir root
+    sh "git submodule update --init --recursive"
+    sh "git submodule foreach git pull origin master"
+    Rake::Task["api:generate"].execute
+    sh "git add lib/slack/endpoint.rb"
+    sh "git add lib/slack/endpoint/"
+    sh "git add slack-api-docs"
+    sh "git commit -m 'rake api:update'"
+  end
+
+  desc "Generate"
+  task :generate do
+    jsons = File.expand_path 'slack-api-docs/methods/*.json', root
+    schema_path = File.expand_path "lib/generators/schema.json", root
+    schema = JSON.parse(File.read(schema_path))
+
+    data = Dir.glob(jsons).each_with_object({}) do |path, result|
+      name = File.basename(path, ".json")
+      prefix, name = name.split(".")
+      next if prefix == "rtm"
+      result[prefix] ||= {}
+
+      parsed = JSON.parse(File.read(path))
+      JSON::Validator.validate(schema, parsed, :insert_defaults => true)
+ 
+      result[prefix][name] = parsed
+
+    end
+
+    generate_methods(data)
+    generate_endpoint(data)
+  end
+
+  desc "Cleanup"
+  task :clean do
+    outdir = File.expand_path "lib/slack/endpoint", root
+    FileUtils.rm_rf outdir
+
+    outpath = File.expand_path "lib/slack/endpoint.rb", root
+    FileUtils.rm_rf outpath
+  end
+
+  def generate_endpoint(data)
+    templete_path = File.expand_path 'lib/generators/templates/endpoint.rb.erb', root
+    templete = Erubis::Eruby.new(File.read(templete_path))
+
+    outpath = File.expand_path "lib/slack/endpoint.rb", root
+    FileUtils.rm_rf outpath
+    File.write outpath, templete.result(files: data.keys)
+  end
+
+  def generate_methods(data)
+    templete_path = File.expand_path 'lib/generators/templates/method.rb.erb', root
+    templete = Erubis::Eruby.new(File.read(templete_path))
+
+    outdir = File.expand_path "lib/slack/endpoint", root
+    FileUtils.rm_rf outdir
+    FileUtils.mkdir outdir
+    data.each_with_index do |(group, names), index|
+      printf "%2d/%2d %10s %s\n", index, data.size, group, names.keys
+
+      outpath = File.expand_path "#{group}.rb", outdir
+      File.write outpath, templete.result(group: group, names: names)
+    end
+  end
+
+  def root
+    File.expand_path '../../../..', __FILE__
+  end
+end

data/lib/generators/templates/endpoint.rb.erb

@@ -0,0 +1,13 @@
+# This file was auto-generated by lib/generators/tasks/generate.rb
+#
+<% files.each do |f| %>
+require_relative 'endpoint/<%= f %>'
+<% end %>
+
+module Slack
+  module Endpoint
+<% files.each do |f| %>
+    include <%= f.capitalize %>
+<% end %>
+  end
+end

data/lib/generators/templates/method.rb.erb

@@ -0,0 +1,29 @@
+# This file was auto-generated by lib/generators/tasks/generate.rb
+
+module Slack
+  module Endpoint
+    module <%= group.capitalize %>
+<% names.each do |name, data| %>
+      #
+      # <%= data["desc"] %>
+      #
+<% data["args"].each do |arg_name, arg_v| %>
+      # @option options [<%= arg_v["type"] %>] :<%= arg_name %>
+<% arg_v["desc"].lines.each do |l| %>
+      #   <%= l.strip %>
+<% 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

data/lib/slack.rb

@@ -1,8 +1,8 @@
-require "slack/error"
-require "slack/configuration"
-require "slack/api"
-require "slack/client"
-require "slack/version"
+require_relative "slack/error"
+require_relative "slack/configuration"
+require_relative "slack/api"
+require_relative "slack/client"
+require_relative "slack/version"
 
 module Slack
   extend Configuration

data/lib/slack/api.rb

@@ -1,12 +1,14 @@
 require File.expand_path('../connection', __FILE__)
 require File.expand_path('../request', __FILE__)
 require File.expand_path('../configuration', __FILE__)
+require File.expand_path('../endpoint', __FILE__)
+require File.expand_path('../realtime/client', __FILE__)
 
 module Slack
   # @private
   class API
     # @private
-    attr_accessor *Configuration::VALID_OPTIONS_KEYS
+    attr_accessor(*Configuration::VALID_OPTIONS_KEYS)
 
     # Creates a new API
     def initialize(options={})
@@ -18,5 +20,11 @@ module Slack
 
     include Connection
     include Request
+    include Endpoint
+
+    def realtime
+      url = post("rtm.start")["url"]
+      RealTime::Client.new(url)
+    end
   end
 end

data/lib/slack/client.rb

@@ -1,17 +1,4 @@
 module Slack
   class Client < API
-    METHODS = %w(users.info users.list channels.history channels.join
-                channels.mark channels.list files.upload files.list
-                im.history im.list groups.history groups.list
-                search.all search.files search.messages
-                chat.postMessage auth.test)
-
-    def respond_to?(method)
-      return METHODS.include?(method.id2name.gsub("_", ".")) || super
-    end
-
-    def method_missing(action, *args)
-      post(action.id2name.gsub("_", "."), *args)
-    end
   end
 end

data/lib/slack/endpoint.rb

@@ -0,0 +1,33 @@
+# This file was auto-generated by lib/generators/tasks/generate.rb
+#
+require_relative 'endpoint/api'
+require_relative 'endpoint/auth'
+require_relative 'endpoint/channels'
+require_relative 'endpoint/chat'
+require_relative 'endpoint/emoji'
+require_relative 'endpoint/files'
+require_relative 'endpoint/groups'
+require_relative 'endpoint/im'
+require_relative 'endpoint/oauth'
+require_relative 'endpoint/presence'
+require_relative 'endpoint/search'
+require_relative 'endpoint/stars'
+require_relative 'endpoint/users'
+
+module Slack
+  module Endpoint
+    include Api
+    include Auth
+    include Channels
+    include Chat
+    include Emoji
+    include Files
+    include Groups
+    include Im
+    include Oauth
+    include Presence
+    include Search
+    include Stars
+    include Users
+  end
+end

data/lib/slack/endpoint/api.rb

@@ -0,0 +1,22 @@
+# This file was auto-generated by lib/generators/tasks/generate.rb
+
+module Slack
+  module Endpoint
+    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

data/lib/slack/endpoint/auth.rb

@@ -0,0 +1,18 @@
+# This file was auto-generated by lib/generators/tasks/generate.rb
+
+module Slack
+  module Endpoint
+    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

data/lib/slack/endpoint/channels.rb

@@ -0,0 +1,213 @@
+# This file was auto-generated by lib/generators/tasks/generate.rb
+
+module Slack
+  module Endpoint
+    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