kindling 0.0.6 → 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2010, Contrast.
+ 
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+ 
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+ 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -1,17 +1,32 @@
 = kindling
 
-Description goes here.
+Ruby wrapper for the 37 Signals Campfire API
 
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (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)
-* Send me a pull request. Bonus points for topic branches.
+== INSTALL:
 
-== Copyright
+	[sudo] gem install kindling
+	
+== Usage
+To use the kindling gem you need
 
-Copyright (c) 2009 wal. See LICENSE for details.
+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)
+2. Subdomain - The Subdomain name for your campfire account (i.e contrast if your campfire domain is http://contrast.campfirenow.com)
+3. Room ID - The Room ID of the target room (best to get this from the url ie http://SUBDOMAIN.campfirenow.com/room/XXXXXX)
+
+	campfire = Kindling::Campfire.new(API_TOKEN, SUBDOMAIN)
+	
+=== SSL
+If using SSL pass true to the third parameter of the Kindling::Campfire constructor
+
+	campfire = Kindling::Campfire.new(API_TOKEN, SUBDOMAIN, true)
+
+=== Sending messages
+	capfire.speak(ROOM_ID, 'my message')
+	
+==== Message Types
+The speak method can take an optional third parameter MessageType
+
+Supported message types are 
+* "TextMessage" (default) : A regular chat message
+* "SoundMessage" : plays a sound as determined by the message, which can be either “rimshot”, “crickets”, or “trombone”
+* "TweetMessage" : The message must be Twitter status URL only

data/VERSION

@@ -1 +1 @@
-0.0.4
+1.0.0

data/kindling.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{kindling}
-  s.version = "0.0.6"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Wal McConnell"]
@@ -13,11 +13,11 @@ Gem::Specification.new do |s|
   s.description = %q{Ruby wrapper for the 37 Signals Campfire API}
   s.email = %q{wal@contrast.ie}
   s.extra_rdoc_files = [
-    "LICENSE",
+    "MIT-LICENSE",
      "README.rdoc"
   ]
   s.files = [
-    "LICENSE",
+     "MIT-LICENSE",
      "README.rdoc",
      "Rakefile",
      "VERSION",

data/test/kindling/campfire_test.rb

@@ -9,7 +9,7 @@ class CampfireTest < Test::Unit::TestCase
       
       should "send message if correct name" do
         Kindling::Request.expects(:rooms).returns(JSON.parse(fixture_file("rooms.json"))["rooms"])
-        Kindling::Request.expects(:speak).with("test message", @campfire, TEST_ROOM_ID)
+        Kindling::Request.expects(:speak).with("test message", @campfire, TEST_ROOM_ID, "Textmessage")
         @campfire.speak(TEST_ROOM_NAME, "test message")
       end        
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: kindling
 version: !ruby/object:Gem::Version 
-  version: 0.0.6
+  version: 1.0.0
 platform: ruby
 authors: 
 - Wal McConnell
@@ -20,10 +20,10 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- LICENSE
+- MIT-LICENSE
 - README.rdoc
 files: 
-- LICENSE
+- MIT-LICENSE
 - README.rdoc
 - Rakefile
 - VERSION

data/LICENSE

@@ -1,20 +0,0 @@
-Copyright (c) 2009 wal
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.