layabout 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 616e412288a6c1cc8efb6adcf371f23d636ae4b2
+  data.tar.gz: 42c701ea50fb420e3e72b427cbcc6340d919683f
+SHA512:
+  metadata.gz: 55db5b1f883b75f510f29f81869411d074daeefad222952d8dd2c265ca1f31d9578f3888cc94be2d422597749a745a3fcf0341afdc642ad71910f8cbd75a22b8
+  data.tar.gz: 0f43ac974b215764863f5eb0e74300ebd61fd5aa4d254f936105f0a4cbbbd9a99233410e445d7b0c3c02173c60e958096990de0aed62f64f1c88c48bcc62189b

data/.gitignore

@@ -0,0 +1,2 @@
+.ruby-version
+coverage/*

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - "2.0.0"
+script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test, :development do
+  gem 'pry'
+  gem 'simplecov'
+end

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    layabout (0.0.1)
+      httpi (~> 2.1.1)
+      multipart-post (~> 1.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.6)
+    coderay (1.1.0)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    httpi (2.1.1)
+      rack
+      rubyntlm (~> 0.3.2)
+    method_source (0.8.2)
+    multi_json (1.10.1)
+    multipart-post (1.1.5)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.5.2)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.4)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.1)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.0)
+    rubyntlm (0.3.4)
+    safe_yaml (1.0.3)
+    simplecov (0.9.0)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    slop (3.6.0)
+    vcr (2.9.3)
+    webmock (1.18.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  layabout!
+  pry
+  rspec (~> 3.1.0, >= 3.1.0)
+  simplecov
+  vcr (~> 2.9.0, >= 2.9.0)
+  webmock (~> 1.18.0, >= 1.18.0)

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 James Cook
+
+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,18 @@
+# Layabout - Slack API Toolbelt
+
+
+### Configuration
+```
+Layabout.configure do |config|
+  config.team  = 'isotope11'
+  config.token = 'your-api-token'
+ end
+```
+
+### Usage
+
+```
+Layabout.say('hello world', '#random')              # Posts a message
+Layabout.upload('/path/to/a/silly.gif', 'C234546')  # You must specify the channel ID ...
+Layabout.channels                                   # Return a list of channels
+```

data/layabout.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'layabout/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "layabout"
+  spec.version       = Layabout::VERSION
+  spec.authors       = ["James Cook"]
+  spec.email         = ["jcook.rubyist@gmail.com"]
+  spec.description   = %q{slack.com API toolbelt}
+  spec.summary       = %q{Chat, upload files, set channel topics, send direct messages, and more via the Slack API}
+  spec.homepage      = "https://github.com/jamescook/layabout"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(spec)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "httpi",               "~> 2.1.1"
+  spec.add_dependency "multipart-post",      "~> 1.1.0"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rspec",   "~> 3.1.0",  ">= 3.1.0"
+  spec.add_development_dependency "vcr",     "~> 2.9.0",  ">= 2.9.0"
+  spec.add_development_dependency "webmock", "~> 1.18.0", ">= 1.18.0"
+end

data/lib/layabout/auth_test.rb

@@ -0,0 +1,35 @@
+require 'uri'
+require 'net/http'
+require 'openssl'
+require 'forwardable'
+
+module Layabout
+  class AuthTest
+    extend Forwardable
+
+    def_delegators :@configuration, :domain, :team, :token
+
+    def initialize(options={})
+      @configuration = ::Layabout.configuration
+    end
+
+    def get
+      SlackResponse.new(HTTPI.get(http_request))
+    end
+
+    private
+
+    def http_request
+      HTTPI::Request.new(endpoint.to_s).tap do |httpi|
+        httpi.auth.ssl.verify_mode = :peer
+      end
+    end
+
+    def endpoint
+      domain.tap do |uri|
+        uri.path = '/api/auth.test'
+        uri.query = "token=#{token}"
+      end
+    end
+  end
+end

data/lib/layabout/channels.rb

@@ -0,0 +1,82 @@
+require 'uri'
+require 'httpi'
+require 'forwardable'
+require_relative '../layabout/slack/channel.rb'
+
+# TODO This code was originally using Net::HTTP instead of HTTPI
+# Needs some refactoring
+module Layabout
+
+  class Channels
+    extend Forwardable
+
+    def_delegators :@configuration, :domain, :team, :token
+
+    def initialize(options={})
+      @configuration = ::Layabout.configuration
+    end
+
+    def list
+      process 'channels', SlackResponse.new(HTTPI.get(http_request(list_endpoint)))
+    end
+
+    def info(channel_id)
+      process('channel', SlackResponse.new(HTTPI.get(http_request(info_endpoint(channel_id)))))
+    end
+
+    def leave(channel_id)
+      SlackResponse.new(HTTPI.get(http_request(leave_endpoint(channel_id))))
+    end
+
+    def join(channel_name)
+      SlackResponse.new(HTTPI.get(http_request(join_endpoint(channel_name))))
+    end
+
+    private
+
+    def process(key, slack_response)
+      data = slack_response.body.fetch(key)
+      if data.kind_of?(Array)
+        return data.map{|json| ::Layabout::Slack::Channel.new(json) }
+      else
+        return ::Layabout::Slack::Channel.new(data)
+      end
+    end
+
+    def http_request(endpoint)
+      @http_request ||= HTTPI::Request.new(endpoint.to_s).tap do |httpi|
+        httpi.auth.ssl.verify_mode = :peer
+      end
+    end
+
+    def join_endpoint(channel_name)
+      build_channel_endpoint('join').tap do |uri|
+        channel_name.sub!('#', '%23')
+        uri.query = uri.query + "&name=#{channel_name}"
+      end
+    end
+
+    def leave_endpoint(channel_id)
+      build_channel_endpoint('leave').tap do |uri|
+        uri.query = uri.query + "&channel=#{channel_id}"
+      end
+    end
+
+    def list_endpoint
+      build_channel_endpoint 'list'
+    end
+
+    def info_endpoint(channel_id)
+      build_channel_endpoint('info').tap do |uri|
+        uri.query = uri.query + "&channel=#{channel_id}"
+      end
+    end
+
+    def build_channel_endpoint(action)
+      domain.tap do |uri|
+        uri.path = "/api/channels.#{action}"
+        uri.query = "token=#{token}"
+      end
+    end
+  end
+end

data/lib/layabout/chat.rb

@@ -0,0 +1,67 @@
+require 'uri'
+require 'httpi'
+require 'forwardable'
+require 'json'
+
+module Layabout
+  class Chat
+    extend Forwardable
+
+    def_delegators :@configuration, :domain, :team, :token
+
+    attr_reader :text, :channel
+
+    def initialize(options={})
+      @text          = options.fetch(:text)
+      @channel       = options.fetch(:channel)
+      @username      = options[:username]
+      @parse         = options[:parse]
+      @link_names    = options[:link_names]
+      @attachments   = options[:attachments]
+      @unfurl_links  = options[:unfurl_links]
+      @icon_url      = options[:icon_url]
+      @icon_emoji    = options[:icon_emoji]
+      @configuration = ::Layabout.configuration
+    end
+
+    def post_message
+      http_request.query = build_query
+
+      SlackResponse.new(HTTPI.get(http_request))
+    end
+
+    private
+
+    def http_request
+      @http_request ||= HTTPI::Request.new(endpoint.to_s).tap do |httpi|
+        httpi.auth.ssl.verify_mode = :peer
+      end
+    end
+
+    def build_query
+      {
+        'channel' => channel,
+        'text'    => text,
+        'token'   => token
+      }.merge(optional_params)
+    end
+
+    def optional_params
+      {}.tap do |hash|
+        hash['username']     = @username     if @username
+        hash['parse']        = @parse        if @parse
+        hash['link_names']   = @link_names   if @link_names
+        hash['attachments']  = @attachments  if @attachments
+        hash['unfurl_links'] = @unfurl_links if @unfurl_links
+        hash['icon_url']     = @icon_url     if @icon_url
+        hash['icon_emoji']   = @icon_emoji   if @icon_emoji
+      end
+    end
+
+    def endpoint
+      domain.tap do |uri|
+        uri.path = '/api/chat.postMessage'
+      end
+    end
+  end
+end

data/lib/layabout/delete_chat.rb

@@ -0,0 +1,48 @@
+require 'uri'
+require 'httpi'
+require 'forwardable'
+require 'json'
+
+module Layabout
+  class DeleteChat
+    extend Forwardable
+
+    def_delegators :@configuration, :domain, :team, :token
+
+    attr_reader :timestamp, :channel
+
+    def initialize(options={})
+      @channel       = options.fetch(:channel)
+      @timestamp     = options.fetch(:timestamp)
+      @configuration = ::Layabout.configuration
+    end
+
+    def delete
+      http_request.query = build_query
+
+      SlackResponse.new(HTTPI.get(http_request))
+    end
+
+    private
+
+    def http_request
+      @http_request ||= HTTPI::Request.new(endpoint.to_s).tap do |httpi|
+        httpi.auth.ssl.verify_mode = :peer
+      end
+    end
+
+    def build_query
+      {
+        'channel' => channel,
+        'ts'      => timestamp,
+        'token'   => token
+      }
+    end
+
+    def endpoint
+      domain.tap do |uri|
+        uri.path = '/api/chat.delete'
+      end
+    end
+  end
+end

data/lib/layabout/file_list.rb

@@ -0,0 +1,58 @@
+require 'uri'
+require 'httpi'
+require 'forwardable'
+require_relative '../layabout/slack/file.rb'
+
+module Layabout
+  class FileList
+    extend Forwardable
+
+    def_delegators :@configuration, :domain, :team, :token
+
+    def initialize(options={})
+      @configuration = ::Layabout.configuration
+      @user          = options[:user]
+      @ts_from       = options[:ts_from]
+      @ts_to         = options[:ts_to]
+      @types         = options[:types]
+      @count         = options[:count]
+      @page          = options[:page]
+    end
+
+    def list
+      process 'files', SlackResponse.new(HTTPI.get(http_request(endpoint)))
+    end
+
+    private
+
+    def process(key, slack_response)
+      data = slack_response.body.fetch(key)
+      # TODO Wrap this in an object that can be paginated
+      return data.map{|json| ::Layabout::Slack::File.new(json) }
+    end
+
+    def http_request(endpoint)
+      @http_request ||= HTTPI::Request.new(endpoint.to_s).tap do |httpi|
+        httpi.auth.ssl.verify_mode = :peer
+        httpi.query = build_query.merge('token' => token)
+      end
+    end
+
+    def build_query
+      {}.tap do |hash|
+        hash['user']    = @user     if @user
+        hash['ts_from'] = @ts_from  if @ts_from
+        hash['ts_to']   = @ts_to    if @ts_to
+        hash['types']   = @types    if @types
+        hash['count']   = @count    if @count
+        hash['page']    = @page     if @page
+      end
+    end
+
+    def endpoint
+      domain.tap do |uri|
+        uri.path = "/api/files.list"
+      end
+    end
+  end
+end

data/lib/layabout/file_upload.rb

@@ -0,0 +1,73 @@
+require 'net/http/post/multipart'
+require 'ostruct'
+
+module Layabout
+  class FileUpload
+    extend Forwardable
+
+    def_delegators :@configuration, :domain, :token
+
+    attr_reader :filepath, :channels
+
+    def initialize(options={})
+      @configuration   = ::Layabout.configuration
+      @filepath        = options.fetch(:filepath)
+      @channels        = options.fetch(:channels)
+      @filetype        = options[:filetype]
+      @filename        = options[:filename]
+      @title           = options[:title]
+      @initial_comment = options[:initial_comment]
+    end
+
+    def upload
+      SlackResponse.new(wrap(http_response))
+    end
+
+    private
+
+    # HTTPI doesn't support multipart posts. We can work around it by using another gem
+    # and handing off something that looks like a HTTPI response
+    def wrap(http_response)
+      OpenStruct.new.tap do |obj|
+        obj.code    = http_response.code.to_i
+        obj.body    = http_response.body
+        obj.headers = {}
+        http_response.each_header{|k,v| obj.headers[k] = v }
+      end
+    end
+
+    def http_response
+      req = Net::HTTP::Post::Multipart.new(endpoint.path, params)
+      res = Net::HTTP.new(endpoint.host, endpoint.port)
+      res.use_ssl = true
+      res.request(req)
+    end
+
+    def required_params
+      {
+        "file"     => UploadIO.new(File.new(filepath), "text/plain", "Gemfile"),
+        "token"    => token,
+        "channels" => channels
+      }
+    end
+
+    def optional_params
+      {}.tap do |hash|
+        hash['filetype']        = @filetype        if @filetype
+        hash['filename']        = @filename        if @filename
+        hash['title']           = @title           if @title
+        hash['initial_comment'] = @initial_comment if @initial_comment
+      end
+    end
+
+    def params
+      required_params.merge(optional_params)
+    end
+
+    def endpoint
+      domain.tap do |uri|
+        uri.path = '/api/files.upload'
+      end
+    end
+  end
+end

data/lib/layabout/helpers.rb

@@ -0,0 +1,21 @@
+require_relative './chat.rb'
+require_relative './channels.rb'
+require_relative './file_upload.rb'
+
+module Layabout
+  module Helpers
+    def say(message, channel, options={})
+      options = options.dup.merge(text: message, channel: channel)
+      Chat.new(options).post_message
+    end
+
+    def channels(options={})
+      Channels.new.list
+    end
+
+    def upload(filepath, channels, options={})
+      options = options.dup.merge(filepath: filepath, channels: channels)
+      FileUpload.new(options).upload
+    end
+  end
+end

data/lib/layabout/incoming_webhook.rb

@@ -0,0 +1,41 @@
+require 'uri'
+require 'httpi'
+require 'forwardable'
+require 'json'
+
+module Layabout
+  class IncomingWebhook
+    extend Forwardable
+
+    def_delegators :@configuration, :domain, :team
+
+    attr_reader :token, :message
+
+    def initialize(options={})
+      @token   = options.fetch(:token) # The token for Webhooks is not the same as your API token
+      @message = options.fetch(:message)
+      @configuration = ::Layabout.configuration
+    end
+
+    def post
+      http_request.body = {'text' => message}.to_json.to_s
+
+      SlackResponse.new(HTTPI.post(http_request))
+    end
+
+    private
+
+    def http_request
+      @http_request ||= HTTPI::Request.new(endpoint.to_s).tap do |httpi|
+        httpi.auth.ssl.verify_mode = :peer
+      end
+    end
+
+    def endpoint
+      domain.tap do |uri|
+        uri.path = '/services/hooks/incoming-webhook'
+        uri.query = "token=#{token}"
+      end
+    end
+  end
+end

data/lib/layabout/slack/channel.rb

@@ -0,0 +1,32 @@
+require 'forwardable'
+require 'ostruct'
+
+module Layabout
+  module Slack
+    class Channel
+      extend Forwardable
+
+      def_delegators :@attributes, :id, 
+        :name, 
+        :created,
+        :creator,
+        :is_archived,
+        :is_member,
+        :num_members,
+        :topic,
+        :purpose,
+        :members,
+        :last_read,
+        :latest,
+        :unread_count
+
+      def initialize(attributes={})
+        @attributes = OpenStruct.new(attributes)
+      end
+
+      def inspect
+        "<Layabout::Slack::Channel id='#{id}' name='#{name}'>"
+      end
+    end
+  end
+end

data/lib/layabout/slack/file.rb

@@ -0,0 +1,56 @@
+require 'forwardable'
+require 'ostruct'
+
+module Layabout
+  module Slack
+    class File
+      extend Forwardable
+
+      def_delegators :@attributes, 
+        :id,
+        :timestamp,
+        :name,
+        :title,
+        :mimetype,
+        :filetype,
+        :pretty_type,
+        :user,
+        :mode,
+        :editable,
+        :is_external,
+        :external_type,
+        :size,
+        :url,
+        :url_download,
+        :url_private,
+        :url_private_download,
+        :thumb_64,
+        :thumb_80,
+        :thumb_360,
+        :thumb_360_gif,
+        :thumb_360_w,
+        :thumb_360_h,
+        :permalink,
+        :edit_link,
+        :preview,
+        :preview_highlight,
+        :lines,
+        :lines_more,
+        :is_public,
+        :public_url_shared,
+        :channels,
+        :groups,
+        :initial_comment,
+        :num_stars,
+        :is_starred
+
+      def initialize(attributes={})
+        @attributes = OpenStruct.new(attributes)
+      end
+
+      def inspect
+        "<Layabout::Slack::File id='#{id}' name='#{name}'>"
+      end
+    end
+  end
+end