rocket-chat-notifier 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ddf5914ca33f6d13f39a46dcfee73ec6abc3bd63
+  data.tar.gz: 6923aec7d0d30e56861ff493227b43da98c71cf5
+SHA512:
+  metadata.gz: e973cd17d57fccb103a39ae552b9c6d50615a368069a7ff0ea13b2f231d67b9acde5d1f2656084c3463cd37bdaf9da572e4e630d5d610f7d49219eae39514247
+  data.tar.gz: 213602b05e9da9829cc2ce06874c9ada81ace4b48b5e282ec2a5ed8a2f2d9cfb68c91eba1e2a2ade571364215c66627a9d27f31904296857fd886610b8926257

data/lib/rocket-chat-notifier.rb

@@ -0,0 +1,74 @@
+require 'net/http'
+require 'uri'
+require 'json'
+
+require_relative 'rocket-chat-notifier/default_http_client'
+require_relative 'rocket-chat-notifier/message_formatter'
+
+module RocketChat
+  class Notifier
+    attr_reader :endpoint, :default_payload
+
+    def initialize webhook_url, options={}
+      @endpoint        = URI.parse webhook_url
+      @default_payload = options
+    end
+
+    def ping message, options={}
+      if message.is_a?(Hash)
+        message, options = nil, message
+      end
+
+      if attachments = options[:attachments] || options["attachments"]
+        wrap_array(attachments).each do |attachment|
+          ["text", :text].each do |key|
+            attachment[key] = MessageFormatter.format(attachment[key]) if attachment.has_key?(key)
+          end
+        end
+      end
+
+      payload      = default_payload.merge(options)
+      client       = payload.delete(:http_client) || http_client
+      http_options = payload.delete(:http_options)
+
+      unless message.nil?
+        payload.merge!(text: MessageFormatter.format(message))
+      end
+
+      params = { payload: payload.to_json }
+      params[:http_options] = http_options if http_options
+
+      client.post endpoint, params
+    end
+
+    def http_client
+      default_payload.fetch :http_client, DefaultHTTPClient
+    end
+
+    def channel
+      default_payload[:channel]
+    end
+
+    def channel= channel
+      default_payload[:channel] = channel
+    end
+
+    def username
+      default_payload[:username]
+    end
+
+    def username= username
+      default_payload[:username] = username
+    end
+
+    def wrap_array(object)
+      if object.nil?
+        []
+      elsif object.respond_to?(:to_ary)
+        object.to_ary || [object]
+      else
+        [object]
+      end
+    end
+  end
+end

data/lib/rocket-chat-notifier/default_http_client.rb

@@ -0,0 +1,51 @@
+module RocketChat
+  class Notifier
+
+    class DefaultHTTPClient
+
+      class << self
+        def post uri, params
+          DefaultHTTPClient.new( uri, params ).call
+        end
+      end
+
+      attr_reader :uri, :params, :http_options
+
+      def initialize uri, params
+        @uri          = uri
+        @http_options = params.delete(:http_options) || {}
+        @params       = params
+      end
+
+      def call
+        http_obj.request request_obj
+      end
+
+      private
+
+        def request_obj
+          req = Net::HTTP::Post.new uri.request_uri
+          req.set_form_data params
+
+          return req
+        end
+
+        def http_obj
+          http = Net::HTTP.new uri.host, uri.port
+          http.use_ssl = (uri.scheme == "https")
+
+          http_options.each do |opt, val|
+            if http.respond_to? "#{opt}="
+              http.send "#{opt}=", val
+            else
+              warn "Net::HTTP doesn't respond to `#{opt}=`, ignoring that option"
+            end
+          end
+
+          return http
+        end
+
+    end
+
+  end
+end

data/lib/rocket-chat-notifier/message_formatter.rb

@@ -0,0 +1,54 @@
+module RocketChat
+  class Notifier
+    class MessageFormatter
+
+      class << self
+
+        def format string
+          MessageFormatter.new(string).formatted
+        end
+
+      end
+
+      def initialize string
+        @orig = if string.respond_to? :scrub
+          string.scrub
+        else
+          string
+        end
+      end
+
+      def formatted
+        @orig
+
+      rescue => e
+        if RUBY_VERSION < '2.1' && e.message.include?('invalid byte sequence')
+          raise e, "#{e.message}. Consider including the 'string-scrub' gem to strip invalid characters"
+        else
+          raise e
+        end
+      end
+
+      private
+
+        def slack_link link, text=nil
+          out = "<#{link}"
+          out << "|#{text}" if text && !text.empty?
+          out << ">"
+
+          return out
+        end
+
+        # http://rubular.com/r/19cNXW5qbH
+        def html_pattern
+          / <a (?:.*?) href=['"](.+?)['"] (?:.*?)> (.+?) <\/a> /x
+        end
+
+        # http://rubular.com/r/guJbTK6x1f
+        def markdown_pattern
+          /\[ ([^\[\]]*?) \] \( ((https?:\/\/.*?) | (mailto:.*?)) \) /x
+        end
+
+    end
+  end
+end

data/lib/rocket-chat-notifier/version.rb

@@ -0,0 +1,5 @@
+module RocketChat
+  class Notifier
+    VERSION = "0.1.0"
+  end
+end

data/spec/end_to_end_spec.rb

@@ -0,0 +1,71 @@
+# encoding: utf-8
+require 'spec_helper'
+
+RSpec.describe RocketChat::Notifier do
+
+  before :each do
+    @http_client = double("RocketChat::Notifier::DefaultHTTPClient")
+  end
+
+  {
+    ['hello', {}] =>
+      { payload: { text:"hello" }.to_json },
+
+    ['[hello](http://example.com/world)', {}] =>
+      { payload: { text: '[hello](http://example.com/world)' }.to_json },
+
+    ['hello/こんにちは from notifier test', {}] =>
+      { payload: { text: 'hello/こんにちは from notifier test' }.to_json },
+
+    ['Hello World, enjoy [this](http://example.com)[this2](http://example2.com)', {}] =>
+      { payload: { text: 'Hello World, enjoy [this](http://example.com)[this2](http://example2.com)'}.to_json },
+
+    ['[John](mailto:john@example.com)', {}] =>
+      { payload: { text: "[John](mailto:john@example.com)"}.to_json },
+
+    ['hello', { channel: 'hodor' }] =>
+      { payload: { channel: 'hodor', text: 'hello' }.to_json },
+
+    ['the message', { channel: 'foo',
+                      attachments: [{ color: '#000',
+                                      text: 'attachment message',
+                                      fallback: 'fallback message' }] }] =>
+      { payload: { channel: 'foo',
+                   attachments: [ { color: '#000',
+                                    text: 'attachment message',
+                                    fallback: 'fallback message' } ],
+                   text: 'the message' }.to_json },
+
+   [{ attachments: [{ color: '#000',
+                      text: 'attachment message',
+                      fallback: 'fallback message' }] }] =>
+    { payload: { attachments: [{ color: '#000',
+                                 text: 'attachment message',
+                                 fallback: 'fallback message' }] }.to_json },
+
+   [{ attachments: { color: '#000',
+                     text: 'attachment message [hodor](http://winterfell.com)',
+                     fallback: 'fallback message' } }] =>
+    { payload: { attachments: { color: '#000',
+                                text: 'attachment message [hodor](http://winterfell.com)',
+                                fallback: 'fallback message' } }.to_json },
+
+   ['hello', { http_options: { timeout: 5 } }] =>
+    { http_options: { timeout: 5 }, payload: { text: 'hello' }.to_json }
+
+
+  }.each do |args, payload|
+
+    it "sends correct payload for #{args}" do
+      notifier = RocketChat::Notifier.new 'http://example.com', http_client: @http_client
+
+      expect( @http_client ).to receive(:post)
+                            .with( URI.parse('http://example.com'),
+                                    payload )
+
+      notifier.ping *args
+    end
+  end
+
+
+end

data/spec/integration/ping_integration_test.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+require_relative '../../lib/rocket-chat-notifier'
+
+notifier = RocketChat::Notifier.new ENV['ROCKET_CHAT_WEBHOOK_URL'], username: 'notifier'
+puts "testing with ruby #{RUBY_VERSION}"
+notifier.ping "hello/こんにちは from notifier test script on ruby: #{RUBY_VERSION}\225"
+notifier.ping attachments: [{color:"#1BF5AF",fallback:"fallback",text:"attachment"}]

data/spec/lib/rocket-chat-notifier/default_http_client_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe RocketChat::Notifier::DefaultHTTPClient do
+
+  describe "::post" do
+    it "initializes DefaultHTTPClient with the given uri and params then calls" do
+      http_post_double = instance_double("RocketChat::Notifier::DefaultHTTPClient")
+
+      expect( described_class ).to receive(:new)
+                               .with( 'uri', 'params' )
+                               .and_return( http_post_double )
+      expect( http_post_double ).to receive(:call)
+
+      described_class.post 'uri', 'params'
+    end
+  end
+
+  describe "#initialize" do
+    it "allows setting of options for Net::HTTP" do
+      net_http_double = instance_double("Net::HTTP")
+      http_client     = described_class.new( URI.parse('http://example.com'), http_options: { open_timeout: 5 })
+
+      allow( Net::HTTP ).to receive(:new)
+                        .and_return(net_http_double)
+      allow( net_http_double ).to receive(:use_ssl=)
+      allow( net_http_double ).to receive(:request)
+
+      expect( net_http_double ).to receive(:open_timeout=).with(5)
+
+      http_client.call
+    end
+  end
+
+end

data/spec/lib/rocket-chat-notifier/message_formatter_spec.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe RocketChat::Notifier::MessageFormatter do
+
+  describe "::format" do
+
+    if "".respond_to? :scrub
+      context "when on ruby 2.1+ or have string-scrub installed" do
+        it "handles invalid unicode sequences" do
+          expect {
+            described_class.format("This sequence is invalid: \255")
+          }.not_to raise_error
+        end
+
+        it "replaces invalid unicode sequences with the unicode replacement character" do
+          formatted = described_class.format("\255")
+          expect(formatted).to eq "\uFFFD"
+        end
+      end
+    end
+
+    it "doesn't replace valid Japanese" do
+      formatted = described_class.format("こんにちは")
+      expect(formatted).to eq "こんにちは"
+    end
+
+  end
+
+end

data/spec/lib/rocket-chat-notifier_spec.rb

@@ -0,0 +1,156 @@
+require 'spec_helper'
+
+describe RocketChat::Notifier do
+  subject { described_class.new 'http://example.com' }
+
+  describe "#initialize" do
+    it "sets the given hook_url to the endpoint URI" do
+      expect( subject.endpoint ).to eq URI.parse 'http://example.com'
+    end
+
+    it "sets the default_payload options" do
+      subject = described_class.new 'http://example.com', channel: 'foo'
+      expect( subject.channel ).to eq 'foo'
+    end
+
+    it "sets a custom http client" do
+      client  = double("CustomClient")
+      subject = described_class.new 'http://example.com', http_client: client
+      expect( subject.http_client ).to eq client
+    end
+  end
+
+  describe "#ping" do
+    before :each do
+      allow( RocketChat::Notifier::DefaultHTTPClient ).to receive(:post)
+    end
+
+    it "passes the message through MessageFormatter" do
+      expect( RocketChat::Notifier::MessageFormatter ).to receive(:format)
+                                                   .with("the message")
+
+      described_class.new('http://example.com').ping "the message", channel: 'foo'
+    end
+
+    it "passes attachment messages through MessageFormatter" do
+      expect( RocketChat::Notifier::MessageFormatter ).to receive(:format)
+                                                   .with("the message")
+      expect( RocketChat::Notifier::MessageFormatter ).to receive(:format)
+                                                   .with("attachment message")
+
+      described_class.new('http://example.com').ping "the message", channel: 'foo',
+                                                                    attachments: [{
+                                                                      color: "#000",
+                                                                      text: "attachment message",
+                                                                      fallback: "fallback message"
+                                                                    }]
+    end
+
+    it "allows sending only an attachment" do
+      expect( RocketChat::Notifier::DefaultHTTPClient ).to receive(:post).with(
+        URI.parse('http://example.com'),
+        payload: '{"channel":"foo","attachments":[{"text":"attachment","fallback":"fallback"}]}'
+      )
+
+      expect{
+        described_class.new('http://example.com')
+                       .ping channel: 'foo',
+                             attachments: [{
+                              text: 'attachment',
+                              fallback: 'fallback'
+                             }]
+      }.not_to raise_error
+    end
+
+    it "passes attachment messages through MessageFormatter, even if a single value is passed" do
+      expect( RocketChat::Notifier::MessageFormatter ).to receive(:format)
+                                                   .with("a random message")
+      expect( RocketChat::Notifier::MessageFormatter ).to receive(:format)
+                                                   .with("attachment message")
+      attachment = {
+        color: "#000",
+        text: "attachment message",
+        fallback: "fallback message"
+      }
+      subject.ping "a random message", attachments: attachment
+    end
+
+    context "with a default channel set" do
+
+      before :each do
+        @endpoint_double = instance_double "URI::HTTP"
+        allow( URI ).to receive(:parse)
+                    .and_return(@endpoint_double)
+        subject.channel = '#default'
+      end
+
+      it "does not require a channel to ping" do
+        expect{
+          subject.ping "the message"
+        }.not_to raise_error
+      end
+
+      it "uses default channel" do
+        expect( RocketChat::Notifier::DefaultHTTPClient ).to receive(:post)
+                          .with @endpoint_double,
+                                payload: '{"channel":"#default","text":"the message"}'
+
+        subject.ping "the message"
+      end
+
+      it "allows override channel to be set" do
+        expect( RocketChat::Notifier::DefaultHTTPClient ).to receive(:post)
+                          .with @endpoint_double,
+                                payload: '{"channel":"new","text":"the message"}'
+
+        subject.ping "the message", channel: "new"
+      end
+
+    end
+
+    context "with default webhook" do
+      it "posts with the correct endpoint & data" do
+          @endpoint_double = instance_double "URI::HTTP"
+          allow( URI ).to receive(:parse)
+                      .with("http://example.com")
+                      .and_return(@endpoint_double)
+
+          expect( RocketChat::Notifier::DefaultHTTPClient ).to receive(:post)
+                            .with @endpoint_double,
+                                  payload: '{"channel":"channel","text":"the message"}'
+
+          described_class.new("http://example.com").ping "the message", channel: "channel"
+      end
+    end
+
+    context "with a custom http_client set" do
+      it "uses it" do
+        endpoint_double = instance_double "URI::HTTP"
+        allow( URI ).to receive(:parse)
+                    .with("http://example.com")
+                    .and_return(endpoint_double)
+        client = double("CustomClient")
+        expect( client ).to receive(:post)
+                        .with endpoint_double,
+                        payload: '{"text":"the message"}'
+
+        described_class.new('http://example.com',http_client: client).ping "the message"
+      end
+    end
+  end
+
+  describe "#channel=" do
+    it "sets the given channel" do
+      subject.channel = "#foo"
+      expect( subject.channel ).to eq "#foo"
+    end
+  end
+
+  describe "#username=" do
+    it "sets the given username" do
+      subject.username = "foo"
+      expect( subject.username ).to eq "foo"
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'rspec'
+require 'rocket-chat-notifier'
+
+if ENV['DEBUG']
+  require 'pry'
+end
+
+RSpec.configure do |config|
+  config.mock_with :rspec do |mocks|
+    mocks.verify_doubled_constant_names = true
+    mocks.verify_partial_doubles        = true
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: rocket-chat-notifier
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Thiago Felix
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-13 00:00:00.000000000 Z
+dependencies: []
+description: " A slim ruby wrapper for posting to Rocket.Chat webhooks "
+email:
+- thiago@thiagofelix.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rocket-chat-notifier.rb
+- lib/rocket-chat-notifier/default_http_client.rb
+- lib/rocket-chat-notifier/message_formatter.rb
+- lib/rocket-chat-notifier/version.rb
+- spec/end_to_end_spec.rb
+- spec/integration/ping_integration_test.rb
+- spec/lib/rocket-chat-notifier/default_http_client_spec.rb
+- spec/lib/rocket-chat-notifier/message_formatter_spec.rb
+- spec/lib/rocket-chat-notifier_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/thiagofelix/rocket-chat-notifier
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: A slim ruby wrapper for posting to Rocket.Chat webhooks
+test_files:
+- spec/end_to_end_spec.rb
+- spec/integration/ping_integration_test.rb
+- spec/lib/rocket-chat-notifier/default_http_client_spec.rb
+- spec/lib/rocket-chat-notifier/message_formatter_spec.rb
+- spec/lib/rocket-chat-notifier_spec.rb
+- spec/spec_helper.rb
+has_rdoc: