Initial implementation of importer (#1)

Author: orhantoy

Gemfile

@@ -23,7 +23,7 @@ gem 'jbuilder', '~> 2.5'
 # Use Redis adapter to run Action Cable in production
 # gem 'redis', '~> 4.0'
 # Use ActiveModel has_secure_password
-# gem 'bcrypt', '~> 3.1.7'
+gem 'bcrypt', '~> 3.1.7'
 
 # Use ActiveStorage variant
 # gem 'mini_magick', '~> 4.8'
@@ -34,6 +34,9 @@ gem 'jbuilder', '~> 2.5'
 # Reduces boot times through caching; required in config/boot.rb
 gem 'bootsnap', '>= 1.1.0', require: false
 
+# All sorts of useful information about every country packaged as pretty little country objects. It includes data from ISO 3166
+gem 'countries'
+
 group :development, :test do
   # Call 'byebug' anywhere in the code to stop execution and get a debugger console
   gem 'byebug', platforms: [:mri, :mingw, :x64_mingw]
@@ -54,6 +57,7 @@ group :test do
   gem 'selenium-webdriver'
   # Easy installation and use of chromedriver to run system tests with Chrome
   gem 'chromedriver-helper'
+  gem 'minitest-focus'
 end
 
 # Windows does not include zoneinfo files, so bundle the tzinfo-data gem

Gemfile.lock

@@ -47,6 +47,7 @@ GEM
     archive-zip (0.11.0)
       io-like (~> 0.3.0)
     arel (9.0.0)
+    bcrypt (3.1.12)
     bindex (0.5.0)
     bootsnap (1.3.2)
       msgpack (~> 1.0)
@@ -66,6 +67,11 @@ GEM
       archive-zip (~> 0.10)
       nokogiri (~> 1.8)
     concurrent-ruby (1.0.5)
+    countries (2.1.4)
+      i18n_data (~> 0.8.0)
+      money (~> 6.9)
+      sixarm_ruby_unaccent (~> 1.1)
+      unicode_utils (~> 1.4)
     crass (1.0.4)
     erubi (1.7.1)
     execjs (2.7.0)
@@ -74,6 +80,7 @@ GEM
       activesupport (>= 4.2.0)
     i18n (1.1.1)
       concurrent-ruby (~> 1.0)
+    i18n_data (0.8.0)
     io-like (0.3.0)
     jbuilder (2.7.0)
       activesupport (>= 4.2.0)
@@ -94,6 +101,10 @@ GEM
     mini_mime (1.0.1)
     mini_portile2 (2.3.0)
     minitest (5.11.3)
+    minitest-focus (1.1.2)
+      minitest (>= 4, < 6)
+    money (6.13.1)
+      i18n (>= 0.6.4, <= 2)
     msgpack (1.2.4)
     multi_json (1.13.1)
     nio4r (2.3.1)
@@ -150,6 +161,7 @@ GEM
     selenium-webdriver (3.14.1)
       childprocess (~> 0.5)
       rubyzip (~> 1.2, >= 1.2.2)
+    sixarm_ruby_unaccent (1.2.0)
     spring (2.0.2)
       activesupport (>= 4.2)
     spring-watcher-listen (2.0.1)
@@ -172,6 +184,7 @@ GEM
       thread_safe (~> 0.1)
     uglifier (4.1.19)
       execjs (>= 0.3.0, < 3)
+    unicode_utils (1.4.0)
     web-console (3.7.0)
       actionview (>= 5.0)
       activemodel (>= 5.0)
@@ -187,12 +200,15 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  bcrypt (~> 3.1.7)
   bootsnap (>= 1.1.0)
   byebug
   capybara (>= 2.15)
   chromedriver-helper
+  countries
   jbuilder (~> 2.5)
   listen (>= 3.0.5, < 3.2)
+  minitest-focus
   pg (>= 0.18, < 2.0)
   puma (~> 3.11)
   rails (~> 5.2.1)

README.md

@@ -0,0 +1,31 @@
+# Müşteri
+
+(*Müşteri* means customer in Turkish.)
+
+A lot of applications deal with importing customers and/or users from other systems, usually by uploading a tabular file like CSV. I made a test assignment for job applicants at a previous job about this specific need. This codebase is an illustration of how I would implement it with Rails.
+
+## Concepts
+
+- **Space** is the top-level grouping of customers. It is the equivalent of an account.
+- **Customer** belongs to a space.
+- **User** can have access to multiple customers across spaces with only one set of credentials (email + password).
+
+## Restrictions
+
+- CSV must be delimited with comma `,` and UTF-8 encoded.
+- Only CSV is supported.
+- CSV file must have a header row with hard-coded column names.
+
+## Improvements
+
+Basically all the listed restrictions should be addressed in an ideal implementation.
+
+## Run
+
+There is nothing special about this Rails app. If you have PostgreSQL installed and have tried running Rails apps before it should be enough to run the following commands
+
+```
+./bin/setup
+rails test # Tests should be passing
+rails server
+```

app/assets/stylesheets/main.scss

@@ -0,0 +1,100 @@
+body {
+  font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
+  margin: 20px;
+}
+
+a {
+  color: #4078c0;
+}
+
+.plain-table {
+  border-collapse: collapse;
+
+  th {
+    border-bottom: 1px solid #bbb;
+    font-weight: bold;
+    text-align: left;
+  }
+
+  tr:hover td {
+    background-color: #eee;
+  }
+
+  th, td {
+    vertical-align: top;
+  }
+
+  th {
+    padding: 0 20px 10px 0;
+  }
+
+  td {
+    padding: 10px 20px 10px 0;
+  }
+}
+
+.mv1 {
+  margin: 24px 0;
+}
+
+form.button_to {
+  display: inline-block;
+}
+
+.btn {
+  display: inline-block;
+  background-color: #6e5494;
+  border: none;
+  border-radius: 4px;
+  color: #fff;
+  cursor: pointer;
+  padding: 0 0.5em;
+  margin: 0;
+  font-size: 20px;
+  line-height: 2em;
+  text-decoration: none;
+}
+
+.btn-bg {
+  background-color: lighten(#6e5494, 50%);
+  padding: 12px;
+}
+
+.customer-import-row--error-cell {
+  color: #bd2c00;
+  font-size: 14px;
+  font-weight: bold;
+}
+
+.customer-import--row-type-link {
+  display: inline-block;
+  border: 1px solid transparent;
+  border-radius: 4px;
+  padding: 4px 8px;
+}
+
+.customer-import--row-type-link.unselected a {
+  color: #666;
+}
+
+.customer-import--row-type-link.selected {
+  border-color: #4078c0;
+}
+
+.password-input-container {
+  display: inline-block;
+  margin-right: 12px;
+
+  label {
+    color: #666;
+    display: inline-block;
+    margin-bottom: 6px;
+  }
+
+  input {
+    font-size: 18px;
+    width: 200px;
+    padding: 6px;
+    margin: 0;
+  }
+}

app/controllers/application_controller.rb

@@ -1,2 +1,9 @@
 class ApplicationController < ActionController::Base
+  helper_method :current_space
+
+  protected
+
+  def current_space
+    @current_space ||= Space.find_by_slug!(params[:tenant])
+  end
 end

app/controllers/customer_imports_controller.rb

@@ -0,0 +1,37 @@
+class CustomerImportsController < ApplicationController
+  def new; end
+
+  def create
+    if params[:import_file].blank?
+      redirect_to url_for(action: "new")
+      return
+    end
+
+    customer_import = current_space.customer_imports.create!(uploaded_file: params[:import_file])
+    ParseCustomerImportJob.perform_later(customer_import)
+
+    redirect_to url_for(action: "show", id: customer_import.id)
+  end
+
+  def show
+    @customer_import = current_space.customer_imports.find(params[:id])
+
+    if @customer_import.parsing?
+      render :parsing
+    elsif @customer_import.finalizing?
+      render :finalizing
+    elsif params[:row_type].present?
+      @rows = @customer_import.rows_of_type(params[:row_type])
+      render
+    else
+      redirect_to url_for(row_type: "valid")
+    end
+  end
+
+  def finalize
+    customer_import = current_space.customer_imports.find(params[:id])
+    FinalizeCustomerImportJob.perform_later(customer_import)
+
+    redirect_to url_for(action: "show", id: customer_import.id)
+  end
+end

app/controllers/customer_membership_confirmations_controller.rb

@@ -0,0 +1,34 @@
+class CustomerMembershipConfirmationsController < ApplicationController
+  # GET /confirm/:membership_id/access?secret_token=xxx
+  def new
+    @membership = CustomerMembership.find_by(id: params[:membership_id], confirmation_token: String(params[:secret_token]))
+  end
+
+  # POST /confirm/:membership_id/access
+  def create
+    @membership = CustomerMembership.find_by(id: params[:membership_id], confirmation_token: String(params[:secret_token]))
+
+    if @membership && @membership.confirm(confirmation_args)
+      redirect_to url_for(action: "success")
+    elsif @membership
+      render :new
+    else
+      redirect_to url_for(action: "error")
+    end
+  end
+
+  # GET /confirm/:membership_id/success
+  def success; end
+
+  # GET /confirm/:membership_id/error
+  def error; end
+
+  private
+
+  def confirmation_args
+    {
+      user_password: params[:user_password],
+      user_password_confirmation: params[:user_password_confirmation],
+    }
+  end
+end

app/controllers/customers_controller.rb

@@ -0,0 +1,9 @@
+class CustomersController < ApplicationController
+  def index
+    @customers = current_space.customers.order(:id)
+  end
+
+  def show
+    @customer = current_space.customers.find(params[:id])
+  end
+end

app/controllers/home_controller.rb

@@ -0,0 +1,7 @@
+class HomeController < ApplicationController
+  def index
+    default_space = Space.find_or_create_by!(slug: "alpi", title: "ALPI")
+
+    redirect_to app_path(tenant: default_space.slug)
+  end
+end

app/jobs/finalize_customer_import_job.rb

@@ -0,0 +1,9 @@
+class FinalizeCustomerImportJob < ApplicationJob
+  after_enqueue do |job|
+    job.arguments.first.touch(:started_finalizing_at)
+  end
+
+  def perform(customer_import)
+    customer_import.finalize!
+  end
+end

app/jobs/parse_customer_import_job.rb

@@ -0,0 +1,16 @@
+class ParseCustomerImportJob < ApplicationJob
+  after_enqueue do |job|
+    job.arguments.first.touch(:started_parsing_at)
+  end
+
+  def perform(customer_import)
+    customer_import.parse!
+  rescue => e
+    customer_import.update(
+      parsing_failed_at: Time.zone.now,
+      parsing_failure_message: "Something went wrong while parsing the file",
+    )
+
+    Rails.logger.error e.message
+  end
+end

app/mailers/customer_membership_mailer.rb

@@ -0,0 +1,10 @@
+class CustomerMembershipMailer < ApplicationMailer
+  def confirmation(customer_membership)
+    @customer_membership = customer_membership
+    @user = customer_membership.user
+    @customer = customer_membership.customer
+    @space = customer_membership.customer.space
+
+    mail(to: @customer_membership.user.email)
+  end
+end

app/models/customer.rb

@@ -0,0 +1,13 @@
+class Customer < ApplicationRecord
+  belongs_to :space
+  has_many :memberships, class_name: "CustomerMembership"
+  has_many :users, through: :memberships
+
+  def country
+    ISO3166::Country.new(country_code) if country_code?
+  end
+
+  def country_name
+    country.name if country
+  end
+end