email_digest 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e5ba6e19b8f7962fc7f96d1623e403bbff8b9e60957a209c50fc873eb4f391ca
+  data.tar.gz: e5a6f65646956c66671bdba5c454e250806a520d62912bf21c1bcf38309aeff3
+SHA512:
+  metadata.gz: 55f42707c03303f309ed0850f0417237e155a5ce74eb7729775cc4c88bb289c3003d730e36515cdc1195cc9ca238f9c13a64f85f3d9ab1e8565c88959833eb17
+  data.tar.gz: c5316893ee2b57debaf88311305a095b769006872c1981f979187d9663935565db056b221af9a32f3d6dbafda58bc0ff2112bb30ee120c220262f37d1b55ac6a

data/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "snyk.advanced.autoSelectOrganization": true
+}

data/ANSWERS_TO_YOUR_QUESTIONS.md

@@ -0,0 +1,361 @@
+# Answers to Your Questions
+
+## Q1: Will it trigger if only 1 digest_item is present?
+
+**✅ YES!** The system triggers if there are **any items** (1 or more).
+
+Looking at `digest_scheduler.rb` line 39:
+```ruby
+if items.any?  # This means 1 or more items will trigger
+  Workers::DigestProcessorWorker.perform_async(...)
+end
+```
+
+**Answer:** Even a single digest item will trigger processing and email sending.
+
+---
+
+## Q2: What context is being sent to users in mail? Can I customize it per digest_type?
+
+**Current Context:**
+The `DigestSummarizer` creates a summary hash with:
+- `subject` - Email subject line
+- `summary` - Summary text
+- `items` - Array of all items
+- `grouped_items` - Items grouped by notification_type
+- `total_count` - Total number of items
+
+Each item includes:
+- `id`, `notification_type`, `subject`, `body`
+- `metadata` - JSONB field (can store anything)
+- `source_id`, `source_type`, `priority`, `created_at`
+
+**✅ YES, you can customize it per digest_type at your code level!**
+
+**Solution:** Create custom summarizer classes in your application:
+
+```ruby
+# app/services/email_digest/summarizers/time_log_summarizer.rb
+module EmailDigest
+  module Summarizers
+    class TimeLogSummarizer < EmailDigest::Services::DigestSummarizer
+      # Override methods to customize the summary
+      def single_item_summary
+        item = items.first
+        item_hash = enrich_item_hash(item_to_hash(item), item)
+        
+        {
+          subject: "Custom Subject: #{item.subject}",
+          summary: "Custom summary text",
+          items: [item_hash],
+          grouped_items: { item.notification_type => [item_hash] },
+          total_count: 1,
+          # Add your custom fields here
+          custom_context: {
+            course: item_hash[:course],
+            section: item_hash[:section]
+          }
+        }
+      end
+
+      def enrich_item_hash(item_hash, item)
+        metadata = item.metadata || {}
+        item_hash.merge(
+          course: load_course(metadata['course_id']),
+          section: load_section(metadata['section_id']),
+          group_template: load_group_template(metadata['group_template_id']),
+          group: load_group(metadata['group_id'])
+        )
+      end
+
+      private
+
+      def load_course(course_id)
+        return nil unless course_id
+        Course.find(course_id) rescue nil
+      end
+      # ... other load methods
+    end
+  end
+end
+```
+
+Then register it:
+```ruby
+# config/initializers/email_digest.rb
+EmailDigest.configure do |config|
+  config.register_digest_type(:time_log_notifications, {
+    mailer_method: 'time_log_digest_email',
+    summarizer: 'EmailDigest::Summarizers::TimeLogSummarizer'  # Your custom class
+  })
+end
+```
+
+---
+
+## Q3: How are different digest_types, users, and organizations combined? What runs at 15 mins?
+
+**How it works:**
+
+1. **Every 15 minutes**, `DigestSchedulerWorker` runs (configured in `sidekiq_cron_schedule.yml`)
+
+2. It calls `DigestScheduler.process_all_ready(organization)` which:
+   - Finds all `DigestPreference` records where:
+     - `next_send_at <= now`
+     - `enabled = true`
+     - Optionally filtered by `organization_id`
+
+3. **Each preference is unique per `(user_id, digest_type, organization_id)`**
+
+4. For each preference:
+   - Uses `DigestCollector` to gather pending items for that specific user+digest_type+organization
+   - If items exist (1+), processes them together
+   - Sends **one email per preference**
+
+**Important:** Items are **NOT combined** across:
+- Different digest_types
+- Different users
+- Different organizations
+
+**Example:**
+- User A with `time_log_notifications` → Gets one email
+- User A with `mentor_supervisor_notifications` → Gets a separate email
+- User B with `time_log_notifications` → Gets a separate email
+
+---
+
+## Q4: How to store additional information (course, section, groupTemplate, group) in digest_item?
+
+**✅ Use the `metadata` field (JSONB)!**
+
+The `metadata` field can store any additional context you need:
+
+```ruby
+# When creating digest items
+EmailDigest::Models::DigestItem.create_for_user(
+  user,
+  :time_log_notifications,
+  :submission_received,
+  subject: "New Time Log Submission",
+  body: "A new time log has been submitted.",
+  metadata: {
+    course_id: course.id.to_s,
+    course_name: course.name,
+    section_id: section.id.to_s,
+    section_name: section.name,
+    group_template_id: group_template.id.to_s,
+    group_template_name: group_template.name,
+    group_id: group.id.to_s,
+    group_name: group.name,
+    student_name: student.name,
+    # ... any other data you need
+  }
+)
+```
+
+**Then in your custom summarizer**, access and enrich this data:
+
+```ruby
+def enrich_item_hash(item_hash, item)
+  metadata = item.metadata || {}
+  item_hash.merge(
+    course: {
+      id: metadata['course_id'],
+      name: metadata['course_name']
+    },
+    section: {
+      id: metadata['section_id'],
+      name: metadata['section_name']
+    },
+    group_template: {
+      id: metadata['group_template_id'],
+      name: metadata['group_template_name']
+    },
+    group: {
+      id: metadata['group_id'],
+      name: metadata['group_name']
+    }
+  )
+end
+```
+
+**Or load full objects:**
+
+```ruby
+def enrich_item_hash(item_hash, item)
+  metadata = item.metadata || {}
+  item_hash.merge(
+    course: load_course(metadata['course_id']),
+    section: load_section(metadata['section_id']),
+    group_template: load_group_template(metadata['group_template_id']),
+    group: load_group(metadata['group_id'])
+  )
+end
+
+private
+
+def load_course(course_id)
+  return nil unless course_id
+  Course.find(course_id) rescue nil
+end
+```
+
+---
+
+## Complete Example: Time Log Digest with Course/Section Context
+
+### 1. Create Digest Item with Metadata
+
+```ruby
+# In your application code
+time_log.add_to_digest(
+  instructor,
+  :submission_received,
+  subject: "New Time Log Submission",
+  body: "A new time log has been submitted for review.",
+  priority: 5,
+  metadata: {
+    course_id: time_log.course.id.to_s,
+    course_name: time_log.course.name,
+    section_id: time_log.section.id.to_s,
+    section_name: time_log.section.name,
+    group_template_id: time_log.group_template&.id&.to_s,
+    group_id: time_log.group.id.to_s,
+    group_name: time_log.group.name,
+    student_id: time_log.student.id.to_s,
+    student_name: time_log.student.name
+  }
+)
+```
+
+### 2. Create Custom Summarizer
+
+```ruby
+# app/services/email_digest/summarizers/time_log_summarizer.rb
+module EmailDigest
+  module Summarizers
+    class TimeLogSummarizer < EmailDigest::Services::DigestSummarizer
+      def enrich_item_hash(item_hash, item)
+        metadata = item.metadata || {}
+        
+        # Load full objects from metadata
+        item_hash.merge(
+          course: load_course(metadata['course_id']),
+          section: load_section(metadata['section_id']),
+          group_template: load_group_template(metadata['group_template_id']),
+          group: load_group(metadata['group_id']),
+          student: load_student(metadata['student_id']),
+          # Include metadata for easy access
+          course_name: metadata['course_name'],
+          section_name: metadata['section_name'],
+          group_name: metadata['group_name'],
+          student_name: metadata['student_name']
+        )
+      end
+
+      def grouped_summary
+        grouped = items.group_by do |item|
+          # Group by course and section
+          metadata = item.metadata || {}
+          "#{metadata['course_name']} - #{metadata['section_name']}"
+        end
+        
+        items_hash = items.map { |item| enrich_item_hash(item_to_hash(item), item) }
+        grouped_hash = grouped.transform_values do |items|
+          items.map { |item| enrich_item_hash(item_to_hash(item), item) }
+        end
+
+        {
+          subject: "Time Log Notifications - #{items.size} New Submissions",
+          summary: "You have #{items.size} new time log submissions across #{grouped.size} courses.",
+          items: items_hash,
+          grouped_items: grouped_hash,
+          total_count: items.size,
+          grouped: true
+        }
+      end
+
+      private
+
+      def load_course(course_id)
+        return nil unless course_id
+        Course.find(course_id) rescue nil
+      end
+
+      def load_section(section_id)
+        return nil unless section_id
+        Section.find(section_id) rescue nil
+      end
+
+      def load_group_template(group_template_id)
+        return nil unless group_template_id
+        GroupTemplate.find(group_template_id) rescue nil
+      end
+
+      def load_group(group_id)
+        return nil unless group_id
+        Group.find(group_id) rescue nil
+      end
+
+      def load_student(student_id)
+        return nil unless student_id
+        Student.find(student_id) rescue nil
+      end
+    end
+  end
+end
+```
+
+### 3. Register Custom Summarizer
+
+```ruby
+# config/initializers/email_digest.rb
+EmailDigest.configure do |config|
+  config.register_digest_type(:time_log_notifications, {
+    mailer_method: 'time_log_digest_email',
+    summarizer: 'EmailDigest::Summarizers::TimeLogSummarizer'
+  })
+end
+```
+
+### 4. Use in Mailer Template
+
+```erb
+<!-- app/views/user_mailer/time_log_digest_email.html.erb -->
+<% @summary[:grouped_items].each do |group_key, items| %>
+  <h2><%= group_key %></h2>
+  <% items.each do |item| %>
+    <div>
+      <h3><%= item[:subject] %></h3>
+      <p><%= item[:body] %></p>
+      
+      <% if item[:course_name] %>
+        <p><strong>Course:</strong> <%= item[:course_name] %></p>
+      <% end %>
+      
+      <% if item[:section_name] %>
+        <p><strong>Section:</strong> <%= item[:section_name] %></p>
+      <% end %>
+      
+      <% if item[:group_name] %>
+        <p><strong>Group:</strong> <%= item[:group_name] %></p>
+      <% end %>
+      
+      <% if item[:student_name] %>
+        <p><strong>Student:</strong> <%= item[:student_name] %></p>
+      <% end %>
+    </div>
+  <% end %>
+<% end %>
+```
+
+---
+
+## Summary
+
+✅ **Q1:** Yes, triggers with 1+ items  
+✅ **Q2:** Customizable per digest_type via custom summarizers in your app  
+✅ **Q3:** Each email is for one user + one digest_type + one organization, processed every 15 mins  
+✅ **Q4:** Store additional info in `metadata` JSONB field, enrich in custom summarizer  
+
+See `CUSTOMIZATION_GUIDE.md` for more detailed examples!

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [1.0.0] - 2025-01-27
+
+### Added
+- Initial release
+- PostgreSQL backend
+- Sidekiq integration
+- Multi-tenant support
+- Flexible scheduling
+- Priority-based processing
+- Smart summarization

data/COMPLETE_SETUP_INSTRUCTIONS.md

@@ -0,0 +1,298 @@
+# Complete Setup Instructions for EmailDigest Gem
+
+## Overview
+
+This guide will help you create a completely separate gem repository that you can:
+1. Use in your application via Gemfile
+2. Publish to RubyGems for others to use
+3. Maintain independently from your main application
+
+## Step-by-Step Instructions
+
+### Step 1: Create New Repository Directory
+
+```bash
+# Navigate to a location outside your main app
+cd ~/workspace  # or ~/projects, or wherever you prefer
+
+# Create new directory
+mkdir email_digest
+cd email_digest
+
+# Initialize git
+git init
+```
+
+### Step 2: Copy All Gem Files
+
+```bash
+# Copy everything from gem_package
+cp -r /Users/rosharma/workspace/sll-la/eportfolio/gem_package/* ~/workspace/email_digest/
+
+# Verify files are copied
+ls -la
+# You should see: email_digest.gemspec, lib/, README.md, etc.
+```
+
+### Step 3: Update Gemspec Metadata
+
+Edit `email_digest.gemspec`:
+
+```ruby
+spec.authors       = ['Your Name']  # Change this
+spec.email         = ['your.email@example.com']  # Change this
+spec.homepage      = 'https://github.com/yourusername/email_digest'  # Change this
+spec.metadata['source_code_uri'] = 'https://github.com/yourusername/email_digest'  # Change this
+```
+
+### Step 4: Create GitHub Repository
+
+#### Option A: Via GitHub Web Interface
+
+1. Go to https://github.com/new
+2. Repository name: `email_digest`
+3. Description: "A flexible email digest system for Rails"
+4. Choose Public or Private
+5. Don't initialize with README (you already have one)
+6. Click "Create repository"
+
+#### Option B: Via GitHub CLI
+
+```bash
+gh repo create email_digest --public --description "A flexible email digest system for Rails"
+```
+
+### Step 5: Connect and Push to GitHub
+
+```bash
+# Add remote
+git remote add origin https://github.com/yourusername/email_digest.git
+
+# Add all files
+git add .
+
+# Initial commit
+git commit -m "Initial commit: EmailDigest gem v1.0.0"
+
+# Push to GitHub
+git branch -M main
+git push -u origin main
+```
+
+### Step 6: Test the Gem Locally
+
+```bash
+# Build the gem
+gem build email_digest.gemspec
+
+# This creates: email_digest-1.0.0.gem
+
+# Test installation
+gem install ./email_digest-1.0.0.gem
+
+# Or test in your app
+# In your app's Gemfile, add:
+# gem 'email_digest', path: '../email_digest'
+# Then: bundle install
+```
+
+### Step 7: Publish to RubyGems
+
+#### 7a. Create RubyGems Account
+
+1. Go to https://rubygems.org
+2. Click "Sign up"
+3. Fill in your details
+4. Verify your email
+
+#### 7b. Get API Key
+
+1. Go to https://rubygems.org/profile/edit
+2. Scroll to "API Access"
+3. Click "Add a new API key"
+4. Give it a name (e.g., "laptop")
+5. Copy the key (you'll use it once)
+
+#### 7c. Configure Credentials
+
+```bash
+# Option 1: Use gem signin
+gem signin
+# Enter your RubyGems username and password
+
+# Option 2: Manual setup
+# Create ~/.gem/credentials with:
+# ---
+# :rubygems_api_key: YOUR_API_KEY_HERE
+```
+
+#### 7d. Publish
+
+```bash
+# Make sure you've built the gem
+gem build email_digest.gemspec
+
+# Push to RubyGems
+gem push email_digest-1.0.0.gem
+
+# You should see:
+# Pushing gem to https://rubygems.org...
+# Successfully registered gem: email_digest
+```
+
+#### 7e. Verify
+
+```bash
+# Check on RubyGems
+open https://rubygems.org/gems/email_digest
+
+# Or via command line
+gem search email_digest
+gem info email_digest
+```
+
+### Step 8: Use in Your Application
+
+In your main app's `Gemfile`:
+
+```ruby
+# From RubyGems (recommended)
+gem 'email_digest'
+
+# Or from GitHub (for development)
+gem 'email_digest', git: 'https://github.com/yourusername/email_digest.git'
+
+# Or local path (for local development)
+gem 'email_digest', path: '../email_digest'
+```
+
+Then in your app:
+
+```bash
+bundle install
+rails generate email_digest:install
+rails db:migrate
+```
+
+## File Structure
+
+Your gem repository should have:
+
+```
+email_digest/
+├── .gitignore
+├── .github/
+│   └── workflows/
+│       └── ci.yml
+├── email_digest.gemspec
+├── README.md
+├── LICENSE.txt
+├── CHANGELOG.md
+├── RUBYGEMS_PUBLISHING.md
+└── lib/
+    ├── email_digest.rb
+    └── email_digest/
+        ├── version.rb
+        ├── configuration.rb
+        ├── railtie.rb
+        ├── models/
+        │   ├── digest_item.rb
+        │   └── digest_preference.rb
+        ├── services/
+        │   ├── digest_collector.rb
+        │   ├── digest_summarizer.rb
+        │   └── digest_scheduler.rb
+        ├── workers/
+        │   ├── digest_processor_worker.rb
+        │   ├── digest_sender_worker.rb
+        │   └── digest_scheduler_worker.rb
+        ├── concerns/
+        │   └── digestable.rb
+        └── generators/
+            └── email_digest/
+                └── install/
+                    ├── install_generator.rb
+                    └── templates/
+                        ├── email_digest.rb
+                        ├── create_email_digest_tables.rb
+                        └── README
+```
+
+## Updating the Gem
+
+When you make changes:
+
+```bash
+# 1. Update version in lib/email_digest/version.rb
+# 2. Update CHANGELOG.md
+# 3. Commit changes
+git add .
+git commit -m "Update: [description]"
+git push
+
+# 4. Tag the release
+git tag -a v1.0.1 -m "Version 1.0.1"
+git push origin v1.0.1
+
+# 5. Build and publish
+gem build email_digest.gemspec
+gem push email_digest-1.0.1.gem
+```
+
+## Quick Reference
+
+### Local Development
+
+```bash
+# In your app's Gemfile
+gem 'email_digest', path: '../email_digest'
+bundle install
+```
+
+### From GitHub
+
+```bash
+# In your app's Gemfile
+gem 'email_digest', git: 'https://github.com/yourusername/email_digest.git'
+bundle install
+```
+
+### From RubyGems
+
+```bash
+# In your app's Gemfile
+gem 'email_digest'
+bundle install
+```
+
+## Troubleshooting
+
+### "Could not find gem"
+
+- Make sure the path is correct
+- Run `bundle install` again
+- Check `bundle show email_digest` to verify location
+
+### "Generator not found"
+
+- Make sure you ran `bundle install`
+- Check that the gem is in your Gemfile
+- Verify the gem path is correct
+
+### "Table already exists"
+
+- You might have run the migration manually
+- Check your database for `email_digest_items` and `email_digest_preferences` tables
+
+## Next Steps
+
+1. ✅ Create separate repo (done via this guide)
+2. ✅ Publish to RubyGems (follow Step 7)
+3. ✅ Use in your app (follow Step 8)
+4. ✅ Share with others (they can use `gem 'email_digest'`)
+
+## Support
+
+- See `RUBYGEMS_PUBLISHING.md` for detailed publishing guide
+- See `README.md` for usage documentation
+- Check GitHub Issues for known problems