slackr 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in slackr.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Risk I/O
+
+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,64 @@
+# Slackr
+
+A simple gem for sending messages to the Slack.com communications platform.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'slackr'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install slackr
+
+## Usage
+
+
+
+Send a message to slack:
+
+```
+require 'slackr'
+slack = Slackr::Client.new("my_team_name","my_api_key")
+slack.say "this is a test"
+```
+
+Say a message to slack using some customization:
+
+```
+require 'slackr'
+slack = Slackr::Client.new("my_team_name","my_api_key",{:icon_emoji => ":ghost:"})
+slack.say("this is a test as a ghost")
+slack.say("this is a test as a ghost with a custom name",{:username => "casper"}
+```
+
+Available customizations include:
+
+```
+# slack_options
+# {
+#   "channel"    => "#myroom",
+#   "username"   => "my_bot_name",
+#   "icon_url"   => "https://slack.com/img/icons/app-57.png",
+#   "icon_emoji" => ":ghost:"
+# }
+```
+
+## TODO
+
+1. More/better tests
+2. Link parsing and attachments
+3. CLI
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

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

data/lib/slackr.rb

@@ -0,0 +1,64 @@
+require "slackr/version"
+require "slackr/errors"
+
+require "net/http"
+require "net/https" # Obsolete as of what ruby version?
+require "uri"
+require "json"
+
+# slack_options
+# {
+#   "channel"    => "#myroom",
+#   "username"   => "my_bot_name",
+#   "icon_url"   => "https://slack.com/img/icons/app-57.png",
+#   "icon_emoji" => ":ghost:"
+# }
+
+module Slackr
+
+  class Client
+    attr_reader :http, :uri, :default_options
+
+    def initialize(team,token,options={})
+      raise Slackr::ArgumentError, "Team required" if team.nil?
+      raise Slackr::ArgumentError, "Token required" if token.nil?
+
+      @team            = team
+      @token           = token
+      @default_options = options
+
+      setup_connection
+    end
+
+    def say(text="",options={})
+      # reformat links, etc here
+      send_request(text,options)
+    end
+
+    private
+    def setup_connection
+      @uri = URI.parse(service_url)
+      @http = Net::HTTP.new(@uri.host, @uri.port)
+      @http.use_ssl = true
+      @http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+    end
+
+    def service_url
+      "https://#{@team}.slack.com/services/hooks/incoming-webhook?token=#{@token}"
+    end
+
+    def encode_message(text,options)
+      "payload=#{default_options.merge(options).merge({"text" => text}).to_json.to_s}"
+    end
+
+    def send_request(text,options)
+      request = Net::HTTP::Post.new(uri.request_uri)
+      request.body = encode_message(text,options)
+      response = http.request(request)
+      unless response.code == "200"
+        raise Slackr::ServiceError, "Slack.com - #{response.code} - #{response.body}"
+      end
+    end
+
+  end
+end

data/lib/slackr/errors.rb

@@ -0,0 +1,4 @@
+module Slackr
+  class ServiceError < StandardError ; end
+  class ArgumentError < StandardError ; end
+end

data/lib/slackr/version.rb

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

data/slackr.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'slackr/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "slackr"
+  spec.version       = Slackr::VERSION
+  spec.authors       = ["Jason Rohwedder"]
+  spec.email         = ["jro@risk.io"]
+  spec.description   = %q{Talk to slack.com chat platform from ruby}
+  spec.summary       = %q{Send data into Slack in real-time, via the Incoming Webhooks API}
+  spec.homepage      = ""
+  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{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "webmock"
+end

data/spec/client_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe Slackr::Client do
+  let(:client) { Slackr::Client.new("team","token") }
+  subject { client }
+
+  describe "#initialize" do
+
+  end
+  
+  describe "#say" do
+    it "should call Client#send_request with proper options" do
+      msg = "This is a test message"
+      opts = {"channel" => "#somewhere"}
+      
+      subject.should_receive(:send_request).with(msg,opts)
+      
+      subject.say msg,opts
+    end
+  end
+
+  describe "#setup_connection" do
+
+  end
+
+  describe "#service_url" do
+    it "should generate the right url" do
+      team = "my-team"
+      token = "my-token"
+      subject = Slackr::Client.new(team,token)
+      
+      subject.send(:service_url).should eq "https://#{team}.slack.com/services/hooks/incoming-webhook?token=#{token}"
+    end
+  end
+
+  describe "#encode_message" do
+    it "should encode a basic message" do
+      msg = "this is my awesome message"
+
+      subject.send(:encode_message,msg,{}).should eq "payload={\"text\":\"#{msg}\"}"
+    end
+    it "should encode a message with options" do
+      msg = "this is my awesome message"
+      opts = {"channel" => "#awesometown"}
+
+      subject.send(:encode_message,msg,opts).should eq "payload={\"channel\":\"#awesometown\",\"text\":\"#{msg}\"}"
+    end
+    it "should encode a basic message when there are default options" do
+      msg = "this is my awesome message"
+
+      subject.stub(:default_options).and_return({"icon_emoji" => "ghost"})
+      subject.send(:encode_message,msg,{}).should eq "payload={\"icon_emoji\":\"ghost\",\"text\":\"#{msg}\"}"
+    end
+    it "should encode a message with option when there are default options present" do
+      msg = "this is my awesome message"
+      opts = {"channel" => "#awesometown"}
+
+      subject.stub(:default_options).and_return({"icon_emoji" => "ghost"})
+      subject.send(:encode_message,msg,opts).should eq "payload={\"icon_emoji\":\"ghost\",\"channel\":\"#awesometown\",\"text\":\"#{msg}\"}"
+    end
+  end
+
+  describe "#send_request" do
+
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'slackr'
+require 'webmock/rspec'
+
+RSpec.configure do |config|
+  # Use color in STDOUT
+  config.color_enabled = true
+
+  # Use color not only in STDOUT but also in pagers and files
+  config.tty = true
+
+  # Use the specified formatter
+  config.formatter = :documentation #:progress, :html, :textmate
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: slackr
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jason Rohwedder
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Talk to slack.com chat platform from ruby
+email:
+- jro@risk.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/slackr.rb
+- lib/slackr/errors.rb
+- lib/slackr/version.rb
+- slackr.gemspec
+- spec/client_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3415245645866188118
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3415245645866188118
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Send data into Slack in real-time, via the Incoming Webhooks API
+test_files:
+- spec/client_spec.rb
+- spec/spec_helper.rb