federails 0.0.1 → 0.2.0

data/app/views/federails/client/actors/show.html.erb

@@ -0,0 +1,100 @@
+<h2><%= @actor.name %></h2>
+
+<% if Federails::Client::FollowingPolicy.new(current_user, Federails::Following).create? %>
+  <p>
+    <%
+      follow = current_user.actor.follows? @actor
+      if @actor.entity == current_user
+    %>
+      <button role="button" disabled="disabled">That's you</button>
+    <% elsif follow %>
+      Already following (<%= follow.status %>)
+      <%= button_to 'Revoke', federails.client_following_path(follow), method: :delete %>
+    <% else %>
+      <%= button_to 'Follow!', federails.follow_client_followings_path, params: { account: @actor.at_address }, method: :post %>
+    <% end %>
+  </p>
+<% end %>
+
+<p>
+  <b>Federated url:</b>
+  <%= @actor.federated_url %>
+</p>
+
+<p>
+  <b>Username:</b>
+  <%= @actor.username %>
+</p>
+
+<p>
+  <b>Inbox URL:</b>
+  <%= @actor.inbox_url %>
+</p>
+
+<p>
+  <b>Outbox URL:</b>
+  <%= @actor.outbox_url %>
+</p>
+
+<p>
+  <b>Followers URL:</b>
+  <%= @actor.followers_url %>
+</p>
+
+<p>
+  <b>Followings URL:</b>
+  <%= @actor.followings_url %>
+</p>
+
+<p>
+  <b>Profile url:</b>
+  <% if @actor.profile_url %>
+    <%= link_to 'Profile', @actor.profile_url %>
+  <% end %>
+</p>
+
+<p>
+  <b>Federation address:</b>
+  <%= @actor.at_address %>
+</p>
+
+<p>
+  <b>Home page:</b>
+  <% if @actor.local? && Federails::Configuration.user_profile_url_method %>
+    <%= link_to @actor.send(Federails::Configuration.user_username_field), Rails.application.routes.url_helpers.send(Federails::Configuration.user_profile_url_method, @actor.user) %>
+  <% elsif @actor.profile_url %>
+    <%= link_to @actor.name, @actor.profile_url %>
+  <% else %>
+    (No homepage)
+  <% end %>
+</p>
+
+<hr>
+
+<h2>Follows</h2>
+<% if current_user && current_user == @actor.entity %>
+  <%= render 'federails/client/followings/form', following: Federails::Following.new %>
+<% end %>
+
+<% @actor.following_follows.each do |following| %>
+  <%= render 'federails/client/followings/follow', following: following %>
+<% end %>
+
+<h2>Followers</h2>
+<% @actor.following_followers.each do |following| %>
+  <%= render 'federails/client/followings/follower', following: following %>
+<% end %>
+
+<%= link_to 'Back', federails.client_actors_url %>
+
+<!-- FIXME: Fetch distant content somehow -->
+<h2>10 last activities</h2>
+<% if @actor.local? %>
+  <%= link_to 'All', federails.client_actor_activities_path(@actor) %>
+<% elsif @actor.profile_url %>
+  <%= link_to 'Visit profile', @actor.profile_url %>
+<% end %>
+
+<% @actor.activities.last(10).each do |activity| %>
+  <%= render 'federails/client/activities/activity', activity: activity %>
+<% end %>

data/app/views/federails/client/actors/show.json.jbuilder

@@ -0,0 +1 @@
+json.partial! 'federails/client/actors/actor', actor: @actor

data/app/views/federails/client/followings/_follow.html.erb

@@ -0,0 +1,4 @@
+<div>
+  <b><%= link_to following.target_actor.name, federails.client_actor_url(following.target_actor) %></b>
+  (<%= following.target_actor.at_address %>) (<%= following.status %>)
+</div>

data/app/views/federails/client/followings/_follower.html.erb

@@ -0,0 +1,7 @@
+<div>
+  <b><%= link_to following.actor.name, federails.client_actor_url(following.actor) %></b>
+  (<%= following.actor.at_address %>) (<%= following.status %>)
+  <% if following.pending? && following.target_actor == current_user.actor %>
+    <%= button_to 'Accept', federails.accept_client_following_path(following), method: :put %>
+  <% end %>
+</div>

data/app/views/federails/client/followings/_following.json.jbuilder

@@ -0,0 +1 @@
+json.extract! following, :id, :actor_id, :target_actor_id, :status, :created_at, :updated_at

data/app/views/federails/client/followings/_form.html.erb

@@ -0,0 +1,21 @@
+<%= form_for following, url: federails.client_following_url do |f| %>
+  <% if following.errors.any? %>
+    <div class="error_explanation">
+      <h2><%= pluralize(following.errors.count, 'error') %> prohibited this following from being saved:</h2>
+      <ul>
+        <% following.errors.full_messages.each do |message| %>
+          <li><%= message %></li>
+        <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+  <div class="field">
+    <%= f.label :target_actor %>
+    <%= f.collection_select :target_actor_id, Federails::Actor.all, :id, :name %>
+  </div>
+
+  <div class="actions">
+    <%= f.submit 'Save' %>
+  </div>
+<% end %>

data/app/views/federails/client/followings/index.html.erb

@@ -0,0 +1,29 @@
+<h1>Listing followings</h1>
+
+<table>
+  <thead>
+  <tr>
+    <th>Actor</th>
+    <th>Target actor</th>
+    <th>Status</th>
+    <th></th>
+    <th></th>
+    <th></th>
+  </tr>
+  </thead>
+
+  <tbody>
+  <% @followings.each do |following| %>
+    <tr>
+      <td><%= following.actor %></td>
+      <td><%= following.target_actor %></td>
+      <td><%= following.status %></td>
+      <td><%= link_to 'Show', following %></td>
+      <td><%= link_to 'Edit', edit_following_path(following) %></td>
+      <td><%= link_to 'Destroy', following, method: :delete, data: { confirm: 'Are you sure?' } %></td>
+    </tr>
+  <% end %>
+  </tbody>
+</table>
+
+<%= link_to 'New Following', new_following_path %>

data/app/views/federails/client/followings/index.json.jbuilder

@@ -0,0 +1 @@
+json.array! @followings, partial: 'federails/client/followings/following', as: :following

data/app/views/federails/client/followings/show.html.erb

@@ -0,0 +1,21 @@
+<p id="notice"><%= notice %></p>
+
+<p>
+  <b>Actor:</b>
+  <%= @following.actor %>
+</p>
+
+<p>
+  <b>Target actor:</b>
+  <%= @following.target_actor %>
+</p>
+
+<p>
+  <b>Status:</b>
+  <%= @following.status %>
+</p>
+
+
+<%= link_to 'Edit', edit_following_path(@following) %>
+\|
+<%= link_to 'Back', followings_path %>

data/app/views/federails/client/followings/show.json.jbuilder

@@ -0,0 +1 @@
+json.partial! 'federails/client/followings/following', following: @following

data/app/views/federails/server/activities/_activity.activitypub.jbuilder

@@ -0,0 +1,14 @@
+context = true unless context == false
+json.set! '@context', 'https://www.w3.org/ns/activitystreams' if context
+
+json.id Federails::Engine.routes.url_helpers.server_actor_activity_url activity.actor, activity
+json.type activity.action
+json.actor activity.actor.federated_url
+json.to ['https://www.w3.org/ns/activitystreams#Public']
+json.cc [activity.actor.followers_url]
+
+if activity.entity.respond_to? :to_activitypub_object
+  json.object activity.entity.to_activitypub_object
+elsif activity.entity.respond_to? :federated_url
+  json.object activity.entity.federated_url
+end

data/app/views/federails/server/activities/outbox.activitypub.jbuilder

@@ -0,0 +1,18 @@
+json.set!('@context', 'https://www.w3.org/ns/activitystreams')
+collection_id = @actor.outbox_url
+json.id collection_id
+json.type 'OrderedCollectionPage'
+json.totalItems @total_activities
+json.first collection_id
+json.last @activities.total_pages == 1 ? Federails::Engine.routes.url_helpers.server_actor_outbox_url(@actor) : Federails::Engine.routes.url_helpers.server_actor_outbox_url(@actor, page: @activities.total_pages)
+json.current do |j|
+  j.type 'OrderedCollectionPage'
+  j.id @activities.current_page == 1 ? Federails::Engine.routes.url_helpers.server_actor_outbox_url(@actor) : Federails::Engine.routes.url_helpers.server_actor_outbox_url(@actor, page: @activities.current_page)
+  j.partOf collection_id
+  j.next @activities.next_page
+  j.prev @activities.prev_page
+  j.totalItems @total_activities
+  j.orderedItems do
+    json.array! @activities, partial: 'federails/server/activities/activity', as: :activity, context: false
+  end
+end

data/app/views/federails/server/activities/show.activitypub.jbuilder

@@ -0,0 +1 @@
+json.partial! 'federails/server/activities/activity', activity: @activity

data/app/views/federails/server/actors/_actor.activitypub.jbuilder

@@ -0,0 +1,21 @@
+json.set! '@context', [
+  'https://www.w3.org/ns/activitystreams',
+  'https://w3id.org/security/v1',
+]
+
+json.id actor.federated_url
+json.name actor.name
+json.type actor.entity_configuration[:actor_type]
+json.preferredUsername actor.username
+json.inbox actor.inbox_url
+json.outbox actor.outbox_url
+json.followers actor.followers_url
+json.following actor.followings_url
+json.url actor.profile_url
+if actor.public_key
+  json.publicKey do
+    json.id actor.key_id
+    json.owner actor.federated_url
+    json.publicKeyPem actor.public_key
+  end
+end

data/app/views/federails/server/actors/followers.activitypub.jbuilder

@@ -0,0 +1,18 @@
+json.set!('@context', 'https://www.w3.org/ns/activitystreams')
+collection_id = @actor.followers_url
+json.id collection_id
+json.type 'OrderedCollectionPage'
+json.totalItems @total_actors
+json.first Federails::Engine.routes.url_helpers.followers_server_actor_url(@actor)
+json.last @actors.total_pages == 1 ? Federails::Engine.routes.url_helpers.followers_server_actor_url(@actor) : Federails::Engine.routes.url_helpers.followers_server_actor_url(@actor, page: @actors.total_pages)
+json.current do |j|
+  j.type 'OrderedCollectionPage'
+  j.id @actors.current_page == 1 ? Federails::Engine.routes.url_helpers.followers_server_actor_url(@actor) : Federails::Engine.routes.url_helpers.followers_server_actor_url(@actor, page: @actors.current_page)
+  j.partOf collection_id
+  j.next @actors.next_page
+  j.prev @actors.prev_page
+  j.totalItems @total_actors
+  j.orderedItems do
+    json.array! @actors.map(&:federated_url)
+  end
+end

data/app/views/federails/server/actors/following.activitypub.jbuilder

@@ -0,0 +1,18 @@
+json.set!('@context', 'https://www.w3.org/ns/activitystreams')
+collection_id = @actor.followings_url
+json.id collection_id
+json.type 'OrderedCollectionPage'
+json.totalItems @total_actors
+json.first Federails::Engine.routes.url_helpers.following_server_actor_url(@actor)
+json.last @actors.total_pages == 1 ? Federails::Engine.routes.url_helpers.following_server_actor_url(@actor) : Federails::Engine.routes.url_helpers.following_server_actor_url(@actor, page: @actors.total_pages)
+json.current do |j|
+  j.type 'OrderedCollectionPage'
+  j.id @actors.current_page == 1 ? Federails::Engine.routes.url_helpers.following_server_actor_url(@actor) : Federails::Engine.routes.url_helpers.following_server_actor_url(@actor, page: @actors.current_page)
+  j.partOf collection_id
+  j.next @actors.next_page
+  j.prev @actors.prev_page
+  j.totalItems @total_actors
+  j.orderedItems do
+    json.array! @actors.map(&:federated_url)
+  end
+end

data/app/views/federails/server/actors/show.activitypub.jbuilder

@@ -0,0 +1 @@
+json.partial! 'federails/server/actors/actor', actor: @actor

data/app/views/federails/server/followings/_following.activitypub.jbuilder

@@ -0,0 +1,7 @@
+context = true unless context == false
+json.set! '@context', 'https://www.w3.org/ns/activitystreams' if context
+
+json.id following.federated_url
+json.type 'Follow'
+json.actor following.actor.federated_url
+json.object following.target_actor.federated_url

data/app/views/federails/server/followings/show.activitypub.jbuilder

@@ -0,0 +1 @@
+json.partial! 'federails/server/followings/following', following: @following

data/app/views/federails/server/nodeinfo/index.nodeinfo.jbuilder

@@ -0,0 +1,6 @@
+json.links [
+  {
+    rel:  'https://nodeinfo.diaspora.software/ns/schema/2.0',
+    href: show_node_info_url,
+  },
+]

data/app/views/federails/server/nodeinfo/show.nodeinfo.jbuilder

@@ -0,0 +1,19 @@
+json.version '2.0'
+# FIXME: Use configuration values when created
+json.software name:    Federails::Configuration.app_name,
+              version: Federails::Configuration.app_version
+json.protocols [
+  'activitypub',
+]
+# FIXME: When server is in good shape: update outbounds
+# http://nodeinfo.diaspora.software/ns/schema/2.0 for possible values
+json.services inbound:  [],
+              outbound: []
+# FIXME: Don't hardcode this
+json.openRegistrations true
+json.usage users: {
+  total:          @total,
+  activeMonth:    @active_month,
+  activeHalfyear: @active_halfyear,
+}
+json.metadata({})

data/app/views/federails/server/web_finger/find.jrd.jbuilder

@@ -0,0 +1,24 @@
+json.subject params[:resource]
+
+links = [
+  # Federation actor URL
+  {
+    rel:  'self',
+    type: Mime[:activitypub].to_s,
+    href: @user.actor.federated_url,
+  },
+]
+
+# User profile URL if configured
+# TODO: Add a profile controller/action in dummy to test this
+if @user.actor.profile_url
+  links.push rel:  'https://webfinger.net/rel/profile-page',
+             type: 'text/html',
+             href: @user.actor.profile_url
+end
+
+# Remote following
+links.push rel:      'http://ostatus.org/schema/1.0/subscribe',
+           template: "#{remote_follow_url}?uri={uri}"
+
+json.links links

data/app/views/federails/server/web_finger/host_meta.xrd.erb

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<XRD
+  xmlns="http://docs.oasis-open.org/ns/xri/xrd-1.0">
+  <Link rel="lrdd" type="application/xrd+xml" template="<%= webfinger_url %>?resource={uri}" />
+</XRD>

data/config/initializers/mime_types.rb

@@ -0,0 +1,21 @@
+# Webfinger: https://datatracker.ietf.org/doc/html/rfc7033
+Mime::Type.register 'application/jrd+json', :jrd
+Mime::Type.register 'application/xrd+xml', :xrd
+
+# ActivityPub: https://www.w3.org/TR/activitypub/#retrieving-objects
+Mime::Type.register 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"', :activitypub, ['application/activity+json', 'application/json']
+
+# Nodeinfo: https://github.com/jhass/nodeinfo/blob/main/PROTOCOL.md#retrieval
+Mime::Type.register 'application/json; profile="http://nodeinfo.diaspora.software/ns/schema/2.0#"', :nodeinfo
+
+# Get current request parsers. Apparently we need to do it this way and can't add in-place, see
+# https://api.rubyonrails.org/classes/ActionDispatch/Http/Parameters/ClassMethods.html#method-i-parameter_parsers-3D
+parsers = ActionDispatch::Request.parameter_parsers
+# Copy the default JSON parsing for JSON types
+[:jrd, :activitypub, :nodeinfo].each do |mime_type|
+  parsers[Mime[mime_type].symbol] = parsers[:json]
+end
+# XRD just needs a simple XML parser
+parsers[Mime[:xrd].symbol] = ->(raw_post) { Hash.from_xml(raw_post) || {} }
+# Store updated parsers
+ActionDispatch::Request.parameter_parsers = parsers

data/config/routes.rb

@@ -1,2 +1,45 @@
 Federails::Engine.routes.draw do
+  if Federails.configuration.enable_discovery
+    scope path: '/' do
+      get '/.well-known/webfinger', to: 'server/web_finger#find', as: :webfinger
+      get '/.well-known/host-meta', to: 'server/web_finger#host_meta', as: :host_meta
+      get '/.well-known/nodeinfo', to: 'server/nodeinfo#index', as: :node_info
+      get '/nodeinfo/2.0', to: 'server/nodeinfo#show', as: :show_node_info
+    end
+  end
+
+  if Federails.configuration.client_routes_path
+    scope Federails.configuration.client_routes_path, module: :client, as: :client do
+      resources :activities, only: [:index, :feed]
+      resources :actors, only: [:index, :show] do
+        collection do
+          get :lookup, to: 'actors#lookup'
+        end
+        resources :activities, only: [:index]
+      end
+      get :feed, to: 'activities#feed'
+      resources :followings, only: [:new, :create, :destroy] do
+        collection do
+          post :follow, to: 'followings#follow'
+        end
+
+        member do
+          put :accept, to: 'followings#accept'
+        end
+      end
+    end
+  end
+
+  scope Federails.configuration.server_routes_path, module: :server, as: :server do
+    resources :actors, only: [:show] do
+      member do
+        get :followers
+        get :following
+      end
+      get :outbox, to: 'activities#outbox'
+      post :inbox, to: 'activities#create'
+      resources :activities, only: [:show]
+      resources :followings, only: [:show]
+    end
+  end
 end

data/db/migrate/20200712133150_create_federails_actors.rb

@@ -0,0 +1,24 @@
+class CreateFederailsActors < ActiveRecord::Migration[7.0]
+  def change
+    create_table :federails_actors do |t|
+      t.string :name
+      t.string :federated_url
+      t.string :username
+      t.string :server
+      t.string :inbox_url
+      t.string :outbox_url
+      t.string :followers_url
+      t.string :followings_url
+      t.string :profile_url
+
+      t.references :user, null: true, foreign_key: { to_table: Federails.configuration.user_table }
+
+      t.timestamps
+      t.index :federated_url, unique: true
+    end
+    remove_foreign_key :federails_actors, :users if foreign_key_exists?(:federails_actors, :users)
+    remove_index :federails_actors, :user_id
+    add_index :federails_actors, :user_id, unique: true
+    add_foreign_key :federails_actors, :users
+  end
+end

data/db/migrate/20200712143127_create_federails_followings.rb

@@ -0,0 +1,14 @@
+class CreateFederailsFollowings < ActiveRecord::Migration[7.0]
+  def change
+    create_table :federails_followings do |t|
+      t.references :actor, null: false, foreign_key: { to_table: :federails_actors }
+      t.references :target_actor, null: false, foreign_key: { to_table: :federails_actors }
+      t.integer :status, default: 0
+      t.string :federated_url
+
+      t.timestamps
+
+      t.index [:actor_id, :target_actor_id], unique: true
+    end
+  end
+end

data/db/migrate/20200712174938_create_federails_activities.rb

@@ -0,0 +1,11 @@
+class CreateFederailsActivities < ActiveRecord::Migration[7.0]
+  def change
+    create_table :federails_activities do |t|
+      t.references :entity, polymorphic: true, null: false
+      t.string :action, null: false, default: nil
+      t.references :actor, null: false, foreign_key: { to_table: :federails_actors }
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20240731145400_change_actor_entity_rel_to_polymorphic.rb

@@ -0,0 +1,11 @@
+class ChangeActorEntityRelToPolymorphic < ActiveRecord::Migration[7.0]
+  def change
+    remove_foreign_key :federails_actors, column: :user_id, to_table: Federails::Configuration.user_table
+    remove_index :federails_actors, :user_id, unique: true
+    change_table :federails_actors do |t|
+      t.rename :user_id, :entity_id
+      t.string :entity_type, null: true, default: Federails::Configuration.user_class&.demodulize
+      t.index [:entity_type, :entity_id], name: 'index_federails_actors_on_entity', unique: true
+    end
+  end
+end

data/db/migrate/20241002094500_add_uuids.rb

@@ -0,0 +1,13 @@
+class AddUuids < ActiveRecord::Migration[7.0]
+  def change
+    [
+      :federails_actors,
+      :federails_activities,
+      :federails_followings,
+    ].each do |table|
+      change_table table do |t|
+        t.string :uuid, default: nil, index: { unique: true }
+      end
+    end
+  end
+end

data/db/migrate/20241002094501_add_keypair_to_actors.rb

@@ -0,0 +1,8 @@
+class AddKeypairToActors < ActiveRecord::Migration[7.0]
+  def change
+    change_table :federails_actors do |t|
+      t.text :public_key
+      t.text :private_key
+    end
+  end
+end

data/lib/federails/configuration.rb

@@ -0,0 +1,92 @@
+module Federails
+  # rubocop:disable Style/ClassVars
+  module Configuration
+    # Application name, used in well-known and nodeinfo endpoints
+    mattr_accessor :app_name
+    @@app_name = nil
+
+    # Application version, used in well-known and nodeinfo endpoints
+    mattr_accessor :app_version
+    @@app_version = nil
+
+    # Force https urls in various rendered content (currently in webfinger views)
+    mattr_accessor :force_ssl
+    @@force_ssl = nil
+
+    # Site hostname
+    mattr_reader :site_host
+    @@site_host = nil
+
+    # Site port
+    mattr_reader :site_port
+    @@site_port = nil
+
+    # Whether to enable ".well-known" and "nodeinfo" endpoints
+    mattr_accessor :enable_discovery
+    @@enable_discovery = true
+
+    # Site port
+    mattr_accessor :app_layout
+    @@app_layout = nil
+
+    # User class name
+    # @deprecated Kept for upgrade compatibility only
+    mattr_accessor :user_class
+    @@user_class = '::User'
+
+    # Route path for the federation URLs (to "Federails::Server::*" controllers)
+    mattr_accessor :server_routes_path
+    @@server_routes_path = :federation
+
+    # Route path for the webapp URLs (to "Federails::Client::*" controllers)
+    mattr_accessor :client_routes_path
+    @@client_routes_path = :app
+
+    # Route method for remote-following requests
+    mattr_accessor :remote_follow_url_method
+    @@remote_follow_url_method = 'federails.new_client_following_url'
+
+    # Method to use for links to user profiles
+    # @deprecated Set profile_url_method option on acts_as_federails_actor instead
+    mattr_accessor :user_profile_url_method
+    @@user_profile_url_method = nil
+
+    # Attribute in the user model to use as the user's name
+    # @deprecated Set name_field option on acts_as_federails_actor instead
+    #
+    # It only have sense if you have a separate username attribute
+    mattr_accessor :user_name_field
+    @@user_name_field = nil
+
+    # Attribute in the user model to use as the username for local actors
+    # @deprecated Set username_field option on acts_as_federails_actor instead
+    mattr_accessor :user_username_field
+    @@user_username_field = :id
+
+    ##
+    # @return [String] Table used for user model
+    # @deprecated Kept for upgrade compatibility only
+    def self.user_table
+      @@user_class&.constantize&.table_name
+    end
+
+    def self.site_host=(value)
+      @@site_host = value
+      Federails::Engine.routes.default_url_options[:host] = value
+    end
+
+    def self.site_port=(value)
+      @@site_port = value
+      Federails::Engine.routes.default_url_options[:port] = value
+    end
+
+    # List of entity types
+    mattr_reader :entity_types
+    @@entity_types = {}
+
+    def self.register_entity(klass, config = {})
+      @@entity_types[klass.name] = config.merge(class: klass)
+    end
+  end
+  # rubocop:enable Style/ClassVars
+end

data/lib/federails/engine.rb

@@ -1,5 +1,11 @@
 module Federails
   class Engine < ::Rails::Engine
     isolate_namespace Federails
+
+    config.generators do |g|
+      g.test_framework :rspec
+      g.fixture_replacement :factory_bot
+      g.factory_bot dir: 'spec/factories'
+    end
   end
 end