lita-hcadmin 0.3.5 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea505de875b8f0e2b8e23e48b73f74dfdd841aca
-  data.tar.gz: 1723fa99de97712ef95809ead9eb19061c056360
+  metadata.gz: 4e35066ec0936361e47aba8dced07c20c011741d
+  data.tar.gz: bf0d87dbc41f183bf67a3fb14c07aebfedd2009c
 SHA512:
-  metadata.gz: c4721968c8703aaf7a5dfb4c14a583ff05f3b40b5e88d04c46249775ae5b5c538461322ee6efee7fc81ee1fadb003a1d8a1175af021c818a2d36a751426c9d88
-  data.tar.gz: a4839fdf71f065c4ffe43ccab69f6be0b41b6033d9953cff4d1575be0b09d1e3229a223a405aed8b1aa1cdc8c120ca3d50beb846e92d82b19fad1940123c61f0
+  metadata.gz: 09e7acd16ce9e3de0176420d127f75cd5c52450cd1ffc17ca4e1782c9c232e589de6e0a270bc711004047fed7bb4b453fb4e71318419162a8037652ab1f3a204
+  data.tar.gz: d00d1bc5047e1af4bfa5483c807e3a62c2e9dab975604fa4023941747dbac87ab626d1d8100927aa700e21f11cea7720617d690b9e95ac6d665c22728db937d7

data/.rubocop.yml

@@ -26,3 +26,9 @@ AllCops:
   Exclude:
     - 'Rakefile'
     - 'lita-hcadmin.gemspec'
+
+CyclomaticComplexity:
+  Max: 12
+
+PerceivedComplexity:
+  Max: 12

data/.travis.yml

@@ -13,4 +13,5 @@ before_script:
   - eval "$(/opt/chefdk/bin/chef shell-init bash)"
 script:
   - /opt/chefdk/embedded/bin/bundle install
+  - /opt/chefdk/embedded/bin/bundle exec bundle-audit check --update
   - /opt/chefdk/embedded/bin/bundle exec rake

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # lita-hcadmin
 
+[0.4.0]
+---------
+- [desktophero] - Activate user
+- [desktophero] - Show user admin list
+
+[0.3.5]
+---------
+- [desktophero] - Small updates to existing functions:
+* [desktophero] - Identify room owner now uses HipChat V2 API
+* Remove wild cards from some of the routes
+* Cleaned up needless code for room owner lookup
+* Leveled up some tests
+
+[0.3.4]
+---------
+- [desktophero] - Not released. Found url encoding issue for room owner identify route
+
 [0.3.3]
 ---------
 - [desktophero] - Fix unarchive logic for multi-word names

data/Gemfile

@@ -8,3 +8,4 @@ gem 'simplecov'
 gem 'coveralls'
 gem 'webmock'
 gem 'rubocop'
+gem 'bundler-audit'

data/README.md

@@ -148,6 +148,31 @@ room owner change RealName FakeRoom
 bot: Uh-oh, 404 returned! The room FakeRoom not found
 ```
 
+### identify user change admins
+```
+identify user change admins
+bot: Users who can change user details
+MentionName1
+MentionName2
+```
+
+The list of names is defined in `Lita.config.handlers.hcadmin.user_change_admins` as an array of MentionNames
+
+### user activate
+```
+user activate <email_name@company.com>
+bot: Added user with status code 201
+```
+
+A couple of checks:
+```
+user activate <bad_email@companyom>
+bot: First value needs to be a valid email address
+```
+```
+user activate <in_user_email@company.com>
+bot: That email is already in use.
+```
 
 ## TO-DOs
 The Issues for this repo will be used to accept, collaborate, and complete `TO-DOs`

data/lib/lita/handlers/hcadmin.rb

@@ -43,6 +43,10 @@ module Lita
         :identify_room_change_admins,
         help: { 'identify room change admins' => 'Returns a list of who can change room ownership' })
 
+      route(/identify user change admins/,
+        :identify_user_change_admins,
+        help: { 'identify user change admins' => 'Returns a list of who can change user accounts' })
+
       route(/identify status/,
         :identify_status,
         help: { 'identify status' => 'Returns the status of HipChat.' })
@@ -59,9 +63,9 @@ module Lita
         :room_unarchive,
         help: { 'room unarchive room_name ' => 'When run as a room change admin, removes a room from archive' })
 
-      route(/((user activate))\s+(.+)/i,
+      route(/(?:(?:user activate))\s+(.+)/i,
         :user_activate,
-        help: { 'user activate email name' => 'When run as a user admin, generates an invite to the email account' })
+        help: { 'user activate email@company' => 'When run as a user admin, generates an invite to the email account' })
 
       def hipchat_sponsor(response)
         response.args.each do |r|
@@ -116,6 +120,20 @@ module Lita
         response.reply "room change admins: #{room_change_admins.length} found ( #{time.real.to_i} s. to respond )"
       end
 
+      def identify_user_change_admins(response)
+        response.reply 'Users who can change user details:'
+        time = Benchmark.measure do
+          if user_change_admins.first.to_s.empty? # rubocop:disable Style/GuardClause
+            return response.reply 'User change admins: None found from config'
+          else
+            user_change_admins.each do |a|
+              response.reply a.to_s
+            end
+          end
+        end
+        response.reply "user change admins: #{user_change_admins.length} found ( #{time.real.to_i} s. to respond )"
+      end
+
       def identify_room_count(response)
         room_count = ''
         time = Benchmark.measure do
@@ -227,12 +245,38 @@ module Lita
       end
 
       def user_activate(response)
-        # puts response.args
-        return response.reply 'First value should be a valid email address' unless valid_email?(response.args[0]) == 0
+        return response.reply 'You are not represented in the USER admin group' unless user_in_group(response.user.mention_name, user_change_admins) == true
+        user_data = user_account_parse(response.matches)
+        user_email = user_data[0]
+        user_name = username_from_email(user_email)
+        return response.reply 'First value needs to be a valid email address' unless valid_email?(user_email) == 0
+        unless email_domain_name.include? domain_from_email(user_email)
+          return response.reply "That email address is not in the approved list to activate. Approved email accounts: #{email_domain_name}"
+        end
+        user_data_check = user_exists?(user_email)
+        return response.reply 'That email is already in use but in a different HipChat account.' if user_data_check[:status] == 409
+        return response.reply 'That email is already an active user in this HipChat account' if user_data_check[:status] == 200
+        return response.reply "I did not understand the status code from HipChat: #{user_data_check[:status]}" unless user_data_check[:status] == 404
+        user_response = http_post("https://api.hipchat.com/v2/user?auth_token=#{v2_admin_token}&format=json", name: user_name, email: user_email)
+        return response.reply "Error while trying to add user: #{user_response.status} -- #{user_response.body}" unless user_response.status == 201
+        response.reply "Added user with status code #{user_response.status}"
       end
 
       private
 
+      def domain_from_email(email)
+        at = email.index('@')
+        email[at..-1]
+      end
+
+      def user_exists?(email)
+        fetch_data('v2', 'user', email)
+      end
+
+      def user_account_parse(data)
+        data[0][0].split(' ')
+      end
+
       def valid_email?(email_value)
         valid_email_reg = /\A[\w+\-.]+@[a-z\d\-.]+\.[a-z]+\z/i
         email_value =~ valid_email_reg
@@ -263,6 +307,10 @@ module Lita
         email_name
       end
 
+      def camelize_username(data)
+        data.split('.').collect(&:capitalize).join
+      end
+
       def fetch_rooms # full list
         url = "https://api.hipchat.com/v1/rooms/list?auth_token=#{v1_admin_token}&format=json"
         proxy = http_proxy || nil
@@ -345,6 +393,10 @@ module Lita
         config.room_change_admins
       end
 
+      def user_change_admins
+        config.user_change_admins
+      end
+
       def normalize_room_name(room_name)
         room_name = room_name.to_s.downcase.strip
         room_name
@@ -398,6 +450,18 @@ END_OF_EMAIL
         response
       end
 
+      def http_post(url, payload, _proxy = {})
+        conn = http_conn(url)
+        response = conn.post do |c|
+          c.options.timeout = 60
+          c.options.open_timeout = 60
+          c.headers['Content-Type'] = 'application/json'
+          c.headers['Accept'] = 'application/json'
+          c.body = payload.to_json
+        end
+        response
+      end
+
       def http_conn(url)
         @http_conn = Faraday.new(url: url) do |h|
           h.request :url_encoded

data/lita-hcadmin.gemspec

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

data/spec/fixtures/user_v2_already_exists.json

@@ -0,0 +1,7 @@
+{
+  "error": {
+    "code": 409,
+    "message": "Email already in use by another user",
+    "type": "Conflict"
+  }
+}

data/spec/lita/handlers/hcadmin_spec.rb

@@ -33,6 +33,7 @@ describe Lita::Handlers::Hcadmin, lita_handler: true do
       config.handlers.hcadmin.email_dist_list = 'blahblah@company.com'
       config.handlers.hcadmin.smtp_server = 'smtp.mailserverstuffandthings.com'
       config.handlers.hcadmin.room_change_admins = ['TestAdmin', 'AnotherAdmin'] # rubocop:disable Style/WordArray
+      config.handlers.hcadmin.user_change_admins = ['UserAdmin', 'AnotherAdmin'] # rubocop:disable Style/WordArray
       config.handlers.hcadmin.account_name = 'TestHipChatAccount'
       config.handlers.hcadmin.email_domain_name = ['@company.com', '@network.net']
       config.handlers.hcadmin.http_logging = false
@@ -165,6 +166,35 @@ describe Lita::Handlers::Hcadmin, lita_handler: true do
         body: '',
         headers: {}
       )
+
+    stub_request(:post, 'https://api.hipchat.com/v2/user?auth_token=abc&format=json')
+      .with(
+        body: "{\"name\":\"new.person\",\"email\":\"new.person@company.com\"}", # rubocop:disable Style/StringLiterals
+        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: 201,
+        body: '',
+        headers: {}
+      )
+
+    stub_request(:post, 'https://api.hipchat.com/v2/user?auth_token=abc&format=json')
+      .with(
+        body: "{\"name\":\"email.name\",\"email\":\"email.name@company.com\"}", # rubocop:disable Style/StringLiterals
+        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: 201,
+        body: '',
+        headers: {}
+      )
+
     stub_request(:get, 'https://api.hipchat.com/v2/room/real%20room?auth_token=abc&format=json')
       .with(
         headers: {
@@ -177,6 +207,7 @@ describe Lita::Handlers::Hcadmin, lita_handler: true do
         body: room_v2_json,
         headers: {}
       )
+
     stub_request(:get, 'https://api.hipchat.com/v2/room/foobar?auth_token=abc&format=json')
       .with(
         headers: {
@@ -201,6 +232,18 @@ describe Lita::Handlers::Hcadmin, lita_handler: true do
         body: room_v2_json,
         headers: {}
       )
+    stub_request(:get, 'https://api.hipchat.com/v2/user/email.name@company.com?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: 404,
+        body: user_v2_not_found,
+        headers: {}
+      )
   end
 
   it 'routes the identify room owner command room name has spaces' do
@@ -239,6 +282,10 @@ describe Lita::Handlers::Hcadmin, lita_handler: true do
     is_expected.to route_command('identify room change admins').to(:identify_room_change_admins)
   end
 
+  it 'routes user change admin requests' do
+    is_expected.to route_command('identify user change admins').to(:identify_user_change_admins)
+  end
+
   it 'routes room owner change requests' do
     is_expected.to route_command('room owner change mention_name room_name').to(:room_owner_change)
   end
@@ -252,8 +299,8 @@ describe Lita::Handlers::Hcadmin, lita_handler: true do
   end
 
   describe '#hipchat_sponsor' do
-    context 'validates the new account request is for a Target.com email address' do
-      it 'rejects non-Target.com email addresses' do
+    context 'validates the new account request is for a company.com email address' do
+      it 'rejects non-company.com email addresses' do
         send_command('hipchat sponsor dummy@gmail.com')
         expect(replies.last).to eq('The email address has to be one of: ["@company.com", "@network.net"]')
       end
@@ -422,28 +469,6 @@ describe Lita::Handlers::Hcadmin, lita_handler: true do
     end
   end
 
-  # describe '#owner_name_from_id' do
-  #   # before(:each) do
-  #   #   allow(described_class).to receive(:owner_name_from_id).with(31, user_json).and_return('AwesomeSauce')
-  #   # end
-  #   let(:user_mention_name) { subject.owner_name_from_id(user_json) }
-  #   context 'an owner id can be translated to an owner name' do
-  #     it 'returns the mention name field from JSON data' do
-  #       # expect(described_class.owner_name_from_id(31, user_json)).to eq 'AwesomeSauce'
-  #       expect(user_mention_name).to eq 'AwesomeSauce'
-  #     end
-  #   end
-  # end
-  #
-  # describe '#id_from_name' do
-  #   let(:room_search) { subject.id_from_name('floppy drive', room_json) }
-  #   context 'returns the room_id from the room_name' do
-  #     it 'does not error when getting the ID from name' do
-  #       expect(room_search).to eq 31
-  #     end
-  #   end
-  # end
-
   describe '#identify_room_count' do
     context 'room count is returned when called' do
       it 'returns the number of rooms when requested' do
@@ -573,13 +598,84 @@ describe Lita::Handlers::Hcadmin, lita_handler: true do
 
   describe '#user_activate' do
     context 'reactivates a person' do
+      it 'blocks an activation if requestor is not a user admin' do
+        send_command('user activate email.name@companycom', as: regular_member)
+        expect(replies.last).to include('You are not represented in the USER admin group')
+      end
+
       it 'catches if the user does not use a real email address' do
-        send_command('user activate email@companycom')
-        expect(replies.last).to include('First value should be a valid email address')
+        send_command('user activate email.name@companycom', as: user_change_admin_member)
+        expect(replies.last).to include('First value needs to be a valid email address')
       end
-      it 'does stuff' do
-        send_command('user activate email@company.com')
+
+      it 'rejects non-company.com email addresses' do
+        send_command('user activate dummy@gmail.com', as: user_change_admin_member)
+        expect(replies.last).to eq('That email address is not in the approved list to activate. Approved email accounts: ["@company.com", "@network.net"]')
+      end
+
+      it 'adds a user if the inputs are sane' do
+        send_command('user activate email.name@company.com Test Account', as: user_change_admin_member)
+        expect(replies.last).to include('Added user with status code 201')
+      end
+    end
+
+    context 'the user account already exists' do
+      let(:user_v2_already_exists) { File.read(File.join('spec', 'fixtures', 'user_v2_already_exists.json')) }
+      before do
+        stub_request(:get, 'https://api.hipchat.com/v2/user/existing.person@company.com?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: 409,
+            body: user_v2_already_exists,
+            headers: {}
+          )
+      end
+      it 'returns a 409 when the account exists in another account' do
+        send_command('user activate existing.person@company.com', as: user_change_admin_member)
+        expect(replies.last).to eq 'That email is already in use but in a different HipChat account.'
+      end
+    end
+    context 'the user account already exists' do
+      let(:user_v2_new) { File.read(File.join('spec', 'fixtures', 'v2_user_not_found.json')) }
+      before do
+        stub_request(:get, 'https://api.hipchat.com/v2/user/new.person@company.com?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: 404,
+            body: user_v2_not_found,
+            headers: {}
+          )
+      end
+      it 'validates a new account is legit' do
+        send_command('user activate new.person@company.com', as: user_change_admin_member)
+        expect(replies.last).to eq 'Added user with status code 201'
       end
     end
   end
+
+  describe '#identify_user_change_admins' do
+    context 'returns the user change admins' do
+      it 'names are returned' do
+        send_command('identify user change admins')
+        expect(replies.last).to include('user change admins')
+      end
+    end
+
+    context 'shows UserAdmin name from hcadmin.config' do
+      it 'shows the UserAdmin was returned' do
+        send_command('identify user change admins')
+        expect(replies).to include('UserAdmin')
+      end
+    end
+  end # end room change admins
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita-hcadmin
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.4.2
 platform: ruby
 authors:
 - Jason Walker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-30 00:00:00.000000000 Z
+date: 2016-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita
@@ -134,6 +134,7 @@ files:
 - spec/fixtures/stats.json
 - spec/fixtures/status.json
 - spec/fixtures/user_data.json
+- spec/fixtures/user_v2_already_exists.json
 - spec/fixtures/user_v2_data.json
 - spec/fixtures/user_v2_notreal_email.json
 - spec/fixtures/users_data.json
@@ -175,6 +176,7 @@ test_files:
 - spec/fixtures/stats.json
 - spec/fixtures/status.json
 - spec/fixtures/user_data.json
+- spec/fixtures/user_v2_already_exists.json
 - spec/fixtures/user_v2_data.json
 - spec/fixtures/user_v2_notreal_email.json
 - spec/fixtures/users_data.json