ogam 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0bd4c39f063cc77d960339f8a828b160734f410e6b31d3ecb0cec94e5ddfaf21
-  data.tar.gz: 83a9fd885e54efff8ba93672d42bb32b517f98f1478893c43939ad7cfaa1f31f
+  metadata.gz: d4a72e5717ef8b802f79499f53fb603ddc9ba61dbd06fa166c9a3045d877b748
+  data.tar.gz: d4cf4b93af132811e4a6ba058e0440ddc60115a414a7c967bb96c0a34363ffbd
 SHA512:
-  metadata.gz: 309fbc943d2d17660050afa90b18c3a2c08329f85fdd2dfaefd92d7c93c8a37ccae3a62e3cf8b5a957299f840269d69c40813811e40c8c37d87f5aea71dbf6c2
-  data.tar.gz: 7d38bbbedda7261c9dc127626fdeef0cd1b2bd41f59812fb7a359fae72e5682ccb22165ffed2ae354bbe1481d90dff4e9718b73656ee5088f24d742b63e44cc7
+  metadata.gz: d4443a1c829534b5ebea13518d00e8d7d1b66dd8cfb2a2b095bbec52478392ac9f09cb8fc0d240482dfaa202e04ef210149e310ecc3a65316be51960a72440bf
+  data.tar.gz: 93d3527909a5d33d90f66cb70dcd170622ae9a947294548552431052005e3e2cd66235d6930cbe6e4e5f57a02952f09baa36cb9c3804bdad5672dcb42d0d986c

data/.rubocop.yml

@@ -16,3 +16,9 @@ Metrics/BlockLength:
   Exclude:
     - 'spec/**/*.rb'
     - 'ogatstyle.gemspec'
+
+Rails/Output:
+  Enabled: false
+
+Rails/SaveBang:
+  Enabled: false

data/.rubocop_metrics_todo.yml

@@ -0,0 +1,59 @@
+Metrics/AbcSize:
+  Exclude:
+    - db/**/*
+    - spec/**/*
+    - config/routes.rb
+    - lib/ogam/group_assigner.rb
+
+Metrics/BlockLength:
+  Exclude:
+    - db/**/*
+    - spec/**/*
+    - config/routes.rb
+
+Metrics/BlockNesting:
+  Exclude:
+    - db/**/*
+    - spec/**/*
+    - config/routes.rb
+
+Metrics/ClassLength:
+  Exclude:
+    - db/**/*
+    - spec/**/*
+    - config/routes.rb
+    - lib/ogam/group_assigner.rb
+
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - db/**/*
+    - spec/**/*
+    - config/routes.rb
+    - lib/ogam/group_assigner.rb
+
+Metrics/MethodLength:
+  Exclude:
+    - db/**/*
+    - spec/**/*
+    - config/routes.rb
+    - lib/ogam/group_assigner.rb
+
+Metrics/ModuleLength:
+  Exclude:
+    - db/**/*
+    - spec/**/*
+    - config/routes.rb
+
+Metrics/ParameterLists:
+  Exclude:
+    - db/**/*
+    - spec/**/*
+    - config/routes.rb
+
+Metrics/PerceivedComplexity:
+  Exclude:
+    - db/**/*
+    - spec/**/*
+    - config/routes.rb
+    - lib/ogam/group_assigner.rb
+

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config --exclude-limit 1000 --no-offense-counts --no-auto-gen-timestamp`
-# using RuboCop version 0.79.0.
+# using RuboCop version 0.80.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

data/.travis.yml

@@ -3,22 +3,20 @@ language: ruby
 cache: bundler
 rvm:
   - 2.6.5
-before_install:
-  - gem uninstall -v '>= 2' -i $(rvm gemdir)@global -ax bundler || true
-  - gem install bundler -v '~> 1.17.3'
 before_script:
-  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64
+    > ./cc-test-reporter
   - chmod +x ./cc-test-reporter
-  - ./cc-test-reporter before-build
+  - './cc-test-reporter before-build'
 script:
   - bundle exec rubocop
   - bundle exec rake
 after_script:
-  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+  - './cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT'
 deploy:
   provider: rubygems
   api_key:
-    secure: kazURR5idcANlaYnqiGLnkXfsYWluTc3H87sg73H6s2JwEkA69FieZA3tUrDVX8kfbOxsqDphyv3fZmqrQtmG74ksUPVGsouoth7gpUMNh6Uj8Hr/e3Cgt/4b/SeGCAdpIsx869w8fA9kEKuf1NhQ0taazfiqToau3amyal6QblxMaalX8ThvWtO98ViJkEeIszxRK+uzd3t1aIEW/Lds9jWUm9Rf1tI/ajlRecwStA74pCQHJ2wuPQRcAB8DYz82pNjlyGwIZd14Gmbys0en+r+av3tYLjzwN+z9y7vlXwp1xAeRKU9GoJCHuevKmT1joRnFFfp3xGoKn63b6yS7KHVFT7v4l+qRbMnL+m/wrz5Xv3ZUyk0un9O3+MFLy0jIYP1adcvh+KkqenAktzSekjGstZn8oRk8lAEYfGLUD45nijdGjbYF7VAUPhoP5g6vxGlbZDCHslHuLGMjiEd/vP+SGEhtEMzk6cvir1yoMzryilRTfBfkut7iVsy/MaMvTShxF0qd1hdtx+Htfcq2zad98lAASsciz8su6u9vaqmqyxLKxdMptbWks4bCd0lB9g6fjIT79cIzjwQB6Hv3WNDpMLGDxWH8PkZf4ZEIlvV1goLlzt5t0SoZryn1hWbO4VJMvGLXtVj9MvdgskN95Ww9FTvO3wlm0PVK5iQWkU=
+    secure: K5oq3QVDaNCEoeDlj9PQgE5oslHTTzzO33SA4XVRPqV/k6S2ASs0iCyAp0LPPFup9NPivw8C64mb41erSY4f/lW8a2tkfVYL28avBiy4n/kioo/hFKjL3WBoUGknsamoDQUBTCrUPtoQE5puducV44cH9AyPFJulXbw4hA8KXisi7xYc+e5NGSsTDhjlj4GBN0G3AOBgZ/x1dqLdG8/NV7Bqwr3fKHqpBEI4nKtGTzWUsoC+4SQVkWKwPzKcme47AiRZa5moKs6xzJQzamJm6sGzk0SQ24PSvDxv/AE6AJe67xbdSzxgN2haSLLTV99AW4ku9dP6JE8i799f9337lmCWNE24GCqlAAURR3GDGtMcv0pUCR12V39wJSdA0C3h4xDriGgSHM69xnY6I4hh0DZCSXMDDAHFQMSF5JU4zOQDKZhme2pUTQwTw0uNoutDp6/YF9kMeq+dzZygKMjtDFVy95IV3N9vXBMHvNQAohNYGVZ47Yy4n6Ss/AOHu6aqWPyFo0VSD4WAzFNJBtZvnMlleS+nRrpxjxaH+LkeqE0VkQU6IFeqipAihEeJDizWMXKcXd7RbFPxmsvcyDHh7kF5th5xCGxqW6O3rC2B64mDNA9NKaROJDMQYszeRb7pOuhoysMnzDOy0CwI9R7jZhlWVSHEZeGv4phMhTKhFGc=
   gem: ogam
   on:
     rvm: 2.6.5

data/Gemfile.lock

@@ -1,23 +1,37 @@
 PATH
   remote: .
   specs:
-    ogam (0.1.0)
+    ogam (1.0.0)
+      activesupport (~> 6.0.2)
+      attr_extras (~> 6.2.3)
       thor (~> 1.0.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (6.0.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
     ast (2.4.0)
+    attr_extras (6.2.3)
+    concurrent-ruby (1.1.6)
     diff-lcs (1.3)
     docile (1.3.2)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.4)
     json (2.3.0)
+    minitest (5.14.0)
     parallel (1.19.1)
     parser (2.7.0.2)
       ast (~> 2.4.0)
     rack (2.2.2)
     rainbow (3.0.0)
     rake (13.0.1)
+    rexml (3.2.4)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -31,15 +45,16 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.2)
-    rubocop (0.79.0)
+    rubocop (0.80.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
       parser (>= 2.7.0.1)
       rainbow (>= 2.2.2, < 4.0)
+      rexml
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-ogat (1.46.1)
-      rubocop (= 0.79.0)
+    rubocop-ogat (1.47.0)
+      rubocop (= 0.80.0)
       rubocop-performance (= 1.5.2)
       rubocop-rails (= 2.4.2)
       rubocop-rspec (= 1.38.1)
@@ -57,7 +72,11 @@ GEM
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
     thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.6)
+      thread_safe (~> 0.1)
     unicode-display_width (1.6.1)
+    zeitwerk (2.2.2)
 
 PLATFORMS
   ruby
@@ -67,7 +86,7 @@ DEPENDENCIES
   ogam!
   rake (~> 13.0)
   rspec (~> 3.0)
-  rubocop-ogat (~> 1.46.1)
+  rubocop-ogat (~> 1.47.0)
   simplecov (~> 0.17.1)
 
 BUNDLED WITH

data/README.md

@@ -1,28 +1,22 @@
 # Ogam
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ogam`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Wrapper around GAM for common tasks with OGAT's G Suite instance.
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'ogam'
-```
-
-And then execute:
+This tool relies on GAM being installed. First install that using the normal installation procedure, then run:
 
-    $ bundle
+    $ gem install ogam
 
-Or install it yourself as:
+If running on Google Cloud Shell, ensure the gems bin directory is in your path by appending the following line to ~/.bashrc:
 
-    $ gem install ogam
+`PATH=".gems/bin:$PATH"`
 
 ## Usage
 
-TODO: Write usage instructions here
+For a list of available commands, run:
+
+    $ ogam help
 
 ## Development
 
@@ -32,4 +26,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/elliotb/ogam.
+Bug reports and pull requests are welcome on GitHub at https://github.com/Outwood/ogam.

data/bin/ogam

@@ -4,9 +4,119 @@
 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')
+  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')
+  def domain(domain)
+    set_signatures(Ogam::User.active_for_domain(domain), pretend: parent_options[:pretend])
+  end
+
+  private
+
+  def set_signatures(users, pretend:)
+    users.each do |user|
+      Ogam::Execute.single(Ogam::Signature.update_signature_command(user), pretend: pretend)
+    end
+  end
+end
+
+# Command line interface for OGAM
 class CLI < Thor
-  # contents of the Thor class
+  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'
+  )
+  def assign_to_standard_groups(domain_or_email)
+    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'
+  )
+  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',
+      pretend: options[:pretend]
+    )
+  end
+
+  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
+
+  option :moderated, type: :boolean, default: false
+  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]
+    )
+  end
+
+  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.'
+  )
+  def set_job_title(email, title)
+    validate_job_title!(title)
+
+    approved_organisations = Ogam::Organisation.all
+    org = infer_organisation_if_necessary(options[:organisation], email, approved_organisations)
+    validate_organisation!(org, approved_organisations)
+
+    set_title_and_org_and_make_changes(email, title, org, 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
+
+  private
+
+  def validate_job_title!(title)
+    approved_job_titles = Ogam::JobTitle.all
+    new_job_titles = Ogam::JobTitle.job_titles(title)
+    new_job_titles.each do |s|
+      raise ArgumentError, "'#{s}' is not an approved job title." unless approved_job_titles.include?(s)
+    end
+  end
+
+  def validate_organisation!(org, approved_organisations)
+    org.split(' / ').each do |org_part|
+      unless approved_organisations.value?(org_part)
+        raise ArgumentError, "'#{org_part}' is not an approved organisation name."
+      end
+    end
+  end
+
+  def infer_organisation_if_necessary(org, email, approved_organisations)
+    return org if org.present?
+
+    approved_organisations.fetch(email.split('@').last, '')
+  end
+
+  def set_title_and_org_and_make_changes(email, title, org, pretend: true)
+    Ogam::Execute.single(
+      "gam update user #{email} organization name #{Shellwords.escape(org)} title #{Shellwords.escape(title)} primary",
+      pretend: pretend
+    )
+    Ogam::GroupAssigner.for_user(email, pretend: pretend)
+    Ogam::User.active_by_email(email).each do |user|
+      Ogam::Execute.single(Ogam::Signature.update_signature_command(user), pretend: pretend)
+    end
+  end
 end
 
 CLI.start(ARGV)

data/lib/ogam/execute.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'csv'
+require 'tempfile'
+require 'English'
+
+module Ogam
+  # Methods to execute GAM commands
+  class Execute
+    def self.single(command, pretend: true)
+      puts "#{pretend ? '[PRETEND] ' : nil}Executing #{command}"
+      return if pretend
+
+      system("~/bin/gam/#{command}", exception: true)
+    end
+
+    def self.fetch(command, pretend: true)
+      puts "#{pretend ? '[PRETEND] ' : nil}Fetching results from #{command}"
+      return if pretend
+
+      `~/bin/gam/#{command}`
+    end
+
+    def self.fetch_csv(command, pretend: true)
+      result = fetch(command, pretend: pretend)
+      return unless result
+
+      CSV.parse(result, headers: true)
+    end
+
+    def self.csv_command(csv_path, command, pretend: true)
+      single("gam csv #{Shellwords.escape(csv_path)} #{command}", pretend: pretend)
+    end
+
+    def self.multiple(commands, pretend: true)
+      return if commands.empty?
+
+      puts "#{pretend ? '[PRETEND] ' : nil}Executing multiple commands:"
+      commands.each do |command|
+        puts "\t#{command}"
+      end
+      return if pretend
+
+      Tempfile.create do |f|
+        commands.each { |command| f.puts command }
+        single("gam batch #{f.path}", pretend: pretend)
+      end
+    end
+  end
+end

data/lib/ogam/group.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'shellwords'
+module Ogam
+  # Methods relating to groups
+  class Group
+    def self.groups_for_domain(domain)
+      Ogam::Execute.fetch_csv("gam print groups domain #{domain}", pretend: false).map { |r| r['Email'] }
+    end
+
+    def self.add_group_member_command(user:, group:)
+      "gam update group #{group} add member user #{user}"
+    end
+
+    def self.create_shared_mailbox_command(email_address, name)
+      <<~COMMAND
+        gam create group #{email_address} name #{Shellwords.escape(name)} allow_external_members false who_can_join invited_can_join primary_language en-GB who_can_view_membership all_in_domain_can_view include_in_global_address_list true is_archived true members_can_post_as_the_group false allow_web_posting true send_message_deny_notification false reply_to reply_to_ignore message_moderation_level moderate_none who_can_contact_owner all_in_domain_can_contact who_can_leave_group all_members_can_leave who_can_add all_managers_can_add who_can_post_message anyone_can_post who_can_invite all_managers_can_invite who_can_view_group all_members_can_view show_in_group_directory true archive_only false spam_moderation_level moderate
+      COMMAND
+    end
+
+    def self.create_distribution_list_command(email_address, name, moderated)
+      <<~COMMAND
+        gam create group #{email_address} name #{Shellwords.escape(name)} allow_external_members false who_can_join invited_can_join primary_language en-GB who_can_view_membership all_in_domain_can_view include_in_global_address_list true is_archived false members_can_post_as_the_group false allow_web_posting false send_message_deny_notification true reply_to reply_to_sender message_moderation_level #{moderated ? 'moderate_all_messages' : 'moderate_none'} who_can_contact_owner all_managers_can_contact who_can_leave_group none_can_leave who_can_add none_can_add who_can_post_message all_in_domain_can_post who_can_invite none_can_invite who_can_view_group all_managers_can_view show_in_group_directory true archive_only false spam_moderation_level moderate
+      COMMAND
+    end
+  end
+end

data/lib/ogam/group_assigner.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+module Ogam
+  # Assign users from a domain to standard groups based on their job titles
+  class GroupAssigner
+    static_facade :call, :users, :domain, [pretend: true]
+
+    SUBJECT_TEACHER_TITLES = ['Teacher of ', 'Head of ', 'Second in ', 'Third in '].freeze
+    SUBJECT_MAPPING = {
+      'art-teachers' => ['Art'],
+      'business-teachers' => ['Business Studies'],
+      'dance-teachers' => ['Performing Arts'],
+      'design-technology-teachers' => ['Technology'],
+      'drama-teachers' => ['Drama', 'Music & Drama', 'Performing Arts'],
+      'english-teachers' => ['English'],
+      'epq-teachers' => [],
+      'geography-teachers' => ['Humanities'],
+      'guidance-teachers' => [],
+      'health-social-care-teachers' => ['Health & Social Care'],
+      'history-teachers' => %w[Humanities History],
+      'ict-teachers' => ['Computer Science'],
+      'law-teachers' => ['Law'],
+      'maths-teachers' => ['Maths'],
+      'mfl-teachers' => ['MFL'],
+      'music-teachers' => ['Music', 'Music & Drama'],
+      'pe-teachers' => ['PE'],
+      're-life-teachers' => ['Humanities'],
+      'science-teachers' => ['Science'],
+      'social-sciences-teachers' => ['Social Sciences']
+    }.freeze
+
+    def self.for_domain(domain, pretend: true)
+      call(User.active_for_domain(domain), domain, pretend: pretend)
+    end
+
+    def self.for_user(email, pretend: true)
+      call(User.active_by_email(email), email.split('@').last, pretend: pretend)
+    end
+
+    def self.groups_for_job_title(job_title, entry, domain)
+      groups_domain = "groups.#{domain}"
+
+      groups = groups_from_entry(entry, groups_domain)
+      groups += subject_groups(job_title, groups_domain) if entry['Teaching']
+
+      groups << "heads-of-departments@#{groups_domain}" if entry['Teaching'] && job_title.include?('Head of ')
+      groups << "principal@#{groups_domain}" if entry['SLT'] && ['Principal', 'Acting Principal'].include?(job_title)
+
+      groups << "learning-managers@#{groups_domain}" if job_title.include?('Learning Manager')
+      groups << "academy-council@#{groups_domain}" if job_title.include?('Academy Council')
+      groups << 'business-managers@trust-wide.outwood.com' if job_title == 'Business Manager'
+
+      groups
+    end
+
+    def self.groups_from_entry(entry, groups_domain)
+      groups = []
+      groups << "teaching-staff@#{groups_domain}" if entry['Teaching']
+      groups << "support-staff@#{groups_domain}" if entry['Support']
+      if entry['SLT']
+        groups << "slt@#{groups_domain}"
+        groups << "leadership-team@#{groups_domain}"
+      end
+      groups << 'finance@trust-wide.outwood.com' if entry['Finance']
+      groups << 'data-exams@trust-wide.outwood.com' if entry['Data and Exams']
+      groups << 'human-resources@trust-wide.outwood.com' if entry['HR']
+      groups << 'ict-support@trust-wide.outwood.com' if entry['ICT Support']
+      groups
+    end
+
+    def self.subject_groups(job_title, groups_domain)
+      return [] unless SUBJECT_TEACHER_TITLES.any? { |title| job_title.include?(title) }
+
+      groups = []
+      SUBJECT_MAPPING.each do |group_prefix, subject_words|
+        has_subject =
+          subject_words.any? do |subject|
+            SUBJECT_TEACHER_TITLES.any? { |title| job_title.ends_with? "#{title}#{subject}" }
+          end
+        next unless has_subject
+
+        groups << "#{group_prefix}@#{groups_domain}"
+      end
+      groups
+    end
+
+    def call
+      Execute.multiple(commands(generate_group_assignments), pretend: pretend)
+    end
+
+    private
+
+    def commands(group_assignments)
+      group_assignments.find_all { |_user, group| valid_groups.include?(group) }.map do |user, group|
+        Group.add_group_member_command(user: user, group: group)
+      end
+    end
+
+    def valid_groups
+      @valid_groups ||= Group.groups_for_domain("groups.#{domain}") + Group.groups_for_domain('trust-wide.outwood.com')
+    end
+
+    def generate_group_assignments
+      group_assignments = []
+      users.each do |user|
+        group_assignments += group_assignments_for_user(user)
+      end
+      group_assignments
+    end
+
+    def group_assignments_for_user(user)
+      group_assignments = []
+      email = user['primaryEmail']
+      User.job_titles_for_user(user).each do |job_title|
+        entry = approved_job_titles.fetch(job_title, nil)
+        if entry.nil?
+          puts "Warning: Unapproved job title found for user #{email}: #{job_title}"
+          next
+        end
+
+        GroupAssigner.groups_for_job_title(job_title, entry, domain).each do |group|
+          group_assignments << [email, group]
+        end
+      end
+      group_assignments
+    end
+
+    def approved_job_titles
+      @approved_job_titles ||= JobTitle.all
+    end
+  end
+end

data/lib/ogam/job_title.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'open-uri'
+require 'csv'
+
+module Ogam
+  # Allows working with a list of approved job titles
+  class JobTitle
+    static_facade :all
+
+    CSV_URL = 'https://docs.google.com/spreadsheets/d/12nl5OBGSmOSsWilzWfflmAHO-8EyfCjVXYLeUDqjB60/export?format=csv&id=12nl5OBGSmOSsWilzWfflmAHO-8EyfCjVXYLeUDqjB60&gid=1604665254'
+
+    def self.job_titles(str)
+      return [] if str.blank?
+
+      str.split(' / ')
+    end
+
+    def all
+      @all ||= parse(download)
+    end
+
+    private
+
+    def download
+      puts 'Fetching list of accepted job titles'
+      URI.parse(CSV_URL).read
+    end
+
+    def parse(str)
+      data = {}
+      CSV.parse(str, headers: true).each do |row|
+        next if row['Job Title'].blank?
+
+        data[row['Job Title']] = entry_for_row(row)
+      end
+
+      data
+    end
+
+    def entry_for_row(row)
+      entry = {}
+      (row.headers - ['Job Title']).each do |col|
+        entry[col] = row[col] == 'TRUE'
+      end
+      entry
+    end
+  end
+end

data/lib/ogam/organisation.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'open-uri'
+require 'csv'
+
+module Ogam
+  # Allows working with a list of approved organisations
+  class Organisation
+    static_facade :all
+
+    CSV_URL = 'https://docs.google.com/spreadsheets/d/12nl5OBGSmOSsWilzWfflmAHO-8EyfCjVXYLeUDqjB60/export?format=csv&id=12nl5OBGSmOSsWilzWfflmAHO-8EyfCjVXYLeUDqjB60&gid=46181347'
+
+    def all
+      @all ||= parse(download)
+    end
+
+    private
+
+    def download
+      puts 'Fetching list of accepted organisations'
+      URI.parse(CSV_URL).read
+    end
+
+    def parse(str)
+      data = {}
+      CSV.parse(str, headers: true).each do |row|
+        next if row['Domain'].blank?
+
+        data[row['Domain'].strip] = row['Organisation Name'].strip
+      end
+
+      data
+    end
+  end
+end

data/lib/ogam/signature.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Ogam
+  # Methods relating to signatures
+  class Signature
+    def self.update_signature_command(user)
+      email = user.fetch('primaryEmail')
+      html = signature_html(
+        user.fetch('name.fullName', nil),
+        user.fetch('organizations.0.title', nil),
+        user.fetch('organizations.0.name', nil)
+      )
+
+      "gam user #{email} signature \"#{html}\""
+    end
+
+    def self.signature_html(name, job_title, organisation)
+      parts = [name, job_title, organisation].reject(&:blank?)
+      "<p>#{parts.join('<br />')}</p><hr color=#5b3293 />"
+    end
+  end
+end

data/lib/ogam/user.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Ogam
+  # Methods relating to users
+  class User
+    def self.active_for_domain(domain)
+      Ogam::Execute.fetch_csv("gam print users allfields domain #{domain} query 'isSuspended=False'", pretend: false)
+    end
+
+    def self.active_by_email(email)
+      Ogam::Execute.fetch_csv(
+        "gam print users allfields query 'email=#{email} isSuspended=False'",
+        pretend: false
+      )
+    end
+
+    def self.job_titles_for_user(user)
+      JobTitle.job_titles(user['organizations.0.title'])
+    end
+  end
+end

data/lib/ogam/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ogam
-  VERSION = '0.1.0'
+  VERSION = '1.0.0'
 end

data/lib/ogam.rb

@@ -1,6 +1,15 @@
 # frozen_string_literal: true
 
+require 'active_support/all'
+require 'attr_extras'
 require 'ogam/version'
+require 'ogam/execute'
+require 'ogam/group'
+require 'ogam/job_title'
+require 'ogam/user'
+require 'ogam/group_assigner'
+require 'ogam/signature'
+require 'ogam/organisation'
 
 module Ogam
   class Error < StandardError; end

data/ogam.gemspec

@@ -26,11 +26,13 @@ Gem::Specification.new do |spec|
   spec.executables << 'ogam'
   spec.require_paths = ['lib']
 
+  spec.add_runtime_dependency 'activesupport', '~> 6.0.2'
+  spec.add_runtime_dependency 'attr_extras', '~> 6.2.3'
   spec.add_runtime_dependency 'thor', '~> 1.0.1'
 
   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', '~> 1.46.1'
+  spec.add_development_dependency 'rubocop-ogat', '~> 1.47.0'
   spec.add_development_dependency 'simplecov', '~> 0.17.1'
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: ogam
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Elliot Bowes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-18 00:00:00.000000000 Z
+date: 2020-02-20 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.2
+- !ruby/object:Gem::Dependency
+  name: attr_extras
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.2.3
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.46.1
+        version: 1.47.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.46.1
+        version: 1.47.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -117,6 +145,13 @@ files:
 - bin/ogam
 - bin/setup
 - lib/ogam.rb
+- lib/ogam/execute.rb
+- lib/ogam/group.rb
+- lib/ogam/group_assigner.rb
+- lib/ogam/job_title.rb
+- lib/ogam/organisation.rb
+- lib/ogam/signature.rb
+- lib/ogam/user.rb
 - lib/ogam/version.rb
 - ogam.gemspec
 homepage: https://github.com/Outwood/ogam
@@ -139,7 +174,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubyforge_project: 
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Wrapper around GAM for common tasks with OGAT's G Suite instance.