kindling 0.0.6 → 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- data/MIT-LICENSE +22 -0
- data/README.rdoc +27 -12
- data/VERSION +1 -1
- data/kindling.gemspec +3 -3
- data/test/kindling/campfire_test.rb +1 -1
- metadata +3 -3
- data/LICENSE +0 -20
data/MIT-LICENSE
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
Copyright (c) 2010, Contrast.
|
2
|
+
|
3
|
+
Permission is hereby granted, free of charge, to any person
|
4
|
+
obtaining a copy of this software and associated documentation
|
5
|
+
files (the "Software"), to deal in the Software without
|
6
|
+
restriction, including without limitation the rights to use,
|
7
|
+
copy, modify, merge, publish, distribute, sublicense, and/or sell
|
8
|
+
copies of the Software, and to permit persons to whom the
|
9
|
+
Software is furnished to do so, subject to the following
|
10
|
+
conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be
|
13
|
+
included in all copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
16
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
17
|
+
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
18
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
19
|
+
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
20
|
+
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
21
|
+
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
22
|
+
OTHER DEALINGS IN THE SOFTWARE.
|
data/README.rdoc
CHANGED
@@ -1,17 +1,32 @@
|
|
1
1
|
= kindling
|
2
2
|
|
3
|
-
|
3
|
+
Ruby wrapper for the 37 Signals Campfire API
|
4
4
|
|
5
|
-
==
|
6
|
-
|
7
|
-
* Fork the project.
|
8
|
-
* Make your feature addition or bug fix.
|
9
|
-
* Add tests for it. This is important so I don't break it in a
|
10
|
-
future version unintentionally.
|
11
|
-
* Commit, do not mess with rakefile, version, or history.
|
12
|
-
(if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
|
13
|
-
* Send me a pull request. Bonus points for topic branches.
|
5
|
+
== INSTALL:
|
14
6
|
|
15
|
-
|
7
|
+
[sudo] gem install kindling
|
8
|
+
|
9
|
+
== Usage
|
10
|
+
To use the kindling gem you need
|
16
11
|
|
17
|
-
|
12
|
+
1. Api Token - An authentication token which you'll find on the "Edit my Campfire account" screen in Campfire (click the "Reveal authentication token for API" link)
|
13
|
+
2. Subdomain - The Subdomain name for your campfire account (i.e contrast if your campfire domain is http://contrast.campfirenow.com)
|
14
|
+
3. Room ID - The Room ID of the target room (best to get this from the url ie http://SUBDOMAIN.campfirenow.com/room/XXXXXX)
|
15
|
+
|
16
|
+
campfire = Kindling::Campfire.new(API_TOKEN, SUBDOMAIN)
|
17
|
+
|
18
|
+
=== SSL
|
19
|
+
If using SSL pass true to the third parameter of the Kindling::Campfire constructor
|
20
|
+
|
21
|
+
campfire = Kindling::Campfire.new(API_TOKEN, SUBDOMAIN, true)
|
22
|
+
|
23
|
+
=== Sending messages
|
24
|
+
capfire.speak(ROOM_ID, 'my message')
|
25
|
+
|
26
|
+
==== Message Types
|
27
|
+
The speak method can take an optional third parameter MessageType
|
28
|
+
|
29
|
+
Supported message types are
|
30
|
+
* "TextMessage" (default) : A regular chat message
|
31
|
+
* "SoundMessage" : plays a sound as determined by the message, which can be either “rimshot”, “crickets”, or “trombone”
|
32
|
+
* "TweetMessage" : The message must be Twitter status URL only
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
0.0
|
1
|
+
1.0.0
|
data/kindling.gemspec
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
|
6
6
|
Gem::Specification.new do |s|
|
7
7
|
s.name = %q{kindling}
|
8
|
-
s.version = "0.0
|
8
|
+
s.version = "1.0.0"
|
9
9
|
|
10
10
|
s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
|
11
11
|
s.authors = ["Wal McConnell"]
|
@@ -13,11 +13,11 @@ Gem::Specification.new do |s|
|
|
13
13
|
s.description = %q{Ruby wrapper for the 37 Signals Campfire API}
|
14
14
|
s.email = %q{wal@contrast.ie}
|
15
15
|
s.extra_rdoc_files = [
|
16
|
-
"LICENSE",
|
16
|
+
"MIT-LICENSE",
|
17
17
|
"README.rdoc"
|
18
18
|
]
|
19
19
|
s.files = [
|
20
|
-
|
20
|
+
"MIT-LICENSE",
|
21
21
|
"README.rdoc",
|
22
22
|
"Rakefile",
|
23
23
|
"VERSION",
|
@@ -9,7 +9,7 @@ class CampfireTest < Test::Unit::TestCase
|
|
9
9
|
|
10
10
|
should "send message if correct name" do
|
11
11
|
Kindling::Request.expects(:rooms).returns(JSON.parse(fixture_file("rooms.json"))["rooms"])
|
12
|
-
Kindling::Request.expects(:speak).with("test message", @campfire, TEST_ROOM_ID)
|
12
|
+
Kindling::Request.expects(:speak).with("test message", @campfire, TEST_ROOM_ID, "Textmessage")
|
13
13
|
@campfire.speak(TEST_ROOM_NAME, "test message")
|
14
14
|
end
|
15
15
|
end
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: kindling
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.0
|
4
|
+
version: 1.0.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Wal McConnell
|
@@ -20,10 +20,10 @@ executables: []
|
|
20
20
|
extensions: []
|
21
21
|
|
22
22
|
extra_rdoc_files:
|
23
|
-
- LICENSE
|
23
|
+
- MIT-LICENSE
|
24
24
|
- README.rdoc
|
25
25
|
files:
|
26
|
-
- LICENSE
|
26
|
+
- MIT-LICENSE
|
27
27
|
- README.rdoc
|
28
28
|
- Rakefile
|
29
29
|
- VERSION
|
data/LICENSE
DELETED
@@ -1,20 +0,0 @@
|
|
1
|
-
Copyright (c) 2009 wal
|
2
|
-
|
3
|
-
Permission is hereby granted, free of charge, to any person obtaining
|
4
|
-
a copy of this software and associated documentation files (the
|
5
|
-
"Software"), to deal in the Software without restriction, including
|
6
|
-
without limitation the rights to use, copy, modify, merge, publish,
|
7
|
-
distribute, sublicense, and/or sell copies of the Software, and to
|
8
|
-
permit persons to whom the Software is furnished to do so, subject to
|
9
|
-
the following conditions:
|
10
|
-
|
11
|
-
The above copyright notice and this permission notice shall be
|
12
|
-
included in all copies or substantial portions of the Software.
|
13
|
-
|
14
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
15
|
-
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
16
|
-
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
17
|
-
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
18
|
-
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
19
|
-
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
20
|
-
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|