federails 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 070da5d2cc3d016475a69f797c6280595618d5f60de95cf7506bb2a1e9cbce4c
-  data.tar.gz: a954535a092fa71fdb911f973363d8372b6d56e42b32190394e92026567c6913
+  metadata.gz: e489a0088b05ef80d9cc112164f054a030f0cb007406cb14789372a5a52c490f
+  data.tar.gz: b6832c622e5c33bf85f520839604a9e6e516821097d70bb6c6acb7df92f0d4b3
 SHA512:
-  metadata.gz: 69fba1438beef26a150079c2a39eb185903025dcad3c24f5dfee941d844710d12938cf5546f0dc488f725096a2c4e6f32dfba4d1d3c825b9ba9418f063bb4ec9
-  data.tar.gz: 01ef6821f7b1aa9422f013e23ed20b1225f0e630d4925ca81c7490f43d790a1d77a3b93e8d72783d93aee59f1760b48bbdd71a59feca353bca0a1277a6bd03c0
+  metadata.gz: 59e24e51b83545daabfa7dc0c878183d8b0bc14276b559b529fb5ee48183739c49b1a1987eb4a5e8d0d795dcfbe6970d6a3478691f9a13cd12c399903df61695
+  data.tar.gz: 01f6e7bef60bd2d15e142b7b55fecf25dd76ab67571c994c3c8aae1eba23fbcc75d02fb03775131a070b3cc6c18021d33ce91bb8645e937d94c1425a0a7433a3

data/README.md

@@ -92,7 +92,7 @@ With `routes_path = 'federation'`, routes will be:
 
 Some routes can be disabled in configuration if you don't want to expose particular features:
 
-```
+```rb
 Federails.configure do |config|
   # Disable routing for .well-known and nodeinfo
   config.enable_discovery = false
@@ -107,7 +107,7 @@ end
 By default, remote follow requests (where you press a follow button on another server and get redirected home to complete the follow)
 will use the built-in client paths. If you're not using the client, or want to provide your own user interface, you can set the path like this, assuming that `new_follow_url` is a valid route in your app. A `uri` query parameter template will be automatically appended, you don't need to specify that.
 
-```
+```rb
 Federails.configure do |config|
   config.remote_follow_url_method = :new_follow_url
 end
@@ -154,6 +154,32 @@ actor.following
 #...
 ```
 
+### Using the Federails client
+
+Federails comes with a client, enabled by default, that provides basic views to display and interact with Federails data,
+accessible on `/app` by default (changeable with the configuration option `client_routes_path`)
+
+If it's a good starting point, it might be disabled once you made your own integration by setting `client_routes_path`
+to a `nil` value.
+
+If you want to override the client's views, copy them in your application:
+
+```sh
+rails generate federails:copy_client_views
+```
+
+## Common questions
+
+- **I override the base controller and the links breaks in my layout**
+
+  Use `main_app.<url_helper>` for links to your application; `federails.<federails_url_helper>` for links to the Federails client.
+- **I specified a custom layout and the links breaks in it**
+
+  Use `main_app.<url_helper>` for links to your application; `federails.<federails_url_helper>` for links to the Federails client.
+- **I specified a custom layout and my helpers are not available**
+
+  You will have better results if you specify a `base_controller` from your application as Federails base controller is isolated from the main app and does not have access to its helpers.
+
 ## Contributing
 
 Contributions are welcome, may it be issues, ideas, code or whatever you want to share. Please note:

data/app/controllers/federails/client/activities_controller.rb

@@ -1,8 +1,8 @@
 module Federails
   module Client
-    class ActivitiesController < Federails::ApplicationController
+    class ActivitiesController < Federails::ClientController
       before_action :authenticate_user!, only: [:feed]
-      # layout 'layouts/application'
+      before_action :authorize_action!
 
       # GET /app/activities
       # GET /app/activities.json
@@ -16,6 +16,12 @@ module Federails
       def feed
         @activities = Activity.feed_for(current_user.actor)
       end
+
+      private
+
+      def authorize_action!
+        authorize(Federails::Activity, policy_class: Federails::Client::ActivityPolicy)
+      end
     end
   end
 end

data/app/controllers/federails/client/actors_controller.rb

@@ -1,12 +1,15 @@
 module Federails
   module Client
-    class ActorsController < Federails::ApplicationController
+    class ActorsController < Federails::ClientController
       before_action :set_actor, only: [:show]
 
       # GET /app/actors
       # GET /app/actors.json
       def index
+        authorize Federails::Actor, policy_class: Federails::Client::ActorPolicy
+
         @actors = policy_scope(Federails::Actor, policy_scope_class: Federails::Client::ActorPolicy::Scope).all
+        @actors = @actors.local if params[:local_only]
       end
 
       # GET /app/actors/1

data/app/controllers/federails/client/followings_controller.rb

@@ -1,7 +1,8 @@
 module Federails
   module Client
-    class FollowingsController < Federails::ApplicationController
+    class FollowingsController < Federails::ClientController
       before_action :authenticate_user!
+      before_action :skip_authorization, only: [:new, :create]
       before_action :set_following, only: [:accept, :destroy]
 
       # GET /app/followings/new?uri={uri}
@@ -40,9 +41,10 @@ module Federails
       # POST /app/followings/follow
       # POST /app/followings/follow.json
       def follow
+        authorize Federails::Following, policy_class: Federails::Client::FollowingPolicy
+
         begin
           @following = Following.new_from_account following_account_params, actor: current_user.actor
-          authorize @following, policy_class: Federails::Client::FollowingPolicy
         rescue ::ActiveRecord::RecordNotFound
           # Renders a 422 instead of a 404
           respond_to do |format|

data/app/controllers/federails/client_controller.rb

@@ -0,0 +1,9 @@
+module Federails
+  class ClientController < Federails.configuration.base_client_controller.constantize
+    include Pundit::Authorization
+
+    after_action :verify_authorized
+
+    layout Federails.configuration.app_layout if Federails.configuration.app_layout
+  end
+end

data/app/controllers/federails/server/activities_controller.rb

@@ -2,12 +2,14 @@ require 'fediverse/inbox'
 
 module Federails
   module Server
-    class ActivitiesController < ServerController
+    class ActivitiesController < Federails::ServerController
       before_action :set_activity, only: [:show]
 
       # GET /federation/activities
       # GET /federation/actors/1/outbox.json
       def outbox
+        authorize Federails::Activity, policy_class: Federails::Server::ActivityPolicy
+
         @actor            = Actor.find_param(params[:actor_id])
         @activities       = policy_scope(Federails::Activity, policy_scope_class: Federails::Server::ActivityPolicy::Scope).where(actor: @actor).order(created_at: :desc)
         @total_activities = @activities.count
@@ -19,6 +21,8 @@ module Federails
 
       # POST /federation/actors/1/inbox
       def create
+        skip_authorization
+
         payload = payload_from_params
         return head :unprocessable_entity unless payload
 
@@ -34,6 +38,7 @@ module Federails
       # Use callbacks to share common setup or constraints between actions.
       def set_activity
         @activity = Actor.find_param(params[:actor_id]).activities.find_param(params[:id])
+        authorize @activity, policy_class: Federails::Server::ActivityPolicy
       end
 
       # Only allow a list of trusted parameters through.

data/app/controllers/federails/server/actors_controller.rb

@@ -1,17 +1,21 @@
 module Federails
   module Server
-    class ActorsController < ServerController
+    class ActorsController < Federails::ServerController
       before_action :set_actor, only: [:show, :followers, :following]
 
       # GET /federation/actors/1
       # GET /federation/actors/1.json
       def show; end
 
+      # GET /federation/actors/:id/followers
+      # GET /federation/actors/:id/followers.json
       def followers
         @actors = @actor.followers.order(created_at: :desc)
         followings_queries
       end
 
+      # GET /federation/actors/:id/followers
+      # GET /federation/actors/:id/followers.json
       def following
         @actors = @actor.follows.order(created_at: :desc)
         followings_queries

data/app/controllers/federails/server/followings_controller.rb

@@ -1,6 +1,6 @@
 module Federails
   module Server
-    class FollowingsController < ServerController
+    class FollowingsController < Federails::ServerController
       before_action :set_following, only: [:show]
 
       # GET /federation/actors/1/followings/1.json

data/app/controllers/federails/server/nodeinfo_controller.rb

@@ -1,19 +1,25 @@
 module Federails
   module Server
-    class NodeinfoController < ServerController
+    class NodeinfoController < Federails::ServerController
       def index
+        skip_authorization
+
         render formats: [:nodeinfo]
       end
 
       def show # rubocop:todo Metrics/AbcSize
+        skip_authorization
+
         @total = @active_halfyear = @active_month = 0
+        @has_user_counts = false
         Federails::Configuration.entity_types.each_value do |config|
-          next unless config[:include_in_user_count]
+          next unless (method = config[:user_count_method]&.to_sym)
 
+          @has_user_counts = true
           model = config[:class]
-          @total += model.count
-          @active_month += model.where(created_at: ((30.days.ago)...Time.current)).count
-          @active_halfyear += model.where(created_at: ((180.days.ago)...Time.current)).count
+          @total += model.send(method, nil)
+          @active_month += model.send(method, ((30.days.ago)...Time.current))
+          @active_halfyear += model.send(method, ((180.days.ago)...Time.current))
         end
         render formats: [:nodeinfo]
       end

data/app/controllers/federails/server/web_finger_controller.rb

@@ -2,8 +2,10 @@ require 'fediverse/webfinger'
 
 module Federails
   module Server
-    class WebFingerController < ServerController
+    class WebFingerController < Federails::ServerController
       def find
+        skip_authorization
+
         resource = params.require(:resource)
         case resource
         when %r{^https?://.+}
@@ -19,6 +21,8 @@ module Federails
       end
 
       def host_meta
+        skip_authorization
+
         render formats: [:xrd]
       end
 

data/app/controllers/federails/{application_controller.rb → server_controller.rb}

@@ -1,10 +1,13 @@
 module Federails
-  class ApplicationController < ActionController::Base
+  class ServerController < ::ActionController::Base # rubocop:disable Rails/ApplicationController
     include Pundit::Authorization
 
-    rescue_from ActiveRecord::RecordNotFound, with: :error_not_found
+    after_action :verify_authorized
+
+    protect_from_forgery with: :null_session
+    helper Federails::ServerHelper
 
-    layout Federails.configuration.app_layout if Federails.configuration.app_layout
+    rescue_from ActiveRecord::RecordNotFound, with: :error_not_found
 
     private
 

data/app/helpers/federails/{application_helper.rb → server_helper.rb}

@@ -1,5 +1,5 @@
 module Federails
-  module ApplicationHelper
+  module ServerHelper
     def remote_follow_url
       method_name = Federails.configuration.remote_follow_url_method.to_s
       if method_name.starts_with? 'federails.'

data/app/models/concerns/federails/entity.rb

@@ -14,38 +14,79 @@ module Federails
         set_callback :followed, :after, method
       end
 
+      # Define a method that will be called after an activity has been received
+      # @param activity_type [String] The activity action to handle, e.g. 'Create'. If you specify '*', the handler will be called for any activity type.
+      # @param object_type [String] The object type to handle, e.g. 'Note'. If you specify '*', the handler will be called for any object type.
+      # @param method [Symbol] The name of the class method to call. The method will receive the complete activity payload as a parameter.
+      # @example
+      #   after_activity_received 'Create', 'Note', :create_note
+      def self.after_activity_received(activity_type, object_type, method)
+        Fediverse::Inbox.register_handler(activity_type, object_type, self, method)
+      end
+
       has_one :actor, class_name: 'Federails::Actor', as: :entity, dependent: :destroy
 
-      after_create :create_actor
+      after_create :create_actor, if: lambda {
+        raise("Entity not configured for #{self.class.name}. Did you use \"acts_as_federails_actor\"?") unless Federails::Configuration.entity_types.key? self.class.name
+
+        Federails::Configuration.entity_types[self.class.name][:auto_create_actors]
+      }
 
       # Configures the mapping between entity and actor
       # @param username_field [Symbol] The method or attribute name that returns the preferred username for ActivityPub
       # @param name_field [Symbol] The method or attribute name that returns the preferred name for ActivityPub
       # @param profile_url_method [Symbol] The route method name that will generate the profile URL for ActivityPub
       # @param actor_type [String] The ActivityStreams Actor type for this entity; defaults to 'Person'
-      # @param include_in_user_count [boolean] Should this entity be included in the nodeinfo user count? Defaults to true
+      # @param user_count_method [Symbol] A class method to call to count active users. Leave unspecified to leave this
+      #  entity out of user counts. Method signature should accept a single parameter which will specify a date range
+      #  If parameter is nil, the total user count should be returned. If the parameter is specified, the number of users
+      #  active during the time period should be returned.
+      # @param auto_create_actors [Boolean] Whether to automatically create an actor when the entity is created
       # @example
       #   acts_as_federails_actor username_field: :username, name_field: :display_name, profile_url_method: :url_for, actor_type: 'Person'
+      # rubocop:disable Metrics/ParameterLists
       def self.acts_as_federails_actor(
-        username_field: Federails::Configuration.user_username_field,
-        name_field: Federails::Configuration.user_name_field,
-        profile_url_method: Federails.configuration.user_profile_url_method,
+        name_field:,
+        username_field:,
+        profile_url_method: nil,
         actor_type: 'Person',
-        include_in_user_count: true
+        user_count_method: nil,
+        auto_create_actors: true
       )
         Federails::Configuration.register_entity(
           self,
-          username_field:        username_field,
-          name_field:            name_field,
-          profile_url_method:    profile_url_method,
-          actor_type:            actor_type,
-          include_in_user_count: include_in_user_count
+          username_field:     username_field,
+          name_field:         name_field,
+          profile_url_method: profile_url_method,
+          actor_type:         actor_type,
+          user_count_method:  user_count_method,
+          auto_create_actors: auto_create_actors
         )
       end
+      # rubocop:enable Metrics/ParameterLists
 
-      # Automatically run default acts_as_federails_actor
-      # this can be optionally called again with different configuration in the entity
-      acts_as_federails_actor
+      # Add custom data to actor responses.
+      # Override in your own model to add extra data, which will be merged into the actor response
+      # generated by Federails. You can include extra `@context` for activitypub extensions and it will
+      # be merged with the main response context.
+      # @example
+      #   def to_activitypub_object
+      #     {
+      #       "@context": {
+      #         toot: "http://joinmastodon.org/ns#",
+      #         attributionDomains: {
+      #           "@id": "toot:attributionDomains",
+      #           "@type": "@id"
+      #         }
+      #       },
+      #       attributionDomains: [
+      #         "example.com"
+      #       ]
+      #     }
+      #   end
+      def to_activitypub_object
+        {}
+      end
 
       private
 

data/app/models/federails/actor.rb

@@ -91,7 +91,9 @@ module Federails
     end
 
     def entity_configuration
-      Federails::Configuration.entity_types[entity.class.name]
+      raise("Entity not configured for #{entity_type}. Did you use \"acts_as_federails_actor\"?") unless Federails::Configuration.entity_types.key? entity_type
+
+      Federails::Configuration.entity_types[entity_type]
     end
 
     class << self

data/app/policies/federails/client/activity_policy.rb

@@ -1,6 +1,9 @@
 module Federails
   module Client
     class ActivityPolicy < Federails::FederailsPolicy
+      def feed?
+        user_with_actor?
+      end
     end
   end
 end

data/app/policies/federails/client/actor_policy.rb

@@ -7,7 +7,7 @@ module Federails
 
       class Scope < Scope
         def resolve
-          scope.local
+          scope
         end
       end
     end

data/app/policies/federails/client/following_policy.rb

@@ -26,9 +26,9 @@ module Federails
       private
 
       def in_following?
-        return false if @user.blank?
+        return false unless user_with_actor?
 
-        @record.actor_id == @user.actor.id || @record.target_actor_id == @user.actor.id
+        @record.actor_id == @user.actor&.id || @record.target_actor_id == @user.actor&.id
       end
     end
   end

data/app/policies/federails/federails_policy.rb

@@ -55,5 +55,9 @@ module Federails
 
       @record.actor_id == @user.actor.id
     end
+
+    def user_with_actor?
+      @user && Federails.actor_entity?(@user) && !!@user.actor
+    end
   end
 end

data/app/policies/federails/server/activity_policy.rb

@@ -1,6 +1,9 @@
 module Federails
   module Server
     class ActivityPolicy < Federails::FederailsPolicy
+      def outbox?
+        true
+      end
     end
   end
 end

data/app/views/federails/client/activities/_activity.html.erb

@@ -1,5 +1,5 @@
 <div>
-  <b><%= activity.actor.name %></b>
+  <b><%= link_to activity.actor.name, federails.client_actor_url(activity.actor) %></b>
   <code><%= activity.action %></code>
   <!-- < %= link_to activity.entity_type, activity.entity %>-->
 </div>

data/app/views/federails/client/activities/feed.html.erb

@@ -1,4 +1,11 @@
-<h1>Your feed !</h1>
+<h1>Your feed</h1>
+<p>
+  This is the list of activities from actors you follow.
+</p>
+
+<% if @activities.size.zero? %>
+  <p>There is nothing to display. Start following things!</p>
+<% end %>
 <% @activities.each do |activity| %>
   <%= render 'activity', activity: activity %>
 <% end %>

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

@@ -1,5 +1,5 @@
 <h1>Listing activities</h1>
 
-<%= @activities.each do |activity| %>
+<% @activities.each do |activity| %>
   <%= render 'activity', activity: activity %>
 <% end %>

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

@@ -1,5 +1,14 @@
 <h1>Listing actors</h1>
 
+<section>
+  Filters:
+  <% if params[:local_only] %>
+    <%= link_to 'All actors', federails.client_actors_url %>
+  <% else %>
+    <%= link_to 'Only local actors', federails.client_actors_url(local_only: true) %>
+  <% end %>
+</section>
+
 <table>
   <thead>
   <tr>
@@ -11,6 +20,11 @@
   </tr>
   </thead>
   <tbody>
+  <% if @actors.size.zero? %>
+    <tr>
+      <td colspan="5">There are no actors to display</td>
+    </tr>
+  <% end %>
   <% @actors.each do |actor| %>
     <tr>
       <td><%= actor.name %></td>

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

@@ -1,100 +1,112 @@
-<h2><%= @actor.name %></h2>
+<h1><%= @actor.name %></h1>
+
+<section>
+  <%= render 'federails/client/followings/follow_actions', user: current_user, actor: @actor %>
+</section>
+
+<section>
+  <% if @actor.local? %>
+    <%= link_to 'All activities', federails.client_actor_activities_path(@actor) %>
+  <% elsif @actor.profile_url %>
+    <%= link_to 'Visit profile', @actor.profile_url %>
+  <% end %>
+</section>
+
+<section>
+  <h2>Actor details</h2>
+
+  <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>
 
-<% 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 %>
+    <b>Federation address:</b>
+    <%= @actor.at_address %>
+  </p>
+
+  <p>
+    <% if @actor.local? && @actor.entity_configuration[:profile_url_method] %>
+      <b>Home page:</b>
+      <%= link_to @actor.entity.send(@actor.entity_configuration[:username_field]),
+                  Rails.application.routes.url_helpers.send(@actor.entity_configuration[:profile_url_method], @actor.entity)
+      %>
+    <% elsif @actor.profile_url %>
+      <b>Federation profile URL (JSON):</b>
+      <%= link_to @actor.name, @actor.profile_url %>
     <% else %>
-      <%= button_to 'Follow!', federails.follow_client_followings_path, params: { account: @actor.at_address }, method: :post %>
+      (No homepage)
     <% 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 %>
+</section>
+
+<hr>
+
+<section>
+  <h2>Follows <small>(<em>Who is followed?</em>)</small></h2>
+
+  <% if @actor.following_follows.size.zero? %>
+    <p><%= @actor.username %> follows nothing</p>
   <% end %>
-</p>
 
-<p>
-  <b>Federation address:</b>
-  <%= @actor.at_address %>
-</p>
+  <% @actor.following_follows.each do |following| %>
+    <%= render 'federails/client/followings/follow', following: following %>
+  <% end %>
+</section>
 
-<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)
+<section>
+  <h2>Followers <small>(<em>Who follows?</em>)</small></h2>
+
+  <% if @actor.following_followers.size.zero? %>
+    <p>Nothing follows <%= @actor.username %></p>
   <% end %>
-</p>
 
-<hr>
+  <% @actor.following_followers.each do |following| %>
+    <%= render 'federails/client/followings/follower', following: following %>
+  <% end %>
+</section>
+
+<section>
+  <%# FIXME: Fetch distant content somehow  %>
+  <h2>10 last activities</h2>
 
-<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 %>
+  <% activities = @actor.activities.last(10) %>
+  <% if activities.size.zero? %>
+    <p>No activity to display</p>
+  <% end %>
+  <% activities.each do |activity| %>
+    <%= render 'federails/client/activities/activity', activity: activity %>
+  <% end %>
+</section>

data/app/views/federails/client/common/_client_links.html.erb

@@ -0,0 +1,24 @@
+Federation:
+
+<ul>
+  <%# Available publicly %>
+  <li><%= link_to 'Actors', federails.client_actors_url %></li>
+  <li><%= link_to 'Activities', federails.client_activities_url %></li>
+
+  <%# Available when user has an associated actor %>
+  <% if Federails::Client::ActivityPolicy.new(user, nil).feed? %>
+    <li><%= link_to 'Feed', federails.client_feed_url %></li>
+  <%end %>
+
+  <%# Available when user has an associated actor. The actor must exist to create the link %>
+  <% if Federails.actor_entity?(user) && user.actor.present? %>
+    <li><%= link_to "You (#{user.actor.username})", federails.client_actor_path(user.actor) %></li>
+  <% end %>
+</ul>
+
+<%# Debug information%>
+<% if !Federails::actor_entity?(user) %>
+  <p><%= user.class.name %> is not configured to have an associated actor; you won't be allowed to follow or be followed</p>
+<% elsif !user.actor.present? %>
+  <p>Your account does not have an associated actor; you won't be allowed to follow or be followed</p>
+<% end %>

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

@@ -0,0 +1,32 @@
+<%#
+  Displays buttons to follow/revoke following on a given actor.
+  Requires variables:
+    - user (usually user)
+    - actor (target actor)
+%>
+<p>
+  <% if Federails::Client::FollowingPolicy.new(user, Federails::Following).create? %>
+    <% follow = user.actor.follows? actor %>
+    <% if actor.entity == user %>
+      <button type="button" role="button" disabled="disabled">That's you</button>
+    <% elsif follow %>
+      Already following (<%= follow.status %>)
+      <%= button_to 'Cancel', federails.client_following_path(follow), method: :delete %>
+    <% else %>
+      <%= button_to "Follow #{actor.username}", federails.follow_client_followings_path, params: { account: actor.at_address }, method: :post %>
+    <% end %>
+
+    <% followed = actor.follows? user.actor %>
+    <% if followed %>
+      <% if followed.pending? %>
+        <%= actor.username %> wants to follow you.
+        <%= button_to 'Accept request', federails.accept_client_following_path(followed), method: :put %>
+      <% else %>
+        <%= actor.username %> follows you.
+        <%= button_to 'Revoke', federails.client_following_path(followed), method: :delete %>
+      <% end %>
+    <% end %>
+  <% else %>
+    <%= user.class.name %> is not configured to follow/be followed, or has no associated actor.
+  <% end %>
+</p>

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

@@ -1,4 +1,5 @@
 <%= form_for following, url: federails.client_following_url do |f| %>
+  <h1>DELETE ME</h1>
   <% if following.errors.any? %>
     <div class="error_explanation">
       <h2><%= pluralize(following.errors.count, 'error') %> prohibited this following from being saved:</h2>

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

@@ -1,7 +1,11 @@
-json.set! '@context', [
+actor_data = actor.entity.to_activitypub_object
+
+json.set! '@context', ([
   'https://www.w3.org/ns/activitystreams',
   'https://w3id.org/security/v1',
-]
+] + [
+  actor_data&.delete(:@context),
+].flatten).compact
 
 json.id actor.federated_url
 json.name actor.name
@@ -19,3 +23,4 @@ if actor.public_key
     json.publicKeyPem actor.public_key
   end
 end
+json.merge! actor_data

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

@@ -9,11 +9,12 @@ json.protocols [
 # 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.openRegistrations Federails::Configuration.open_registrations
+if @has_user_counts
+  json.usage users: {
+    total:          @total,
+    activeMonth:    @active_month,
+    activeHalfyear: @active_halfyear,
+  }
+end
 json.metadata({})

data/config/initializers/mime_types.rb

@@ -3,7 +3,7 @@ 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']
+Mime::Type.register 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"', :activitypub, ['application/activity+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

data/config/routes.rb

@@ -10,7 +10,11 @@ Federails::Engine.routes.draw do
 
   if Federails.configuration.client_routes_path
     scope Federails.configuration.client_routes_path, module: :client, as: :client do
-      resources :activities, only: [:index, :feed]
+      resources :activities, only: [:index] do
+        collection do
+          get :feed, to: 'activities#feed'
+        end
+      end
       resources :actors, only: [:index, :show] do
         collection do
           get :lookup, to: 'actors#lookup'
@@ -30,7 +34,7 @@ Federails::Engine.routes.draw do
     end
   end
 
-  scope Federails.configuration.server_routes_path, module: :server, as: :server do
+  scope Federails.configuration.server_routes_path, module: :server, as: :server, defaults: { format: :activitypub } do
     resources :actors, only: [:show] do
       member do
         get :followers

data/db/migrate/20200712133150_create_federails_actors.rb

@@ -11,14 +11,12 @@ class CreateFederailsActors < ActiveRecord::Migration[7.0]
       t.string :followings_url
       t.string :profile_url
 
-      t.references :user, null: true, foreign_key: { to_table: Federails.configuration.user_table }
+      t.integer :entity_id, null: true
+      t.string :entity_type, null: true
 
       t.timestamps
       t.index :federated_url, unique: true
+      t.index [:entity_type, :entity_id], name: 'index_federails_actors_on_entity', 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/lib/federails/configuration.rb

@@ -25,15 +25,14 @@ module Federails
     mattr_accessor :enable_discovery
     @@enable_discovery = true
 
-    # Site port
+    # Does the site allow open registrations? (only used for nodeinfo reporting)
+    mattr_accessor :open_registrations
+    @@open_registrations = false
+
+    # Application layout
     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
@@ -42,34 +41,14 @@ module Federails
     mattr_accessor :client_routes_path
     @@client_routes_path = :app
 
+    # Default controller to use as base for client controllers
+    mattr_accessor :base_client_controller
+    @@base_client_controller = 'ActionController::Base'
+
     # 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

data/lib/federails/version.rb

@@ -1,3 +1,3 @@
 module Federails
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.3.0'.freeze
 end

data/lib/federails.rb

@@ -23,15 +23,22 @@ module Federails
       :site_host,
       :site_port,
       :enable_discovery,
+      :open_registrations,
       :app_layout,
-      :user_class, # @deprecated
       :server_routes_path,
       :client_routes_path,
       :remote_follow_url_method,
-      :user_profile_url_method, # @deprecated
-      :user_name_field, # @deprecated
-      :user_username_field, # @deprecated
+      :base_client_controller,
     ].each { |key| Configuration.send :"#{key}=", config[key] if config.key?(key) }
   end
+
+  # @return [Boolean] True if the given model is a possible entity
+  #
+  # @example
+  #   puts "Follow #{some_actor.name}" if actor_entity? current_user
+  def self.actor_entity?(class_or_instance)
+    klass = class_or_instance.is_a?(Class) ? class_or_instance.name : class_or_instance.class.name
+    Configuration.entity_types.key? klass
+  end
 end
 # rubocop:enable Style/ClassVars

data/lib/fediverse/inbox.rb

@@ -2,34 +2,33 @@ require 'fediverse/request'
 
 module Fediverse
   class Inbox
+    @@handlers = {} # rubocop:todo Style/ClassVars
     class << self
+      def register_handler(activity_type, object_type, klass, method)
+        @@handlers[activity_type] ||= {}
+        @@handlers[activity_type][object_type] ||= {}
+        @@handlers[activity_type][object_type][klass] = method
+      end
+
       def dispatch_request(payload)
-        case payload['type']
-        when 'Create'
-          handle_create_request payload
-        when 'Follow'
-          handle_create_follow_request payload
-        when 'Accept'
-          handle_accept_request payload
-        when 'Undo'
-          handle_undo_request payload
-        else
-          # FIXME: Fails silently
-          # raise NotImplementedError
-          Rails.logger.debug { "Unhandled activity type: #{payload['type']}" }
+        handlers = get_handlers(payload['type'], payload['object'].is_a?(Hash) ? payload.dig('object', 'type') : nil)
+        handlers.each_pair do |klass, method|
+          klass.send method, payload
         end
+        return unless handlers.empty?
+
+        # FIXME: Fails silently
+        # raise NotImplementedError
+        Rails.logger.debug { "Unhandled activity type: #{payload['type']}" }
       end
 
       private
 
-      def handle_create_request(payload)
-        activity = Request.get(payload['object'])
-        case activity['type']
-        when 'Follow'
-          handle_create_follow_request activity
-        when 'Note'
-          handle_create_note activity
-        end
+      def get_handlers(activity_type, object_type)
+        {}.merge(@@handlers.dig(activity_type, object_type) || {})
+          .merge(@@handlers.dig(activity_type, '*') || {})
+          .merge(@@handlers.dig('*', '*') || {})
+          .merge(@@handlers.dig('*', object_type) || {})
       end
 
       def handle_create_follow_request(activity)
@@ -39,33 +38,30 @@ module Fediverse
         Federails::Following.create! actor: actor, target_actor: target_actor, federated_url: activity['id']
       end
 
-      def handle_create_note(activity)
-        actor = Federails::Actor.find_or_create_by_object activity['attributedTo']
-        Note.create! actor: actor, content: activity['content'], federated_url: activity['id']
-      end
+      def handle_accept_request(activity)
+        original_activity = Request.get(activity['object'])
 
-      def handle_accept_request(payload)
-        activity = Request.get(payload['object'])
-        raise "Can't accept things that are not Follow" unless activity['type'] == 'Follow'
-
-        actor        = Federails::Actor.find_or_create_by_object activity['actor']
-        target_actor = Federails::Actor.find_or_create_by_object activity['object']
-        raise 'Follow not accepted by target actor but by someone else' if payload['actor'] != target_actor.federated_url
+        actor        = Federails::Actor.find_or_create_by_object original_activity['actor']
+        target_actor = Federails::Actor.find_or_create_by_object original_activity['object']
+        raise 'Follow not accepted by target actor but by someone else' if activity['actor'] != target_actor.federated_url
 
         follow = Federails::Following.find_by actor: actor, target_actor: target_actor
         follow.accept!
       end
 
-      def handle_undo_request(payload)
-        activity = payload['object']
-        raise "Can't undo things that are not Follow" unless activity['type'] == 'Follow'
+      def handle_undo_request(activity)
+        original_activity = activity['object']
 
-        actor        = Federails::Actor.find_or_create_by_object activity['actor']
-        target_actor = Federails::Actor.find_or_create_by_object activity['object']
+        actor        = Federails::Actor.find_or_create_by_object original_activity['actor']
+        target_actor = Federails::Actor.find_or_create_by_object original_activity['object']
 
         follow = Federails::Following.find_by actor: actor, target_actor: target_actor
         follow&.destroy
       end
     end
+
+    register_handler 'Follow', '*', self, :handle_create_follow_request
+    register_handler 'Accept', 'Follow', self, :handle_accept_request
+    register_handler 'Undo', 'Follow', self, :handle_undo_request
   end
 end

data/lib/fediverse/notifier.rb

@@ -17,7 +17,7 @@ module Fediverse
       private
 
       def payload(activity)
-        Federails::ApplicationController.renderer.new.render(
+        Federails::ServerController.renderer.new.render(
           template: 'federails/server/activities/show',
           assigns:  { activity: activity },
           format:   :json

data/lib/generators/federails/copy_client_views/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Copies the client views to be overridden in main application
+
+Example:
+    bin/rails generate copy_client_views
+
+    This will create:
+        app/views/federails/client/**/*

data/lib/generators/federails/copy_client_views/copy_client_views_generator.rb

@@ -0,0 +1,9 @@
+module Federails
+  class CopyClientViewsGenerator < Rails::Generators::Base
+    source_root File.expand_path('../../../../app/views', __dir__)
+
+    def copy_views
+      directory 'federails/client', Rails.root.join('app', 'views', 'federails', 'client')
+    end
+  end
+end

data/lib/generators/federails/install/install_generator.rb

@@ -3,8 +3,8 @@ module Federails
     source_root File.expand_path('templates', __dir__)
 
     def copy_files
-      copy_file 'federails.yml', 'config/federails.yml'
-      copy_file 'federails.rb', 'config/initializers/federails.rb'
+      copy_file 'federails.yml', Rails.root.join('config', 'federails.yml')
+      copy_file 'federails.rb', Rails.root.join('config', 'initializers', 'federails.rb')
     end
   end
 end

data/lib/generators/federails/install/templates/federails.yml

@@ -6,9 +6,11 @@ defaults: &defaults
   site_host: http://localhost
   site_port: 3000
   enable_discovery: true
+  open_registrations: false
   app_layout: 'layouts/application'
   server_routes_path: federation
   client_routes_path: app
+  #base_client_controller: ::ActionController::Base
 
 development:
   <<: *defaults

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: federails
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Manuel Tancoigne
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-13 00:00:00.000000000 Z
+date: 2024-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -119,17 +119,17 @@ files:
 - Rakefile
 - app/assets/config/federails_manifest.js
 - app/assets/stylesheets/federails/application.css
-- app/controllers/federails/application_controller.rb
 - app/controllers/federails/client/activities_controller.rb
 - app/controllers/federails/client/actors_controller.rb
 - app/controllers/federails/client/followings_controller.rb
+- app/controllers/federails/client_controller.rb
 - app/controllers/federails/server/activities_controller.rb
 - app/controllers/federails/server/actors_controller.rb
 - app/controllers/federails/server/followings_controller.rb
 - app/controllers/federails/server/nodeinfo_controller.rb
-- app/controllers/federails/server/server_controller.rb
 - app/controllers/federails/server/web_finger_controller.rb
-- app/helpers/federails/application_helper.rb
+- app/controllers/federails/server_controller.rb
+- app/helpers/federails/server_helper.rb
 - app/jobs/federails/application_job.rb
 - app/jobs/federails/notify_inbox_job.rb
 - app/mailers/federails/application_mailer.rb
@@ -159,7 +159,9 @@ files:
 - app/views/federails/client/actors/index.json.jbuilder
 - app/views/federails/client/actors/show.html.erb
 - app/views/federails/client/actors/show.json.jbuilder
+- app/views/federails/client/common/_client_links.html.erb
 - app/views/federails/client/followings/_follow.html.erb
+- app/views/federails/client/followings/_follow_actions.html.erb
 - app/views/federails/client/followings/_follower.html.erb
 - app/views/federails/client/followings/_following.json.jbuilder
 - app/views/federails/client/followings/_form.html.erb
@@ -185,7 +187,6 @@ files:
 - db/migrate/20200712133150_create_federails_actors.rb
 - db/migrate/20200712143127_create_federails_followings.rb
 - db/migrate/20200712174938_create_federails_activities.rb
-- db/migrate/20240731145400_change_actor_entity_rel_to_polymorphic.rb
 - db/migrate/20241002094500_add_uuids.rb
 - db/migrate/20241002094501_add_keypair_to_actors.rb
 - lib/federails.rb
@@ -198,6 +199,8 @@ files:
 - lib/fediverse/request.rb
 - lib/fediverse/signature.rb
 - lib/fediverse/webfinger.rb
+- lib/generators/federails/copy_client_views/USAGE
+- lib/generators/federails/copy_client_views/copy_client_views_generator.rb
 - lib/generators/federails/install/USAGE
 - lib/generators/federails/install/install_generator.rb
 - lib/generators/federails/install/templates/federails.rb
@@ -227,7 +230,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.15
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: An ActivityPub engine for Ruby on Rails

data/app/controllers/federails/server/server_controller.rb

@@ -1,17 +0,0 @@
-module Federails
-  module Server
-    class ServerController < Federails::ApplicationController
-      protect_from_forgery with: :null_session
-
-      # def policy_scope(scope, policy_scope_class: nil)
-      #   scope = [scope, :server] unless policy_scope_class
-      #   super(scope, policy_scope_class: policy_scope_class)
-      # end
-
-      # def authorize(record, query = nil, policy_class: nil)
-      #   record = [:server, record] unless policy_class
-      #   super(record, query, policy_class: policy_class)
-      # end
-    end
-  end
-end

data/db/migrate/20240731145400_change_actor_entity_rel_to_polymorphic.rb

@@ -1,11 +0,0 @@
-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