rails-contact 0.1.0

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

@@ -0,0 +1,119 @@
+module Rails
+  module Contact
+    module Search
+      module Backends
+        class Elasticsearch
+          INDEX = "rails_contact_contacts".freeze
+
+          def initialize(client: nil)
+            @client = client || ::Elasticsearch::Client.new(url: Rails::Contact.configuration.elasticsearch_url)
+          end
+
+          def search(query, filters)
+            response = @client.search(index: INDEX, body: search_body(query, filters))
+            ids = response.fetch("hits", {}).fetch("hits", []).map { |doc| doc["_id"] }
+            records_by_id = Contact.where(id: ids).index_by { |record| record.id.to_s }
+            ids.filter_map { |id| records_by_id[id.to_s] }
+          rescue StandardError
+            Search::Backends::Database.new.search(query, filters)
+          end
+
+          def upsert(contact)
+            @client.index(index: INDEX, id: contact.id, body: document_for(contact))
+          end
+
+          def remove(contact_id)
+            @client.delete(index: INDEX, id: contact_id)
+          rescue StandardError
+            nil
+          end
+
+          def create_index!
+            return if @client.indices.exists?(index: INDEX)
+
+            @client.indices.create(index: INDEX, body: index_mapping)
+          end
+
+          private
+
+          def index_mapping
+            {
+              settings: {
+                analysis: {
+                  analyzer: {
+                    folding_analyzer: {
+                      tokenizer: "standard",
+                      filter: [ "lowercase", "asciifolding" ]
+                    }
+                  }
+                }
+              },
+              mappings: {
+                properties: {
+                  full_name: { type: "text", analyzer: "folding_analyzer" },
+                  emails: { type: "keyword" },
+                  phones_e164: { type: "keyword" },
+                  region_name: { type: "keyword" },
+                  current_city: { type: "keyword" },
+                  departure_city: { type: "keyword" },
+                  sync_eligible: { type: "boolean" },
+                  updated_at: { type: "date" }
+                }
+              }
+            }
+          end
+
+          def search_body(query, filters)
+            {
+              size: Rails::Contact.configuration.default_per_page,
+              sort: [ { updated_at: { order: "desc" } }, { id: { order: "desc" } } ],
+              query: {
+                bool: {
+                  must: search_clause(query),
+                  filter: filter_clauses(filters)
+                }
+              }
+            }
+          end
+
+          def search_clause(query)
+            return [ { match_all: {} } ] if query.blank?
+
+            [ {
+              multi_match: {
+                query: query,
+                fields: [ "full_name^3", "emails^2", "phones_e164" ],
+                fuzziness: "AUTO"
+              }
+            } ]
+          end
+
+          def filter_clauses(filters)
+            clauses = []
+            clauses << { term: { current_city: filters["city"] } } if filters["city"].present?
+            clauses << { term: { region_name: filters["region"] } } if filters["region"].present?
+            unless filters["sync_eligible"].nil?
+              value = ActiveModel::Type::Boolean.new.cast(filters["sync_eligible"])
+              clauses << { term: { sync_eligible: value } }
+            end
+            clauses
+          end
+
+          def document_for(contact)
+            {
+              id: contact.id,
+              full_name: contact.full_name,
+              emails: contact.emails.map(&:value),
+              phones_e164: contact.phones.map(&:e164),
+              region_name: contact.region_name,
+              current_city: contact.current_city,
+              departure_city: contact.departure_city,
+              sync_eligible: contact.sync_eligible,
+              updated_at: contact.updated_at
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails/contact/search/query.rb

@@ -0,0 +1,27 @@
+module Rails
+  module Contact
+    module Search
+      class Query
+        def initialize(query, filters: {})
+          @query = query
+          @filters = filters.to_h.compact_blank
+        end
+
+        def call
+          backend.search(@query, @filters)
+        end
+
+        private
+
+        def backend
+          case Rails::Contact.configuration.search_backend.to_sym
+          when :elasticsearch
+            Search::Backends::Elasticsearch.new
+          else
+            Search::Backends::Database.new
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails/contact/version.rb

@@ -0,0 +1,5 @@
+module Rails
+  module Contact
+    VERSION = "0.1.0"
+  end
+end

data/lib/rails/contact.rb

@@ -0,0 +1,32 @@
+require "rails/contact/version"
+require "elasticsearch"
+require "rails/contact/engine"
+require "rails/contact/configuration"
+require "rails/contact/orm"
+require "rails/contact/routing"
+require "rails/contact/search/query"
+require "rails/contact/search/backends/database"
+require "rails/contact/search/backends/elasticsearch"
+require "rails/contact/csv/import_service"
+require "rails/contact/google/client"
+require "rails/contact/google/token_store"
+require "rails/contact/google/payload_mapper"
+require "rails/contact/google/sync_service"
+
+module Rails
+  module Contact
+    class Error < StandardError; end
+
+    class << self
+      attr_writer :configuration
+
+      def configuration
+        @configuration ||= Configuration.new
+      end
+
+      def configure
+        yield(configuration)
+      end
+    end
+  end
+end

data/lib/tasks/rails/contact_tasks.rake

@@ -0,0 +1,31 @@
+namespace :rails_contact do
+  desc "Install initializer and mount routes"
+  task install: :environment do
+    puts "Run: rails generate rails:contact:install"
+  end
+
+  desc "Create Elasticsearch index and reindex all contacts"
+  task reindex: :environment do
+    backend = Rails::Contact::Search::Backends::Elasticsearch.new
+    backend.create_index!
+    Rails::Contact::Contact.includes(:emails, :phones).find_each do |contact|
+      backend.upsert(contact)
+    end
+    puts "Indexed contacts into Elasticsearch"
+  end
+
+  desc "Run Google two-way sync for rolling window"
+  task sync_google: :environment do
+    Rails::Contact::GoogleSyncJob.perform_now
+    puts "Google sync completed"
+  end
+
+  desc "Import contacts from CSV path (CSV_PATH=/path/file.csv)"
+  task import_csv: :environment do
+    path = ENV["CSV_PATH"]
+    raise "Set CSV_PATH env var" if path.blank?
+
+    count = Rails::Contact::Csv::ImportService.new(path: path).import!
+    puts "Imported #{count} rows"
+  end
+end

data/test/csv_import_service_test.rb

@@ -0,0 +1,25 @@
+require_relative "test_helper"
+require "tempfile"
+
+module Rails
+  module Contact
+    class CsvImportServiceTest < Minitest::Test
+      def test_imports_and_dedupes_by_email
+        file = Tempfile.new([ "contacts", ".csv" ])
+        file.write("Enquirer Email,Enquirer First Name,Enquirer Last Name,Enquirer Phone,Enquirer Phone Country Code,Current City,Departure City,Region Name\n")
+        file.write("john@example.com,John,Doe,9998887777,+91,Delhi,Mumbai,UK Tours\n")
+        file.write("john@example.com,John,Doe,9998887777,+91,Delhi,Mumbai,UK Tours\n")
+        file.rewind
+
+        count = Csv::ImportService.new(path: file.path).import!
+
+        assert_equal 2, count
+        assert_equal 1, Contact.count
+        assert_equal 1, Contact.first.emails.count
+      ensure
+        file.close
+        file.unlink
+      end
+    end
+  end
+end

data/test/google_sync_service_test.rb

@@ -0,0 +1,47 @@
+require_relative "test_helper"
+
+module Rails
+  module Contact
+    class GoogleSyncServiceTest < Minitest::Test
+      FakeTokenStore = Struct.new(:access_token)
+
+      class FakeClient
+        attr_reader :created
+
+        def initialize
+          @created = []
+        end
+
+        def create_contact(payload)
+          @created << payload
+          { "resourceName" => "people/123", "etag" => "abc" }
+        end
+
+        def update_contact(_resource_name, payload)
+          @created << payload
+          { "resourceName" => "people/123", "etag" => "def" }
+        end
+      end
+
+      def setup
+        Rails::Contact.configuration.google_max_contacts = 1
+      end
+
+      def test_syncs_only_within_rolling_window
+        older = Contact.create!(given_name: "Old", updated_at: 2.days.ago, created_at: 2.days.ago)
+        newer = Contact.create!(given_name: "New", updated_at: Time.current, created_at: Time.current)
+        [ older, newer ].each do |contact|
+          contact.emails.create!(value: "#{contact.given_name.downcase}@example.com", primary: true)
+          contact.phones.create!(value: "+911234567890", e164: "+911234567890", primary: true)
+        end
+
+        client = FakeClient.new
+        Google::SyncService.new(token_store: FakeTokenStore.new("token"), client: client).sync!
+
+        assert_equal 1, client.created.size
+        assert_nil older.reload.google_resource_name
+        refute_nil newer.reload.google_resource_name
+      end
+    end
+  end
+end

data/test/payload_mapper_test.rb

@@ -0,0 +1,19 @@
+require_relative "test_helper"
+
+module Rails
+  module Contact
+    class PayloadMapperTest < Minitest::Test
+      def test_maps_contact_to_people_payload
+        contact = Contact.create!(given_name: "A", family_name: "B", current_city: "Delhi", departure_city: "Pune", region_name: "UK Tours")
+        contact.emails.create!(value: "ab@example.com", primary: true, label: "work")
+        contact.phones.create!(value: "+919999999999", e164: "+919999999999", primary: true, label: "mobile")
+        contact.addresses.create!(city: "Delhi", departure_city: "Pune", formatted_value: "Current city: Delhi\nDeparture city: Pune")
+
+        payload = Google::PayloadMapper.new(contact).to_people_payload
+        assert_equal "A", payload[:names][0][:givenName]
+        assert_equal "ab@example.com", payload[:emailAddresses][0][:value]
+        assert_equal "+919999999999", payload[:phoneNumbers][0][:value]
+      end
+    end
+  end
+end

data/test/search_fallback_test.rb

@@ -0,0 +1,25 @@
+require_relative "test_helper"
+
+module Rails
+  module Contact
+    class SearchFallbackTest < Minitest::Test
+      class FailingClient
+        def search(*)
+          raise StandardError, "boom"
+        end
+      end
+
+      def test_falls_back_to_database_when_elasticsearch_fails
+        contact = Contact.create!(given_name: "Aruna", family_name: "D", current_city: "Pune")
+        contact.emails.create!(value: "aruna@example.com", primary: true)
+        contact.phones.create!(value: "+919999999999", e164: "+919999999999", primary: true)
+
+        backend = Search::Backends::Elasticsearch.new(client: FailingClient.new)
+        results = backend.search("Aruna", {})
+
+        assert_equal 1, results.size
+        assert_equal "Aruna", results.first.given_name
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,79 @@
+ENV["RAILS_ENV"] ||= "test"
+
+require "bundler/setup"
+require "rails"
+require "active_record"
+require "active_job"
+require "minitest/autorun"
+require "minitest/reporters"
+require "webmock/minitest"
+require "mocha/minitest"
+require "rails/contact"
+require_relative "../app/models/rails/contact/application_record"
+require_relative "../app/models/rails/contact/contact"
+require_relative "../app/models/rails/contact/contact_email"
+require_relative "../app/models/rails/contact/contact_phone"
+require_relative "../app/models/rails/contact/contact_address"
+require_relative "../app/jobs/rails/contact/application_job"
+require_relative "../app/jobs/rails/contact/index_contact_job"
+
+Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new
+
+ActiveRecord::Base.establish_connection(adapter: "sqlite3", database: ":memory:")
+
+ActiveRecord::Schema.define do
+  create_table :rails_contact_contacts, force: true 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, default: true
+    t.text :biography
+    t.text :metadata
+    t.timestamps
+  end
+
+  create_table :rails_contact_contact_emails, force: true do |t|
+    t.integer :contact_id, null: false
+    t.string :value, null: false
+    t.string :label
+    t.boolean :primary, default: false
+    t.timestamps
+  end
+
+  create_table :rails_contact_contact_phones, force: true do |t|
+    t.integer :contact_id, null: false
+    t.string :value, null: false
+    t.string :e164
+    t.string :label
+    t.boolean :primary, default: false
+    t.timestamps
+  end
+
+  create_table :rails_contact_contact_addresses, force: true do |t|
+    t.integer :contact_id, null: false
+    t.string :city
+    t.string :departure_city
+    t.text :formatted_value
+    t.string :label
+    t.timestamps
+  end
+end
+
+ActiveJob::Base.queue_adapter = :test
+
+class Minitest::Test
+  def setup
+    Rails::Contact::ContactAddress.delete_all
+    Rails::Contact::ContactPhone.delete_all
+    Rails::Contact::ContactEmail.delete_all
+    Rails::Contact::Contact.delete_all
+    ActiveJob::Base.queue_adapter.enqueued_jobs.clear
+    ActiveJob::Base.queue_adapter.performed_jobs.clear
+  end
+end

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification
+name: rails-contact
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kshitiz Sinha
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.22'
+- !ruby/object:Gem::Dependency
+  name: phonelib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: faraday-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: elasticsearch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8.13'
+description: Mountable Rails engine offering contact CRUD, CSV import, Elasticsearch-backed
+  search, and optional capped Google Contacts two-way sync.
+email:
+- kshtzkr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/dependabot.yml"
+- ".github/workflows/ci.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/stylesheets/rails/contact/application.css
+- app/controllers/rails/contact/application_controller.rb
+- app/controllers/rails/contact/contacts_controller.rb
+- app/helpers/rails/contact/application_helper.rb
+- app/jobs/rails/contact/application_job.rb
+- app/jobs/rails/contact/google_sync_job.rb
+- app/jobs/rails/contact/index_contact_job.rb
+- app/mailers/rails/contact/application_mailer.rb
+- app/mailers/rails/contact/contact_mailer.rb
+- app/models/rails/contact/application_record.rb
+- app/models/rails/contact/contact.rb
+- app/models/rails/contact/contact_address.rb
+- app/models/rails/contact/contact_email.rb
+- app/models/rails/contact/contact_phone.rb
+- app/views/layouts/rails/contact/application.html.erb
+- app/views/rails/contact/contacts/_form.html.erb
+- app/views/rails/contact/contacts/edit.html.erb
+- app/views/rails/contact/contacts/index.html.erb
+- app/views/rails/contact/contacts/new.html.erb
+- app/views/rails/contact/contacts/show.html.erb
+- bin/rails
+- bin/rubocop
+- config/routes.rb
+- lib/generators/rails/contact/contact_generator.rb
+- lib/generators/rails/contact/install/install_generator.rb
+- lib/generators/rails/contact/install/templates/rails_contact.rb.tt
+- lib/generators/rails/contact/templates/create_rails_contact_contact_addresses.rb.tt
+- lib/generators/rails/contact/templates/create_rails_contact_contact_emails.rb.tt
+- lib/generators/rails/contact/templates/create_rails_contact_contact_phones.rb.tt
+- lib/generators/rails/contact/templates/create_rails_contact_contacts.rb.tt
+- lib/generators/rails/contact/views_generator.rb
+- lib/generators/rails_contact/rails_contact_generator.rb
+- lib/rails/contact.rb
+- lib/rails/contact/configuration.rb
+- lib/rails/contact/csv/import_service.rb
+- lib/rails/contact/engine.rb
+- lib/rails/contact/google/client.rb
+- lib/rails/contact/google/conflict_resolver.rb
+- lib/rails/contact/google/payload_mapper.rb
+- lib/rails/contact/google/sync_service.rb
+- lib/rails/contact/google/token_store.rb
+- lib/rails/contact/orm.rb
+- lib/rails/contact/routing.rb
+- lib/rails/contact/search/backends/database.rb
+- lib/rails/contact/search/backends/elasticsearch.rb
+- lib/rails/contact/search/query.rb
+- lib/rails/contact/version.rb
+- lib/tasks/rails/contact_tasks.rake
+- test/csv_import_service_test.rb
+- test/google_sync_service_test.rb
+- test/payload_mapper_test.rb
+- test/search_fallback_test.rb
+- test/test_helper.rb
+homepage: https://github.com/kshtzkr/rails-contact
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/kshtzkr/rails-contact
+  source_code_uri: https://github.com/kshtzkr/rails-contact/tree/main
+  changelog_uri: https://github.com/kshtzkr/rails-contact/releases
+  bug_tracker_uri: https://github.com/kshtzkr/rails-contact/issues
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: Google-shaped contacts for Rails with search and sync.
+test_files: []