federails 0.0.1 → 0.1.0

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.json.jbuilder

@@ -0,0 +1,9 @@
+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]
+json.object activity.entity.federated_url

data/app/views/federails/server/activities/outbox.json.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.json.jbuilder

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

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

@@ -0,0 +1,11 @@
+json.set! '@context', 'https://www.w3.org/ns/activitystreams'
+
+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

data/app/views/federails/server/actors/followers.json.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.json.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.json.jbuilder

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

data/app/views/federails/server/followings/_following.json.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.json.jbuilder

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

data/app/views/federails/server/nodeinfo/index.json.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.json.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.json.jbuilder

@@ -0,0 +1,20 @@
+json.subject params[:resource]
+
+links = [
+  # Federation actor URL
+  {
+    rel:  'self',
+    type: 'application/activity+json',
+    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
+
+json.links links

data/app/views/federails/server/web_finger/host_meta.xml.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/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: [: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/lib/federails/configuration.rb

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

data/lib/federails/utils/host.rb

@@ -0,0 +1,54 @@
+module Federails
+  module Utils
+    class Host
+      class << self
+        COMMON_PORTS = [80, 443].freeze
+
+        ##
+        # @return [String] Host and port of the current instance
+        def localhost
+          uri = URI.parse Federails.configuration.site_host
+          host_and_port (uri.host || 'localhost'), Federails.configuration.site_port
+        end
+
+        ##
+        # Checks if the given URL points somewhere on current instance
+        #
+        # @param url [String] URL to check
+        #
+        # @return [true, false]
+        def local_url?(url)
+          uri = URI.parse url
+          host = host_and_port uri.host, uri.port
+          localhost == host
+        end
+
+        ##
+        # Gets the route on the current instance, or nil
+        #
+        # @param url [String] URL to check
+        #
+        # @return [ActionDispatch::Routing::RouteSet, nil] nil when URL do not match a route
+        def local_route(url)
+          return nil unless local_url? url
+
+          Rails.application.routes.recognize_path(url)
+        rescue ActionController::RoutingError
+          nil
+        end
+
+        private
+
+        def host_and_port(host, port)
+          port_string = if port.present? && COMMON_PORTS.exclude?(port)
+                          ":#{port}"
+                        else
+                          ''
+                        end
+
+          "#{host}#{port_string}"
+        end
+      end
+    end
+  end
+end

data/lib/federails/version.rb

@@ -1,3 +1,3 @@
 module Federails
-  VERSION = "0.0.1"
+  VERSION = '0.1.0'.freeze
 end

data/lib/federails.rb

@@ -1,6 +1,36 @@
-require "federails/version"
-require "federails/engine"
+require 'federails/version'
+require 'federails/engine'
+require 'federails/configuration'
 
+# rubocop:disable Style/ClassVars
 module Federails
-  # Your code goes here...
+  mattr_reader :configuration
+  @@configuration = Configuration
+
+  # Make factories available
+  config.factory_bot.definition_file_paths += [File.expand_path('spec/factories', __dir__)] if defined?(FactoryBotRails)
+
+  def self.configure
+    yield @@configuration
+  end
+
+  def self.config_from(name) # rubocop:disable Metrics/MethodLength
+    config = Rails.application.config_for name
+    [
+      :app_name,
+      :app_version,
+      :force_ssl,
+      :site_host,
+      :site_port,
+      :enable_discovery,
+      :app_layout,
+      :user_class, # @deprecated
+      :server_routes_path,
+      :client_routes_path,
+      :user_profile_url_method, # @deprecated
+      :user_name_field, # @deprecated
+      :user_username_field, # @deprecated
+    ].each { |key| Configuration.send :"#{key}=", config[key] }
+  end
 end
+# rubocop:enable Style/ClassVars

data/lib/fediverse/inbox.rb

@@ -0,0 +1,71 @@
+require 'fediverse/request'
+
+module Fediverse
+  class Inbox
+    class << self
+      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']}" }
+        end
+      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
+      end
+
+      def handle_create_follow_request(activity)
+        actor        = Federails::Actor.find_or_create_by_object activity['actor']
+        target_actor = Federails::Actor.find_or_create_by_object activity['object']
+
+        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(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
+
+        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'
+
+        actor        = Federails::Actor.find_or_create_by_object activity['actor']
+        target_actor = Federails::Actor.find_or_create_by_object activity['object']
+
+        follow = Federails::Following.find_by actor: actor, target_actor: target_actor
+        follow&.destroy
+      end
+    end
+  end
+end

data/lib/fediverse/notifier.rb

@@ -0,0 +1,21 @@
+module Fediverse
+  class Notifier
+    class << self
+      def post_to_inboxes(activity)
+        actors = activity.recipients
+
+        Rails.logger.debug('Nobody to notice') && return if actors.count.zero?
+
+        message = Federails::ApplicationController.renderer.new.render(
+          template: 'federails/server/activities/show',
+          assigns:  { activity: activity },
+          format:   :json
+        )
+        actors.each do |actor|
+          Rails.logger.debug { "Sending activity ##{activity.id} to #{actor.inbox_url}" }
+          Faraday.post actor.inbox_url, message, 'Content-Type' => 'application/json', 'Accept' => 'application/json'
+        end
+      end
+    end
+  end
+end

data/lib/fediverse/request.rb

@@ -0,0 +1,38 @@
+require 'json/ld'
+
+module Fediverse
+  class Request
+    BASE_HEADERS = {
+      'Content-Type' => 'application/json',
+      'Accept'       => 'application/json',
+    }.freeze
+
+    def initialize(id)
+      @id = id
+    end
+
+    def get
+      Rails.logger.debug { "GET #{@id}" }
+      @response = Faraday.get(@id, nil, BASE_HEADERS)
+      response_to_json
+    end
+
+    class << self
+      def get(id)
+        new(id).get
+      end
+    end
+
+    private
+
+    def response_to_json
+      begin
+        body = JSON.parse @response.body
+      rescue JSON::ParserError
+        return
+      end
+
+      JSON::LD::API.compact body, body['@context']
+    end
+  end
+end