hipchat 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1b54a53da40893dd5e1fbd4d0fafa3f75f00c685
-  data.tar.gz: c5f30c699dda1135934c4085faeefd3c6667a837
+  metadata.gz: d6e9ee49fd12948084e362a20620cb7331e13f41
+  data.tar.gz: d1b658a816e7f42d34c6a5cdbf3f3c51e3f43542
 SHA512:
-  metadata.gz: a61559bdf4536909fcd9857a0f2afed9eb4ee2baf96cbe69b76a0dd4dce36f6888b7f089759189bce1a13848973c71d42cb49659f26fb75c233a9bbe1e9dbbb0
-  data.tar.gz: cf8f7bed717b1b5854d17b4297d680e324f131ac5d32f1ef8a509ad4fb04882a687fbb6e99156a6edf4530025b7459af5bcb6ccace87f34e5503e7295909c099
+  metadata.gz: 7de04454a535bf911c40aa3d81a717ef80a0fd7996ed5272f80b0aeea5414e6c345b31455ecfeba394df3dfe9fa5ef41e6797d3bc0d578cc27ad859abb9cbcd4
+  data.tar.gz: 6e003b0651748e0507d18a57fd0b1acf50bd7ce9ecd3a8c24353ec6eaa4f7da24714e7eb626227d9ef88cdcc4e3fec57fe5b32dc5da18fda607d0d7b79e79040

data/hipchat.gemspec

@@ -21,8 +21,9 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 1.9.3'
 
   spec.add_dependency "httparty"
+  spec.add_dependency "mimemagic"
 
-  spec.add_development_dependency "rspec", "~> 2.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rr"
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

data/lib/hipchat.rb

@@ -1,8 +1,10 @@
 require 'hipchat/railtie' if defined?(Rails::Railtie)
-require "hipchat/version"
+require 'hipchat/version'
 
 module HipChat
+  require 'hipchat/api_version'
   require 'hipchat/errors'
+  require 'hipchat/file_helper'
   require 'hipchat/room'
   require 'hipchat/client'
   require 'hipchat/user'

data/lib/hipchat/api_version.rb

@@ -58,17 +58,24 @@ module HipChat
 
       def users_config
         {
-          :url => '/user',
-          :data_key => 'items'
-        }
+          'v1' => {
+            :url => '/users/list',
+            :data_key => 'users'
+          },
+          'v2' => {
+            :url => '/user',
+            :data_key => 'items'
+          }
+        }[version]
       end
     end
 
     class Room < ApiVersion
 
       def initialize(options = {})
-        @room_id = options[:room_id]
         @version = options[:api_version]
+        options[:room_id] ||= options[get_id_attribute]
+        @room_id = options[:room_id]
         if @version.eql?('v1')
           @base_uri = "#{options[:server_url]}/v1/rooms"
           @headers = {'Accept' => 'application/json',
@@ -82,17 +89,26 @@ module HipChat
 
       attr_reader :version, :base_uri, :room_id, :headers
 
+      def get_id_attribute
+        version.eql?('v1') ? 'room_id' : 'id'
+      end
+
       def get_room_config
         {
+          'v1' => {
+            :url => URI::escape('/show'),
+            :query_params => { :room_id => room_id }
+        },
           'v2' => {
-            :url => URI::escape("/#{room_id}")
+            :url => URI::escape("/#{room_id}"),
+            :query_params => { }
           }
         }[version]
       end
 
       def update_room_config
         {
-          "v2" => {
+          'v2' => {
             :url => URI::escape("/#{room_id}"),
             :method => :put,
             :body_format => :to_json
@@ -122,6 +138,15 @@ module HipChat
         }[version]
       end
 
+      def send_file_config
+        {
+          'v2' => {
+            :url => URI::escape("/#{room_id}/share/file"),
+            :body_format => :to_json
+          }
+        }[version]
+      end
+
       def topic_config
         {
           'v1' => {
@@ -159,29 +184,67 @@ module HipChat
 
     class User
 
-      def initialize(user_id, options)
-        @user_id = user_id
-        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'}
+      def initialize(options)
+        @version = options[:api_version]
+        options[:user_id] ||= options[get_id_attribute]
+        @user_id = options[:user_id]
+        if @version.eql?('v1')
+          @base_uri = "#{options[:server_url]}/v1/users"
+          @headers = {'Accept' => 'application/json',
+                      'Content-Type' => 'application/x-www-form-urlencoded'}
+        else
+          @base_uri = "#{options[:server_url]}/v2/user"
+          @headers = {'Accept' => 'application/json',
+                      'Content-Type' => 'application/json'}
+        end
       end
 
       attr_reader :version, :base_uri, :user_id, :headers
 
+      def get_id_attribute
+        version.eql?('v1') ? 'user_id' : 'id'
+      end
+
       def send_config
+        raise InvalidApiVersion, 'This functionality is not supported in API v1' unless version.eql?('v2')
+
         {
           :url => URI::escape("/#{user_id}/message"),
           :body_format => :to_json
         }
       end
 
-      def view_config
+      def send_file_config
         {
-          :url => URI::escape("/#{user_id}"),
+          :url => URI::escape("/#{user_id}/share/file"),
           :body_format => :to_json
         }
       end
+
+      def view_config
+        {
+          'v1' => {
+            :url => URI::escape('/show'),
+            :body_format => :to_json,
+            :query_params => { :user_id => user_id }
+          },
+          'v2' => {
+            :url => URI::escape("/#{user_id}"),
+            :body_format => :to_json,
+            :query_params => {}
+          }
+        }[version]
+      end
+
+      def history_config
+        raise InvalidApiVersion, 'This functionality is not supported in API v1' unless version.eql?('v2')
+
+        {
+          :url => URI::escape("/#{user_id}/history/latest"),
+          :body_format => :to_json,
+          :allowed_params => [:'max-results', :timezone, :'not-before']
+        }
+      end
     end
   end
 end

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

@@ -25,6 +25,8 @@ namespace :hipchat do
   end
 
   def send_message(message, options)
+    return unless options[:notify]
+
     hipchat_token = fetch(:hipchat_token)
     hipchat_room_name = fetch(:hipchat_room_name)
     hipchat_options = fetch(:hipchat_options, {})

data/lib/hipchat/capistrano2.rb

@@ -42,7 +42,7 @@ Capistrano::Configuration.instance(:must_exist).load do
         if fetch(:hipchat_commit_log, false)
           logs = commit_logs
           unless logs.empty?
-            send(logs.join("\n"), send_options)
+            send(logs.join(commit_log_line_separator), send_options)
           end
         end
         send("#{human} finished deploying #{deployment_name} to #{environment_string}#{fetch(:hipchat_with_migrations, '')}.", send_options)
@@ -128,6 +128,10 @@ Capistrano::Configuration.instance(:must_exist).load do
     def env
       fetch(:hipchat_env, fetch(:rack_env, fetch(:rails_env, "production")))
     end
+
+    def commit_log_line_separator
+      message_format == "html" ? "<br/>" : "\n"
+    end
   end
 
   def commit_logs

data/lib/hipchat/chef.rb

@@ -15,20 +15,21 @@ require 'hipchat'
 module HipChat
   class NotifyRoom < Chef::Handler
 
-    def initialize(api_token, room_name, options={}, msg_options={}, notify_users=false, report_success=false, excluded_envs=[], msg_prefix='')
+    def initialize(api_token, room_name, options={})
+      defaults = { hipchat_options: {}, msg_options: {}, excluded_envs: [], msg_prefix: ''}
+      options = defaults.merge(options)
       @api_token = api_token
       @room_name = room_name
-      @options = options
-      @report_success = report_success
-      @msg_options = msg_options
-      @msg_options[:notify] = notify_users 
-      @excluded_envs = excluded_envs
+      @hipchat_options = options[:hipchat_options]
+      @msg_options = options[:msg_options]
+      @msg_prefix = options[:msg_prefix]
+      @excluded_envs = options[:excluded_envs]
     end
 
     def report
       unless @excluded_envs.include?(node.chef_environment)
         msg = if run_status.failed? then "Failure on \"#{node.name}\" (\"#{node.chef_environment}\" env): #{run_status.formatted_exception}"
-              elsif run_status.success? && @report_success
+              elsif run_status.success? && @msg_options[:notify]
                 "Chef run on \"#{node.name}\" completed in #{run_status.elapsed_time.round(2)} seconds"
               else nil
               end
@@ -38,8 +39,8 @@ module HipChat
                 end
 
         if msg
-          client = HipChat::Client.new(@api_token, @options)
-          client[@room_name].send('Chef', [msg_prefix, msg].join(' '), @msg_options)
+          client = HipChat::Client.new(@api_token, @hipchat_options)
+          client[@room_name].send('Chef', [@msg_prefix, msg].join(' '), @msg_options)
         end
       end
     end

data/lib/hipchat/client.rb

@@ -1,5 +1,3 @@
-require 'hipchat/api_version'
-
 module HipChat
 
   class Client
@@ -23,12 +21,12 @@ module HipChat
     end
 
     def [](name)
-      Room.new(@token, { room_id: name }.merge(@options))
+      HipChat::Room.new(@token, { room_id: name, :api_version => @api_version, :server_url => @options[:server_url] })
     end
 
     def create_room(name, options={})
       if @api.version == 'v1' && options[:owner_user_id].nil?
-        raise RoomMissingOwnerUserId, "V1 API Requires owner_user_id"
+        raise RoomMissingOwnerUserId, 'V1 API Requires owner_user_id'
       end
 
       if name.length > 50
@@ -52,14 +50,14 @@ module HipChat
       when 400
         raise UnknownRoom,  "Error: #{response.message}"
       when 401
-        raise Unauthorized, "Access denied"
+        raise Unauthorized, 'Access denied'
       else
         raise UnknownResponseCode, "Unexpected error #{response.code}"
       end
     end
 
     def user(name)
-      User.new(@token, { :user_id => name }.merge(@options))
+      HipChat::User.new(@token, { :user_id => name, :api_version => @api_version, :server_url => @options[:server_url] })
     end
 
     def users
@@ -97,7 +95,7 @@ module HipChat
       case response.code
       when 200
         response[@api.rooms_config[:data_key]].map do |r|
-          Room.new(@token, r.merge(:api_version => @api_version, :room_id => r['id'], :server_url => @options[:server_url]))
+          HipChat::Room.new(@token, r.merge(:api_version => @api_version, :server_url => @options[:server_url]))
         end
       else
         raise UnknownResponseCode, "Unexpected #{response.code} for room"
@@ -114,8 +112,8 @@ module HipChat
       )
       case response.code
       when 200
-        response[@api.users_config[:data_key]].map do |r|
-          User.new(@token, r.merge(:api_version => @api_version, :user_id => r['id']))
+        response[@api.users_config[:data_key]].map do |u|
+          HipChat::User.new(@token, u.merge(:api_version => @api_version, :server_url => @options[:server_url]))
         end
       else
         raise UnknownResponseCode, "Unexpected #{response.code} for user"

data/lib/hipchat/file_helper.rb

@@ -0,0 +1,42 @@
+require 'mimemagic'
+
+module HipChat
+  module FileHelper
+    BOUNDARY = "sendfileboundary"
+
+    private
+
+    #
+    # Builds a multipart file body for the api.
+    #
+    # message - a message to attach
+    # file - a File instance
+    def file_body(message, file)
+      file_name = File.basename(file.path)
+      mime_type = MimeMagic.by_path(file_name)
+      file_content = Base64.encode64(file.read)
+
+      body =  ["--#{BOUNDARY}"]
+      body << 'Content-Type: application/json; charset=UTF-8'
+      body << 'Content-Disposition: attachment; name="metadata"'
+      body << ''
+      body << message
+      body << "--#{BOUNDARY}"
+      body << "Content-Type: #{mime_type}; charset=UTF-8"
+      body << 'Content-Transfer-Encoding: base64'
+      body << %{Content-Disposition: attachment; name="file"; filename="#{file_name}"}
+      body << ''
+      body << file_content
+      body << "--#{BOUNDARY}--"
+      body.join("\n")
+    end
+
+    #
+    # Appends headers require for the multipart body.
+    #
+    # headers - a base headers hash
+    def file_body_headers(headers)
+      headers.merge('Content-Type' => "multipart/related; boundary=#{BOUNDARY}")
+    end
+  end
+end

data/lib/hipchat/rails3_tasks.rb

@@ -42,8 +42,8 @@ namespace :hipchat do
 
     client = HipChat::Client.new(options[:token], options)
 
-    options[:room].each do |r| 
-      client[options[r]].send(options[:user], options[:message], { :color => options[:color], :notify => options[:notify] })
+    options[:room].each do |r|
+      client[r].send(options[:user], options[:message], { :color => options[:color], :notify => options[:notify] })
     end
   end
 end

data/lib/hipchat/room.rb

@@ -5,6 +5,7 @@ module HipChat
 
   class Room < OpenStruct
     include HTTParty
+    include FileHelper
 
     format   :json
 
@@ -18,7 +19,7 @@ module HipChat
     # Retrieve data for this room
     def get_room
       response = self.class.get(@api.get_room_config[:url],
-        :query => {:auth_token => @token },
+        :query => {:auth_token => @token }.merge(@api.get_room_config[:query_params]),
         :headers => @api.headers
       )
 
@@ -37,7 +38,7 @@ module HipChat
     # Update a room
     def update_room(options = {})
       options = {
-        :privacy => "public",
+        :privacy => 'public',
         :is_archived => false,
         :is_guest_accessible => false
       }.merge symbolize(options)
@@ -54,8 +55,6 @@ module HipChat
         }.to_json,
         :headers => @api.headers)
 
-      puts response.body
-
       case response.code
       when 200, 204; true
       when 404
@@ -68,7 +67,7 @@ module HipChat
     end
 
     # Invite user to this room
-    def invite(user, reason="")
+    def invite(user, reason='')
       response = self.class.post(@api.invite_config[:url]+"/#{user}",
         :query => { :auth_token => @token },
         :body => {
@@ -112,7 +111,7 @@ module HipChat
         raise UsernameTooLong, "Username #{from} is `#{from.length} characters long. Limit is 15'"
       end
       options = if options_or_notify == true or options_or_notify == false
-        warn "DEPRECATED: Specify notify flag as an option (e.g., :notify => true)"
+        warn 'DEPRECATED: Specify notify flag as an option (e.g., :notify => true)'
         { :notify => options_or_notify }
       else
         options_or_notify || {}
@@ -144,6 +143,40 @@ module HipChat
       end
     end
 
+    # Send a file to this room.
+    #
+    # Usage:
+    #
+    #   # Default
+    #   send_file 'nickname', 'some message', File.open("/path/to/file")
+    def send_file(from, message, file)
+      if from.length > 15
+        raise UsernameTooLong, "Username #{from} is `#{from.length} characters long. Limit is 15'"
+      end
+
+      response = self.class.post(@api.send_file_config[:url],
+        :query => { :auth_token => @token },
+        :body  => file_body(
+          {
+            :room_id        => room_id,
+            :from           => from,
+            :message        => message,
+          }.send(@api.send_config[:body_format]), file
+        ),
+        :headers => file_body_headers(@api.headers)
+      )
+
+      case response.code
+      when 200, 204; 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
+
     # Change this room's topic
     #
     # Usage:
@@ -197,7 +230,12 @@ module HipChat
     #                (default "JSON")
     def history(options = {})
 
-      options = { :date => 'recent', :timezone => 'UTC', :format => 'JSON' }.merge options
+      options = { 
+        :date => 'recent', 
+        :timezone => 'UTC', 
+        :format => 'JSON', 
+        :'max-results' => 100 
+      }.merge options
 
       response = self.class.get(@api.history_config[:url],
         :query => {
@@ -205,7 +243,8 @@ module HipChat
           :date       => options[:date],
           :timezone   => options[:timezone],
           :format     => options[:format],
-          :auth_token => @token,
+          :'max-results' => options[:'max-results'],
+          :auth_token => @token
         },
         :headers => @api.headers
       )
@@ -253,8 +292,8 @@ module HipChat
         return obj.reduce({}) do |memo, (k, v)|
           memo.tap { |m| m[k.to_sym] = symbolize(v) }
         end if obj.is_a? Hash
-          
-        return obj.reduce([]) do |memo, v| 
+
+        return obj.reduce([]) do |memo, v|
           memo << symbolize(v); memo
         end if obj.is_a? Array
         obj