slackhook 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 67c80a31d87839cfc10443f08d3134e9e66f22f3
+  data.tar.gz: 4e37f2613048675d2909af139393883bb2a05bb9
+SHA512:
+  metadata.gz: f4b6665206f40023aa234ca4ed96067ce4e09086b5ecd373ee28f7c2cb9cba75d8c76d30b3cfb194f238926197788e164e240614964b59b31054d36137559116
+  data.tar.gz: 33f69d72a8a052e9a1acbae72fe0dc9107ebce3ec4b9abed4014ef67a99df97135299af53b1bcd7fa91485601c4561ddda94be6ab31c035008555fe840d7112a

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Urielable
+
+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,62 @@
+# Slackhook
+
+Easily add Slack WebHooks integration and send messages from your Ruby application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'slackhook'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install slackhook
+```
+
+## Usage
+
+
+
+To use this gem you only need to configure the Incoming WebHook integration in Slack.
+
+You can find this using your slack account and going to [Incoming WebHooks](https://api.slack.com/) and select your default channel.
+
+Well, now you are ready to send messages to Slack channels \0/!
+
+
+## Quick start
+
+```ruby
+# This is how you send messages to your default channel.
+Slackhook.send_hook({webhook_url: "your_webhook_url", text: "test message"})
+```
+
+There are also ```username```  and ```icon_type``` (**slackbot** is the default) options to be more specific about the nickname and avatar which would appear on the chat.
+
+You can use the ```channel``` option if the message is goint to be sent to a non default channel.
+
+```ruby
+> require "slackhook"
+> Slackhook.send_hook({ webhook_url: "your_webhook_url",
+                        text: "test message",
+                        channel: "@your-channel",
+                        username: "testbot",
+                        icon_type: ":trollface:"})
+```
+
+## Contributing
+
+1. [Fork it](https://github.com/Urielable/slackhook/fork)
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/lib/slackhook.rb

@@ -0,0 +1,21 @@
+#encoding: UTF-8
+require "slackhook/version"
+require "slackhook/webhook_service"
+
+module Slackhook
+  def self.send_hook options
+      # Send message to Slack
+      #
+      # Example:
+      #   >> Slackhook.send_hook({webhook_url: "your_webhook_url", text: "message", channel: "@urielable", username: "testbot"})
+      #   => "200"
+      #
+      # Arguments:
+      #   webhook_url: (String)
+      #   text: (String)
+      #   channel: (String)
+      #   username: (String)
+
+    WebhookService::Webhook.new(options).send
+  end
+end

data/lib/slackhook/version.rb

@@ -0,0 +1,3 @@
+module Slackhook
+  VERSION = "1.0"
+end

data/lib/slackhook/webhook_service.rb

@@ -0,0 +1,28 @@
+#encoding: UTF-8
+require 'net/http'
+require "uri"
+require "json"
+
+module WebhookService
+  class Webhook
+    def initialize options = {}
+      @text        = options.fetch(:text, nil)
+      @icon_type   = options.fetch(:icon_type, nil)
+      @channel     = options.fetch(:channel, nil)
+      @username    = options.fetch(:username, nil)
+      @webhook_url = options.fetch(:webhook_url, nil)
+    end
+
+    def send
+      uri           = URI::encode(@webhook_url)
+      @toSend       = { channel: @channel, text: @text, username: @username, icon_emoji: @icon_type}
+      uri           = URI.parse(uri)
+      https         = Net::HTTP.new(uri.host,uri.port)
+      https.use_ssl = true
+      req           = Net::HTTP::Post.new(uri.path, initheader = {'Content-Type' =>'application/json'})
+      req.body      = JSON.dump @toSend
+      res           = https.request(req)
+      res.code
+    end
+  end
+end

data/slackhook.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'slackhook/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "slackhook"
+  spec.version       = Slackhook::VERSION
+  spec.authors       = ["Urielable"]
+  spec.email         = ["uriel85@gmail.com"]
+  spec.summary       = %q{Easily add Slack Webhook integration to your Ruby application.}
+  spec.description   = %q{Easily add Slack Webhook integration to your Ruby application.}
+  spec.homepage      = "https://github.com/Urielable/slackhook"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.5.0"
+end

data/test/test_slackhook.rb

@@ -0,0 +1,14 @@
+require "minitest/autorun"
+require "slackhook"
+
+class SlackhookTest < Minitest::Test
+  def test_params_for_all_options_present 
+    assert_equal "200",
+      Slackhook.send_hook({webhook_url: webhook_url, text: "Unit test message", icon_type: ":trollface:", channel: "channel", username: "testbot"})
+  end
+
+  def test_params_for_missing_values
+    assert_equal "200",
+      Slackhook.send_hook({webhook_url: webhook_url, text: "Unit test missing", channel: "channel", username: "testbot"})
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: slackhook
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Urielable
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-01-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rake
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: minitest
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.5.0
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.5.0
+  prerelease: false
+  type: :development
+description: Easily add Slack Webhook integration to your Ruby application.
+email:
+- uriel85@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/slackhook.rb
+- lib/slackhook/version.rb
+- lib/slackhook/webhook_service.rb
+- slackhook.gemspec
+- test/test_slackhook.rb
+homepage: https://github.com/Urielable/slackhook
+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.1.9
+signing_key:
+specification_version: 4
+summary: Easily add Slack Webhook integration to your Ruby application.
+test_files:
+- test/test_slackhook.rb