slack-web-api 0.0.1

data/lib/slack/endpoint/users.rb

@@ -0,0 +1,78 @@
+# This file was auto-generated by lib/generators/tasks/generate.rb
+
+module Slack
+  module Endpoint
+    module Users
+      #
+      # This method lets you find out information about a user's presence.
+      # Consult the presence documentation for more details.
+      #
+      # @option options [Object] :user
+      #   User to get presence info on. Defaults to the authed user.
+      # @see https://api.slack.com/methods/users.getPresence
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/users.getPresence.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/users.getPresence.json
+      def users_getPresence(options={})
+        throw ArgumentError.new("Required arguments :user missing") if options[:user].nil?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("users.getPresence", options)
+      end
+
+      #
+      # This method returns information about a team member.
+      #
+      # @option options [Object] :user
+      #   User to get info on
+      # @see https://api.slack.com/methods/users.info
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/users.info.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/users.info.json
+      def users_info(options={})
+        throw ArgumentError.new("Required arguments :user missing") if options[:user].nil?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("users.info", options)
+      end
+
+      #
+      # This method returns a list of all users in the team. This includes deleted/deactivated users.
+      #
+      # @option options [Object] :presence
+      #   Whether to include presence data in the output
+      # @see https://api.slack.com/methods/users.list
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/users.list.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/users.list.json
+      def users_list(options={})
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("users.list", options)
+      end
+
+      #
+      # This method lets the slack messaging server know that the authenticated user
+      # is currently active. Consult the presence documentation for
+      # more details.
+      #
+      # @see https://api.slack.com/methods/users.setActive
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/users.setActive.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/users.setActive.json
+      def users_setActive(options={})
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("users.setActive", options)
+      end
+
+      #
+      # This method lets you set the calling user's manual presence.
+      # Consult the presence documentation for more details.
+      #
+      # @option options [Object] :presence
+      #   Either auto or away
+      # @see https://api.slack.com/methods/users.setPresence
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/users.setPresence.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/users.setPresence.json
+      def users_setPresence(options={})
+        throw ArgumentError.new("Required arguments :presence missing") if options[:presence].nil?
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("users.setPresence", options)
+      end
+
+    end
+  end
+end

data/lib/slack/error.rb

@@ -0,0 +1,19 @@
+module Slack
+  # Custom error class for rescuing from all Slack errors
+  class Error < StandardError; end
+
+  # Raised when Slack returns the HTTP status code 400
+  class BadRequest < Error; end
+
+  # Raised when Slack returns the HTTP status code 404
+  class NotFound < Error; end
+
+  # Raised when Slack returns the HTTP status code 500
+  class InternalServerError < Error; end
+
+  # Raised when Slack returns the HTTP status code 503
+  class ServiceUnavailable < Error; end
+
+  # Raised when a subscription payload hash is invalid
+  class InvalidSignature < Error; end
+end

data/lib/slack/request.rb

@@ -0,0 +1,41 @@
+module Slack
+  # Defines HTTP request methods
+  module Request
+    # Perform an HTTP GET request
+    def get(path, options={})
+      request(:get, path, options)
+    end
+
+    # Perform an HTTP POST request
+    def post(path, options={})
+      request(:post, path, options)
+    end
+
+    # Perform an HTTP PUT request
+    def put(path, options={})
+      request(:put, path, options)
+    end
+
+    # Perform an HTTP DELETE request
+    def delete(path, options={})
+      request(:delete, path, options)
+    end
+
+    private
+
+    # Perform an HTTP request
+    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
+      return response.body
+    end
+  end
+end

data/lib/slack/version.rb

@@ -0,0 +1,3 @@
+module Slack
+  VERSION = "0.0.1"
+end

data/slack.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "slack/version"
+
+
+Gem::Specification.new do |spec|
+  spec.name          = "slack-web-api"
+  spec.version       = Slack::VERSION
+  spec.authors       = ["keydunov"]
+  spec.email         = ["artyom.keydunov@gmail.com"]
+  spec.summary       = %q{A Ruby wrapper for the Slack Web API}
+  spec.description   = %q{A Ruby wrapper for the Slack Web API}
+  spec.homepage      = "https://github.com/keydunov/slack-web-api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'erubis', '~> 2.7.0'
+  spec.add_development_dependency "json-schema"
+  spec.add_development_dependency "pry"
+
+  spec.add_runtime_dependency "faraday", [">= 0.7", "< 0.10"]
+  spec.add_runtime_dependency "faraday_middleware", "~> 0.8"
+  spec.add_runtime_dependency "multi_json", ">= 1.0.3", "~> 1.0"
+end

data/spec/api_spec.rb

@@ -0,0 +1,23 @@
+require_relative './spec_helper'
+
+RSpec.describe Slack::Client, :vcr do
+  describe :api do
+    describe :test do
+      it "with valid token" do
+        expect(
+          valid_client.api_test
+        ).to valid_response
+      end
+
+      it "with extra arguments" do
+        extra = {
+          "foo" => "bar",
+          "hello" => "world"
+        }
+        expect(
+          valid_client.api_test(extra)["args"]
+        ).to include(extra)
+      end
+    end
+  end
+end

data/spec/auth_spec.rb

@@ -0,0 +1,22 @@
+require_relative './spec_helper'
+
+RSpec.describe Slack::Client, :vcr do
+  describe :auth do
+    describe :test do
+      it "with valid token" do
+        expect(
+          valid_client.auth_test
+        ).to valid_response
+      end
+
+      it "with invalid token" do
+        expect(
+          invalid_client.auth_test
+        ).to include({
+          "ok" => false,
+          "error" => "invalid_auth"
+        })
+      end
+    end
+  end
+end

data/spec/channels_spec.rb

@@ -0,0 +1,247 @@
+require_relative './spec_helper'
+
+RSpec.describe Slack::Client, :vcr do
+  describe :channels do
+    describe :archive do
+      it "without name" do
+        expect{valid_client.channels_archive}.to raise_error ArgumentError
+      end
+
+      it "with name" do
+        expect(
+          valid_client.channels_archive(channel: test_channel_id)
+        ).to include({
+          "ok" => true
+        })
+      end
+    end
+
+    describe :history do
+      it "without name" do
+        expect{valid_client.channels_history}.to raise_error ArgumentError
+      end
+
+      it "with name" do
+        expect(
+          valid_client.channels_history(channel: test_channel_id)
+        ).to include({
+          "ok" => true
+        })
+      end
+    end
+
+    describe :info do
+      it "without name" do
+        expect{valid_client.channels_info}.to raise_error ArgumentError
+      end
+
+      it "with name" do
+        expect(
+          valid_client.channels_info(channel: test_channel_id)
+        ).to include({
+          "ok" => true
+        })
+      end
+    end
+
+    describe :create do
+      it "without name" do
+        expect{valid_client.channels_create}.to raise_error ArgumentError
+      end
+
+      it "with test_channel_name" do
+        response = valid_client.channels_create name: test_channel_name
+
+        expect(response).to include({ "ok" => true })
+        expect(response["channel"]).to include({ "name" => test_channel_name })
+      end
+
+      it "with taken name" do
+        response = valid_client.channels_create name: "general"
+
+        expect(response).to include({
+          "ok" => false,
+          "error" => "name_taken"
+        })
+      end
+    end
+
+    describe :list do
+      it "with valid token" do
+        response = valid_client.channels_list
+
+        expect(response).to include({ "ok" => true })
+      end
+    end
+
+    describe :invite do
+      it "without arguments" do
+        expect{valid_client.channels_invite}.to raise_error ArgumentError
+      end
+
+      it "without argument(channel)" do
+        expect{valid_client.channels_invite(user: test_user_id)}.to raise_error ArgumentError
+      end
+
+      it "without argument(user)" do
+        expect{valid_client.channels_invite(channel: test_channel_id)}.to raise_error ArgumentError
+      end
+
+      it "with valid arguments" do
+        expect(
+          valid_client.channels_invite(user: another_user_id, channel: test_channel_id)
+        ).to include({
+          "ok" => true
+        })
+      end
+    end
+
+    describe :leave do
+      it "without argument" do
+        expect{valid_client.channels_leave}.to raise_error ArgumentError
+      end
+
+      it "with channel" do
+        expect(
+          valid_client.channels_leave(channel: test_channel_id)
+        ).to include({
+          "ok" => true
+        })
+      end
+    end
+
+    describe :join do
+      it "without :name" do
+        expect{valid_client.channels_join}.to raise_error ArgumentError
+      end
+
+      it "with :name" do
+        expect(
+          valid_client.channels_join(name: test_channel_name)
+        ).to include({
+          "ok" => true
+        })
+      end
+    end
+
+    describe :kick do
+      it "without arguments" do
+        expect{valid_client.channels_kick}.to raise_error ArgumentError
+      end
+      it "without :channel" do
+        expect{valid_client.channels_kick(name: another_user_id)}.to raise_error ArgumentError
+      end
+      it "without :name" do
+        expect{valid_client.channels_kick(channel: test_channel_id)}.to raise_error ArgumentError
+      end
+      it "with arguments" do
+        expect(
+          valid_client.channels_kick(user: another_user_id, channel: test_channel_id)
+        ).to include({
+          "ok" => true
+        })
+      end
+    end
+
+    describe :mark do
+      it "without arguments" do
+        expect{valid_client.channels_mark}.to raise_error ArgumentError
+      end
+
+      it "without ts" do
+        expect{valid_client.channels_mark(channel: test_channel_id)}.to raise_error ArgumentError
+      end
+
+      it "without channel" do
+        expect{valid_client.channels_mark(ts: 0)}.to raise_error ArgumentError
+      end
+      it "with argument" do
+        expect(
+          valid_client.channels_mark(channel: test_channel_id, ts: 0)
+        ).to include({
+          "ok" => true
+        })
+      end
+    end
+
+    describe :rename do
+      it "without arguments" do
+        expect{valid_client.channels_rename}.to raise_error ArgumentError
+      end
+
+      it "without channel" do
+        expect{valid_client.channels_rename(name: another_channel_name)}.to raise_error ArgumentError
+      end
+
+      it "without name" do
+        expect{valid_client.channels_rename(channel: test_channel_id)}.to raise_error ArgumentError
+      end
+
+      it "with name" do
+        expect(
+          valid_client.channels_rename(channel: test_channel_id, name: another_channel_name)
+        ).to include({
+          "ok" => true
+        })
+      end
+    end
+
+    describe :setPurpose do
+      it "without arguments" do
+        expect{valid_client.channels_setPurpose}.to raise_error ArgumentError
+      end
+
+      it "without channel" do
+        expect{valid_client.channels_setPurpose(purpose: "TestPurpose")}.to raise_error ArgumentError
+      end
+
+      it "without topic" do
+        expect{valid_client.channels_setPurpose(channel: test_channel_id)}.to raise_error ArgumentError
+      end
+
+      it "with arguments" do
+        expect(
+          valid_client.channels_setPurpose(channel: test_channel_id, purpose: "TestPurpose")
+        ).to include({
+          "ok" => true
+        })
+      end
+    end
+
+    describe :setTopic do
+      it "without arguments" do
+        expect{valid_client.channels_setTopic}.to raise_error ArgumentError
+      end
+
+      it "without channel" do
+        expect{valid_client.channels_setTopic(topic: "TestTopic")}.to raise_error ArgumentError
+      end
+
+      it "without topic" do
+        expect{valid_client.channels_setTopic(channel: test_channel_id)}.to raise_error ArgumentError
+      end
+
+      it "with arguments" do
+        expect(
+          valid_client.channels_setTopic(channel: test_channel_id, topic: "TestTopic")
+        ).to include({
+          "ok" => true
+        })
+      end
+    end
+
+    describe :unarchive do
+      it "without :channel" do
+        expect{valid_client.channels_join}.to raise_error ArgumentError
+      end
+
+      it "with :channel" do
+        expect(
+          valid_client.channels_unarchive(channel: test_channel_id)
+        ).to include({
+          "ok" => true
+        })
+      end
+    end
+  end
+end