slack-notify 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 20a2b6939a5568e6d47b85ce5324cd5625027a1c
-  data.tar.gz: 7215519c083be5901151756f7a099f12589dfd07
+  metadata.gz: 7258bd95339bbf7ce21f40177fe44b2cefe94a06
+  data.tar.gz: a1ff2e2acfcab61138ae1d3558f91616fae29883
 SHA512:
-  metadata.gz: 4588aff57f04f9d036b5e200e195f59c75d1d2d4110dd1e2d37be95add91901cb8ba9c5d2abaed8fda10b04779e5ab0225030899f65f33d2031a3730d0033372
-  data.tar.gz: 1d0b1f9fac8129006e1e3c6b85e3548610ccb798c7a2f210a57536c8f23130761cc3fc55cc3b717edfa6f53f275820b5bc68a4d06ef096612cd88dbc3cd0cd17
+  metadata.gz: 0a25b9e37a3e7e74baf9e81567640f0c6bb93a4f2b9a497a6c78ba5b0908c4e2ed04e8ef2a4f58dc43cbc90e753a4b0d696741171ea7a66924e5d2896570e335
+  data.tar.gz: a9bbde639753f8077256c3d2c80dd1696e1a031bed8f03c95d73ca82ed3b3068b6fb5283efbc5108e3b47b97a81dc1d62152f068c87b723386896d6e8ed96b31

data/README.md

@@ -1,6 +1,6 @@
 # slack-notify
 
-Send notifications to [Slack](http://slack.com/)
+Send notifications to [Slack](http://slack.com/) via webhooks.
 
 [![Build Status](http://img.shields.io/travis/sosedoff/slack-notify/master.svg?style=flat)](https://travis-ci.org/sosedoff/slack-notify)
 [![Code Climate](http://img.shields.io/codeclimate/github/sosedoff/slack-notify.svg?style=flat)](https://codeclimate.com/github/sosedoff/slack-notify)
@@ -37,13 +37,13 @@ require "slack-notify"
 Initialize client:
 
 ```ruby
-client = SlackNotify::Client.new("team", "token")
+client = SlackNotify::Client.new("slack webhook url")
 ```
 
 Initialize with options:
 
 ```ruby
-client = SlackNotify::Client.new("team", "token", {
+client = SlackNotify::Client.new("slack webhook url", {
   channel: "#development",
   username: "mybot",
   icon_url: "http://mydomain.com/myimage.png",
@@ -52,6 +52,12 @@ client = SlackNotify::Client.new("team", "token", {
 })
 ```
 
+Initialize via shorthand method:
+
+```ruby
+client = SlackNotify.new(options)
+```
+
 Send test request:
 
 ```ruby
@@ -78,13 +84,6 @@ You can also test gem via rake console:
 rake console
 ```
 
-## Gotchas
-
-Current issues with Slack API:
-
-- No message raised if team subdomain is invalid
-- 500 server error is raised on bad requests
-
 ## License
 
 Copyright (c) 2013-2014 Dan Sosedoff, <dan.sosedoff@gmail.com>

data/lib/slack-notify.rb

@@ -2,4 +2,10 @@ require "slack-notify/version"
 require "slack-notify/error"
 require "slack-notify/connection"
 require "slack-notify/payload"
-require "slack-notify/client"
+require "slack-notify/client"
+
+module SlackNotify
+  def self.new(options = {})
+    SlackNotify::Client.new(options)
+  end
+end

data/lib/slack-notify/client.rb

@@ -5,9 +5,8 @@ module SlackNotify
   class Client
     include SlackNotify::Connection
 
-    def initialize(team, token, options = {})
-      @team         = team
-      @token        = token
+    def initialize(options = {})
+      @webhook_url  = options[:webhook_url]
       @username     = options[:username]
       @channel      = options[:channel]
       @icon_url     = options[:icon_url]
@@ -15,7 +14,9 @@ module SlackNotify
       @link_names   = options[:link_names]
       @unfurl_links = options[:unfurl_links] || "1"
 
-      validate_arguments
+      if @webhook_url.nil?
+        raise ArgumentError, "Webhook URL required"
+      end
     end
 
     def test
@@ -42,16 +43,6 @@ module SlackNotify
 
     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\-]+$/i ? true : false
-    end
-
     def delivery_channels(channel)
       [channel || @channel || "#general"].flatten.compact.uniq
     end

data/lib/slack-notify/connection.rb

@@ -1,7 +1,7 @@
 module SlackNotify
   module Connection
     def send_payload(payload)
-      conn = Faraday.new(hook_url) do |c|
+      conn = Faraday.new(@webhook_url) do |c|
         c.use(Faraday::Request::UrlEncoded)
         c.adapter(Faraday.default_adapter)
         c.options.timeout      = 5
@@ -24,13 +24,5 @@ module SlackNotify
         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/version.rb

@@ -1,3 +1,3 @@
 module SlackNotify
-  VERSION = "0.3.3"
+  VERSION = "0.4.0"
 end

data/spec/slack-notify/client_spec.rb

@@ -2,36 +2,17 @@ require "spec_helper"
 
 describe SlackNotify::Client do
   describe "#initialize" do
-    it "requires team name" do
-      expect { described_class.new(nil, nil) }.
-        to raise_error ArgumentError, "Team name required"
+    it "requires webhook_url" do
+      expect { described_class.new }.to raise_error ArgumentError, "Webhook URL required"
     end
 
-    it "requires token" do
-      expect { described_class.new("foobar", nil) }.
-        to raise_error ArgumentError, "Token required"
-    end
-
-    it "raises error on invalid team name" do
-      names = ["foo bar", "foo $bar", "foo.bar"]
-
-      names.each do |name|
-        expect { described_class.new(name, "token") }.
-          to raise_error "Invalid team name"
-      end
-    end
-
-    it "does not raise error on valid team name" do
-      names = ["foo", "Foo", "foo-bar"]
-
-      names.each do |name|
-        expect { described_class.new(name, "token") }.not_to raise_error
-      end
+    it "does not raise error when webhook_url is set" do
+      expect { described_class.new(webhook_url: "foobar") }.not_to raise_error
     end
   end
 
   describe "#test" do
-    let(:client) { described_class.new("foo", "token") }
+    let(:client) { described_class.new(webhook_url: "foobar") }
 
     before do
       client.stub(:notify)
@@ -44,46 +25,31 @@ describe SlackNotify::Client do
   end
 
   describe "#notify" do
-    let(:client) { described_class.new("foo", "token") }
+    let(:client) do
+      described_class.new(webhook_url: "https://hooks.slack.com/services/foo/bar")
+    end
 
-    it "delivers payload" do
-      stub_request(:post, "https://foo.slack.com/services/hooks/incoming-webhook?token=token").
-         with(:body => {"{\"text\":\"Message\",\"username\":\"webhookbot\",\"channel\":\"#general\",\"unfurl_links\":\"1\"}"=>true},
-              :headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/x-www-form-urlencoded'}).
-         to_return(:status => 200, :body => "", :headers => {})
+    before do
+      stub_request(:post, "https://hooks.slack.com/services/foo/bar").
+       with(:body => {"{\"text\":\"Message\",\"username\":\"webhookbot\",\"channel\":\"#general\",\"unfurl_links\":\"1\"}"=>true},
+            :headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/x-www-form-urlencoded'}).
+       to_return(:status => 200, :body => "", :headers => {})
+    end
 
+    it "delivers payload" do
       expect(client.notify("Message")).to eq true
     end
 
-    context "with settings from environment variables" do
-      let(:vars) { ["SLACK_TEAM", "SLACK_TOKEN", "SLACK_CHANNEL", "SLACK_USER"] }
-
+    context "when icon_url is set" do
       let(:client) do
-        described_class.new(ENV["SLACK_TEAM"], ENV["SLACK_TOKEN"], {
-          channel: ENV["SLACK_CHANNEL"],
-          username: ENV["SLACK_USER"]
-        })
+        described_class.new(
+          webhook_url: "https://hooks.slack.com/services/foo/bar",
+          icon_url: "foobar"
+        )
       end
 
       before do
-        vars.each { |v| ENV[v] = "foobar" }
-        client.stub(:send_payload) { true }
-      end
-
-      after do
-        vars.each { |v| ENV.delete(v) }
-      end
-
-      it "sends data to channel specified by environment variables" do
-        client.notify("Message")
-      end
-    end
-
-    context "when icon_url is set" do
-      let(:client) { described_class.new("foo", "bar", icon_url: "foobar") }
-
-      before do
-        stub_request(:post, "https://foo.slack.com/services/hooks/incoming-webhook?token=bar").
+        stub_request(:post, "https://hooks.slack.com/services/foo/bar").
           with(:body => {"{\"text\":\"Message\",\"username\":\"webhookbot\",\"channel\":\"#general\",\"icon_url\":\"foobar\",\"unfurl_links\":\"1\"}"=>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.9.0'}).
           to_return(:status => 200, :body => "", :headers => {})
@@ -95,10 +61,15 @@ describe SlackNotify::Client do
     end
 
     context "when icon_emoji is set" do
-      let(:client) { described_class.new("foo", "bar", icon_emoji: "foobar") }
+      let(:client) do
+        described_class.new(
+          webhook_url: "https://hooks.slack.com/services/foo/bar",
+          icon_emoji: "foobar"
+        )
+      end
 
       before do
-        stub_request(:post, "https://foo.slack.com/services/hooks/incoming-webhook?token=bar").
+        stub_request(:post, "https://hooks.slack.com/services/foo/bar").
           with(:body => {"{\"text\":\"Message\",\"username\":\"webhookbot\",\"channel\":\"#general\",\"icon_emoji\":\"foobar\",\"unfurl_links\":\"1\"}"=>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.9.0'}).
           to_return(:status => 200, :body => "", :headers => {})
@@ -110,10 +81,15 @@ describe SlackNotify::Client do
     end
 
     context "when link_names is set" do
-      let(:client) { described_class.new("foo", "bar", link_names: 1) }
+      let(:client) do
+        described_class.new(
+          webhook_url: "https://hooks.slack.com/services/foo/bar",
+          link_names: 1
+        )
+      end
 
       before do
-        stub_request(:post, "https://foo.slack.com/services/hooks/incoming-webhook?token=bar").
+        stub_request(:post, "https://hooks.slack.com/services/foo/bar").
           with(:body => {"{\"text\":\"Message\",\"username\":\"webhookbot\",\"channel\":\"#general\",\"link_names\":1,\"unfurl_links\":\"1\"}"=>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.9.0'}).
           to_return(:status => 200, :body => "", :headers => {})
@@ -137,7 +113,7 @@ describe SlackNotify::Client do
 
     context "when team name is invalid" do
       before do
-        stub_request(:post, "https://foo.slack.com/services/hooks/incoming-webhook?token=token").
+        stub_request(:post, "https://hooks.slack.com/services/foo/bar").
          with(:body => {"{\"text\":\"Message\",\"username\":\"webhookbot\",\"channel\":\"#general\",\"unfurl_links\":\"1\"}"=>true},
               :headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/x-www-form-urlencoded'}).
          to_return(:status => 404, :body => "Line 1\nLine 2\nLine 3", :headers => {})
@@ -150,7 +126,7 @@ describe SlackNotify::Client do
 
     context "when token is invalid" do
       before do
-        stub_request(:post, "https://foo.slack.com/services/hooks/incoming-webhook?token=token").
+        stub_request(:post, "https://hooks.slack.com/services/foo/bar").
          with(:body => {"{\"text\":\"Message\",\"username\":\"webhookbot\",\"channel\":\"#general\",\"unfurl_links\":\"1\"}"=>true},
               :headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/x-www-form-urlencoded'}).
          to_return(:status => 500, :body => "No hooks", :headers => {})
@@ -164,7 +140,7 @@ describe SlackNotify::Client do
 
     context "when channel is invalid" do
       before do
-        stub_request(:post, "https://foo.slack.com/services/hooks/incoming-webhook?token=token").
+        stub_request(:post, "https://hooks.slack.com/services/foo/bar").
          with(:body => {"{\"text\":\"message\",\"username\":\"webhookbot\",\"channel\":\"#foobar\",\"unfurl_links\":\"1\"}"=>true},
               :headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/x-www-form-urlencoded'}).
          to_return(:status => 500, :body => "Invalid channel specified", :headers => {})

data/spec/slack_notify_spec.rb

@@ -0,0 +1,9 @@
+require "spec_helper"
+
+describe SlackNotify do
+  describe ".new" do
+    it "returns a client instance" do
+      expect(SlackNotify.new(webhook_url: "foobar")).to be_a SlackNotify::Client
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack-notify
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Dan Sosedoff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-08 00:00:00.000000000 Z
+date: 2014-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -131,6 +131,7 @@ files:
 - slack-notify.gemspec
 - spec/slack-notify/client_spec.rb
 - spec/slack-notify/payload_spec.rb
+- spec/slack_notify_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/sosedoff/slack-notify
 licenses:
@@ -159,4 +160,5 @@ summary: Send notifications to a Slack channel
 test_files:
 - spec/slack-notify/client_spec.rb
 - spec/slack-notify/payload_spec.rb
+- spec/slack_notify_spec.rb
 - spec/spec_helper.rb