hipchat 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9cdd550f65e0e012c7111c61836744d879ddbf90
-  data.tar.gz: ee465ca047742841fc8d640a182480e22df302e0
+  metadata.gz: b2ec52d652412c7540c45f243508e99f5a155ec1
+  data.tar.gz: 0082b930a02ab0a0fac1d46d7181a7cd64202634
 SHA512:
-  metadata.gz: a75f6ad13c8ea975899a5307e465d210332d645d809e63fef60e60110074309d25abc873b4b5d574fcf1873f77dab38cf2127b3cf2508e67c57d544f9a3ee8ff
-  data.tar.gz: 06150b37bfdc38a204b90eb6eb4d5f25ab4eb4d43008799a8af6aebe602e170a16ec79e8ac6f67d4ede652ae0298d6de5455c0f2ab73f2f391071e3979a950cf
+  metadata.gz: 0470720c384fce9a0403b3df9fc930b98cd1047d496b783a62cb0fbbec8999bdd4998db5f76153f366450ffc91e2ec48f2a44cfaeb8181c9ebcf47d11dbc9fac
+  data.tar.gz: 82098108cb71cffb51993058336b39072da7154ae8a579e7077365dc98a1dc6c22671a29f817f0fed68f8d5dd1bf60056ec44924a4b016a94ff6febb926e874e

data/.ruby-gemset

@@ -0,0 +1 @@
+hipchat-rb

data/.ruby-version

@@ -0,0 +1 @@
+2.1.0

data/.travis.yml

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

data/README.textile

@@ -40,6 +40,9 @@ 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, V1 requires owner_user_id (see https://www.hipchat.com/docs/api/method/rooms/create)
+client.create_room("Name", :owner_user_id => 'user_id')
+
 h2. "API v2":https://www.hipchat.com/docs/apiv2
 
 bc.. client = HipChat::Client.new(api_token, :api_version => 'v2')
@@ -67,6 +70,18 @@ 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
 
 *APIv1 ONLY, use APIv1 Key*
@@ -96,6 +111,15 @@ To determine the user that is currently running the deploy, the capistrano tasks
 # The git user.name var.
 # The $USER environment variable.
 
+h3. Commit log notification (only for Capistrano 2)
+
+Send commit log with deploy notification. We currently support git and svn.
+
+bc.. set :hipchat_commit_log, true
+# Optional
+set :hipchat_commit_log_format, ":time :user\n:message\n"
+set :hipchat_commit_log_time_format, "%Y/%m/%d %H:%M:%S"
+
 h2. Rails 3 Rake Task
 
 Send a message using a rake task:
@@ -138,7 +162,7 @@ h2. Chef Handler
 Report on Chef runs. Within a Recipe:
 
 bc.. include_recipe 'chef_handler'
-  
+
 gem_package 'hipchat'
 
 chef_handler 'HipChat::NotifyRoom' do

data/lib/hipchat.rb

@@ -1,211 +1,9 @@
-require 'httparty'
-require 'ostruct'
-
 require 'hipchat/railtie' if defined?(Rails::Railtie)
 require "hipchat/version"
-require 'hipchat/api_version'
 
 module HipChat
-  class UnknownRoom         < StandardError; end
-  class Unauthorized        < StandardError; end
-  class UnknownResponseCode < StandardError; end
-  class UsernameTooLong < StandardError; end
-
-  class Client
-    include HTTParty
-
-    format :json
-
-    def initialize(token, options={})
-      @token = token
-      @api_version = options[:api_version]
-      @api = HipChat::ApiVersion::Client.new(@api_version)
-      self.class.base_uri(@api.base_uri)
-      http_proxy = options[:http_proxy] || ENV['http_proxy']
-      setup_proxy(http_proxy) if http_proxy
-    end
-
-    def rooms
-      @rooms ||= _rooms
-    end
-
-    def [](name)
-      Room.new(@token, :room_id => name, :api_version => @api_version)
-    end
-
-    private
-    def setup_proxy(proxy_url)
-      proxy_url = URI.parse(proxy_url)
-
-      self.class.http_proxy(proxy_url.host, proxy_url.port,
-                            proxy_url.user, proxy_url.password)
-      HipChat::Room.http_proxy(proxy_url.host, proxy_url.port,
-                               proxy_url.user, proxy_url.password)
-    end
-
-    def _rooms
-      response = self.class.get(@api.rooms_config[:url],
-        :query => {
-          :auth_token => @token
-        }, 
-        :headers => @api.headers
-      )
-      case response.code
-      when 200
-        response[@api.rooms_config[:data_key]].map do |r|
-          Room.new(@token, r.merge(:api_version => @api_version))
-        end
-      else
-        raise UnknownResponseCode, "Unexpected #{response.code} for room `#{room_id}'"
-      end
-    end
-  end
-
-  class Room < OpenStruct
-    include HTTParty
-
-    format   :json
-
-    def initialize(token, params)
-      @token = token
-      @api = HipChat::ApiVersion::Room.new(params[:room_id],
-                                           params.delete(:api_version))
-      self.class.base_uri(@api.base_uri)
-      super(params)
-    end
-
-    # 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 = {})
-      if from.length > 15
-        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)"
-        { :notify => options_or_notify }
-      else
-        options_or_notify || {}
-      end
-
-      options = { :color => 'yellow', :notify => false }.merge options
-
-      response = self.class.post(@api.send_config[:url],
-        :query => { :auth_token => @token },
-        :body  => {
-          :room_id        => room_id,
-          :from           => from,
-          :message        => message,
-          :message_format => options[:message_format] || 'html',
-          :color          => options[:color],
-          :notify         => @api.bool_val(options[:notify])
-        }.send(@api.send_config[:body_format]),
-        :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:
-    #
-    #   # Default
-    #   topic 'my awesome topic'
-    #
-    # Options:
-    #
-    # +from+::  the name of the person changing the topic
-    #            (default "API")
-    def topic(new_topic, options = {})
-
-      options = { :from => 'API' }.merge options
-
-      response = self.class.send(@api.topic_config[:method], @api.topic_config[:url],
-        :query => { :auth_token => @token },
-        :body  => {
-          :room_id        => room_id,
-          :from           => options[:from],
-          :topic          => new_topic
-        }.send(@api.topic_config[:body_format]),
-        :headers => @api.headers
-      )
-
-      case response.code
-      when 204,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
-
-    # Pull this room's history
-    #
-    # Usage
-    #
-    #   # Default
-    #
-    #
-    # Options
-    #
-    # +date+::     Whether to return a specific day (YYYY-MM-DD format) or recent
-    #                (default "recent")
-    # +timezone+:: Your timezone.  Supported timezones are at: https://www.hipchat.com/docs/api/timezones
-    #                (default "UTC")
-    # +format+::   Format to retrieve the history in.  Valid options are JSON and XML
-    #                (default "JSON")
-    def history(options = {})
-
-      options = { :date => 'recent', :timezone => 'UTC', :format => 'JSON' }.merge options
-
-      response = self.class.get(@api.history_config[:url],
-        :query => {
-          :room_id    => room_id,
-          :date       => options[:date],
-          :timezone   => options[:timezone],
-          :format     => options[:format],
-          :auth_token => @token,
-        },
-        :headers => @api.headers
-      )
-
-      case response.code
-      when 200
-        response.body
-      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
+  require 'hipchat/errors'
+  require 'hipchat/room'
+  require 'hipchat/client'
+  require 'hipchat/user'
 end

data/lib/hipchat/api_version.rb

@@ -1,16 +1,26 @@
+require 'uri'
+
 module HipChat
   class ApiVersion
 
-    class Client
+    def bool_val(opt)
+      if version.eql?('v1')
+        opt ? 1 : 0
+      else
+        opt
+      end
+    end
+
+    class Client < ApiVersion
 
       def initialize(version = 'v1')
         @version = !version.nil? ? version : 'v1'
         if @version.eql?('v1')
-          @base_uri = "https://api.hipchat.com/v1/rooms"
+          @base_uri = "https://api.hipchat.com/v1"
           @headers = {'Accept' => 'application/json',
              'Content-Type' => 'application/x-www-form-urlencoded'}
         else
-          @base_uri = "https://api.hipchat.com/v2/room"
+          @base_uri = "https://api.hipchat.com/v2"
           @headers = {'Accept' => 'application/json',
              'Content-Type' => 'application/json'}
         end
@@ -21,7 +31,7 @@ module HipChat
       def rooms_config
         {
           'v1' => {
-            :url => '/list',
+            :url => '/rooms/list',
             :data_key => 'rooms'
           },
           'v2' => {
@@ -30,9 +40,30 @@ module HipChat
           }
         }[version]
       end
+
+
+      def create_room_config
+        {
+          'v1' => {
+            :url => '/rooms/create',
+            :body_format => :to_hash
+          },
+          'v2' => {
+            :url => '/room',
+            :body_format => :to_json
+          }
+        }[version]
+      end
+
+      def users_config
+        {
+          :url => '/user',
+          :data_key => 'items'
+        }
+      end
     end
 
-    class Room
+    class Room < ApiVersion
 
       def initialize(room_id, version = 'v1')
         @room_id = room_id
@@ -50,6 +81,23 @@ module HipChat
 
       attr_reader :version, :base_uri, :room_id, :headers
 
+      def get_room_config
+        {
+          'v2' => {
+            :url => URI::escape("/#{room_id}")
+          }
+        }[version]
+      end
+
+      def invite_config
+        {
+          'v2' => {
+            :url => URI::escape("/#{room_id}/invite"),
+            :body_format => :to_json
+          }
+        }[version]
+      end
+
       def send_config
         {
           'v1' => {
@@ -57,7 +105,7 @@ module HipChat
             :body_format => :to_hash
           },
           'v2' => {
-            :url => "/#{room_id}/notification",
+            :url => URI::escape("/#{room_id}/notification"),
             :body_format => :to_json
           }
         }[version]
@@ -71,7 +119,7 @@ module HipChat
             :body_format => :to_hash
           },
           'v2' => {
-            :url => "/#{room_id}/topic",
+            :url => URI::escape("/#{room_id}/topic"),
             :method => :put,
             :body_format => :to_json
           }
@@ -84,19 +132,37 @@ module HipChat
             :url => '/history'
           },
           'v2' => {
-            :url => "/#{room_id}/history"
+            :url => URI::escape("/#{room_id}/history")
           }
         }[version]
       end
+    end
 
-      def bool_val(opt)
-        if version.eql?('v1')
-          opt ? 1 : 0
-        else
-          opt
-        end
+    class User
+
+      def initialize(user_id, version)
+        @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"
+        @headers = {'Accept' => 'application/json',
+          'Content-Type' => 'application/json'}
       end
 
+      attr_reader :version, :base_uri, :user_id, :headers
+
+      def send_config
+        {
+          :url => URI::escape("/#{user_id}/message"),
+          :body_format => :to_json
+        }
+      end
+
+      def view_config
+        {
+          :url => URI::escape("/#{user_id}"),
+          :body_format => :to_json
+        }
+      end
     end
   end
 end

data/lib/hipchat/capistrano2.rb

@@ -39,6 +39,12 @@ Capistrano::Configuration.instance(:must_exist).load do
           environment_string = "#{stage} (#{env})"
         end
 
+        if fetch(:hipchat_commit_log, false)
+          logs = commit_logs
+          unless logs.empty?
+            send(logs.join("\n"), send_options)
+          end
+        end
         send("#{human} finished deploying #{deployment_name} to #{environment_string}#{fetch(:hipchat_with_migrations, '')}.", send_options)
       end
     end
@@ -123,9 +129,43 @@ Capistrano::Configuration.instance(:must_exist).load do
     end
   end
 
+  def commit_logs
+    from = (previous_revision rescue nil)
+    to   = (latest_revision rescue nil)
+
+    log_hashes = []
+    case scm.to_s
+    when 'git'
+      logs = run_locally(source.local.scm(:log, "--no-merges --pretty=format:'%H$$%at$$%an$$%s' #{from}..#{to}"))
+      logs.split(/\n/).each do |log|
+        ll = log.split(/\$\$/)
+        log_hashes << {revision: ll[0], time: Time.at(ll[1].to_i), user: ll[2], message: ll[3]}
+      end
+    when 'svn'
+      logs = run_locally(source.local.scm(:log, "--non-interactive -r #{from}:#{to}"))
+      logs.scan(/^[-]+$\n\s*(?<revision>[^\|]+)\s+\|\s+(?<user>[^\|]+)\s+\|\s+(?<time>[^\|]+)\s+.*\n+^\s*(?<message>.*)\s*$\n/) do |m|
+        h = Regexp.last_match
+        log_hashes << {revision: h[:revision], time: Time.parse(h[:time]), user: h[:user], message: h[:message]}
+      end
+    else
+      puts "We haven't supported this scm yet."
+      return []
+    end
+
+    format = fetch(:hipchat_commit_log_format, ":time :user\n:message\n")
+    time_format = fetch(:hipchat_commit_log_time_format, "%Y/%m/%d %H:%M:%S")
+
+    log_hashes.map do |log_hash|
+      log_hash[:time] &&= log_hash[:time].localtime.strftime(time_format)
+      log_hash.inject(format) do |l, (k, v)|
+        l.gsub(/:#{k}/, v.to_s)
+      end
+    end
+  end
+
   before "deploy", "hipchat:trigger_notification"
   before "deploy:migrations", "hipchat:trigger_notification", "hipchat:configure_for_migrations"
   before "deploy:update_code", "hipchat:notify_deploy_started"
   after  "deploy", "hipchat:notify_deploy_finished"
   after  "deploy:migrations", "hipchat:notify_deploy_finished"
-end
+end