rooty/fab-manager
1
0
Fork 0
mirror of https://github.com/LaCasemate/fab-manager.git synced 2025-01-17 06:52:27 +01:00
Code Issues Releases Activity

improved member autocompletion with multiple words + refactored members controller

Browse Source
This commit is contained in:
Sylvain 2019-01-21 15:17:56 +01:00
parent 62410da9e1
commit 75eaf4d4d0
8 changed files with 227 additions and 158 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGELOG.md
View File

@ -9,6 +9,7 @@
- Fix a bug: unable to delete an admin who has changed a setting
- Fix a bug: unable to create/edit a plan of 12 months or 52 weeks
- Fix a bug: Unable to search in user autocomplete fields
- Improved user autocompletion when using multiple words
- Refactored frontend invoices translations
- Updated RailRoady 1.4.0 to 1.5.3

148
app/controllers/api/members_controller.rb
View File

@ -1,15 +1,16 @@
# frozen_string_literal: true
# API Controller for resources of type User with role 'member'
class API::MembersController < API::ApiController
before_action :authenticate_user!, except: [:last_subscribed]
before_action :set_member, only: [:update, :destroy, :merge]
before_action :set_member, only: %i[update destroy merge]
respond_to :json
def index
@requested_attributes = params[:requested_attributes]
@query = policy_scope(User)
unless params[:page].nil? and params[:size].nil?
@query = @query.page(params[:page].to_i).per(params[:size].to_i)
end
@query = @query.page(params[:page].to_i).per(params[:size].to_i) unless params[:page].nil? && params[:size].nil?
# remove unmerged profiles from list
@members = @query.to_a
@ -17,7 +18,11 @@ class API::MembersController < API::ApiController
end
def last_subscribed
@query = User.active.with_role(:member).includes(profile: [:user_avatar]).where('is_allow_contact = true AND confirmed_at IS NOT NULL').order('created_at desc').limit(params[:last])
@query = User.active.with_role(:member)
.includes(profile: [:user_avatar])
.where('is_allow_contact = true AND confirmed_at IS NOT NULL')
.order('created_at desc')
.limit(params[:last])
# remove unmerged profiles from list
@members = @query.to_a
@ -34,27 +39,11 @@ class API::MembersController < API::ApiController
def create
authorize User
if !user_params[:password] and !user_params[:password_confirmation]
generated_password = Devise.friendly_token.first(8)
@member = User.new(user_params.merge(password: generated_password).permit!)
else
@member = User.new(user_params.permit!)
end
@member = User.new(user_params.permit!)
members_service = Members::MembersService.new(@member)
# if the user is created by an admin and the authentication is made through an SSO, generate a migration token
if current_user.admin? and AuthProvider.active.providable_type != DatabaseProvider.name
@member.generate_auth_migration_token
end
if @member.save
@member.generate_subscription_invoice
@member.send_confirmation_instructions
if !user_params[:password] and !user_params[:password_confirmation]
UsersMailer.delay.notify_user_account_created(@member, generated_password)
else
UsersMailer.delay.notify_user_account_created(@member, user_params[:password])
end
if members_service.create(current_user, user_params)
render :show, status: :created, location: member_path(@member)
else
render json: @member.errors, status: :unprocessable_entity
@ -63,21 +52,14 @@ class API::MembersController < API::ApiController
def update
authorize @member
members_service = MembersService.new(@member)
members_service = Members::MembersService.new(@member)
if user_params[:group_id] && @member.group_id != user_params[:group_id].to_i && !@member.subscribed_plan.nil?
# here a group change is requested but unprocessable, handle the exception
@member.errors[:group_id] = t('members.unable_to_change_the_group_while_a_subscription_is_running')
render json: @member.errors, status: :unprocessable_entity
if members_service.update(user_params)
# Update password without logging out
sign_in(@member, bypass: true) unless current_user.id != params[:id].to_i
render :show, status: :ok, location: member_path(@member)
else
# otherwise, run the user update
if members_service.update(user_params)
# Update password without logging out
sign_in(@member, bypass: true) unless current_user.id != params[:id].to_i
render :show, status: :ok, location: member_path(@member)
else
render json: @member.errors, status: :unprocessable_entity
end
render json: @member.errors, status: :unprocessable_entity
end
end
@ -92,9 +74,11 @@ class API::MembersController < API::ApiController
def export_subscriptions
authorize :export
export = Export.where(category:'users', export_type: 'subscriptions').where('created_at > ?', Subscription.maximum('updated_at')).last
export = Export.where(category: 'users', export_type: 'subscriptions')
.where('created_at > ?', Subscription.maximum('updated_at'))
.last
if export.nil? || !FileTest.exist?(export.file)
@export = Export.new(category:'users', export_type: 'subscriptions', user: current_user)
@export = Export.new(category: 'users', export_type: 'subscriptions', user: current_user)
if @export.save
render json: { export_id: @export.id }, status: :ok
else
@ -111,7 +95,7 @@ class API::MembersController < API::ApiController
def export_reservations
authorize :export
export = Export.where(category:'users', export_type: 'reservations')
export = Export.where(category: 'users', export_type: 'reservations')
.where('created_at > ?', Reservation.maximum('updated_at'))
.last
if export.nil? || !FileTest.exist?(export.file)
@ -131,11 +115,11 @@ class API::MembersController < API::ApiController
def export_members
authorize :export
export = Export.where(category:'users', export_type: 'members')
export = Export.where(category: 'users', export_type: 'members')
.where('created_at > ?', User.with_role(:member).maximum('updated_at'))
.last
if export.nil? || !FileTest.exist?(export.file)
@export = Export.new(category:'users', export_type: 'members', user: current_user)
@export = Export.new(category: 'users', export_type: 'members', user: current_user)
if @export.save
render json: { export_id: @export.id }, status: :ok
else
@ -148,16 +132,15 @@ class API::MembersController < API::ApiController
end
end
# the user is querying to be mapped to his already existing account
def merge
authorize @member
# here the user query to be mapped to his already existing account
token = params.require(:user).permit(:auth_token)[:auth_token]
token = token_param
@account = User.find_by(auth_token: token)
if @account
members_service = MembersService.new(@account)
members_service = Members::MembersService.new(@account)
begin
if members_service.merge_from_sso(@member)
@member = @account
@ -168,7 +151,8 @@ class API::MembersController < API::ApiController
render json: @member.errors, status: :unprocessable_entity
end
rescue DuplicateIndexError => error
render json: { error: t('members.please_input_the_authentication_code_sent_to_the_address', EMAIL: error.message) }, status: :unprocessable_entity
render json: { error: t('members.please_input_the_authentication_code_sent_to_the_address', EMAIL: error.message) },
status: :unprocessable_entity
end
else
render json: { error: t('members.your_authentication_code_is_not_valid') }, status: :unprocessable_entity
@ -178,67 +162,17 @@ class API::MembersController < API::ApiController
def list
authorize User
p = params.require(:query).permit(:search, :order_by, :page, :size)
render json: { error: 'page must be an integer' }, status: :unprocessable_entity and return unless query_params[:page].is_a? Integer
render json: { error: 'size must be an integer' }, status: :unprocessable_entity and return unless query_params[:size].is_a? Integer
render json: {error: 'page must be an integer'}, status: :unprocessable_entity unless p[:page].is_a? Integer
render json: {error: 'size must be an integer'}, status: :unprocessable_entity unless p[:size].is_a? Integer
direction = (p[:order_by][0] == '-' ? 'DESC' : 'ASC')
order_key = (p[:order_by][0] == '-' ? p[:order_by][1, p[:order_by].size] : p[:order_by])
order_key = case order_key
when 'last_name'
'profiles.last_name'
when 'first_name'
'profiles.first_name'
when 'email'
'users.email'
when 'phone'
'profiles.phone'
when 'group'
'groups.name'
when 'plan'
'plans.base_name'
else
'users.id'
end
@query = User.includes(:profile, :group, :subscriptions)
.joins(:profile, :group, :roles, 'LEFT JOIN "subscriptions" ON "subscriptions"."user_id" = "users"."id" LEFT JOIN "plans" ON "plans"."id" = "subscriptions"."plan_id"')
.where("users.is_active = 'true' AND roles.name = 'member'")
.order("#{order_key} #{direction}")
.page(p[:page])
.per(p[:size])
# ILIKE => PostgreSQL case-insensitive LIKE
@query = @query.where('profiles.first_name ILIKE :search OR profiles.last_name ILIKE :search OR profiles.phone ILIKE :search OR email ILIKE :search OR groups.name ILIKE :search OR plans.base_name ILIKE :search', search: "%#{p[:search]}%") if p[:search].size > 0
@members = @query.to_a
query = Members::ListService.list(query_params)
@max_members = query.except(:offset, :limit, :order).count
@members = query.to_a
end
def search
@members = User.includes(:profile)
.joins(:profile, :roles, 'LEFT JOIN "subscriptions" ON "subscriptions"."user_id" = "users"."id"')
.where("users.is_active = 'true' AND roles.name = 'member'")
.where("lower(f_unaccent(profiles.first_name)) ~ regexp_replace(:search, E'\\\\s+', '|') OR lower(f_unaccent(profiles.last_name)) ~ regexp_replace(:search, E'\\\\s+', '|')", search: params[:query].downcase)
if current_user.member?
# non-admin can only retrieve users with "public profiles"
@members = @members.where("users.is_allow_contact = 'true'")
else
# only admins have the ability to filter by subscription
if params[:subscription] == 'true'
@members = @members.where('subscriptions.id IS NOT NULL AND subscriptions.expiration_date >= :now', now: Date.today.to_s)
elsif params[:subscription] == 'false'
@members = @members.where('subscriptions.id IS NULL OR subscriptions.expiration_date < :now', now: Date.today.to_s)
end
end
@members = @members.to_a
@members = Members::ListService.search(current_user, params[:query], params[:subscription])
end
def mapping
@ -281,4 +215,12 @@ class API::MembersController < API::ApiController
end
end
def token_param
params.require(:user).permit(:auth_token)[:auth_token]
end
def query_params
params.require(:query).permit(:search, :order_by, :page, :size)
end
end

5
app/controllers/application_controller.rb
View File

@ -51,4 +51,9 @@ class ApplicationController < ActionController::Base
def current_user
super
end
# This is a placeholder for Devise's authenticate_user! method.
def authenticate_user!
super
end
end

8
app/policies/user_policy.rb
View File

@ -2,9 +2,11 @@ class UserPolicy < ApplicationPolicy
class Scope < Scope
def resolve
if user.admin?
scope.includes(:group, :training_credits, :machine_credits, :subscriptions => [:plan => [:credits]], :profile => [:user_avatar]).joins(:roles).where("users.is_active = 'true' AND roles.name = 'member'").order('users.created_at desc')
scope.includes(:group, :training_credits, :machine_credits, subscriptions: [plan: [:credits]], profile: [:user_avatar])
.joins(:roles).where("users.is_active = 'true' AND roles.name = 'member'").order('users.created_at desc')
else
scope.includes(:profile => [:user_avatar]).joins(:roles).where("users.is_active = 'true' AND roles.name = 'member'").where(is_allow_contact: true).order('users.created_at desc')
scope.includes(profile: [:user_avatar]).joins(:roles).where("users.is_active = 'true' AND roles.name = 'member'")
.where(is_allow_contact: true).order('users.created_at desc')
end
end
end
@ -25,7 +27,7 @@ class UserPolicy < ApplicationPolicy
user.id == record.id
end
%w(list create mapping).each do |action|
%w[list create mapping].each do |action|
define_method "#{action}?" do
user.admin?
end

87
app/services/members/list_service.rb Normal file
View File

@ -0,0 +1,87 @@
# frozen_string_literal: true
# Provides helper methods for listing Users
class Members::ListService
class << self
def list(params)
@query = User.includes(:profile, :group, :subscriptions)
.joins(:profile,
:group,
:roles,
'LEFT JOIN "subscriptions" ON "subscriptions"."user_id" = "users"."id" ' \
'LEFT JOIN "plans" ON "plans"."id" = "subscriptions"."plan_id"')
.where("users.is_active = 'true' AND roles.name = 'member'")
.order(list_order(params))
.page(params[:page])
.per(params[:size])
# ILIKE => PostgreSQL case-insensitive LIKE
if params[:search].size.positive?
@query = @query.where('profiles.first_name ILIKE :search OR ' \
'profiles.last_name ILIKE :search OR ' \
'profiles.phone ILIKE :search OR ' \
'email ILIKE :search OR ' \
'groups.name ILIKE :search OR ' \
'plans.base_name ILIKE :search', search: "%#{params[:search]}%")
end
@query
end
def search(current_user, query, subscription)
members = User.includes(:profile)
.joins(:profile,
:roles,
'LEFT JOIN "subscriptions" ON "subscriptions"."user_id" = "users"."id" AND ' \
'"subscriptions"."created_at" = ( ' \
'SELECT max("created_at") ' \
'FROM "subscriptions" ' \
'WHERE "user_id" = "users"."id")')
.where("users.is_active = 'true' AND roles.name = 'member'")
query.downcase.split(' ').each do |word|
members = members.where('lower(f_unaccent(profiles.first_name)) ~ :search OR ' \
'lower(f_unaccent(profiles.last_name)) ~ :search',
search: word)
end
if current_user.member?
# non-admin can only retrieve users with "public profiles"
members = members.where("users.is_allow_contact = 'true'")
elsif subscription == 'true'
# only admins have the ability to filter by subscription
members = members.where('subscriptions.id IS NOT NULL AND subscriptions.expiration_date >= :now', now: Date.today.to_s)
elsif subscription == 'false'
members = members.where('subscriptions.id IS NULL OR subscriptions.expiration_date < :now', now: Date.today.to_s)
end
members.to_a
end
private
def list_order(params)
direction = (params[:order_by][0] == '-' ? 'DESC' : 'ASC')
order_key = (params[:order_by][0] == '-' ? params[:order_by][1, params[:order_by].size] : params[:order_by])
order_key = case order_key
when 'last_name'
'profiles.last_name'
when 'first_name'
'profiles.first_name'
when 'email'
'users.email'
when 'phone'
'profiles.phone'
when 'group'
'groups.name'
when 'plan'
'plans.base_name'
else
'users.id'
end
"#{order_key} #{direction}"
end
end
end

77
app/services/members/members_service.rb Normal file
View File

@ -0,0 +1,77 @@
# frozen_string_literal: true
# Provides helper methods for User actions
class Members::MembersService
attr_accessor :member
def initialize(member)
@member = member
end
def update(params)
if params[:group_id] && @member.group_id != params[:group_id].to_i && !@member.subscribed_plan.nil?
# here a group change is requested but unprocessable, handle the exception
@member.errors[:group_id] = I18n.t('members.unable_to_change_the_group_while_a_subscription_is_running')
return false
end
not_complete = member.need_completion?
up_result = member.update(params)
notify_user_profile_complete(not_complete) if up_result
up_result
end
def create(current_user, params)
@member.password = password(params)
# if the user is created by an admin and the authentication is made through an SSO, generate a migration token
@member.generate_auth_migration_token if current_user.admin? && AuthProvider.active.providable_type != DatabaseProvider.name
if @member.save
@member.generate_subscription_invoice
@member.send_confirmation_instructions
UsersMailer.delay.notify_user_account_created(@member, @member.password)
true
else
false
end
end
def merge_from_sso(user)
merge_result = member.merge_from_sso(user)
notify_admin_user_merged if merge_result
merge_result
end
private
def notify_user_profile_complete(previous_state)
return unless previous_state && !member.need_completion?
NotificationCenter.call type: :notify_user_profile_complete,
receiver: member,
attached_object: member
NotificationCenter.call type: :notify_admin_profile_complete,
receiver: User.admins,
attached_object: member
end
def notify_admin_user_merged
NotificationCenter.call type: :notify_admin_user_merged,
receiver: User.admins,
attached_object: member
end
def password(params)
if !params[:password] && !params[:password_confirmation]
Devise.friendly_token.first(8)
else
params[:password]
end
end
end

45
app/services/members_service.rb
View File

@ -1,45 +0,0 @@
class MembersService
attr_accessor :member
def initialize(member)
@member = member
end
def update(params)
not_complete = self.member.need_completion?
up_result = self.member.update(params)
if up_result
notify_user_profile_complete(not_complete)
end
up_result
end
def merge_from_sso(user)
merge_result = self.member.merge_from_sso(user)
if merge_result
notify_admin_user_merged
end
merge_result
end
private
def notify_user_profile_complete(previous_state)
if previous_state and not self.member.need_completion?
NotificationCenter.call type: :notify_user_profile_complete,
receiver: self.member,
attached_object: self.member
NotificationCenter.call type: :notify_admin_profile_complete,
receiver: User.admins,
attached_object: self.member
end
end
def notify_admin_user_merged
NotificationCenter.call type: :notify_admin_user_merged,
receiver: User.admins,
attached_object: self.member
end
end

14
app/views/api/members/list.json.jbuilder
View File

@ -1,7 +1,5 @@
max_members = @query.except(:offset, :limit, :order).count
json.array!(@members) do |member|
json.maxMembers max_members
json.maxMembers @max_members
json.id member.id
json.email member.email if current_user
json.profile do
@ -13,7 +11,9 @@ json.array!(@members) do |member|
json.group do
json.name member.group.name
end
json.subscribed_plan do
json.partial! 'api/shared/plan', plan: member.subscribed_plan
end if member.subscribed_plan
end
if member.subscribed_plan
json.subscribed_plan do
json.partial! 'api/shared/plan', plan: member.subscribed_plan
end
end
end