lita-gsuite 0.5

data/lib/lita/gsuite_gateway.rb

@@ -0,0 +1,101 @@
+require 'lita/google_activity'
+require 'lita/google_group'
+require 'lita/google_organisation_unit'
+require 'lita/google_user'
+require 'google/apis/admin_directory_v1'
+require 'google/apis/admin_reports_v1'
+
+module Lita
+  # Wrapper class for interacting with the gsuite directory API. Use
+  # this to list users, groups, group members.
+  #
+  # It only has read-only permissions, so cannot make any changes.
+  #
+  # Usage:
+  #
+  #     gateway = GsuiteGateway.new(
+  #       user_authorization: auth
+  #     )
+  #
+  # The user_authorization argument should be an auth object generated
+  # the googleauth gem - check its documentation for more details on the
+  # ways to build one of these objects.
+  #
+  class GsuiteGateway
+    OAUTH_SCOPES = [
+      "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"
+    ]
+
+    def initialize(user_authorization: nil)
+      @user_authorization = user_authorization
+    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 || []
+      activities.map { |item|
+        GoogleActivity.from_api(item)
+      }.flatten
+    end
+
+    # return an Array of all groups
+    def groups
+      data = directory_service.list_groups(max_results: 500, customer: "my_customer")
+      data.groups.map { |group|
+        GoogleGroup.from_api(group)
+      }
+    end
+
+    def organisational_units
+      data = directory_service.list_org_units("my_customer", type: "children")
+      data.organization_units.map { |ou|
+        GoogleOrganisationUnit.from_api(ou)
+      }
+    end
+
+    # return a list of users that have Two Factor Auth enabled
+    def two_factor_users
+      list_users("isEnrolledIn2Sv=true")
+    end
+
+    # return all users
+    def users
+      list_users
+    end
+
+    # return super administrators
+    def super_admins
+      list_users("isAdmin=true")
+    end
+
+    # return administrators with delegated administration of some users or groups
+    def delegated_admins
+      list_users("isDelegatedAdmin=true")
+    end
+
+    private
+
+    def list_users(query = nil)
+      data = directory_service.list_users(max_results: 500, customer: "my_customer", query: query)
+      data.users.map { |user|
+        GoogleUser.from_api_user(user)
+      }
+    end
+
+    def directory_service
+      @directory_service ||= Google::Apis::AdminDirectoryV1::DirectoryService.new.tap { |service|
+        service.authorization = @user_authorization
+      }
+    end
+
+    def reports_service
+      @reports_service ||= Google::Apis::AdminReportsV1::ReportsService.new.tap { |service|
+        service.authorization = @user_authorization
+      }
+    end
+
+  end
+end

data/lib/lita/redis_token_store.rb

@@ -0,0 +1,48 @@
+module Lita
+  # This is a local, simplified copy of Google::Auth::Stores::RedisTokenStore.
+  #
+  # After a user authenticates via Google OAuth we need to store a copy of their
+  # tokens in redis so we can call the Google APIs on their behalf. The googleauth
+  # library can store the tokens using any class that conforms to the
+  # Google::Auth::TokenStore contract.
+  #
+  # The RedisTokenStore provided by the googleauth gem works well enough, but it
+  # assumes that the provided redis object is a plain Redis instance. Lita wraps
+  # the Redis instance in a Redis::Namespace, so we need this custom store implementation.
+  #
+  # A nice side-effect is that we can rely on the Redis::Namespace instance to prefix keys
+  # for us which removes some complexity from the class.
+  #
+  class RedisTokenStore
+    KEY_PREFIX = 'g-user-token:'
+
+    # Create a new store with the supplied redis client.
+    #
+    def initialize(redis)
+      @redis = redis
+    end
+
+    def load(id)
+      key = key_for(id)
+      @redis.get(key)
+    end
+
+    def store(id, token)
+      key = key_for(id)
+      @redis.set(key, token)
+    end
+
+    def delete(id)
+      key = key_for(id)
+      @redis.del(key)
+    end
+
+    private
+
+    # Generate a redis key from a token ID
+    #
+    def key_for(id)
+      KEY_PREFIX + id
+    end
+  end
+end

data/lib/lita/weekly_schedule.rb

@@ -0,0 +1,54 @@
+module Lita
+  class WeeklySchedule
+    attr_reader :id, :room_id, :user_id, :day, :time, :cmd
+
+    def initialize(id:, room_id:, user_id:, day:, time:, cmd:)
+      @id = id
+      @room_id, @user_id = room_id, user_id
+      @day, @time = day.to_s.to_sym, time.to_s
+      @cmd = cmd.new if cmd
+    end
+
+    def name
+      @cmd.name
+    end
+
+    def run(*args)
+      @cmd.run(*args)
+    end
+
+    def valid?
+      room_id && user_id && valid_day? && valid_time? && valid_cmd?
+    end
+
+    def to_json
+      {
+        id: @id,
+        day: @day,
+        time: @time,
+        cmd: @cmd.name,
+        user_id: @user_id,
+        room_id: @room_id,
+      }.to_json
+    end
+
+    def human
+      "Weekly (id: #{@id}): #{@day} #{@time} - #{@cmd.name}"
+    end
+
+    private
+
+    def valid_day?
+      [:monday, :tuesday, :wednesday, :thursday, :friday, :saturday, :sunday].include?(day)
+    end
+
+    def valid_time?
+      time.match(/\A\d\d:\d\d\Z/)
+    end
+
+    def valid_cmd?
+      cmd.respond_to?(:run)
+    end
+  end
+
+end

data/lib/lita/window_schedule.rb

@@ -0,0 +1,50 @@
+module Lita
+  class WindowSchedule
+    attr_reader :id, :room_id, :user_id, :cmd
+
+    def initialize(id:, room_id:, user_id:, cmd:)
+      @id = id
+      @room_id, @user_id = room_id, user_id
+      @cmd = cmd.new if cmd
+    end
+
+    def duration_minutes
+      @cmd.duration_minutes
+    end
+
+    def buffer_minutes
+      @cmd.buffer_minutes
+    end
+
+    def name
+      @cmd.name
+    end
+
+    def run(*args)
+      @cmd.run(*args)
+    end
+
+    def human
+      "Sliding Window (id: #{@id}): #{@cmd.name}"
+    end
+
+    def valid?
+      room_id && user_id && valid_cmd?
+    end
+
+    def to_json
+      {
+        id: @id,
+        cmd: @cmd.name,
+        user_id: @user_id,
+        room_id: @room_id,
+      }.to_json
+    end
+
+    private
+
+    def valid_cmd?
+      cmd.respond_to?(:run)
+    end
+  end
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: lita-gsuite
+version: !ruby/object:Gem::Version
+  version: '0.5'
+platform: ruby
+authors:
+- James Healy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: lita-timing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: lita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: google-api-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Adds commands to lita for monitoring gsuite account activity and flagging
+  potential issues
+email:
+- james.healy@theconversation.edu.au
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- MIT-LICENSE
+files:
+- MIT-LICENSE
+- README.md
+- lib/lita-gsuite.rb
+- lib/lita/commands/deletion_candidates.rb
+- lib/lita/commands/empty_groups.rb
+- lib/lita/commands/list_activities.rb
+- lib/lita/commands/list_admins.rb
+- lib/lita/commands/no_org_unit.rb
+- lib/lita/commands/suspension_candidates.rb
+- lib/lita/commands/two_factor_off.rb
+- lib/lita/commands/two_factor_stats.rb
+- lib/lita/google_activity.rb
+- lib/lita/google_group.rb
+- lib/lita/google_organisation_unit.rb
+- lib/lita/google_user.rb
+- lib/lita/gsuite.rb
+- lib/lita/gsuite_gateway.rb
+- lib/lita/redis_token_store.rb
+- lib/lita/weekly_schedule.rb
+- lib/lita/window_schedule.rb
+homepage: http://github.com/yob/lita-gsuite
+licenses:
+- MIT
+metadata:
+  lita_plugin_type: handler
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Monitor activity and data in a gsuite account
+test_files: []