ogam 1.3.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ded9c968a17644837dd792f5e1e5b7a0b01569772b216cebb10b9a100db888f
-  data.tar.gz: 7932280e0b64ba87fbb5a3f7e5dee03d9e159b28dc621bb5e96cb11b6d8b8bc3
+  metadata.gz: b41adf475cb00cb57164e2bbb0e330d3b7d0401abd7725cc4ddc39325e2e8e9f
+  data.tar.gz: 8519c7e4f82dfcdd87e2efde8fa0651841984d136fe6f4853bf85e042e1bdf1c
 SHA512:
-  metadata.gz: 504c052a371e7a6eebe7833cd773381a3d2a9d6b9d2a30623925475360eec3ad8614499fbe23bb4930c255359cc1aca06c91a9982102585ce8cdf9c1770dc1a5
-  data.tar.gz: daa018bb77aa0c9caf4e3619938d2dbc962eb30f6166b184e567f44210e8b7bd65d18c6d840d5fb5a3d044e0f6bff9e727bdf71c34e1efe19afc24e5ee685be1
+  metadata.gz: 1d05195e69269c8700c50806953046a7676b9f380658d2168292795759c6b5be139b594362313fe2e378e192a6f4d2e8fd71efa6d43375fed08339b2ebdd1da6
+  data.tar.gz: 4ac972b6caf6c6b3f37f1ebd37f47fb8e76b12526394aa8c9d00bdd8ca6b58b4902b54be22780d7750a1f67de35e6d69bb8669363929edd8f168ff42d4fa1f71

data/.rubocop.yml

@@ -5,8 +5,17 @@ inherit_gem:
   rubocop-ogat:
     - config/default.yml
 
+inherit_mode:
+  merge:
+    - 'Include'
+
 AllCops:
   TargetRubyVersion: 2.6
+  Include:
+    - 'bin/ogam'
+  Exclude:
+    - 'bin/console'
+    - 'vendor/bundle/**/*'
 
 Rails:
   Enabled: false

data/.rubocop_todo.yml

@@ -1,12 +1,12 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config --auto-gen-only-exclude --exclude-limit 10000 --no-offense-counts --no-auto-gen-timestamp`
-# using RuboCop version 0.80.1.
+# using RuboCop version 0.82.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Configuration parameters: Max.
+# Configuration parameters: IgnoredMethods, Max.
 Metrics/AbcSize:
   Exclude:
     - 'spec/**/*'
@@ -24,7 +24,7 @@ Metrics/ClassLength:
     - 'config/environments/*.rb'
     - 'lib/ogam/group_assigner.rb'
 
-# Configuration parameters: Max.
+# Configuration parameters: IgnoredMethods, Max.
 Metrics/CyclomaticComplexity:
   Exclude:
     - 'spec/**/*'
@@ -42,7 +42,7 @@ Metrics/MethodLength:
     - 'config/environments/*.rb'
     - 'lib/ogam/group_assigner.rb'
 
-# Configuration parameters: Max.
+# Configuration parameters: IgnoredMethods, Max.
 Metrics/PerceivedComplexity:
   Exclude:
     - 'spec/**/*'

data/bin/ogam

@@ -1,19 +1,19 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'bundler/setup'
-require 'ogam'
-require 'thor'
-require 'shellwords'
+require "bundler/setup"
+require "ogam"
+require "thor"
+require "shellwords"
 
 # Signature subcommand cli
 class SignatureCLI < Thor
-  desc('user EMAIL', 'Sets the signature for user with primary email EMAIL based on their name, job title, and org')
+  desc("user EMAIL", "Sets the signature for user with primary email EMAIL based on their name, job title, and org")
   def user(email)
     set_signatures(Ogam::User.active_by_email(email), pretend: parent_options[:pretend])
   end
 
-  desc('domain DOMAIN', 'Sets the signature for all users @DOMAIN based on their name, job title, and org')
+  desc("domain DOMAIN", "Sets the signature for all users @DOMAIN based on their name, job title, and org")
   def domain(domain)
     set_signatures(Ogam::User.active_for_domain(domain), pretend: parent_options[:pretend])
   end
@@ -32,38 +32,38 @@ class CLI < Thor
   class_option :pretend, type: :boolean, default: false
 
   desc(
-    'assign_to_standard_groups DOMAIN_OR_EMAIL',
-    'Assigns users at DOMAIN (e.g. newbold.outwood.com) or EMAIL address to standard groups based on their job title'
+    "assign_to_standard_groups DOMAIN_OR_EMAIL",
+    "Assigns users at DOMAIN (e.g. newbold.outwood.com) or EMAIL address to standard groups based on their job title"
   )
   def assign_to_standard_groups(domain_or_email)
-    method = domain_or_email.include?('@') ? :for_user : :for_domain
+    method = domain_or_email.include?("@") ? :for_user : :for_domain
     Ogam::GroupAssigner.public_send(method, domain_or_email, pretend: options[:pretend])
   end
 
   desc(
-    'populate_titles_and_orgs PATH_TO_CSV',
-    'Populates job titles and organisation names from a CSV with columns primary_email, job_title, organisation'
+    "populate_titles_and_orgs PATH_TO_CSV",
+    "Populates job titles and organisation names from a CSV with columns primary_email, job_title, organisation"
   )
   def populate_titles_and_orgs(csv_path)
     Ogam::Execute.csv_command(
       csv_path,
-      'gam update user ~primary_email organization name ~organisation title ~job_title primary',
+      "gam update user ~primary_email organization name ~organisation title ~job_title primary",
       pretend: options[:pretend]
     )
   end
 
-  desc('create_shared_mailbox EMAIL NAME', 'Create a shared mailbox')
+  desc("create_shared_mailbox EMAIL NAME", "Create a shared mailbox")
   def create_shared_mailbox(email, name)
     Ogam::Execute.single(Ogam::Group.create_shared_mailbox_command(email, name), pretend: options[:pretend])
   end
 
-  desc('create_exec_mailbox EMAIL NAME', 'Create an Exec mailbox')
+  desc("create_exec_mailbox EMAIL NAME", "Create an Exec mailbox")
   def create_exec_mailbox(email, name)
     Ogam::Execute.single(Ogam::Group.create_exec_mailbox_command(email, name), pretend: options[:pretend])
   end
 
   option :moderated, type: :boolean, default: false
-  desc('create_group EMAIL NAME [--moderated]', 'Create a distribution list group, optionally moderated')
+  desc("create_group EMAIL NAME [--moderated]", "Create a distribution list group, optionally moderated")
   def create_group(email, name)
     Ogam::Execute.single(
       Ogam::Group.create_distribution_list_command(email, name, options[:moderated]), pretend: options[:pretend]
@@ -72,8 +72,8 @@ class CLI < Thor
 
   option :organisation, type: :string
   desc(
-    'set_job_title EMAIL TITLE [--organisation ORG_NAME]',
-    'Sets job title for a user, and updates their signature, groups, and organisation name. Optionally override org.'
+    "set_job_title EMAIL TITLE [--organisation ORG_NAME]",
+    "Sets job title for a user, and updates their signature, groups, and organisation name. Optionally override org."
   )
   def set_job_title(email, title)
     validate_job_title!(title)
@@ -86,27 +86,28 @@ class CLI < Thor
   end
 
   desc(
-    'add_send_as USER GROUP NAME TITLE ORG_NAME',
-    'Adds a sendas address to USER to be able to send as GROUP, and sets the NAME, and signature for sending'
+    "add_send_as USER GROUP NAME TITLE ORG_NAME",
+    "Adds a sendas address to USER to be able to send as GROUP, and sets the NAME, and signature for sending"
   )
   def add_send_as(user, group, name, title, org_name)
     signature_html = Ogam::Signature.signature_html(name, title, org_name)
     Ogam::Execute.single(Ogam::Group.add_send_as_command(user, group, name, signature_html), pretend: options[:pretend])
   end
 
-  desc('set_signature user/domain EMAIL/DOMAIN', 'Set email signatures for users/domains based on user attributes')
-  subcommand 'set_signature', SignatureCLI
+  desc("set_signature user/domain EMAIL/DOMAIN", "Set email signatures for users/domains based on user attributes")
+  subcommand "set_signature", SignatureCLI
 
-  desc('delicense_suspended_ou', 'De-licenses GSEfE from all users under /Suspended')
+  desc("delicense_suspended_ou", "De-licenses GSEfE from all users under /Suspended")
   def delicense_suspended_ou
     Ogam::Execute.single('gam ou "/Suspended" delete license 1010310002', pretend: options[:pretend])
   end
 
-  desc('suspend USER', 'Suspends a user, moves them to /Suspended, and delicenses GSEfE')
-  def suspend(user)
+  desc("offboard USER", "Suspends a user, moves them to /Suspended, removes from groups, and delicenses GSEfE")
+  def offboard(user)
     Ogam::Execute.single(
       "gam update user #{user} suspended on org \"/Suspended\"", pretend: options[:pretend]
     )
+    Ogam::Execute.single("gam user #{user} delete groups", pretend: options[:pretend])
     puts "Waiting 5 seconds before delicensing..."
     sleep(5)
     Ogam::Execute.single("gam user #{user} delete license 1010310002", pretend: options[:pretend])
@@ -123,7 +124,7 @@ class CLI < Thor
   end
 
   def validate_organisation!(org, approved_organisations)
-    org.split(' / ').each do |org_part|
+    org.split(" / ").each do |org_part|
       unless approved_organisations.value?(org_part)
         raise ArgumentError, "'#{org_part}' is not an approved organisation name."
       end
@@ -133,7 +134,7 @@ class CLI < Thor
   def infer_organisation_if_necessary(org, email, approved_organisations)
     return org if org.present?
 
-    approved_organisations.fetch(email.split('@').last, '')
+    approved_organisations.fetch(email.split("@").last, "")
   end
 
   def set_title_and_org_and_make_changes(email, title, org, pretend: true)

data/lib/ogam/execute.rb

@@ -32,6 +32,7 @@ module Ogam
       single("gam csv #{Shellwords.escape(csv_path)} #{command.strip}", pretend: pretend)
     end
 
+    # rubocop:disable Metrics/MethodLength
     def self.multiple(commands, pretend: true)
       return if commands.empty?
 
@@ -41,10 +42,12 @@ module Ogam
       end
       return if pretend
 
-      Tempfile.create do |f|
-        commands.each { |command| f.puts command.strip }
-        single("gam batch #{f.path}", pretend: pretend)
-      end
+      f = Tempfile.new
+      commands.each { |command| f.puts command.strip }
+      f.close
+      single("gam batch #{f.path}", pretend: pretend)
+      f.unlink
     end
+    # rubocop:enable Metrics/MethodLength
   end
 end

data/lib/ogam/group.rb

@@ -9,7 +9,7 @@ module Ogam
     end
 
     def self.add_group_member_command(user:, group:)
-      "gam update group #{group} add member user #{user}"
+      "gam update group #{group} add member user #{Shellwords.escape(user)}"
     end
 
     def self.create_shared_mailbox_command(email_address, name)

data/lib/ogam/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ogam
-  VERSION = "1.3.1"
+  VERSION = "1.3.2"
 end

data/ogam.gemspec

@@ -33,6 +33,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 2.1"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rubocop-ogat", "~> 2.0.1"
+  spec.add_development_dependency "rubocop-ogat", "~> 2.6.0"
   spec.add_development_dependency "simplecov", "~> 0.18.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ogam
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
 platform: ruby
 authors:
 - Elliot Bowes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-01 00:00:00.000000000 Z
+date: 2020-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: 2.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: 2.6.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement