hipchat-api 1.0.4 → 1.0.5

data/.rspec

@@ -1,2 +1,3 @@
 --colour
 --format doc
+--order random

data/CHANGELOG.md

@@ -1,19 +1,26 @@
-# 1.0.4 (2012-07-16)
+# CHANGELOG
+
+## 1.0.5 (2012-12-04)
+
+* Added `rooms_topic` method to set a room's topic.
+* Added `users_undelete` method to undelete a user.
+
+## 1.0.4 (2012-07-16)
 
 * Change reject! to reject to fix create user issue. Fixes #2. Thanks @bradleybuda.
 
-# 1.0.3 (2012-07-13)
+## 1.0.3 (2012-07-13)
 
 * Add support to the new message_format param when publishing messages to a room. Thanks @rtopitt.
 
-# 1.0.2 (2011-09-09)
+## 1.0.2 (2011-09-09)
 
  * Added missing HipChat API methods: `rooms_create`, `rooms_delete`
  
-# 1.0.1 (2011-05-09)
+## 1.0.1 (2011-05-09)
 
  * Set the default HIPCHAT_API_URL to use https
 
-# 1.0.0 (2011-05-07)
+## 1.0.0 (2011-05-07)
 
  * Initial release

data/README.md

@@ -39,6 +39,7 @@ rooms_delete(room_id)
 rooms_list	
 rooms_history(room_id, date, timezone)	
 rooms_message(room_id, from, message, notify = 0, color = 'yellow', message_format = 'html')  
+rooms_topic(toom_id, topic, from = 'API')
 rooms_show(room_id)  
 ```
   
@@ -48,7 +49,8 @@ rooms_show(room_id)
 users_list  
 users_create(email, name, title, is_group_admin = 0, password = nil, timezone = 'UTC')
 users_delete(user_id)  
-users_show(user_id)  
+users_show(user_id)
+users_undelete(user_id)
 users_update(user_id, email = nil, name = nil, title = nil, is_group_admin = nil, password = nil, timezone = nil)
 ```
   

data/hipchat-api.gemspec

@@ -23,6 +23,6 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency('fakeweb')
   s.add_development_dependency('mocha', '~> 0.11.4')
-  s.add_development_dependency('rspec', '~> 2.7.0')
+  s.add_development_dependency('rspec')
   s.add_development_dependency('rake')
 end

data/lib/hipchat-api.rb

@@ -113,6 +113,17 @@ module HipChat
         :message => message, :notify => notify, :color => color, :message_format => message_format})
     end
 
+    # Set a room's topic. Useful for displaying statistics, important links, server status, you name it! 
+    #
+    # @param room_id [int] ID of the room.
+    # @param topic [String] The topic body. 250 characters max. 
+    # @param from [String, 'API'] Name of the service changing the topic. (default: API).
+    #
+    # @see https://www.hipchat.com/docs/api/method/rooms/topic
+    def rooms_topic(room_id, topic, from = 'API')
+      self.class.post(hipchat_api_url_for('rooms/topic'), :body => {:auth_token => @token, :room_id => room_id, :topic => topic, :from => from})
+    end
+
     # Get room details.
     #
     # @param room_id [int] ID of the room.
@@ -162,6 +173,15 @@ module HipChat
       self.class.get(hipchat_api_url_for('users/show'), :query => {:auth_token => @token, :user_id => user_id})
     end
 
+    # Undelete a user. They will be sent an email requiring them to click a link to reactivate the account. 
+    #
+    # @param user_id [String] ID or email address of the user.
+    #
+    # @see https://www.hipchat.com/docs/api/method/users/undelete
+    def users_undelete(user_id)
+      self.class.post(hipchat_api_url_for('users/undelete'), :body => {:auth_token => @token, :user_id => user_id})
+    end
+
     # Update a user.
     #
     # @param email [String] User's email.

data/lib/hipchat-api/version.rb

@@ -1,5 +1,5 @@
 module HipChat
   class API
-    VERSION = '1.0.4'.freeze
+    VERSION = '1.0.5'.freeze
   end
 end

data/spec/fakeweb/rooms_topic_response.json

@@ -0,0 +1 @@
+{ "status": "ok" }

data/spec/fakeweb/users_undelete_response.json

@@ -0,0 +1 @@
+{ "undeleted": true }

data/spec/hipchat-api_spec.rb

@@ -14,7 +14,7 @@ describe "HipChat::API" do
   end
 
   it "should be the correct version" do
-    HipChat::API::VERSION.should == '1.0.4'
+    HipChat::API::VERSION.should == '1.0.5'
   end
 
   it "should create a new instance with the correct parameters" do
@@ -90,6 +90,17 @@ describe "HipChat::API" do
     rooms_message_response['status'].should == 'sent'
   end
 
+  it "should update a room's topic" do
+    FakeWeb.register_uri(:post,
+                         %r|#{HipChat::API::HIPCHAT_API_URL}/rooms/topic|,
+                         :body => File.join(File.dirname(__FILE__), 'fakeweb', 'rooms_topic_response.json'),
+                         :content_type => "application/json")
+
+    rooms_message_response = @hipchat_api.rooms_topic(10, 'This is a new topic')
+    rooms_message_response.should_not be nil
+    rooms_message_response['status'].should == 'ok'    
+  end
+
   it "should return a history of messages" do
     FakeWeb.register_uri(:get,
                          %r|#{HipChat::API::HIPCHAT_API_URL}/rooms/history|,
@@ -149,6 +160,17 @@ describe "HipChat::API" do
     users_show_response['user']['name'].should == 'Garret Heaton'
   end
 
+  it "should undelete a user" do
+    FakeWeb.register_uri(:post,
+                         %r|#{HipChat::API::HIPCHAT_API_URL}/users/undelete|,
+                         :body => File.join(File.dirname(__FILE__), 'fakeweb', 'users_undelete_response.json'),
+                         :content_type => "application/json")
+
+    users_update_response = @hipchat_api.users_undelete('new-email-address@hipchat.com')
+    users_update_response.should_not be nil
+    users_update_response['undeleted'].should be true
+  end
+
   it "should update a user" do
     FakeWeb.register_uri(:post,
                          %r|#{HipChat::API::HIPCHAT_API_URL}/users/update|,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hipchat-api
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-17 00:00:00.000000000 Z
+date: 2012-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -64,17 +64,17 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.7.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.7.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -117,10 +117,12 @@ files:
 - spec/fakeweb/rooms_list_response.json
 - spec/fakeweb/rooms_message_response.json
 - spec/fakeweb/rooms_show_response.json
+- spec/fakeweb/rooms_topic_response.json
 - spec/fakeweb/users_create_response.json
 - spec/fakeweb/users_delete_response.json
 - spec/fakeweb/users_list_response.json
 - spec/fakeweb/users_show_response.json
+- spec/fakeweb/users_undelete_response.json
 - spec/fakeweb/users_update_response.json
 - spec/hipchat-api_spec.rb
 - spec/spec_helper.rb
@@ -138,7 +140,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1264281140319170135
+      hash: -2445592630498617141
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -147,10 +149,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1264281140319170135
+      hash: -2445592630498617141
 requirements: []
 rubyforge_project: hipchat-api
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Ruby gem for interacting with HipChat
@@ -161,10 +163,12 @@ test_files:
 - spec/fakeweb/rooms_list_response.json
 - spec/fakeweb/rooms_message_response.json
 - spec/fakeweb/rooms_show_response.json
+- spec/fakeweb/rooms_topic_response.json
 - spec/fakeweb/users_create_response.json
 - spec/fakeweb/users_delete_response.json
 - spec/fakeweb/users_list_response.json
 - spec/fakeweb/users_show_response.json
+- spec/fakeweb/users_undelete_response.json
 - spec/fakeweb/users_update_response.json
 - spec/hipchat-api_spec.rb
 - spec/spec_helper.rb