lita-hcadmin 0.3.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dbb668a3f1776c2b498ad15764a56d7f1b309347
+  data.tar.gz: 27af7e8a66abb2e65e4ba40c38ab87688c28331a
+SHA512:
+  metadata.gz: 7b888e6b7888f5d3412797d9cd28a33d293beb350861c9ec7b2eb72647ca5fc4ea918b05a99bb96b99c254033ef5f331bf5670346a810e0af543e3b3224fe27e
+  data.tar.gz: 57975f9f90f363f2f24ddee9ababc163da5f785ee6b0280298c18a3b8efbb47087a93f40a695cbf6be0c384dda39b4feff423c7eb3220a921a0c60b4b78f91ed

data/.gitignore

@@ -0,0 +1,20 @@
+.DS_Store
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.gem
+.coveralls.yml

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.rubocop.yml

@@ -0,0 +1,28 @@
+AlignParameters:
+  Enabled: false
+
+Encoding:
+  Enabled: false
+
+LineLength:
+  Max: 240
+
+Documentation:
+  Enabled: false
+
+ClassLength:
+  Max: 400
+
+AbcSize:
+  Max: 60
+
+MethodLength:
+  Max: 30
+
+GuardCause:
+  Enabled: false
+
+AllCops:
+  Exclude:
+    - 'Rakefile'
+    - 'lita-hcadmin.gemspec'

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+rvm:
+- 2.0
+sudo: false
+addons:
+  apt:
+    sources:
+      - chef-current-precise
+    packages:
+      - chefdk
+
+before_script:
+  - eval "$(/opt/chefdk/bin/chef shell-init bash)"
+script:
+  - /opt/chefdk/embedded/bin/bundle install
+  - /opt/chefdk/embedded/bin/bundle exec rake

data/CHANGELOG.md

@@ -0,0 +1,41 @@
+# lita-hcadmin
+
+[0.3.3]
+---------
+- [desktophero] - Fix unarchive logic for multi-word names
+
+[0.3.2]
+---------
+- [desktophero] - Fix unarchive logic for unfound rooms
+
+[0.3.1]
+---------
+- [desktophero] - Unarchive room as a room change admin
+
+[0.2.19]
+---------
+- [desktophero] - Allow an existing user to send an invite request to admins (hipchat sponsor <email>)
+
+[0.2.1]
+---------
+- [desktophero] - Room Count request method update
+
+[0.2.0]
+---------
+- [desktophero] - Switch HTTP Client to Faraday; response includes HTTP response and body for HipChatAPI commands
+
+[0.1.15]
+---------
+- [desktophero] - Added time to respond to room owner request; updated help return text
+
+[0.1.15]
+---------
+- [desktophero] - Added time to respond to more functions; update to README
+
+[0.1.13]
+---------
+- [desktophero] - Identify hipchat status
+
+[0.1.0]
+---------
+- [desktophero] - Initial cookbook

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rspec'
+gem 'fakeredis'
+gem 'simplecov'
+gem 'coveralls'
+gem 'webmock'
+gem 'rubocop'

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016, Target Corporation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,163 @@
+# lita-hcadmin
+
+[![Build Status](https://travis-ci.org/target/lita-hipchat-admin.svg?branch=master)](https://travis-ci.org/target/lita-hipchat-admin)
+
+## Why?
+This handler for Lita (https://www.lita.io/) extends the Lita HipChat adapter (https://github.com/litaio/lita-hipchat)
+and focuses on allowing admin type commands and visibility into the HipChat account. See commands below.
+
+## Installation
+
+Add lita-hcadmin to your Lita instance's Gemfile:
+
+``` ruby
+gem "lita-hcadmin"
+```
+
+## Setup
+Only validated with Lita v4.4 and newer.
+Only validated with HipChat SaaS.
+
+## Configuration
+
+```ruby
+Lita.configure do |config|
+  config.handlers.hcadmin.v1_notify_token = '<v1_notification_token>' # for using HipChat API V1 notification scopes; required
+  config.handlers.hcadmin.v1_admin_token = '<v1_admin_token>' # for using HipChat API V1 administration scopes; required
+  config.handlers.hcadmin.v2_admin_token = '<v2_admin_token>' # for using HipChat API V2 administration scopes; required
+  config.handlers.hcadmin.http_proxy = "<some_company_proxy>" # if a proxy is used; optional
+  config.handlers.hcadmin.email_dist_list = "user@company.com" # valid email address to send sponsor requests
+  config.handlers.hcadmin.smtp_server = "smtp.company.com" # to specify the smtp server for emails
+  config.handlers.hcadmin.room_change_admins = ["hipchat", "user", "array", "of", "menionnames"] #
+  config.handlers.hcadmin.hipchat_account_name = "<name of account>"
+end
+```
+
+
+## Usage
+
+Help output:
+```
+identify room owner ROOM_NAME - Returns the mention name of the room owner.
+identify hipchat admins - Returns the mention name of the HipChat Admins.
+identify user count - Returns the count of users in <account_name>.
+identify room count - Returns the count of rooms in <account_name>.
+identify room change admins - Returns a list of who can change room ownership
+identify status - Returns the status of HipChat.
+hipchat sponsor EMAIL ADDRESS - Generates an invite to the person being sponsoered. Use a valid Target.com email address
+```
+
+
+### identify room owner
+```
+identify room owner foobar
+bot: Getting rooms ... one moment
+Getting room id ... another moment
+Getting the user name from the user ID ... almost there
+```
+Either a room owner is identified:
+```
+The owner of foobar is MentionName
+```
+or, the bot responds with details
+```
+Room foobar apparently does not have an owner or I could not find a room with that name ( 8 s. to respond )
+```
+
+
+### identify hipchat Admins
+```
+identify hipchat admins
+bot: Admin search takes a moment ...
+
+bot: MentionName1
+MentionName2
+MentionName3
+MentionName4
+```
+#### data above is sample information
+
+### identify room count
+```
+identify room count
+bot: Rooms in hipchat: 2213 ( 2 s. to respond )
+```
+#### data above is sample information
+
+### identify user count
+```
+identify user count
+bot: Users in hipchat: 4971 ( 15 s. to respond )
+```
+#### data above is sample information
+
+### identify status
+```
+identify status
+bot: Status of hipchat: Code: 200 => {"status": "okay"} ( 0 s. to respond )
+```
+-- data above is sample information
+
+### hipchat sponsor <EMAIL_ADDRESS>
+```
+hipchat sponsor <email_account@company.com>
+The email address of email_account@company.com was not found. Generating request to admins
+Admins have been notified of your request to add email_account@company.com, @requestor_name
+Message to admins sent
+```
+
+This generates an email to the address defined in `Lita.config.handlers.hcadmin.email_dist_list`
+
+### identify room change admins
+```
+identify room change admins
+bot: Users who can change room ownership
+MentionName1
+MentionName2
+```
+
+The list of names is defined in `Lita.config.handlers.hcadmin.room_change_admins` as an array of MentionNames
+
+### room owner change NewOwnerMentionName RoomName
+```
+room owner change NewOwner RoomName
+bot: Room update request sent. HTTP response code: 204
+```
+
+If the user can't be found
+```
+room owner change FakeName RoomName
+bot: Uh-oh, 404 returned! The user FakeName not found
+```
+
+If the room can't be found
+```
+room owner change RealName FakeRoom
+bot: Uh-oh, 404 returned! The room FakeRoom not found
+```
+
+### room unarchive RoomName
+```
+room unarchive RoomName
+bot: Room update request sent. HTTP response code: 204
+```
+
+If the room can't be found
+```
+room owner change RealName FakeRoom
+bot: Uh-oh, 404 returned! The room FakeRoom not found
+```
+
+
+## TO-DOs
+The Issues for this repo will be used to accept, collaborate, and complete `TO-DOs`
+
+## License and Author
+
+Author:: Jason Walker (<jason.walker@target.com> , [desktophero])
+
+```text
+Copyright:: 2016, Target Corporation
+
+See License for details
+```

data/Rakefile

@@ -0,0 +1,26 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+task default: :ci_checks
+
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Run all style tests'
+
+namespace :style do
+  desc 'Test ruby style against guidelines from rubocop'
+  task :rubocop do
+    RuboCop::RakeTask.new
+  end
+end
+
+task :style do
+  Rake.application.in_namespace(:style) { |x| x.tasks.each { |t| t.invoke } }
+end
+
+task :ci_checks do
+  # Rake::Task['style'].invoke
+  Rake::Task['spec'].invoke
+  Rake::Task['style'].invoke
+end