hipchat 1.5.4 → 1.6.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZDBiYjZkZDVmYzJiYTFlMGI0YWVjZTZkNGIxMzI2ZTkzOTc0Yzk5OA==
-  data.tar.gz: !binary |-
-    ZjE0YmMzM2MxNjEwZjUyZTg5MGU2MDUxYTlkMjQ0MjZmMGU0ZmM5YQ==
+SHA1:
+  metadata.gz: f06cfd02a9621ac268502235156b565ee8a53b00
+  data.tar.gz: ade9310c79b73892f9e837bd87ec51339a6cbb18
 SHA512:
-  metadata.gz: !binary |-
-    NGJlOGFhMGQzOTBhYjliZDg5ZTI0OGRkNWVlYWU3ZDBmYmM2ZGI1ZDBiODYz
-    OGExMmFmNzE2ZGUwZGFhNWUxNDRkZGIxNGI3ODE4M2YxMjYxNDE4ZWEzYWMz
-    Zjk4NTcyZjE5YzI5M2QyM2JlNjM0MjU3OWZhM2I5YWJmNTA0ZTU=
-  data.tar.gz: !binary |-
-    MjIyMzRmNDMxZTA2NjE2NmI0NDllOTI5MGZkYTc5MTlmNTVhMzc4NzE5NGE1
-    NjkzNTMyMjAyNTJmMjE0YTFjNTU3OWZjYjY2MGE5NTk1MTA3ZGE4OWU1NDY2
-    N2JlZjhiNzY1MGUyODkxZjBkMDBlYzdlNDM3ZGYyNTA3OTQzYTU=
+  metadata.gz: 9c4a0072f4197265cd8bac579b35470bb424451ac963700a42ff9b535972d1d1df2ce3bd7d22a0cb82fe189cc24d7b8ce3db2b081fd73017e9b4dc549c40d09a
+  data.tar.gz: e914f9f8c2b4ce389a9120db5d32279618aed97ba456e2fa817165bd073500874cd854e4302eaac63bede8e73a8fbd6e02607e618c0483f5680ab95ae26f5e9b

data/.ruby-version

@@ -1 +1 @@
-2.1.0
+2.4.0

data/.travis.yml

@@ -6,6 +6,8 @@ before_install:
   - gem update bundler
 
 rvm:
-  - 1.9.3
   - 2.0.0
   - 2.1
+  - 2.2.6
+  - 2.3.3
+  - 2.4.0

data/README.textile

@@ -8,7 +8,7 @@ h2. CI Status
 !https://coveralls.io/repos/hipchat/hipchat-rb/badge.svg(Coverage Status)!:https://coveralls.io/r/hipchat/hipchat-rb
 
 h2. Requirements
-* Ruby 1.9.3 or higher
+* Ruby 2.0.0 or higher
 * HipChat Account, sign up "here!":https://hipchat.com/
 
 h2. Installation
@@ -108,6 +108,15 @@ 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')
 
+# Update a user status.  Available options for show are 'away', 'chat', 'dnd', 'xa'
+client.user('foo@bar.org').status('this is my status',  
+        :name=>'Foo Bar',
+        :status=>'Doing very important stuff',
+        :show=>'xa',
+        :mention_name=>'foo',
+        :email=>'foo@barr.org')
+
+
 h2. Custom Server URL
 
 bc.. client = HipChat::Client.new(api_token, :api_version => 'v2', :server_url => 'https://domain.com')

data/hipchat.gemspec

@@ -18,16 +18,19 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 1.9.3'
+  spec.required_ruby_version = '>= 2.0.0'
 
   spec.add_dependency "httparty"
   spec.add_dependency "mimemagic"
 
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rr"
-  spec.add_development_dependency "bundler", "~> 1.13.0"
+  spec.add_development_dependency "bundler", "~> 1.14.0"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "webmock", "= 1.22.1"
+  spec.add_development_dependency "webmock", "> 1.22.6"
+  spec.add_development_dependency "addressable", "= 2.4.0"
+  spec.add_development_dependency "term-ansicolor", "~> 1.4.0"
+  spec.add_development_dependency "json", "> 1.8.4"
   spec.add_development_dependency 'rdoc', '> 2.4.2'
   spec.add_development_dependency 'tins', '~> 1.6.0'
   spec.add_development_dependency 'coveralls'

data/lib/hipchat/api_version.rb

@@ -83,6 +83,15 @@ module HipChat
           }
         }[version]
       end
+
+      def scopes_config
+        raise InvalidApiVersion, 'This functionality is not supported in API v1' unless version.eql?('v2')
+        {
+          'v2' => {
+            :url => URI::escape("/oauth/token")
+          }
+        }[version]
+      end
     end
 
     class Room < ApiVersion
@@ -186,6 +195,17 @@ module HipChat
         }[version]
       end
 
+      def reply_config
+        {
+            'v2' => {
+                :url => URI::escape("/#{room_id}/reply"),
+                :method => :post,
+                :query_params => { },
+                :body_format => :to_json
+            }
+        }[version]
+      end
+
       def send_file_config
         {
           'v2' => {
@@ -302,6 +322,34 @@ module HipChat
         }[version]
       end
 
+      def user_joined_rooms_config
+        raise InvalidApiVersion, 'This functionality is not supported in API v1' unless version.eql?('v2')
+
+        {
+          'v2' => {
+            :url => URI::escape("/#{user_id}/preference/auto-join"),
+            :body_format => :to_json,
+            :query_params => {}
+          }
+        }[version]
+      end
+
+      #Same signature as view_config but separating code to keep any future changes safe
+      def user_update_config
+        {
+          'v1' => {
+            :url => URI::escape('/show'),
+            :body_format => :to_json,
+            :query_params => { :user_id => user_id }
+          },
+          'v2' => {
+            :url => URI::escape("/#{user_id}"),
+            :body_format => :to_json,
+            :query_params => {}
+          }
+        }[version]
+      end
+
 
       def delete_config
         {

data/lib/hipchat/client.rb

@@ -7,7 +7,7 @@ module HipChat
 
     def initialize(token, options={})
       @token = token
-      default_options = { api_version: 'v1', server_url: 'https://api.hipchat.com' }
+      default_options = { api_version: 'v2', server_url: 'https://api.hipchat.com' }
       @options = default_options.merge options
       @api_version = @options[:api_version]
       @api = HipChat::ApiVersion::Client.new(@options)
@@ -24,6 +24,43 @@ module HipChat
       HipChat::Room.new(@token, { room_id: name, :api_version => @api_version, :server_url => @options[:server_url] })
     end
 
+    # Returns the scopes for the Auth token
+    #
+    # Calls the endpoint:
+    #
+    #   https://api.hipchat.com/v2/oauth/token/#{token}
+    #
+    #   The response is a JSON object containing a client key. The client
+    #   object contains a list of allowed scopes.
+    #
+    #   There are two possible response types, for a global API token, the
+    #   room object will be nil. For a room API token, the room object will
+    #   be populated:
+    #
+    # Optional room parameter can be passed in. The method will return the
+    # following:
+    #
+    #   - if it's a global API token and room param is nil: scopes
+    #   - if it's a global API token and room param is not nil: scopes
+    #   - if it's a room API token and room param is nil: nil
+    #   - if it's a room API token and room param is not nil
+    #       - if room param's room_id matches token room_id: scopes
+    #       - if room param's room_id doesn't match token room_id: nil
+    #
+    # Raises errors if response is unrecognizable
+    def scopes(room: nil)
+      path = "#{@api.scopes_config[:url]}/#{URI::escape(@token)}"
+      response = self.class.get(path,
+        :query => { :auth_token => @token },
+        :headers => @api.headers
+      )
+      ErrorHandler.response_code_to_exception_for :room, 'scopes', response
+      return response['scopes'] unless response['client']['room']
+      if room && response['client']['room']['id'] == room.room_id
+        return response['scopes']
+      end
+    end
+
     def create_room(name, options={})
       if @api.version == 'v1' && options[:owner_user_id].nil?
         raise RoomMissingOwnerUserId, 'V1 API Requires owner_user_id'
@@ -96,12 +133,7 @@ module HipChat
     end
 
     def _rooms
-      response = self.class.get(@api.rooms_config[:url],
-        :query => {
-          :auth_token => @token
-        },
-        :headers => @api.headers
-      )
+      response = self.class.get(@api.rooms_config[:url], query: { auth_token: @token }, headers: @api.headers)
 
       ErrorHandler.response_code_to_exception_for :room, nil, response
       response[@api.rooms_config[:data_key]].map do |r|

data/lib/hipchat/errors.rb

@@ -1,5 +1,21 @@
 module HipChat
-  class ServiceError            < StandardError;       end
+  class ServiceError < StandardError
+    attr_accessor :response
+
+    def initialize(msg, response: nil)
+      @response = response
+      @msg = msg
+    end
+
+    def message
+      if @response.respond_to? :body
+        "#{@msg}:\nResponse: #{@response.body}"
+      else
+        @msg
+      end
+    end
+  end
+
   class RoomNameTooLong         < ServiceError;        end
   class RoomMissingOwnerUserId  < ServiceError;        end
   class UnknownResponseCode     < ServiceError;        end
@@ -24,24 +40,24 @@ module HipChat
     # @param response {HTTParty::Response} The HTTParty response/request object
     def self.response_code_to_exception_for(klass, identifier, response)
       # Supports user, room and webhook objects.  If we get something other than that, bail.
-      raise ServiceError "Unknown class #{klass}" unless [:user, :room, :webhook].include? klass
+      raise(ServiceError.new("Unknown class #{klass}", response: response)) unless [:user, :room, :webhook].include? klass
       # Grab the corresponding unknown object exception class and constantize it for the 404 case to call
       not_found_exception = Module.const_get(HipChat.to_s.to_sym).const_get("Unknown#{klass.capitalize}".to_sym)
       case response.code
         when 200, 201, 202, 204;
           return
         when 400
-          raise BadRequest, "The request was invalid. You may be missing a required argument or provided bad data. path:#{response.request.path.to_s} method:#{response.request.http_method.to_s}"
+          raise BadRequest.new("The request was invalid. You may be missing a required argument or provided bad data. path:#{response.request.path} method:#{response.request.http_method}", response: response)
         when 401, 403
-          raise Unauthorized, "Access denied to #{klass} `#{identifier}'"
+          raise Unauthorized.new("Access denied to #{klass} `#{identifier}'", response: response)
         when 404
-          raise not_found_exception,  "Unknown #{klass}: `#{identifier}'"
+          raise not_found_exception.new("Unknown #{klass}: `#{identifier}'", response: response)
         when 405
-          raise MethodNotAllowed, "You requested an invalid method. path:#{response.request.path.to_s} method:#{response.request.http_method.to_s}"
+          raise MethodNotAllowed.new("You requested an invalid method. path:#{response.request.path} method:#{response.request.http_method}", response: response)
         when 429
-          raise TooManyRequests, 'You have exceeded the rate limit. `https://www.hipchat.com/docs/apiv2/rate_limiting`'
+          raise TooManyRequests.new('You have exceeded the rate limit. `https://www.hipchat.com/docs/apiv2/rate_limiting`', response: response)
         else
-          raise UnknownResponseCode, "Unexpected #{response.code} for #{klass} `#{identifier}'"
+          raise UnknownResponseCode.new("Unexpected #{response.code} for #{klass} `#{identifier}'", response: response)
       end
     end
   end

data/lib/hipchat/room.rb

@@ -29,7 +29,7 @@ module HipChat
 
     # Update a room
     def update_room(options = {})
-      options = {
+      merged_options = {
         :privacy => 'public',
         :is_archived => false,
         :is_guest_accessible => false
@@ -38,12 +38,12 @@ module HipChat
       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]
+          :name => merged_options[:name],
+          :topic => merged_options[:topic],
+          :privacy => merged_options[:privacy],
+          :is_archived => @api.bool_val(merged_options[:is_archived]),
+          :is_guest_accessible => @api.bool_val(merged_options[:is_guest_accessible]),
+          :owner => merged_options[:owner]
         }.to_json,
         :headers => @api.headers)
 
@@ -132,23 +132,23 @@ module HipChat
       if from.length > 20
         raise UsernameTooLong, "Username #{from} is `#{from.length} characters long. Limit is 20'"
       end
-      options = if options_or_notify == true or options_or_notify == false
+      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 }
+        options = { :notify => options_or_notify }
       else
-        options_or_notify || {}
+        options = options_or_notify
       end
 
-      options = { :color => 'yellow', :notify => false, :message_format => 'html' }.merge options
+      merged_options = { :color => 'yellow', :notify => false, :message_format => 'html' }.merge options
 
       body = {
         :room_id        => room_id,
         :from           => from,
         :message        => message,
-        :message_format => options[:message_format],
-        :color          => options[:color],
-        :card           => options[:card],
-        :notify         => @api.bool_val(options[:notify])
+        :message_format => merged_options[:message_format],
+        :color          => merged_options[:color],
+        :card           => merged_options[:card],
+        :notify         => @api.bool_val(merged_options[:notify])
       }.delete_if { |_k, v| v.nil? }
 
       response = self.class.post(@api.send_config[:url],
@@ -161,6 +161,16 @@ module HipChat
       true
     end
 
+    def reply(parent_message_id, message)
+      query_params  = { auth_token: @token }.merge(@api.reply_config[:query_params])
+      body          = { message: message, parent_message_id: parent_message_id }.send(@api.reply_config[:body_format])
+
+      response = self.class.post(@api.reply_config[:url], query: query_params, body: body, headers: @api.headers)
+
+      ErrorHandler.response_code_to_exception_for :room, 'all', response
+      response.parsed_response
+    end
+
     def share_link(from, message, link)
       if from.length > 20
         raise UsernameTooLong, "Username #{from} is `#{from.length} characters long. Limit is 20'"
@@ -221,13 +231,13 @@ module HipChat
     #            (default "API")
     def topic(new_topic, options = {})
 
-      options = { :from => 'API' }.merge options
+      merged_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],
+          :from           => merged_options[:from],
           :topic          => new_topic
         }.send(@api.topic_config[:body_format]),
         :headers => @api.headers
@@ -254,7 +264,7 @@ module HipChat
     #                (default "JSON")
     def history(options = {})
 
-      options = {
+      merged_options = {
         :date => 'recent',
         :timezone => 'UTC',
         :format => 'JSON',
@@ -266,14 +276,14 @@ module HipChat
       response = self.class.get(@api.history_config[:url],
         :query => {
           :room_id    => room_id,
-          :date       => options[:date],
-          :timezone   => options[:timezone],
-          :format     => options[:format],
-          :'max-results' => options[:'max-results'],
-          :'start-index' => options[:'start-index'],
-          :'end-date' => options[:'end-date'],
+          :date       => merged_options[:date],
+          :timezone   => merged_options[:timezone],
+          :format     => merged_options[:format],
+          :'max-results' => merged_options[:'max-results'],
+          :'start-index' => merged_options[:'start-index'],
+          :'end-date' => merged_options[:'end-date'],
           :auth_token => @token
-        },
+        }.reject!{|k,v| v.nil?},
         :headers => @api.headers
       )
 
@@ -291,7 +301,7 @@ module HipChat
           :timezone   => options[:timezone],
           :format     => options[:format],
           :auth_token => @token,
-        },
+        }.reject!{|k,v| v.nil?},
         :headers => @api.headers
       )
 
@@ -313,16 +323,16 @@ module HipChat
     # +name+::     The label for this webhook
     #                (default "")
     def create_webhook(url, event, options = {})
-      raise InvalidEvent unless %w(room_message room_notification room_exit room_enter room_topic_change room_archived room_deleted room_unarchived).include? event
+      raise InvalidEvent.new("Invalid event: #{event}") unless %w(room_message room_notification room_exit room_enter room_topic_change room_archived room_deleted room_unarchived).include? event
 
       begin
         u = URI::parse(url)
-        raise InvalidUrl unless %w(http https).include? u.scheme
+        raise InvalidUrl.new("Invalid Scheme: #{url}") unless %w(http https).include? u.scheme
       rescue URI::InvalidURIError
-        raise InvalidUrl
+        raise InvalidUrl.new("Invalid URL: #{url}")
       end
 
-      options = {
+      merged_options = {
         :pattern => '',
         :name => ''
       }.merge options
@@ -331,7 +341,7 @@ module HipChat
         :query => {
           :auth_token => @token
         },
-        :body => {:url => url, :pattern => options[:pattern], :event => event, :name => options[:name]}.send(@api.send_config[:body_format]),
+        :body => {:url => url, :pattern => merged_options[:pattern], :event => event, :name => merged_options[:name]}.send(@api.send_config[:body_format]),
         :headers => @api.headers
       )
 
@@ -371,13 +381,13 @@ module HipChat
     # +max-results+::     The label for this webhook
     #                (default "")
     def get_all_webhooks(options = {})
-      options = {:'start-index' => 0, :'max-results' => 100}.merge(options)
+      merged_options = {:'start-index' => 0, :'max-results' => 100}.merge(options)
 
       response = self.class.get(@api.webhook_config[:url],
                                    :query => {
                                      :auth_token => @token,
-                                     :'start-index' => options[:'start-index'],
-                                     :'max-results' => options[:'max-results']
+                                     :'start-index' => merged_options[:'start-index'],
+                                     :'max-results' => merged_options[:'max-results']
                                    },
                                    :headers => @api.headers
       )

data/lib/hipchat/user.rb

@@ -32,7 +32,6 @@ module HipChat
                                  }.send(@api.send_config[:body_format]),
                                  :headers => @api.headers
       )
-
       ErrorHandler.response_code_to_exception_for :user, user_id, response
       true
     end
@@ -61,7 +60,7 @@ module HipChat
       )
 
       ErrorHandler.response_code_to_exception_for :user, user_id, response
-      User.new(@token, response.merge(:api_version => @api.version))
+      User.new(@token, response.merge(:api_version => @api.version, :server_url => server_url))
     end
 
     #
@@ -100,5 +99,68 @@ module HipChat
       true
     end
 
+    #
+    # User update.
+    # API: https://www.hipchat.com/docs/apiv2/method/update_user
+    # Request body
+    # name - REQUIRED - User's full name.  Valid length range: 1-50
+    # roles - The list of roles for the user. For example "owner", "administrator", "user", "delegated administrator"
+    # title - User's title
+    # status - string may be null
+    # show - REQUIRED -  string - the status to show for the user. Available options 'away', 'chat', 'dnd', 'xa'
+    # mention_name - REQUIRED - User's @mention name without the @
+    # is_group_admin - Whether or not this user is an administrator
+    # timezone - User's timezone. Must be a supported timezone.  Defaults to 'UTC'
+    # password - User's password.  If not provided, the existing password is kept
+    # email - REQUIRED - User's email
+    def update(options = {})
+      name          = options[:name]    
+      roles         = options[:roles]   ? options[:roles] : nil
+      title         = options[:title]   ? options[:title] : nil
+      status        = options[:status]  ? options[:status] : nil
+      show          = options[:show]    ? options[:show] : nil 
+      mention_name  = options[:mention_name] 
+      is_group_admin = options[:is_group_admin] ? options[:is_group_admin] : nil
+      timezone      = options[:timezone] ? options[:timezone] : 'UTC'
+      password      = options[:password] ? options[:password] : nil
+      email         = options[:email] 
+
+      #create body format
+      body = {
+        
+      }
+
+
+      response = self.class.put(@api.user_update_config[:url],
+                                 :query => { :auth_token => @token },
+                                 :body => {
+                                     :name            => name,
+                                     :presence        => {:status=>status, :show=>show},
+                                     :mention_name    => mention_name,
+                                     :timezone        => timezone,
+                                     :email           => email
+                                 }
+                                 .merge(title ? {:title =>title} : {})
+                                 .merge(password ? {:password => password} : {})
+                                 .merge(is_group_admin ? {:is_group_admin => is_group_admin} : {})
+                                 .merge(roles ? {:roles => roles} : {})
+                                 .send(@api.user_update_config[:body_format]),
+                                 :headers => @api.headers
+      )
+      
+      ErrorHandler.response_code_to_exception_for :user, user_id, response
+    end
+
+    #
+    # Getting all rooms details in which user is present
+    #
+    def rooms
+      response = self.class.get(@api.user_joined_rooms_config[:url],
+                                :query => { :auth_token => @token }.merge(@api.user_joined_rooms_config[:query_params]),
+                                :headers => @api.headers
+      )
+      ErrorHandler.response_code_to_exception_for :user, user_id, response
+      User.new(@token, response.merge(:api_version => @api.version))
+    end
   end
 end

data/lib/hipchat/version.rb

@@ -1,3 +1,3 @@
 module HipChat
-  VERSION = '1.5.4'
+  VERSION = '1.6.0'
 end

data/spec/hipchat_api_v2_spec.rb

@@ -1,4 +1,5 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require'tempfile'
 
 describe "HipChat (API V2)" do
 
@@ -7,6 +8,62 @@ describe "HipChat (API V2)" do
   let(:room) { subject["Hipchat"] }
   let(:user) { subject.user "12345678" }
 
+  describe "#scopes" do
+    include_context "HipChatV2"
+    let(:token_room) { nil }
+    before { mock_successful_scopes room: token_room }
+
+    context 'with a global API token' do
+      context 'room parameter given' do
+        it 'returns an array of global scopes' do
+          expect(subject.scopes(room: room))
+            .to match_array(['view_room', 'send_notification'])
+        end
+      end
+
+      context 'no room parameter given' do
+        it 'returns an array of global scopes' do
+          expect(subject.scopes)
+            .to match_array(['view_room', 'send_notification'])
+        end
+      end
+    end
+
+    context 'with a room API token' do
+      let(:token_room) { room }
+
+      context 'room parameter given' do
+        context 'room parameter matches API token room' do
+          it 'returns an array of global scopes' do
+            expect(subject.scopes(room: room))
+              .to match_array(['view_room', 'send_notification'])
+          end
+        end
+
+        context 'room parameter does not match API token room' do
+          let(:token_room) { double(room_id: 'Not-Hipchat') }
+          it 'returns nil' do
+            expect(subject.scopes(room: room)).to eq nil
+          end
+        end
+      end
+
+      context 'no room parameter given' do
+        it 'returns nil' do
+          expect(subject.scopes).to eq nil
+        end
+      end
+    end
+
+    it "fails if we get an unknown response code" do
+      allow(subject.class)
+        .to receive(:get).with(anything, anything)
+        .and_return(OpenStruct.new(:code => 403))
+
+      expect { subject.scopes }.to raise_error(HipChat::Unauthorized)
+    end
+  end
+
   describe "#history" do
     include_context "HipChatV2"
     it "is successful without custom options" do
@@ -28,7 +85,7 @@ describe "HipChat (API V2)" do
       expect(subject.rooms.first.history).to be_truthy
     end
 
-    it "fails when the room doen't exist" do
+    it "fails when the room doesn't exist" do
       allow(room.class).to receive(:get).with(anything, anything).and_return(OpenStruct.new(:code => 404))
 
       expect { room.history }.to raise_error(HipChat::UnknownRoom)
@@ -63,7 +120,7 @@ describe "HipChat (API V2)" do
       expect(subject.rooms.first.statistics).to be_truthy
     end
 
-    it "fails when the room doen't exist" do
+    it "fails when the room doesn't exist" do
       allow(room.class).to receive(:get).with(anything, anything).and_return(OpenStruct.new(:code => 404))
 
       expect { room.statistics }.to raise_error(HipChat::UnknownRoom)
@@ -115,6 +172,8 @@ describe "HipChat (API V2)" do
     end
   end
 
+
+
   describe "#send_message" do
     include_context "HipChatV2"
     it "successfully without custom options" do
@@ -202,6 +261,36 @@ describe "HipChat (API V2)" do
     end
   end
 
+  describe '#reply' do
+    include_context 'HipChatV2'
+    let(:parent_id) { '100000' }
+    let(:message)   { 'Hello world' }
+
+    it 'successfully' do
+      mock_successful_reply parent_id, message
+
+      expect(room.reply(parent_id, message))
+    end
+
+    it "but fails when the parent_id doesn't exist" do
+      allow(room.class).to receive(:post).and_return(OpenStruct.new(:code => 404))
+
+      expect { room.reply parent_id, message }.to raise_error(HipChat::UnknownRoom)
+    end
+
+    it "but fails when we're not allowed to do so" do
+      allow(room.class).to receive(:post).and_return(OpenStruct.new(:code => 401))
+
+      expect { room.reply parent_id, message }.to raise_error(HipChat::Unauthorized)
+    end
+
+    it 'but fails if we get an unknown response code' do
+      allow(room.class).to receive(:post).and_return(OpenStruct.new(:code => 403))
+
+      expect { room.reply parent_id, message }.to raise_error(HipChat::Unauthorized)
+    end
+  end
+
   describe '#share_link' do
     let(:link) { "http://i.imgur.com/cZ6GDFY.jpg" }
     include_context "HipChatV2"
@@ -317,6 +406,31 @@ describe "HipChat (API V2)" do
     end
   end
 
+  describe "#user_update" do
+    include_context "HipChatV2"
+
+    let(:user_update) {
+      {
+        :name => "Foo Bar",
+        :presence => { status: "Away", show: "away" },
+        :mention_name => "foo",
+        :timezone => "GMT",
+        :email => "foo@bar.org",
+        :title => "mister",
+        :is_group_admin => 0,
+        :roles => []
+      }
+    }
+
+    it "successfull" do
+      mock_successful_user_update(user_update)
+
+      user_update.delete(:presence)
+                 .each { |key, value| user_update[key] = value }
+      expect(user.update(user_update))
+    end
+  end
+
   describe "#get_room" do
     include_context "HipChatV2"
 

data/spec/hipchat_error_handler_spec.rb

@@ -0,0 +1,133 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe HipChat::ErrorHandler do
+  let(:body)     { { error: { code: code, message: 'any', type: 'any' } } }
+  let(:request)  { HTTParty::Request.new(Net::HTTP::Get, 'http://foo.com/') }
+  let(:response) { HTTParty::Response.new(request, response_object, lambda { body }) }
+  let(:room_id)  { 'Hipchat' }
+  before do
+    allow(response_object).to receive_messages(body: body.to_json)
+  end
+
+
+  describe 'response_code_to_exception_for' do
+    subject { HipChat::ErrorHandler.response_code_to_exception_for(:room, room_id, response) }
+
+    context 'success codes' do
+      shared_examples 'the error handler' do
+        it "does not raise an error" do
+          expect { subject }.not_to raise_error
+        end
+      end
+
+      context 'Hipchat API responds with success' do
+        describe 'code 200' do
+          let(:response_object) { Net::HTTPOK.new('1.1', code, '') }
+          let(:code)            { 200 }
+          it_should_behave_like 'the error handler'
+        end
+
+        describe 'code 201' do
+          let(:response_object) { Net::HTTPCreated.new('1.1', code, '') }
+          let(:code)            { 201 }
+          it_should_behave_like 'the error handler'
+        end
+
+        describe 'code 202' do
+          let(:response_object) { Net::HTTPAccepted.new('1.1', code, '') }
+          let(:code)            { 202 }
+          it_should_behave_like 'the error handler'
+        end
+
+        describe 'code 204' do
+          let(:response_object) { Net::HTTPNoContent.new('1.1', code, '') }
+          let(:code)            { 204 }
+          it_should_behave_like 'the error handler'
+        end
+      end
+    end
+
+    context 'failure codes' do
+      shared_examples 'the error handler' do
+        it "raises the correct client error" do
+          expect { subject }
+            .to raise_error(client_error) do |error|
+              expect(error.message)
+                .to match message
+            end
+        end
+      end
+
+      context 'Hipchat API responds with Not Found' do
+        let(:response_object) { Net::HTTPNotFound.new('1.1', code, '') }
+        let(:client_error)    { HipChat::UnknownRoom }
+        let(:message)         { "Unknown room: `#{room_id}\':\nResponse: #{body.to_json}" }
+
+        describe 'code 404' do
+          let(:code) { 404 }
+          it_should_behave_like 'the error handler'
+        end
+      end
+
+      context 'Hipchat API responds with Unauthorized' do
+        let(:response_object) { Net::HTTPUnauthorized.new('1.1', code, '') }
+        let(:client_error)    { HipChat::Unauthorized }
+        let(:message)         { "Access denied to room `#{room_id}\':\nResponse: #{body.to_json}" }
+
+        describe 'code 401' do
+          let(:code) { 401 }
+          it_should_behave_like 'the error handler'
+        end
+
+        describe 'code 403' do
+          let(:code) { 403 }
+          it_should_behave_like 'the error handler'
+        end
+      end
+
+      context 'Hipchat API responds with Bad Request' do
+        let(:response_object) { Net::HTTPBadRequest.new('1.1', code, '') }
+        let(:client_error)    { HipChat::BadRequest }
+        let(:message)         { "The request was invalid. You may be missing a required argument or provided bad data. path:http://foo.com/ method:Net::HTTP::Get:\nResponse: #{body.to_json}" }
+
+        describe 'code 400' do
+          let(:code) { 400 }
+          it_should_behave_like 'the error handler'
+        end
+      end
+
+      context 'Hipchat API responds with MethodNotAllowed' do
+        let(:response_object) { Net::HTTPMethodNotAllowed.new('1.1', code, '') }
+        let(:client_error)    { HipChat::MethodNotAllowed }
+        let(:message)         { "You requested an invalid method. path:http://foo.com/ method:Net::HTTP::Get:\nResponse: #{body.to_json}" }
+
+        describe 'code 405' do
+          let(:code) { 405 }
+          it_should_behave_like 'the error handler'
+        end
+      end
+
+      context 'Hipchat API responds with TooManyRequests' do
+        let(:response_object) { Net::HTTPTooManyRequests.new('1.1', code, '') }
+        let(:client_error)    { HipChat::TooManyRequests }
+        let(:message)         { "You have exceeded the rate limit. `https://www.hipchat.com/docs/apiv2/rate_limiting`:\nResponse: #{body.to_json}" }
+
+        describe 'code 429' do
+          let(:code) { 429 }
+          it_should_behave_like 'the error handler'
+        end
+      end
+
+      context 'Hipchat API responds with an unknown response code' do
+        let(:response_object) { Net::HTTPBadGateway.new('1.1', code, '') }
+        let(:client_error)    { HipChat::UnknownResponseCode }
+        let(:message)         { "Unexpected 502 for room `#{room_id}\'" }
+
+        describe 'code 502' do
+          let(:code) { 502 }
+          it_should_behave_like 'the error handler'
+        end
+      end
+    end
+  end
+end

data/spec/hipchat_spec.rb

@@ -40,9 +40,9 @@ describe HipChat do
 
     context "api_version" do
 
-      it "defaults to a v1 client" do
+      it "defaults to a v2 client" do
         client = HipChat::Client.new("blah")
-        expect(client[:example].api_version).to eql('v1')
+        expect(client[:example].api_version).to eql('v2')
       end
 
       it "when given 'v1' it registers a v1 client" do

data/spec/support/shared_contexts_for_hipchat.rb

@@ -50,7 +50,7 @@ shared_context "HipChatV1" do
                                    :'max-results' => options[:'max-results'],
                                    :'start-index' => options[:'start-index'],
                                    :'end-date'    => options[:'end-date'],
-                                   :format        => options[:format]}).to_return(canned_response)
+                                   :format        => options[:format]}.reject!{|k,v| v.nil?}).to_return(canned_response)
   end
 
   def mock_successful_room_creation(name, options={})
@@ -123,6 +123,16 @@ shared_context "HipChatV2" do
                                                     'Content-Type' => 'application/json'}).to_return(:status => 200, :body => "", :headers => {})
   end
 
+  def mock_successful_reply(parent_message_id, message)
+    stub_request(:post, 'https://api.hipchat.com/v2/room/Hipchat/reply?auth_token=blah')
+        .with(query:  { auth_token:        'blah' },
+              body:   { parent_message_id: parent_message_id,
+                        message:           message },
+              headers:           { 'Accept' =>       'application/json',
+                                   'Content-Type' => 'application/json' })
+        .to_return(status: 200, body: '', headers: {})
+  end
+
   def mock_successful_link_share(from, message, link)
     stub_request(:post, "https://api.hipchat.com/v2/room/Hipchat/share/link").with(
                              :query => {:auth_token => "blah"},
@@ -179,6 +189,29 @@ shared_context "HipChatV2" do
                                             :headers => {})
   end
 
+  def mock_successful_scopes(room: nil)
+    token_room = room ? { id: room.room_id, name: 'example' } : nil
+    stub_request(:get, 'https://api.hipchat.com/v2/oauth/token/blah').with(
+      :query => { :auth_token => 'blah' },
+      :body => '',
+      :headers => {
+        'Accept' => 'application/json',
+        'Content-Type' => 'application/json'
+      }
+    ).to_return(
+      :status => 200,
+      :body => {
+        client: {
+          allowed_scopes: [:view_room, :send_notification],
+          name: 'All perms',
+          room: token_room
+        },
+        scopes: [:view_room, :send_notification]
+      }.to_json,
+      :headers => {}
+    )
+  end
+
   def mock_successful_history(options={})
     options = { :date => 'recent', :timezone => 'UTC', :format => 'JSON', :'max-results' => 100, :'start-index' => 0 }.merge(options)
     canned_response = File.new(HISTORY_JSON_PATH)
@@ -189,7 +222,7 @@ shared_context "HipChatV2" do
                                    :'max-results' => options[:'max-results'],
                                    :'start-index' => options[:'start-index'],
                                    :'end-date'    => options[:'end-date'],
-                                   :format     => options[:format]}).to_return(canned_response)
+                                   :format     => options[:format]}.reject!{|k,v| v.nil?}).to_return(canned_response)
   end
 
   def mock_successful_statistics(options={})
@@ -197,7 +230,7 @@ shared_context "HipChatV2" do
                                    :room_id    => "Hipchat",
                                    :date       => options[:date],
                                    :timezone   => options[:timezone],
-                                   :format     => options[:format]}).to_return(
+                                   :format     => options[:format]}.reject!{|k,v| v.nil?}).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 => {})
@@ -326,6 +359,19 @@ shared_context "HipChatV2" do
                                                 'Content-Type' => 'multipart/related; boundary=sendfileboundary'}).to_return(:status => 200, :body => "", :headers => {})
   end
 
+  def mock_successful_user_update(options)
+     stub_request(:put, "https://api.hipchat.com/v2/user/12345678").with(
+      :query => {:auth_token => "blah"},
+      :body => options.to_json,
+      :headers => {"Accept" => "application/json",
+                    "Content-Type" => "application/json"}).to_return(
+                    :status => 204,
+                    :body => "",
+                    :headers => {})
+
+
+  end
+
   def mock_successful_create_webhook(room_id, url, event, options = {})
     options = {:pattern => '', :name => ''}.merge(options)
     stub_request(:post, "https://api.hipchat.com/v2/room/#{room_id}/webhook").with(

metadata

@@ -1,153 +1,195 @@
 --- !ruby/object:Gem::Specification
 name: hipchat
 version: !ruby/object:Gem::Version
-  version: 1.5.4
+  version: 1.6.0
 platform: ruby
 authors:
 - HipChat/Atlassian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-12 00:00:00.000000000 Z
+date: 2017-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mimemagic
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.13.0
+        version: 1.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.13.0
+        version: 1.14.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 1.22.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 1.22.6
+- !ruby/object:Gem::Dependency
+  name: addressable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.22.1
+        version: 2.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.22.1
+        version: 2.4.0
+- !ruby/object:Gem::Dependency
+  name: term-ansicolor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 1.8.4
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>'
+    - - ">"
       - !ruby/object:Gem::Version
         version: 2.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>'
+    - - ">"
       - !ruby/object:Gem::Version
         version: 2.4.2
 - !ruby/object:Gem::Dependency
   name: tins
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Ruby library to interact with HipChat
@@ -157,12 +199,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .coveralls.yml
-- .document
-- .gitignore
-- .ruby-gemset
-- .ruby-version
-- .travis.yml
+- ".coveralls.yml"
+- ".document"
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.textile
@@ -185,6 +227,7 @@ files:
 - spec/example/history.json
 - spec/hipchat_api_v1_spec.rb
 - spec/hipchat_api_v2_spec.rb
+- spec/hipchat_error_handler_spec.rb
 - spec/hipchat_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
@@ -200,17 +243,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Ruby library to interact with HipChat
@@ -218,6 +261,7 @@ test_files:
 - spec/example/history.json
 - spec/hipchat_api_v1_spec.rb
 - spec/hipchat_api_v2_spec.rb
+- spec/hipchat_error_handler_spec.rb
 - spec/hipchat_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb