Extending customers to Redmine's built in search

app/controllers/customers_controller.rb

@@ -30,8 +30,6 @@ class CustomersController < ApplicationController
   before_action :view_customer, except: [:new, :view]
   skip_before_action :verify_authenticity_token, :check_if_login_required, only: [:view]
 
-  default_search_scope :names
-
   autocomplete :customer, :name, full: true, extra_data: [:id]
 
   def allowed_params

app/models/customer.rb

@@ -18,11 +18,6 @@ class Customer < ActiveRecord::Base
   
   self.primary_key = :id
   
-  # returns a human readable string
-  def to_s
-    return "#{self[:name]} - #{phone_number.split(//).last(4).join unless phone_number.nil?}"
-  end
-  
   # Convenience Method
   # returns the customer's email
   def email
@@ -41,6 +36,27 @@ class Customer < ActiveRecord::Base
     @details.email_address = s
   end
   
+  # Redmine Search Event Interface
+  def event_type
+    :customer
+  end
+
+  def event_title
+    to_s
+  end
+
+  def event_description
+    "#{I18n.t :label_primary_phone}: #{primary_phone} #{I18n.t:label_mobile_phone}: #{mobile_phone}"
+  end
+
+  def event_url
+    customer_path(self)
+  end
+
+  def event_datetime
+    updated_at || created_at
+  end
+
   # Convenience Method
   # returns the customer's primary phone
   def primary_phone
@@ -63,6 +79,11 @@ class Customer < ActiveRecord::Base
     update_phone_number
   end
 
+  # Customers are not bound by a project.
+  def project
+    nil
+  end
+
   # Convenience Method
   # returns the customer's mobile phone
   def mobile_phone
@@ -174,6 +195,41 @@ class Customer < ActiveRecord::Base
     return customers.order(:name)
   end
 
+  def self.searchable_columns
+    ['name', 'phone_number', 'mobile_phone_number']
+  end
+
+  def self.searchable_options
+    {
+      columns: searchable_columns,
+      scope: self.all
+    }
+  end
+
+  def self.search_results_from_ids(ids, *args)
+    return [] if ids.blank?
+
+    ids = ids.map(&:to_i)
+    records = where(id: ids).index_by(&:id)
+    ids.map { |id| records[id] }.compact
+  end
+
+  def self.search_result_ranks_and_ids(tokens, user, project = nil, options = {})
+    return {} if tokens.blank?
+
+    scope = self.all
+
+    tokens.each do |token|
+      q = "%#{sanitize_sql_like(token)}%"
+      scope = where("name LIKE ? OR phone_number LIKE ? OR mobile_phone_number LIKE ?", "%#{q}%", "%#{q}%", "%#{q}%") 
+    end
+
+    ids = scope.distinct.limit(options[:limit] || 100).pluck(:id)
+
+    # Assign simple uniform ranking
+    ids.each_with_object({}) { |id, h| h[id] = id }
+  end
+  
   # proforms a bruteforce sync operation
   # This needs to be simplified
   def self.sync_by_id(id) 
@@ -201,6 +257,27 @@ class Customer < ActiveRecord::Base
     end
   end
   
+  # returns a human readable string
+  def to_s
+    return "#{self[:name]} - #{phone_number.split(//).last(4).join unless phone_number.nil?}"
+  end
+  
+  private
+  
+  # pull the details
+  def pull
+    begin
+      raise Exception unless self.id
+      qbo = Qbo.first
+      @details = qbo.perform_authenticated_request do |access_token|
+        service = Quickbooks::Service::Customer.new(company_id: qbo.realm_id, access_token: access_token)
+        service.fetch_by_id(self.id)
+      end
+    rescue Exception => e
+      @details = Quickbooks::Model::Customer.new
+    end
+  end
+
   # Push the updates
   def save_with_push
     begin
@@ -220,20 +297,4 @@ class Customer < ActiveRecord::Base
   alias_method :save_without_push, :save
   alias_method :save, :save_with_push
   
-  private
-  
-  # pull the details
-  def pull
-    begin
-      raise Exception unless self.id
-      qbo = Qbo.first
-      @details = qbo.perform_authenticated_request do |access_token|
-        service = Quickbooks::Service::Customer.new(company_id: qbo.realm_id, access_token: access_token)
-        service.fetch_by_id(self.id)
-      end
-    rescue Exception => e
-      @details = Quickbooks::Model::Customer.new
-    end
-  end
-  
 end

db/migrate/038_add_customers_timestamp.rb

@@ -0,0 +1,15 @@
+#The MIT License (MIT)
+#
+#Copyright (c) 2016 - 2026 rick barrette
+#
+#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+#
+#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+#
+#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+class AddCustomersTimestamp < ActiveRecord::Migration[5.1]
+  def change
+    add_timestamps(:customers, null: true)
+  end
+end

init.rb

@@ -37,6 +37,10 @@ Redmine::Plugin.register :redmine_qbo do
   # Register top menu items
   menu :top_menu, :customers, { controller: :customers, action: :index }, caption: :label_customers, if: Proc.new {User.current.logged?}
     
+  Redmine::Search.map do |search|
+    search.register :customers
+  end
+
 end
 
 # Dynamically load all Hooks & Patches recursively