Class: Crm::PartyLookupController

Inherits:
CrmController show all
Defined in:
app/controllers/crm/party_lookup_controller.rb

Overview

Controller: party lookup.

Constant Summary

Constants included from Controllers::ReferenceFindable

Controllers::ReferenceFindable::ID_EMBEDDED_PATTERNS

Constants included from Controllers::AnalyticsEvents

Controllers::AnalyticsEvents::MAX_QUEUED_EVENTS, Controllers::AnalyticsEvents::SESSION_KEY

Constants included from Controllers::ErrorRendering

Controllers::ErrorRendering::NON_CONTENT_PATH_PREFIXES

Instance Method Summary collapse

Methods inherited from CrmController

#access_denied, #context_id, #context_object, #crm_home_path, #current_ability, #default_url_options, #download_temp, #get_tempfile_path_for_download, #init_status_job_collector, #initialize_crm_lazy_chunks, #persist_enqueued_status_jobs, #record_not_found, #redirect_to_job_or_fallback, #render_edit_action, #set_context, #set_download_path, #stash_file_for_temp_download, #sync_admin_presence_cookie, #touch_employee_last_seen

Methods inherited from ApplicationController

#account_impersonated?, #add_to_flash, #after_sign_in_path_for, #bypass_forgery_protection?, #chat_enabled?, #cloudflare_cleared?, #default_catalog, #default_url_options, #enable_turbo_frames, #find_publication, #fix_invalid_accept_header, #init_js_utils, #is_globals_call?, #layout_by_resource, #locale_store, #redirect_to, #require_employee_for_crm, #set_base_host, #set_real_ip, #set_report_errors_for, #should_render_layout?, #skip_layout_for_turbo_frame?, #stamp_impersonation_context, #tab_frame_breakout_request?, #warmlyyours_canada_ip?, #warmlyyours_ip?, #y

Methods included from Controllers::ReturnPathHandling

#check_for_return_path, #redirect_to_return_path_or_default

Methods included from Controllers::AnalyticsEvents

#consume_queued_analytics_events, #registration_lead_type, #track_event

Methods included from Controllers::DeviceDetection

#device_detector, #is_ie?

Methods included from Controllers::SubdomainDetection

#is_crm_request?, #is_www_request?, #json_request?

Methods included from Controllers::TurboSafeRedirect

#redirect_to

Methods included from Controllers::TrackingDetection

#bot_request?, #gdpr_country?, #gdpr_country_data, #prevent_bots, #set_tracking_cookie, #track_visitor?

Methods included from Controllers::AcceleratedFileSending

#send_file_accelerated, #send_upload_accelerated

Methods included from Controllers::ErrorRendering

#excp_string, #mail_to_for_error_reporting, #render_400, #render_404, #render_406, #render_410, #render_500, #render_invalid_authenticity_token, #render_ip_spoof_error, #render_unpermitted_parameters, #safe_referer_or_fallback

Methods included from Controllers::TurnstileVerification

#load_turnstile_script_tag, #turnstile_lazy_widget, #turnstile_script_tag, #turnstile_widget, #validate_turnstile!

Methods included from Controllers::CloudflareCaching

edge_cached, #edge_cached_action?, #reset_cloudflare_cache, #set_cloudflare_cache, #skip_edge_cache!, #skip_session

Methods included from Controllers::Webpackable

#preload_webpack_fonts, #webpack_css_include, #webpack_css_url, #webpack_js_include, #wpd_is_running?

Methods included from Controllers::Localizable

#cloudflare_country_locale, #determine_request_locale, #geocoder_locale, #guest_user_locale_check, #locale_optional_www_auth_path?, #param_locale, #set_locale, #set_request_locale, #skip_localization?, #warmlyyours_ip_locale

Methods included from Controllers::Authenticable

#access_denied, #authenticate_account, #authenticate_account!, #authenticate_account_from_login_token!, #check_is_a_manager, #check_is_a_sales_manager, #check_is_an_admin, #check_is_an_employee, #check_party, #clear_mismatched_guest_user, #create_guest_user, #credentials?, #current_or_guest_user, #current_or_guest_user_id_read_only, #current_user, #devise_mapping, #fully_logged_in?, #generate_bot_id, #guest_user, #identifiable?, #init_current_user, #initialize_guest, #load_context_user, #logging_in, #resource, #resource_name, #restrict_access_for_non_employees, #scrubbed_request_path, #user_object, #warn_on_session_guest_id_leak

Methods included from UrlsHelper

#catalog_breadcrumb_links, #catalog_link, #catalog_link_for_product_line, #catalog_link_for_sku, #cms_link, #delocalized_path, #path_to_sales_product_sku, #path_to_sales_product_sku_for_product_line, #path_to_sales_product_sku_for_product_line_slug, #product_line_from_catalog_link, #protocol_neutral_url, #sanitize_external_url, #valid_external_url?

Instance Method Details

#lookup_contactObject

TomSelect JSON search for a customer's contacts, prepending the
invoice's shipping attention line (if any) on page 1.



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
# File 'app/controllers/crm/party_lookup_controller.rb', line 25

def lookup_contact
  cid = params[:customer_id].presence
  page = params[:page].presence&.to_i || 1
  per_page = params[:per_page].presence&.to_i || 10
  q = params[:q].presence
  include_inactive = params[:include_inactive].to_b
  invoice_id = params[:invoice_id].presence

  unless cid
    render json: { results: [], pagination: { more: false } }
    return
  end

  scope = contact_lookup_results_relation(cid, q, include_inactive)
  pagy, contacts_page = pagy(:countless, scope, page: page, limit: per_page)

  contact_rows = contacts_page.map do |c|
    { id: c.full_name, text: TomSelect.normalize_text(c.full_name) }
  end

  if page == 1
    extras = invoice_shipping_contact_names_for_lookup(cid, invoice_id, q)
    extra_rows = extras.map { |name| { id: name, text: TomSelect.normalize_text(name) } }
    contact_rows = merge_tom_select_contact_rows(extra_rows, contact_rows)
  end

  render json: { results: contact_rows, pagination: { more: !pagy.next.nil? } }
end

#lookup_customerObject

TomSelect JSON search for customers, by reference number, id, or keyword query.



6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
# File 'app/controllers/crm/party_lookup_controller.rb', line 6

def lookup_customer
  q = params[:q]
  customer_id = params[:customer_id].presence || scan_customer_id
  company_id = params[:company_id].presence
  page = params[:page] || 1
  per_page = params[:per_page] || 10
  @results = Customer.all # starting scope
  @results = @results.joins(:catalog).where(catalogs: { company_id: company_id }) if company_id
  @results = if customer_id
               @results.where(id: customer_id)
             else
               @results.lookup(q)
             end

  render json: TomSelect.format_json_results(self, @results, page, per_page)
end

#lookup_partyObject

TomSelect JSON search for parties, by id (optionally scoped to a category)
or keyword query.



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
# File 'app/controllers/crm/party_lookup_controller.rb', line 56

def lookup_party
  q = params[:q]
  party_id = params[:party_id].presence
  categories = params[:categories].presence
  if party_id
    query = { id: party_id }
    query[:type] = categories if categories.present?
    party = Party.find_by(query)
    if party
      render json: { results: { id: party_id, text: party.to_s } }
    else
      render json: { results: { id: nil, text: nil } }
    end
  else
    page = params[:page] || 1
    per_page = params[:per_page] || 10
    @results = if (customer_id = scan_customer_id)
                 Customer.where(id: customer_id)
               else
                 Party.lookup(q)
               end
    render json: TomSelect.format_json_results(self, @results, page, per_page)
  end
end

#lookup_party_by_categoryObject

TomSelect JSON search for parties scoped to params[:search_for]
(customer/supplier/contact/employee/party), filtered by id/email/phone/address/name.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
# File 'app/controllers/crm/party_lookup_controller.rb', line 83

def lookup_party_by_category
  page = params[:page] || 1
  per_page = params[:per_page] || 10
  @results = case params[:search_for]&.downcase
             when 'customer'
               Customer.order(:full_name)
             when 'supplier'
               Supplier.order(:full_name)
             when 'contact'
               Contact.order(:full_name)
             when 'employee'
               Employee.order(:full_name)
             else # 'party' or blank - search all customers and contacts
               Party.customer_or_contact
             end
  q = params[:q].presence
  query_type = params[:query_type].presence
  unless params[:include_inactive].to_b
    # explicity pass state IS NULL otherwise parties with state NULL will not be returned
    @results = @results.where.not(inactive: true).where("parties.state IS NULL or parties.state NOT IN ('guest','inactive','closed','bankrupt')")
  end
  if q
    @results = case query_type
               when 'id'
                 if (customer_id = scan_customer_id(q))
                   @results.where(id: customer_id)
                 else
                   @results.where(id: q)
                 end
               when 'email'
                 @results.email_search(q)
               when 'phone'
                 @results.phone_search(q)
               when 'address'
                 @results.address_search(q)
               else # Name lookup; also match customer reference numbers (CN123) used in CRM
                 cn_id = scan_customer_id(q)
                 if cn_id
                   by_cn = @results.where(id: cn_id)
                   by_cn.exists? ? by_cn : @results.lookup(q)
                 else
                   @results.lookup(q)
                 end
               end
  end

  render json: TomSelect.format_json_results(self, @results, page, per_page)
end