hipchat 1.5.2 → 1.5.3

data/lib/hipchat/user.rb

@@ -19,26 +19,19 @@ module HipChat
     #
     # Send a private message to user.
     #
-    def send(message, message_format='text')
+    def send(message, message_format='text', notify=false)
       response = self.class.post(@api.send_config[:url],
                                  :query => { :auth_token => @token },
                                  :body => {
                                      :message => message,
-                                     :message_format => message_format
+                                     :message_format => message_format,
+                                     :notify => notify
                                  }.send(@api.send_config[:body_format]),
                                  :headers => @api.headers
       )
 
-      case response.code
-      when 200, 204;
-        true
-      when 404
-        raise UnknownUser, "Unknown user: `#{user_id}'"
-      when 401
-        raise Unauthorized, "Access denied to user `#{user_id}'"
-      else
-        raise UnknownResponseCode, "Unexpected #{response.code} for private message to `#{user_id}'"
-      end
+      ErrorHandler.response_code_to_exception_for :user, user_id, response
+      true
     end
 
     #
@@ -51,15 +44,8 @@ module HipChat
         :headers => file_body_headers(@api.headers)
       )
 
-      case response.code
-      when 200, 204; true
-      when 404
-        raise UnknownUser,  "Unknown user: `#{user_id}'"
-      when 401
-        raise Unauthorized, "Access denied to user `#{user_id}'"
-      else
-        raise UnknownResponseCode, "Unexpected #{response.code} for private message to `#{user_id}'"
-      end
+      ErrorHandler.response_code_to_exception_for :user, user_id, response
+      true
     end
 
     #
@@ -71,12 +57,8 @@ module HipChat
                                 :headers => @api.headers
       )
 
-      case response.code
-      when 200
-        User.new(@token, response.merge(:api_version => @api.version))
-      else
-        raise UnknownResponseCode, "Unexpected #{response.code} for view message to `#{user_id}'"
-      end
+      ErrorHandler.response_code_to_exception_for :user, user_id, response
+      User.new(@token, response.merge(:api_version => @api.version))
     end
 
     #
@@ -90,12 +72,30 @@ module HipChat
                                 :headers => @api.headers
       )
 
-      case response.code
-      when 200
-        response.body
-      else
-        raise UnknownResponseCode, "Unexpected #{response.code} for view private message history for `#{user_id}'"
+      ErrorHandler.response_code_to_exception_for :user, user_id, response
+      response.body
+    end
+
+    #
+    # Get private message history
+    #
+    def delete(params = {})
+      case @api.version
+      when 'v1'
+        response = self.class.post(@api.delete_config[:url],
+                                  :query => { :auth_token => @token }.merge(params),
+                                  :headers => @api.headers
+        )
+      when 'v2'
+        response = self.class.delete(@api.delete_config[:url],
+                                  :query => { :auth_token => @token },
+                                  :headers => @api.headers
+        )
       end
+
+      ErrorHandler.response_code_to_exception_for :user, user_id, response
+      true
     end
+
   end
 end

data/lib/hipchat/version.rb

@@ -1,3 +1,3 @@
 module HipChat
-  VERSION = '1.5.2'
+  VERSION = '1.5.3'
 end

data/spec/hipchat_api_v1_spec.rb

@@ -15,8 +15,8 @@ describe "HipChat (API V1)" do
     end
 
     it "is successful with custom options" do
-      mock_successful_history(:timezone => 'America/Los_Angeles', :date => '2010-11-19', :'max-results' => 10, :'start-index' => 10)
-      expect(room.history(:timezone => 'America/Los_Angeles', :date => '2010-11-19', :'max-results' => 10, :'start-index' => 10)).to be_truthy
+      mock_successful_history(:timezone => 'America/Los_Angeles', :date => '2010-11-19', :'max-results' => 10, :'start-index' => 10, :'end-date' => '2010-11-19')
+      expect(room.history(:timezone => 'America/Los_Angeles', :date => '2010-11-19', :'max-results' => 10, :'start-index' => 10, :'end-date' => '2010-11-19')).to be_truthy
     end
 
     it "is successful from fetched room" do
@@ -48,7 +48,7 @@ describe "HipChat (API V1)" do
         OpenStruct.new(:code => 403)
       }
 
-      expect { room.history }.to raise_error(HipChat::UnknownResponseCode)
+      expect { room.history }.to raise_error(HipChat::Unauthorized)
     end
   end
 
@@ -87,7 +87,23 @@ describe "HipChat (API V1)" do
         OpenStruct.new(:code => 403)
       }
 
-      expect { room.topic "" }.to raise_error(HipChat::UnknownResponseCode)
+      expect { room.topic "" }.to raise_error(HipChat::Unauthorized)
+    end
+  end
+
+  describe "#delete_room" do
+    include_context "HipChatV1"
+
+    it "successfully" do
+      mock_successful_delete_room("Hipchat")
+      expect(room.delete_room).to be_truthy
+    end
+
+    it "missing room" do
+      mock_delete_missing_room("Hipchat")
+      expect do
+        room.delete_room
+      end.to raise_exception(HipChat::UnknownRoom)
     end
   end
 
@@ -142,7 +158,7 @@ describe "HipChat (API V1)" do
         OpenStruct.new(:code => 403)
       }
 
-      expect { room.send "", "" }.to raise_error(HipChat::UnknownResponseCode)
+      expect { room.send "", "" }.to raise_error(HipChat::Unauthorized)
     end
   end
 
@@ -166,6 +182,27 @@ describe "HipChat (API V1)" do
     end
   end
 
+  describe "#create_user" do
+    include_context "HipChatV1"
+
+    it "successfully with user name" do
+      mock_successful_user_creation("A User", "email@example.com")
+
+      expect(subject.create_user("A User", "email@example.com")).to be_truthy
+    end
+
+    it "successfully with custom parameters" do
+      mock_successful_user_creation("A User", "email@example.com", {:title => "Super user", :password => "password", :is_group_admin => "true"})
+
+      expect(subject.create_user("A User", "email@example.com", {:title => "Super user", :password => "password", :is_group_admin =>true})).to be_truthy
+    end
+
+    it "but fail is name is longer then 50 char" do
+      expect { subject.create_user("A User that is too long that I should fail right now", "email@example.com") }.
+        to raise_error(HipChat::UsernameTooLong)
+    end
+  end
+
   describe "#send user message" do
     it "fails because API V1 doesn't support user operations" do
 
@@ -173,4 +210,11 @@ describe "HipChat (API V1)" do
         to raise_error(HipChat::InvalidApiVersion)
     end
   end
+
+  describe "#create_webhook"
+  it "fails because API V1 doesn't support webhooks" do
+
+    expect { room.create_webhook('https://example.org/hooks/awesome', 'room_enter') }.
+      to raise_error(HipChat::InvalidApiVersion)
+  end
 end

data/spec/hipchat_api_v2_spec.rb

@@ -16,8 +16,8 @@ describe "HipChat (API V2)" do
     end
 
     it "is successful with custom options" do
-      mock_successful_history(:timezone => 'America/Los_Angeles', :date => '2010-11-19', :'max-results' => 10, :'start-index' => 10)
-      expect(room.history(:timezone => 'America/Los_Angeles', :date => '2010-11-19', :'max-results' => 10, :'start-index' => 10)).to be_truthy
+      mock_successful_history(:timezone => 'America/Los_Angeles', :date => '2010-11-19', :'max-results' => 10, :'start-index' => 10, :'end-date' => '2010-11-19')
+      expect(room.history(:timezone => 'America/Los_Angeles', :date => '2010-11-19', :'max-results' => 10, :'start-index' => 10, :'end-date' => '2010-11-19')).to be_truthy
     end
 
     it "is successful from fetched room" do
@@ -49,7 +49,7 @@ describe "HipChat (API V2)" do
         OpenStruct.new(:code => 403)
       }
 
-      expect { room.history }.to raise_error(HipChat::UnknownResponseCode)
+      expect { room.history }.to raise_error(HipChat::Unauthorized)
     end
   end
 
@@ -90,7 +90,7 @@ describe "HipChat (API V2)" do
         OpenStruct.new(:code => 403)
       }
 
-      expect { room.statistics }.to raise_error(HipChat::UnknownResponseCode)
+      expect { room.statistics }.to raise_error(HipChat::Unauthorized)
     end
   end
 
@@ -129,7 +129,40 @@ describe "HipChat (API V2)" do
           OpenStruct.new(:code => 403)
         }
 
-      expect { room.topic "" }.to raise_error(HipChat::UnknownResponseCode)
+      expect { room.topic "" }.to raise_error(HipChat::Unauthorized)
+    end
+  end
+
+  describe "#send_message" do
+    include_context "HipChatV2"
+    it "successfully without custom options" do
+      mock_successful_send_message 'Hello world'
+
+      expect(room.send_message("Hello world")).to be_truthy
+    end
+
+    it "but fails when the room doesn't exist" do
+      mock(HipChat::Room).post(anything, anything) {
+        OpenStruct.new(:code => 404)
+      }
+
+      expect { room.send_message "" }.to raise_error(HipChat::UnknownRoom)
+    end
+
+    it "but fails when we're not allowed to do so" do
+      mock(HipChat::Room).post(anything, anything) {
+        OpenStruct.new(:code => 401)
+      }
+
+      expect { room.send_message "" }.to raise_error(HipChat::Unauthorized)
+    end
+
+    it "but fails if we get an unknown response code" do
+      mock(HipChat::Room).post(anything, anything) {
+        OpenStruct.new(:code => 403)
+      }
+
+      expect { room.send_message "" }.to raise_error(HipChat::Unauthorized)
     end
   end
 
@@ -153,6 +186,17 @@ describe "HipChat (API V2)" do
       expect(room.send("Dude", "Hello world", :color => 'red')).to be_truthy
     end
 
+    it "successfully creates a card in the room" do
+      card = {
+        :style => 'application',
+        :title => 'My Awesome Card',
+        :id => 12345
+      }
+      mock_successful_send_card 'Dude', 'Hello world', card
+
+      expect(room.send("Dude", "Hello world", :card => card)).to be_truthy
+    end
+
     it "successfully with text message_format" do
       mock_successful_send 'Dude', 'Hello world', :message_format => 'text'
 
@@ -184,7 +228,46 @@ describe "HipChat (API V2)" do
         OpenStruct.new(:code => 403)
       }
 
-      expect { room.send "", "" }.to raise_error(HipChat::UnknownResponseCode)
+      expect { room.send "", "" }.to raise_error(HipChat::Unauthorized)
+    end
+  end
+
+  describe '#share_link' do
+    let(:link) { "http://i.imgur.com/cZ6GDFY.jpg" }
+    include_context "HipChatV2"
+    it "successfully" do
+      mock_successful_link_share 'Dude', 'Sloth love Chunk!', link
+
+      room.share_link("Dude", "Sloth love Chunk!", link).should be_truthy
+    end
+
+    it "but fails when the room doesn't exist" do
+      mock(HipChat::Room).post(anything, anything) {
+        OpenStruct.new(:code => 404)
+      }
+
+      lambda { room.share_link "", "", link }.should raise_error(HipChat::UnknownRoom)
+    end
+
+    it "but fails when we're not allowed to do so" do
+      mock(HipChat::Room).post(anything, anything) {
+        OpenStruct.new(:code => 401)
+      }
+
+      lambda { room.share_link "", "", link }.should raise_error(HipChat::Unauthorized)
+    end
+
+    it "but fails if the username is more than 15 chars" do
+      lambda { room.share_link "a very long username here", "a message", link }.should raise_error(HipChat::UsernameTooLong)
+    end
+
+    it "but fails if we get an unknown response code" do
+      mock(HipChat::Room).post(anything, anything) {
+        OpenStruct.new(:code => 403)
+      }
+
+      lambda { room.share_link "", "", link }.
+        should raise_error(HipChat::Unauthorized)
     end
   end
 
@@ -232,7 +315,7 @@ describe "HipChat (API V2)" do
       }
 
       lambda { room.send_file "", "", file }.
-        should raise_error(HipChat::UnknownResponseCode)
+        should raise_error(HipChat::Unauthorized)
     end
   end
 
@@ -257,6 +340,27 @@ describe "HipChat (API V2)" do
     end
   end
 
+  describe "#create_user" do
+    include_context "HipChatV2"
+
+    it "successfully with user name" do
+      mock_successful_user_creation("A User", "email@example.com")
+
+      expect(subject.create_user("A User", "email@example.com")).to be_truthy
+    end
+
+    it "successfully with custom parameters" do
+      mock_successful_user_creation("A User", "email@example.com", {:title => "Super user", :password => "password", :is_group_admin => true})
+
+      expect(subject.create_user("A User", "email@example.com", {:title => "Super user", :password => "password", :is_group_admin =>true})).to be_truthy
+    end
+
+    it "but fail is name is longer then 50 char" do
+      expect { subject.create_user("A User that is too long that I should fail right now", "email@example.com") }.
+        to raise_error(HipChat::UsernameTooLong)
+    end
+  end
+
   describe "#get_room" do
     include_context "HipChatV2"
 
@@ -286,6 +390,22 @@ describe "HipChat (API V2)" do
     end
   end
 
+  describe "#delete_room" do
+    include_context "HipChatV2"
+
+    it "successfully" do
+      mock_successful_delete_room("Hipchat",)
+      expect(room.delete_room).to be_truthy
+    end
+
+    it "missing room" do
+      mock_delete_missing_room("Hipchat")
+      expect do
+        room.delete_room
+      end.to raise_exception(HipChat::UnknownRoom)
+    end
+  end
+
   describe "#invite" do
     include_context "HipChatV2"
 
@@ -302,6 +422,22 @@ describe "HipChat (API V2)" do
     end
   end
 
+  describe "#add_member" do
+    include_context "HipChatV2"
+
+    it "successfully with user_id" do
+      mock_successful_add_member()
+
+      expect(room.add_member("1234")).to be_truthy
+    end
+
+    it "successfully with custom parameters" do
+      mock_successful_add_member({:user_id => "321", :room_roles => ["room_admin","room_member"]})
+
+      expect(room.add_member("321", ["room_admin","room_member"])).to be_truthy
+    end
+  end
+
   describe "#send user message" do
     include_context "HipChatV2"
     it "successfully with a standard message" do
@@ -372,4 +508,152 @@ describe "HipChat (API V2)" do
       lambda { user.send_file "", file }.should raise_error(HipChat::Unauthorized)
     end
   end
+
+  describe '#create_webhook' do
+    include_context "HipChatV2"
+
+    it "successfully with a valid room, url and event" do
+      mock_successful_create_webhook('Hipchat', 'https://example.org/hooks/awesome', 'room_enter')
+
+      expect(room.create_webhook('https://example.org/hooks/awesome', 'room_enter')).to be_truthy
+    end
+
+    it "but fails when the room doesn't exist" do
+      mock(HipChat::Room).post(anything, anything) {
+        OpenStruct.new(:code => 404)
+      }
+
+      lambda { room.create_webhook('https://example.org/hooks/awesome', 'room_enter') }.should raise_error(HipChat::UnknownRoom)
+    end
+
+    it "but fails when we're not allowed to do so" do
+      mock(HipChat::Room).post(anything, anything) {
+        OpenStruct.new(:code => 401)
+      }
+
+      lambda { room.create_webhook('https://example.org/hooks/awesome', 'room_enter') }.should raise_error(HipChat::Unauthorized)
+    end
+
+    it "but fails if the url is invalid" do
+      lambda { room.create_webhook('foo://bar.baz/', 'room_enter') }.should raise_error(HipChat::InvalidUrl)
+    end
+
+    it "but fails if the event is invalid" do
+      lambda { room.create_webhook('https://example.org/hooks/awesome', 'room_vandalize') }.should raise_error(HipChat::InvalidEvent)
+    end
+
+    it "but fails if we get an unknown response code" do
+      mock(HipChat::Room).post(anything, anything) {
+        OpenStruct.new(:code => 403)
+      }
+
+      lambda { room.create_webhook('https://example.org/hooks/awesome', 'room_enter') }.
+        should raise_error(HipChat::Unauthorized)
+    end
+  end
+
+  describe '#delete_webhook' do
+    include_context "HipChatV2"
+
+    it "successfully deletes a webhook with a valid webhook id" do
+      mock_successful_delete_webhook('Hipchat', 'my_awesome_webhook')
+
+      expect(room.delete_webhook('my_awesome_webhook')).to be_truthy
+    end
+
+    it "but fails when the webhook doesn't exist" do
+      mock(HipChat::Room).delete(anything, anything) {
+        OpenStruct.new(:code => 404)
+      }
+
+      lambda { room.delete_webhook('my_awesome_webhook') }.should raise_error(HipChat::UnknownWebhook)
+    end
+
+    it "but fails when we're not allowed to do so" do
+      mock(HipChat::Room).delete(anything, anything) {
+        OpenStruct.new(:code => 401)
+      }
+
+      lambda { room.delete_webhook('my_awesome_webhook') }.should raise_error(HipChat::Unauthorized)
+    end
+
+    it "but fails if we get an unknown response code" do
+      mock(HipChat::Room).delete(anything, anything) {
+        OpenStruct.new(:code => 403)
+      }
+
+      lambda { room.delete_webhook('my_awesome_webhook') }.
+        should raise_error(HipChat::Unauthorized)
+    end
+  end
+
+  describe '#get_all_webhooks' do
+    include_context "HipChatV2"
+
+    it "successfully lists webhooks with a valid room id" do
+      mock_successful_get_all_webhooks('Hipchat')
+
+      expect(room.get_all_webhooks).to be_truthy
+    end
+
+    it "but fails when the room doesn't exist" do
+      mock(HipChat::Room).get(anything, anything) {
+        OpenStruct.new(:code => 404)
+      }
+
+      lambda { room.get_all_webhooks }.should raise_error(HipChat::UnknownRoom)
+    end
+
+    it "but fails when we're not allowed to do so" do
+      mock(HipChat::Room).get(anything, anything) {
+        OpenStruct.new(:code => 401)
+      }
+
+      lambda { room.get_all_webhooks }.should raise_error(HipChat::Unauthorized)
+    end
+
+    it "but fails if we get an unknown response code" do
+      mock(HipChat::Room).get(anything, anything) {
+        OpenStruct.new(:code => 403)
+      }
+
+      lambda { room.get_all_webhooks }.
+        should raise_error(HipChat::Unauthorized)
+    end
+  end
+
+  describe '#get_webhook' do
+    include_context "HipChatV2"
+
+    it "successfully gets webhook info with valid room and webhook ids" do
+      mock_successful_get_webhook('Hipchat', '5678')
+
+      expect(room.get_webhook('5678')).to be_truthy
+    end
+
+    it "but fails when the webhook doesn't exist" do
+      mock(HipChat::Room).get(anything, anything) {
+        OpenStruct.new(:code => 404)
+      }
+
+      lambda { room.get_webhook('5678') }.should raise_error(HipChat::UnknownWebhook)
+    end
+
+    it "but fails when we're not allowed to do so" do
+      mock(HipChat::Room).get(anything, anything) {
+        OpenStruct.new(:code => 401)
+      }
+
+      lambda { room.get_webhook('5678') }.should raise_error(HipChat::Unauthorized)
+    end
+
+    it "but fails if we get an unknown response code" do
+      mock(HipChat::Room).get(anything, anything) {
+        OpenStruct.new(:code => 403)
+      }
+
+      lambda { room.get_webhook('5678') }.
+        should raise_error(HipChat::Unauthorized)
+    end
+  end
 end