slack-notify 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9bb78e8f557ad72bf40e7dada483c74f363eb9b5
+  data.tar.gz: a53d66d0b94c5bbb8b88ddeacfb3bf9abb4cf711
+SHA512:
+  metadata.gz: 3c1ffa1661501b852ac68c44dfe1b1a88fb0fbfa240c3e09e024a597bff004e6d1c6a9e4f4244f3e2e3b957e50e8d9bfb2cd9d103ac62a2a160448f327b9b6a8
+  data.tar.gz: ca8cac631640524704dbbe5ef810f3ab8d04ef41f87b263229e8ed148030696dfbe9b0eeab1c127dd354ece20388b01811858438ab67dcfdbbeda9d1cb7cde51

data/.gitignore

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

data/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Dan Sosedoff
+
+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,72 @@
+# slack-notify
+
+Send notifications to [Slack](http://slack.com/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```
+gem "slack-notify"
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install slack-notify
+```
+
+## Usage
+
+Require:
+
+```ruby
+require "slack-notify"
+```
+
+Initialize client:
+
+```ruby
+client = SlackNotify::Client.new("subdomain", "token")
+```
+
+Initialize with options:
+
+```ruby
+client = SlackNotify::Client.new("subdomain", "token", {
+  channel: "#development",
+  username: "mybot"
+})
+```
+
+Send test request:
+
+```ruby
+client.test
+```
+
+Send message:
+
+```ruby
+client.notify("Hello There!")
+client.notify("Another message", "#channel2")
+```
+
+## Gotchas
+
+Some of the issues while Slack is in beta:
+
+- No message raised if domain is not valid
+- Slack raises error 500 on bad request
+
+## License
+
+Copyright (c) 2013 Dan Sosedoff
+
+MIT License

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:test) do |t|
+  t.pattern = "spec/*_spec.rb"
+  t.verbose = false
+end
+
+task :default => :test

data/lib/slack-notify.rb

@@ -0,0 +1,52 @@
+require "slack-notify/version"
+require "slack-notify/error"
+
+require "json"
+require "faraday"
+
+module SlackNotify
+  class Client
+    def initialize(subdomain, token, options={})
+      @subdomain = subdomain
+      @token     = token
+      @username  = options[:username] || "webhookbot"
+      @channel   = options[:channel] || "#general"
+
+      raise ArgumentError, "Subdomain required" if @subdomain.nil?
+      raise ArgumentError, "Token required"     if @token.nil?
+    end
+
+    def test
+      notify("This is a test message!")
+    end
+
+    def notify(text, channel=nil)
+      send_payload(
+        text: text,
+        channel: channel || @channel,
+        username: @username
+      )
+    end
+
+    private
+
+    def send_payload(payload)
+      url = "https://#{@subdomain}.slack.com/services/hooks/incoming-webhook"
+      url << "?token=#{@token}"
+
+      response = Faraday.post(url) do |req|
+        req.body = JSON.dump(payload)
+      end
+
+      if response.success?
+        true
+      else
+        if response.body.include?("\n")
+          raise SlackNotify::Error
+        else
+          raise SlackNotify::Error.new(response.body)
+        end
+      end
+    end
+  end
+end

data/lib/slack-notify/error.rb

@@ -0,0 +1,3 @@
+module SlackNotify
+  class Error < StandardError ; end
+end

data/lib/slack-notify/version.rb

@@ -0,0 +1,3 @@
+module SlackNotify
+  VERSION = "0.1.0"
+end

data/slack-notify.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'slack-notify/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "slack-notify"
+  spec.version       = SlackNotify::VERSION
+  spec.authors       = ["Dan Sosedoff"]
+  spec.email         = ["dan.sosedoff@gmail.com"]
+  spec.description   = %q{Send notifications to Slack channel}
+  spec.summary       = %q{Send notifications to Slack channel}
+  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",      "~> 10"
+  spec.add_development_dependency "simplecov", "~> 0.8"
+  spec.add_development_dependency "rspec",     "~> 2.13"
+  spec.add_development_dependency "webmock",   "~> 1.0"
+
+  spec.add_dependency "faraday", "~> 0.8"
+  spec.add_dependency "json",    "~> 1.8"
+end

data/spec/slack-notify/client_spec.rb

@@ -0,0 +1,116 @@
+require "spec_helper"
+
+describe SlackNotify::Client do
+  describe "#initialize" do
+    it "requires subdomain" do
+      expect { described_class.new(nil, nil) }.
+        to raise_error ArgumentError, "Subdomain required"
+    end
+
+    it "requires token" do
+      expect { described_class.new("foobar", nil) }.
+        to raise_error ArgumentError, "Token required"
+    end
+  end
+
+  describe "#test" do
+    let(:client) do
+      described_class.new("foo", "token")
+    end
+
+    let(:payload) do
+      {
+        text: "This is a test message!",
+        channel: "#general",
+        username: "webhookbot"
+      }
+    end
+
+    before do
+      client.stub(:send_payload) { true }
+    end
+
+    it "sends a test payload" do
+      expect(client).to receive(:send_payload).with(payload)
+      client.test
+    end
+  end
+
+  describe "#notify" do
+    let(:client) do
+      described_class.new("foo", "token")
+    end
+
+    it "sends message to default channel" do
+      client.stub(:send_payload) { true }
+
+      expect(client).to receive(:send_payload).with(
+        text: "Message",
+        channel: "#general",
+        username: "webhookbot"
+      )
+
+      client.notify("Message")
+    end
+
+    it "sends message as default user" do
+      client.stub(:send_payload) { true }
+
+      expect(client).to receive(:send_payload).with(
+        text: "Message",
+        channel: "#general",
+        username: "webhookbot"
+      )
+
+      client.notify("Message")
+    end
+
+    it "sends message to a specified channel" do
+      client.stub(:send_payload) { true }
+
+      expect(client).to receive(:send_payload).with(
+        text: "Message",
+        channel: "#mychannel",
+        username: "webhookbot"
+      )
+
+      client.notify("Message", "#mychannel")
+    end
+
+    it "delivers payload" do
+      stub_request(:post, "https://foo.slack.com/services/hooks/incoming-webhook?token=token").
+         with(:body => {"{\"text\":\"Message\",\"channel\":\"#general\",\"username\":\"webhookbot\"}"=>true},
+              :headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/x-www-form-urlencoded', 'User-Agent'=>'Faraday v0.8.8'}).
+         to_return(:status => 200, :body => "", :headers => {})
+
+      expect(client.notify("Message")).to eq true
+    end
+
+    context "invalid subdomain" do
+      before do
+        stub_request(:post, "https://foo.slack.com/services/hooks/incoming-webhook?token=token").
+         with(:body => {"{\"text\":\"Message\",\"channel\":\"#general\",\"username\":\"webhookbot\"}"=>true},
+              :headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/x-www-form-urlencoded', 'User-Agent'=>'Faraday v0.8.8'}).
+         to_return(:status => 404, :body => "Multi line\ncontent\nhtml stuff", :headers => {})
+      end
+
+      it "raises error" do
+        expect { client.notify("Message") }.to raise_error SlackNotify::Error
+      end
+    end
+
+    context "invalid token" do
+      before do
+        stub_request(:post, "https://foo.slack.com/services/hooks/incoming-webhook?token=token").
+         with(:body => {"{\"text\":\"Message\",\"channel\":\"#general\",\"username\":\"webhookbot\"}"=>true},
+              :headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/x-www-form-urlencoded', 'User-Agent'=>'Faraday v0.8.8'}).
+         to_return(:status => 404, :body => "No hooks", :headers => {})
+      end
+
+      it "raises error" do
+        expect { client.notify("Message") }
+          .to raise_error SlackNotify::Error, "No hooks"
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require "simplecov"
+SimpleCov.start
+
+$:.unshift File.expand_path("../..", __FILE__)
+
+require "webmock"
+require "webmock/rspec"
+require "slack-notify"
+
+def fixture_path(filename=nil)
+  path = File.expand_path("../fixtures", __FILE__)
+  filename.nil? ? path : File.join(path, filename)
+end
+
+def fixture(file)
+  File.read(File.join(fixture_path, file))
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: slack-notify
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dan Sosedoff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: Send notifications to Slack channel
+email:
+- dan.sosedoff@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/slack-notify.rb
+- lib/slack-notify/error.rb
+- lib/slack-notify/version.rb
+- slack-notify.gemspec
+- spec/slack-notify/client_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.5
+signing_key: 
+specification_version: 4
+summary: Send notifications to Slack channel
+test_files:
+- spec/slack-notify/client_spec.rb
+- spec/spec_helper.rb
+has_rdoc: