breacan 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bd1925ffbf6e5ae727056a78968ad71c79e299b5
+  data.tar.gz: e13e08f2d165b7e99bf6e52e51bae971ee1d9e71
+SHA512:
+  metadata.gz: 7985138b2198118c6147f524a9adf9d9baf1682e66ea4ed7d587b11c6cf7131002553c5450a1199028880b37c2280f4248c9ccc162bb7311289382236f3c9a39
+  data.tar.gz: 6d87c8702becbc3b027ec1d4bd4d8957733f840bcf90a5e9f70a608d0348a14eb1a4aa73a6ac919cbf53fd1aeb6af221977b8fde107390cb7524825ce0d5327c

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in breacan.gemspec
+gemspec
+
+gem 'pry'
+gem 'awesome_print'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 linyows
+
+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,48 @@
+<p align="center">
+<img src="https://d262ilb51hltx0.cloudfront.net/max/2000/1*ryU77MsLt5tnp3ow8kqELA.png">
+<strong>Breacan</strong>: Simple Ruby wrapper for Slack API.
+</p>
+
+[![ruby gem](https://img.shields.io/gem/v/breacan.svg?style=flat-square)][gem]
+[gem]: https://rubygems.org/gems/breacan
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'breacan'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install breacan
+
+Usage
+-----
+
+TODO: Write usage instructions here
+
+Contributing
+------------
+
+1. Fork it ( https://github.com/linyows/breacan/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 a new Pull Request
+
+Authors
+-------
+
+- [linyows](https://github.com/linyows)
+
+License
+-------
+
+The MIT License (MIT)

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/breacan.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'breacan/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "breacan"
+  spec.version       = Breacan::VERSION
+  spec.authors       = ["linyows"]
+  spec.email         = ["linyows@gmail.com"]
+  spec.summary       = %q{Simple Ruby wrapper for Slack API.}
+  spec.description   = %q{Simple Ruby wrapper for Slack API.}
+  spec.homepage      = "https://github.com/linyows/breacan"
+  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_dependency "sawyer", "~> 0.6"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/breacan.rb

@@ -0,0 +1,24 @@
+require 'breacan/version'
+require 'breacan/client'
+
+module Breacan
+  class << self
+    include Breacan::Configurable
+
+    def client
+      unless defined?(@client) && @client.same_options?(options)
+        @client = Breacan::Client.new(options)
+      end
+      @client
+    end
+
+    private
+
+    def method_missing(method_name, *args, &block)
+      return super unless client.respond_to?(method_name)
+      client.send(method_name, *args, &block)
+    end
+  end
+end
+
+Breacan.setup

data/lib/breacan/authentication.rb

@@ -0,0 +1,7 @@
+module Breacan
+  module Authentication
+    def token_authenticated?
+      !!@access_token
+    end
+  end
+end

data/lib/breacan/client.rb

@@ -0,0 +1,109 @@
+require 'sawyer'
+require 'breacan/configurable'
+require 'breacan/authentication'
+require 'breacan/client/oauth'
+require 'breacan/client/channels'
+require 'breacan/client/chat'
+
+module Breacan
+  class Client
+    include Breacan::Authentication
+    include Breacan::Configurable
+    include Breacan::Client::OAuth
+    include Breacan::Client::Channels
+    include Breacan::Client::Chat
+
+    CONVENIENCE_HEADERS = Set.new(%i(accept content_type))
+
+    def initialize(options = {})
+      Breacan::Configurable.keys.each do |key|
+        instance_variable_set(:"@#{key}", options[key] || Breacan.instance_variable_get(:"@#{key}"))
+      end
+    end
+
+    def same_options?(opts)
+      opts.hash == options.hash
+    end
+
+    def get(url, options = {})
+      request :get, url, parse_query_and_convenience_headers(options)
+    end
+
+    def post(url, options = {})
+      request :post, url, options
+    end
+
+    def put(url, options = {})
+      request :put, url, options
+    end
+
+    def patch(url, options = {})
+      request :patch, url, options
+    end
+
+    def delete(url, options = {})
+      request :delete, url, options
+    end
+
+    def head(url, options = {})
+      request :head, url, parse_query_and_convenience_headers(options)
+    end
+
+    def agent
+      @agent ||= Sawyer::Agent.new(api_endpoint, sawyer_options) do |http|
+        http.headers[:accept] = media_type
+        http.headers[:content_type] = media_type
+        http.headers[:user_agent] = user_agent
+      end
+    end
+
+    private
+
+    def request(method, path, data, options = {})
+      if data.is_a?(Hash)
+        options[:query] = data.delete(:query) || {}
+        options[:headers] = data.delete(:headers) || {}
+        if accept = data.delete(:accept)
+          options[:headers][:accept] = accept
+        end
+      end
+      api_path = URI::Parser.new.escape("#{path.to_s}?token=#{@access_token}")
+      @last_response = response = agent.call(method, api_path, data, options)
+      response.data
+    end
+
+    def boolean_from_response(method, path, options = {})
+      request(method, path, options)
+      @last_response.status == 204
+    rescue Breacan::NotFound
+      false
+    end
+
+    def sawyer_options
+      opts = {
+        :links_parser => Sawyer::LinkParsers::Simple.new
+      }
+      conn_opts = @connection_options
+      conn_opts[:builder] = @middleware if @middleware
+      conn_opts[:proxy] = @proxy if @proxy
+      opts[:faraday] = Faraday.new(conn_opts)
+
+      opts
+    end
+
+    def parse_query_and_convenience_headers(options)
+      headers = options.fetch(:headers, {})
+      CONVENIENCE_HEADERS.each do |h|
+        if header = options.delete(h)
+          headers[h] = header
+        end
+      end
+      query = options.delete(:query)
+      opts = {:query => options}
+      opts[:query].merge!(query) if query && query.is_a?(Hash)
+      opts[:headers] = headers unless headers.empty?
+
+      opts
+    end
+  end
+end

data/lib/breacan/client/channels.rb

@@ -0,0 +1,22 @@
+module Breacan
+  class Client
+    module Channels
+      def channels_list
+        get 'channels.list'
+      end
+
+      def channels_info(*args)
+        get 'channels.info', args
+      end
+
+      def channels_history(*args)
+        get 'channels.history', args
+      end
+
+      def channels_info_by_name(name)
+        res = channels_list
+        res.channels.find { |ch| ch['name'] == name } if res.ok
+      end
+    end
+  end
+end

data/lib/breacan/client/chat.rb

@@ -0,0 +1,17 @@
+module Breacan
+  class Client
+    module Chat
+      def chat_delete(*args)
+        delete 'chat.delete', args
+      end
+
+      def chat_post_message(*args)
+        get 'chat.postMessage', args
+      end
+
+      def chat_update(*args)
+        get 'chat.update', args
+      end
+    end
+  end
+end

data/lib/breacan/client/oauth.rb

@@ -0,0 +1,9 @@
+module Breacan
+  class Client
+    module OAuth
+      def oauth_access(*args)
+        post 'oauth.access', args
+      end
+    end
+  end
+end

data/lib/breacan/configurable.rb

@@ -0,0 +1,60 @@
+require 'breacan/response/raise_error'
+
+module Breacan
+  module Configurable
+    OPTIONS_KEYS = %i(
+      access_token
+      team
+      api_endpoint
+      web_endpoint
+      user_agent
+      media_type
+      connection_options
+      proxy
+      middleware
+    )
+
+    attr_accessor(*OPTIONS_KEYS)
+
+    class << self
+      def keys
+        @keys ||= OPTIONS_KEYS
+      end
+    end
+
+    def configure
+      yield self
+    end
+
+    def api_endpoint
+      File.join(@api_endpoint, '')
+    end
+
+    def web_endpoint
+      File.join(@web_endpoint, '')
+    end
+
+    def reset!
+      @access_token       = ENV['BREACAN_ACCESS_TOKEN']
+      @team               = ENV['BREACAN_TEAM']
+      @api_endpoint       = ENV['BREACAN_API_ENDPOINT'] || 'https://slack.com/api/'
+      @web_endpoint       = ENV['BREACAN_WEB_ENDPOINT'] || "https://#{@team}.slack.com/"
+      @user_agent         = "Breacan Ruby Gem #{Breacan::VERSION}"
+      @media_type         = 'application/json'
+      @connection_options = { headers: { accept: media_type, user_agent: user_agent } }
+      @proxy              = ENV['BREACAN_PROXY']
+      @middleware         = Faraday::RackBuilder.new { |builder|
+          builder.use Breacan::Response::RaiseError
+          builder.adapter Faraday.default_adapter
+        }
+      self
+    end
+    alias setup reset!
+
+    def options
+      Hash[Breacan::Configurable.keys.map { |key|
+        [key, instance_variable_get(:"@#{key}")]
+      }]
+    end
+  end
+end

data/lib/breacan/error.rb

@@ -0,0 +1,104 @@
+module Breacan
+  class Error < StandardError
+    def self.from_response(response)
+      if klass = case response[:status].to_i
+        when 400      then Breacan::BadRequest
+        when 401      then Breacan::Unauthorized
+        when 403      then Breacan::Forbidden
+        when 404      then Breacan::NotFound
+        when 406      then Breacan::NotAcceptable
+        when 409      then Breacan::Conflict
+        when 415      then Breacan::UnsupportedMediaType
+        when 422      then Breacan::UnprocessableEntity
+        when 400..499 then Breacan::ClientError
+        when 500      then Breacan::InternalServerError
+        when 501      then Breacan::NotImplemented
+        when 502      then Breacan::BadGateway
+        when 503      then Breacan::ServiceUnavailable
+        when 500..599 then Breacan::ServerError
+        end
+        klass.new(response)
+      end
+    end
+
+    def initialize(response = nil)
+      @response = response
+      super(build_error_message)
+    end
+
+    def errors
+      if data && data.is_a?(Hash)
+        data[:errors] || []
+      else
+        []
+      end
+    end
+
+    private
+
+    def data
+      @data ||=
+        if (body = @response[:body]) && !body.empty?
+          if body.is_a?(String) &&
+            @response[:response_headers] &&
+            @response[:response_headers][:content_type] =~ /json/
+
+            Sawyer::Agent.serializer.decode(body)
+          else
+            body
+          end
+        else
+          nil
+        end
+    end
+
+    def response_message
+      case data
+      when Hash
+        data[:message]
+      when String
+        data
+      end
+    end
+
+    def response_error
+      "Error: #{data[:error]}" if data.is_a?(Hash) && data[:error]
+    end
+
+    def build_error_message
+      return nil if @response.nil?
+
+      message =  "#{@response[:method].to_s.upcase} "
+      message << redact_url(@response[:url].to_s) + ": "
+      message << "#{@response[:status]} - "
+      message << "#{response_message}" unless response_message.nil?
+      message << "#{response_error}" unless response_error.nil?
+      message
+    end
+
+    def redact_url(url_string)
+      %w[client_secret access_token].each do |token|
+        url_string.gsub!(/#{token}=\S+/, "#{token}=(redacted)") if url_string.include? token
+      end
+      url_string
+    end
+  end
+
+  class ClientError < Error; end
+  class BadRequest < ClientError; end
+  class Unauthorized < ClientError; end
+  class Forbidden < ClientError; end
+  class TooManyRequests < Forbidden; end
+  class TooManyLoginAttempts < Forbidden; end
+  class NotFound < ClientError; end
+  class NotAcceptable < ClientError; end
+  class Conflict < ClientError; end
+  class UnsupportedMediaType < ClientError; end
+  class UnprocessableEntity < ClientError; end
+  class ServerError < Error; end
+  class InternalServerError < ServerError; end
+  class NotImplemented < ServerError; end
+  class BadGateway < ServerError; end
+  class ServiceUnavailable < ServerError; end
+  class MissingContentType < ArgumentError; end
+end

data/lib/breacan/response/raise_error.rb

@@ -0,0 +1,16 @@
+require 'faraday'
+require 'breacan/error'
+
+module Breacan
+  module Response
+    class RaiseError < Faraday::Response::Middleware
+      private
+
+      def on_complete(response)
+        if error = Breacan::Error.from_response(response)
+          raise error
+        end
+      end
+    end
+  end
+end

data/lib/breacan/version.rb

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

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: breacan
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- linyows
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sawyer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Simple Ruby wrapper for Slack API.
+email:
+- linyows@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- breacan.gemspec
+- lib/breacan.rb
+- lib/breacan/authentication.rb
+- lib/breacan/client.rb
+- lib/breacan/client/channels.rb
+- lib/breacan/client/chat.rb
+- lib/breacan/client/oauth.rb
+- lib/breacan/configurable.rb
+- lib/breacan/error.rb
+- lib/breacan/response/raise_error.rb
+- lib/breacan/version.rb
+homepage: https://github.com/linyows/breacan
+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.2
+signing_key: 
+specification_version: 4
+summary: Simple Ruby wrapper for Slack API.
+test_files: []