hipchat-cli 0.0.1 → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/LICENSE +20 -0
- data/README.md +26 -4
- data/lib/hip_chat_cli/version.rb +1 -1
- metadata +4 -2
data/LICENSE
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2013 Jeremy Baker
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
6
|
+
this software and associated documentation files (the "Software"), to deal in
|
7
|
+
the Software without restriction, including without limitation the rights to
|
8
|
+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
9
|
+
the Software, and to permit persons to whom the Software is furnished to do so,
|
10
|
+
subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
13
|
+
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, FITNESS
|
17
|
+
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
18
|
+
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
19
|
+
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
20
|
+
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
CHANGED
@@ -2,11 +2,13 @@
|
|
2
2
|
|
3
3
|
Currently provides a simple, easy to use command line tool for sending a message to a HipChat room. Similar to https://github.com/hipchat/hipchat-cli, but about a billion times more Ruby.
|
4
4
|
|
5
|
-
###
|
5
|
+
### Installation
|
6
6
|
|
7
7
|
Install the gem:
|
8
8
|
|
9
9
|
gem install hipchat-cli
|
10
|
+
|
11
|
+
### Sending A Message
|
10
12
|
|
11
13
|
Use the bin:
|
12
14
|
|
@@ -16,7 +18,7 @@ or
|
|
16
18
|
|
17
19
|
echo "Hello World" | hipchat_notify --room [Room Name] --token [API TOKEN]
|
18
20
|
|
19
|
-
|
21
|
+
#### Options
|
20
22
|
|
21
23
|
-t, --token API_TOKEN [required] The API token for HipChat
|
22
24
|
-r, --room ROOM [required] The room ID to receive the message
|
@@ -26,6 +28,26 @@ or
|
|
26
28
|
-n, --notify notify the users in the room about the message
|
27
29
|
-h, --help Show the options and sample usage
|
28
30
|
|
31
|
+
### Environment Variables
|
32
|
+
|
33
|
+
You can use Environment Variables to set common values instead of passing them in via the command line options.
|
34
|
+
|
35
|
+
* username: HIPCHAT_API_USERNAME
|
36
|
+
* room: HIPCHAT_API_ROOM
|
37
|
+
* token: HIPCHAT_API_TOKEN
|
38
|
+
|
39
|
+
### More CLI bins!
|
40
|
+
|
41
|
+
It would be awesome to have more commands added to this tool, either as a command or as a standalone bin. If you want to add one, please follow the contribution guidelines below.
|
42
|
+
|
43
|
+
Some ideas:
|
44
|
+
|
45
|
+
* create a room
|
46
|
+
* update a topic
|
47
|
+
* create a user
|
48
|
+
* delete a user
|
49
|
+
|
50
|
+
.. pretty much anything [the HipChat API](https://www.hipchat.com/docs/api/) supports. :+1:
|
29
51
|
|
30
52
|
### Contributing
|
31
53
|
|
@@ -34,6 +56,6 @@ or
|
|
34
56
|
3. Add your changes. Make sure the tests pass (if any)
|
35
57
|
4. Submit a pull request.
|
36
58
|
|
37
|
-
###
|
59
|
+
### Copyright
|
38
60
|
|
39
|
-
See LICENSE for details
|
61
|
+
Copyright (c) 2013 Jeremy Baker. See LICENSE for details
|
data/lib/hip_chat_cli/version.rb
CHANGED
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: hipchat-cli
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.0
|
4
|
+
version: 0.1.0
|
5
5
|
prerelease:
|
6
6
|
platform: ruby
|
7
7
|
authors:
|
@@ -41,8 +41,10 @@ files:
|
|
41
41
|
- lib/hip_chat_cli/version.rb
|
42
42
|
- lib/hip_chat_cli.rb
|
43
43
|
- README.md
|
44
|
+
- LICENSE
|
44
45
|
homepage: http://github.com/jhubert/hipchat-cli-rb
|
45
|
-
licenses:
|
46
|
+
licenses:
|
47
|
+
- MIT
|
46
48
|
post_install_message:
|
47
49
|
rdoc_options: []
|
48
50
|
require_paths:
|