email_digest 1.0.0

data/lib/email_digest/services/digest_scheduler.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module EmailDigest
+  module Services
+    class DigestScheduler
+      def self.process_all_ready(organization = nil)
+        preferences = Models::DigestPreference.ready_to_send(organization)
+        preferences.each do |preference|
+          process_preference(preference)
+        end
+      end
+
+      def self.process_preference(preference)
+        return unless preference.enabled
+
+        # Get user from MongoDB - we need to load it using the configured user class
+        user_class = EmailDigest.configuration.user_class.constantize
+        user = user_class.find(preference.user_id)
+        return unless user
+
+        # Get organization from MongoDB
+        org_class = EmailDigest.configuration.organization_class.constantize
+        organization = org_class.find(preference.organization_id)
+        return unless organization
+
+        # Scope queries by organization_id (replaces Mongoid multitenancy)
+        # Use custom collector if configured, otherwise use default
+        digest_config = EmailDigest.configuration.digest_types[preference.digest_type.to_sym]
+        collector_class = if digest_config&.dig(:collector)
+          digest_config[:collector].constantize
+        else
+          EmailDigest::Services::DigestCollector
+        end
+
+        collector = collector_class.new(user, preference.digest_type, organization)
+        items = collector.collect_items
+
+        # Trigger if there are any items (1 or more)
+        if items.any?
+          Workers::DigestProcessorWorker.perform_async(
+            preference.id.to_s,
+            items.map(&:id).map(&:to_s)
+          )
+        else
+          # No items, but update the schedule
+          preference.update_last_sent
+        end
+      rescue StandardError => e
+        Rails.logger.error("EmailDigest: Error processing preference #{preference.id}: #{e.message}")
+        Rails.logger.error(e.backtrace.join("\n"))
+        Airbrake.notify(e) if defined?(Airbrake)
+      end
+    end
+  end
+end

data/lib/email_digest/services/digest_summarizer.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+module EmailDigest
+  module Services
+    class DigestSummarizer
+      attr_reader :items, :digest_type
+
+      def initialize(items, digest_type)
+        @items = items
+        @digest_type = digest_type.to_sym
+      end
+
+      def summarize
+        return empty_summary if items.empty?
+        return single_item_summary if items.size == 1
+        return grouped_summary if should_group?
+        return priority_summary if has_high_priority_items?
+
+        default_summary
+      end
+
+      private
+
+      def empty_summary
+        {
+          subject: "Your #{digest_type.to_s.humanize} Digest",
+          summary: "No new notifications.",
+          items: [],
+          grouped_items: {},
+          total_count: 0
+        }
+      end
+
+      def single_item_summary
+        item = items.first
+        item_hash = enrich_item_hash(item_to_hash(item), item)
+        {
+          subject: item.subject || "New #{item.notification_type.humanize}",
+          summary: item.body,
+          items: [item_hash],
+          grouped_items: { item.notification_type => [item_hash] },
+          total_count: 1
+        }
+      end
+
+      def should_group?
+        items.size > 3 && items.map(&:notification_type).uniq.size < items.size
+      end
+
+      def grouped_summary
+        grouped = items.group_by(&:notification_type)
+        notification_counts = grouped.map { |type, items| "#{items.size} #{type.humanize.pluralize(items.size)}" }
+        items_hash = items.map { |item| enrich_item_hash(item_to_hash(item), item) }
+        grouped_hash = grouped.transform_values { |items| items.map { |item| enrich_item_hash(item_to_hash(item), item) } }
+
+        {
+          subject: "Your #{digest_type.to_s.humanize} Digest - #{items.size} New Items",
+          summary: "You have #{items.size} new notifications: #{notification_counts.join(', ')}.",
+          items: items_hash,
+          grouped_items: grouped_hash,
+          total_count: items.size,
+          grouped: true
+        }
+      end
+
+      def has_high_priority_items?
+        items.any? { |item| item.priority > 5 }
+      end
+
+      def priority_summary
+        high_priority = items.select { |item| item.priority > 5 }
+        regular = items.reject { |item| item.priority > 5 }
+
+        summary_parts = []
+        summary_parts << "#{high_priority.size} high priority notification#{'s' if high_priority.size != 1}" if high_priority.any?
+        summary_parts << "#{regular.size} other notification#{'s' if regular.size != 1}" if regular.any?
+
+        {
+          subject: "Your #{digest_type.to_s.humanize} Digest - #{items.size} New Items",
+          summary: summary_parts.join(' and ') + ".",
+          items: items.map { |item| enrich_item_hash(item_to_hash(item), item) },
+          grouped_items: {
+            high_priority: high_priority.map { |item| enrich_item_hash(item_to_hash(item), item) },
+            regular: regular.map { |item| enrich_item_hash(item_to_hash(item), item) }
+          },
+          total_count: items.size,
+          priority_based: true
+        }
+      end
+
+      def default_summary
+        items_hash = items.map { |item| enrich_item_hash(item_to_hash(item), item) }
+        {
+          subject: "Your #{digest_type.to_s.humanize} Digest - #{items.size} New Items",
+          summary: "You have #{items.size} new notification#{'s' if items.size != 1}.",
+          items: items_hash,
+          grouped_items: { all: items_hash },
+          total_count: items.size
+        }
+      end
+
+      def item_to_hash(item)
+        {
+          id: item.id.to_s,
+          notification_type: item.notification_type,
+          subject: item.subject,
+          body: item.body,
+          metadata: item.metadata || {},
+          source_id: item.source_id,
+          source_type: item.source_type,
+          priority: item.priority,
+          created_at: item.created_at
+        }
+      end
+
+      # Override this method in custom summarizers to include additional context
+      # This method is called for each item and can be extended to include
+      # course, section, groupTemplate, group, or any other metadata
+      # 
+      # Example:
+      #   def enrich_item_hash(item_hash, item)
+      #     item_hash.merge(
+      #       course: load_course_from_metadata(item.metadata),
+      #       section: load_section_from_metadata(item.metadata),
+      #       group_template: load_group_template_from_metadata(item.metadata)
+      #     )
+      #   end
+      def enrich_item_hash(item_hash, item)
+        # Base implementation returns item_hash as-is
+        # Override in custom summarizers to add additional fields
+        item_hash
+      end
+    end
+  end
+end

data/lib/email_digest/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module EmailDigest
+  VERSION = '1.0.0'
+end

data/lib/email_digest/workers/digest_processor_worker.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module EmailDigest
+  module Workers
+    class DigestProcessorWorker
+      include Sidekiq::Worker
+
+      sidekiq_options retry: 3, queue: :email_digest
+
+      def perform(preference_id, item_ids)
+        preference = Models::DigestPreference.find(preference_id)
+        return unless preference&.enabled
+
+        # Get user and organization from MongoDB
+        user_class = EmailDigest.configuration.user_class.constantize
+        user = user_class.find(preference.user_id)
+        return unless user
+
+        org_class = EmailDigest.configuration.organization_class.constantize
+        organization = org_class.find(preference.organization_id)
+        return unless organization
+
+        # Scope queries by organization_id (replaces Mongoid multitenancy)
+        items = Models::DigestItem.where(id: item_ids)
+                                  .where(organization_id: organization.id.to_s)
+                                  .where(processed: false)
+        return if items.empty?
+
+        # Convert to array for summarizer
+        items_array = items.to_a
+
+        # Use custom summarizer if configured, otherwise use default
+        digest_config = EmailDigest.configuration.digest_types[preference.digest_type.to_sym]
+        summarizer_class = if digest_config&.dig(:summarizer)
+          digest_config[:summarizer].constantize
+        else
+          Services::DigestSummarizer
+        end
+
+        # Summarize items
+        summarizer = summarizer_class.new(items_array, preference.digest_type)
+        summary = summarizer.summarize
+
+        # Enqueue email sending
+        Workers::DigestSenderWorker.perform_async(
+          preference.id.to_s,
+          summary.to_json
+        )
+
+        # Mark items as processed atomically to prevent race conditions
+        Models::DigestItem.where(id: item_ids, processed: false, organization_id: organization.id.to_s)
+                          .update_all(processed: true, processed_at: Time.current)
+
+        # Update preference
+        preference.update_last_sent
+      rescue StandardError => e
+        Rails.logger.error("EmailDigest: Error processing digest #{preference_id}: #{e.message}")
+        Rails.logger.error(e.backtrace.join("\n"))
+        Airbrake.notify(e) if defined?(Airbrake)
+        raise
+      end
+    end
+  end
+end

data/lib/email_digest/workers/digest_scheduler_worker.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module EmailDigest
+  module Workers
+    class DigestSchedulerWorker
+      include Sidekiq::Worker
+
+      sidekiq_options retry: 2, queue: :email_digest
+
+      def perform(organization_id = nil)
+        organization = if organization_id
+          org_class = EmailDigest.configuration.organization_class.constantize
+          org_class.find(organization_id)
+        else
+          nil
+        end
+        Services::DigestScheduler.process_all_ready(organization)
+      rescue StandardError => e
+        Rails.logger.error("EmailDigest: Error in scheduler worker: #{e.message}")
+        Rails.logger.error(e.backtrace.join("\n"))
+        Airbrake.notify(e) if defined?(Airbrake)
+        raise
+      end
+    end
+  end
+end

data/lib/email_digest/workers/digest_sender_worker.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module EmailDigest
+  module Workers
+    class DigestSenderWorker
+      include Sidekiq::Worker
+
+      sidekiq_options retry: 2, queue: :email_digest
+
+      def perform(preference_id, summary_json)
+        preference = Models::DigestPreference.find(preference_id)
+        return unless preference
+
+        # Get user and organization from MongoDB
+        user_class = EmailDigest.configuration.user_class.constantize
+        user = user_class.find(preference.user_id)
+        return unless user
+
+        org_class = EmailDigest.configuration.organization_class.constantize
+        organization = org_class.find(preference.organization_id)
+        return unless organization
+
+        summary = JSON.parse(summary_json).with_indifferent_access
+        mailer_class = EmailDigest.configuration.mailer_class.constantize
+
+        # Get digest type specific mailer method or use default
+        digest_config = EmailDigest.configuration.digest_types[preference.digest_type.to_sym]
+        mailer_method = digest_config&.dig(:mailer_method) || 
+                       EmailDigest.configuration.mailer_method
+
+        # Send email
+        mailer_class.send(
+          mailer_method,
+          user,
+          summary,
+          preference.digest_type
+        ).deliver
+
+        Rails.logger.info("EmailDigest: Sent digest to user #{user.id} for type #{preference.digest_type}")
+      rescue StandardError => e
+        Rails.logger.error("EmailDigest: Error sending digest #{preference_id}: #{e.message}")
+        Rails.logger.error(e.backtrace.join("\n"))
+        Airbrake.notify(e) if defined?(Airbrake)
+        raise
+      end
+    end
+  end
+end

data/lib/email_digest.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'active_record'
+require 'sidekiq'
+require 'sidekiq-cron'
+
+require_relative 'email_digest/version'
+require_relative 'email_digest/configuration'
+require_relative 'email_digest/models/digest_preference'
+require_relative 'email_digest/models/digest_item'
+require_relative 'email_digest/services/digest_collector'
+require_relative 'email_digest/services/digest_summarizer'
+require_relative 'email_digest/services/digest_scheduler'
+require_relative 'email_digest/workers/digest_processor_worker'
+require_relative 'email_digest/workers/digest_sender_worker'
+require_relative 'email_digest/workers/digest_scheduler_worker'
+require_relative 'email_digest/concerns/digestable'
+
+# Load generators if Rails is available
+if defined?(Rails)
+  require 'email_digest/railtie'
+end
+
+module EmailDigest
+  class << self
+    attr_accessor :configuration
+
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration) if block_given?
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+  end
+end

metadata

@@ -0,0 +1,241 @@
+--- !ruby/object:Gem::Specification
+name: email_digest
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Rohit sharma
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2026-01-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: sidekiq-cron
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+description: |
+  EmailDigest is a comprehensive email digest system that allows you to collect,
+  summarize, and send batched email notifications to users. It supports multiple
+  digest types, customizable schedules, priority-based processing, and multi-tenant
+  architectures. Built with PostgreSQL and Sidekiq for reliability and scalability.
+email:
+- rohitsharma170801@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".vscode/settings.json"
+- ANSWERS_TO_YOUR_QUESTIONS.md
+- CHANGELOG.md
+- COMPLETE_SETUP_INSTRUCTIONS.md
+- CUSTOMIZATION_GUIDE.md
+- FAQ.md
+- LICENSE.txt
+- QUICK_START.md
+- README.md
+- REPOSITORY_READY.md
+- RUBYGEMS_PUBLISHING.md
+- SETUP_SEPARATE_GEM_REPO.md
+- email_digest.gemspec
+- lib/email_digest.rb
+- lib/email_digest/concerns/digestable.rb
+- lib/email_digest/configuration.rb
+- lib/email_digest/generators/email_digest/install/install_generator.rb
+- lib/email_digest/generators/email_digest/install/templates/README
+- lib/email_digest/generators/email_digest/install/templates/create_email_digest_tables.rb
+- lib/email_digest/generators/email_digest/install/templates/email_digest.rb
+- lib/email_digest/models/digest_item.rb
+- lib/email_digest/models/digest_preference.rb
+- lib/email_digest/railtie.rb
+- lib/email_digest/services/digest_collector.rb
+- lib/email_digest/services/digest_scheduler.rb
+- lib/email_digest/services/digest_summarizer.rb
+- lib/email_digest/version.rb
+- lib/email_digest/workers/digest_processor_worker.rb
+- lib/email_digest/workers/digest_scheduler_worker.rb
+- lib/email_digest/workers/digest_sender_worker.rb
+homepage: https://github.com/rohitsharma170801/email_digest
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/rohitsharma170801/email_digest
+  source_code_uri: https://github.com/rohitsharma170801/email_digest
+  changelog_uri: https://github.com/rohitsharma170801/email_digest/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: A flexible, production-ready email digest system for Rails applications
+test_files: []