slackr 0.0.5 → 0.0.6

data/README.md

@@ -38,6 +38,10 @@ Retrieve the channel list:
 slack.channels.list # returns a hash of channel objects
 ```
 
+Upload a file (Note: You must specify channels by their ID, not name. You can send to multiple by using a comma separated list):
+```
+slack.upload '/path/to/a/file.txt', {'channels' => 'C026VKGP7'}
+
 Available customizations include:
 
 ```

data/lib/slackr.rb

@@ -3,10 +3,12 @@ require "slackr/errors"
 require "slackr/connection"
 require "slackr/webhooks/incoming"
 require "slackr/channel"
+require "slackr/file_uploader"
 
 # slack = Slackr.connect("teamX", "token124", {"channel" => "#myroom", "username" => "systems_bot"})
 # slack.say "hello world" => posts 'hello world' to the myroom channel as the systems_bot user
 # slack.say "hello", {"channel" => "#room2", "username" => "joke_bot"} => posts 'hello' to the room2 channel as the joke_but user
+# slack.upload "/path/to/a/file.txt", {"channels" => "X026VKGP7"} => uploads a file to the channel specified by ID
 # slack.channels.list => returns a hash of channel objects
 module Slackr
   extend self
@@ -25,6 +27,10 @@ module Slackr
     Slackr::IncomingWebhook.say(connection, text, options)
   end
 
+  def upload(filepath, options = {})
+    Slackr::FileUploader.new(connection, filepath, options).upload
+  end
+
   def channels
     Slackr::Channel.init(connection)
   end

data/lib/slackr/file_uploader.rb

@@ -0,0 +1,56 @@
+require "net/http"
+require "net/https"
+require 'net/http/post/multipart'
+require "uri"
+
+module Slackr
+  class FileUploader
+
+    attr_accessor :connection
+    attr_reader :channels, :filetype, :filename, :title, :comment, :filepath
+
+    def initialize(connection, filepath, options={})
+      @connection  = connection
+      @filepath    = filepath
+      @channels    = options['channels']
+      @filetype    = options['filetype']
+      @filename    = options['filename']
+      @title       = options['title']
+      @comment     = options['initial_comment']
+    end
+
+    def upload
+      response = connection.http_request(multipart)
+      if response.code != "200"
+        raise Slackr::ServiceError, "Slack.com - #{response.code} - #{response.body}"
+      end
+
+      true
+    end
+
+  private
+
+    def multipart
+      Net::HTTP::Post::Multipart.new(service_url.path,
+        {
+         'file'  => UploadIO.new(File.open(filepath), "application/data"),
+         'token' => connection.token
+        }.merge(additional_params))
+    end
+
+    def additional_params
+      {}.tap do |hash|
+        hash['channels']        = channels if channels
+        hash['filetype']        = filetype if filetype
+        hash['filename']        = filename if filename
+        hash['title']           = title    if title
+        hash['initial_comment'] = comment  if comment
+      end
+    end
+
+    def service_url
+      URI.parse("#{connection.base_url}/api/files.upload")
+    end
+  end
+end
+

data/lib/slackr/version.rb

@@ -1,3 +1,3 @@
 module Slackr
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/slackr.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "multipart-post", "~> 2.0.0"
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake", "~> 10.1.1", ">= 10.1.1"
   spec.add_development_dependency "rspec", "~> 2.14.1", ">= 2.14.1"

data/spec/fixtures/sample_file.txt

@@ -0,0 +1 @@
+Hello world!

data/spec/slackr/file_uploader_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Slackr::FileUploader do
+  let(:connection) {  Slackr::Connection.new("team", "token", {}) }
+
+  before do
+    connection.send(:setup_connection)
+
+    stub_request(:post, "https://team.slack.com/api/files.upload").
+         with(:body => "-------------RubyMultipartPost\r\nContent-Disposition: form-data; name=\"file\"; filename=\"sample_file.txt\"\r\nContent-Length: 13\r\nContent-Type: application/data\r\nContent-Transfer-Encoding: binary\r\n\r\nHello world!\n\r\n-------------RubyMultipartPost\r\nContent-Disposition: form-data; name=\"token\"\r\n\r\ntoken\r\n-------------RubyMultipartPost\r\nContent-Disposition: form-data; name=\"channels\"\r\n\r\n123456789\r\n-------------RubyMultipartPost\r\nContent-Disposition: form-data; name=\"filetype\"\r\n\r\ntxt\r\n-------------RubyMultipartPost\r\nContent-Disposition: form-data; name=\"title\"\r\n\r\nsome custom title\r\n-------------RubyMultipartPost\r\nContent-Disposition: form-data; name=\"initial_comment\"\r\n\r\nsome kind of comment\r\n-------------RubyMultipartPost--\r\n\r\n",
+              :headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Length'=>'725', 'Content-Type'=>'multipart/form-data; boundary=-----------RubyMultipartPost', 'User-Agent'=>'Ruby'}).
+         to_return(:status => 200, :body => "", :headers => {})
+
+    # 1.9.3 fix
+    stub_request(:post, "https://team.slack.com/api/files.upload").
+         with(:body => "-------------RubyMultipartPost\r\nContent-Disposition: form-data; name=\"file\"; filename=\"sample_file.txt\"\r\nContent-Length: 13\r\nContent-Type: application/data\r\nContent-Transfer-Encoding: binary\r\n\r\nHello world!\n\r\n-------------RubyMultipartPost\r\nContent-Disposition: form-data; name=\"token\"\r\n\r\ntoken\r\n-------------RubyMultipartPost\r\nContent-Disposition: form-data; name=\"channels\"\r\n\r\n123456789\r\n-------------RubyMultipartPost\r\nContent-Disposition: form-data; name=\"filetype\"\r\n\r\ntxt\r\n-------------RubyMultipartPost\r\nContent-Disposition: form-data; name=\"title\"\r\n\r\nsome custom title\r\n-------------RubyMultipartPost\r\nContent-Disposition: form-data; name=\"initial_comment\"\r\n\r\nsome kind of comment\r\n-------------RubyMultipartPost--\r\n\r\n",
+              :headers => {'Accept'=>'*/*', 'Content-Length'=>'725', 'Content-Type'=>'multipart/form-data; boundary=-----------RubyMultipartPost', 'User-Agent'=>'Ruby'}).
+         to_return(:status => 200, :body => "", :headers => {})
+  end
+
+  describe "#upload" do
+    let(:filepath) { "spec/fixtures/sample_file.txt" }
+    let(:options) { {'channels' => '123456789', 'filetype' => 'txt', 'title' => 'some custom title', 'initial_comment' => 'some kind of comment'} }
+
+    subject { described_class.new(connection, filepath, options) }
+
+    it "should upload the file to the specified channel" do
+      expect(subject.upload).to eq true
+    end
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: slackr
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Jason Rohwedder
@@ -10,30 +10,45 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-13 00:00:00.000000000 Z
+date: 2014-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  type: :development
   prerelease: false
-  name: bundler
+  name: multipart-post
+  type: :runtime
   requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0
     none: false
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  name: bundler
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
-  version_requirements: !ruby/object:Gem::Requirement
     none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
+    none: false
 - !ruby/object:Gem::Dependency
-  type: :development
   prerelease: false
   name: rake
+  type: :development
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -41,8 +56,8 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 10.1.1
-  version_requirements: !ruby/object:Gem::Requirement
     none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -50,12 +65,12 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 10.1.1
+    none: false
 - !ruby/object:Gem::Dependency
-  type: :development
   prerelease: false
   name: rspec
+  type: :development
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -63,8 +78,8 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.14.1
-  version_requirements: !ruby/object:Gem::Requirement
     none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -72,12 +87,12 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.14.1
+    none: false
 - !ruby/object:Gem::Dependency
-  type: :development
   prerelease: false
   name: webmock
+  type: :development
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -85,8 +100,8 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.17.4
-  version_requirements: !ruby/object:Gem::Requirement
     none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -94,6 +109,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.17.4
+    none: false
 description: Talk to slack.com chat platform from ruby
 email:
 - jro@risk.io
@@ -112,11 +128,14 @@ files:
 - lib/slackr/channel.rb
 - lib/slackr/connection.rb
 - lib/slackr/errors.rb
+- lib/slackr/file_uploader.rb
 - lib/slackr/version.rb
 - lib/slackr/webhooks/incoming.rb
 - slackr.gemspec
+- spec/fixtures/sample_file.txt
 - spec/slackr/channel_spec.rb
 - spec/slackr/connection_spec.rb
+- spec/slackr/file_uploader_spec.rb
 - spec/slackr/webhooks/incoming_spec.rb
 - spec/slackr_spec.rb
 - spec/spec_helper.rb
@@ -128,17 +147,23 @@ rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: -3557734913826783238
       version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: -3557734913826783238
       version: '0'
+  none: false
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23.2
@@ -146,8 +171,10 @@ signing_key:
 specification_version: 3
 summary: Send data into Slack in real-time, via the Incoming Webhooks API
 test_files:
+- spec/fixtures/sample_file.txt
 - spec/slackr/channel_spec.rb
 - spec/slackr/connection_spec.rb
+- spec/slackr/file_uploader_spec.rb
 - spec/slackr/webhooks/incoming_spec.rb
 - spec/slackr_spec.rb
 - spec/spec_helper.rb