fedipub-moderation 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1ce4eb580ac4093a39a006480b07f863e6b2f4ae8bb1d077a42ecc10799c7f55
+  data.tar.gz: d94937b13d7a3a1f730ed89a790b2647a03b4dcc8e7aed060d4231b0fd529361
+SHA512:
+  metadata.gz: 3cd1c951cf24d4c47c914440f014703f416058fc8cce885b284256b9f0e05b04891758a61779eb6cd55a2d75ce5c405e1cfadd3c07d0b36fd7220fdce2c11ff5
+  data.tar.gz: 6dc30a28a28d2b27e6ab15de37e52204cb2b2e9f7e220ea7dde7b87965db16cb7d2e17260ab1ad4fde375892a1a167fca57c7d4a5dbfa0058361d9beb84dbd88

data/README.md

@@ -0,0 +1,98 @@
+# Fedipub::Moderation
+
+![Gitlab Build Status](https://img.shields.io/gitlab/pipeline-status/fedipub%2Ffedipub-moderation)
+![Libraries.io dependency status for latest release](https://img.shields.io/librariesio/release/rubygems/fedipub-moderation)
+
+![Gem Version](https://img.shields.io/gem/v/fedipub-moderation)
+![Gem Downloads (for latest version)](https://img.shields.io/gem/dtv/fedipub-moderation)
+![Dependent repos (via libraries.io)](https://img.shields.io/librariesio/dependent-repos/rubygems/fedipub-moderation)
+
+A gem that provides moderation capabilities for [Fedipub](https://gitlab.com/fedipub/fedipub). It adds the following features:
+
+* Handle incoming `Flag` activities, normally used for reporting content to moderators
+* Block federation with particular servers
+
+[!note]
+This gem was previously called `federails-moderation`, but has changed name in line with the rename of Federails to Fedipub.
+
+## Requirements
+
+* [Fedipub](https://gitlab.com/fedipub/fedipub) >= 0.8
+* Ruby >= 3.0
+
+## Installation
+Add the gem to your Rails application:
+
+```bash
+> bundle add "fedipub-moderation"
+```
+
+Then install the database migrations:
+
+```bash
+> bin/rails fedipub_moderation:install:migrations
+> bin/rails db:migrate
+```
+
+## Usage
+
+### Reports
+
+When your application receives a `Flag` activitypub message, it will create a `Fedipub::Moderation::Report` record with the details.
+
+```ruby
+# Find all unresolved reports
+reports = Fedipub::Moderation::Report.where(resolution: nil)
+r = reports.first
+
+# Reports can have a comment that was sent with them:
+puts r.content
+# "This message is spam"
+
+# It will be associated with the actor that sent it:
+puts r.actor.at_address
+# "@floppy@mastodon.me.uk"
+
+# Deal with the report in your app, then either:
+r.resolve!
+# or, you can ignore it
+r.ignore!
+
+```
+
+You can receive a callback in your application when a new report is received, by providing a proc which will be called:
+
+```
+Fedipub::Moderation.configure do |conf|
+  conf.after_report_created = ->(report) { MyApp::MyReportHandler.call(report) }
+end
+```
+
+### Domain Blocks
+
+You can block domains that are abusive like so:
+
+```
+Fedipub::Moderation::DomainBlock.create(domain: "spammer.com")
+```
+
+Once the block is created, incoming messages from that domain, or from any actor on that domain, will be ignored. Also, outgoing messages to that domain will be dropped before being delivered.
+
+Actors from the blocked domain aren't currently auto-removed; this may be added in the future, but for now that's left up to your application.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitLab at https://gitlab.com/fedipub/fedipub-moderation. This project is intended to be a safe, welcoming space for collaboration; everyone interacting in the project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://gitlab.com/fedipub/fedipub-moderation/-/blob/main/CODE_OF_CONDUCT.md).
+
+## Support & Community
+
+For help, join the main [Fedipub matrix chat room](https://matrix.to/#/#fedipub:matrix.org).
+
+## Acknowledgements
+
+This gem builds on top of [Fedipub](https://gitlab.com/fedipub/fedipub), by [Manuel Tancoigne](https://gitlab.com/mtancoigne).
+
+This gem was initially created as part of [Manyfold](https://manyfold.app), with funding from [NGI0 Entrust](https://nlnet.nl/entrust), a fund established by [NLnet](https://nlnet.nl) with financial support from the European Commission's [Next Generation Internet](https://ngi.eu) program.
+
+[<img src="https://nlnet.nl/logo/banner.png" alt="NLnet foundation logo" width="20%" />](https://nlnet.nl)
+[<img src="https://nlnet.nl/image/logos/NGI0_tag.svg" alt="NGI Zero Logo" width="20%" />](https://nlnet.nl/entrust)

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/models/fedipub/moderation/domain_block.rb

@@ -0,0 +1,12 @@
+module Fedipub::Moderation
+  class DomainBlock < ApplicationRecord
+    validates :domain, presence: true, uniqueness: true, "fedipub/moderation/domain_name": true
+
+    def self.blocked?(query)
+      self.exists?(domain: [ query, PublicSuffix.parse(query).domain ])
+    rescue PublicSuffix::Error
+      # Allow things that we don't understand
+      false
+    end
+  end
+end

data/app/models/fedipub/moderation/report.rb

@@ -0,0 +1,32 @@
+class Fedipub::Moderation::Report < ApplicationRecord
+  belongs_to :fedipub_actor, class_name: "Fedipub::Actor", optional: true
+  belongs_to :object, polymorphic: true, optional: true
+
+  after_create :execute_create_callback
+
+  def resolve!
+    update!(resolved_at: DateTime.now, resolution: "resolved")
+  end
+
+  def ignore!
+    update!(resolved_at: DateTime.now, resolution: "ignored")
+  end
+
+  def reporter_address
+    if fedipub_actor
+      fedipub_actor.at_address
+    else
+      URI.parse(federated_url).host
+    end
+  end
+
+  def local?
+    fedipub_actor&.local?
+  end
+
+  private
+
+  def execute_create_callback
+    Fedipub::Moderation::Configuration.after_report_created&.call self
+  end
+end

data/app/services/fedipub/moderation/application_service.rb

@@ -0,0 +1,7 @@
+module Fedipub::Moderation
+  class ApplicationService
+    def self.call(*args, &block)
+      new(*args, &block).call
+    end
+  end
+end

data/app/services/fedipub/moderation/report_creation_service.rb

@@ -0,0 +1,40 @@
+module Fedipub::Moderation
+  class ReportCreationService < ApplicationService
+    def initialize(activity)
+      @activity = activity
+      Rails.logger.info "Report recieved: #{@activity.inspect}"
+    end
+
+    def call
+      Report.create!(
+        fedipub_actor: find_reporter,
+        object: find_objects.first,
+        federated_url: @activity["id"],
+        content: @activity["content"]
+      )
+    end
+
+    private
+
+    def find_reporter
+      Fedipub::Actor.find_or_create_by_federation_url(@activity["actor"])
+    rescue ActiveRecord::RecordInvalid, URI::InvalidURIError
+      # Anonymous reports will try to create invalid actors, so we end up here
+      nil
+    end
+
+    def find_objects
+      objects = Array(@activity["object"]).map { |url|
+        begin
+          # Find reported actors
+          Fedipub::Actor.find_by_federation_url(url)
+          # Other objects could be here too, but they will come later
+        rescue ActiveRecord::RecordNotFound
+          nil
+        end
+      }.compact
+      Rails.logger.warn "Fedipub::Moderation cannot currently handle multiple objects in a single report, only the first has been logged" if objects.length > 1
+      objects
+    end
+  end
+end

data/app/validators/fedipub/moderation/domain_name_validator.rb

@@ -0,0 +1,9 @@
+require "public_suffix"
+
+module Fedipub::Moderation
+  class DomainNameValidator < ActiveModel::EachValidator
+    def validate_each(record, attribute, value)
+      record.errors.add attribute, :invalid unless PublicSuffix.valid?(value, default_rule: nil)
+    end
+  end
+end

data/config/initializers/extensions.rb

@@ -0,0 +1,9 @@
+require "fediverse/inbox"
+require "fedipub/moderation/filtered_inbox"
+
+Fediverse::Inbox.send(:include, Fedipub::Moderation::FilteredInbox)
+
+require "fediverse/notifier"
+require "fedipub/moderation/filtered_notifier"
+
+Fediverse::Notifier.send(:include, Fedipub::Moderation::FilteredNotifier)

data/config/initializers/handlers.rb

@@ -0,0 +1,5 @@
+require "fediverse/inbox"
+
+Rails.application.config.after_initialize do
+  Fediverse::Inbox.register_handler "Flag", "*", Fedipub::Moderation::ReportCreationService, :call
+end

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/db/migrate/20241127105043_create_federails_moderation_reports.rb

@@ -0,0 +1,13 @@
+class CreateFederailsModerationReports < ActiveRecord::Migration[7.0]
+  def change
+    create_table :federails_moderation_reports do |t|
+      t.string :federated_url
+      t.references :federails_actor, foreign_key: true
+      t.string :content
+      t.references :object, polymorphic: true
+      t.datetime :resolved_at
+      t.string :resolution
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20241128115659_create_federails_moderation_domain_blocks.rb

@@ -0,0 +1,8 @@
+class CreateFederailsModerationDomainBlocks < ActiveRecord::Migration[7.0]
+  def change
+    create_table :federails_moderation_domain_blocks do |t|
+      t.string "domain", null: false, index: { unique: true }
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20260729204941_rename_federails_moderation_to_fedipub_moderation.rb

@@ -0,0 +1,8 @@
+class RenameFederailsModerationToFedipubModeration < ActiveRecord::Migration[7.2]
+  def change
+    rename_column :federails_moderation_reports, :federails_actor_id, :fedipub_actor_id
+    rename_index :federails_moderation_reports, "index_federails_moderation_reports_on_object", "index_fedipub_moderation_reports_on_object"
+    rename_table :federails_moderation_reports, :fedipub_moderation_reports
+    rename_table :federails_moderation_domain_blocks, :fedipub_moderation_domain_blocks
+  end
+end

data/lib/fedipub/moderation/configuration.rb

@@ -0,0 +1,11 @@
+module Fedipub::Moderation
+  # rubocop:disable Style/ClassVars
+
+  # Stores the Fedipub::Moderation configuration in a _singleton_.
+  module Configuration
+    # A proc that is called any time new report is created
+    # Useful for sending notifications
+    mattr_accessor :after_report_created
+  end
+  # rubocop:enable Style/ClassVars
+end

data/lib/fedipub/moderation/engine.rb

@@ -0,0 +1,9 @@
+require "fedipub"
+
+module Fedipub
+  module Moderation
+    class Engine < ::Rails::Engine
+      isolate_namespace Fedipub::Moderation
+    end
+  end
+end

data/lib/fedipub/moderation/filtered_inbox.rb

@@ -0,0 +1,18 @@
+module Fedipub::Moderation
+  module FilteredInbox
+    extend ActiveSupport::Concern
+
+    included do
+      class <<self
+        def filter_request(payload)
+          filtered_dispatch_request(payload) unless
+            (payload["id"] && DomainBlock.blocked?(URI.parse(payload["id"]).host)) ||
+            (payload["actor"] && DomainBlock.blocked?(URI.parse(payload["actor"]).host))
+        end
+
+        alias_method :filtered_dispatch_request, :dispatch_request
+        alias_method :dispatch_request, :filter_request
+      end
+    end
+  end
+end

data/lib/fedipub/moderation/filtered_notifier.rb

@@ -0,0 +1,16 @@
+module Fedipub::Moderation
+  module FilteredNotifier
+    extend ActiveSupport::Concern
+
+    included do
+      class <<self
+        def filter_post_to_inbox(inbox_url:, message:, from: nil)
+          filtered_post_to_inbox(inbox_url: inbox_url, message: message, from: from) unless DomainBlock.blocked?(URI.parse(inbox_url).hostname)
+        end
+
+        alias_method :filtered_post_to_inbox, :post_to_inbox
+        alias_method :post_to_inbox, :filter_post_to_inbox
+      end
+    end
+  end
+end

data/lib/fedipub/moderation/railtie.rb

@@ -0,0 +1,6 @@
+module Fedipub
+  module Moderation
+    class Railtie < ::Rails::Railtie
+    end
+  end
+end

data/lib/fedipub/moderation/version.rb

@@ -0,0 +1,5 @@
+module Fedipub
+  module Moderation
+    VERSION = "0.5.0"
+  end
+end

data/lib/fedipub/moderation.rb

@@ -0,0 +1,18 @@
+require "fedipub/moderation/version"
+require "fedipub/moderation/engine"
+require "fedipub/moderation/configuration"
+
+module Fedipub
+  module Moderation
+    mattr_reader :configuration
+    @@configuration = Configuration
+
+    def self.configure
+      yield @@configuration
+    end
+
+    def self.table_name_prefix
+      "fedipub_moderation_"
+    end
+  end
+end

data/lib/tasks/fedipub/moderation_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :fedipub_moderation do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: fedipub-moderation
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- James Smith
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-08-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.2.2
+- !ruby/object:Gem::Dependency
+  name: fedipub
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: public_suffix
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+description: Moderation additions for Fedipub; reporting, limit/suspend, server blocking,
+  etc
+email:
+- james@floppy.org.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- app/models/fedipub/moderation/domain_block.rb
+- app/models/fedipub/moderation/report.rb
+- app/services/fedipub/moderation/application_service.rb
+- app/services/fedipub/moderation/report_creation_service.rb
+- app/validators/fedipub/moderation/domain_name_validator.rb
+- config/initializers/extensions.rb
+- config/initializers/handlers.rb
+- config/routes.rb
+- db/migrate/20241127105043_create_federails_moderation_reports.rb
+- db/migrate/20241128115659_create_federails_moderation_domain_blocks.rb
+- db/migrate/20260729204941_rename_federails_moderation_to_fedipub_moderation.rb
+- lib/fedipub/moderation.rb
+- lib/fedipub/moderation/configuration.rb
+- lib/fedipub/moderation/engine.rb
+- lib/fedipub/moderation/filtered_inbox.rb
+- lib/fedipub/moderation/filtered_notifier.rb
+- lib/fedipub/moderation/railtie.rb
+- lib/fedipub/moderation/version.rb
+- lib/tasks/fedipub/moderation_tasks.rake
+homepage: https://gitlab.com/fedipub/fedipub-moderation
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://gitlab.com/fedipub/fedipub-moderation
+  source_code_uri: https://gitlab.com/fedipub/fedipub-moderation
+  changelog_uri: https://gitlab.com/fedipub/fedipub-moderation/releases
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Moderation additions for Fedipub.
+test_files: []