hipchat 0.4.1 → 0.5.0

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Mojo Tech
+Copyright (c) 2012 Atlassian
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.textile

@@ -13,6 +13,9 @@ 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')
 
+# Have your message rendered as text in HipChat (see https://www.hipchat.com/docs/api/method/rooms/message)
+client['my room'].send('username', '@coworker Build faild!', :message_format => 'text')
+
 h2. Capistrano
 
 bc.. require 'hipchat/capistrano'
@@ -20,6 +23,9 @@ bc.. require 'hipchat/capistrano'
 set :hipchat_token, "<your token>"
 set :hipchat_room_name, "Your room"
 set :hipchat_announce, false # notify users
+set :hipchat_color, 'green' #finished deployment message color
+set :hipchat_failed_color, 'red' #cancelled deployment message color
+set :hipchat_message_format, 'text' # Sets the deployment message format, see https://www.hipchat.com/docs/api/method/rooms/message
 
 h3. Who did it?
 
@@ -34,7 +40,7 @@ h2. Rails 3 Rake Task
 
 Send a message using a rake task:
 
-bc.. rake hipchat:send["hello world"]
+bc. rake hipchat:send["hello world"]
 
 Options like the room, API token, user name and notification flag can be set in YAML.
 
@@ -52,15 +58,14 @@ 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][0...6]}"
-  message += " to #{@configuration[:environment]}"
+  message  = "Deploying revision #{revision[0...6]} to #{node[:environment][:name]}"
   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} && bundle exec rake hipchat:send MESSAGE='#{message}'"
 end
 
 h2. Copyright
 
-Copyright (c) 2010 Mojo Tech. See LICENSE for details.
+Copyright (c) 2012 Atlassian. See LICENSE for details.

data/Rakefile

@@ -7,9 +7,9 @@ begin
     gem.name = "hipchat"
     gem.summary = %Q{Ruby library to interact with HipChat}
     gem.description = %Q{Ruby library to interact with HipChat}
-    gem.email = "gems@mojotech.com"
-    gem.homepage = "http://github.com/mojotech/hipchat"
-    gem.authors = ["MojoTech"]
+    gem.email = "support@hipchat.com"
+    gem.homepage = "https://github.com/hipchat/hipchat-rb"
+    gem.authors = ["HipChat/Atlassian"]
     gem.add_dependency "httparty"
     gem.add_development_dependency "rspec", "~> 2.0"
     gem.add_development_dependency "rr", "~> 1.0"

data/VERSION

@@ -1 +1 @@
-0.4.1
+0.5.0

data/hipchat.gemspec

@@ -5,13 +5,13 @@
 
 Gem::Specification.new do |s|
   s.name = "hipchat"
-  s.version = "0.4.1"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["MojoTech"]
-  s.date = "2011-10-19"
+  s.authors = ["HipChat/Atlassian"]
+  s.date = "2012-10-12"
   s.description = "Ruby library to interact with HipChat"
-  s.email = "gems@mojotech.com"
+  s.email = "support@hipchat.com"
   s.extra_rdoc_files = [
     "LICENSE",
     "README.textile"
@@ -32,9 +32,9 @@ Gem::Specification.new do |s|
     "spec/spec.opts",
     "spec/spec_helper.rb"
   ]
-  s.homepage = "http://github.com/mojotech/hipchat"
+  s.homepage = "https://github.com/hipchat/hipchat-rb"
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.10"
+  s.rubygems_version = "1.8.24"
   s.summary = "Ruby library to interact with HipChat"
 
   if s.respond_to? :specification_version then

data/lib/hipchat.rb

@@ -47,7 +47,7 @@ module HipChat
     #   send 'nickname', 'some message'
     #
     #   # Notify users and color the message red
-    #   send 'nickname', 'some message', :notify => true, :color => 'red' 
+    #   send 'nickname', 'some message', :notify => true, :color => 'red'
     #
     #   # Notify users (deprecated)
     #   send 'nickname', 'some message', true
@@ -58,7 +58,7 @@ module HipChat
     #            (default "yellow")
     # +notify+:: true or false
     #            (default false)
-    def send(from, message, options_or_notify = false)
+    def send(from, message, options_or_notify = {})
       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 }
@@ -71,11 +71,12 @@ module HipChat
       response = self.class.post('/message',
         :query => { :auth_token => @token },
         :body  => {
-          :room_id => room_id,
-          :from    => from,
-          :message => message,
-          :color   => options[:color],
-          :notify  => options[:notify] ? 1 : 0
+          :room_id        => room_id,
+          :from           => from,
+          :message        => message,
+          :message_format => options[:message_format] || 'html',
+          :color          => options[:color],
+          :notify         => options[:notify] ? 1 : 0
         }
       )
 

data/lib/hipchat/capistrano.rb

@@ -20,22 +20,30 @@ Capistrano::Configuration.instance(:must_exist).load do
     task :notify_deploy_started do
       if hipchat_send_notification
         on_rollback do
+          send_options.merge!(:color => failed_message_color)
           hipchat_client[hipchat_room_name].
-            send(deploy_user, "#{human} cancelled deployment of #{deployment_name} to #{env}.", hipchat_announce)
+            send(deploy_user, "#{human} cancelled deployment of #{deployment_name} to #{env}.", send_options)
         end
 
         message = "#{human} is deploying #{deployment_name} to #{env}"
         message << " (with migrations)" if hipchat_with_migrations
         message << "."
 
-        hipchat_client[hipchat_room_name].
-          send(deploy_user, message, hipchat_announce)
+        hipchat_client[hipchat_room_name].send(deploy_user, message, send_options)
       end
     end
 
     task :notify_deploy_finished do
       hipchat_client[hipchat_room_name].
-        send(deploy_user, "#{human} finished deploying #{deployment_name} to #{env}.", hipchat_announce)
+        send(deploy_user, "#{human} finished deploying #{deployment_name} to #{env}.", send_options)
+    end
+
+    def send_options
+      return @send_options if defined?(@send_options)
+      @send_options = message_color ? {:color => message_color} : {}
+      @send_options = message_format ? {:message_format => message_format } : {}
+      @send_options.merge!(:notify => message_notification)
+      @send_options
     end
 
     def deployment_name
@@ -45,7 +53,23 @@ Capistrano::Configuration.instance(:must_exist).load do
         application
       end
     end
-    
+
+    def message_color
+      fetch(:hipchat_color, nil)
+    end
+
+    def failed_message_color
+      fetch(:hipchat_failed_color, "red")
+    end
+
+    def message_notification
+      fetch(:hipchat_announce, false)
+    end
+
+    def message_format
+      fetch(:hipchat_message_format, "html")
+    end
+
     def deploy_user
       fetch(:hipchat_deploy_user, "Deploy")
     end

data/lib/hipchat/chef.rb

@@ -25,7 +25,7 @@ module HipChat
       msg = "Failure on #{node.name}: #{run_status.formatted_exception}"
 
       client = HipChat::Client.new(@api_token)
-      client[@room_name].send('Chef', msg, @notify_users)
+      client[@room_name].send('Chef', msg, :notify => @notify_users)
     end
   end
 end

data/lib/hipchat/rails3_tasks.rb

@@ -7,16 +7,23 @@ namespace :hipchat do
     config_file      = Rails.root.join 'config', 'hipchat.yml'
 
     options = {
-      :message => ENV['MESSAGE'],
-      :user    => ENV['USER'],
-      :notify  => ENV['NOTIFY'],
-      :room    => ENV['ROOM'],
-      :token   => ENV['TOKEN']
+      :message        => ENV['MESSAGE'],
+      :message_format => ENV['MESSAGE_FORMAT'],
+      :user           => ENV['HIPCHAT_USER'],
+      :notify         => ENV['NOTIFY'],
+      :room           => ENV['ROOM'],
+      :token          => ENV['TOKEN']
+    }.reject { |k, v| v.blank? }
+    
+    system_options = {
+      :user    => ENV['USER']
     }.reject { |k, v| v.blank? }
 
     if File.exists? config_file
       options.reverse_merge! YAML.load_file(config_file).symbolize_keys
     end
+    
+    options.reverse_merge! system_options
 
     options[:notify] = options[:notify].to_s != 'false'
 
@@ -27,6 +34,6 @@ namespace :hipchat do
 
     client = HipChat::Client.new(options[:token])
 
-    client[options[:room]].send(options[:user], options[:message], options[:notify])
+    client[options[:room]].send(options[:user], options[:message], :notify => options[:notify])
   end
 end

data/spec/hipchat_spec.rb

@@ -4,7 +4,7 @@ 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)
@@ -16,40 +16,28 @@ describe HipChat do
                                         :color   => options[:color],
                                         :notify  => options[:notify]}) {
       OpenStruct.new(:code => 200)
-    }    
+    }
   end
 
   describe "sends a message to a room" do
     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
+      room.send("Dude", "Hello world").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", :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,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: hipchat
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
-- MojoTech
+- HipChat/Atlassian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-19 00:00:00.000000000Z
+date: 2012-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70228089062780 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70228089062780
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70228089062160 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +37,15 @@ dependencies:
         version: '2.0'
   type: :development
   prerelease: false
-  version_requirements: *70228089062160
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rr
-  requirement: &70228089061480 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,9 +53,14 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *70228089061480
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: Ruby library to interact with HipChat
-email: gems@mojotech.com
+email: support@hipchat.com
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -66,7 +81,7 @@ files:
 - spec/hipchat_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
-homepage: http://github.com/mojotech/hipchat
+homepage: https://github.com/hipchat/hipchat-rb
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -86,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Ruby library to interact with HipChat