hipchat-api 1.0.5 → 1.0.6

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NTkwZDUwZWE0MjY5OWNjMjYzNzQ1MTdlYWViNmZhN2I3YmI0Mzc4Nw==
+  data.tar.gz: !binary |-
+    Zjg0MWI4ZGQyNWYwYjMxMTk2MWJjNjA5ZjNjZDI4OGQ2MDZiYWQxZQ==
+SHA512:
+  metadata.gz: !binary |-
+    NDU3NWI3ZGIyMDFmNWJmNDA2ZDRhZjkxNzI4MTRhYzA5NjE4ZjJmNDQwMTQ2
+    ODA1YThjZjc0ZTc3ODY5MjZhMjliMTdmYjYyZWY1NGM1MWEwMzYzOTJkODAw
+    Nzg0MzQ5YmZhOWNiYWMzYWU1ZjU5YWViNWZjYzVmZTUxNDM1NTc=
+  data.tar.gz: !binary |-
+    NjljNzhhY2I0Y2JhYWZlYmJmNDY1MjE5ZWU4Yjc0ODA4ZWY1YTFjZGM0NDk1
+    ZTFhMWE2ZDAyY2M4NDAyMGIwYWVkMTdkMTVjODQzNGFmMzZmZGVmMzBhM2Q5
+    NTc1ZDUyOGI5ZDM1YzZmNjBiNmE2ODI3Y2JkMmZjNWFmZTNjN2Q=

data/.ruby-gemset

@@ -0,0 +1 @@
+hipchat-api_gem

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3

data/.travis.yml

@@ -1,6 +1,4 @@
 rvm:
-  - 1.8.7
-  - 1.9.2
   - 1.9.3
 gemfile:
   - Gemfile

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 1.0.6 (2014-03-09)
+
+* Added `include_deleted` parameter to `users_list` method [#7](https://github.com/czarneckid/hipchat-api/pull/7)
+
 ## 1.0.5 (2012-12-04)
 
 * Added `rooms_topic` method to set a room's topic.
@@ -16,7 +20,7 @@
 ## 1.0.2 (2011-09-09)
 
  * Added missing HipChat API methods: `rooms_create`, `rooms_delete`
- 
+
 ## 1.0.1 (2011-05-09)
 
  * Set the default HIPCHAT_API_URL to use https

data/Gemfile

@@ -1,3 +1,3 @@
-source "http://rubygems.org"
+source 'https://rubygems.org'
 
 gemspec

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2011-2012 David Czarnecki
+Copyright (c) 2011-2014 David Czarnecki
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,6 +1,6 @@
 # hipchat-api
 
-[![Project Status](http://stillmaintained.com/czarneckid/hipchat-api.png)](http://stillmaintained.com/czarneckid/hipchat-api) [![Build Status](http://travis-ci.org/czarneckid/hipchat-api.png)](http://travis-ci.org/czarneckid/hipchat-api)
+[![Project Status](http://stillmaintained.com/czarneckid/hipchat-api.png)](http://stillmaintained.com/czarneckid/hipchat-api) [![Build Status](https://travis-ci.org/czarneckid/hipchat-api.png)](https://travis-ci.org/czarneckid/hipchat-api)
 
 Ruby gem for interacting with HipChat API
 
@@ -8,7 +8,7 @@ Ruby gem for interacting with HipChat API
 
 ## Compatibility
 
-hipchat-API has been tested under Ruby 1.8.7 and Ruby 1.9.2
+hipchat-API has been tested under Ruby 1.9.3
 
 ## Requirements
 
@@ -24,11 +24,11 @@ gem install hipchat-api
 
 ```ruby
 require 'hipchat-api'
-=> true 
+=> true
 hipchat_api = HipChat::API.new('api_token')
-=> #<HipChat::API:0x000001013d7280 @token="api_token", @hipchat_api_url="https://api.hipchat.com/v1"> 		
+=> #<HipChat::API:0x000001013d7280 @token="api_token", @hipchat_api_url="https://api.hipchat.com/v1">
 ```
-	 
+
 ## API methods
 
 * Room-related methods
@@ -36,26 +36,26 @@ hipchat_api = HipChat::API.new('api_token')
 ```ruby
 rooms_create(name, owner_user_id, privacy = 'public', topic = '', guest_access = 0)
 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_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)  
+rooms_show(room_id)
 ```
-  
+
 * User-related methods
 
 ```ruby
-users_list  
+users_list(include_deleted = 0)
 users_create(email, name, title, is_group_admin = 0, password = nil, timezone = 'UTC')
-users_delete(user_id)  
+users_delete(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)
 ```
-  
+
 ## Contributing to hipchat-api
- 
+
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
 * Fork the project
@@ -66,4 +66,4 @@ users_update(user_id, email = nil, name = nil, title = nil, is_group_admin = nil
 
 ## Copyright
 
-Copyright (c) 2011-2012 David Czarnecki. See LICENSE.txt for further details.
+Copyright (c) 2011-2014 David Czarnecki. See LICENSE.txt for further details.

data/Rakefile

@@ -6,14 +6,7 @@ require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = FileList['spec/**/*_spec.rb']
   spec.rspec_opts = ['--backtrace']
-  # spec.ruby_opts = ['-w']    
+  # spec.ruby_opts = ['-w']
 end
 
 task :default => :spec
-
-namespace :spec do
-  desc "Runs specs on Ruby 1.8.7 and 1.9.2"
-  task :rubies do
-    system "rvm 1.8.7@hipchat-api_gem,1.9.2@hipchat-api_gem,1.9.3@hipchat-api_gem do rake"
-  end
-end

data/lib/hipchat-api.rb

@@ -113,10 +113,10 @@ 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! 
+    # 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 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
@@ -159,9 +159,13 @@ module HipChat
 
     # List all users in the group.
     #
+    # @param notify [bool] Boolean flag of whether or not include deleted users 0 = false, 1 = true. (default: 0)
+    #
     # @see https://www.hipchat.com/docs/api/method/users/list
-    def users_list
-      self.class.get(hipchat_api_url_for('users/list'), :query => {:auth_token => @token})
+    def users_list(include_deleted = 0)
+      query = {:auth_token => @token}
+      query[:include_deleted] = 1 if include_deleted == 1
+      self.class.get(hipchat_api_url_for('users/list'), :query => query)
     end
 
     # Get a user's details.
@@ -173,7 +177,7 @@ 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. 
+    # 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.
     #

data/lib/hipchat-api/version.rb

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

data/spec/fakeweb/users_list_include_deleted_response.json

@@ -0,0 +1,29 @@
+{ "users" : [ { "email" : "chris@hipchat.com",
+        "is_group_admin" : 1,
+        "name" : "Chris Rivers",
+        "photo_url" : "https://www.hipchat.com/chris.png",
+        "status" : "away",
+        "status_message" : "gym, bbl",
+        "title" : "Developer",
+        "user_id" : 1
+      },
+      { "email" : "pete@hipchat.com",
+        "is_group_admin" : 1,
+        "name" : "Peter Curley",
+        "photo_url" : "https://www.hipchat.com/pete.png",
+        "status" : "offline",
+        "status_message" : "",
+        "title" : "Designer",
+        "user_id" : 3
+      },
+      { "email" : "garret@hipchat.com",
+        "is_group_admin" : 1,
+        "name" : "Garret Heaton",
+        "photo_url" : "https://www.hipchat.com/garret.png",
+        "status" : "available",
+        "status_message" : "Come see what I'm working on!",
+        "title" : "Co-founder",
+        "user_id" : 5,
+	"is_deleted" : 1
+      }
+    ] }

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.5'
+    HipChat::API::VERSION.should == '1.0.6'
   end
 
   it "should create a new instance with the correct parameters" do
@@ -98,7 +98,7 @@ describe "HipChat::API" do
 
     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'    
+    rooms_message_response['status'].should == 'ok'
   end
 
   it "should return a history of messages" do
@@ -149,6 +149,19 @@ describe "HipChat::API" do
     users_list_response['users'].size.should be 3
   end
 
+  it "should return a list of users including deleted" do
+    FakeWeb.register_uri(:get,
+                         %r|#{HipChat::API::HIPCHAT_API_URL}/users/list.*include_deleted=1|,
+                         :body => File.join(File.dirname(__FILE__), 'fakeweb', 'users_list_include_deleted_response.json'),
+                         :content_type => "application/json")
+
+    users_list_response = @hipchat_api.users_list(include_deleted = 1)
+    users_list_response.should_not be nil
+    users_list_response['users'].size.should be 3
+    users_list_response['users'].select { |u| u['is_deleted'] == 1 }.size.should be 1
+    users_list_response['users'].select { |u| u['is_deleted'] != 1 }.size.should be 2
+  end
+
   it "should show the details for a user" do
     FakeWeb.register_uri(:get,
                          %r|#{HipChat::API::HIPCHAT_API_URL}/users/show|,

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: hipchat-api
 version: !ruby/object:Gem::Version
-  version: 1.0.5
-  prerelease: 
+  version: 1.0.6
 platform: ruby
 authors:
 - David Czarnecki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-04 00:00:00.000000000 Z
+date: 2014-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: fakeweb
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,7 +55,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -78,7 +69,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -86,7 +76,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -101,7 +90,8 @@ files:
 - .document
 - .gitignore
 - .rspec
-- .rvmrc
+- .ruby-gemset
+- .ruby-version
 - .travis.yml
 - CHANGELOG.md
 - Gemfile
@@ -120,6 +110,7 @@ files:
 - spec/fakeweb/rooms_topic_response.json
 - spec/fakeweb/users_create_response.json
 - spec/fakeweb/users_delete_response.json
+- spec/fakeweb/users_list_include_deleted_response.json
 - spec/fakeweb/users_list_response.json
 - spec/fakeweb/users_show_response.json
 - spec/fakeweb/users_undelete_response.json
@@ -128,33 +119,26 @@ files:
 - spec/spec_helper.rb
 homepage: http://github.com/czarneckid/hipchat-api
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2445592630498617141
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2445592630498617141
 requirements: []
 rubyforge_project: hipchat-api
-rubygems_version: 1.8.24
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ruby gem for interacting with HipChat
 test_files:
 - spec/fakeweb/rooms_create_response.json
@@ -166,6 +150,7 @@ test_files:
 - spec/fakeweb/rooms_topic_response.json
 - spec/fakeweb/users_create_response.json
 - spec/fakeweb/users_delete_response.json
+- spec/fakeweb/users_list_include_deleted_response.json
 - spec/fakeweb/users_list_response.json
 - spec/fakeweb/users_show_response.json
 - spec/fakeweb/users_undelete_response.json

data/.rvmrc

@@ -1,3 +0,0 @@
-rvm --create 1.8.7@hipchat-api_gem
-rvm --create 1.9.2@hipchat-api_gem
-rvm --create 1.9.3@hipchat-api_gem