activity_notification 2.3.2 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3756e6a1dde16b628911625689f64a6514c7c43f42964453dcb04511f5cc6d5b
-  data.tar.gz: 1964bd54d6a1521f8224bbc4dcc27fbefcf2bd9ca95090e45dfbbc2d2f38bba6
+  metadata.gz: 0f81f1308188c8ac3e07332a40b1fab62c5af3a43dbbe135a71303e31d403285
+  data.tar.gz: db55d9f9811dcceecd1f562feaf33949faf716ce6ab07e45f0f35b077b032923
 SHA512:
-  metadata.gz: 92289fad6ce9f245663fa01b2335a486e3cde53c9e50ec2be2161fc1fefbe2953898530fa7a1c94522adc60f7e523ccea1bc1bce14808c9ae6bb2ca9cc750302
-  data.tar.gz: dca9ddbd8d069b44848266a51346355fe382008b0deb61085903b334c39404935cff93a7a3118dd52ba9f89aa09e176f7beeba358ee4b4dd3fa5763dcd96c0d2
+  metadata.gz: b4287ae97e4d9f3f3788a5d0fc36b9eb9837880d1ed4289a2e881d32e8a61baecfcd9dc1f9f8e0846214a87fdd4a808e042a3ae77a283a2eb5d4d4bffa4f6411
+  data.tar.gz: 2be55085563ca99a32c029bcc5ecf5e3a025d42a72326ef0f40f218f123af478d2adf760bf5cb51a142a6e326d0bf6c33374c9116e2cd39f0d1b248d3e69b5bd

data/.github/workflows/build.yml

@@ -17,63 +17,36 @@ jobs:
       fail-fast: false
       matrix:
         gemfile:
-          - gemfiles/Gemfile.rails-5.0
-          - gemfiles/Gemfile.rails-5.1
-          - gemfiles/Gemfile.rails-5.2
-          - gemfiles/Gemfile.rails-6.0
-          - gemfiles/Gemfile.rails-6.1
           - gemfiles/Gemfile.rails-7.0
           - gemfiles/Gemfile.rails-7.1
           - gemfiles/Gemfile.rails-7.2
+          - gemfiles/Gemfile.rails-8.0
         orm:
           - active_record
           - mongoid
           - dynamoid
         include:
           # https://www.ruby-lang.org/en/downloads
-          - gemfile: gemfiles/Gemfile.rails-5.0
-            ruby-version: 2.7.7
-          - gemfile: gemfiles/Gemfile.rails-5.1
-            ruby-version: 2.7.7
-          - gemfile: gemfiles/Gemfile.rails-5.2
-            ruby-version: 2.7.7
-          - gemfile: gemfiles/Gemfile.rails-6.0
-            ruby-version: 2.7.7
-          - gemfile: gemfiles/Gemfile.rails-6.1
-            ruby-version: 2.7.7
           - gemfile: gemfiles/Gemfile.rails-7.0
-            ruby-version: 3.1.6
+            ruby-version: 3.2.9
           - gemfile: gemfiles/Gemfile.rails-7.1
-            ruby-version: 3.2.4
+            ruby-version: 3.2.9
           - gemfile: gemfiles/Gemfile.rails-7.2
-            ruby-version: 3.3.4
+            ruby-version: 3.3.9
+          - gemfile: gemfiles/Gemfile.rails-8.0
+            ruby-version: 3.4.5
           - gemfile: Gemfile
-            ruby-version: 3.3.3
+            ruby-version: 3.4.5
             orm: active_record
             test-db: mysql
           - gemfile: Gemfile
-            ruby-version: 3.3.3
+            ruby-version: 3.4.5
             orm: active_record
             test-db: postgresql
           - gemfile: Gemfile
-            ruby-version: 3.3.3
+            ruby-version: 3.4.5
             orm: mongoid
             test-db: mongodb
-          - gemfile: Gemfile
-            ruby-version: head
-            orm: active_record
-            allow_failures: 'true'
-        exclude:
-          - gemfile: gemfiles/Gemfile.rails-6.0
-            orm: dynamoid
-          - gemfile: gemfiles/Gemfile.rails-6.1
-            orm: dynamoid
-          - gemfile: gemfiles/Gemfile.rails-7.0
-            orm: dynamoid
-          - gemfile: gemfiles/Gemfile.rails-7.1
-            orm: dynamoid
-          - gemfile: gemfiles/Gemfile.rails-7.2
-            orm: dynamoid
 
     env:
       RAILS_ENV: test

data/CHANGELOG.md

@@ -1,5 +1,30 @@
+## 2.4.0 / 2025-08-20
+[Full Changelog](http://github.com/simukappu/activity_notification/compare/v2.3.3...v2.4.0)
+
+Enhancements:
+
+* Support for Mongoid v9 - [#189](https://github.com/simukappu/activity_notification/issues/189)
+* Support for Dynamoid v3.11.0+ (upgraded from v3.1.0) - [#188](https://github.com/simukappu/activity_notification/issues/188)
+* Add bulk destroy notifications API - [#172](https://github.com/simukappu/activity_notification/issues/172)
+* Add ids parameter to open_all notifications API - [#172](https://github.com/simukappu/activity_notification/issues/172)
+* Add skip_validation option to open! method for notification handling - [#186](https://github.com/simukappu/activity_notification/issues/186) [#187](https://github.com/simukappu/activity_notification/pull/187)
+* Add exception handling to Mailer jobs for missing notification - [#50](https://github.com/simukappu/activity_notification/issues/50)
+
+Dependency:
+
+* Remove support for Rails 5 and 6
+* Update Mongoid dependency from development to runtime dependency - [#189](https://github.com/simukappu/activity_notification/issues/189)
+* Update Dynamoid dependency from development to runtime dependency - [#188](https://github.com/simukappu/activity_notification/issues/188)
+
+## 2.3.3 / 2025-01-13
+[Full Changelog](http://github.com/simukappu/activity_notification/compare/v2.3.2...v2.3.3)
+
+Enhancements:
+
+* Allow use with Rails 8.0 - [#182](https://github.com/simukappu/activity_notification/pull/182) [#183](https://github.com/simukappu/activity_notification/issues/183)
+
 ## 2.3.2 / 2024-09-23
-[Full Changelog](http://github.com/simukappu/activity_notification/compare/v2.3.0...v2.3.1)
+[Full Changelog](http://github.com/simukappu/activity_notification/compare/v2.3.1...v2.3.2)
 
 Enhancements:
 

data/Gemfile

@@ -2,7 +2,7 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem 'rails', '~> 7.1.0'
+gem 'rails', '~> 8.0.0'
 
 group :production do
   gem 'sprockets-rails'

data/README.md

@@ -10,7 +10,7 @@
 
 *activity_notification* provides integrated user activity notifications for [Ruby on Rails](https://rubyonrails.org). You can easily use it to configure multiple notification targets and make activity notifications with notifiable models, like adding comments, responding etc.
 
-*activity_notification* supports Rails 5.0+ with [ActiveRecord](https://guides.rubyonrails.org/active_record_basics.html), [Mongoid](https://mongoid.org) and [Dynamoid](https://github.com/Dynamoid/dynamoid) ORM. It is tested for [MySQL](https://www.mysql.com), [PostgreSQL](https://www.postgresql.org), [SQLite3](https://www.sqlite.org) with ActiveRecord, [MongoDB](https://www.mongodb.com) with Mongoid and [Amazon DynamoDB](https://aws.amazon.com/dynamodb) with Dynamoid. If you are using Rails 4.2, use [v2.1.4](https://rubygems.org/gems/activity_notification/versions/2.1.4) or older version of *activity_notification*.
+*activity_notification* supports Rails 7.0+ with [ActiveRecord](https://guides.rubyonrails.org/active_record_basics.html), [Mongoid](https://mongoid.org) and [Dynamoid](https://github.com/Dynamoid/dynamoid) ORM. It is tested for [MySQL](https://www.mysql.com), [PostgreSQL](https://www.postgresql.org), [SQLite3](https://www.sqlite.org) with ActiveRecord, [MongoDB](https://www.mongodb.com) with Mongoid and [Amazon DynamoDB](https://aws.amazon.com/dynamodb) with Dynamoid v3.11.0+. If you are using Rails 5 or Rails 6, use [v2.3.3](https://rubygems.org/gems/activity_notification/versions/2.3.3) or older version of *activity_notification*.
 
 
 ## About
@@ -106,6 +106,8 @@ This sample application works with *activity_notification* REST API backend.
     - [Rendering notifications](/docs/Setup.md#rendering-notifications)
     - [Notification views](/docs/Setup.md#notification-views)
     - [i18n for notifications](/docs/Setup.md#i18n-for-notifications)
+    - [Managing notifications](/docs/Setup.md#managing-notifications)
+  - [Managing notifications](/docs/Setup.md#managing-notifications)
   - [Customizing controllers (optional)](/docs/Setup.md#customizing-controllers-optional)
 - [Functions](/docs/Functions.md#Functions)
   - [Email notification](/docs/Functions.md#email-notification)
@@ -284,6 +286,12 @@ See [Creating notifications](/docs/Setup.md#creating-notifications) for more det
 
 See [Displaying notifications](/docs/Setup.md#displaying-notifications) for more details.
 
+### Managing notifications
+
+*activity_notification* provides APIs to manage notifications programmatically. You can mark notifications as opened (read), filter them, and perform bulk operations.
+
+See [Managing notifications](/docs/Setup.md#managing-notifications) for more details.
+
 ### Run example Rails application
 
 Test module includes example Rails application in *[spec/rails_app](/spec/rails_app)*.

data/activity_notification.gemspec

@@ -20,19 +20,19 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.required_ruby_version = '>= 2.1.0'
 
-  s.add_dependency 'railties', '>= 5.0.0', '< 7.3'
+  s.add_dependency 'railties', '>= 7.0.0', '< 8.1'
+  s.add_dependency 'mongoid', '>= 4.0.0', '< 10.0'
+  s.add_dependency 'dynamoid', '>= 3.11.0', '< 4.0'
   s.add_dependency 'i18n', '>= 0.5.0'
   s.add_dependency 'jquery-rails', '>= 3.1.1'
   s.add_dependency 'swagger-blocks', '>= 3.0.0'
 
   s.add_development_dependency 'puma', '>= 3.12.0'
-  s.add_development_dependency 'sqlite3', '>= 1.3.13', '< 2.0'
+  s.add_development_dependency 'sqlite3', '>= 1.3.13'
   s.add_development_dependency 'mysql2', '>= 0.5.2'
   s.add_development_dependency 'pg', '>= 1.0.0'
-  s.add_development_dependency 'mongoid', '>= 4.0.0', '< 9.0'
-  s.add_development_dependency 'dynamoid', '3.1.0'
   s.add_development_dependency 'rspec-rails', '>= 3.8.0'
-  s.add_development_dependency 'factory_bot_rails', '>= 4.11.0', '< 5.0.0'
+  s.add_development_dependency 'factory_bot_rails', '>= 4.11.0'
   s.add_development_dependency 'simplecov', '~> 0'
   s.add_development_dependency 'yard', '>= 0.9.16'
   s.add_development_dependency 'yard-activesupport-concern', '>= 0.0.1'

data/ai-curated-specs/issues/172/design.md

@@ -0,0 +1,220 @@
+# Design Document: Bulk destroy notifications API
+
+## Issue Summary
+GitHub Issue [#172](https://github.com/simukappu/activity_notification/issues/172) requests the ability to delete more than one notification for a target. Currently, only single notification deletion is available through the `destroy` API. The user wants a `bulk_destroy` API or provision to create custom APIs for bulk destroying notifications.
+
+## Current State Analysis
+
+### Existing Destroy Functionality
+- **Single Destroy**: `DELETE /:target_type/:target_id/notifications/:id`
+  - Implemented in `NotificationsController#destroy`
+  - API version in `NotificationsApiController#destroy`
+  - Simply calls `@notification.destroy` on individual notification
+
+### Existing Bulk Operations Pattern
+- **Bulk Open**: `POST /:target_type/:target_id/notifications/open_all`
+  - Implemented in `NotificationsController#open_all`
+  - Uses `@target.open_all_notifications(params)` 
+  - Backend implementation in `NotificationApi#open_all_of`
+  - Uses `update_all(opened_at: opened_at)` for efficient bulk updates
+
+## Proposed Implementation
+
+### 1. Backend API Method (NotificationApi)
+**File**: `lib/activity_notification/apis/notification_api.rb`
+
+Add a new class method `destroy_all_of` following the pattern of `open_all_of`:
+
+```ruby
+# Destroys all notifications of the target matching the filter criteria.
+#
+# @param [Object] target Target of the notifications to destroy
+# @param [Hash] options Options for filtering notifications to destroy
+# @option options [String]   :filtered_by_type       (nil) Notifiable type for filter
+# @option options [Object]   :filtered_by_group      (nil) Group instance for filter  
+# @option options [String]   :filtered_by_group_type (nil) Group type for filter, valid with :filtered_by_group_id
+# @option options [String]   :filtered_by_group_id   (nil) Group instance id for filter, valid with :filtered_by_group_type
+# @option options [String]   :filtered_by_key        (nil) Key of the notification for filter
+# @option options [String]   :later_than             (nil) ISO 8601 format time to filter notifications later than specified time
+# @option options [String]   :earlier_than           (nil) ISO 8601 format time to filter notifications earlier than specified time
+# @option options [Array]    :ids                    (nil) Array of specific notification IDs to destroy
+# @return [Array<Notification>] Destroyed notification records
+def destroy_all_of(target, options = {})
+```
+
+### 2. Target Model Method
+**File**: `lib/activity_notification/models/concerns/target.rb`
+
+Add instance method `destroy_all_notifications` following the pattern of `open_all_notifications`:
+
+```ruby
+# Destroys all notifications of the target matching the filter criteria.
+#
+# @param [Hash] options Options for filtering notifications to destroy
+# @option options [String]   :filtered_by_type       (nil) Notifiable type for filter
+# @option options [Object]   :filtered_by_group      (nil) Group instance for filter
+# @option options [String]   :filtered_by_group_type (nil) Group type for filter, valid with :filtered_by_group_id
+# @option options [String]   :filtered_by_group_id   (nil) Group instance id for filter, valid with :filtered_by_group_type
+# @option options [String]   :filtered_by_key        (nil) Key of the notification for filter
+# @option options [String]   :later_than             (nil) ISO 8601 format time to filter notifications later than specified time
+# @option options [String]   :earlier_than           (nil) ISO 8601 format time to filter notifications earlier than specified time
+# @option options [Array]    :ids                    (nil) Array of specific notification IDs to destroy
+# @return [Array<Notification>] Destroyed notification records
+def destroy_all_notifications(options = {})
+```
+
+### 3. Controller Actions
+
+#### Web Controller
+**File**: `app/controllers/activity_notification/notifications_controller.rb`
+
+Add new action `destroy_all`:
+
+```ruby
+# Destroys all notifications of the target matching filter criteria.
+#
+# POST /:target_type/:target_id/notifications/destroy_all
+# @overload destroy_all(params)
+#   @param [Hash] params Request parameters
+#   @option params [String] :filter                 (nil)     Filter option to load notification index by their status (Nothing as auto, 'opened' or 'unopened')
+#   @option params [String] :limit                  (nil)     Maximum number of notifications to return
+#   @option params [String] :without_grouping       ('false') Whether notification index will include group members
+#   @option params [String] :with_group_members     ('false') Whether notification index will include group members
+#   @option params [String] :filtered_by_type       (nil)     Notifiable type to filter notifications
+#   @option params [String] :filtered_by_group_type (nil)     Group type to filter notifications, valid with :filtered_by_group_id
+#   @option params [String] :filtered_by_group_id   (nil)     Group instance ID to filter notifications, valid with :filtered_by_group_type
+#   @option params [String] :filtered_by_key        (nil)     Key of notifications to filter
+#   @option params [String] :later_than             (nil)     ISO 8601 format time to filter notifications later than specified time
+#   @option params [String] :earlier_than           (nil)     ISO 8601 format time to filter notifications earlier than specified time
+#   @option params [Array]  :ids                    (nil)     Array of specific notification IDs to destroy
+#   @option params [String] :reload                 ('true')  Whether notification index will be reloaded
+#   @return [Response] JavaScript view for ajax request or redirects to back as default
+def destroy_all
+```
+
+#### API Controller  
+**File**: `app/controllers/activity_notification/notifications_api_controller.rb`
+
+Add new action `destroy_all`:
+
+```ruby
+# Destroys all notifications of the target matching filter criteria.
+#
+# POST /:target_type/:target_id/notifications/destroy_all
+# @overload destroy_all(params)
+#   @param [Hash] params Request parameters
+#   @option params [String] :filtered_by_type       (nil) Notifiable type to filter notifications
+#   @option params [String] :filtered_by_group_type (nil) Group type to filter notifications, valid with :filtered_by_group_id
+#   @option params [String] :filtered_by_group_id   (nil) Group instance ID to filter notifications, valid with :filtered_by_group_type
+#   @option params [String] :filtered_by_key        (nil) Key of notifications to filter
+#   @option params [String] :later_than             (nil) ISO 8601 format time to filter notifications later than specified time
+#   @option params [String] :earlier_than           (nil) ISO 8601 format time to filter notifications earlier than specified time
+#   @option params [Array]  :ids                    (nil) Array of specific notification IDs to destroy
+#   @return [JSON] count: number of destroyed notification records, notifications: destroyed notifications
+def destroy_all
+```
+
+### 4. Routes Configuration
+**File**: Routes will be automatically generated by the existing `notify_to` helper
+
+The route will be: `POST /:target_type/:target_id/notifications/destroy_all`
+
+### 5. View Templates
+**Files**: 
+- `app/views/activity_notification/notifications/default/destroy_all.js.erb`
+- Template generators will need to be updated to include the new view
+
+### 6. Swagger API Documentation
+**File**: Update Swagger documentation to include the new bulk destroy endpoint
+
+### 7. Generator Templates
+**Files**: Update controller generator templates to include the new `destroy_all` action:
+- `lib/generators/templates/controllers/notifications_api_controller.rb`
+- `lib/generators/templates/controllers/notifications_controller.rb`
+- `lib/generators/templates/controllers/notifications_with_devise_controller.rb`
+
+## Implementation Details
+
+### Filter Options Support
+The bulk destroy API will support the same filtering options as the existing `open_all` functionality:
+- `filtered_by_type`: Filter by notifiable type
+- `filtered_by_group_type` + `filtered_by_group_id`: Filter by group
+- `filtered_by_key`: Filter by notification key
+- `later_than` / `earlier_than`: Filter by time range
+- `ids`: Array of specific notification IDs (new option for precise control)
+
+### Safety Considerations
+1. **Validation**: Ensure all notifications belong to the specified target
+2. **Permissions**: Leverage existing authentication/authorization patterns
+3. **Soft Delete**: Consider if soft delete should be supported (follow existing destroy pattern)
+4. **Callbacks**: Ensure any existing destroy callbacks are properly triggered
+
+### Performance Considerations
+1. **Batch Operations**: Use `destroy_all` for efficient database operations
+2. **Memory Usage**: For large datasets, consider pagination or streaming
+3. **Callbacks**: Balance between performance and callback execution
+
+### Error Handling
+1. **Partial Failures**: Handle cases where some notifications can't be destroyed
+2. **Validation Errors**: Provide meaningful error messages
+3. **Authorization Errors**: Consistent with existing error handling patterns
+
+## Testing Requirements
+
+### Unit Tests
+- Test `NotificationApi#destroy_all_of` method
+- Test `Target#destroy_all_notifications` method
+- Test controller actions for both web and API versions
+
+### Integration Tests
+- Test complete request/response cycle
+- Test with various filter combinations
+- Test error scenarios
+
+### Performance Tests
+- Test with large datasets
+- Verify efficient database queries
+
+## Migration Considerations
+- No database schema changes required
+- Backward compatible addition
+- Follows existing patterns and conventions
+
+## Documentation Updates
+- Update README.md with new bulk destroy functionality
+- Update API documentation
+- Update controller documentation
+- Add examples to documentation
+
+## Alternative Implementation Options
+
+### Option 1: Single Endpoint with Multiple IDs
+Instead of filter-based bulk destroy, accept an array of notification IDs:
+```
+POST /:target_type/:target_id/notifications/destroy_all
+Body: { "ids": [1, 2, 3, 4, 5] }
+```
+
+### Option 2: RESTful Bulk Operations
+Follow RESTful conventions with a bulk operations endpoint:
+```
+POST /:target_type/:target_id/notifications/bulk
+Body: { "action": "destroy", "filters": {...} }
+```
+
+### Option 3: Query Parameter Approach
+Use existing destroy endpoint with query parameters:
+```
+DELETE /:target_type/:target_id/notifications?ids[]=1&ids[]=2&ids[]=3
+```
+
+## Recommended Approach
+The proposed implementation follows the existing pattern established by `open_all` functionality, making it consistent with the current codebase architecture. This approach provides:
+
+1. **Consistency**: Matches existing bulk operation patterns
+2. **Flexibility**: Supports various filtering options
+3. **Safety**: Leverages existing validation and authorization
+4. **Performance**: Uses efficient bulk database operations
+5. **Maintainability**: Follows established code organization
+
+The implementation should prioritize the filter-based approach (similar to `open_all`) while also supporting the `ids` parameter for precise control when needed.