hipchat 0.4.0 → 0.4.1

data/README.textile

@@ -5,8 +5,13 @@ A very basic wrapper for the HipChat HTTP API.
 h2. Usage
 
 bc.. client = HipChat::Client.new(api_token)
-notify_users = false
-client['my room'].send('username', 'A message!', notify_users)
+client['my room'].send('username', 'I talk')
+
+# Send notifications to users (default false)
+client['my room'].send('username', 'I quit!', :notify => true)
+
+# Color it red. or "yellow", "green", "purple", "random" (default "yellow")
+client['my room'].send('username', 'Build failed!', :color => 'red')
 
 h2. Capistrano
 
@@ -47,13 +52,13 @@ Use a "deploy hook":http://bit.ly/qnbIkP to send messages from Engine Yard's Clo
 RAILS_ROOT/deploy/after_restart.rb:
 
 bc.. on_app_master do
-  message  = "Deploying revision #{@configuration[:revision]}"
+  message  = "Deploying revision #{@configuration[:revision][0...6]}"
   message += " to #{@configuration[:environment]}"
   message += " (with migrations)" if migrate?
   message += "."
 
   # Send a message via rake task assuming a hipchat.yml in your config like above
-  run "cd #{release_path} && rake hipchat:send MESSAGE=#{message}"
+  run "cd #{release_path} && rake hipchat:send MESSAGE='#{message}'"
 end
 
 h2. Copyright

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.4.1

data/hipchat.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "hipchat"
-  s.version = "0.4.0"
+  s.version = "0.4.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["MojoTech"]
-  s.date = "2011-10-07"
+  s.date = "2011-10-19"
   s.description = "Ruby library to interact with HipChat"
   s.email = "gems@mojotech.com"
   s.extra_rdoc_files = [

data/lib/hipchat.rb

@@ -39,21 +39,54 @@ module HipChat
       super(params)
     end
 
-    def send(from, message, notify = false)
+    # Send a message to this room.
+    #
+    # Usage:
+    #
+    #   # Default
+    #   send 'nickname', 'some message'
+    #
+    #   # Notify users and color the message red
+    #   send 'nickname', 'some message', :notify => true, :color => 'red' 
+    #
+    #   # Notify users (deprecated)
+    #   send 'nickname', 'some message', true
+    #
+    # Options:
+    #
+    # +color+::  "yellow", "red", "green", "purple", or "random"
+    #            (default "yellow")
+    # +notify+:: true or false
+    #            (default false)
+    def send(from, message, options_or_notify = false)
+      options = if options_or_notify == true or options_or_notify == false
+        warn "DEPRECATED: Specify notify flag as an option (e.g., :notify => true)"
+        { :notify => options_or_notify }
+      else
+        options_or_notify || {}
+      end
+
+      options = { :color => 'yellow', :notify => false }.merge options
+
       response = self.class.post('/message',
-                                 :query => { :auth_token => @token },
-                                 :body => {:room_id => room_id,
-                                           :from => from,
-                                           :message => message,
-                                           :notify => notify ? 1 : 0})
+        :query => { :auth_token => @token },
+        :body  => {
+          :room_id => room_id,
+          :from    => from,
+          :message => message,
+          :color   => options[:color],
+          :notify  => options[:notify] ? 1 : 0
+        }
+      )
 
       case response.code
-      when 200; # weee
-      when 404; raise UnknownRoom,  "Unknown room: `#{room_id}'"
-      when 401; raise Unauthorized, "Access denied to room `#{room_id}'"
-      else      raise UnknownResponseCode, "Unexpected #{response.code} for " <<
-                                           "room `#{room_id}'"
-
+      when 200; true
+      when 404
+        raise UnknownRoom,  "Unknown room: `#{room_id}'"
+      when 401
+        raise Unauthorized, "Access denied to room `#{room_id}'"
+      else
+        raise UnknownResponseCode, "Unexpected #{response.code} for room `#{room_id}'"
       end
     end
   end

data/lib/hipchat/capistrano.rb

@@ -21,10 +21,10 @@ Capistrano::Configuration.instance(:must_exist).load do
       if hipchat_send_notification
         on_rollback do
           hipchat_client[hipchat_room_name].
-            send(deploy_user, "#{human} cancelled deployment of #{application} to #{env}.", hipchat_announce)
+            send(deploy_user, "#{human} cancelled deployment of #{deployment_name} to #{env}.", hipchat_announce)
         end
 
-        message = "#{human} is deploying #{application} to #{env}"
+        message = "#{human} is deploying #{deployment_name} to #{env}"
         message << " (with migrations)" if hipchat_with_migrations
         message << "."
 
@@ -35,9 +35,17 @@ Capistrano::Configuration.instance(:must_exist).load do
 
     task :notify_deploy_finished do
       hipchat_client[hipchat_room_name].
-        send(deploy_user, "#{human} finished deploying #{application} to #{env}.", hipchat_announce)
+        send(deploy_user, "#{human} finished deploying #{deployment_name} to #{env}.", hipchat_announce)
     end
 
+    def deployment_name
+      if branch
+        "#{application}/#{branch}"
+      else
+        application
+      end
+    end
+    
     def deploy_user
       fetch(:hipchat_deploy_user, "Deploy")
     end

data/spec/hipchat_spec.rb

@@ -4,21 +4,52 @@ describe HipChat do
   subject { HipChat::Client.new("blah") }
 
   let(:room) { subject["Hipchat"] }
+  
+  # Helper for mocking room message post requests
+  def mock_successful_send(from, message, options={})
+    options = {:color => 'yellow', :notify => 0}.merge(options)
+    mock(HipChat::Room).post("/message",
+                             :query => {:auth_token => "blah"},
+                             :body  => {:room_id => "Hipchat",
+                                        :from    => "Dude",
+                                        :message => "Hello world",
+                                        :color   => options[:color],
+                                        :notify  => options[:notify]}) {
+      OpenStruct.new(:code => 200)
+    }    
+  end
 
   describe "sends a message to a room" do
-    it "successfully" do
-      mock(HipChat::Room).post("/message",
-                               :query => {:auth_token => "blah"},
-                               :body  => {:room_id => "Hipchat",
-                                          :from    => "Dude",
-                                          :message => "Hello world",
-                                          :notify  => 0}) {
-        OpenStruct.new(:code => 200)
-      }
+    it "successfully without custom options" do
+      mock_successful_send 'Dude', 'Hello world'
+      
+      room.send("Dude", "Hello world").should be_true
+    end
+    
+    it "successfully with notifications on as boolean" do
+      mock_successful_send 'Dude', 'Hello world', :notify => 1
+
+      room.send("Dude", "Hello world", true).should be_true
+    end
+    
+    it "successfully with notifications off as boolean" do
+      mock_successful_send 'Dude', 'Hello world', :notify => 0
+
+      room.send("Dude", "Hello world", false).should be_true
+    end
+    
+    it "successfully with notifications on as option" do
+      mock_successful_send 'Dude', 'Hello world', :notify => 1
 
-      room.send "Dude", "Hello world"
+      room.send("Dude", "Hello world", :notify => true).should be_true
     end
+    
+    it "successfully with custom color" do
+      mock_successful_send 'Dude', 'Hello world', :color => 'red'
 
+      room.send("Dude", "Hello world", :color => 'red').should be_true
+    end
+    
     it "but fails when the room doesn't exist" do
       mock(HipChat::Room).post(anything, anything) {
         OpenStruct.new(:code => 404)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hipchat
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-07 00:00:00.000000000Z
+date: 2011-10-19 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70192945036400 !ruby/object:Gem::Requirement
+  requirement: &70228089062780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70192945036400
+  version_requirements: *70228089062780
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70192945035200 !ruby/object:Gem::Requirement
+  requirement: &70228089062160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '2.0'
   type: :development
   prerelease: false
-  version_requirements: *70192945035200
+  version_requirements: *70228089062160
 - !ruby/object:Gem::Dependency
   name: rr
-  requirement: &70192945034300 !ruby/object:Gem::Requirement
+  requirement: &70228089061480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,7 +43,7 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *70192945034300
+  version_requirements: *70228089061480
 description: Ruby library to interact with HipChat
 email: gems@mojotech.com
 executables: []