slack-api-wrapper 0.0.6 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dedcbbf1b36c42b4eb57b2ed9ae32426db56e031
-  data.tar.gz: 72720e24918c02d42e573c659ca31e3540207a1f
+  metadata.gz: 4f09a1ec435533832987741dbb6bb3c8f041c94d
+  data.tar.gz: 8bb3fc0fc558d9ddf956e7ce49cc63bbbee35093
 SHA512:
-  metadata.gz: 8795bfe54af70f6317508ece2bea2c0d2ea94feeb242f47ed6db8a82a95ac4563e2c3effeebc2d322d520d46455836c93fa4e4538154e773729969ee9596c9ef
-  data.tar.gz: b0de368f122442d43af86c55aab8372f7a73c20244a7b15348dce275623bfa566abd1ce5880a8fd08ad781fed113f625011e804dfa764201057d02c0aa1da3fc
+  metadata.gz: 037aea41e976706faf3ac23e1fa9330b8fd2e1d732ec5a791998aa81cfafa2fd60cb6c45502b5e982e5c1affe562d258a9efa684fc1d4df5fcdbb7f2fa77e6bd
+  data.tar.gz: 0647730f20756766677fb8b20adbc2b8031e969ede4832c76e31f59b2404b02f81899f81c567c8e55f78d277917002f4fb2566ba037ba978e70f199bdc3aa5cb

data/.codeclimate.yml

@@ -0,0 +1,2 @@
+languages:
+  Ruby: true

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.travis.yml

@@ -1,3 +1,20 @@
 language: ruby
 rvm:
-  - 2.1.5
+  - 2.0.0
+  - 2.1
+  - 2.2.2
+  - ruby-head
+  - jruby
+  - jruby-head
+
+sudo: false
+
+script: 'bundle exec rake spec'
+
+cache: bundler
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+  fast_finish: true

data/.yardopts

@@ -0,0 +1,9 @@
+--protected
+--no-private
+--embed-mixin ClassMethods
+--markup markdown
+-
+README.md
+CHANGELOG.md
+CODE_OF_CONDUCT.md
+MIT-LICENSE

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+### 0.1.0 2015-09-26
+* Remove oauth logic (use omniauth-slack instead)
+* Improve error handling and fix some bugs with them
+* Make all api request thru a post method instead of a get
+* Add pins and reactions endpoints
+* Complete README
+* Add this file
+
+### 0.0.6 2015-03-16
+* initial functional release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/README.md

@@ -1,30 +1,70 @@
-Slack API Wrapper [![Build Status](https://travis-ci.org/gssbzn/slack-api-wrapper.svg)](https://travis-ci.org/gssbzn/slack-api-wrapper)
-=========================
+# Slack API Wrapper
+[![Gem Version](https://badge.fury.io/rb/slack-api-wrapper.svg)](http://badge.fury.io/rb/slack-api-wrapper)
+[![Build Status](https://travis-ci.org/gssbzn/slack-api-wrapper.svg)](https://travis-ci.org/gssbzn/slack-api-wrapper)
+[![Code Climate](https://codeclimate.com/github/gssbzn/slack-api-wrapper/badges/gpa.svg)](https://codeclimate.com/github/gssbzn/slack-api-wrapper)
+[![Coverage Status](https://coveralls.io/repos/gssbzn/slack-api-wrapper/badge.svg?branch=master&service=github)](https://coveralls.io/github/gssbzn/slack-api-wrapper)
 
 A library that provides a plain function-call interface to the Slack API web endpoints.
 
-This a work in progress, many API endpoint implementations are still missing,
-I expect to add them as soon as possible or you can help by making a pull request.
-
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'slack-api-wrapper'
+```ruby
+gem 'slack-api-wrapper'
+```
 
 And then execute:
 
-    $ bundle
+```console
+bundle
+```
 
 Or install it yourself as:
 
-    $ gem install slack-api-wrapper
+```console
+gem install 'slack-api-wrapper
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+You need to get an api token to use the ruby client.
+You can follow Slack documentation about it (https://api.slack.com/docs/oauth),
+or use [omniauth-slack](https://github.com/kmrshntr/omniauth-slack) to get one.
+
+```ruby
+# Initialize client
+client = Slack::Client.new api_token
+
+# Test user token
+response = client.auth_test
+puts "id: #{response['user_id']}, name: #{response['user']}"
+
+# Get user teammates
+response = client.users_list
+response['members'].each do |user|
+  puts "id: #{user['id']}, name: #{user['name']}"
+end
+
+# Get user channels
+response = client.channels_list
+response['channels'].each do |channel|
+  puts "id: #{channel['id']}, name: #{channel['name']}"
+end
 
-You can see a demo here [slack-web-test](https://github.com/gssbzn/slack-web-test)
+# Get user private groups
+response = client.groups_list
+response['groups'].each do |group|
+  puts "id: #{group['id']}, name: #{group['name']}"
+end
+
+# Posting a message
+response = client.chat_post_message('channel'=> 'CXXXX', 'text'=> 'Testing Slack API', 'as_user'=> true)
+```
+
+## Additional Resources
+
+Slack API Docs: https://api.slack.com/
 
 ## Contributing
 
@@ -34,7 +74,6 @@ You can see a demo here [slack-web-test](https://github.com/gssbzn/slack-web-tes
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
 
-
 ## License
 
 MIT License. Copyright 2015 Gustavo Bazan. http://gustavobazan.com

data/Rakefile

@@ -1,7 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
-
+task default: :spec

data/lib/slack-api-wrapper.rb

@@ -2,11 +2,10 @@ require 'net/https'
 require 'cgi'
 require 'json'
 
-require_relative "slack/version"
-require_relative "slack/error"
-require_relative "slack/session"
-require_relative "slack/oauth2"
-require_relative "slack/client"
+require_relative 'slack/version'
+require_relative 'slack/error'
+require_relative 'slack/session'
+require_relative 'slack/client'
 
 # Copyright (c) 2015 Gustavo Bazan
 # MIT License
@@ -15,104 +14,28 @@ require_relative "slack/client"
 #
 # * {Slack::Client} is the class used to interact with the slack end points.
 # * {Slack::Error} is raised when Slack encounters an error.
-# * {Slack::Oauth2} handles oauth2 authentication.
 #
 module Slack
   # Slack url
   WEB_SERVER = 'slack.com'
-  # Slack api path
-  API_SERVER = 'slack.com/api'
 
-  # Removes nil params
+  # Parse response. You probably shouldn't be calling this directly.
+  # This takes responses from the server and parses them.
+  # It also checks for errors and raises exceptions with the appropriate messages.
   #
-  # @param [Hash] params
-  #   API call arguments
-  # @return [Hash]
-  def self.clean_params(params)
-    r = {}
-    params.each do |k,v|
-      r[k] = v.to_s unless v.nil?
-    end
-    r
-  end
-
-  # Convert params to query string
-  #
-  # @param [Hash] params
-  #   API call arguments
-  # @return [String]
-  def self.make_query_string(params)
-    clean_params(params).collect {|k,v|
-      CGI.escape(k) + "=" + CGI.escape(v)
-    }.join("&")
-  end
-
-  # Handle http requests
-  # @param [URI::HTTPS] uri
-  #   API uri
-  # @param [Object] request
-  #   request object
-  # @return [Net::HTTPResponse]
-  def self.do_http(uri, request)
-
-    http = Net::HTTP.new(uri.host, uri.port)
-
-    http.use_ssl = true
-
-    # Let then know about us
-    request['User-Agent'] =  "SlackRubyAPIWrapper"
-
-    begin
-      http.request(request)
-    rescue OpenSSL::SSL::SSLError => e
-      raise SlackError.new("SSL error connecting to Slack.")
-    end
-  end
-
-  # Parse response. You probably shouldn't be calling this directly.  This takes responses from the server
-  # and parses them.  It also checks for errors and raises exceptions with the appropriate messages.
   # @param [Net::HTTPResponse] response
   # @param [Boolean] raw if return raw data
   # @raise [SlackError]
   # @raise [SlackAuthError]
-  def self.parse_response(response, raw=false)
-    if response.kind_of?(Net::HTTPServerError)
-      raise SlackError.new("Slack Server Error: #{response} - #{response.body}", response)
-    elsif response.kind_of?(Net::HTTPUnauthorized)
-      raise SlackAuthError.new("User is not authenticated.", response)
-    elsif !response.kind_of?(Net::HTTPSuccess)
-      begin
-        d = JSON.parse(response.body)
-      rescue
-        raise SlackError.new("Slack Server Error: body=#{response.body}", response)
-      end
-      if d['error']
-        raise SlackError.new(d['error'], response)
-      else
-        raise SlackError.new(response.body, response)
-      end
+  def self.parse_response(response, raw = false)
+    if response.is_a?(Net::HTTPServerError)
+      fail Slack::Error.new("Slack Server Error: #{response} - #{response.body}", response)
     end
-
     return response.body if raw
-
-    begin
-      return JSON.parse(response.body)
-    rescue JSON::ParserError
-      raise SlackError.new("Unable to parse JSON response: #{response.body}", response)
-    end
-  end
-
-  # A string comparison function that is resistant to timing attacks.  If you're comparing a
-  # string you got from the outside world with a string that is supposed to be a secret, use
-  # this function to check equality.
-  # @param [String] a
-  # @param [String] b
-  # @return [Boolean] whether the strings are equal
-  def self.safe_string_equals(a, b)
-    if a.length != b.length
-      false
-    else
-      a.chars.zip(b.chars).map {|ac,bc| ac == bc}.all?
-    end
+    d = JSON.parse(response.body)
+    fail Slack::Error.new(d['error'], response) if d['error']
+    return d
+  rescue JSON::ParserError
+    raise Slack::Error.new("Unable to parse JSON response: #{response.body}", response)
   end
 end

data/lib/slack/client.rb

@@ -5,18 +5,17 @@ require_relative 'session'
 require_relative 'web'
 
 module Slack
-  # Use this class to make Slack API calls.  You'll need to obtain an OAuth 2 access token
-  # first; you can get one using {Slack::OAuth2::Flow}.
+  # Use this class to make Slack API calls.
+  # You'll need to obtain an OAuth 2 access token
   class Client
     include Web
 
     # @param [String] oauth2_access_token user token
     def initialize(oauth2_access_token)
-      if oauth2_access_token.is_a?(String)
-        @session = Session.new(oauth2_access_token)
-      else
-        raise ArgumentError.new("oauth2_access_token doesn't have a valid type")
+      unless oauth2_access_token.is_a?(String)
+        fail ArgumentError, 'bad type for oauth2_access_token (expecting String)'
       end
+      @session = Session.new(oauth2_access_token)
     end
   end
 end

data/lib/slack/error.rb

@@ -8,10 +8,9 @@ module Slack
   # @!attribute error
   #   @return [String] the name of the error
   class Error < RuntimeError
-
     attr_accessor :http_response, :error
 
-    def initialize(error, http_response=nil)
+    def initialize(error, http_response = nil)
       @error = error
       @http_response = http_response
     end
@@ -22,11 +21,4 @@ module Slack
       "#{error}"
     end
   end
-
-  # This is the error raised on Authentication failures.  Usually this means
-  # one of three things
-  # * Your user failed to go to the authorize url and approve your application
-  # * You set an invalid or expired token and secret on your Session
-  # * Your user deauthorized the application after you stored a valid token and secret
-  class AuthError < Error; end
 end

data/lib/slack/request.rb

@@ -0,0 +1,56 @@
+module Slack
+  # Methods to do http requests
+  module Request
+    # Convert params to query string
+    #
+    # @param [Hash] params
+    #   API call arguments
+    # @return [String]
+    def make_query_string(params)
+      clean_params(params).collect do |k, v|
+        CGI.escape(k) + '=' + CGI.escape(v)
+      end.join('&')
+    end
+
+    # Handle http requests
+    # @param [URI::HTTPS] uri
+    #   API uri
+    # @param [Object] request
+    #   request object
+    # @return [Net::HTTPResponse]
+    def do_http(uri, request)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      # Let then know about us
+      request['User-Agent'] = 'SlackRubyAPIWrapper'
+      begin
+        http.request(request)
+      rescue OpenSSL::SSL::SSLError => e
+        raise Slack::Error, 'SSL error connecting to Slack.'
+      end
+    end
+
+    def do_http_with_body(uri, request, body) # :nodoc:
+      unless body.nil?
+        if body.is_a?(Hash)
+          request.set_form_data clean_params(body)
+        else
+          s = body.to_s
+          request['Content-Length'] = s.length
+          request.body = s
+        end
+      end
+      do_http(uri, request)
+    end
+
+    private
+
+    def clean_params(params) # :nodoc:
+      r = {}
+      params.each do |k, v|
+        r[k] = v.to_s unless v.nil?
+      end
+      r
+    end
+  end
+end

data/lib/slack/session.rb

@@ -1,81 +1,46 @@
 # Copyright (c) 2015 Gustavo Bazan
 # MIT License
+require_relative 'request'
 
 module Slack
-
   class Session # :nodoc:
+    include Request
 
     # @param [String] oauth2_access_token user token
     def initialize(oauth2_access_token)
       unless oauth2_access_token.is_a?(String)
-        raise "bad type for oauth2_access_token (expecting String)"
+        fail ArgumentError, 'bad type for oauth2_access_token (expecting String)'
       end
       @access_token = oauth2_access_token
     end
 
-    private
-
-    def build_url(path) # :nodoc:
-      host = Slack::WEB_SERVER
-      full_path = "/api/#{path}"
-      URI::HTTPS.build({host: host, path: full_path})
-    end
-
-    def build_url_with_params(path, params) # :nodoc:
-      target = build_url(path)
-      target.query = Slack::make_query_string(params)
-      target
-    end
-
-    protected
-
-    def do_http(uri, request) # :nodoc:
-      Slack::do_http(uri, request)
-    end
-
-    public
-
-    def do_get(path, params=nil, headers=nil)  # :nodoc:
+    def do_get(path, params = nil) # :nodoc:
       params ||= {}
-      params["token"] = @access_token
+      params['token'] = @access_token
       uri = build_url_with_params(path, params)
       do_http(uri, Net::HTTP::Get.new(uri.request_uri))
     end
 
-    def do_http_with_body(uri, request, body) # :nodoc:
-      if body != nil
-        if body.is_a?(Hash)
-          request.set_form_data(Slack::clean_params(body))
-        elsif body.respond_to?(:read)
-          if body.respond_to?(:length)
-            request["Content-Length"] = body.length.to_s
-          elsif body.respond_to?(:stat) && body.stat.respond_to?(:size)
-            request["Content-Length"] = body.stat.size.to_s
-          else
-            raise ArgumentError, "Don't know how to handle 'body' (responds to 'read' but not to 'length' or 'stat.size')."
-          end
-          request.body_stream = body
-        else
-          s = body.to_s
-          request["Content-Length"] = s.length
-          request.body = s
-        end
-      end
-      do_http(uri, request)
-    end
-
-    def do_post(path, params=nil, headers=nil)  # :nodoc:
+    def do_post(path, params = nil, headers = nil) # :nodoc:
+      headers ||= {}
+      headers['Authorization'] = "Bearer #{@access_token}"
       params ||= {}
-      params["token"] = @access_token
+      params['token'] = @access_token
       uri = build_url(path)
       do_http_with_body(uri, Net::HTTP::Post.new(uri.request_uri, headers), params)
     end
 
-    def do_put(path, params=nil, headers=nil, body=nil)  # :nodoc:
-      params ||= {}
-      params["token"] = @access_token
-      uri = build_url_with_params(path, params)
-      do_http_with_body(uri, Net::HTTP::Put.new(uri.request_uri, headers), body)
+    private
+
+    def build_url(path) # :nodoc:
+      full_path = "/api/#{path}"
+      URI::HTTPS.build(host: Slack::WEB_SERVER, path: full_path)
+    end
+
+    def build_url_with_params(path, params) # :nodoc:
+      target = build_url(path)
+      target.query = make_query_string(params)
+      target
     end
   end
 end