rails-image-post-solution 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61ff05d1659ea0e22251e785b60a0a3e9c08f200f63b54a16ddb77edfd046987
-  data.tar.gz: b211876b47d97ef9da39dd0197c688bde4951d9c2e100cf20da227e4b7129425
+  metadata.gz: 32426dffba22192bd75b188bd48b57c794cfa2f64b28d699f7dc375c55060d21
+  data.tar.gz: dad18086d9ff9c6d613ecded2c48fcb17e6de7543f87fefbddcf33e196669fa4
 SHA512:
-  metadata.gz: f448802dbaa0cbbeb74555219f1100ec50373a0cea862d8322efb63e653fea5420c3bab1413f9086feee2973f907f225188cbeffc4e6abdb271b494bcd189976
-  data.tar.gz: 0bdadbfc8e131fface96b9d3d9269e548687d11c1d65bbd2975b9aecbe3f3b4a08e536207e0136eb6607fe4b042be2b0f69a45cd8a55160c2ff35e10d49fc876
+  metadata.gz: 30ce677ce249bc09956d4ac0948946a3046840342db546de43b5c4b620a3bf8d47cb2a6d8d6c65b36cbc080c9abf724bfe096430a4f9a35ef840450ec5dd5e8c
+  data.tar.gz: '08acf121746c98771333797ac6bd58d1060c3176c049e56422e237e2c4591cbabe3afbad39d6cb67ce7d4457c5bdf73500c4c7d62bb55ef4c15fc75ac02ea915'

data/README.md

@@ -4,6 +4,7 @@ A comprehensive Rails engine for image reporting, AI-powered moderation using Op
 
 ## Features
 
+### Core Features
 - **Image Reporting System**: Allow users to report inappropriate images
 - **AI-Powered Moderation**: Automatic content moderation using OpenAI Vision API
   - Detects R18 (adult content)
@@ -14,10 +15,15 @@ A comprehensive Rails engine for image reporting, AI-powered moderation using Op
 - **i18n Support**: Japanese and English locales included
 - **Highly Configurable**: Customize behavior to fit your application
 
+### Extended Admin Features (Optional)
+- **User Management**: Suspend, ban, and manage users
+- **Frozen Posts Management**: Review, unfreeze, or permanently freeze flagged content
+- **Enhanced Reporting**: Extended admin views with detailed statistics
+
 ## Requirements
 
-- Ruby >= 3.2.0
-- Rails >= 7.0
+- Ruby >= 3.4.7
+- Rails >= 8.1
 - Active Storage
 - OpenAI API key (for AI moderation features)
 
@@ -90,7 +96,15 @@ export OPENAI_API_KEY=sk-...
 
 ### User Reporting
 
-Users can report images via POST request:
+The gem provides shared view partials for easy integration:
+
+```erb
+<%# In your view %>
+<%= render 'shared/image_report_button', image: @attachment %>
+<%= render 'shared/image_report_modal' %>
+```
+
+Or manually via POST request:
 
 ```ruby
 # In your view
@@ -113,6 +127,12 @@ fetch('/moderation/image_reports', {
 });
 ```
 
+The provided partials include:
+- `_image_report_button.html.erb` - Report button with status display
+- `_image_report_modal.html.erb` - Modal dialog for submitting reports with category selection
+
+**Note**: The partials reference Stimulus controllers (`image-report`). You'll need to implement the corresponding Stimulus controller in your application or use the manual POST method above.
+
 ### Admin Dashboard
 
 Admins can access the dashboard at:
@@ -144,17 +164,43 @@ To enable automatic post freezing, add a `freeze_post!` method to your models th
 class Post < ApplicationRecord
   has_many_attached :images
 
+  # Scopes for frozen posts management
+  scope :frozen, -> { where.not(frozen_at: nil) }
+  scope :temporarily_frozen, -> { frozen.where(frozen_type: "temporary") }
+  scope :permanently_frozen, -> { frozen.where(frozen_type: "permanent") }
+  scope :recent, -> { order(created_at: :desc) }
+
   def freeze_post!(type:, reason:)
     update!(
-      frozen: true,
       frozen_type: type,
       frozen_reason: reason,
       frozen_at: Time.current
     )
   end
 
+  def unfreeze!
+    update!(
+      frozen_type: nil,
+      frozen_reason: nil,
+      frozen_at: nil
+    )
+  end
+
   def frozen?
-    frozen == true
+    frozen_at.present?
+  end
+end
+```
+
+Add the required columns to your model:
+
+```ruby
+class AddFrozenFieldsToPosts < ActiveRecord::Migration[8.1]
+  def change
+    add_column :posts, :frozen_type, :string
+    add_column :posts, :frozen_reason, :text
+    add_column :posts, :frozen_at, :datetime
+    add_index :posts, :frozen_at
   end
 end
 ```
@@ -183,6 +229,69 @@ class User < ApplicationRecord
 end
 ```
 
+### Additional User Model Methods (for Extended Features)
+
+If you plan to use the extended admin features (user management, frozen posts), add these methods to your User model:
+
+```ruby
+class User < ApplicationRecord
+  # Status check methods
+  def active?
+    !suspended? && !banned?
+  end
+
+  def suspended?
+    suspended_until.present? && suspended_until > Time.current
+  end
+
+  def banned?
+    banned_at.present?
+  end
+
+  # User management methods
+  def suspend!(reason:, duration: 7.days)
+    update!(
+      suspended_until: Time.current + duration,
+      suspension_reason: reason
+    )
+  end
+
+  def unsuspend!
+    update!(
+      suspended_until: nil,
+      suspension_reason: nil
+    )
+  end
+
+  def ban!(reason:)
+    update!(
+      banned_at: Time.current,
+      ban_reason: reason
+    )
+  end
+
+  def unban!
+    update!(
+      banned_at: nil,
+      ban_reason: nil
+    )
+  end
+end
+```
+
+And add the corresponding database columns:
+
+```ruby
+class AddModerationFieldsToUsers < ActiveRecord::Migration[8.1]
+  def change
+    add_column :users, :suspended_until, :datetime
+    add_column :users, :suspension_reason, :text
+    add_column :users, :banned_at, :datetime
+    add_column :users, :ban_reason, :text
+  end
+end
+```
+
 ## Routes
 
 The engine provides the following routes:
@@ -195,6 +304,50 @@ PATCH  /moderation/admin/image_reports/:id/confirm      # Mark as inappropriate
 PATCH  /moderation/admin/image_reports/:id/dismiss      # Mark as safe
 ```
 
+### Extended Admin Features (Optional)
+
+The gem includes additional admin controllers for extended functionality. To use these, add the following routes to your `config/routes.rb`:
+
+```ruby
+namespace :admin do
+  # User management
+  resources :users, only: [:index, :show] do
+    member do
+      post :suspend
+      post :unsuspend
+      post :ban
+      post :unban
+    end
+  end
+
+  # Frozen posts management
+  resources :frozen_posts, only: [:index] do
+    collection do
+      post 'unfreeze_stage/:id', action: :unfreeze_stage, as: :unfreeze_stage
+      post 'unfreeze_comment/:id', action: :unfreeze_comment, as: :unfreeze_comment
+      post 'permanent_freeze_stage/:id', action: :permanent_freeze_stage, as: :permanent_freeze_stage
+      post 'permanent_freeze_comment/:id', action: :permanent_freeze_comment, as: :permanent_freeze_comment
+      delete 'destroy_stage/:id', action: :destroy_stage, as: :destroy_stage
+      delete 'destroy_comment/:id', action: :destroy_comment, as: :destroy_comment
+    end
+  end
+
+  # Extended image reports (alternative to engine's admin controller)
+  resources :image_reports, only: [:index, :show] do
+    member do
+      patch :confirm
+      patch :dismiss
+    end
+  end
+end
+```
+
+These extended features include:
+
+- **User Management**: Suspend, unsuspend, ban, and unban users
+- **Frozen Posts Management**: View, unfreeze, permanently freeze, or delete frozen posts
+- **Enhanced Image Reports**: Additional views and functionality for managing image reports
+
 ## Customization
 
 ### Custom Admin Check

data/config/routes.rb

@@ -12,5 +12,27 @@ RailsImagePostSolution::Engine.routes.draw do
         patch :dismiss
       end
     end
+
+    # User management
+    resources :users, only: [ :index, :show ] do
+      member do
+        patch :suspend
+        patch :unsuspend
+        patch :ban
+        patch :unban
+      end
+    end
+
+    # Frozen posts management
+    resources :frozen_posts, only: [ :index ] do
+      collection do
+        patch "unfreeze_stage/:id", to: "frozen_posts#unfreeze_stage", as: :unfreeze_stage
+        patch "unfreeze_comment/:id", to: "frozen_posts#unfreeze_comment", as: :unfreeze_comment
+        patch "permanent_freeze_stage/:id", to: "frozen_posts#permanent_freeze_stage", as: :permanent_freeze_stage
+        patch "permanent_freeze_comment/:id", to: "frozen_posts#permanent_freeze_comment", as: :permanent_freeze_comment
+        delete "destroy_stage/:id", to: "frozen_posts#destroy_stage", as: :destroy_stage
+        delete "destroy_comment/:id", to: "frozen_posts#destroy_comment", as: :destroy_comment
+      end
+    end
   end
 end

data/lib/generators/rails_image_post_solution/install/README

@@ -22,6 +22,6 @@ Next steps:
      # Your implementation
    end
 
-For more information, see: https://github.com/your-username/rails-image-post-solution
+For more information, see: https://github.com/dhq-boiler/rails-image-post-solution
 
 ===============================================================================

data/lib/rails_image_post_solution/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsImagePostSolution
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-image-post-solution
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - dhq_boiler