slack.rb 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6828b51e4fa4cc0e3d4be1a86e0ce62e4c33e7d
-  data.tar.gz: f52cd2d62c1ef973fc1b95d369fc0b8dc5814e2d
+  metadata.gz: ad9860bb84883992baebd1ab9b5ebafcc03964db
+  data.tar.gz: ae0b5bdff9a86994253721fc96285559b2c26ed4
 SHA512:
-  metadata.gz: 6921716b6f042892736ac5bfddf3ee910e43688fe38ffc7c9c0d2454769e18aec88ac31c0c8da6c6e9c5020a7db498eeabd4f343ebf5df00b41b338b1de64efb
-  data.tar.gz: 69c7b8984626d14246602794529ce23a48728da3443b1f32c446eae9f4a44a6d00ca64710241fd8d2f33081c03e88e7beee85f431a0d271579c950f7d32cc919
+  metadata.gz: a54b6d2120b7a5d5cea8d0f514070d7f0bcda377e1f445baae3041800556780a2c680f877a3145e9672d292c4e736c35ed4f25663fec3198090450b0c5a875cd
+  data.tar.gz: 41ce86e35e2d96720f7c2323c88296429ac66c18e24ab5213b34cf2eb3dcd37440c2f18ae527c259b3be3b15f47a90e706122292db0a47046f122242a96d596d

data/Gemfile

@@ -14,7 +14,7 @@ group :test do
   gem 'rspec',     '~> 3.0.0.beta2'
   gem 'simplecov', :require => false
   gem 'vcr',       '~> 2.4.0'
-  gem 'webmock',   '>= 1.9.3'
+  gem 'webmock',   '~> 1.9.3'
 end
 
 gemspec

data/lib/slack.rb

@@ -1,8 +1,47 @@
 require "slack/version"
 
 module Slack
+  require 'slack/response/raise_error'
   require "slack/error"
   require "slack/connection"
   require "slack/payload"
   require "slack/client"
+
+  # Default API endpoint
+  API_ENDPOINT = "https://slack.com/api/".freeze
+
+  # Default User Agent header string
+  USER_AGENT   = "Slack Ruby Gem #{Slack::VERSION}".freeze
+
+  # Default media type
+  MEDIA_TYPE   = "application/json"
+
+  # Default API endpoint from ENV or {API_ENDPOINT}
+  # @return [String]
+  def api_endpoint
+    ENV['SLACK_API_ENDPOINT'] || API_ENDPOINT
+  end
+
+  # Default media type from ENV or {MEDIA_TYPE}
+  # @return [String]
+  def default_media_type
+    ENV['SLACK_DEFAULT_MEDIA_TYPE'] || MEDIA_TYPE
+  end
+
+  # Default User-Agent header string from ENV or {USER_AGENT}
+  # @return [String]
+  def user_agent
+    ENV['SLACK_USER_AGENT'] || USER_AGENT
+  end
+
+  # Default options for Faraday::Connection
+  # @return [Hash]
+  def connection_options
+    {
+      :headers => {
+        :accept => default_media_type,
+        :user_agent => user_agent
+      }
+    }
+  end
 end

data/lib/slack/connection.rb

@@ -28,18 +28,14 @@ module Slack
     def connection
       Faraday.new(base_url) do |c|
         c.use(Faraday::Request::UrlEncoded)
+        c.use(Slack::Response::RaiseError)
         c.adapter(Faraday.default_adapter)
       end
     end
 
     def handle_response(response)
       body = JSON.parse(response.body)
-
-      if ["true", 1].include? body['ok']
-        true
-      else
-        raise Slack::Error.new(response.body)
-      end
+      true if ["true", 1].include? body['ok']
     end
   end
 end

data/lib/slack/error.rb

@@ -1,4 +1,54 @@
 module Slack
-  class Error < StandardError ; end
-  class UnknownResponseCode < StandardError; end
+  class Error < StandardError
+
+    # Returns the appropriate Slack::Error sublcass based
+    # on error message
+    #
+    # @param [Hash] response HTTP response
+    # @return [Slack::Error]
+    def self.from_response(response)
+      status  = response[:status].to_i
+      headers = response[:response_headers]
+      body = JSON.parse(response.body)
+      ok = ["true", 1].include? body['ok']
+      error = body['error']
+
+      unless ok
+        if klass = case error
+                     when "invalid_auth"      then Slack::InvalidAuth
+                     when "account_inactive"  then Slack::AccountInactive
+                     when "channel_not_found" then Slack::ChannelNotFound
+                     when "is_archived"       then Slack::IsArchived
+                   end
+          klass.new(response)
+        end
+      end
+    end
+
+    def initialize(response=nil)
+      @response = response
+      super(build_error_message)
+    end
+
+    def build_error_message
+      return nil if @response.nil?
+
+      message =  "#{@response['method'].to_s.upcase} "
+      message << "#{@response['url'].to_s}: "
+      message << "#{@response['status']} - "
+      message
+    end
+  end
+
+  # Raised when a invalid authentication token was given
+  class InvalidAuth < Error; end
+
+  # Raised when authentication token is for a deleted user or team
+  class AccountInactive < Error; end
+
+  # Raised when value passed for channel was invalid
+  class ChannelNotFound < Error; end
+
+  # Raised when Channel has been archived
+  class IsArchived < Error; end
 end

data/lib/slack/response/raise_error.rb

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

data/lib/slack/version.rb

@@ -1,3 +1,3 @@
 module Slack
-  VERSION = "0.0.3".freeze
+  VERSION = "0.0.4".freeze
 end

data/spec/slack/client_spec.rb

@@ -38,7 +38,7 @@ describe Slack::Client do
     it "returns channel not found error" do
       expect{
         @client.post_message("May the force be with you", "channel-name")
-      }.to raise_error(Slack::Error)
+      }.to raise_error(Slack::ChannelNotFound)
 
       params = {text: "May the force be with you", channel: "#channel-name", token: test_slack_token}
       assert_requested :post, slack_url_with_params("/chat.postMessage", params)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slack.rb
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Bastian Bartmann
@@ -58,6 +58,7 @@ files:
 - lib/slack/connection.rb
 - lib/slack/error.rb
 - lib/slack/payload.rb
+- lib/slack/response/raise_error.rb
 - lib/slack/version.rb
 - script/bootstrap
 - script/cibuild