slack-web-api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5c83a89cf20026e6fa6c74cfdc06f94bea085bc8
+  data.tar.gz: aa2a9c6fea05deb01bde20b385faa0f6567d50b0
+SHA512:
+  metadata.gz: a3315e3600aea6e1169d3aac7388e6e85ee8e8e58f03c206700f337dd705a0529321cbb87ddb5f7b34a21be36102a79d8fccb4bb399aae69a2f5d63cd586eca3
+  data.tar.gz: 64a3d8839c95d9ade22b5bd500773325debc1b17f086df6c5d8ab07e20137a3129f77acd9c9d30f0f3c2aa37e73ab50d5a7b8660c3abd466ccdbd73eec460b4d

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.gitmodules

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - 2.1
+  - 2.2
+
+git:
+  submodules: false

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in slack.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,13 @@
+clearing true
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 aki017
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,33 @@
+# Slack Web API
+
+A Ruby wrapper for the Slack Web API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'slack-web-api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install slack-web-api
+
+## Usage
+
+```ruby
+require "slack"
+
+client = Slack::Client.new token: token
+client.auth_test
+```
+## Contributing
+
+1. Fork it ( http://github.com/aki017/slack-ruby-gem/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+require_relative "./lib/generators/tasks/generate"
+
+Bundler.setup :default, :development
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task default: [:spec]

data/examples/basic.rb

@@ -0,0 +1,35 @@
+require "slack"
+require "yaml"
+
+token = ENV["TOKEN"] || (print "Token: "; gets.strip)
+client = Slack::Client.new token: token
+
+# Get users list
+puts "Get users list"
+users = Hash[client.users_list["members"].map{|m| [m["id"], m["name"]]}]
+
+puts YAML.dump users
+puts
+puts
+
+# Get channels list
+puts "Get channels list"
+channels = client.channels_list["channels"]
+puts YAML.dump channels
+puts
+puts
+
+channels.each do |c|
+  puts "- id: #{c["id"]}, name: #{c["name"]}"
+
+  # Get channel histry
+  messages = client.channels_history(channel: "#{c["id"]}")["messages"]
+  messages.each do |message|
+    user_name = users[message["user"]]
+    text = message["text"].inspect
+    puts "  - #{user_name}: #{text}"
+  end
+end
+
+sleep 1
+

data/lib/faraday/raise_http_exception.rb

@@ -0,0 +1,51 @@
+require 'faraday'
+
+# @private
+module FaradayMiddleware
+  # @private
+  class RaiseHttpException < Faraday::Middleware
+    def call(env)
+      @app.call(env).on_complete do |response|
+        case response[:status].to_i
+        when 400
+          raise Slack::BadRequest, error_message_400(response)
+        when 404
+          raise Slack::NotFound, error_message_400(response)
+        when 500
+          raise Slack::InternalServerError, error_message_500(response, "Something is technically wrong.")
+        when 503
+          raise Slack::ServiceUnavailable, error_message_500(response, "Slack is rate limiting your requests.")
+        end
+      end
+    end
+
+    def initialize(app)
+      super app
+      @parser = nil
+    end
+
+    private
+
+    def error_message_400(response)
+      "#{response[:method].to_s.upcase} #{response[:url].to_s}: #{response[:status]}#{error_body(response[:body])}"
+    end
+
+    def error_body(body)
+      # body gets passed as a string, not sure if it is passed as something else from other spots?
+      if not body.nil? and not body.empty? and body.kind_of?(String)
+        # removed multi_json thanks to wesnolte's commit
+        body = ::JSON.parse(body)
+      end
+
+      if body.nil?
+        nil
+      elsif body['meta'] and body['meta']['error_message'] and not body['meta']['error_message'].empty?
+        ": #{body['meta']['error_message']}"
+      end
+    end
+
+    def error_message_500(response, body=nil)
+      "#{response[:method].to_s.upcase} #{response[:url].to_s}: #{[response[:status].to_s + ':', body].compact.join(' ')}"
+    end
+  end
+end

data/lib/slack.rb

@@ -0,0 +1,27 @@
+require_relative "slack/error"
+require_relative "slack/configuration"
+require_relative "slack/api"
+require_relative "slack/client"
+require_relative "slack/version"
+
+module Slack
+  extend Configuration
+
+  # Alias for Slack::Client.new
+  #
+  # @return [Slack::Client]
+  def self.client(options={})
+    Slack::Client.new(options)
+  end
+
+  # Delegate to Slack::Client
+  def self.method_missing(method, *args, &block)
+    return super unless client.respond_to?(method)
+    client.send(method, *args, &block)
+  end
+
+  # Delegate to Slack::Client
+  def self.respond_to?(method, include_all=false)
+    return client.respond_to?(method, include_all) || super
+  end
+end

data/lib/slack/api.rb

@@ -0,0 +1,24 @@
+require File.expand_path('../connection', __FILE__)
+require File.expand_path('../request', __FILE__)
+require File.expand_path('../configuration', __FILE__)
+require File.expand_path('../endpoint', __FILE__)
+
+module Slack
+  # @private
+  class API
+    # @private
+    attr_accessor(*Configuration::VALID_OPTIONS_KEYS)
+
+    # Creates a new API
+    def initialize(options={})
+      options = Slack.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+    include Connection
+    include Request
+    include Endpoint
+  end
+end

data/lib/slack/client.rb

@@ -0,0 +1,4 @@
+module Slack
+  class Client < API
+  end
+end

data/lib/slack/configuration.rb

@@ -0,0 +1,76 @@
+require 'faraday'
+require File.expand_path('../version', __FILE__)
+
+module Slack
+  # Defines constants and methods related to configuration
+  module Configuration
+    # An array of valid keys in the options hash when configuring a {Slack::API}
+    VALID_OPTIONS_KEYS = [
+      :adapter,
+      :token,
+      :endpoint,
+      :user_agent,
+      :proxy,
+      :ca_path,
+      :ca_file,
+      :middlewares
+    ].freeze
+
+    # The adapter that will be used to connect if none is set
+    #
+    # @note The default faraday adapter is Net::HTTP.
+    DEFAULT_ADAPTER = Faraday.default_adapter
+
+    # By default, don't set an token
+    DEFAULT_TOKEN = nil
+
+    # The endpoint that will be used to connect if none is set
+    #
+    # @note There is no reason to use any other endpoint at this time
+    DEFAULT_ENDPOINT = 'https://slack.com/api/'.freeze
+
+    # By default, don't use a proxy server
+    DEFAULT_PROXY = nil
+
+    # The user agent that will be sent to the API endpoint if none is set
+    DEFAULT_USER_AGENT = "Slack Ruby Gem #{Slack::VERSION}".freeze
+
+    # Default openssl CA_PATH and CA_FILE path
+    DEFAULT_CA_PATH = %x[ openssl version -a | grep OPENSSLDIR | awk '{print $2}'|sed -e 's/\"//g' ]
+    DEFAULT_CA_FILE = "#{DEFAULT_CA_PATH}/ca-certificates.crt"
+
+    DEFAULT_MIDDLEWARES = []
+
+    # @private
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    # When this module is extended, set all configuration options to their default values
+    def self.extended(base)
+      base.reset
+    end
+
+    # Convenience method to allow configuration options to be set in a block
+    def configure
+      yield self
+    end
+
+    # Create a hash of options and their values
+    def options
+      VALID_OPTIONS_KEYS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+    # Reset all configuration options to defaults
+    def reset
+      self.adapter     = DEFAULT_ADAPTER
+      self.token       = DEFAULT_TOKEN
+      self.endpoint    = DEFAULT_ENDPOINT
+      self.user_agent  = DEFAULT_USER_AGENT
+      self.proxy       = DEFAULT_PROXY
+      self.ca_path     = DEFAULT_CA_PATH
+      self.ca_file     = DEFAULT_CA_FILE
+      self.middlewares = DEFAULT_MIDDLEWARES
+    end
+  end
+end

data/lib/slack/connection.rb

@@ -0,0 +1,29 @@
+require 'faraday_middleware'
+Dir[File.expand_path('../../faraday/*.rb', __FILE__)].each{|f| require f}
+
+module Slack
+  # @private
+  module Connection
+    private
+
+    def connection
+      options = {
+        :headers => {'Accept' => "application/json; charset=utf-8", 'User-Agent' => user_agent},
+        :proxy => proxy,
+        :url => endpoint,
+        :ssl => { :ca_path => ca_path, :ca_file => ca_file },
+      }
+
+      Faraday::Connection.new(options) do |connection|
+        Array(middlewares).each do |middleware|
+          connection.use middleware
+        end
+        connection.use Faraday::Request::Multipart
+        connection.use Faraday::Request::UrlEncoded
+        connection.use Faraday::Response::ParseJson
+        connection.use FaradayMiddleware::RaiseHttpException
+        connection.adapter(adapter)
+      end
+    end
+  end
+end

data/lib/slack/endpoint.rb

@@ -0,0 +1,43 @@
+# 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/mpim'
+require_relative 'endpoint/oauth'
+require_relative 'endpoint/pins'
+require_relative 'endpoint/presence'
+require_relative 'endpoint/reactions'
+require_relative 'endpoint/search'
+require_relative 'endpoint/stars'
+require_relative 'endpoint/team'
+require_relative 'endpoint/usergroups'
+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 Mpim
+    include Oauth
+    include Pins
+    include Presence
+    include Reactions
+    include Search
+    include Stars
+    include Team
+    include Usergroups
+    include Users
+  end
+end

data/lib/slack/endpoint/api.rb

@@ -0,0 +1,23 @@
+# This file was auto-generated by lib/generators/tasks/generate.rb
+
+module Slack
+  module Endpoint
+    module Api
+      #
+      # This method helps you test your 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/aki017/slack-api-docs/blob/master/methods/api.test.md
+      # @see https://github.com/aki017/slack-api-docs/blob/master/methods/api.test.json
+      def api_test(options={})
+        options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
+        post("api.test", options)
+      end
+
+    end
+  end
+end