hipchat 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 87814d532992250965bb8fd683295acd9ed7e8c1
-  data.tar.gz: d0e551de4271ce51a6d60fdac6821b0b7c30f929
+  metadata.gz: 1b54a53da40893dd5e1fbd4d0fafa3f75f00c685
+  data.tar.gz: c5f30c699dda1135934c4085faeefd3c6667a837
 SHA512:
-  metadata.gz: 8cb2ae5a7ddcc189db17a21b09a63739ebf4dbc523ab62be6908ab14120b442f5d7d5dce6fed6ce5f8c77bb0509a401fe49e5b0b2754638089588e136e36fcef
-  data.tar.gz: 6aed60e1f7cb4df9b021cc461e47b9f814ba06c51ae3d2c5fc8a10b528ea0690e2aa468bf569500dc5e9e83973df901113f46543c997248e9b0190c28ebb8c39
+  metadata.gz: a61559bdf4536909fcd9857a0f2afed9eb4ee2baf96cbe69b76a0dd4dce36f6888b7f089759189bce1a13848973c71d42cb49659f26fb75c233a9bbe1e9dbbb0
+  data.tar.gz: cf8f7bed717b1b5854d17b4297d680e324f131ac5d32f1ef8a509ad4fb04882a687fbb6e99156a6edf4530025b7459af5bcb6ccace87f34e5503e7295909c099

data/.gitignore

@@ -13,6 +13,10 @@ tmtags
 ## VIM
 *.swp
 
+## IntelliJ
+*.iml
+.idea
+
 ## PROJECT::GENERAL
 coverage
 rdoc
@@ -32,4 +36,4 @@ test/tmp
 test/version_tmp
 tmp
 
-## PROJECT::SPECIFIC
+## PROJECT::SPECIFIC

data/README.textile

@@ -80,12 +80,19 @@ 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')
 
+# Get statistics from a room
+client['my room'].statistics()
+
 # 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
 
+# Update room data (see https://www.hipchat.com/docs/apiv2/method/update_room)
+It's recommended to call client['my room'].get_room then pass in modified hash attributes to #update_room
+client['my room'].update_room(options = {})
+
 # Invite user to room (see https://www.hipchat.com/docs/apiv2/method/invite_user)
 client['my room'].invite("USER_ID_OR_NAME", options = {})
 
@@ -125,6 +132,10 @@ client.create_room("Name", options = {})
 # Get room data (see https://www.hipchat.com/docs/apiv2/method/get_room)
 client['my room'].get_room
 
+# Update room data (see https://www.hipchat.com/docs/apiv2/method/update_room)
+It's easiest to call client['my room'].get_room, parse the json and then pass in modified hash attributes
+client['my room'].update_room(options = {})
+
 # Invite user to room (see https://www.hipchat.com/docs/apiv2/method/invite_user)
 client['my room'].invite("USER_ID_OR_NAME", options = {})
 
@@ -186,7 +197,7 @@ Options like the room, API token, user name and notification flag can be set in
 RAILS_ROOT/config/hipchat.yml:
 
 bc.. token: "<your token>"
-room: "Your room"
+room: ["Room name(s) or id(s)"] # this is an array
 user: "Your name" # Default to `whoami`
 notify: true # Defaults to false
 api_version: "v2" # optional, defaults to v1
@@ -209,8 +220,11 @@ end
 h2. Chef Handler
 
 *APIv1 ONLY, use APIv1 Key*
+NOTE: APIv2 required for HipChatServer Beta
+
+Report on Chef runs. 
 
-Report on Chef runs. Within a Recipe:
+h3. Within a Recipe:
 
 bc.. include_recipe 'chef_handler'
 
@@ -223,6 +237,18 @@ chef_handler 'HipChat::NotifyRoom' do
                    'hipchat', 'chef.rb')
 end
 
+h3. With client.rb:
+
+bc..    require 'hipchat/chef'
+   hipchat_handler = HipChat::NotifyRoom.new("API_KEY", "HIPCHAT_ROOM")
+   exception_handlers << hipchat_handler
+
+h3. With HipChat Server Beta
+
+Add an "options" hash to set api v2 and your URL:
+* arguments ['API_KEY', 'HIPCHAT_ROOM', options={api_version: "v2", server_url: "https://hipchat.example.com"}]
+* hipchat_handler = HipChat::NotifyRoom.new("API_KEY", "HIPCHAT_ROOM", options={api_version: "v2", server_url: "https://hipchat.example.com"})
+
 h2. Copyright
 
 Copyright (c) 2012 Atlassian. See LICENSE for details.

data/lib/hipchat/api_version.rb

@@ -90,6 +90,16 @@ module HipChat
         }[version]
       end
 
+      def update_room_config
+        {
+          "v2" => {
+            :url => URI::escape("/#{room_id}"),
+            :method => :put,
+            :body_format => :to_json
+          }
+        }[version]
+      end
+
       def invite_config
         {
           'v2' => {
@@ -137,6 +147,14 @@ module HipChat
           }
         }[version]
       end
+
+      def statistics_config
+        {
+          'v2' => {
+            :url => URI::escape("/#{room_id}/statistics")
+          }
+        }[version]
+      end
     end
 
     class User

data/lib/hipchat/chef.rb

@@ -15,11 +15,13 @@ require 'hipchat'
 module HipChat
   class NotifyRoom < Chef::Handler
 
-    def initialize(api_token, room_name, notify_users=false, report_success=false, excluded_envs=[])
+    def initialize(api_token, room_name, options={}, msg_options={}, notify_users=false, report_success=false, excluded_envs=[], msg_prefix='')
       @api_token = api_token
       @room_name = room_name
-      @notify_users = notify_users
+      @options = options
       @report_success = report_success
+      @msg_options = msg_options
+      @msg_options[:notify] = notify_users 
       @excluded_envs = excluded_envs
     end
 
@@ -31,13 +33,13 @@ module HipChat
               else nil
               end
 
-        color = if run_status.success? then 'green'
+        @msg_options[:color]= if run_status.success? then 'green'
                 else 'red'
                 end
 
         if msg
-          client = HipChat::Client.new(@api_token)
-          client[@room_name].send('Chef', msg, :notify => @notify_users, :color => color)
+          client = HipChat::Client.new(@api_token, @options)
+          client[@room_name].send('Chef', [msg_prefix, msg].join(' '), @msg_options)
         end
       end
     end

data/lib/hipchat/client.rb

@@ -118,7 +118,7 @@ module HipChat
           User.new(@token, r.merge(:api_version => @api_version, :user_id => r['id']))
         end
       else
-        raise UnknownResponseCode, "Unexpected #{response.code} for room"
+        raise UnknownResponseCode, "Unexpected #{response.code} for user"
       end
     end
   end

data/lib/hipchat/rails3_tasks.rb

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

data/lib/hipchat/room.rb

@@ -34,6 +34,39 @@ module HipChat
       end
     end
 
+    # Update a room
+    def update_room(options = {})
+      options = {
+        :privacy => "public",
+        :is_archived => false,
+        :is_guest_accessible => false
+      }.merge symbolize(options)
+
+      response = self.class.send(@api.topic_config[:method], @api.update_room_config[:url],
+        :query => { :auth_token => @token },
+        :body => {
+          :name => options[:name],
+          :topic => options[:topic],
+          :privacy => options[:privacy],
+          :is_archived => @api.bool_val(options[:is_archived]),
+          :is_guest_accessible => @api.bool_val(options[:is_guest_accessible]),
+          :owner => options[:owner]
+        }.to_json,
+        :headers => @api.headers)
+
+      puts response.body
+
+      case response.code
+      when 200, 204; true
+      when 404
+        raise Unknown Room, "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
+
     # Invite user to this room
     def invite(user, reason="")
       response = self.class.post(@api.invite_config[:url]+"/#{user}",
@@ -188,5 +221,44 @@ module HipChat
         raise UnknownResponseCode, "Unexpected #{response.code} for room `#{room_id}'"
       end
     end
+
+    # Pull this room's statistics
+    def statistics(options = {})
+
+      response = self.class.get(@api.statistics_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
+
+    private
+      def symbolize(obj)
+        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| 
+          memo << symbolize(v); memo
+        end if obj.is_a? Array
+        obj
+      end
+
   end
 end

data/lib/hipchat/version.rb

@@ -1,3 +1,3 @@
 module HipChat
-  VERSION = "1.3.0"
+  VERSION = "1.4.0"
 end

data/spec/hipchat_api_v2_spec.rb

@@ -54,6 +54,48 @@ describe "HipChat (API V2)" do
     end
   end
 
+  describe "#statistics" do
+    include_context "HipChatV2"
+    it "is successful without custom options" do
+      mock_successful_statistics
+
+      room.statistics().should be_true
+    end
+
+    it "is successful from fetched room" do
+      mock_successful_rooms
+      mock_successful_statistics
+
+      subject.rooms.should be_true
+      subject.rooms.first.statistics.should be_true
+    end
+
+    it "fails when the room doen't exist" do
+      mock(HipChat::Room).get(anything, anything) {
+        OpenStruct.new(:code => 404)
+      }
+
+      lambda { room.statistics }.should raise_error(HipChat::UnknownRoom)
+    end
+
+    it "fails when we're not allowed to do so" do
+      mock(HipChat::Room).get(anything, anything) {
+        OpenStruct.new(:code => 401)
+      }
+
+      lambda { room.statistics }.should raise_error(HipChat::Unauthorized)
+    end
+
+    it "fails if we get an unknown response code" do
+      mock(HipChat::Room).get(anything, anything) {
+        OpenStruct.new(:code => 403)
+      }
+
+      lambda { room.statistics }.
+        should raise_error(HipChat::UnknownResponseCode)
+    end 
+  end
+
   describe "#topic" do
     include_context "HipChatV2"
     it "is successful without custom options" do
@@ -182,6 +224,24 @@ describe "HipChat (API V2)" do
 
   end
 
+  describe "#update_room" do
+    include_context "HipChatV2"
+    let(:room_info) {
+      {
+        "name" => "hipchat",
+        "topic" => "hipchat topic",
+        "privacy" => "public",
+        "is_archived" => false,
+        "is_guest_accessible" => false,
+        "owner" => { "id" => "12345" }
+      }
+    }
+    it "successfully" do 
+      mock_successful_update_room("Hipchat", room_info)
+      room.update_room(room_info).should be_true
+    end
+  end
+
   describe "#invite" do
     include_context "HipChatV2"
 

data/spec/support/shared_contexts_for_hipchat.rb

@@ -112,6 +112,17 @@ shared_context "HipChatV2" do
                                    :format     => options[:format]}).to_return(canned_response)
   end
 
+  def mock_successful_statistics(options={})
+    stub_request(:get, "https://api.hipchat.com/v2/room/Hipchat/statistics").with(:query => {:auth_token => "blah",
+                                   :room_id    => "Hipchat",
+                                   :date       => options[:date],
+                                   :timezone   => options[:timezone],
+                                   :format     => options[:format]}).to_return(
+                                          :status => 200,
+                                          :body => '{"last_active": "2014-09-02T21:33:54+00:00", "links": {"self": "https://api.hipchat.com/v2/room/12345/statistics"},  "messages_sent": 10}',
+                                          :headers => {})
+  end
+
   def mock_successful_room_creation(name, options={})
     stub_request(:post, "https://api.hipchat.com/v2/room").with(
                              :query => {:auth_token => "blah"},
@@ -131,6 +142,24 @@ shared_context "HipChatV2" do
                    'Content-Type' => 'application/json'}).to_return(:status => 200, :body => "{\"id\":\"#{room_id}\"}", :headers => {})
   end
 
+  def mock_successful_update_room(room_id="1234", options={})
+    stub_request(:put, "https://api.hipchat.com/v2/room/#{room_id}").with(
+      :query => {:auth_token => "blah"},
+      :body => {
+        :name => "hipchat",
+        :topic => "hipchat topic",
+        :privacy => "public",
+        :is_archived => false,
+        :is_guest_accessible => false,
+        :owner => { :id => "12345" }
+      }.to_json,
+      :headers => {"Accept" => "application/json",
+                    "Content-Type" => "application/json"}).to_return(
+                    :status => 204,
+                    :body => "", 
+                    :headers => {})
+  end
+
   def mock_successful_invite(options={})
     options = {:user_id => "1234"}.merge(options)
     stub_request(:post, "https://api.hipchat.com/v2/room/Hipchat/invite/#{options[:user_id]}").with(

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hipchat
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - HipChat/Atlassian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-08 00:00:00.000000000 Z
+date: 2014-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty