lita-hcadmin 0.3.3

data/lib/lita/handlers/hcadmin.rb

@@ -0,0 +1,441 @@
+require 'benchmark'
+require 'open-uri'
+require 'faraday'
+require 'base64'
+require 'net/smtp'
+require 'logger'
+require 'open-uri'
+
+module Lita
+  module Handlers
+    class Hcadmin < Handler
+      namespace 'hcadmin'
+      config :v1_notify_token, type: String, required: true
+      config :v1_admin_token, type: String, required: true
+      config :v2_admin_token, type: String, required: true
+      config :http_proxy, type: String, required: false
+      config :email_dist_list
+      config :smtp_server
+      config :allowed_domains
+      config :room_change_admins, type: Array, required: false
+      config :account_name, type: String, required: true
+      config :email_domain_name, type: Array, required: true
+      config :http_logging, type: [TrueClass, FalseClass], default: true, required: false
+
+      route(/(?:(?:identify room owner))\s+(.+)/i,
+        :identify_room_owner,
+        help: { 'identify room owner ROOM_NAME' => 'Returns the mention name of the room owner.' })
+
+      route(/(?:(?:identify hipchat admins))/i,
+        :identify_hipchat_admins,
+        help: { 'identify hipchat admins' => 'Returns the mention name of the HipChat Admins.' })
+
+      route(/(?:(?:identify user count))/i,
+        :identify_user_count,
+        help: { 'identify user count' => 'Returns the count of users in the account.' })
+
+      route(/(?:(?:identify room count))/i,
+        :identify_room_count,
+        help: { 'identify room count' => 'Returns the count of rooms in the account.' })
+
+      route(/(?:(?:identify room change admins))/i,
+        :identify_room_change_admins,
+        help: { 'identify room change admins' => 'Returns a list of who can change room ownership' })
+
+      route(/(?:(?:identify status))/i,
+        :identify_status,
+        help: { 'identify status' => 'Returns the status of HipChat.' })
+
+      route(/(?:(?:hipchat sponsor))\s+(.+)/i,
+        :hipchat_sponsor,
+        help: { 'hipchat sponsor EMAIL ADDRESS' => 'Generates an invite to the person being sponsored. Use a valid email address' })
+
+      route(/(?:(?:room owner change))\s+(.+)/i,
+        :room_owner_change,
+        help: { 'room owner change owner_mention_name room_name ' => 'When run as a room change admin, updates the room ownership' })
+
+      route(/(?:(?:room unarchive))/i, #      route(/(?:(?:room unarchive))\s+(.+)/i,
+        :room_unarchive,
+        help: { 'room unarchive room_name ' => 'When run as a room change admin, removes a room from archive' })
+
+      def hipchat_sponsor(response)
+        response.args.each do |r|
+          next if 'sponsor'.include?(r)
+          if email_domain_name.any? { |w| r[w] } # rubocop:disable Style/GuardClause
+            sponsored_user = fetch_user_v2(r.strip)
+            sponsored_user_json = parse(sponsored_user[:body], 'sponsor')
+            if sponsored_user_json['id'] # rubocop:disable Style/GuardClause
+              return response.reply "The email address of #{r} already has an account on #{account_name} of #{sponsored_user_json['id']}"
+            else
+              response.reply "The email address of #{r} was not found. Generating request to #{email_dist_list}"
+              response.reply "Admins have been notified of your request to add #{r}, @#{response.user.name}"
+              send_mail(r, email_dist_list, response.user.name, smtp_server)
+              return response.reply 'Message to admins sent'
+            end
+          else
+            return response.reply "The email address has to be one of: #{email_domain_name.inspect}"
+          end
+        end
+        response.reply 'something'
+      end
+
+      def identify_status(response)
+        status = ''
+        time = Benchmark.measure do
+          status = fetch_status
+        end
+        response.reply "Status of hipchat: Code: #{status[:status]} => #{status[:body]} ( #{time.real.to_i} s. to respond )"
+      end
+
+      def identify_user_count(response)
+        user_count = ''
+        time = Benchmark.measure do
+          user_count = fetch_stats
+          user_count = parse(user_count[:body], 'users')
+          # user_count = parse(fetch_users, 'users')
+        end
+        response.reply "Users in hipchat: #{user_count} ( #{time.real.to_i} s. to respond )"
+      end
+
+      def identify_room_change_admins(response)
+        response.reply 'Users who can change room ownership:'
+        time = Benchmark.measure do
+          if room_change_admins.first.to_s.empty? # rubocop:disable Style/GuardClause
+            return response.reply 'Room change admins: None found from config'
+          else
+            room_change_admins.each do |a|
+              response.reply a.to_s
+            end
+          end
+        end
+        response.reply "room change admins: #{room_change_admins.length} found ( #{time.real.to_i} s. to respond )"
+      end
+
+      def identify_room_count(response)
+        room_count = ''
+        time = Benchmark.measure do
+          room_count = fetch_rooms
+          room_count = parse(room_count[:body], 'rooms')
+        end
+        response.reply "Rooms in hipchat: #{room_count.length} ( #{time.real.to_i} s. to respond )"
+      end
+
+      def identify_hipchat_admins(response)
+        response.reply 'Admin search takes a moment ...'
+        admin_message = nil
+        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']
+            end
+            admin_message = 'complete'
+          end
+        end
+        response.reply "Admin list: #{admin_message} ( #{time.real.to_i} s. to respond )"
+      end
+
+      def identify_room_owner(response)
+        room_name = nil
+        reply_message = nil
+        room_owner = nil
+        time = Benchmark.measure do
+          response.matches.each do |match|
+            room_name = normalize_room_name(match[0])
+          end
+          # get room json
+          response.reply 'Getting rooms ... one moment'
+          room_data = fetch_rooms
+
+          response.reply 'Getting room id ... another moment'
+          room_id = id_from_name(room_name, parse(room_data[:body], 'rooms'))
+
+          response.reply 'Getting the user name from the user ID ... almost there'
+          room_owner = owner_id_from_room_id(room_id, parse(room_data[:body], 'rooms'))
+
+          if room_owner.nil?
+            reply_message = "Room #{room_name} apparently does not have an owner or I could not find a room with that name"
+          elsif room_id.nil?
+            reply_message = "Room #{room_name} apparently does not have an owner or I could not find a room with that name"
+          end
+        end
+
+        if reply_message.nil?
+          user_data = fetch_user(room_owner)
+          owner_mention = owner_name_from_id(parse(user_data[:body], 'user'))
+          reply_message = "The owner of #{room_name} is #{owner_mention}"
+          response.reply reply_message
+        else
+          response.reply reply_message + " ( #{time.real.to_i} s. to respond )"
+        end
+      end
+
+      def parse(json, type)
+        json = JSON.parse(json)
+        case type
+        when 'rooms'
+          json = json['rooms']
+        when 'user'
+          json = json['user']
+        when 'users'
+          json = json['users']
+        when 'status'
+          json = json['body']
+        when 'sponsor'
+          json = json
+        end
+        json
+      end
+
+      def id_from_name(room_name, json)
+        room_id = nil
+        json.each do |j|
+          next unless room_name == j['name'].to_s.downcase.strip
+          room_id = j['room_id']
+        end
+        room_id
+      end
+
+      def owner_id_from_room_id(room_id, json)
+        owner_id = nil
+        json.each do |j|
+          next unless room_id == j['room_id']
+          owner_id = j['owner_user_id']
+        end
+        owner_id
+      end
+
+      def owner_name_from_id(json)
+        user_name = json['mention_name']
+        user_name
+      end
+
+      def room_owner_change(response) # Length check => owner: 1, change: 2, member_name: 3, room_name: 4, room_name can be multiple words!
+        return response.reply 'You are not represented in the room owner change admin group' unless user_in_group(response.user.mention_name, room_change_admins) == true
+        return response.reply "Wrong number of arguments; expected format of owner_name & room_name received arguments: #{response.args.values_at(2..response.args.length - 1)}" unless response.args.length > 3
+        user_details = user_data('@' + response.args[2].to_s)
+        return response.reply "Uh-oh, 404 returned! The user #{response.args[2]} not found" if user_details['id'].nil?
+        room_details = room_data(response.args[3..-1].join(' ').to_s)
+        return response.reply "Uh-oh, 404 returned! The room #{response.args[3..-1].join(' ')} not found" if room_details['id'].nil?
+        room_update = {}
+        room_update['name'] = room_details['name']
+        room_update['privacy'] = room_details['privacy']
+        room_update['is_archived'] = room_details['is_archived']
+        room_update['is_guest_accessible'] = room_details['is_guest_accessible']
+        room_update['topic'] = room_details['topic']
+        room_update['owner'] = { id: user_details['id'].to_s }
+        unless JSON.parse(room_update.to_json) #
+          return response.reply "Unfortunately, I was not able to present valid date to the API: #{room_update}"
+        end
+
+        update_room = http_put("https://api.hipchat.com/v2/room/#{room_details['id']}?auth_token=#{v2_admin_token}&format=json", room_update)
+        response.reply "Room update request sent. HTTP response code: #{update_room.status}"
+      end
+
+      def room_unarchive(response)
+        return response.reply 'You are not represented in the room owner change admin group' unless user_in_group(response.user.mention_name, room_change_admins) == true
+        return response.reply 'Wrong number of arguments; expected format of room_name received arguments' unless response.args.length > 1
+        room_details = room_data(response.args[1..-1].join(' ').to_s)
+        return response.reply "Uh-oh, 404 returned! The room #{response.args[1..-1].join(' ')} not found" if room_details['id'].nil?
+        room_owner = room_details['owner']['id']
+        room_update = {}
+        room_update['name'] = room_details['name']
+        room_update['privacy'] = room_details['privacy']
+        room_update['is_archived'] = false
+        room_update['is_guest_accessible'] = room_details['is_guest_accessible']
+        room_update['topic'] = room_details['topic']
+        room_update['owner'] = { id: room_owner.to_s }
+        update_room = http_put("https://api.hipchat.com/v2/room/#{room_details['id']}?auth_token=#{v2_admin_token}&format=json", room_update)
+        response.reply "Room update request sent. HTTP response code: #{update_room.status}"
+      end
+
+      def fetch_data(api_v, object_type, object_id)
+        object_id = url_encode_name(object_id) if object_id.class == String
+        return 'Wrong API version provided' unless api_v == 'v2'
+        return "Wrong HipChat object type (#{object_type}). Only accepts 'room' or 'user'" unless %w('room', 'user').any? { |s| s.include?(object_type.to_s) }
+        return 'Please provide the object id of the room or user you want information for' if object_id.nil?
+        url = "https://api.hipchat.com/v2/#{object_type}/#{object_id}?auth_token=#{v2_admin_token}&format=json"
+        proxy = http_proxy || nil
+        json = get url, proxy
+        json
+      end
+
+      private
+
+      def user_data(user_name)
+        user_check = JSON.parse(fetch_data('v2', 'user', user_name).to_json)
+        user_details = JSON.parse(user_check['body'])
+        user_details
+      end
+
+      def room_data(room_name)
+        room_check = JSON.parse(fetch_data('v2', 'room', room_name).to_json)
+        room_details = JSON.parse(room_check['body'])
+        room_details
+      end
+
+      def url_encode_name(str)
+        URI.encode(str)
+      end
+
+      def user_in_group(user, group)
+        group.include?(user) ? true : false
+      end
+
+      def username_from_email(email)
+        email_name = email.split('@')[0].strip
+        email_name
+      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
+        json = get url, proxy
+        json
+      end
+
+      def fetch_status # full list
+        url = 'https://api.hipchat.com/v2/health-check'
+        proxy = http_proxy || nil
+        json = get url, proxy
+        json
+      end
+
+      def fetch_stats # fast user count
+        url = "https://api.hipchat.com/v2/group/171096/statistics?auth_token=#{v2_admin_token}&format=json"
+        proxy = http_proxy || nil
+        json = get url, proxy
+        json
+      end
+
+      def fetch_user(user_id)
+        url = "https://api.hipchat.com/v1/users/show?user_id=#{user_id}&auth_token=#{v1_admin_token}&format=json"
+        proxy = http_proxy || nil
+        json = get url, proxy
+        json
+      end
+
+      def fetch_users # full list
+        url = "https://api.hipchat.com/v1/users/list?auth_token=#{v1_admin_token}&format=json"
+        proxy = http_proxy || nil
+        json = get url, proxy
+        json
+      end
+
+      def fetch_user_v2(user_context)
+        url = "https://api.hipchat.com/v2/user/#{user_context}?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
+
+      def http_logging
+        config.http_logging
+      end
+
+      def account_name
+        config.account_name
+      end
+
+      def v1_notify_token
+        config.v1_notify_token
+      end
+
+      def v1_admin_token
+        config.v1_admin_token
+      end
+
+      def v2_admin_token
+        config.v2_admin_token
+      end
+
+      def email_dist_list
+        config.email_dist_list
+      end
+
+      def smtp_server
+        config.smtp_server
+      end
+
+      def http_proxy
+        config.http_proxy
+      end
+
+      def room_change_admins
+        config.room_change_admins
+      end
+
+      def normalize_room_name(room_name)
+        room_name = room_name.to_s.downcase.strip
+        room_name
+      end
+
+      def send_mail(new_user, to_dist_list, from_mention, smtp_server_name)
+        message = <<END_OF_EMAIL
+From:#{username_from_email(new_user)} <#{new_user}>
+To: #{username_from_email(to_dist_list)} <#{to_dist_list}>
+Cc: #{username_from_email(new_user)} <#{new_user}>
+MIME-version: 1.0
+Content-type: text/html
+Subject: request access
+
+
+I have been sponsored by #{from_mention} in HipChat. I'd like an invite.
+END_OF_EMAIL
+        Net::SMTP.start(smtp_server_name) do |mail|
+          mail.send_message message, new_user, to_dist_list, new_user
+          mail.finish
+        end
+      end
+
+      def get(url, _proxy = {})
+        conn = Faraday.new(url: url) do |f|
+          f.request :url_encoded
+          f.response :logger if http_logging
+          f.adapter Faraday.default_adapter
+        end
+
+        response = conn.get do |g|
+          g.options.timeout = 60
+          g.options.open_timeout = 60
+          g.headers['Content-Type'] = 'application/json'
+          g.headers['Accept'] = 'application/json'
+        end
+
+        http_response = { status: response.status, body: response.body }
+        http_response
+      end
+
+      def http_put(url, payload, _proxy = {})
+        conn = http_conn(url)
+        response = conn.put 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
+          h.response :logger if http_logging
+          h.adapter Faraday.default_adapter
+        end
+        @http_conn
+      end
+
+      Lita.register_handler(self)
+    end
+  end
+end

data/lib/lita-hcadmin.rb

@@ -0,0 +1,13 @@
+require 'lita' # rubocop:disable Style/FileName
+require 'lita/version'
+Lita.load_locales Dir[File.expand_path(
+  File.join('..', '..', 'locales', '*.yml'), __FILE__
+)]
+
+require 'lita/handlers/hcadmin'
+require 'lita/version'
+
+Lita::Handlers::Hcadmin.template_root File.expand_path(
+  File.join('..', '..', 'templates'),
+ __FILE__
+)

data/lita-hcadmin.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |spec|
+  spec.name          = "lita-hcadmin"
+  spec.version       = "0.3.3"
+  spec.authors       = ["Jason Walker"]
+  spec.email         = ["jason.walker@target.com"]
+  spec.description   = "HipChat admin plugin for Lita"
+  spec.summary       = "Allow your HipChat admins to interact with the HipChat APIs"
+  spec.homepage      = "https://github.com/target/lita-hipchat-admin"
+  spec.license       = "MIT"
+  spec.metadata      = { "lita_plugin_type" => "handler" }
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "lita", ">= 4.3"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "rspec", ">= 3.0.0"
+  spec.add_development_dependency "rest-client"
+end

data/locales/en.yml

@@ -0,0 +1,4 @@
+en:
+  lita:
+    handlers:
+      hcadmin:

data/spec/fixtures/bad_gateway.txt

@@ -0,0 +1 @@
+<html>\r\n<head><title>502 Bad Gateway</title></head>\r\n<body bgcolor=\"white\">\r\n<center><h1>502 Bad Gateway</h1></center>\r\n<hr><center>nginx</center>\r\n</body>\r\n</html>\r\n

data/spec/fixtures/room_data.json

@@ -0,0 +1,40 @@
+{
+  "rooms": [
+    {
+      "room_id": 31,
+      "name": "floppy drive",
+      "topic": "",
+      "last_active": 55,
+      "created": 56,
+      "owner_user_id": 2341755,
+      "is_archived": false,
+      "is_private": true,
+      "guest_access_url": null,
+      "xmpp_jid": "11_boofar@conf.hipchat.com"
+    },
+    {
+      "room_id": 32,
+      "name": "#DOES15",
+      "topic": "",
+      "last_active": 56,
+      "created": 57,
+      "owner_user_id": 1291419,
+      "is_archived": false,
+      "is_private": true,
+      "guest_access_url": null,
+      "xmpp_jid": "11_boofar@conf.hipchat.com"
+    },
+    {
+      "room_id": 33,
+      "name": "11",
+      "topic": "",
+      "last_active": 58,
+      "created": 59,
+      "owner_user_id": 2483071,
+      "is_archived": false,
+      "is_private": true,
+      "guest_access_url": null,
+      "xmpp_jid": "11_boofar@conf.hipchat.com"
+    }
+  ]
+}

data/spec/fixtures/room_v2_data.json

@@ -0,0 +1,45 @@
+{
+  "avatar_url": null,
+  "created": "2015-04-27T17:55:04+00:00",
+  "delegate_admin_visibility": null,
+  "guest_access_url": null,
+  "id": 1460619,
+  "is_archived": false,
+  "is_guest_accessible": false,
+  "last_active": "2016-02-12T17:32:37+00:00",
+  "links": {
+    "participants": "https://api.hipchat.com/v2/room/55/participant",
+    "self": "https://api.hipchat.com/v2/room/55",
+    "webhooks": "https://api.hipchat.com/v2/room/55/webhook"
+  },
+  "name": "Test Room @ Company.com",
+  "owner": {
+    "id": 66,
+    "links": {
+      "self": "https://api.hipchat.com/v2/user/66"
+    },
+    "mention_name": "Solo",
+    "name": "Red Solo Cup",
+    "version": "D4AFE5D2"
+  },
+  "participants": [
+    {
+      "id": 123,
+      "links": {
+        "self": "https://api.hipchat.com/v2/user/123"
+      },
+      "mention_name": "Paper",
+      "name": "Green Paper Plate",
+      "version": "078RPR8X"
+    }
+  ],
+  "privacy": "public",
+  "statistics": {
+    "links": {
+      "self": "https://api.hipchat.com/v2/room/55/statistics"
+    }
+  },
+  "topic": "Room for testing things",
+  "version": "RR2FE49I",
+  "xmpp_jid": "321_testing__things@conf.hipchat.com"
+}

data/spec/fixtures/stats.json

@@ -0,0 +1,6 @@
+{
+    "links": {
+        "self": "https://api.hipchat.com/v2/group/11/statistics"
+    },
+    "users": 5315
+}

data/spec/fixtures/status.json

@@ -0,0 +1,3 @@
+{
+  "status": "okay"
+}

data/spec/fixtures/user_data.json

@@ -0,0 +1,17 @@
+{
+  "user": {
+    "user_id": 55,
+    "email": "awesome.sauce@company.com",
+    "is_deleted": 0,
+    "is_group_admin": 0,
+    "name": "Awesome Sauce",
+    "mention_name": "AwesomeSauce",
+    "photo_url": "https://s3.amazonaws.com/uploads.hipchat.com/photos/55/CweZ4eN82RiAn7s_125.jpg",
+    "last_active": 10,
+    "created": 9,
+    "status": "available",
+    "status_message": "",
+    "timezone": "America/Chicago",
+    "title": "Awesome dude"
+  }
+}

data/spec/fixtures/user_v2_data.json

@@ -0,0 +1,39 @@
+{
+  "created": "2014-09-19T23:26:09+00:00",
+  "email": "valid_user@company.com",
+  "group": {
+    "id": 22,
+    "links": {
+      "self": "https://api.hipchat.com/v2/group/123"
+    },
+    "name": "TestHipChatAccount"
+  },
+  "id": 11,
+  "is_deleted": false,
+  "is_group_admin": true,
+  "is_guest": false,
+  "last_active": "2015-11-23T14:07:33+0000",
+  "links": {
+    "self": "https://api.hipchat.com/v2/user/boofar"
+  },
+  "mention_name": "JasonWalker",
+  "name": "Jason Walker",
+  "photo_url": "https://s3.amazonaws.com/uploads.hipchat.com/photos/foobar/ZeVseMiEejjdTe3_125.jpg",
+  "presence": {
+    "client": {
+      "type": "http://hipchat.com/client/mac",
+      "version": "202"
+    },
+    "is_online": true,
+    "show": "chat"
+  },
+  "roles": [
+    "owner",
+    "admin",
+    "user"
+  ],
+  "timezone": "America/Chicago",
+  "title": "admin of the things",
+  "version": "LVNLL4UA",
+  "xmpp_jid": "11_11@chat.hipchat.com"
+}

data/spec/fixtures/user_v2_notreal_email.json

@@ -0,0 +1,7 @@
+{
+  "error": {
+    "code": 404,
+    "message": "Target user notreal.email@company.com is not a valid user",
+    "type": "Not Found"
+  }
+}