hipchat 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2ec52d652412c7540c45f243508e99f5a155ec1
-  data.tar.gz: 0082b930a02ab0a0fac1d46d7181a7cd64202634
+  metadata.gz: 6073dc06bef01e6ad218249ec887d775fa89e8e2
+  data.tar.gz: 4b10a0deedf65b55dd331613d6dbc25a41809122
 SHA512:
-  metadata.gz: 0470720c384fce9a0403b3df9fc930b98cd1047d496b783a62cb0fbbec8999bdd4998db5f76153f366450ffc91e2ec48f2a44cfaeb8181c9ebcf47d11dbc9fac
-  data.tar.gz: 82098108cb71cffb51993058336b39072da7154ae8a579e7077365dc98a1dc6c22671a29f817f0fed68f8d5dd1bf60056ec44924a4b016a94ff6febb926e874e
+  metadata.gz: 66edf59e5fc4fc96fdbc43846648a76c48c48d32c3f13cbc0fdf9ce22bc15f72a8ebad3818dc716f80330498800cdbaa4e6296867e1a7b076ce057262ef20b47
+  data.tar.gz: 226c2ea4a5447c1726bb20b5727c60112f9e1f214b29786bd8db31ec2874f7efd951fcd75ff67fa737657f4041a15c6d892c9f00aebef9764882b8cc357fdd41

data/.travis.yml

@@ -3,4 +3,4 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
-  - 2.1.0
+  - 2.1

data/README.textile

@@ -20,7 +20,7 @@ bc.. client = HipChat::Client.new(api_token)
 client['my room'].send('username', 'I talk')
 
 # Send notifications to users (default false)
-client['my room'].send('username', 'I quit!', :notify => 1)
+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')
@@ -82,9 +82,46 @@ client['my room'].invite("USER_ID_OR_NAME", options = {})
 # Sends a user a private message. Valid value for user are user id or email address
 client.user('foo@bar.org').send('I can send private messages')
 
-h2. Capistrano
+h2. Custom Server URL
 
-*APIv1 ONLY, use APIv1 Key*
+bc.. client = HipChat::Client.new(api_token, :api_version => 'v2', :server_url => 'https://domain.com')
+# 'username' is the name for which the message will be presented as from
+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')
+
+# Have your message rendered as text in HipChat (see https://www.hipchat.com/docs/apiv2/method/send_room_notification)
+client['my room'].send('username', '@coworker Build faild!', :message_format => 'text')
+
+# Update the topic of a room in HipChat (see https://www.hipchat.com/docs/apiv2/method/set_topic)
+client['my room'].topic('Free Ice Cream in the kitchen')
+
+# Change the from field for a topic update (default "API")
+client['my room'].topic('Weekely sales: $10,000', :from => 'Sales Team')
+
+# Get history from a room
+client['my room'].history()
+
+# Get history for a date in time with a particular timezone (default is latest 75 messages, timezone default is 'UTC')
+client['my room'].history(:date => '2010-11-19', :timezone => 'PST')
+
+# Create a new room (see https://www.hipchat.com/docs/apiv2/method/create_room)
+client.create_room("Name", options = {})
+
+# Get room data (see https://www.hipchat.com/docs/apiv2/method/get_room)
+client['my room'].get_room
+
+# Invite user to room (see https://www.hipchat.com/docs/apiv2/method/invite_user)
+client['my room'].invite("USER_ID_OR_NAME", options = {})
+
+# Sends a user a private message. Valid value for user are user id or email address
+client.user('foo@bar.org').send('I can send private messages')
+
+h2. Capistrano
 
 Capfile
 
@@ -101,6 +138,9 @@ set :hipchat_color, 'yellow' #normal message color
 set :hipchat_success_color, 'green' #finished deployment message color
 set :hipchat_failed_color, 'red' #cancelled deployment message color
 set :hipchat_message_format, 'html' # Sets the deployment message format, see https://www.hipchat.com/docs/api/method/rooms/message
+set :hipchat_options, {
+  :api_version  => "v2" # Set "v2" to send messages with API v2
+}
 
 h3. Who did it?
 

data/lib/hipchat/api_version.rb

@@ -13,14 +13,15 @@ module HipChat
 
     class Client < ApiVersion
 
-      def initialize(version = 'v1')
-        @version = !version.nil? ? version : 'v1'
+      def initialize(options = {})
+        # puts options.inspect
+        @version = options[:api_version]
         if @version.eql?('v1')
-          @base_uri = "https://api.hipchat.com/v1"
+          @base_uri = "#{options[:server_url]}/v1"
           @headers = {'Accept' => 'application/json',
              'Content-Type' => 'application/x-www-form-urlencoded'}
         else
-          @base_uri = "https://api.hipchat.com/v2"
+          @base_uri = "#{options[:server_url]}/v2"
           @headers = {'Accept' => 'application/json',
              'Content-Type' => 'application/json'}
         end
@@ -65,15 +66,15 @@ module HipChat
 
     class Room < ApiVersion
 
-      def initialize(room_id, version = 'v1')
-        @room_id = room_id
-        @version = !version.nil? ? version : 'v1'
+      def initialize(options = {})
+        @room_id = options[:room_id]
+        @version = options[:api_version]
         if @version.eql?('v1')
-          @base_uri = "https://api.hipchat.com/v1/rooms"
+          @base_uri = "#{options[:server_url]}/v1/rooms"
           @headers = {'Accept' => 'application/json',
              'Content-Type' => 'application/x-www-form-urlencoded'}
         else
-          @base_uri = "https://api.hipchat.com/v2/room"
+          @base_uri = "#{options[:server_url]}/v2/room"
           @headers = {'Accept' => 'application/json',
              'Content-Type' => 'application/json'}
         end
@@ -140,10 +141,10 @@ module HipChat
 
     class User
 
-      def initialize(user_id, version)
+      def initialize(user_id, options)
         @user_id = user_id
-        raise InvalidApiVersion,  "user API calls invalid for API v1" if ! version.eql?('v2')
-        @base_uri = "https://api.hipchat.com/v2/user"
+        raise InvalidApiVersion,  "user API calls invalid for API v1" if ! options[:api_version].eql?('v2')
+        @base_uri = "#{options[:server_url]}/v2/user"
         @headers = {'Accept' => 'application/json',
           'Content-Type' => 'application/json'}
       end

data/lib/hipchat/capistrano/tasks/hipchat.rake

@@ -3,17 +3,17 @@ require 'hipchat'
 namespace :hipchat do
 
   task :notify_deploy_started do
-    send_message("#{human} is deploying #{deployment_name} to #{environment_name}.", send_options)
+    send_message("#{human} is deploying #{deployment_name} to #{environment_string}.", send_options)
   end
 
   task :notify_deploy_finished do
     send_options.merge!(:color => success_message_color)
-    send_message("#{human} finished deploying #{deployment_name} to #{environment_name}.", send_options)
+    send_message("#{human} finished deploying #{deployment_name} to #{environment_string}.", send_options)
   end
 
   task :notify_deploy_reverted do
     send_options.merge!(:color => failed_message_color)
-    send_message("#{human} cancelled deployment of #{deployment_name} to #{environment_name}.", send_options)
+    send_message("#{human} cancelled deployment of #{deployment_name} to #{environment_string}.", send_options)
   end
 
   def send_options
@@ -27,8 +27,9 @@ namespace :hipchat do
   def send_message(message, options)
     hipchat_token = fetch(:hipchat_token)
     hipchat_room_name = fetch(:hipchat_room_name)
+    hipchat_options = fetch(:hipchat_options, {})
 
-    hipchat_client = fetch(:hipchat_client, HipChat::Client.new(hipchat_token))
+    hipchat_client = fetch(:hipchat_client, HipChat::Client.new(hipchat_token, hipchat_options))
 
     if hipchat_room_name.is_a?(String)
       rooms = [hipchat_room_name]
@@ -48,6 +49,14 @@ namespace :hipchat do
     }
   end
 
+  def environment_string
+    if fetch(:stage)
+      "#{fetch(:stage)} (#{environment_name})"
+    else
+      environment_name
+    end
+  end
+
   def deployment_name
     if fetch(:branch, nil)
       application = fetch(:application)
@@ -63,7 +72,7 @@ namespace :hipchat do
   end
 
   def message_color
-    fetch(:hipchat_color)
+    fetch(:hipchat_color, 'yellow')
   end
 
   def success_message_color

data/lib/hipchat/capistrano2.rb

@@ -58,7 +58,8 @@ Capistrano::Configuration.instance(:must_exist).load do
     end
 
     def send(message, options)
-      set :hipchat_client, HipChat::Client.new(hipchat_token) if fetch(:hipchat_client, nil).nil?
+      hipchat_options = fetch(:hipchat_options, {})
+      set :hipchat_client, HipChat::Client.new(hipchat_token, hipchat_options) if fetch(:hipchat_client, nil).nil?
 
       if hipchat_room_name.is_a?(String)
         rooms = [hipchat_room_name]

data/lib/hipchat/client.rb

@@ -9,8 +9,10 @@ module HipChat
 
     def initialize(token, options={})
       @token = token
+      default_options = { api_version: 'v1', server_url: 'https://api.hipchat.com' }
+      @options = default_options.merge options
       @api_version = options[:api_version]
-      @api = HipChat::ApiVersion::Client.new(@api_version)
+      @api = HipChat::ApiVersion::Client.new(@options)
       self.class.base_uri(@api.base_uri)
       http_proxy = options[:http_proxy] || ENV['http_proxy']
       setup_proxy(http_proxy) if http_proxy
@@ -21,7 +23,7 @@ module HipChat
     end
 
     def [](name)
-      Room.new(@token, :room_id => name, :api_version => @api_version)
+      Room.new(@token, { room_id: name }.merge(@options))
     end
 
     def create_room(name, options={})
@@ -35,7 +37,7 @@ module HipChat
       unless options[:guest_access].nil?
         options[:guest_access] = @api.bool_val(options[:guest_access])
       end
-      
+
       response = self.class.post(@api.create_room_config[:url],
         :query => { :auth_token => @token },
         :body => {
@@ -57,7 +59,7 @@ module HipChat
     end
 
     def user(name)
-      User.new(@token, :user_id => name, :api_version => @api_version)
+      User.new(@token, { :user_id => name }.merge(@options))
     end
 
     def users
@@ -94,18 +96,19 @@ module HipChat
     def _users
       response = self.class.get(@api.users_config[:url],
         :query => {
-          :auth_token => @token
+          :auth_token => @token,
+          :expand => 'items'
         },
         :headers => @api.headers
       )
       case response.code
       when 200
         response[@api.users_config[:data_key]].map do |r|
-          Room.new(@token, r.merge(:api_version => @api_version, :user_id => r['id']))
+          User.new(@token, r.merge(:api_version => @api_version, :user_id => r['id']))
         end
       else
         raise UnknownResponseCode, "Unexpected #{response.code} for room"
       end
-    end    
+    end
   end
-end
+end

data/lib/hipchat/rails3_tasks.rb

@@ -14,7 +14,8 @@ namespace :hipchat do
       :room           => ENV['ROOM'],
       :color          => ENV['COLOR'],
       :token          => ENV['TOKEN'],
-      :api_version    => ENV['API_VERSION']
+      :api_version    => ENV['API_VERSION'],
+      :server_url     => ENV['SERVER_URL']
     }.reject { |k, v| v.blank? }
 
     system_options = {

data/lib/hipchat/room.rb

@@ -10,8 +10,7 @@ module HipChat
 
     def initialize(token, params)
       @token = token
-      @api = HipChat::ApiVersion::Room.new(params[:room_id],
-                                           params.delete(:api_version))
+      @api = HipChat::ApiVersion::Room.new(params)
       self.class.base_uri(@api.base_uri)
       super(params)
     end
@@ -190,4 +189,4 @@ module HipChat
       end
     end
   end
-end
+end

data/lib/hipchat/user.rb

@@ -11,7 +11,7 @@ module HipChat
     def initialize(token, params)
       @token = token
       @api = HipChat::ApiVersion::User.new(params[:user_id],
-                                           params.delete(:api_version))
+                                           params)
       self.class.base_uri(@api.base_uri)
       super(params)
     end
@@ -38,25 +38,23 @@ module HipChat
         raise UnknownResponseCode, "Unexpected #{response.code} for private message to `#{user_id}'"
       end
     end
-    
+
     #
     # Get a user's details.
     #
     def view
       puts "#{@api.base_uri}#{@api.view_config[:url]}"
-      response = self.class.post(@api.view_config[:url],
+      response = self.class.get(@api.view_config[:url],
         :query => { :auth_token => @token },
         :headers => @api.headers
       )
 
       case response.code
       when 200
-        response[@api.users_config[:data_key]].map do |r|
-          User.new(@token, r.merge(:api_version => @api_version))
-        end
+        User.new(@token, response.merge(:api_version => 'v2'))
       else
         raise UnknownResponseCode, "Unexpected #{response.code} for view message to `#{user_id}'"
       end
     end
   end
-end
+end

data/lib/hipchat/version.rb

@@ -1,3 +1,3 @@
 module HipChat
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hipchat
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - HipChat/Atlassian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-11 00:00:00.000000000 Z
+date: 2014-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty