(feature) Allow users to be imported from a CSV

As this is designed to be run from the rails console, `UserImport.new`
expects an instance of Auth0Client as its second parameter.

It will then create a new Auth0 user for each email address included
in the CSV file, skipping any that already exists. Their passwords and
uid will be printed to the console.

Author: leeky

Gemfile

@@ -27,10 +27,14 @@ gem 'puma', '~> 3.11'
 # Audit log
 gem 'rails_event_store'
 
+# Auth0
+gem 'auth0', require: false
+
 gem 'rubocop'
 
 group :development, :test do
   gem 'byebug', platforms: %i[mri mingw x64_mingw]
+  gem 'dotenv-rails'
   gem 'factory_bot_rails'
   gem 'pry-rails'
   gem 'rspec-rails'

Gemfile.lock

@@ -51,6 +51,8 @@ GEM
     arkency-command_bus (0.4.0)
       thread_safe
     ast (2.4.0)
+    auth0 (4.4.0)
+      rest-client (~> 2.0)
     aws-eventstream (1.0.1)
     aws-partitions (1.95.0)
     aws-sdk-core (3.22.1)
@@ -72,6 +74,12 @@ GEM
     crass (1.0.4)
     database_cleaner (1.7.0)
     diff-lcs (1.3)
+    domain_name (0.5.20180417)
+      unf (>= 0.0.5, < 1.0.0)
+    dotenv (2.4.0)
+    dotenv-rails (2.4.0)
+      dotenv (= 2.4.0)
+      railties (>= 3.2, < 6.0)
     erubi (1.7.1)
     factory_bot (4.10.0)
       activesupport (>= 3.0.0)
@@ -81,6 +89,8 @@ GEM
     ffi (1.9.23)
     globalid (0.4.1)
       activesupport (>= 4.2.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
     i18n (1.0.1)
       concurrent-ruby (~> 1.0)
     jbuilder (2.7.0)
@@ -111,12 +121,16 @@ GEM
     marcel (0.3.2)
       mimemagic (~> 0.3.2)
     method_source (0.9.0)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
     mimemagic (0.3.2)
     mini_mime (1.0.0)
     mini_portile2 (2.3.0)
     minitest (5.11.3)
     msgpack (1.2.4)
     multi_json (1.13.1)
+    netrc (0.11.0)
     nio4r (2.3.1)
     nokogiri (1.8.2)
       mini_portile2 (~> 2.3.0)
@@ -179,6 +193,10 @@ GEM
     rb-fsevent (0.10.3)
     rb-inotify (0.9.10)
       ffi (>= 0.5.0, < 2)
+    rest-client (2.0.2)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
       rspec-expectations (~> 3.7.0)
@@ -230,6 +248,9 @@ GEM
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.5)
     unicode-display_width (1.3.2)
     websocket-driver (0.7.0)
       websocket-extensions (>= 0.1.0)
@@ -240,10 +261,12 @@ PLATFORMS
 
 DEPENDENCIES
   aasm
+  auth0
   aws-sdk-lambda
   bootsnap (>= 1.1.0)
   byebug
   database_cleaner
+  dotenv-rails
   factory_bot_rails
   jbuilder (~> 2.5)
   jsonapi-rails

lib/user_import.rb

@@ -0,0 +1,19 @@
+require 'csv'
+require 'auth0'
+require 'user_import_row'
+
+class UserImport
+  def initialize(csv_data, auth0_client)
+    @rows = CSV.parse(csv_data, headers: true, header_converters: :symbol)
+    @auth0_client = auth0_client
+  end
+
+  def run!
+    @rows.each do |row|
+      UserImportRow.new(row.to_h, @auth0_client).import!
+
+      # Needed to stop the Auth0 Management API throttling us
+      sleep 1
+    end
+  end
+end

lib/user_import_row.rb

@@ -0,0 +1,43 @@
+class UserImportRow
+  REQUIRED_KEYS = %i[email personname suppliername].freeze
+
+  def initialize(row, auth0_client)
+    @row = row
+    @auth0_client = auth0_client
+
+    check_for_required_keys!
+  end
+
+  def import!
+    name = @row[:personname]
+    email = @row[:email].strip
+    supplier = @row[:suppliername]
+    password = SecureRandom.alphanumeric(20)
+
+    begin
+      new_user = @auth0_client.create_user(
+        name,
+        connection: 'Username-Password-Authentication',
+        email: email,
+        password: password,
+        verify_email: false,
+        user_metadata: {
+          supplier: supplier
+        }
+      )
+    rescue Auth0::Unsupported => e
+      # Ignore error when user already exists
+      raise unless JSON.parse(e.message)['statusCode'] == 409
+    end
+
+    Rails.logger.info "#{new_user['user_id']},#{email},#{password},#{name}" if new_user
+  end
+
+  private
+
+  def check_for_required_keys!
+    raise MissingKey unless (REQUIRED_KEYS - @row.keys).empty?
+  end
+
+  class MissingKey < StandardError; end
+end

spec/lib/user_import_row_spec.rb

@@ -0,0 +1,50 @@
+require 'rails_helper'
+require './lib/user_import_row'
+
+RSpec.describe UserImportRow do
+  describe '#initialize' do
+    it 'throws an error if the hash is missing required fields' do
+      auth0_client = instance_double('auth0 client')
+
+      data = {
+        personname: 'Daffy Duck'
+      }
+
+      expect { UserImportRow.new(data, auth0_client) }
+        .to raise_error('UserImportRow::MissingKey')
+    end
+  end
+
+  describe '#import!' do
+    it 'creates a new user on Auth0' do
+      data = {
+        frameworkreference: 'RM3756',
+        supplierid: 1234,
+        suppliername: 'Bob and Bucket LLP',
+        lotid: 5678,
+        lotnumber: 1,
+        username: 'francis.brown',
+        personname: 'Francis Brown',
+        jobtitle: 'Big Cheese',
+        contacttel: '02088118055',
+        contactmobile: '07900111222',
+        email: 'francis.brown@example.com',
+        usercreationdate: '1/1/1970 18:00',
+        lastlogindate: '1/7/2018 12:40'
+      }
+
+      auth0_client = instance_double('auth0 client')
+
+      expect(auth0_client)
+        .to receive(:create_user)
+        .with(
+          'Francis Brown',
+          a_hash_including(
+            email: 'francis.brown@example.com'
+          )
+        )
+
+      UserImportRow.new(data, auth0_client).import!
+    end
+  end
+end

spec/lib/user_import_spec.rb

@@ -0,0 +1,33 @@
+require 'rails_helper'
+
+require './lib/user_import'
+
+RSpec.describe UserImport do
+  describe '#initialize' do
+    it 'accepts CSV data and an Auth0 client as input' do
+      client = instance_double('auth0 client')
+
+      csv = "suppliername,email,personname\n"
+      csv += "Vaughan Legal,email@example.com,Jo Bloggs\n"
+      csv += "Vaughan Legal,email2@example.com,Francis Bloggs\n"
+
+      expect { UserImport.new(csv, client) }.to_not raise_error
+    end
+  end
+
+  describe '#run!' do
+    it 'calls UserImportRow.import! for each row contained in the CSV' do
+      client = instance_double('auth0 client')
+      allow(client).to receive(:create_user).and_return('user_id' => 'auth0|user_id')
+
+      csv = "suppliername,email,personname\n"
+      csv += "Vaughan Legal,email@example.com,Jo Bloggs\n"
+      csv += "Vaughan Legal,email2@example.com,Francis Bloggs\n"
+      csv += "Vaughan Legal,email3@example.com,Alex Bloggs\n"
+
+      UserImport.new(csv, client).run!
+
+      expect(client).to have_received(:create_user).exactly(3).times
+    end
+  end
+end