slack-notify 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00ae9577d0c514b298a64e4516e24b1b3a888e11
-  data.tar.gz: 168e894c3fbc4206e0451bb9ff626b2232f6a23b
+  metadata.gz: 03e6c9b0e49fde578cd9f35b06f842d31d4f37cd
+  data.tar.gz: 6a6cb121c35a1e62ecb7dd0f47e1da4a773d37a0
 SHA512:
-  metadata.gz: 3ae2ba9457d0f19474275265e844a8fd2461d6e7ee1154bd990cc4f3238ae7c23bf1d327c9e3e6d598e1b99cdb3d41f5a7720b7072560fbe16f318549dc9e016
-  data.tar.gz: e56fd9be21863aa0f1ce9656063918ec059383318b526f50cac12184ba9c5cd227869432a5f3596886ec967ed139a9864dc47134ee4ea822c770e03e370a15cd
+  metadata.gz: c4d94d98b07f026fbd651e5b3cb87e03af147cb33ea8758109a4ee11680c120997d0337571413d9b2ed307d6d551c1679d07fc345db3e48c02da927684041f9d
+  data.tar.gz: f57fd7011d8295e0de59c755b774ddffa9b664e2aa960c565bb7b7913d7e39b447fa638d085bce9d10b1f3eeb8d8253e6f8c7bf22afc751f355b29b810060d65

data/.travis.yml

@@ -0,0 +1,4 @@
+rvm:
+  - "2.0.0"
+  - "2.1.0"
+  - "2.1.1"

data/README.md

@@ -2,6 +2,9 @@
 
 Send notifications to [Slack](http://slack.com/)
 
+[![Build Status](https://travis-ci.org/sosedoff/slack-notify.png?branch=master)](https://travis-ci.org/sosedoff/slack-notify)
+[![Code Climate](https://codeclimate.com/github/sosedoff/slack-notify.png)](https://codeclimate.com/github/sosedoff/slack-notify)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -41,7 +44,9 @@ Initialize with options:
 ```ruby
 client = SlackNotify::Client.new("team", "token", {
   channel: "#development",
-  username: "mybot"
+  username: "mybot",
+  icon_url: "http://mydomain.com/myimage.png",
+  icon_emoji: ":shipit:"
 })
 ```
 
@@ -65,6 +70,12 @@ Send direct message:
 client.notify("Hello There!", "@username")
 ```
 
+You can also test gem via rake console:
+
+```
+rake console
+```
+
 ## Gotchas
 
 Current issues with Slack API:

data/Rakefile

@@ -6,4 +6,14 @@ RSpec::Core::RakeTask.new(:test) do |t|
   t.verbose = false
 end
 
+task :console do
+  require "irb"
+  require "irb/completion"
+  require "pp"
+  require "slack-notify"
+  
+  ARGV.clear
+  IRB.start
+end
+
 task :default => :test

data/lib/slack-notify/client.rb

@@ -0,0 +1,55 @@
+require "json"
+require "faraday"
+
+module SlackNotify
+  class Client
+    include SlackNotify::Connection
+
+    def initialize(team, token, options = {})
+      @team       = team
+      @token      = token
+      @username   = options[:username]
+      @channel    = options[:channel]
+      @icon_url   = options[:icon_url]
+      @icon_emoji = options[:icon_emoji]
+
+      validate_arguments
+    end
+
+    def test
+      notify("Test Message")
+    end
+
+    def notify(text, channel = nil)
+      delivery_channels(channel).each do |chan|
+        payload = SlackNotify::Payload.new(
+          text:       text,
+          channel:    chan,
+          username:   @username,
+          icon_url:   @icon_url,
+          icon_emoji: @icon_emoji
+        )
+
+        send_payload(payload)
+      end
+
+      true
+    end
+
+    private
+
+    def validate_arguments
+      raise ArgumentError, "Team name required" if @team.nil?
+      raise ArgumentError, "Token required"     if @token.nil?
+      raise ArgumentError, "Invalid team name"  unless valid_team_name?
+    end
+
+    def valid_team_name?
+      @team =~ /^[a-z\d\-]+$/ ? true : false
+    end
+
+    def delivery_channels(channel)
+      [channel || @channel || "#general"].flatten.compact.uniq
+    end
+  end
+end

data/lib/slack-notify/connection.rb

@@ -0,0 +1,34 @@
+module SlackNotify
+  module Connection
+    def send_payload(payload)
+      conn = Faraday.new(hook_url, { timeout: 5, open_timeout: 5 }) do |c|
+        c.use(Faraday::Request::UrlEncoded)
+        c.adapter(Faraday.default_adapter)
+      end
+
+      response = conn.post do |req|
+        req.body = JSON.dump(payload.to_hash)
+      end
+
+      handle_response(response)
+    end
+
+    def handle_response(response)
+      unless response.success?
+        if response.body.include?("\n")
+          raise SlackNotify::Error
+        else
+          raise SlackNotify::Error.new(response.body)
+        end
+      end
+    end
+
+    def hook_url
+      "#{base_url}/services/hooks/incoming-webhook?token=#{@token}"
+    end
+
+    def base_url
+      "https://#{@team}.slack.com"
+    end
+  end
+end

data/lib/slack-notify/payload.rb

@@ -0,0 +1,29 @@
+module SlackNotify
+  class Payload
+    attr_accessor :username, :text, :channel, :icon_url, :icon_emoji
+
+    def initialize(options = {})
+      @username   = options[:username] || "webhookbot"
+      @channel    = options[:channel]  || "#general"
+      @text       = options[:text]
+      @icon_url   = options[:icon_url]
+      @icon_emoji = options[:icon_emoji]
+
+      unless channel[0] =~ /^(#|@)/
+        @channel = "##{@channel}"
+      end
+    end
+
+    def to_hash
+     hash = {
+        text:       text,
+        username:   username,
+        channel:    channel,
+        icon_url:   icon_url,
+        icon_emoji: icon_emoji
+      }
+
+      hash.delete_if { |_,v| v.nil? }
+    end
+  end
+end

data/lib/slack-notify/version.rb

@@ -1,3 +1,3 @@
 module SlackNotify
-  VERSION = "0.1.4"
+  VERSION = "0.2.0"
 end

data/lib/slack-notify.rb

@@ -1,75 +1,5 @@
 require "slack-notify/version"
 require "slack-notify/error"
-
-require "json"
-require "faraday"
-
-module SlackNotify
-  class Client
-    def initialize(team, token, options = {})
-      @team     = team
-      @token    = token
-      @username = options[:username] || "webhookbot"
-      @channel  = options[:channel]  || "#general"
-
-      raise ArgumentError, "Team name required" if @team.nil?
-      raise ArgumentError, "Token required"     if @token.nil?
-      raise ArgumentError, "Invalid team name"  unless valid_team_name?
-    end
-
-    def test
-      notify("This is a test message!")
-    end
-
-    def notify(text, channel = nil)
-      format_channel(channel).each do |chan|
-        send_payload(text: text, username: @username, channel: chan)
-      end
-
-      true
-    end
-
-    private
-
-    def format_channel(channel)
-      [channel || @channel].flatten.compact.uniq.map do |name|
-        name[0].match(/^(#|@)/) && name || "##{name}"
-      end
-    end
-
-    def send_payload(payload)
-      conn = Faraday.new(hook_url, { timeout: 5, open_timeout: 5 }) do |c|
-        c.use(Faraday::Request::UrlEncoded)
-        c.adapter(Faraday.default_adapter)
-      end
-
-      response = conn.post do |req|
-        req.body = JSON.dump(payload)
-      end
-
-      handle_response(response)
-    end
-
-    def handle_response(response)
-      unless response.success?
-        if response.body.include?("\n")
-          raise SlackNotify::Error
-        else
-          raise SlackNotify::Error.new(response.body)
-        end
-      end
-    end
-
-    def valid_team_name?
-      @team =~ /^[a-z\d\-]+$/ ? true : false
-    end
-
-    def hook_url
-      "#{base_url}/services/hooks/incoming-webhook?token=#{@token}"
-    end
-
-    def base_url
-      "https://#{@team}.slack.com"
-    end
-  end
-end
+require "slack-notify/connection"
+require "slack-notify/payload"
+require "slack-notify/client"

data/spec/slack-notify/client_spec.rb

@@ -23,68 +23,20 @@ describe SlackNotify::Client do
   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
+    let(:client) { described_class.new("foo", "token") }
 
     before do
-      client.stub(:send_payload) { true }
+      client.stub(:notify)
+      client.test
     end
 
-    it "sends a test payload" do
-      expect(client).to receive(:send_payload).with(payload)
-      client.test
+    it "it sends a test message" do
+      expect(client).to have_received(:notify).with("Test Message")
     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
+    let(:client) { described_class.new("foo", "token") }
 
     it "delivers payload" do
       stub_request(:post, "https://foo.slack.com/services/hooks/incoming-webhook?token=token").
@@ -119,34 +71,44 @@ describe SlackNotify::Client do
       end
     end
 
-    context "with multiple channels" do
+    context "when icon_url is set" do
+      let(:client) { described_class.new("foo", "bar", icon_url: "foobar") }
+
       before do
-        client.stub(:send_payload) { true }
+        stub_request(:post, "https://foo.slack.com/services/hooks/incoming-webhook?token=bar").
+          with(:body => {"{\"text\":\"Message\",\"username\":\"webhookbot\",\"channel\":\"#general\",\"icon_url\":\"foobar\"}"=>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.9'}).
+          to_return(:status => 200, :body => "", :headers => {})
       end
 
-      it "delivers payload to multiple channels" do
-        expect(client).to receive(:send_payload).exactly(2).times
-        client.notify("Message", ["#channel1", "#channel2"])
+      it "includes url in payload" do
+        client.notify("Message")
       end
     end
 
-    context "when pound symbol is missing" do
-      before { client.stub(:send_payload).and_return(true) }
+    context "when icon_emoji is set" do
+      let(:client) { described_class.new("foo", "bar", icon_emoji: "foobar") }
 
-      it "adds pound symbol to channel name" do
-        expect(client).to receive(:send_payload).with(text: "Message", username: "webhookbot", channel: "#foobar")
-        client.notify("Message", "foobar")
+      before do
+        stub_request(:post, "https://foo.slack.com/services/hooks/incoming-webhook?token=bar").
+          with(:body => {"{\"text\":\"Message\",\"username\":\"webhookbot\",\"channel\":\"#general\",\"icon_emoji\":\"foobar\"}"=>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.9'}).
+          to_return(:status => 200, :body => "", :headers => {})
+      end
+
+      it "includes icon in payload" do
+        client.notify("Message")
       end
     end
 
-    context "when direct message" do
+    context "with multiple channels" do
       before do
-        client.stub(:send_payload).and_return(true)
-        client.notify("Message", "@user")
+        client.stub(:send_payload) { true }
+        client.notify("Message", ["#channel1", "#channel2"])
       end
 
-      it "sends payload to a user" do
-        expect(client).to have_received(:send_payload).with(text: "Message", username: "webhookbot", channel: "@user")
+      it "delivers payload to multiple channels" do
+        expect(client).to have_received(:send_payload).exactly(2).times
       end
     end
 

data/spec/slack-notify/payload_spec.rb

@@ -0,0 +1,105 @@
+require "spec_helper"
+
+describe SlackNotify::Payload do
+  let(:options) do
+    {
+      username: "foo",
+      channel: "#bar",
+      text: "hola",
+      icon_url: "http://domain.com/image.png",
+      icon_emoji: ":chart_with_upwards_trend:"
+    }
+  end
+
+  describe "#initialize" do
+    let(:payload) { described_class.new(options) }
+
+    context "with options" do
+      it "sets username" do
+        expect(payload.username).to eq "foo"
+      end
+
+      it "sets channel" do
+        expect(payload.channel).to eq "#bar"
+      end
+
+      it "sets text" do
+        expect(payload.text).to eq "hola"
+      end
+
+      it "sets icon url" do
+        expect(payload.icon_url).to eq "http://domain.com/image.png"
+      end
+
+      it "sets icon emoji" do
+        expect(payload.icon_emoji).to eq ":chart_with_upwards_trend:"
+      end
+
+      context "on missing pound in channel" do
+        let(:options) do
+          { channel: "foo" }
+        end
+
+        it "adds pound symbol" do
+          expect(payload.channel).to eq "#foo"
+        end
+      end
+
+      context "on direct message" do
+        let(:options) do
+          { channel: "@dan" }
+        end
+
+        it "keeps the symbol" do
+          expect(payload.channel).to eq "@dan"
+        end
+      end
+    end
+
+    context "without options" do
+      let(:options) { Hash.new }
+
+      it "sets username" do
+        expect(payload.username).to eq "webhookbot"
+      end
+
+      it "sets channel" do
+        expect(payload.channel).to eq "#general"
+      end
+    end
+  end
+
+  describe "#to_hash" do
+    let(:hash) { described_class.new(options).to_hash }
+
+    it "includes basic attributes" do
+      expect(hash).to eq Hash(
+        channel: "#bar",
+        icon_url: "http://domain.com/image.png",
+        icon_emoji: ":chart_with_upwards_trend:",
+        text: "hola",
+        username: "foo"
+      )
+    end
+
+    context "when icon url is not set" do
+      before do
+        options[:icon_url] = nil
+      end
+
+      it "excludes icon_url" do
+        expect(hash.keys).not_to include "icon_url"
+      end
+    end
+
+    context "when icon emoji is not set" do
+      before do
+        options[:icon_emoji] = nil
+      end
+
+      it "excludes icon_emoji" do
+        expect(hash.keys).not_to include "icon_emoji"
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack-notify
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Dan Sosedoff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-02 00:00:00.000000000 Z
+date: 2014-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -117,15 +117,20 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/slack-notify.rb
+- lib/slack-notify/client.rb
+- lib/slack-notify/connection.rb
 - lib/slack-notify/error.rb
+- lib/slack-notify/payload.rb
 - lib/slack-notify/version.rb
 - slack-notify.gemspec
 - spec/slack-notify/client_spec.rb
+- spec/slack-notify/payload_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/sosedoff/slack-notify
 licenses:
@@ -153,4 +158,5 @@ specification_version: 4
 summary: Send notifications to a Slack channel
 test_files:
 - spec/slack-notify/client_spec.rb
+- spec/slack-notify/payload_spec.rb
 - spec/spec_helper.rb