rails-contact 0.1.0

data/app/views/rails/contact/contacts/show.html.erb

@@ -0,0 +1,13 @@
+<h1><%= @contact.full_name %></h1>
+<p>Email: <%= @contact.primary_email&.value %></p>
+<p>Phone: <%= @contact.primary_phone&.e164 %></p>
+<p>Current city: <%= @contact.current_city %></p>
+<p>Departure city: <%= @contact.departure_city %></p>
+<p>Region: <%= @contact.region_name %></p>
+<p>Biography: <%= @contact.biography %></p>
+
+<p>
+  <%= link_to "Edit", edit_contact_path(@contact) %> |
+  <%= link_to "Delete", contact_path(@contact), data: {turbo_method: :delete, turbo_confirm: "Delete contact?"} %> |
+  <%= link_to "Back", contacts_path %>
+</p>

data/bin/rails

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path("..", __dir__)
+ENGINE_PATH = File.expand_path("../lib/rails/contact/engine", __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+require "bundler/setup" if File.exist?(ENV["BUNDLE_GEMFILE"])
+
+require "rails"
+# Pick the frameworks you want:
+require "active_model/railtie"
+require "active_job/railtie"
+require "active_record/railtie"
+# require "active_storage/engine"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+# require "action_mailbox/engine"
+# require "action_text/engine"
+require "action_view/railtie"
+require "action_cable/engine"
+# require "rails/test_unit/railtie"
+require "rails/engine/commands"

data/bin/rubocop

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+require "rubygems"
+require "bundler/setup"
+
+# explicit rubocop config increases performance slightly while avoiding config confusion.
+ARGV.unshift("--config", File.expand_path("../.rubocop.yml", __dir__))
+
+load Gem.bin_path("rubocop", "rubocop")

data/config/routes.rb

@@ -0,0 +1,4 @@
+Rails::Contact::Engine.routes.draw do
+  resources :contacts
+  root to: "contacts#index"
+end

data/lib/generators/rails/contact/contact_generator.rb

@@ -0,0 +1,29 @@
+require "rails/generators"
+require "rails/generators/active_record"
+
+module Rails
+  module Contact
+    module Generators
+      class ContactGenerator < ::Rails::Generators::NamedBase
+        include ::Rails::Generators::Migration
+
+        source_root File.expand_path("templates", __dir__)
+
+        def self.next_migration_number(dirname)
+          ActiveRecord::Generators::Base.next_migration_number(dirname)
+        end
+
+        def create_initializer
+          invoke "rails:contact:install"
+        end
+
+        def copy_migrations
+          migration_template "create_rails_contact_contacts.rb.tt", "db/migrate/create_rails_contact_contacts.rb"
+          migration_template "create_rails_contact_contact_emails.rb.tt", "db/migrate/create_rails_contact_contact_emails.rb"
+          migration_template "create_rails_contact_contact_phones.rb.tt", "db/migrate/create_rails_contact_contact_phones.rb"
+          migration_template "create_rails_contact_contact_addresses.rb.tt", "db/migrate/create_rails_contact_contact_addresses.rb"
+        end
+      end
+    end
+  end
+end

data/lib/generators/rails/contact/install/install_generator.rb

@@ -0,0 +1,19 @@
+require "rails/generators"
+
+module Rails
+  module Contact
+    module Generators
+      class InstallGenerator < ::Rails::Generators::Base
+        source_root File.expand_path("templates", __dir__)
+
+        def create_initializer
+          template "rails_contact.rb.tt", "config/initializers/rails_contact.rb"
+        end
+
+        def mount_engine_route
+          route "mount Rails::Contact::Engine => '/contacts', as: 'rails_contact'"
+        end
+      end
+    end
+  end
+end

data/lib/generators/rails/contact/install/templates/rails_contact.rb.tt

@@ -0,0 +1,16 @@
+Rails::Contact.configure do |config|
+  config.contact_class_name = "Rails::Contact::Contact"
+  config.search_backend = :elasticsearch
+  config.elasticsearch_url = ENV.fetch("ELASTICSEARCH_URL", "http://127.0.0.1:9200")
+
+  config.google_sync_enabled = ENV.fetch("RAILS_CONTACT_GOOGLE_SYNC_ENABLED", "false") == "true"
+  config.google_max_contacts = 25_000
+  config.rolling_window_sort = :updated_at
+
+  config.google_client_id = ENV["GOOGLE_CLIENT_ID"]
+  config.google_client_secret = ENV["GOOGLE_CLIENT_SECRET"]
+  config.google_redirect_uri = ENV["GOOGLE_REDIRECT_URI"]
+  config.google_token_path = ENV.fetch("RAILS_CONTACT_GOOGLE_TOKEN_PATH", "tmp/rails_contact_google_token.json")
+
+  config.default_per_page = 25
+end

data/lib/generators/rails/contact/templates/create_rails_contact_contact_addresses.rb.tt

@@ -0,0 +1,13 @@
+class CreateRailsContactContactAddresses < ActiveRecord::Migration[7.1]
+  def change
+    create_table :rails_contact_contact_addresses do |t|
+      t.references :contact, null: false, foreign_key: {to_table: :rails_contact_contacts}
+      t.string :city
+      t.string :departure_city
+      t.text :formatted_value
+      t.string :label
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/rails/contact/templates/create_rails_contact_contact_emails.rb.tt

@@ -0,0 +1,15 @@
+class CreateRailsContactContactEmails < ActiveRecord::Migration[7.1]
+  def change
+    create_table :rails_contact_contact_emails do |t|
+      t.references :contact, null: false, foreign_key: {to_table: :rails_contact_contacts}
+      t.string :value, null: false
+      t.string :label
+      t.boolean :primary, null: false, default: false
+
+      t.timestamps
+    end
+
+    add_index :rails_contact_contact_emails, :value
+    add_index :rails_contact_contact_emails, [:contact_id, :primary]
+  end
+end

data/lib/generators/rails/contact/templates/create_rails_contact_contact_phones.rb.tt

@@ -0,0 +1,16 @@
+class CreateRailsContactContactPhones < ActiveRecord::Migration[7.1]
+  def change
+    create_table :rails_contact_contact_phones do |t|
+      t.references :contact, null: false, foreign_key: {to_table: :rails_contact_contacts}
+      t.string :value, null: false
+      t.string :e164
+      t.string :label
+      t.boolean :primary, null: false, default: false
+
+      t.timestamps
+    end
+
+    add_index :rails_contact_contact_phones, :e164
+    add_index :rails_contact_contact_phones, [:contact_id, :primary]
+  end
+end

data/lib/generators/rails/contact/templates/create_rails_contact_contacts.rb.tt

@@ -0,0 +1,24 @@
+class CreateRailsContactContacts < ActiveRecord::Migration[7.1]
+  def change
+    create_table :rails_contact_contacts do |t|
+      t.string :given_name, null: false
+      t.string :family_name
+      t.string :region_name
+      t.string :departure_city
+      t.string :current_city
+      t.string :google_resource_name
+      t.string :google_etag
+      t.datetime :google_last_modified_at
+      t.datetime :last_synced_at
+      t.boolean :sync_eligible, null: false, default: true
+      t.text :biography
+      t.jsonb :metadata, null: false, default: {}
+
+      t.timestamps
+    end
+
+    add_index :rails_contact_contacts, :updated_at
+    add_index :rails_contact_contacts, :sync_eligible
+    add_index :rails_contact_contacts, :google_resource_name, unique: true
+  end
+end

data/lib/generators/rails/contact/views_generator.rb

@@ -0,0 +1,15 @@
+require "rails/generators/base"
+
+module Rails
+  module Contact
+    module Generators
+      class ViewsGenerator < ::Rails::Generators::Base
+        source_root File.expand_path("../../../../app/views", __dir__)
+
+        def copy_views
+          directory "rails/contact/contacts", "app/views/rails_contact/contacts"
+        end
+      end
+    end
+  end
+end

data/lib/generators/rails_contact/rails_contact_generator.rb

@@ -0,0 +1,7 @@
+require "rails/generators"
+
+class RailsContactGenerator < ::Rails::Generators::NamedBase
+  def delegate_to_engine_generator
+    invoke "rails:contact:contact", [ name ]
+  end
+end

data/lib/rails/contact/configuration.rb

@@ -0,0 +1,25 @@
+module Rails
+  module Contact
+    class Configuration
+      attr_accessor :contact_class_name, :elasticsearch_url, :search_backend,
+                    :google_sync_enabled, :google_max_contacts, :rolling_window_sort,
+                    :google_client_id, :google_client_secret, :google_redirect_uri,
+                    :google_token_path, :reset_index_on_boot, :default_per_page
+
+      def initialize
+        @contact_class_name = "Rails::Contact::Contact"
+        @elasticsearch_url = ENV.fetch("ELASTICSEARCH_URL", "http://127.0.0.1:9200")
+        @search_backend = :elasticsearch
+        @google_sync_enabled = false
+        @google_max_contacts = 25_000
+        @rolling_window_sort = :updated_at
+        @google_client_id = ENV["GOOGLE_CLIENT_ID"]
+        @google_client_secret = ENV["GOOGLE_CLIENT_SECRET"]
+        @google_redirect_uri = ENV["GOOGLE_REDIRECT_URI"]
+        @google_token_path = ENV.fetch("RAILS_CONTACT_GOOGLE_TOKEN_PATH", "tmp/rails_contact_google_token.json")
+        @reset_index_on_boot = false
+        @default_per_page = 25
+      end
+    end
+  end
+end

data/lib/rails/contact/csv/import_service.rb

@@ -0,0 +1,87 @@
+require "csv"
+
+module Rails
+  module Contact
+    module Csv
+      class ImportService
+        HEADER_MAP = {
+          "Enquirer First Name" => :given_name,
+          "Enquirer Last Name" => :family_name,
+          "Current City" => :current_city,
+          "Departure City" => :departure_city,
+          "Region Name" => :region_name
+        }.freeze
+
+        def initialize(path:, dedupe_key: :email)
+          @path = path
+          @dedupe_key = dedupe_key
+        end
+
+        def import!
+          imported = 0
+          CSV.foreach(@path, headers: true) do |row|
+            import_row(row.to_h)
+            imported += 1
+          end
+          imported
+        end
+
+        private
+
+        def import_row(row)
+          attrs = build_attributes(row)
+          contact = find_or_initialize(row)
+          contact.assign_attributes(attrs)
+          contact.save!
+          upsert_associations(contact, row)
+          Rails::Contact::IndexContactJob.perform_later(contact.id)
+        end
+
+        def build_attributes(row)
+          HEADER_MAP.each_with_object({}) do |(csv_key, attr), memo|
+            value = row[csv_key].to_s.strip
+            memo[attr] = (value == "blank" ? nil : value.presence)
+          end
+        end
+
+        def find_or_initialize(row)
+          email = normalize_email(row["Enquirer Email"])
+          return Rails::Contact::Contact.new if email.blank?
+          return Rails::Contact::Contact.new if @dedupe_key != :email
+
+          Rails::Contact::Contact.joins(:emails).where(rails_contact_contact_emails: { value: email }).first || Rails::Contact::Contact.new
+        end
+
+        def upsert_associations(contact, row)
+          email = normalize_email(row["Enquirer Email"])
+          primary_phone = normalize_phone(row["Enquirer Phone Country Code"], row["Enquirer Phone"])
+          alt_phone = normalize_phone(row["Alternate Wa Phone Country Code"], row["Alternate Wa Phone"])
+
+          contact.emails.find_or_create_by!(value: email, primary: true, label: "work") if email.present?
+          if primary_phone.present?
+            contact.phones.find_or_create_by!(value: primary_phone, e164: primary_phone, primary: true, label: "mobile")
+          end
+          if alt_phone.present?
+            contact.phones.find_or_create_by!(value: alt_phone, e164: alt_phone, primary: false, label: "whatsapp")
+          end
+
+          formatted_value = "Current city: #{contact.current_city}\nDeparture city: #{contact.departure_city}"
+          contact.addresses.find_or_create_by!(city: contact.current_city, departure_city: contact.departure_city, formatted_value: formatted_value)
+        end
+
+        def normalize_email(value)
+          clean = value.to_s.strip.downcase
+          clean.presence
+        end
+
+        def normalize_phone(country_code, number)
+          digits = number.to_s.gsub(/\D+/, "")
+          return nil if digits.blank?
+          prefix = country_code.to_s.strip
+          prefix = "+#{prefix}" unless prefix.start_with?("+")
+          "#{prefix}#{digits}"
+        end
+      end
+    end
+  end
+end

data/lib/rails/contact/engine.rb

@@ -0,0 +1,21 @@
+module Rails
+  module Contact
+    class Engine < ::Rails::Engine
+      isolate_namespace Rails::Contact
+
+      config.generators.test_framework :minitest
+
+      initializer "rails_contact.configure_defaults" do
+        Rails::Contact.configuration
+      end
+
+      initializer "rails_contact.filter_sensitive_params" do |app|
+        app.config.filter_parameters += %i[google_access_token google_refresh_token authorization]
+      end
+
+      rake_tasks do
+        load File.expand_path("../../tasks/rails/contact_tasks.rake", __dir__)
+      end
+    end
+  end
+end

data/lib/rails/contact/google/client.rb

@@ -0,0 +1,55 @@
+require "json"
+
+module Rails
+  module Contact
+    module Google
+      class Client
+        PEOPLE_API_BASE = "https://people.googleapis.com/v1".freeze
+
+        def initialize(access_token:)
+          @connection = Faraday.new(url: PEOPLE_API_BASE) do |faraday|
+            faraday.request :retry, max: 3, interval: 0.5, backoff_factor: 2
+            faraday.response :raise_error
+          end
+          @access_token = access_token
+        end
+
+        def create_contact(payload)
+          post("/people:createContact", payload)
+        end
+
+        def update_contact(resource_name, payload)
+          patch("/#{resource_name}:updateContact", payload)
+        end
+
+        def delete_contact(resource_name)
+          @connection.delete("/#{resource_name}") { |request| request.headers = headers }
+        end
+
+        private
+
+        def post(path, payload)
+          parse(@connection.post(path) do |request|
+            request.headers = headers
+            request.body = payload.to_json
+          end)
+        end
+
+        def patch(path, payload)
+          parse(@connection.patch(path) do |request|
+            request.headers = headers
+            request.body = payload.to_json
+          end)
+        end
+
+        def parse(response)
+          JSON.parse(response.body)
+        end
+
+        def headers
+          { "Authorization" => "Bearer #{@access_token}", "Content-Type" => "application/json" }
+        end
+      end
+    end
+  end
+end

data/lib/rails/contact/google/conflict_resolver.rb

@@ -0,0 +1,20 @@
+module Rails
+  module Contact
+    module Google
+      class ConflictResolver
+        def initialize(local_contact, remote_modified_at:)
+          @local_contact = local_contact
+          @remote_modified_at = remote_modified_at
+        end
+
+        # v1 policy: last-write-wins by modified timestamp.
+        def prefer_remote?
+          return false if @remote_modified_at.blank?
+          return true if @local_contact.updated_at.blank?
+
+          @remote_modified_at > @local_contact.updated_at
+        end
+      end
+    end
+  end
+end

data/lib/rails/contact/google/payload_mapper.rb

@@ -0,0 +1,26 @@
+module Rails
+  module Contact
+    module Google
+      class PayloadMapper
+        def initialize(contact)
+          @contact = contact
+        end
+
+        def to_people_payload
+          {
+            names: [ { givenName: @contact.given_name, familyName: @contact.family_name } ],
+            emailAddresses: @contact.emails.map { |email| { value: email.value, type: (email.label || "other") } },
+            phoneNumbers: @contact.phones.map { |phone| { value: phone.e164.presence || phone.value, type: (phone.label || "mobile") } },
+            addresses: @contact.addresses.map do |address|
+              {
+                city: address.city,
+                formattedValue: address.formatted_value.presence || "Current city: #{@contact.current_city}\nDeparture city: #{@contact.departure_city}"
+              }
+            end,
+            biographies: [ { value: [ @contact.biography, @contact.region_name ].compact.join("\n") } ]
+          }.compact
+        end
+      end
+    end
+  end
+end

data/lib/rails/contact/google/sync_service.rb

@@ -0,0 +1,34 @@
+module Rails
+  module Contact
+    module Google
+      class SyncService
+        def initialize(token_store: TokenStore.new, client: nil)
+          @token_store = token_store
+          @client = client || Client.new(access_token: @token_store.access_token)
+        end
+
+        def sync!
+          Rails::Contact::Contact.sync_window.each do |contact|
+            sync_contact(contact)
+          end
+        end
+
+        def sync_contact(contact)
+          payload = PayloadMapper.new(contact).to_people_payload
+          response = if contact.google_resource_name.present?
+                       @client.update_contact(contact.google_resource_name, payload)
+          else
+                       @client.create_contact(payload)
+          end
+
+          contact.update!(
+            google_resource_name: response["resourceName"] || contact.google_resource_name,
+            google_etag: response["etag"] || contact.google_etag,
+            google_last_modified_at: Time.current,
+            last_synced_at: Time.current
+          )
+        end
+      end
+    end
+  end
+end

data/lib/rails/contact/google/token_store.rb

@@ -0,0 +1,31 @@
+require "json"
+require "fileutils"
+
+module Rails
+  module Contact
+    module Google
+      class TokenStore
+        def initialize(path: Rails::Contact.configuration.google_token_path)
+          @path = path
+        end
+
+        def access_token
+          data.fetch("access_token")
+        end
+
+        def write!(payload)
+          FileUtils.mkdir_p(File.dirname(@path))
+          File.write(@path, payload.to_json)
+        end
+
+        private
+
+        def data
+          @data ||= JSON.parse(File.read(@path))
+        rescue Errno::ENOENT
+          raise Rails::Contact::Error, "Google token file missing at #{@path}"
+        end
+      end
+    end
+  end
+end

data/lib/rails/contact/orm.rb

@@ -0,0 +1,19 @@
+module Rails
+  module Contact
+    module ORM
+      module_function
+
+      def adapter
+        ENV.fetch("DEVISE_ORM", "active_record")
+      end
+
+      def active_record?
+        adapter == "active_record"
+      end
+
+      def mongoid?
+        adapter == "mongoid"
+      end
+    end
+  end
+end

data/lib/rails/contact/routing.rb

@@ -0,0 +1,11 @@
+module Rails
+  module Contact
+    module Routing
+      def rails_contact_for(path = :contacts)
+        mount Rails::Contact::Engine => "/#{path}", as: "rails_contact"
+      end
+    end
+  end
+end
+
+ActionDispatch::Routing::Mapper.include(Rails::Contact::Routing)

data/lib/rails/contact/search/backends/database.rb

@@ -0,0 +1,41 @@
+module Rails
+  module Contact
+    module Search
+      module Backends
+        class Database
+          def search(query, filters)
+            scope = Contact.includes(:emails, :phones).recent_first
+            scope = apply_filters(scope, filters)
+            return scope.limit(limit) if query.blank?
+
+            wildcard = "%#{query.downcase}%"
+            scope.left_joins(:emails, :phones).where(
+              "LOWER(rails_contact_contacts.given_name) LIKE :q OR "\
+              "LOWER(rails_contact_contacts.family_name) LIKE :q OR "\
+              "LOWER(rails_contact_contact_emails.value) LIKE :q OR "\
+              "rails_contact_contact_phones.e164 LIKE :raw",
+              q: wildcard,
+              raw: "%#{query}%"
+            ).distinct.limit(limit)
+          end
+
+          private
+
+          def apply_filters(scope, filters)
+            scoped = scope
+            scoped = scoped.where(current_city: filters["city"]) if filters["city"].present?
+            scoped = scoped.where(region_name: filters["region"]) if filters["region"].present?
+            if filters["sync_eligible"].present?
+              scoped = scoped.where(sync_eligible: ActiveModel::Type::Boolean.new.cast(filters["sync_eligible"]))
+            end
+            scoped
+          end
+
+          def limit
+            Rails::Contact.configuration.default_per_page
+          end
+        end
+      end
+    end
+  end
+end