lita-hcadmin 0.4.5 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fc34b2696ab300c6bed1244ed01dc01669cc8c1d
-  data.tar.gz: 95840dec11fcb76abc0fa97e04404557384dc2f1
+  metadata.gz: c178fe6da37330ea589d254a4544da656a00a1d1
+  data.tar.gz: 4472c5c8421040c42a286f6ac46353fa68f1fe94
 SHA512:
-  metadata.gz: 77fa03c6b253ebc43344c803f928bc53d34d7fe4e03f2ef93a670ed2b179aa05f7999ed2ead110c87a4e2a89d616d3fb04d059e95c184d393a9df512f4c816a6
-  data.tar.gz: c33814a51cf56658ba0d516c09f6a7a36ca3497110404ebbefb02c8e092d3c315532e51568737c2990d053cfff6226da8a5206b0b02aaf8696db17effbdd23c9
+  metadata.gz: 7d65fb91aa31dcae91f67b7e3db1048cba3cfbf31250101a499a38a04964af18529ac49dbfcd664b5b307d9109b9ebfb5660532bca9a34fe96a8851860b757c4
+  data.tar.gz: f811402bb564ff1e41336e38e3321320f4d42f69ba8ab2a0349fdbd84b69d1dc4286bd2e258382b7ccd08d735570384f32fae992729ada1ba5da2b19e7a72c06

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # lita-hcadmin
 
+[0.5.3]
+---------
+- [desktophero] - 
+  - Fixed pagination for multiple API requests
+
+[0.5.2]
+---------
+- [desktophero] - not released
+  - Modify the HipChat admin pagination from multiple requests to the Get All User API
+
+[0.5.1]
+---------
+- [desktophero] - Not released
+  - Modify the HipChat admin return set
+
+[0.5.0]
+---------
+- [desktophero] - Not released
+  - Update HipChat admin lookup to V2 API
+  - Update applicable tests, including additional fixture for V2 Get Users
+  - Remove old tests
+
 [0.4.5]
 ---------
 - [desktophero] - Update tests to use `subject` and objects to validate private methods

data/lib/lita/handlers/hcadmin.rb

@@ -148,22 +148,23 @@ module Lita
       end
 
       def identify_hipchat_admins(response)
-        response.reply 'Admin search takes a moment ...'
-        admin_message = nil
+        response.reply 'Admin search takes about a minute ...'
+        @all_admins = []
+        batch_count = user_count_api_iterations
+
         time = Benchmark.measure do
-          parse_users = fetch_users
-          if parse_users[:status] != 200
-            admin_message = "I ran into an HTTP error ( HTTP code: #{parse_users[:status]} )"
-          else
-            all_users = parse(parse_users[:body], 'users')
-            all_users.each do |u|
-              next if u['is_group_admin'] == 0
-              response.reply u['mention_name']
+          (0..batch_count + 1).each do |i|
+            i = i * 1000 - 1 unless i == 0 # fun with math!
+            response.reply "Checking users ( through #{i})"
+            parse_users = fetch_all_users_v2(i)
+            return response.reply "Admin list: I ran into an HTTP error ( HTTP code: #{parse_users[:status]} )" if parse_users[:status] != 200
+            all_users = parse(parse_users[:body], 'sponsor')
+            all_users['items'].each do |u|
+              admin_list(u['mention_name']) if u['is_group_admin'] == true
             end
-            admin_message = 'complete'
           end
         end
-        response.reply "Admin list: #{admin_message} ( #{time.real.to_i} s. to respond )"
+        response.reply "Admin list: #{@all_admins.join(', ')} ( #{time.real.to_i} s. to respond )"
       end
 
       def identify_room_owner(response)
@@ -188,6 +189,8 @@ module Lita
           json = json['rooms']
         when 'user'
           json = json['user']
+        when 'items'
+          json = json['items']
         when 'users'
           json = json['users']
         when 'status'
@@ -285,6 +288,18 @@ module Lita
 
       private
 
+      def user_count_api_iterations
+        total_users = fetch_stats
+        total_users = parse(total_users[:body], 'users')
+        user_count_api_iterations = total_users / 1000
+        return 1 if user_count_api_iterations < 1
+        user_count_api_iterations
+      end
+
+      def admin_list(admin_mention)
+        @all_admins.push admin_mention
+      end
+
       def domain_from_email(email)
         at = email.index('@')
         email[at..-1]
@@ -374,6 +389,13 @@ module Lita
         json
       end
 
+      def fetch_all_users_v2(iteration)
+        url = "https://api.hipchat.com/v2/user?expand=items&max-results=1000&start-index=#{iteration}&auth_token=#{v2_admin_token}&format=json&"
+        proxy = http_proxy || nil
+        json = get url, proxy
+        json
+      end
+
       def email_domain_name
         config.email_domain_name
       end

data/lita-hcadmin.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "lita-hcadmin"
-  spec.version       = "0.4.5"
+  spec.version       = "0.5.3"
   spec.authors       = ["Jason Walker"]
   spec.email         = ["jason.walker@target.com"]
   spec.description   = "HipChat admin plugin for Lita"

data/spec/fixtures/stats.json

@@ -2,5 +2,5 @@
     "links": {
         "self": "https://api.hipchat.com/v2/group/11/statistics"
     },
-    "users": 5315
+    "users": 900
 }

data/spec/lita/handlers/hcadmin_spec.rb

@@ -9,6 +9,8 @@ describe Lita::Handlers::Hcadmin, lita_handler: true do
   let(:user_json) { File.read(File.join('spec', 'fixtures', 'user_data.json')) }
   let(:all_user_json) { File.read(File.join('spec', 'fixtures', 'users_data.json')) }
   let(:user_v2_json) { File.read(File.join('spec', 'fixtures', 'v2_user_data.json')) }
+  let(:all_users_v2_json) { File.read(File.join('spec', 'fixtures', 'user_v2_all_users.json')) }
+  let(:all_users_v2_json_no_admins) { File.read(File.join('spec', 'fixtures', 'user_v2_all_users_no_admins.json')) }
   let(:user_v2_noaccount) { File.read(File.join('spec', 'fixtures', 'user_v2_notreal_email.json')) }
   let(:user_v2_not_found) { File.read(File.join('spec', 'fixtures', 'v2_user_not_found.json')) }
   let(:room_v2_not_found) { File.read(File.join('spec', 'fixtures', 'v2_room_not_found.json')) }
@@ -296,6 +298,58 @@ describe Lita::Handlers::Hcadmin, lita_handler: true do
         body: user_v2_json,
         headers: {}
       )
+
+    stub_request(:get, 'https://api.hipchat.com/v2/user?expand=items&auth_token=abc&format=json&max-results=1000&start-index=0')
+      .with(
+        headers: {
+          'Accept' => 'application/json',
+          'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+          'Content-Type' => 'application/json',
+          'User-Agent' => 'Faraday v0.9.2' })
+      .to_return(
+        status: 200,
+        body: all_users_v2_json,
+        headers: {}
+      )
+
+    stub_request(:get, 'https://api.hipchat.com/v2/user?expand=items&auth_token=abc&format=json&max-results=1000&start-index=999')
+      .with(
+        headers: {
+          'Accept' => 'application/json',
+          'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+          'Content-Type' => 'application/json',
+          'User-Agent' => 'Faraday v0.9.2' })
+      .to_return(
+        status: 200,
+        body: all_users_v2_json_no_admins,
+        headers: {}
+      )
+
+    stub_request(:get, 'https://api.hipchat.com/v2/user?expand=items&auth_token=abc&format=json&max-results=1000&start-index=1999')
+      .with(
+        headers: {
+          'Accept' => 'application/json',
+          'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+          'Content-Type' => 'application/json',
+          'User-Agent' => 'Faraday v0.9.2' })
+      .to_return(
+        status: 200,
+        body: all_users_v2_json_no_admins,
+        headers: {}
+      )
+
+    stub_request(:get, 'https://api.hipchat.com/v2/group/171096/statistics?auth_token=abc&format=json')
+      .with(
+        headers: {
+          'Accept' => 'application/json',
+          'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+          'Content-Type' => 'application/json',
+          'User-Agent' => 'Faraday v0.9.2' })
+      .to_return(
+        status: 200,
+        body: group_stats,
+        headers: {}
+      )
   end
 
   it 'routes the identify room owner command room name has spaces' do
@@ -389,47 +443,33 @@ describe Lita::Handlers::Hcadmin, lita_handler: true do
 
   describe '#identify_hipchat_admins' do
     describe 'successful HTTP request against the API' do
-      before(:each) do
-        stub_request(:get, 'https://api.hipchat.com/v1/users/list?auth_token=123&format=json')
-          .with(
-            headers: {
-              'Accept' => 'application/json',
-              'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
-              'Content-Type' => 'application/json',
-              'User-Agent' => 'Faraday v0.9.2' })
-          .to_return(
-            status: 200,
-            body: all_user_json,
-            headers: {}
-          )
-      end
       it 'receives a list of admins from a JSON payload' do
         send_command('identify hipchat admins')
-        expect(replies.last).to eq('Admin list: complete ( 0 s. to respond )')
+        expect(replies.last).to eq('Admin list: DummyAccount, DummyAccount3 ( 0 s. to respond )')
       end
     end
 
     describe 'handles Bad Gateway errors' do
       before(:each) do
-        stub_request(:get, 'https://api.hipchat.com/v1/users/list?auth_token=123&format=json')
+        stub_request(:get, 'https://api.hipchat.com/v2/user?expand=items&auth_token=abc&format=json&max-results=1000&start-index=0')
           .with(headers: { 'Accept' => 'application/json', 'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type' => 'application/json', 'User-Agent' => 'Faraday v0.9.2' })
           .to_return(status: 502, body: bad_gateway, headers: {})
       end
       it 'sends a request for admins that fails with a 502 and responds with exception details' do
         send_command('identify hipchat admins')
-        expect(replies.last).to eq('Admin list: I ran into an HTTP error ( HTTP code: 502 ) ( 0 s. to respond )')
+        expect(replies.last).to eq('Admin list: I ran into an HTTP error ( HTTP code: 502 )')
       end
     end
 
     describe 'handles non-200 series' do
       before(:each) do
-        stub_request(:get, 'https://api.hipchat.com/v1/users/list?auth_token=123&format=json')
+        stub_request(:get, 'https://api.hipchat.com/v2/user?expand=items&auth_token=abc&format=json&max-results=1000&start-index=0')
           .with(headers: { 'Accept' => 'application/json', 'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type' => 'application/json', 'User-Agent' => 'Faraday v0.9.2' })
           .to_return(status: 501, body: bad_gateway, headers: {})
       end
       it 'sends a request for admins that fails with a 501 and responds with exception details' do
         send_command('identify hipchat admins')
-        expect(replies.last).to eq('Admin list: I ran into an HTTP error ( HTTP code: 501 ) ( 0 s. to respond )')
+        expect(replies.last).to eq('Admin list: I ran into an HTTP error ( HTTP code: 501 )')
       end
     end
   end # end identify_hipchat_admins

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita-hcadmin
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.5.3
 platform: ruby
 authors:
 - Jason Walker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-23 00:00:00.000000000 Z
+date: 2016-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita