Skip to content

Commit 05bbec0

Browse files
committed
rename project to match sensu installer
1 parent 833db05 commit 05bbec0

7 files changed

Lines changed: 39 additions & 30 deletions

File tree

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,4 @@
77
/pkg/
88
/spec/reports/
99
/tmp/
10+
/vendor/

README.md

Lines changed: 28 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
11
# Sensu check for new incidents in Trello
22

3-
Checks for cards in a trello list. If cards are present, the check returns
4-
_CRITICAL_, containing name and date of last activity of card. When more
5-
than one card is present, all card names and dates are returned with *;*
6-
delimiter.
3+
Checks for cards in a trello list. If cards are present, the check returns
4+
_CRITICAL_, containing name and date of last activity of card. When more than
5+
one card is present, all card names and dates are returned with *;* delimiter.
76

87
## Installation
98

109
Add this line to your application's Gemfile:
1110

1211
```ruby
13-
gem 'sensu-plugin-trello'
12+
gem 'sensu-plugins-trello'
1413
```
1514

1615
And then execute:
@@ -19,17 +18,18 @@ And then execute:
1918

2019
Or install it yourself as:
2120

22-
$ gem install sensu-plugin-trello
21+
$ gem install sensu-plugins-trello
2322

2423
## CONFIGURATION
25-
Configuration of API key and API token should be done through the sensu
24+
Configuration of API key and API token should be done through the sensu
2625
settings file located in _/etc/sensu/conf.d/_.
2726

28-
_api_key_ and _api_token_ can be obtained from [Trello](https://trello.com/app-key).
29-
_list_ can be obtained by adding _.json_ to a card in the browser in the
30-
list that should be monitored and search for _idList_ in the JSON-output.
31-
Note that in a production environment, _api_key_ and _api_token_ should be
32-
specified in the Sensu settings rather than through CLI parameters.
27+
_api_key_ and _api_token_ can be obtained from
28+
[Trello](https://trello.com/app-key). _list_ can be obtained by adding _.json_
29+
to a card in the browser in the list that should be monitored and search for
30+
_idList_ in the JSON-output. Note that in a production environment, _api_key_
31+
and _api_token_ should be specified in the Sensu settings rather than through
32+
CLI parameters.
3333

3434
## USAGE
3535
Check if a specific trello list is empty or contains cards
@@ -44,23 +44,31 @@ Check if a specific trello list is empty or contains cards
4444

4545
### Optional parameters
4646

47-
| Parameter | Description |
48-
| --------- | --------------- |
49-
| -h HOST | Trello API host |
50-
| -p PORT | Trello API port |
47+
| Parameter | Description |
48+
| ------------------ | --------------------------------- |
49+
| -h HOST | Trello API host |
50+
| -p PORT | Trello API port |
51+
| --timeout TIMEOUT | Trello request timeout in seconds |
5152

5253
### Example:
5354
```
54-
./bin/check-trello-incidents.rb -k 123456789012 -t 1234567890121234567890 -l 1234567890
55+
./bin/check-trello-incidents.rb -k 123456789012 -t 1234567890121234567890 -l 1234567890
5556
```
5657

5758
## Development
5859

59-
After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
60+
After checking out the repo, run `bin/setup` to install dependencies. You can
61+
also run `bin/console` for an interactive prompt that will allow you to
62+
experiment.
6063

61-
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).
64+
To install this gem onto your local machine, run `bundle exec rake install`. To
65+
release a new version, update the version number in `version.rb`, and then run
66+
`bundle exec rake release`, which will create a git tag for the version, push
67+
git commits and tags, and push the `.gem` file to
68+
[rubygems.org](https://rubygems.org).
6269

6370
## Contributing
6471

65-
Bug reports and pull requests are welcome on GitHub at https://github.com/aboutsource/sensu-plugin-trello.
72+
Bug reports and pull requests are welcome on GitHub at
73+
https://github.com/aboutsource/sensu-plugins-trello.
6674

bin/console

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#!/usr/bin/env ruby
22

33
require "bundler/setup"
4-
require "sensu/plugin/trello"
4+
require "sensu/plugins/trello"
55

66
# You can add fixtures and/or initialization code here to make experimenting
77
# with your gem easier. You can also use a different console, if you like.

bin/setup

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@ set -euo pipefail
33
IFS=$'\n\t'
44
set -vx
55

6-
bundle install
6+
bundle install --path vendor/bundle
77

88
# Do any other automated setup that you need to do here
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
require "sensu/plugin/trello/version"
1+
require "sensu/plugins/trello/version"
22

33
module Sensu
4-
module Plugin
4+
module Plugins
55
module Trello
66
# Your code goes here...
77
end
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
module Sensu
2-
module Plugin
2+
module Plugins
33
module Trello
44
VERSION = "0.1.0"
55
end
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
# coding: utf-8
22
lib = File.expand_path('../lib', __FILE__)
33
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4-
require 'sensu/plugin/trello/version'
4+
require 'sensu/plugins/trello/version'
55

66
Gem::Specification.new do |spec|
7-
spec.name = "sensu-plugin-trello"
8-
spec.version = Sensu::Plugin::Trello::VERSION
9-
spec.authors = ["Hauke Altmann"]
7+
spec.name = "sensu-plugins-trello"
8+
spec.version = Sensu::Plugins::Trello::VERSION
9+
spec.authors = ["Hauke Altmann", "Stefan Walluhn"]
1010
spec.email = ["hauke.altmann@aboutsource.net"]
1111

1212
spec.summary = 'Check if a Trello list contains card(s)'
1313
spec.description = 'Used for incident management where a card represents an incident.'
14-
spec.homepage = "https://github.com/aboutsource/sensu-plugin-trello"
14+
spec.homepage = "https://github.com/aboutsource/sensu-plugins-trello"
1515

1616
spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
1717
spec.executables = Dir.glob('bin/**/*.rb').map { |file| File.basename(file) }

0 commit comments

Comments
 (0)