rails-image-post-solution 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 61ff05d1659ea0e22251e785b60a0a3e9c08f200f63b54a16ddb77edfd046987
+  data.tar.gz: b211876b47d97ef9da39dd0197c688bde4951d9c2e100cf20da227e4b7129425
+SHA512:
+  metadata.gz: f448802dbaa0cbbeb74555219f1100ec50373a0cea862d8322efb63e653fea5420c3bab1413f9086feee2973f907f225188cbeffc4e6abdb271b494bcd189976
+  data.tar.gz: 0bdadbfc8e131fface96b9d3d9269e548687d11c1d65bbd2975b9aecbe3f3b4a08e536207e0136eb6607fe4b042be2b0f69a45cd8a55160c2ff35e10d49fc876

data/.rubocop.yml

@@ -0,0 +1,8 @@
+# Omakase Ruby styling for Rails
+inherit_gem: { rubocop-rails-omakase: rubocop.yml }
+
+# Overwrite or add rules to create your own house style
+#
+# # Use `[a, [b, c]]` not `[ a, [ b, c ] ]`
+# Layout/SpaceInsideArrayLiteralBrackets:
+#   Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.4.7

data/CHANGELOG.md

@@ -0,0 +1,42 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2025-01-17
+
+### Added
+- Initial release of RailsImagePostSolution
+- Image reporting system for Active Storage attachments
+- AI-powered moderation using OpenAI Vision API
+  - Detects R18 (adult content)
+  - Detects R18G (grotesque/violent content)
+  - Detects illegal content
+- Admin dashboard for reviewing image reports
+  - View all reports with filtering by status
+  - Detailed report view with image preview
+  - Confirm or dismiss reports
+  - View AI moderation results
+- Auto-freeze functionality for inappropriate content
+- Rails generator for easy installation (`rails generate rails_image_post_solution:install`)
+- Configuration system with initializer
+- i18n support (Japanese and English)
+- Database migrations for image_reports table
+- User reporting API endpoint
+- Comprehensive README with installation and usage instructions
+
+### Features
+- Configurable OpenAI API key
+- Configurable admin check method
+- Optional auto-freeze on content flagged by AI
+- Support for nil user_id (system/AI reports)
+- Unique index to prevent duplicate reports from same user
+- AI confidence scores and category detection
+- View helper methods for easy integration
+
+[Unreleased]: https://github.com/dhq-boiler/rails-image-post-solution/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/dhq-boiler/rails-image-post-solution/releases/tag/v0.1.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 dhq_boiler
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,264 @@
+# RailsImagePostSolution
+
+A comprehensive Rails engine for image reporting, AI-powered moderation using OpenAI Vision API, and admin dashboard. Perfect for Rails applications using Active Storage that need to moderate user-generated image content.
+
+## Features
+
+- **Image Reporting System**: Allow users to report inappropriate images
+- **AI-Powered Moderation**: Automatic content moderation using OpenAI Vision API
+  - Detects R18 (adult content)
+  - Detects R18G (grotesque/violent content)
+  - Detects illegal content
+- **Admin Dashboard**: Review and manage reported images
+- **Auto-Freeze**: Automatically freeze posts containing flagged content (configurable)
+- **i18n Support**: Japanese and English locales included
+- **Highly Configurable**: Customize behavior to fit your application
+
+## Requirements
+
+- Ruby >= 3.2.0
+- Rails >= 7.0
+- Active Storage
+- OpenAI API key (for AI moderation features)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "rails-image-post-solution"
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Run the installation generator:
+
+```bash
+rails generate rails_image_post_solution:install
+```
+
+This will:
+1. Create an initializer at `config/initializers/rails_image_post_solution.rb`
+2. Copy migration files to your application
+3. Display installation instructions
+
+Run the migrations:
+
+```bash
+rails db:migrate
+```
+
+Mount the engine in your `config/routes.rb`:
+
+```ruby
+Rails.application.routes.draw do
+  mount RailsImagePostSolution::Engine => "/moderation"
+  # ... your other routes
+end
+```
+
+## Configuration
+
+Edit `config/initializers/rails_image_post_solution.rb`:
+
+```ruby
+RailsImagePostSolution.configure do |config|
+  # OpenAI API key (recommended to use environment variable)
+  config.openai_api_key = ENV["OPENAI_API_KEY"]
+
+  # Auto-freeze posts when inappropriate content is detected
+  # Default: true
+  config.auto_freeze_on_flag = true
+
+  # Method name to check if current_user is admin
+  # Default: :admin?
+  config.admin_check_method = :admin?
+end
+```
+
+Set your OpenAI API key as an environment variable:
+
+```bash
+export OPENAI_API_KEY=sk-...
+```
+
+## Usage
+
+### User Reporting
+
+Users can report images via POST request:
+
+```ruby
+# In your view
+<%= button_to "Report", rails_image_post_solution.image_reports_path(attachment_id: @image.id, reason: "Inappropriate content"), method: :post %>
+```
+
+Or via JavaScript:
+
+```javascript
+fetch('/moderation/image_reports', {
+  method: 'POST',
+  headers: {
+    'Content-Type': 'application/json',
+    'X-CSRF-Token': document.querySelector('[name="csrf-token"]').content
+  },
+  body: JSON.stringify({
+    attachment_id: imageId,
+    reason: 'R18 content'
+  })
+});
+```
+
+### Admin Dashboard
+
+Admins can access the dashboard at:
+
+```
+/moderation/admin/image_reports
+```
+
+Features:
+- View all reports
+- Filter by status (pending, confirmed, dismissed, reviewed)
+- View detailed information about each report
+- Mark reports as confirmed (inappropriate) or dismissed (safe)
+- View AI moderation results
+
+### AI Moderation
+
+AI moderation runs automatically when the first report is submitted for an image. You can also trigger it manually:
+
+```ruby
+RailsImagePostSolution::ImageModerationJob.perform_later(attachment_id)
+```
+
+### Post Freezing (Optional)
+
+To enable automatic post freezing, add a `freeze_post!` method to your models that have images:
+
+```ruby
+class Post < ApplicationRecord
+  has_many_attached :images
+
+  def freeze_post!(type:, reason:)
+    update!(
+      frozen: true,
+      frozen_type: type,
+      frozen_reason: reason,
+      frozen_at: Time.current
+    )
+  end
+
+  def frozen?
+    frozen == true
+  end
+end
+```
+
+## Requirements for Host Application
+
+Your Rails application must have:
+
+1. **Active Storage** configured
+2. **User model** with:
+   - `current_user` helper method in controllers
+   - `admin?` method (or custom method specified in config)
+   - Display name method (tries `display_name` or `name`)
+
+Example User model:
+
+```ruby
+class User < ApplicationRecord
+  def admin?
+    role == "admin"
+  end
+
+  def display_name
+    name || email
+  end
+end
+```
+
+## Routes
+
+The engine provides the following routes:
+
+```
+POST   /moderation/image_reports                        # Create report
+GET    /moderation/admin/image_reports                  # List all reports
+GET    /moderation/admin/image_reports/:id              # View report details
+PATCH  /moderation/admin/image_reports/:id/confirm      # Mark as inappropriate
+PATCH  /moderation/admin/image_reports/:id/dismiss      # Mark as safe
+```
+
+## Customization
+
+### Custom Admin Check
+
+You can customize how admin access is checked:
+
+```ruby
+# config/initializers/rails_image_post_solution.rb
+config.admin_check_method = :moderator?  # or any method name
+```
+
+### Custom Styling
+
+Override the engine's views by creating files in your app:
+
+```
+app/views/rails_image_post_solution/admin/image_reports/index.html.erb
+app/views/rails_image_post_solution/admin/image_reports/show.html.erb
+```
+
+### Custom Moderation Logic
+
+You can subclass and override the moderation job:
+
+```ruby
+class CustomImageModerationJob < RailsImagePostSolution::ImageModerationJob
+  def perform(attachment_id)
+    # Your custom logic
+    super
+  end
+end
+```
+
+## Database Schema
+
+The gem creates one table: `image_reports`
+
+| Column                         | Type     | Description                          |
+|--------------------------------|----------|--------------------------------------|
+| active_storage_attachment_id   | integer  | Reference to Active Storage          |
+| user_id                        | integer  | Reporter (null for AI reports)       |
+| reason                         | text     | Reason for report                    |
+| status                         | string   | pending/confirmed/dismissed/reviewed |
+| reviewed_by_id                 | integer  | Admin who reviewed                   |
+| reviewed_at                    | datetime | When reviewed                        |
+| ai_flagged                     | boolean  | Flagged by AI                        |
+| ai_confidence                  | float    | AI confidence score (0.0-1.0)        |
+| ai_categories                  | text     | JSON of detected categories          |
+| ai_detected_at                 | datetime | When AI detection ran                |
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dhq-boiler/rails-image-post-solution.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Author
+
+dhq_boiler (dhq_boiler@live.jp)

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[spec]

data/app/controllers/admin/frozen_posts_controller.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Admin
+  class FrozenPostsController < ApplicationController
+    before_action :require_login
+    before_action :require_admin
+
+    def index
+      @filter = params[:filter] || "all"
+
+      # Get frozen stages and comments
+      stages = Stage.frozen.includes(:user).recent
+      comments = MultiplayRecruitmentComment.frozen.includes(:user, :multiplay_recruitment).recent
+
+      case @filter
+      when "temporary"
+        stages = stages.temporarily_frozen
+        comments = comments.temporarily_frozen
+      when "permanent"
+        stages = stages.permanently_frozen
+        comments = comments.permanently_frozen
+      end
+
+      # Combine into array and sort by frozen_at
+      @frozen_posts = (stages.to_a + comments.to_a).sort_by(&:frozen_at).reverse
+
+      # Statistics
+      @stats = {
+        total: Stage.frozen.count + MultiplayRecruitmentComment.frozen.count,
+        temporary: Stage.temporarily_frozen.count + MultiplayRecruitmentComment.temporarily_frozen.count,
+        permanent: Stage.permanently_frozen.count + MultiplayRecruitmentComment.permanently_frozen.count
+      }
+    end
+
+    def unfreeze_stage
+      stage = Stage.find(params[:id])
+      stage.unfreeze!
+      redirect_to admin_frozen_posts_path, notice: I18n.t("admin.flash.stage_unfrozen")
+    end
+
+    def unfreeze_comment
+      comment = MultiplayRecruitmentComment.find(params[:id])
+      comment.unfreeze!
+      redirect_to admin_frozen_posts_path, notice: I18n.t("admin.flash.comment_unfrozen")
+    end
+
+    def permanent_freeze_stage
+      stage = Stage.find(params[:id])
+      stage.freeze_post!(type: :permanent, reason: params[:reason] || I18n.t("admin.flash.permanent_freeze_by_admin"))
+      redirect_to admin_frozen_posts_path, notice: I18n.t("admin.flash.stage_permanently_frozen")
+    end
+
+    def permanent_freeze_comment
+      comment = MultiplayRecruitmentComment.find(params[:id])
+      comment.freeze_post!(type: :permanent, reason: params[:reason] || I18n.t("admin.flash.permanent_freeze_by_admin"))
+      redirect_to admin_frozen_posts_path, notice: I18n.t("admin.flash.comment_permanently_frozen")
+    end
+
+    def destroy_stage
+      stage = Stage.find(params[:id])
+      stage.destroy
+      redirect_to admin_frozen_posts_path, notice: I18n.t("admin.flash.stage_deleted")
+    end
+
+    def destroy_comment
+      comment = MultiplayRecruitmentComment.find(params[:id])
+      comment.destroy
+      redirect_to admin_frozen_posts_path, notice: I18n.t("admin.flash.comment_deleted")
+    end
+
+    private
+
+    def require_admin
+      return if current_user.admin?
+
+      redirect_to root_path, alert: I18n.t("admin.flash.access_denied")
+    end
+  end
+end

data/app/controllers/admin/image_reports_controller.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Admin
+  class ImageReportsController < ApplicationController
+    before_action :require_login
+    before_action :require_admin
+    before_action :set_report, only: %i[show confirm dismiss]
+
+    def index
+      @status_filter = params[:status] || "all"
+
+      @reports = ImageReport.includes(:user, :active_storage_attachment, :reviewed_by)
+                            .recent
+
+      # Filter by status
+      case @status_filter
+      when "pending"
+        @reports = @reports.pending
+      when "confirmed"
+        @reports = @reports.confirmed
+      when "dismissed"
+        @reports = @reports.dismissed
+      when "reviewed"
+        @reports = @reports.reviewed
+      end
+
+      @reports = @reports.limit(100)
+
+      # Statistics
+      @stats = {
+        total: ImageReport.count,
+        pending: ImageReport.pending.count,
+        confirmed: ImageReport.confirmed.count,
+        dismissed: ImageReport.dismissed.count,
+        reviewed: ImageReport.reviewed.count
+      }
+    end
+
+    def show
+      @attachment = @report.active_storage_attachment
+      @reported_user = @attachment.record.user if @attachment.record.respond_to?(:user)
+      @all_reports = ImageReport.where(active_storage_attachment_id: @attachment.id)
+                                .includes(:user)
+                                .recent
+    end
+
+    def confirm
+      @report.update!(
+        status: ImageReport::STATUSES[:confirmed],
+        reviewed_by: current_user,
+        reviewed_at: Time.current
+      )
+
+      redirect_to admin_image_reports_path, notice: I18n.t("admin.image_reports.flash.report_confirmed")
+    end
+
+    def dismiss
+      @report.update!(
+        status: ImageReport::STATUSES[:dismissed],
+        reviewed_by: current_user,
+        reviewed_at: Time.current
+      )
+
+      redirect_to admin_image_reports_path, notice: I18n.t("admin.image_reports.flash.report_dismissed")
+    end
+
+    private
+
+    def set_report
+      @report = ImageReport.find(params[:id])
+    rescue ActiveRecord::RecordNotFound
+      redirect_to admin_image_reports_path, alert: I18n.t("admin.image_reports.flash.report_not_found")
+    end
+
+    def require_admin
+      return if current_user.admin?
+
+      redirect_to root_path, alert: I18n.t("admin.flash.admin_access_only")
+    end
+  end
+end

data/app/controllers/admin/users_controller.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module Admin
+  class UsersController < ApplicationController
+    before_action :require_login
+    before_action :require_admin
+    before_action :set_user, only: %i[show suspend unsuspend ban unban]
+
+    def index
+      @status_filter = params[:status] || "all"
+
+      @users = User.order(created_at: :desc)
+
+      # Filter by status
+      case @status_filter
+      when "active"
+        @users = @users.select(&:active?)
+      when "suspended"
+        @users = @users.select(&:suspended?)
+      when "banned"
+        @users = @users.select(&:banned?)
+      when "admin"
+        @users = @users.where(admin: true)
+      end
+
+      @users = @users.first(100)
+
+      # Statistics
+      @stats = {
+        total: User.count,
+        active: User.all.count(&:active?),
+        suspended: User.all.count(&:suspended?),
+        banned: User.all.count(&:banned?),
+        admin: User.where(admin: true).count
+      }
+    end
+
+    def show
+      @stages = @user.stages.recent.limit(10)
+      @comments = @user.multiplay_recruitment_comments.order(created_at: :desc).limit(10)
+      @reports_made = ImageReport.where(user_id: @user.id).order(created_at: :desc).limit(10)
+
+      # Reports against this user's images
+      @reports_received = ImageReport
+                          .joins(active_storage_attachment: :blob)
+                          .where(active_storage_attachments: { record_type: %w[Stage MultiplayRecruitmentComment] })
+                          .where("active_storage_attachments.record_id IN (
+          SELECT id FROM stages WHERE user_id = :user_id
+          UNION
+          SELECT id FROM multiplay_recruitment_comments WHERE user_id = :user_id
+        )", user_id: @user.id)
+                          .order(created_at: :desc)
+                          .limit(10)
+    end
+
+    def suspend
+      duration_days = params[:duration]&.to_i || 7
+      reason = params[:reason]
+
+      @user.suspend!(reason: reason, duration: duration_days.days)
+
+      redirect_to admin_user_path(@user),
+                  notice: I18n.t("admin.flash.user_suspended", name: @user.display_name, days: duration_days)
+    end
+
+    def unsuspend
+      @user.unsuspend!
+
+      redirect_to admin_user_path(@user), notice: I18n.t("admin.flash.user_unsuspended", name: @user.display_name)
+    end
+
+    def ban
+      reason = params[:reason]
+
+      @user.ban!(reason: reason)
+
+      redirect_to admin_user_path(@user), notice: I18n.t("admin.flash.user_banned", name: @user.display_name)
+    end
+
+    def unban
+      @user.unban!
+
+      redirect_to admin_user_path(@user), notice: I18n.t("admin.flash.user_unbanned", name: @user.display_name)
+    end
+
+    private
+
+    def set_user
+      @user = User.find(params[:id])
+    rescue ActiveRecord::RecordNotFound
+      redirect_to admin_users_path, alert: I18n.t("admin.flash.user_not_found")
+    end
+
+    def require_admin
+      return if current_user.admin?
+
+      redirect_to root_path, alert: I18n.t("admin.flash.admin_access_only")
+    end
+  end
+end