Merge pull request #27 from dxw/290-add-customers-model

Add new Customer model (including import script)

Author: tekin

.rubocop.yml

@@ -13,6 +13,10 @@ Rails:
 Bundler/OrderedGems:
     Enabled: false
 
+Rails/Output:
+    Exclude:
+        - 'db/data_migrate/**/*'
+
 Style/Alias:
     Enabled: false
 

Gemfile

@@ -32,6 +32,8 @@ gem 'auth0', require: false
 
 gem 'rubocop'
 
+gem 'progress_bar', require: false
+
 group :development, :test do
   gem 'byebug', platforms: %i[mri mingw x64_mingw]
   gem 'dotenv-rails'

Gemfile.lock

@@ -89,6 +89,7 @@ GEM
     ffi (1.9.23)
     globalid (0.4.1)
       activesupport (>= 4.2.0)
+    highline (1.7.10)
     http-cookie (1.0.3)
       domain_name (~> 0.5)
     i18n (1.0.1)
@@ -134,11 +135,15 @@ GEM
     nio4r (2.3.1)
     nokogiri (1.8.2)
       mini_portile2 (~> 2.3.0)
+    options (2.3.2)
     parallel (1.12.1)
     parser (2.5.1.0)
       ast (~> 2.4.0)
     pg (1.0.0)
     powerpack (0.1.1)
+    progress_bar (1.2.0)
+      highline (~> 1.6)
+      options (~> 2.3.0)
     pry (0.11.3)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
@@ -274,6 +279,7 @@ DEPENDENCIES
   jsonapi-rspec
   listen (>= 3.0.5, < 3.2)
   pg (>= 0.18, < 2.0)
+  progress_bar
   pry-rails
   puma (~> 3.11)
   rails (~> 5.2.0)

app/models/customer.rb

@@ -0,0 +1,6 @@
+class Customer < ApplicationRecord
+  enum sector: { central_government: 0, wider_public_sector: 1 }
+
+  validates :name, :sector, presence: true
+  validates :urn, presence: true, uniqueness: true
+end

db/data_migrate/20180807095900_customers.csv

@@ -0,0 +1,20 @@
+require 'csv'
+require 'progress_bar'
+
+puts 'Reading CSV file...'
+customers_csv_path = Rails.root.join('db', 'data_migrate', '20180807095900_customers.csv')
+csv = CSV.read(customers_csv_path, headers: true, header_converters: :symbol)
+
+puts 'Importing customers...'
+bar = ProgressBar.new(csv.count)
+csv.each do |customer_row|
+  postcode = customer_row[:postcode] == 'XXXX' ? nil : customer_row[:postcode].strip
+
+  Customer.find_or_create_by(urn: customer_row[:urn]) do |customer|
+    customer.postcode = postcode
+    customer.sector = customer_row[:sector].strip.parameterize.underscore
+    customer.name = customer_row[:customername].strip
+  end
+
+  bar.increment!
+end

db/data_migrate/20180807095900_import_customers.rb

@@ -0,0 +1,16 @@
+class CreateCustomers < ActiveRecord::Migration[5.2]
+  def change
+    create_table :customers, id: :uuid do |t|
+      t.string :name, null: false
+      t.string :postcode
+      t.integer :urn, null: false
+      t.integer :sector, null: false
+
+      t.timestamps
+    end
+
+    add_index :customers, :urn, unique: true
+    add_index :customers, :postcode
+    add_index :customers, :sector
+  end
+end

db/migrate/20180807093650_create_customers.rb

@@ -10,7 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 2018_08_06_160648) do
+ActiveRecord::Schema.define(version: 2018_08_07_093650) do
 
   # These are extensions that must be enabled in order to support this database
   enable_extension "pgcrypto"
@@ -23,6 +23,18 @@
     t.index ["supplier_id"], name: "index_agreements_on_supplier_id"
   end
 
+  create_table "customers", id: :uuid, default: -> { "gen_random_uuid()" }, force: :cascade do |t|
+    t.string "name", null: false
+    t.string "postcode"
+    t.integer "urn", null: false
+    t.integer "sector", null: false
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.index ["postcode"], name: "index_customers_on_postcode"
+    t.index ["sector"], name: "index_customers_on_sector"
+    t.index ["urn"], name: "index_customers_on_urn", unique: true
+  end
+
   create_table "event_store_events", id: :uuid, default: -> { "gen_random_uuid()" }, force: :cascade do |t|
     t.string "event_type", null: false
     t.text "metadata"

db/schema.rb

@@ -0,0 +1,8 @@
+FactoryBot.define do
+  factory :customer do
+    name 'Department for Silly Hats'
+    sequence(:urn)
+    postcode 'W1 7ZX'
+    sector Customer.sectors[:central_government]
+  end
+end

spec/factories/customers.rb

@@ -0,0 +1,10 @@
+require 'rails_helper'
+
+RSpec.describe Customer do
+  subject { FactoryBot.create(:customer) }
+
+  it { is_expected.to validate_presence_of(:name) }
+  it { is_expected.to validate_presence_of(:urn) }
+  it { is_expected.to validate_presence_of(:sector) }
+  it { is_expected.to validate_uniqueness_of(:urn) }
+end