slackit 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: c089ed18ed1b058316bd9d8e175af9d506346c78e6fcc77acf76bd8d3fcc32ab
4
+ data.tar.gz: 233de7bbcc96e98ffea33cbb2645d2bb4571f94bec4cd0c77e18b98325ab17ce
5
+ SHA512:
6
+ metadata.gz: e6e17bc95581a210a10128c43c47619e7c17d8b1cd9f20f27d07d2ad1b62e0fe1f6cc61bfcf7e4de0c2141da22475d29f13fdef4256dce54755ee3a987fd06dd
7
+ data.tar.gz: 37f8cd77870067b4017fb7491e9975dd3a713639e859d6de173d870e336aba481cb944a19ed52543032f7c095bca5d2801e2db75cb83656af85b8ec0bc17accf
data/.gitignore ADDED
@@ -0,0 +1,14 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /coverage/
5
+ /doc/
6
+ /pkg/
7
+ /spec/reports/
8
+ /tmp/
9
+ /Gemfile.lock
10
+
11
+ *.gem
12
+
13
+ # rspec failure tracking
14
+ .rspec_status
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
data/.rubocop.yml ADDED
@@ -0,0 +1,30 @@
1
+ Layout/IndentationWidth:
2
+ Width: 4
3
+
4
+ Metrics/AbcSize:
5
+ Max: 50
6
+
7
+ Metrics/LineLength:
8
+ Max: 180
9
+
10
+ Metrics/BlockLength:
11
+ Max: 40
12
+
13
+ Metrics/CyclomaticComplexity:
14
+ Max: 20
15
+
16
+ Metrics/MethodLength:
17
+ Max: 60
18
+
19
+ Metrics/PerceivedComplexity:
20
+ Max: 20
21
+
22
+ Style/GlobalVars:
23
+ Enabled: false
24
+
25
+ Style/RaiseArgs:
26
+ EnforcedStyle: compact
27
+
28
+ Style/WordArray:
29
+ EnforcedStyle: brackets
30
+
data/.travis.yml ADDED
@@ -0,0 +1,33 @@
1
+ sudo: required
2
+ matrix:
3
+ include:
4
+ - language: ruby
5
+ rvm: 2.2
6
+ before_install:
7
+ - gem install bundler -v 1.16.1
8
+ - language: ruby
9
+ rvm: 2.4.4
10
+ before_install:
11
+ - gem install bundler -v 1.17.3
12
+ - language: ruby
13
+ env: SKIP_INTERPRETER=true
14
+ rvm: 2.4.4
15
+ before_install:
16
+ - git clone https://github.com/TravisToolbox/rubocop-travis.git
17
+ install:
18
+ - ./rubocop-travis/install.sh
19
+ script:
20
+ - ./rubocop-travis/scan.sh
21
+ - language: ruby
22
+ rvm: 2.2
23
+ before_install:
24
+ - mkdir travis
25
+ - git clone https://github.com/TravisToolbox/awesomebot-travis.git travis/awesomebot
26
+ install:
27
+ - ./travis/awesomebot/install.sh
28
+ script:
29
+ - ./travis/awesomebot/scan.sh
30
+ notifications:
31
+ email: false
32
+ slack:
33
+ secure: fteRmCizwdBUF2X57Kp5TOxWXx6iOM1eRNEuTNgJgOvT+YMc6QPE3XjppGtaS/OHG7q+UCYhZP6P3C7aJRJO+oxHZMw/725LKabhy6pCBwcAnkxMV/CAnhhhI1jHzR5Iqk5IvctM9VZSfHXmCnM5VrobICMt4y8/fYkY47e4PZpTzorVO2oLNkR0Da0KrrYqeL0prlu4e9UGC8nU0jy8Nwvaap6OZPJUsYninQzhOgg008mFGTKBK852GHTSW99PLeyJahM00T8xx3ENpK2UpNmynE/r6OffsAmT90TeTsINItVoWn/g6h9lUd5co0OAt5uQ2zYWSFJRsL0HlLlJTk4RwJZ2ESClPoXKwqhBqr+LtRfQCQOnMFJ+V9Nx8ojOaS84QZREPQUlDFvqdBeSomWpeIDmmNeT2+SkyCrrDz4NsIYHI/hwPujIHt0547tIYqNTrsdelkZuWPtjPN+ZPCa+UhKFtvTCyTdqh96VuAjwNj2oM0CjI1CT5G8AnmkyYoqoVB5AfZ+ttfLqOwxmb78skAFpyiQx6i/j1wta4P0H/I+Ycr5Kk1RFOR2KmU8AdzMBUKda2gSJFkU5XIdAyd52ZDCC46olEL9Nw8WnsArFQJIPqlX/aJiXJ/W+0RNmcXdKThIFo9GOnj9ewR15/CWWAI6ofqmWlEJ/9lfGnmg=
data/CHANGELOG.md ADDED
@@ -0,0 +1,5 @@
1
+ ## 1.0.0 (January 21, 2019)
2
+
3
+ * Initial Release ([@TGWolf][])
4
+
5
+ [@TGWolf]: https://github.com/TGWolf
data/CODEOWNERS ADDED
@@ -0,0 +1,7 @@
1
+ # The codeowners file:
2
+ #
3
+ # For more information please read: https://help.github.com/articles/about-codeowners/
4
+
5
+ # These owners will be the default owners for everything in
6
+ # the repo. Unless a later match takes precedence,
7
+ * @AntiPhotonltd/reviewers
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at wolf@tgwolf.com. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [http://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: http://contributor-covenant.org
74
+ [version]: http://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,6 @@
1
+ source "https://rubygems.org"
2
+
3
+ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
4
+
5
+ # Specify your gem's dependencies in slackit.gemspec
6
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2019 Tim Gurney aka Wolf
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,43 @@
1
+ # Slackit
2
+
3
+ Slackit is a very simply Ruby Gem for posting to a slack incoming webhook.
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ gem 'slackit'
11
+ ```
12
+
13
+ And then execute:
14
+
15
+ $ bundle
16
+
17
+ Or install it yourself as:
18
+
19
+ $ gem install slackit
20
+
21
+ ## Usage
22
+
23
+ To come
24
+
25
+ ## Development
26
+
27
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
28
+
29
+ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
30
+
31
+ ## Testing
32
+
33
+ ## Contributing
34
+
35
+ Bug reports and pull requests are welcome on GitHub at https://github.com/AntiPhotonltd/slackit. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
36
+
37
+ ## License
38
+
39
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
40
+
41
+ ## Code of Conduct
42
+
43
+ Everyone interacting in the Slackit project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/AntiPhotonltd/slackit/blob/master/CODE_OF_CONDUCT.md).
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "slackit"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start(__FILE__)
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
data/exe/slackit ADDED
@@ -0,0 +1,3 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require 'slackit'
@@ -0,0 +1,3 @@
1
+ class Slackit
2
+ VERSION = '0.1.0'.freeze
3
+ end
data/lib/slackit.rb ADDED
@@ -0,0 +1,36 @@
1
+ require 'slackit/version'
2
+
3
+ #
4
+ # To follow
5
+ #
6
+ class Slackit
7
+ def initialize(webhook_url, channel = false, username = 'SlackIT', icon_emoji = ':wolf:')
8
+ @webhook_url = webhook_url
9
+ @channel = channel
10
+ @username = username
11
+ @icon_emoji = icon_emoji
12
+ end
13
+
14
+ # sends a notification
15
+ # returns true after a successfull pust
16
+ def send(text)
17
+ # send as json
18
+ headers = { 'Content-Type' => 'application/json' }
19
+
20
+ # payload
21
+ body = { 'text': text, 'icon_emoji': @icon_emoji, username: @username }
22
+
23
+ # add the channel if there is one otherwise the default channel
24
+ body['channel'] = @channel if @channel
25
+
26
+ begin
27
+ response = HTTParty.post(@webhook_url, body: body.to_json, headers: headers)
28
+
29
+ return true if response.code == 200
30
+
31
+ return false
32
+ rescue HTTParty::Error, SocketError => _e
33
+ return false
34
+ end
35
+ end
36
+ end
data/slackit.gemspec ADDED
@@ -0,0 +1,31 @@
1
+ lib = File.expand_path("../lib", __FILE__)
2
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
3
+ require "slackit/version"
4
+
5
+ Gem::Specification.new do |spec|
6
+ spec.name = "slackit"
7
+ spec.version = Slackit::VERSION
8
+ spec.authors = ["Tim Gurney aka Wolf"]
9
+ spec.email = ["wolf@tgwolf.com"]
10
+
11
+ spec.summary = %q{A simple gem for posting to a slack incoming webhook.}
12
+ spec.description = %q{A simple gem for posting to a slack incoming webhook.}
13
+ spec.homepage = "https://github.com/AntiPhotonltd/slackit"
14
+ spec.license = "MIT"
15
+
16
+ spec.files = `git ls-files`.split($/)
17
+
18
+ # Specify which files should be added to the gem when it is released.
19
+ # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
20
+ #spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
21
+ # `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
22
+ #end
23
+ spec.bindir = "exe"
24
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
25
+ spec.require_paths = ["lib"]
26
+
27
+ spec.add_development_dependency "bundler", "~> 1.16"
28
+ spec.add_development_dependency "rake", "~> 10.0"
29
+ spec.add_development_dependency "rspec", "~> 3.0"
30
+ spec.add_development_dependency "httparty", "~> 0.16.2"
31
+ end
@@ -0,0 +1,7 @@
1
+ require 'slackit'
2
+
3
+ RSpec.describe Slackit do
4
+ it 'has a version number' do
5
+ expect(Slackit::VERSION).not_to be nil
6
+ end
7
+ end
@@ -0,0 +1,14 @@
1
+ require 'bundler/setup'
2
+ require 'slackit'
3
+
4
+ RSpec.configure do |config|
5
+ # Enable flags like --only-failures and --next-failure
6
+ config.example_status_persistence_file_path = '.rspec_status'
7
+
8
+ # Disable RSpec exposing methods globally on `Module` and `main`
9
+ config.disable_monkey_patching!
10
+
11
+ config.expect_with :rspec do |c|
12
+ c.syntax = :expect
13
+ end
14
+ end
metadata ADDED
@@ -0,0 +1,119 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: slackit
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Tim Gurney aka Wolf
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2019-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.16'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.16'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: httparty
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: 0.16.2
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: 0.16.2
69
+ description: A simple gem for posting to a slack incoming webhook.
70
+ email:
71
+ - wolf@tgwolf.com
72
+ executables:
73
+ - slackit
74
+ extensions: []
75
+ extra_rdoc_files: []
76
+ files:
77
+ - ".gitignore"
78
+ - ".rspec"
79
+ - ".rubocop.yml"
80
+ - ".travis.yml"
81
+ - CHANGELOG.md
82
+ - CODEOWNERS
83
+ - CODE_OF_CONDUCT.md
84
+ - Gemfile
85
+ - LICENSE.txt
86
+ - README.md
87
+ - Rakefile
88
+ - bin/console
89
+ - bin/setup
90
+ - exe/slackit
91
+ - lib/slackit.rb
92
+ - lib/slackit/version.rb
93
+ - slackit.gemspec
94
+ - spec/slackit_spec.rb
95
+ - spec/spec_helper.rb
96
+ homepage: https://github.com/AntiPhotonltd/slackit
97
+ licenses:
98
+ - MIT
99
+ metadata: {}
100
+ post_install_message:
101
+ rdoc_options: []
102
+ require_paths:
103
+ - lib
104
+ required_ruby_version: !ruby/object:Gem::Requirement
105
+ requirements:
106
+ - - ">="
107
+ - !ruby/object:Gem::Version
108
+ version: '0'
109
+ required_rubygems_version: !ruby/object:Gem::Requirement
110
+ requirements:
111
+ - - ">="
112
+ - !ruby/object:Gem::Version
113
+ version: '0'
114
+ requirements: []
115
+ rubygems_version: 3.0.2
116
+ signing_key:
117
+ specification_version: 4
118
+ summary: A simple gem for posting to a slack incoming webhook.
119
+ test_files: []