newsmast_mastodon

newsmast_mastodon is a Rails engine that extends a Mastodon host app with Newsmast features across accounts, content filtering, conversations, custom feeds, local-only posts, posting workflows, and timeline behavior.

• API endpoints under api/v1 for Newsmast account and feed workflows
• Draft status APIs and publish workflow
• Local-only post settings support
• Feed and timeline extensions (including custom timeline endpoints)
• Account and notification-related enhancements
• Host-app concern/service prepends for Mastodon models and services
• Install task for Chewy indexes and frontend override files

Add the gem to your Mastodon host app:

gem "newsmast_mastodon"

Install dependencies:

bundle install

Run database migrations (the engine appends its own migrations to the host app):

bin/rails db:migrate

Install Chewy indexes and frontend overrides into the host app:

bin/rails newsmast_mastodon:install

If frontend files are copied/updated, rebuild frontend assets in the host app:

yarn build:development
# or
yarn build:production

• Ruby: >= 3.1.0
• Rails: >= 7.1, < 9.0
• Host app: Mastodon-based Rails application

This repository does not pin a specific Mastodon release in its dependencies, so compatibility should be validated against your target Mastodon version.

• The engine mounts itself at / in the host app.
• The engine prepends/includes Newsmast concerns and overrides into Mastodon classes during to_prepare.
• The engine appends gem migrations to the host migration path automatically.
• If Ghost/WordPress environment variables are present, related hosts are allowlisted in config.hosts.

The engine defines multiple api/v1 routes, including:

• POST /api/v1/drafted_statuses
• POST /api/v1/drafted_statuses/:id/publish
• GET /api/v1/timelines/:username/feed
• GET /api/v1/local_only_posts/getLocalOnlySetting

See config/routes.rb for the full route list.

Set up and run checks:

bundle install
bundle exec rspec
bundle exec rubocop

Use Docker only for infrastructure (PostgreSQL, Redis, Elasticsearch), while running the Rails app and specs directly on your machine.

From your workspace root, start services:

docker compose up -d db redis es

From newsmast_mastodon, run specs against those services:

export DATABASE_HOST=127.0.0.1
export DATABASE_PORT=5432
export DATABASE_USER=postgres
export DATABASE_PASSWORD=postgres
export REDIS_HOST=127.0.0.1
export REDIS_PORT=6379
export ES_ENABLED=true
export ES_HOST=127.0.0.1
export ES_PORT=9200

bundle exec rspec --format progress

Optional cleanup:

docker compose down

Note: RAILS_ENV=test bin/rails app:db:prepare can fail if duplicate migration names exist in the consolidated migration set. In that case, run specs directly as above until migration naming conflicts are resolved.

Contribution process and standards are documented in CONTRIBUTING.md.

See CHANGELOG.md for release notes.

This project is licensed under the GNU Affero General Public License v3.0. See LICENSE.txt for details.