hipchat 1.4.0 → 1.5.0

data/lib/hipchat/user.rb

@@ -5,13 +5,13 @@ module HipChat
 
   class User < OpenStruct
     include HTTParty
+    include FileHelper
 
-    format   :json
+    format :json
 
     def initialize(token, params)
       @token = token
-      @api = HipChat::ApiVersion::User.new(params[:user_id],
-                                           params)
+      @api = HipChat::ApiVersion::User.new(params)
       self.class.base_uri(@api.base_uri)
       super(params)
     end
@@ -19,13 +19,36 @@ module HipChat
     #
     # Send a private message to user.
     #
-    def send(message)
+    def send(message, message_format='text')
       response = self.class.post(@api.send_config[:url],
+                                 :query => { :auth_token => @token },
+                                 :body => {
+                                     :message => message,
+                                     :message_format => message_format
+                                 }.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
+    end
+
+    #
+    # Send a private file to user.
+    #
+    def send_file(message, file)
+      response = self.class.post(@api.send_file_config[:url],
         :query => { :auth_token => @token },
-        :body  => {
-          :message => message
-        }.send(@api.send_config[:body_format]),
-        :headers => @api.headers
+        :body => file_body({ :message => message }.send(@api.send_config[:body_format]), file),
+        :headers => file_body_headers(@api.headers)
       )
 
       case response.code
@@ -43,18 +66,36 @@ module HipChat
     # Get a user's details.
     #
     def view
-      puts "#{@api.base_uri}#{@api.view_config[:url]}"
       response = self.class.get(@api.view_config[:url],
-        :query => { :auth_token => @token },
-        :headers => @api.headers
+                                :query => { :auth_token => @token }.merge(@api.view_config[:query_params]),
+                                :headers => @api.headers
       )
 
       case response.code
       when 200
-        User.new(@token, response.merge(:api_version => 'v2'))
+        User.new(@token, response.merge(:api_version => @api.version))
       else
         raise UnknownResponseCode, "Unexpected #{response.code} for view message to `#{user_id}'"
       end
     end
+
+    #
+    # Get private message history
+    #
+    def history(params = {})
+      params.select! { |key, _value| @api.history_config[:allowed_params].include? key }
+
+      response = self.class.get(@api.history_config[:url],
+                                :query => { :auth_token => @token }.merge(params),
+                                :headers => @api.headers
+      )
+
+      case response.code
+      when 200
+        response.body
+      else
+        raise UnknownResponseCode, "Unexpected #{response.code} for view private message history for `#{user_id}'"
+      end
+    end
   end
 end

data/lib/hipchat/version.rb

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

data/spec/hipchat_api_v1_spec.rb

@@ -11,20 +11,20 @@ describe "HipChat (API V1)" do
     it "is successful without custom options" do
       mock_successful_history()
 
-      room.history().should be_true
+      expect(room.history()).to be_truthy
     end
 
     it "is successful with custom options" do
-      mock_successful_history(:timezone => 'America/Los_Angeles', :date => '2010-11-19')
-      room.history(:timezone => 'America/Los_Angeles', :date => '2010-11-19').should be_true
+      mock_successful_history(:timezone => 'America/Los_Angeles', :date => '2010-11-19', :'max-results' => 10)
+      expect(room.history(:timezone => 'America/Los_Angeles', :date => '2010-11-19', :'max-results' => 10)).to be_truthy
     end
 
     it "is successful from fetched room" do
       mock_successful_rooms
       mock_successful_history
 
-      subject.rooms.should be_true
-      subject.rooms.first.history.should be_true
+      expect(subject.rooms).to be_truthy
+      expect(subject.rooms.first.history).to be_truthy
     end
 
     it "fails when the room doen't exist" do
@@ -32,7 +32,7 @@ describe "HipChat (API V1)" do
         OpenStruct.new(:code => 404)
       }
 
-      lambda { room.history }.should raise_error(HipChat::UnknownRoom)
+      expect { room.history }.to raise_error(HipChat::UnknownRoom)
     end
 
     it "fails when we're not allowed to do so" do
@@ -40,7 +40,7 @@ describe "HipChat (API V1)" do
         OpenStruct.new(:code => 401)
       }
 
-      lambda { room.history }.should raise_error(HipChat::Unauthorized)
+      expect { room.history }.to raise_error(HipChat::Unauthorized)
     end
 
     it "fails if we get an unknown response code" do
@@ -48,8 +48,7 @@ describe "HipChat (API V1)" do
         OpenStruct.new(:code => 403)
       }
 
-      lambda { room.history }.
-        should raise_error(HipChat::UnknownResponseCode)
+      expect { room.history }.to raise_error(HipChat::UnknownResponseCode)
     end
   end
 
@@ -58,13 +57,13 @@ describe "HipChat (API V1)" do
     it "is successful without custom options" do
       mock_successful_topic_change("Nice topic")
 
-      room.topic("Nice topic").should be_true
+      expect(room.topic("Nice topic")).to be_truthy
     end
 
     it "is successful with a custom from" do
       mock_successful_topic_change("Nice topic", :from => "Me")
 
-      room.topic("Nice topic", :from => "Me").should be_true
+      expect(room.topic("Nice topic", :from => "Me")).to be_truthy
     end
 
     it "fails when the room doesn't exist" do
@@ -72,7 +71,7 @@ describe "HipChat (API V1)" do
         OpenStruct.new(:code => 404)
       }
 
-      lambda { room.topic "" }.should raise_error(HipChat::UnknownRoom)
+      expect { room.topic "" }.to raise_error(HipChat::UnknownRoom)
     end
 
     it "fails when we're not allowed to do so" do
@@ -80,7 +79,7 @@ describe "HipChat (API V1)" do
         OpenStruct.new(:code => 401)
       }
 
-      lambda { room.topic "" }.should raise_error(HipChat::Unauthorized)
+      expect { room.topic "" }.to raise_error(HipChat::Unauthorized)
     end
 
     it "fails if we get an unknown response code" do
@@ -88,8 +87,7 @@ describe "HipChat (API V1)" do
         OpenStruct.new(:code => 403)
       }
 
-      lambda { room.topic "" }.
-        should raise_error(HipChat::UnknownResponseCode)
+      expect { room.topic "" }.to raise_error(HipChat::UnknownResponseCode)
     end
   end
 
@@ -98,25 +96,25 @@ describe "HipChat (API V1)" do
     it "successfully without custom options" do
       mock_successful_send 'Dude', 'Hello world'
 
-      room.send("Dude", "Hello world").should be_true
+      expect(room.send("Dude", "Hello world")).to be_truthy
     end
 
     it "successfully with notifications on as option" do
       mock_successful_send 'Dude', 'Hello world', :notify => 1
 
-      room.send("Dude", "Hello world", :notify => 1).should be_true
+      expect(room.send("Dude", "Hello world", :notify => 1)).to be_truthy
     end
 
     it "successfully with custom color" do
       mock_successful_send 'Dude', 'Hello world', :color => 'red'
 
-      room.send("Dude", "Hello world", :color => 'red').should be_true
+      expect(room.send("Dude", "Hello world", :color => 'red')).to be_truthy
     end
 
     it "successfully with text message_format" do
       mock_successful_send 'Dude', 'Hello world', :message_format => 'text'
 
-      room.send("Dude", "Hello world", :message_format => 'text').should be_true
+      expect(room.send("Dude", "Hello world", :message_format => 'text')).to be_truthy
     end
 
     it "but fails when the room doesn't exist" do
@@ -124,7 +122,7 @@ describe "HipChat (API V1)" do
         OpenStruct.new(:code => 404)
       }
 
-      lambda { room.send "", "" }.should raise_error(HipChat::UnknownRoom)
+      expect { room.send "", "" }.to raise_error(HipChat::UnknownRoom)
     end
 
     it "but fails when we're not allowed to do so" do
@@ -132,11 +130,11 @@ describe "HipChat (API V1)" do
         OpenStruct.new(:code => 401)
       }
 
-      lambda { room.send "", "" }.should raise_error(HipChat::Unauthorized)
+      expect { room.send "", "" }.to raise_error(HipChat::Unauthorized)
     end
 
     it "but fails if the username is more than 15 chars" do
-      lambda { room.send "a very long username here", "a message" }.should raise_error(HipChat::UsernameTooLong)
+      expect { room.send "a very long username here", "a message" }.to raise_error(HipChat::UsernameTooLong)
     end
 
     it "but fails if we get an unknown response code" do
@@ -144,8 +142,7 @@ describe "HipChat (API V1)" do
         OpenStruct.new(:code => 403)
       }
 
-      lambda { room.send "", "" }.
-        should raise_error(HipChat::UnknownResponseCode)
+      expect { room.send "", "" }.to raise_error(HipChat::UnknownResponseCode)
     end
   end
 
@@ -155,26 +152,25 @@ describe "HipChat (API V1)" do
     it "successfully with room name" do
       mock_successful_room_creation("A Room", :owner_user_id => "123456")
 
-      subject.create_room("A Room", {:owner_user_id => "123456"}).should be_true
+      expect(subject.create_room("A Room", {:owner_user_id => "123456"})).to be_truthy
     end
 
     it "successfully with custom parameters" do
       mock_successful_room_creation("A Room", {:owner_user_id => "123456", :privacy => "private", :guest_access => "1"})
 
-      subject.create_room("A Room", {:owner_user_id => "123456", :privacy => "private", :guest_access =>true}).should be_true
+      expect(subject.create_room("A Room", {:owner_user_id => "123456", :privacy => "private", :guest_access =>true})).to be_truthy
     end
 
     it "but fails if we dont pass owner_user_id" do
-      lambda { subject.create_room("A Room", {:privacy => "private", :guest_access =>true}) }.
-        should raise_error(HipChat::RoomMissingOwnerUserId)
+      expect { subject.create_room("A Room", {:privacy => "private", :guest_access =>true}) }.to raise_error(HipChat::RoomMissingOwnerUserId)
     end
   end
 
   describe "#send user message" do
     it "fails because API V1 doesn't support user operations" do
 
-      lambda { HipChat::Client.new("blah", :api_version => @api_version).user('12345678') }.
-        should raise_error(HipChat::InvalidApiVersion)
+      expect { HipChat::Client.new("blah", :api_version => @api_version).user('12345678').send('nope') }.
+        to raise_error(HipChat::InvalidApiVersion)
     end
   end
 end

data/spec/hipchat_api_v2_spec.rb

@@ -12,20 +12,20 @@ describe "HipChat (API V2)" do
     it "is successful without custom options" do
       mock_successful_history()
 
-      room.history().should be_true
+      expect(room.history()).to be_truthy
     end
 
     it "is successful with custom options" do
-      mock_successful_history(:timezone => 'America/Los_Angeles', :date => '2010-11-19')
-      room.history(:timezone => 'America/Los_Angeles', :date => '2010-11-19').should be_true
+      mock_successful_history(:timezone => 'America/Los_Angeles', :date => '2010-11-19', :'max-results' => 10)
+      expect(room.history(:timezone => 'America/Los_Angeles', :date => '2010-11-19', :'max-results' => 10)).to be_truthy
     end
 
     it "is successful from fetched room" do
       mock_successful_rooms
       mock_successful_history
 
-      subject.rooms.should be_true
-      subject.rooms.first.history.should be_true
+      expect(subject.rooms).to be_truthy
+      expect(subject.rooms.first.history).to be_truthy
     end
 
     it "fails when the room doen't exist" do
@@ -33,7 +33,7 @@ describe "HipChat (API V2)" do
         OpenStruct.new(:code => 404)
       }
 
-      lambda { room.history }.should raise_error(HipChat::UnknownRoom)
+      expect { room.history }.to raise_error(HipChat::UnknownRoom)
     end
 
     it "fails when we're not allowed to do so" do
@@ -41,7 +41,7 @@ describe "HipChat (API V2)" do
         OpenStruct.new(:code => 401)
       }
 
-      lambda { room.history }.should raise_error(HipChat::Unauthorized)
+      expect { room.history }.to raise_error(HipChat::Unauthorized)
     end
 
     it "fails if we get an unknown response code" do
@@ -49,8 +49,7 @@ describe "HipChat (API V2)" do
         OpenStruct.new(:code => 403)
       }
 
-      lambda { room.history }.
-        should raise_error(HipChat::UnknownResponseCode)
+      expect { room.history }.to raise_error(HipChat::UnknownResponseCode)
     end
   end
 
@@ -59,15 +58,15 @@ describe "HipChat (API V2)" do
     it "is successful without custom options" do
       mock_successful_statistics
 
-      room.statistics().should be_true
+      expect(room.statistics()).to be_truthy
     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
+      expect(subject.rooms).to be_truthy
+      expect(subject.rooms.first.statistics).to be_truthy
     end
 
     it "fails when the room doen't exist" do
@@ -75,7 +74,7 @@ describe "HipChat (API V2)" do
         OpenStruct.new(:code => 404)
       }
 
-      lambda { room.statistics }.should raise_error(HipChat::UnknownRoom)
+      expect { room.statistics }.to raise_error(HipChat::UnknownRoom)
     end
 
     it "fails when we're not allowed to do so" do
@@ -83,7 +82,7 @@ describe "HipChat (API V2)" do
         OpenStruct.new(:code => 401)
       }
 
-      lambda { room.statistics }.should raise_error(HipChat::Unauthorized)
+      expect { room.statistics }.to raise_error(HipChat::Unauthorized)
     end
 
     it "fails if we get an unknown response code" do
@@ -91,9 +90,8 @@ describe "HipChat (API V2)" do
         OpenStruct.new(:code => 403)
       }
 
-      lambda { room.statistics }.
-        should raise_error(HipChat::UnknownResponseCode)
-    end 
+      expect { room.statistics }.to raise_error(HipChat::UnknownResponseCode)
+    end
   end
 
   describe "#topic" do
@@ -101,13 +99,13 @@ describe "HipChat (API V2)" do
     it "is successful without custom options" do
       mock_successful_topic_change("Nice topic")
 
-      room.topic("Nice topic").should be_true
+      expect(room.topic("Nice topic")).to be_truthy
     end
 
     it "is successful with a custom from" do
       mock_successful_topic_change("Nice topic", :from => "Me")
 
-      room.topic("Nice topic", :from => "Me").should be_true
+      expect(room.topic("Nice topic", :from => "Me")).to be_truthy
     end
 
     it "fails when the room doesn't exist" do
@@ -115,7 +113,7 @@ describe "HipChat (API V2)" do
         OpenStruct.new(:code => 404)
       }
 
-      lambda { room.topic "" }.should raise_error(HipChat::UnknownRoom)
+      expect { room.topic "" }.to raise_error(HipChat::UnknownRoom)
     end
 
     it "fails when we're not allowed to do so" do
@@ -123,7 +121,7 @@ describe "HipChat (API V2)" do
           OpenStruct.new(:code => 401)
         }
 
-      lambda { room.topic "" }.should raise_error(HipChat::Unauthorized)
+      expect { room.topic "" }.to raise_error(HipChat::Unauthorized)
     end
 
     it "fails if we get an unknown response code" do
@@ -131,8 +129,7 @@ describe "HipChat (API V2)" do
           OpenStruct.new(:code => 403)
         }
 
-      lambda { room.topic "" }.
-        should raise_error(HipChat::UnknownResponseCode)
+      expect { room.topic "" }.to raise_error(HipChat::UnknownResponseCode)
     end
   end
 
@@ -141,25 +138,25 @@ describe "HipChat (API V2)" do
     it "successfully without custom options" do
       mock_successful_send 'Dude', 'Hello world'
 
-      room.send("Dude", "Hello world").should be_true
+      expect(room.send("Dude", "Hello world")).to be_truthy
     end
 
     it "successfully with notifications on as option" do
       mock_successful_send 'Dude', 'Hello world', :notify => true
 
-      room.send("Dude", "Hello world", :notify => true).should be_true
+      expect(room.send("Dude", "Hello world", :notify => true)).to be_truthy
     end
 
     it "successfully with custom color" do
       mock_successful_send 'Dude', 'Hello world', :color => 'red'
 
-      room.send("Dude", "Hello world", :color => 'red').should be_true
+      expect(room.send("Dude", "Hello world", :color => 'red')).to be_truthy
     end
 
     it "successfully with text message_format" do
       mock_successful_send 'Dude', 'Hello world', :message_format => 'text'
 
-      room.send("Dude", "Hello world", :message_format => 'text').should be_true
+      expect(room.send("Dude", "Hello world", :message_format => 'text')).to be_truthy
     end
 
     it "but fails when the room doesn't exist" do
@@ -167,7 +164,7 @@ describe "HipChat (API V2)" do
         OpenStruct.new(:code => 404)
       }
 
-      lambda { room.send "", "" }.should raise_error(HipChat::UnknownRoom)
+      expect { room.send "", "" }.to raise_error(HipChat::UnknownRoom)
     end
 
     it "but fails when we're not allowed to do so" do
@@ -175,11 +172,11 @@ describe "HipChat (API V2)" do
         OpenStruct.new(:code => 401)
       }
 
-      lambda { room.send "", "" }.should raise_error(HipChat::Unauthorized)
+      expect { room.send "", "" }.to raise_error(HipChat::Unauthorized)
     end
 
     it "but fails if the username is more than 15 chars" do
-      lambda { room.send "a very long username here", "a message" }.should raise_error(HipChat::UsernameTooLong)
+      expect { room.send "a very long username here", "a message" }.to raise_error(HipChat::UsernameTooLong)
     end
 
     it "but fails if we get an unknown response code" do
@@ -187,7 +184,54 @@ describe "HipChat (API V2)" do
         OpenStruct.new(:code => 403)
       }
 
-      lambda { room.send "", "" }.
+      expect { room.send "", "" }.to raise_error(HipChat::UnknownResponseCode)
+    end
+  end
+
+  describe "#send_file" do
+    let(:file) do
+      Tempfile.new('foo').tap do |f|
+        f.write("the content")
+        f.rewind
+      end
+    end
+
+    after { file.unlink }
+
+    include_context "HipChatV2"
+
+    it "successfully" do
+      mock_successful_file_send 'Dude', 'Hello world', file
+
+      room.send_file("Dude", "Hello world", file).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.send_file "", "", file }.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.send_file "", "", file }.should raise_error(HipChat::Unauthorized)
+    end
+
+    it "but fails if the username is more than 15 chars" do
+      lambda { room.send_file "a very long username here", "a message", file }.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.send_file "", "", file }.
         should raise_error(HipChat::UnknownResponseCode)
     end
   end
@@ -198,18 +242,18 @@ describe "HipChat (API V2)" do
     it "successfully with room name" do
       mock_successful_room_creation("A Room")
 
-      subject.create_room("A Room").should be_true
+      expect(subject.create_room("A Room")).to be_truthy
     end
 
     it "successfully with custom parameters" do
       mock_successful_room_creation("A Room", {:owner_user_id => "123456", :privacy => "private", :guest_access => true})
 
-      subject.create_room("A Room", {:owner_user_id => "123456", :privacy => "private", :guest_access =>true}).should be_true
+      expect(subject.create_room("A Room", {:owner_user_id => "123456", :privacy => "private", :guest_access =>true})).to be_truthy
     end
 
     it "but fail is name is longer then 50 char" do
-      lambda { subject.create_room("A Room that is too long that I should fail right now") }.
-        should raise_error(HipChat::RoomNameTooLong)
+      expect { subject.create_room("A Room that is too long that I should fail right now") }.
+        to raise_error(HipChat::RoomNameTooLong)
     end
   end
 
@@ -219,7 +263,7 @@ describe "HipChat (API V2)" do
     it "successfully" do
       mock_successful_get_room("Hipchat")
 
-      room.get_room.should be_true
+      expect(room.get_room).to be_truthy
     end
 
   end
@@ -236,9 +280,9 @@ describe "HipChat (API V2)" do
         "owner" => { "id" => "12345" }
       }
     }
-    it "successfully" do 
+    it "successfully" do
       mock_successful_update_room("Hipchat", room_info)
-      room.update_room(room_info).should be_true
+      expect(room.update_room(room_info)).to be_truthy
     end
   end
 
@@ -248,13 +292,13 @@ describe "HipChat (API V2)" do
     it "successfully with user_id" do
       mock_successful_invite()
 
-      room.invite("1234").should be_true
+      expect(room.invite("1234")).to be_truthy
     end
 
     it "successfully with custom parameters" do
       mock_successful_invite({:user_id => "321", :reason => "A great reason"})
 
-      room.invite("321", "A great reason").should be_true
+      expect(room.invite("321", "A great reason")).to be_truthy
     end
   end
 
@@ -263,7 +307,53 @@ describe "HipChat (API V2)" do
     it "successfully with a standard message" do
       mock_successful_user_send 'Equal bytes for everyone'
 
-      user.send('Equal bytes for everyone').should be_true
+      expect(user.send('Equal bytes for everyone')).to be_truthy
+    end
+
+    it "but fails when the user doesn't exist" do
+      mock(HipChat::User).post(anything, anything) {
+        OpenStruct.new(:code => 404)
+      }
+
+      expect { user.send "" }.to raise_error(HipChat::UnknownUser)
+    end
+
+    it "but fails when we're not allowed to do so" do
+      mock(HipChat::User).post(anything, anything) {
+        OpenStruct.new(:code => 401)
+      }
+
+      expect { user.send "" }.to raise_error(HipChat::Unauthorized)
+    end
+  end
+
+  describe '#get_user_history' do
+    include_context 'HipChatV2'
+
+    it 'successfully returns history' do
+      mock_successful_user_history
+      user.history.should be_truthy
+    end
+
+    it 'has allowed params' do
+      expect(user.instance_variable_get(:@api).history_config[:allowed_params]).to eq([:'max-results', :timezone, :'not-before'])
+    end
+  end
+
+  describe "#send_file user" do
+    include_context "HipChatV2"
+
+    let(:file) do
+      Tempfile.new('foo').tap do |f|
+        f.write("the content")
+        f.rewind
+      end
+    end
+
+    it "successfully with a standard file" do
+      mock_successful_user_send_file 'Equal bytes for everyone', file
+
+      user.send_file('Equal bytes for everyone', file).should be_truthy
     end
 
     it "but fails when the user doesn't exist" do
@@ -271,7 +361,7 @@ describe "HipChat (API V2)" do
         OpenStruct.new(:code => 404)
       }
 
-      lambda { user.send "" }.should raise_error(HipChat::UnknownUser)
+      lambda { user.send_file "", file }.should raise_error(HipChat::UnknownUser)
     end
 
     it "but fails when we're not allowed to do so" do
@@ -279,7 +369,7 @@ describe "HipChat (API V2)" do
         OpenStruct.new(:code => 401)
       }
 
-      lambda { user.send "" }.should raise_error(HipChat::Unauthorized)
+      lambda { user.send_file "", file }.should raise_error(HipChat::Unauthorized)
     end
   end
 end