slack-poster 0.0.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +17 -0
- data/Gemfile +2 -0
- data/LICENSE.txt +22 -0
- data/README.md +31 -0
- data/Rakefile +1 -0
- data/lib/slack-poster/poster.rb +78 -0
- data/lib/slack-poster/version.rb +3 -0
- data/lib/slack-poster.rb +5 -0
- data/slack-poster.gemspec +25 -0
- metadata +95 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 2e14cf397de2bf4dc0af6ace274213e6271af5af
|
4
|
+
data.tar.gz: 82332c088dfa575457a00277aa1417e70f5b8ab6
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: a9e439e4fb0c094f531f1d78947608b9ea26e05fd70ada99e37006684a19f5216ee1970fd287e437de98eba5845bc50cf9e676e26cc84b71c47f731060ba9280
|
7
|
+
data.tar.gz: 17ae929ac17d9af14f877362ed95aafc07e4bd3f16547c90f115e609f7605a8393824e615d74c9131a3d2b852d14e165436e7ea3e14efa03e9424c7a8b079c66
|
data/.gitignore
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
Copyright (c) 2014 Ricardo Otero
|
2
|
+
|
3
|
+
MIT License
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
6
|
+
a copy of this software and associated documentation files (the
|
7
|
+
"Software"), to deal in the Software without restriction, including
|
8
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
9
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
10
|
+
permit persons to whom the Software is furnished to do so, subject to
|
11
|
+
the following conditions:
|
12
|
+
|
13
|
+
The above copyright notice and this permission notice shall be
|
14
|
+
included in all copies or substantial portions of the Software.
|
15
|
+
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
18
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
20
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
21
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
22
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,31 @@
|
|
1
|
+
# Slack Poster
|
2
|
+
|
3
|
+
[Slack](https://slack.com/) is a mashup of chatrooms and collaborative sharing tools that are meant to do away with redundant conversations in multiple places.
|
4
|
+
|
5
|
+
slack-poster is a simple gem to make your integration with Slack easier. It supports only incoming communications (from you to Slack).
|
6
|
+
|
7
|
+
## Installation
|
8
|
+
|
9
|
+
Add this line to your application's Gemfile:
|
10
|
+
|
11
|
+
gem 'slack-poster'
|
12
|
+
|
13
|
+
And then execute:
|
14
|
+
|
15
|
+
$ bundle
|
16
|
+
|
17
|
+
Or install it yourself as:
|
18
|
+
|
19
|
+
$ gem install slack-poster
|
20
|
+
|
21
|
+
## Usage
|
22
|
+
|
23
|
+
TODO: Write usage instructions here
|
24
|
+
|
25
|
+
## Contributing
|
26
|
+
|
27
|
+
1. Fork it ( http://github.com/rikas/slack-poster/fork )
|
28
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
29
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
30
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
31
|
+
5. Create new Pull Request
|
data/Rakefile
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
require 'bundler/gem_tasks'
|
@@ -0,0 +1,78 @@
|
|
1
|
+
require 'httparty'
|
2
|
+
|
3
|
+
module Slack
|
4
|
+
class Poster
|
5
|
+
include HTTParty
|
6
|
+
|
7
|
+
attr_accessor :username, :channel
|
8
|
+
|
9
|
+
# The default format of the requests. Used on HTTP header 'Content-Type'.
|
10
|
+
format :json
|
11
|
+
|
12
|
+
# Disable the use of rails query string format.
|
13
|
+
#
|
14
|
+
# With rails query string format enabled:
|
15
|
+
# => get '/', :query => {:selected_ids => [1,2,3]}
|
16
|
+
#
|
17
|
+
# Would translate to this:
|
18
|
+
# => /?selected_ids[]=1&selected_ids[]=2&selected_ids[]=3
|
19
|
+
#
|
20
|
+
disable_rails_query_string_format
|
21
|
+
|
22
|
+
# Initializes a Poster instance to post messages. It uses the HTTParty.base_uri and
|
23
|
+
# HTTParty.default_params to set parameters of POST request.
|
24
|
+
# It also accepts a configuration hash.
|
25
|
+
#
|
26
|
+
# ==== Examples
|
27
|
+
#
|
28
|
+
# Without configuration hash
|
29
|
+
# => Slack::Poster.new('myteam', 'eNmZHQY6f591ziHyZdzePFz8')
|
30
|
+
#
|
31
|
+
# With configuration using username and icon avatar:
|
32
|
+
# => Slack::Poster.new('myteam', 'eNmZHQY6f591ziHyZdzePFz8', username: 'Ricardo',
|
33
|
+
# icon_url: 'http://www.gravatar.com/avatar/92e00fd27c64c94d04140cef88039468.png')
|
34
|
+
#
|
35
|
+
# You can also use an emoji as avatar:
|
36
|
+
# => Slack::Poster.new('myteam', 'eNmZHQY6f591ziHyZdzePFz8', username: 'Ricardo',
|
37
|
+
# icon_emoji: 'ghost')
|
38
|
+
#
|
39
|
+
def initialize(team, token, options = {})
|
40
|
+
self.class.base_uri("https://#{team}.slack.com")
|
41
|
+
self.class.default_params(token: token)
|
42
|
+
|
43
|
+
@username = options[:username] || 'webhookbot'
|
44
|
+
@channel = options[:channel] || '#general'
|
45
|
+
|
46
|
+
@icon_emoji = format_emoji(options[:icon_emoji])
|
47
|
+
@icon_url = options[:icon_url]
|
48
|
+
|
49
|
+
raise ArgumentError, 'Team name is required' if team.blank?
|
50
|
+
raise ArgumentError, 'Token is' if token.blank?
|
51
|
+
end
|
52
|
+
|
53
|
+
# This method will post to the configured team Slack.
|
54
|
+
def send_message(text)
|
55
|
+
body = { text: text, channel: @channel, username: @username }.merge(avatar_hash)
|
56
|
+
body = { body: "payload=#{body.to_json}" }
|
57
|
+
|
58
|
+
response = self.class.post('/services/hooks/incoming-webhook', body)
|
59
|
+
|
60
|
+
"#{response.body} (#{response.code})"
|
61
|
+
end
|
62
|
+
|
63
|
+
private
|
64
|
+
|
65
|
+
def avatar_hash
|
66
|
+
@icon_emoji ? { icon_emoji: @icon_emoji } : { icon_url: @icon_url }
|
67
|
+
end
|
68
|
+
|
69
|
+
def format_channel(channel)
|
70
|
+
"##{channel.split('#').last}"
|
71
|
+
end
|
72
|
+
|
73
|
+
def format_emoji(emoji)
|
74
|
+
emoji = emoji.to_s.gsub(':', '')
|
75
|
+
emoji.empty? ? nil : ":#{emoji}:"
|
76
|
+
end
|
77
|
+
end
|
78
|
+
end
|
data/lib/slack-poster.rb
ADDED
@@ -0,0 +1,25 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'slack-poster/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = 'slack-poster'
|
8
|
+
spec.version = Slack::VERSION
|
9
|
+
spec.authors = ['Ricardo Otero']
|
10
|
+
spec.email = ['oterosantos@gmail.com']
|
11
|
+
spec.summary = %q{Slack wrapper for Incoming WebHooks integrations.}
|
12
|
+
spec.description = %q{slack-poster is a gem to make your integration with Slack WebHooks easier.}
|
13
|
+
spec.homepage = ''
|
14
|
+
spec.license = 'MIT'
|
15
|
+
|
16
|
+
spec.files = `git ls-files -z`.split("\x0")
|
17
|
+
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
18
|
+
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
19
|
+
spec.require_paths = ['lib']
|
20
|
+
|
21
|
+
spec.add_development_dependency 'bundler', '~> 1.5'
|
22
|
+
spec.add_development_dependency 'rake'
|
23
|
+
|
24
|
+
spec.add_dependency 'httparty', '~> 0.12'
|
25
|
+
end
|
metadata
ADDED
@@ -0,0 +1,95 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: slack-poster
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.3
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Ricardo Otero
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2014-01-21 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: bundler
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '1.5'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.5'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rake
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - ">="
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - ">="
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: httparty
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '0.12'
|
48
|
+
type: :runtime
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '0.12'
|
55
|
+
description: slack-poster is a gem to make your integration with Slack WebHooks easier.
|
56
|
+
email:
|
57
|
+
- oterosantos@gmail.com
|
58
|
+
executables: []
|
59
|
+
extensions: []
|
60
|
+
extra_rdoc_files: []
|
61
|
+
files:
|
62
|
+
- ".gitignore"
|
63
|
+
- Gemfile
|
64
|
+
- LICENSE.txt
|
65
|
+
- README.md
|
66
|
+
- Rakefile
|
67
|
+
- lib/slack-poster.rb
|
68
|
+
- lib/slack-poster/poster.rb
|
69
|
+
- lib/slack-poster/version.rb
|
70
|
+
- slack-poster.gemspec
|
71
|
+
homepage: ''
|
72
|
+
licenses:
|
73
|
+
- MIT
|
74
|
+
metadata: {}
|
75
|
+
post_install_message:
|
76
|
+
rdoc_options: []
|
77
|
+
require_paths:
|
78
|
+
- lib
|
79
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
80
|
+
requirements:
|
81
|
+
- - ">="
|
82
|
+
- !ruby/object:Gem::Version
|
83
|
+
version: '0'
|
84
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
85
|
+
requirements:
|
86
|
+
- - ">="
|
87
|
+
- !ruby/object:Gem::Version
|
88
|
+
version: '0'
|
89
|
+
requirements: []
|
90
|
+
rubyforge_project:
|
91
|
+
rubygems_version: 2.2.1
|
92
|
+
signing_key:
|
93
|
+
specification_version: 4
|
94
|
+
summary: Slack wrapper for Incoming WebHooks integrations.
|
95
|
+
test_files: []
|