slack-api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 541dc284ef2a2942a179bc3fb6e2a6bc2680a9cf
+  data.tar.gz: e6072a5aa8026a15cbcb32f873d2006d480acd7e
+SHA512:
+  metadata.gz: 573b5b20ee3b8e0c05b458ee993a3f94519ae17043422dfa7141a0c502fb3fd08c4edd4e518194326322a1d511e3b32c41cd46444b2d1c0ae9428954110db1dc
+  data.tar.gz: 0fc48c5f5cb3292606f292e57b0ccf9653c4e7955202ba34ab2229a34fc5cf923fa7f84c598b82257128e067568702bb3339c1cf9d7e86ea5c2d995898c7cb53

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/.rspec

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

data/Gemfile

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

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,37 @@
+# Slack
+
+A Ruby wrapper for the Slack API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'slack-api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install slack-api
+
+## Usage
+
+```ruby
+require "slack"
+
+Slack.configure do |config|
+  config.token = "YOUR_TOKEN"
+end
+
+Slack.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 @@
+require "bundler/gem_tasks"

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 "slack/error"
+require "slack/configuration"
+require "slack/api"
+require "slack/client"
+require "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)
+    return client.respond_to?(method) || super
+  end
+end

data/lib/slack/api.rb

@@ -0,0 +1,21 @@
+require File.expand_path('../connection', __FILE__)
+require File.expand_path('../request', __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
+  end
+end

data/lib/slack/client.rb

@@ -0,0 +1,17 @@
+module Slack
+  class Client < API
+    METHODS = %w(users.list channels.history 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)
+      get(action.id2name.gsub("_", "."), *args)
+    end
+  end
+end

data/lib/slack/configuration.rb

@@ -0,0 +1,64 @@
+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
+    ].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
+
+    # @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
+    end
+  end
+end

data/lib/slack/connection.rb

@@ -0,0 +1,24 @@
+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,
+      }
+
+      Faraday::Connection.new(options) do |connection|
+        connection.use Faraday::Request::UrlEncoded
+        connection.use Faraday::Response::ParseJson
+        connection.use FaradayMiddleware::RaiseHttpException
+        connection.adapter(adapter)
+      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.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,28 @@
+# 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-api"
+  spec.version       = Slack::VERSION
+  spec.authors       = ["aki017"]
+  spec.email         = ["aki@aki017.info"]
+  spec.summary       = %q{A Ruby wrapper for the Slack API}
+  spec.description   = %q{A Ruby wrapper for the Slack API}
+  spec.homepage      = "https://github.com/aki017/slack-ruby-gem"
+  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 "rspec", "~> 2.4"
+  spec.add_development_dependency "webmock", "~> 1.6" 
+  spec.add_runtime_dependency "faraday", [">= 0.7", "<= 0.9"] 
+  spec.add_runtime_dependency "faraday_middleware", "~> 0.8"
+  spec.add_runtime_dependency "multi_json", ">= 1.0.3", "~> 1.0" 
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: slack-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- aki017
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: A Ruby wrapper for the Slack API
+email:
+- aki@aki017.info
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/faraday/raise_http_exception.rb
+- lib/slack.rb
+- lib/slack/api.rb
+- lib/slack/client.rb
+- lib/slack/configuration.rb
+- lib/slack/connection.rb
+- lib/slack/error.rb
+- lib/slack/request.rb
+- lib/slack/version.rb
+- slack.gemspec
+- spec/spec_helper.rb
+homepage: https://github.com/aki017/slack-ruby-gem
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: A Ruby wrapper for the Slack API
+test_files:
+- spec/spec_helper.rb