Merge pull request #15 from dxw/feature/142-create-supplier-user-accounts-in-auth0

(142) Import suppliers / Create users in Auth0

Author: leeky

.rubocop.yml

@@ -65,3 +65,8 @@ Metrics/BlockLength:
     Max: 40
     Exclude:
         - 'spec/**/*'
+
+Lint/AmbiguousBlockAssociation:
+    Exclude:
+        - 'spec/**/*'
+

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

README.md

@@ -43,3 +43,7 @@ Rebuilds the test server, runs rubocop checks, runs the test suite and cleans up
 ## API Endpoints
 
 A [full list of the API endpoints](endpoints.md) is available in a separate document.
+
+## Importing users
+
+See [this guide](importing.md) to see how to import users and suppliers.

importing.md

@@ -0,0 +1,48 @@
+# Import Users / Suppliers
+
+Users and suppliers are imported from a CSV which MUST have the following
+fields:
+
+ - personname (full name of user)
+ - email
+ - suppliername
+ - frameworkreference (the framework's RM number)
+
+Also, the file needs to encoded in UTF-8 or you'll get errors! To convert an
+existing file, run the following on the command line:
+
+`iconv -c -f "US-ASCII" -t "UTF-8" input.csv > output.csv`
+
+The following commands can be run from the Rails console, given a `csv`
+variable that contains the contents of a CSV as a string.
+
+# Importing suppliers
+
+Running `require 'supplier_import'; SupplierImport.new(csv).run!` will:
+
+ - Create any suppliers that don't already exist in the database
+ - Assign these suppliers to the correct frameworks (NB: these should already
+     exist)
+
+# Importing users
+
+First, you'll need to obtain the Auth0 client_id, token and domain. Then you'll
+need to set the `csv` variable as above.
+
+Once you have these, run the following from the Rails console.
+
+```ruby
+client = Auth0Client.new(client_id: client_id, token: token, domain: domain)
+UserImport.new(csv, client).run!
+```
+
+You'll see an output like this (one for every row in the CSV)
+
+```
+auth0:1234566788,email@example.com,password,John Smith
+```
+
+**Make a note of this, as it's the only place where you can see the passwords
+generated for each user.**
+
+

lib/supplier_import.rb

@@ -0,0 +1,14 @@
+require 'csv'
+require 'supplier_import_row'
+
+class SupplierImport
+  def initialize(csv_data)
+    @rows = CSV.parse(csv_data, headers: true, header_converters: :symbol)
+  end
+
+  def run!
+    @rows.each do |row|
+      SupplierImportRow.new(row.to_h).import!
+    end
+  end
+end

lib/supplier_import_row.rb

@@ -0,0 +1,24 @@
+class SupplierImportRow
+  REQUIRED_KEYS = %i[frameworkreference suppliername].freeze
+
+  def initialize(row)
+    @row = row
+
+    check_for_required_keys!
+  end
+
+  def import!
+    supplier = Supplier.find_or_create_by!(name: @row[:suppliername])
+    framework = Framework.find_by!(short_name: @row[:frameworkreference])
+
+    supplier.agreements.find_or_create_by!(framework: framework)
+  end
+
+  private
+
+  def check_for_required_keys!
+    raise MissingKey unless (REQUIRED_KEYS - @row.keys).empty?
+  end
+
+  class MissingKey < StandardError; end
+end

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/factories/agreement.rb

@@ -0,0 +1,6 @@
+FactoryBot.define do
+  factory :agreement do
+    supplier
+    framework
+  end
+end