lita-gsuite 0.5 → 0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 39fffd8c5976caaef1dd7c8b68a7562f95aa6f9b
-  data.tar.gz: 342a2b5efcf4f14b2f66a2083ebb201ee9c521dc
+  metadata.gz: 931b1f87a3ceba7c16ab448dc899bea54adb0bd0
+  data.tar.gz: 9c62785f33b8ffff0126d50ee1bd4105b3681a0e
 SHA512:
-  metadata.gz: 6df288e9de29014dbae5c9523441cfbf4b9bde4d67850ce04ac627963d564830dd32cc06c71e88346baf88f295d8a6f2360954fbaa3b320a1928ab1be6bec1bf
-  data.tar.gz: 145eb15b7d0ed9e454cd5bbdab45ad5a4a25470805bb46455e7dee8c34d5706634e1fe2172735092ee06f688f6f71e08ef3db15976a68d318e7c2824e3cae150
+  metadata.gz: 570024f9f0da581c40aa5712bded8a66accd874ea6a391bdee6f7539e76fdae136affc2ef859615746bb1d20c7a301d5e53be7a54c50eb9fc2862d2c66a84877
+  data.tar.gz: ed5a2ef9965e10b865370e7d4dcb2290a61bd9d31160e65ebdf337655eb686f65660131128c42c5908c6169be59fc447f04f6aff869534aeee0ee276628d1765

data/README.md

@@ -8,34 +8,27 @@ into the account, not provide administrative functions.
 This was written for a GSuite account with ~125 active users. It may not scale
 well to larger accounts, but feedback and optimisations are welcome.
 
-## Installation
+## Getting Started
 
-Add this gem to your lita installation by including the following line in your Gemfile:
+### 1. Installation
 
-    gem "lita-gsuite", git: "http://github.com/yob/lita-gsuite.git"
+Add this gem to your lita installation by including the following line in your Gemfile:
 
-## Configuration
+    gem "lita-gsuite"
 
-Edit your lita\_config.rb to include the following lines lines. Some of the
-values are sensitive, so using ENV vars is recommended to keep the values out
-of version control.
+### 2. Configuration
 
-When an API call to google is required, we want to make it with tokens that
-are tied to the specific user that requested data. To do so, we use Google's
-OAuth2 support.
+The lita bot requires an OAuth client ID and secret before it can initiate
+the process to generate an OAuth2 token for each user. That requires an OAuth2
+client ID and secret.
 
-That requires an OAuth2 client ID and secret - see "Authentication" below for more
-details on how to generate these:
+Both values must be added to your lita\_config.rb. Both are sensitive, so using
+ENV vars is recommended to keep the values out of version control.
 
     config.handlers.gsuite.oauth_client_id = ENV["GOOGLE_CLIENT_ID"]
     config.handlers.gsuite.oauth_client_secret = ENV["GOOGLE_CLIENT_SECRET"]
 
-## Authentication
-
-The lita bot requires an OAuth client ID and secret before it can initiate
-the process to generate an OAuth2 token for each user.
-
-These can be created on the [Google Developers
+You can generate the ID and secret on the [Google Developers
 Console](https://console.developers.google.com/), and Google has [some
 documentation](https://developers.google.com/identity/protocols/OAuth2).
 
@@ -47,15 +40,33 @@ will be prompted to complete an OAuth authorisation process before they can star
 generates an API token that's specific to them and will be used to make API calls on
 their behalf.
 
-## Enable Google API
+### 3. Enable Google API
 
-The GSuite API must be explicitly enabled for your account, and the new service account
-must be whitelisted before it can access any data.
+The GSuite API must be explicitly enabled for your account:
 
 1. Sign in to https://admin.google.com
 2. Visit the Security tab, click "API reference" and "Enable API Access"
 
-## Chat commands
+### 4. Authorising and First Commands
+
+With the installation and configuration complete, restart your lita bot.
+
+Open your chat interface, and issue the following commands the bot.
+
+1. Initiate authentication for your user: `lita gsuite auth`
+2. Provide your unique token to lita-gsuite: `lita gsuite set-token <token-generated-in-previous-step>`
+3. Fetch an account summary: `lita gsuite account-summary`
+
+All going well, you should see a summary of your gsuite account printed in the channel.
+
+## Chat commands Reference
+
+### Administrators
+
+Display a summary of the GSuite account - organisation name, contant details,
+alternative email address, etc.
+
+    lita gsuite account-summary
 
 ### Administrators
 

data/lib/lita-gsuite.rb

@@ -1,3 +1,4 @@
+require "lita/commands/account_summary"
 require "lita/commands/deletion_candidates"
 require "lita/commands/empty_groups"
 require "lita/commands/list_admins"

data/lib/lita/commands/account_summary.rb

@@ -0,0 +1,45 @@
+module Lita
+  module Commands
+
+    class AccountSummary
+
+      def name
+        'account-summary'
+      end
+
+      def run(robot, target, gateway, opts = {})
+        msg = build_msg(gateway)
+        robot.send_message(target, msg)
+      end
+
+      private
+
+      def build_msg(gateway)
+        data = get_account_data(gateway)
+
+        msg = "GSuite Account Summary - incorrect or out-of-date details can be updated at https://admin.google.com\n\n"
+        data.each do |label, value|
+          msg += "#{label}: #{value}\n"
+        end
+        msg
+      end
+
+      def get_account_data(gateway)
+        account = gateway.account_summary
+        {
+          "ID" => account.id,
+          "Alternate Email" => account.alternate_email,
+          "Created At" => account.created_at.iso8601,
+          "Primary Domain" => account.primary_domain,
+          "Language" => account.language,
+          "Phone Number" => account.phone_number,
+          "Address" => account.address,
+          "Contact Name" => account.contact_name,
+        }.reject { |item|
+          item.nil? || item == ""
+        }
+      end
+
+    end
+  end
+end

data/lib/lita/google_account.rb

@@ -0,0 +1,56 @@
+module Lita
+  # A GSuite account
+  class GoogleAccount
+    attr_reader :id, :alternate_email, :created_at, :language, :phone_number
+    attr_reader :primary_domain
+    attr_reader :address_line1, :address_line2, :address_line3
+    attr_reader :contact_name, :country_code, :organization_name, :postal_code, :region
+
+    def self.from_api(account)
+      GoogleAccount.new(
+        id: account.id,
+        alternate_email: account.alternate_email,
+        created_at: account.customer_creation_time,
+        primary_domain: account.customer_domain,
+        language: account.language,
+        phone_number: account.phone_number,
+        address_line1: account.postal_address.address_line1,
+        address_line2: account.postal_address.address_line2,
+        address_line3: account.postal_address.address_line3,
+        contact_name: account.postal_address.contact_name,
+        country_code: account.postal_address.country_code,
+        postal_code: account.postal_address.postal_code,
+        region: account.postal_address.region
+      )
+    end
+
+    def initialize(id:, alternate_email:, primary_domain:, created_at:, language:, phone_number:, address_line1: nil, address_line2: nil, address_line3: nil, contact_name: nil, country_code: nil, organization_name: nil, postal_code: nil, region: nil)
+      @id, @alternate_email, @created_at = id, alternate_email, created_at
+      @primary_domain = primary_domain
+      @language, @phone_number = language, phone_number
+      @address_line1, @address_line2, @address_line3 = address_line1, address_line2, address_line3
+      @contact_name, @country_code, @organization_name = contact_name, country_code, organization_name
+      @postal_code, @region = postal_code, region
+    end
+
+    def ==(other)
+      @id == other.id
+    end
+
+    def address
+      [
+        address_line1,
+        address_line2,
+        address_line3,
+        region,
+        postal_code,
+        country_code
+      ].reject(&:nil?).join(", ")
+    end
+
+    def to_s
+      "Account #{@id}"
+    end
+  end
+end
+

data/lib/lita/gsuite.rb

@@ -9,6 +9,7 @@ module Lita
     OOB_OAUTH_URI = 'urn:ietf:wg:oauth:2.0:oob'
 
     COMMANDS = [
+      Commands::AccountSummary,
       Commands::ListAdmins,
       Commands::EmptyGroups,
       Commands::NoOrgUnit,
@@ -36,6 +37,7 @@ module Lita
 
     # Instant queries. Authenticated users can run these commands and the result will be returned
     # immediately
+    route(/^gsuite account-summary$/, :account_summary, command: true,  help: {"gsuite account" => "Summarise key account details"})
     route(/^gsuite list-admins$/, :list_admins, command: true,  help: {"gsuite list-admins" => "List active admins"})
     route(/^gsuite suspension-candidates$/, :suspension_candidates, command: true, help: {"gsuite suspension-candidates" => "List active users that habven't signed in for a while"})
     route(/^gsuite deletion-candidates$/, :deletion_candidates, command: true,  help: {"gsuite deletion-candidates" => "List suspended users that habven't signed in for a while"})
@@ -58,6 +60,16 @@ module Lita
       window_commands_timer
     end
 
+    def account_summary(response)
+      return unless confirm_user_authenticated(response)
+
+      Commands::AccountSummary.new.run(
+        robot,
+        Source.new(room: response.room),
+        gateway(response.user)
+      )
+    end
+
     def deletion_candidates(response)
       return unless confirm_user_authenticated(response)
 

data/lib/lita/gsuite_gateway.rb

@@ -1,3 +1,4 @@
+require 'lita/google_account'
 require 'lita/google_activity'
 require 'lita/google_group'
 require 'lita/google_organisation_unit'
@@ -26,13 +27,20 @@ module Lita
       "https://www.googleapis.com/auth/admin.directory.user.readonly",
       "https://www.googleapis.com/auth/admin.directory.orgunit.readonly",
       "https://www.googleapis.com/auth/admin.reports.audit.readonly",
-      "https://www.googleapis.com/auth/admin.directory.group.readonly"
+      "https://www.googleapis.com/auth/admin.directory.group.readonly",
+      "https://www.googleapis.com/auth/admin.directory.customer.readonly",
     ]
 
     def initialize(user_authorization: nil)
       @user_authorization = user_authorization
     end
 
+    # return an object with some basic data on the entire gsuite account
+    def account_summary
+      data = directory_service.get_customer("my_customer")
+      GoogleAccount.from_api(data)
+    end
+
     def admin_activities(start_time, end_time)
       data = reports_service.list_activities("all", "admin", start_time: start_time.iso8601, end_time: end_time.iso8601)
       activities = data.items || []

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita-gsuite
 version: !ruby/object:Gem::Version
-  version: '0.5'
+  version: '0.6'
 platform: ruby
 authors:
 - James Healy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-04 00:00:00.000000000 Z
+date: 2017-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -121,6 +121,7 @@ files:
 - MIT-LICENSE
 - README.md
 - lib/lita-gsuite.rb
+- lib/lita/commands/account_summary.rb
 - lib/lita/commands/deletion_candidates.rb
 - lib/lita/commands/empty_groups.rb
 - lib/lita/commands/list_activities.rb
@@ -129,6 +130,7 @@ files:
 - lib/lita/commands/suspension_candidates.rb
 - lib/lita/commands/two_factor_off.rb
 - lib/lita/commands/two_factor_stats.rb
+- lib/lita/google_account.rb
 - lib/lita/google_activity.rb
 - lib/lita/google_group.rb
 - lib/lita/google_organisation_unit.rb