fedipub 0.0.1 → 0.9.0

data/lib/fediverse/webfinger.rb

@@ -0,0 +1,140 @@
+require 'fedipub/utils/host'
+require 'fedipub/utils/json_request'
+
+module Fediverse
+  # Methods related to Webfinger: find accounts, fetch actors,...
+  class Webfinger
+    class << self
+      ACCOUNT_REGEX = /(?<username>[a-z0-9\-_.]+)(?:@(?<domain>.*))?/
+
+      # Extracts username and domain from an account string.
+      # Accepts forms "user@domain", "@user@domain" and "acct:user@domain"
+      #
+      # @param account [String] Account string
+      #
+      # @return [MatchData, nil] Matches with +:username+ and +:domain+ or +nil+
+      def split_account(account)
+        /\A(acct:|@)?#{ACCOUNT_REGEX}\z/io.match account
+      end
+
+      # Determines if a given account string should be a local account (same host as configured one)
+      #
+      # @param hash [Hash, MatchData] Object with +:username+ and +:domain+ keys
+      #
+      # @return [Boolean]
+      def local_user?(hash)
+        hash[:username] && (hash[:domain].nil? || (hash[:domain] == Fedipub::Utils::Host.localhost))
+      end
+
+      # Fetches a distant actor
+      #
+      # @param username [String]
+      # @param domain [String]
+      #
+      # @return [Fedipub::Actor, nil] Fedipub actor or nothing when not found
+      def fetch_actor(username, domain)
+        fetch_actor_url webfinger(username, domain)
+      end
+
+      # Fetches an actor given its URL
+      #
+      # @param url [String] Actor's federation URL
+      #
+      # @return [Fedipub::Actor, nil] Fedipub actor or nothing when not found
+      def fetch_actor_url(url)
+        webfinger_to_actor get_json url
+      end
+
+      # Gets the real actor's federation URL from its username and domain
+      #
+      # @param username [String]
+      # @param domain [String]
+      #
+      # @return [String, nil] Federation URL if found
+      def webfinger(username, domain)
+        json = webfinger_response(username, domain)
+        link = json['links'].find { |l| Mime::Type.lookup(l['type']).to_sym == :activitypub }
+
+        link['href'] if link
+      end
+
+      # Returns remote follow link template, or complete link if actor_url is provided
+      #
+      # @param username [String]
+      # @param domain [String]
+      # @param actor_url [String] Optional Federation URL to provide when known
+      #
+      # @return [String] The URL to use as follow URL
+      def remote_follow_url(username, domain, actor_url: nil)
+        json = webfinger_response(username, domain)
+        link = json['links'].find { |l| l['rel'] == 'http://ostatus.org/schema/1.0/subscribe' }
+        return nil if link&.dig('template').nil?
+
+        if actor_url
+          link['template'].gsub('{uri}', CGI.escape(actor_url))
+        else
+          link['template']
+        end
+      end
+
+      private
+
+      # Makes a webfinger request for a given username/domain
+      # @return [Hash] Webfinger response's content
+      def webfinger_response(username, domain)
+        scheme = Fedipub.configuration.force_ssl ? 'https' : 'http'
+        get_json "#{scheme}://#{domain}/.well-known/webfinger", resource: "acct:#{username}@#{domain}"
+      end
+
+      # Extracts the server and port from a string, omitting common ports
+      # @return [String] Server and port
+      def server_and_port(string)
+        uri = URI.parse string
+        if uri.port && [80, 443].exclude?(uri.port)
+          "#{uri.host}:#{uri.port}"
+        else
+          uri.host
+        end
+      end
+
+      # Builds a +Fedipub::Actor+ from a Webfinger response
+      # @param data [Hash] Webfinger response
+      # @return [Fedipub::Actor]
+      def webfinger_to_actor(data) # rubocop:disable Metrics/MethodLength
+        data = data.clone
+        id = data.delete('id')
+        Fedipub::Actor.new federated_url:  id,
+                           username:       data.delete('preferredUsername'),
+                           actor_type:     data.delete('type'),
+                           name:           data.delete('name'),
+                           server:         server_and_port(id),
+                           inbox_url:      data.delete('inbox'),
+                           outbox_url:     data.delete('outbox'),
+                           followers_url:  data.delete('followers'),
+                           followings_url: data.delete('following'),
+                           profile_url:    data.delete('url'),
+                           public_key:     data.delete('publicKey')&.dig('publicKeyPem'),
+                           extensions:     data.except('@context')
+      end
+
+      # Makes a simple GET request and returns a +Hash+ from the parsed body
+      # @return [Hash]
+      # @raise [ActiveRecord::RecordNotFound] when the response is invalid
+      def get_json(url, params = {})
+        Fedipub::Utils::JsonRequest.get_json(url, params: params, follow_redirects: true, headers: { accept: 'application/json' })
+      rescue Fedipub::Utils::JsonRequest::UnhandledResponseStatus => e
+        Rails.logger.debug { e.message }
+
+        raise ActiveRecord::RecordNotFound
+      rescue Faraday::ConnectionFailed
+        Rails.logger.debug { "Failed to reach server for GET #{url}" }
+
+        raise ActiveRecord::RecordNotFound
+      rescue JSON::ParserError
+        Rails.logger.debug { "Invalid JSON response for GET #{url}" }
+
+        raise ActiveRecord::RecordNotFound
+      end
+    end
+  end
+end

data/lib/fediverse.rb

@@ -0,0 +1,5 @@
+require 'fediverse/collection'
+
+# This module includes classes and helpers to interact with the Fediverse.
+module Fediverse
+end

data/lib/generators/fedipub/copy_client_policies/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Copies the Pundit client policies to be overridden in main application.
+
+Example:
+    bin/rails generate copy_client_policies
+
+    This will create:
+        app/policies/fedipub/client/*

data/lib/generators/fedipub/copy_client_policies/copy_client_policies_generator.rb

@@ -0,0 +1,9 @@
+module Fedipub
+  class CopyClientPoliciesGenerator < Rails::Generators::Base
+    source_root File.expand_path('../../../../app/policies/fedipub', __dir__)
+
+    def copy_policies
+      directory 'client', Rails.root.join('app', 'policies', 'fedipub', 'client')
+    end
+  end
+end

data/lib/generators/fedipub/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/fedipub/client/**/*

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

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

data/lib/generators/fedipub/copy_factories/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Copies FactoryBot factories in the "spec" directory
+
+Example:
+    bin/rails generate copy_factories
+
+    This will create:
+        spec/factories/*

data/lib/generators/fedipub/copy_factories/copy_factories_generator.rb

@@ -0,0 +1,43 @@
+module Fedipub
+  class CopyFactoriesGenerator < Rails::Generators::Base
+    SOURCE_DIRECTORY = File.expand_path('../../../../spec/factories/fedipub', __dir__)
+    FACTORY_DEFINITION_REGEX = /(FactoryBot.define do\n\s+factory) :(\w+),/
+
+    source_root SOURCE_DIRECTORY
+
+    def initialize
+      super
+      @files = []
+      @factories = []
+    end
+
+    def copy_factories
+      dest = Rails.root.join('spec', 'factories')
+
+      Dir.entries(SOURCE_DIRECTORY).each do |node|
+        source_path = File.join(SOURCE_DIRECTORY, node)
+        next unless File.file?(source_path) && node.match?(/\.rb\Z/)
+
+        file_path = File.join(dest, "fedipub_#{node}")
+        copy_file node, file_path
+        @files << file_path
+        @factories << File.read(file_path).match(FACTORY_DEFINITION_REGEX)&.[](2)
+      end
+
+      substitute_values!
+    end
+
+    private
+
+    def substitute_values!
+      @factories.compact!
+      @files.each do |file|
+        gsub_file file, FACTORY_DEFINITION_REGEX, '\1 :fedipub_\2,'
+
+        @factories.each do |factory|
+          gsub_file file, ":#{factory}", ":fedipub_#{factory}"
+        end
+      end
+    end
+  end
+end

data/lib/generators/fedipub/install/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Copies configuration file and initializer
+
+Example:
+    bin/rails generate fedipub:install
+
+    This will create:
+        config/fedipub.yml
+        config/initializers/fedipub.rb

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

@@ -0,0 +1,10 @@
+module Fedipub
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+
+    def copy_files
+      copy_file 'fedipub.yml', Rails.root.join('config', 'fedipub.yml')
+      copy_file 'fedipub.rb', Rails.root.join('config', 'initializers', 'fedipub.rb')
+    end
+  end
+end

data/lib/generators/fedipub/install/templates/fedipub.rb

@@ -0,0 +1 @@
+Fedipub.config_from 'fedipub'

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

@@ -0,0 +1,27 @@
+---
+defaults: &defaults
+  app_name:
+  app_version:
+  force_ssl: false
+  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
+  job_queue: default
+  #remote_entities_cache_duration: 86400 # 1 day in seconds
+  #base_client_controller: ::ActionController::Base
+
+development:
+  <<: *defaults
+
+test:
+  <<: *defaults
+  site_port: null
+
+production:
+  <<: *defaults
+  force_ssl: true
+  site_port: 443

data/lib/tasks/factory_bot.rake

@@ -0,0 +1,15 @@
+namespace :factory_bot do
+  desc 'Verify that all FactoryBot factories are valid'
+  task lint: :environment do
+    if Rails.env.test?
+      conn = ActiveRecord::Base.connection
+      conn.transaction do
+        FactoryBot.lint traits: true
+        raise ActiveRecord::Rollback
+      end
+    else
+      system("bundle exec rake app:factory_bot:lint RAILS_ENV='test'")
+      raise if $CHILD_STATUS.exitstatus.nonzero?
+    end
+  end
+end

data/lib/tasks/fedipub_tasks.rake

@@ -0,0 +1,13 @@
+namespace :fedipub do
+  desc 'Re-fetches every remote actors to update database'
+  task sync_actors: :environment do
+    Fedipub::Maintenance::ActorUpdater.run do |actor, status|
+      puts "#{actor.federated_url}: #{status}"
+    end
+  end
+
+  desc 'Re-fetches every host and completes missing ones'
+  task sync_hosts: :environment do
+    Fedipub::Maintenance::HostsUpdater.run
+  end
+end

metadata

@@ -1,15 +1,140 @@
 --- !ruby/object:Gem::Specification
 name: fedipub
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Manuel Tancoigne
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-07-20 00:00:00.000000000 Z
-dependencies: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday-follow_redirects
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jbuilder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: json-ld
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: json-ld-preloaded
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+- !ruby/object:Gem::Dependency
+  name: pundit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.2.0
 description: An ActivityPub engine for Ruby on Rails
 email:
 - manu@experimentslabs.com
@@ -20,17 +145,142 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- app/assets/config/fedipub_manifest.js
+- app/assets/stylesheets/fedipub/application.css
+- app/controllers/concerns/fedipub/server/render_collections.rb
+- app/controllers/fedipub/client/activities_controller.rb
+- app/controllers/fedipub/client/actors_controller.rb
+- app/controllers/fedipub/client/followings_controller.rb
+- app/controllers/fedipub/client_controller.rb
+- app/controllers/fedipub/server/activities_controller.rb
+- app/controllers/fedipub/server/actors_controller.rb
+- app/controllers/fedipub/server/followings_controller.rb
+- app/controllers/fedipub/server/nodeinfo_controller.rb
+- app/controllers/fedipub/server/published_controller.rb
+- app/controllers/fedipub/server/web_finger_controller.rb
+- app/controllers/fedipub/server_controller.rb
+- app/helpers/fedipub/server_helper.rb
+- app/jobs/fedipub/application_job.rb
+- app/jobs/fedipub/fetch_nodeinfo_job.rb
+- app/jobs/fedipub/notify_inbox_job.rb
+- app/mailers/fedipub/application_mailer.rb
+- app/models/concerns/fedipub/actor_entity.rb
+- app/models/concerns/fedipub/announceable.rb
+- app/models/concerns/fedipub/data_entity.rb
+- app/models/concerns/fedipub/handles_delete_requests.rb
+- app/models/concerns/fedipub/has_uuid.rb
+- app/models/concerns/fedipub/likeable.rb
+- app/models/fedipub/activity.rb
+- app/models/fedipub/actor.rb
+- app/models/fedipub/application_record.rb
+- app/models/fedipub/following.rb
+- app/models/fedipub/host.rb
+- app/policies/fedipub/client/activity_policy.rb
+- app/policies/fedipub/client/actor_policy.rb
+- app/policies/fedipub/client/following_policy.rb
+- app/policies/fedipub/fedipub_policy.rb
+- app/policies/fedipub/server/activity_policy.rb
+- app/policies/fedipub/server/actor_policy.rb
+- app/policies/fedipub/server/following_policy.rb
+- app/policies/fedipub/server/publishable_policy.rb
+- app/views/fedipub/client/activities/_activity.html.erb
+- app/views/fedipub/client/activities/_activity.json.jbuilder
+- app/views/fedipub/client/activities/_index.json.jbuilder
+- app/views/fedipub/client/activities/feed.html.erb
+- app/views/fedipub/client/activities/feed.json.jbuilder
+- app/views/fedipub/client/activities/index.html.erb
+- app/views/fedipub/client/activities/index.json.jbuilder
+- app/views/fedipub/client/actors/_actor.json.jbuilder
+- app/views/fedipub/client/actors/_lookup_form.html.erb
+- app/views/fedipub/client/actors/gone.html.erb
+- app/views/fedipub/client/actors/index.html.erb
+- app/views/fedipub/client/actors/index.json.jbuilder
+- app/views/fedipub/client/actors/show.html.erb
+- app/views/fedipub/client/actors/show.json.jbuilder
+- app/views/fedipub/client/common/_client_links.html.erb
+- app/views/fedipub/client/followings/_follow.html.erb
+- app/views/fedipub/client/followings/_follow_actions.html.erb
+- app/views/fedipub/client/followings/_follower.html.erb
+- app/views/fedipub/client/followings/_following.json.jbuilder
+- app/views/fedipub/client/followings/_form.html.erb
+- app/views/fedipub/client/followings/index.html.erb
+- app/views/fedipub/client/followings/index.json.jbuilder
+- app/views/fedipub/client/followings/show.html.erb
+- app/views/fedipub/client/followings/show.json.jbuilder
+- app/views/fedipub/server/activities/_activity.activitypub.jbuilder
+- app/views/fedipub/server/activities/show.activitypub.jbuilder
+- app/views/fedipub/server/actors/_actor.activitypub.jbuilder
+- app/views/fedipub/server/actors/_tombstone.activitypub.jbuilder
+- app/views/fedipub/server/actors/show.activitypub.jbuilder
+- app/views/fedipub/server/followings/_following.activitypub.jbuilder
+- app/views/fedipub/server/followings/show.activitypub.jbuilder
+- app/views/fedipub/server/nodeinfo/index.nodeinfo.jbuilder
+- app/views/fedipub/server/nodeinfo/show.nodeinfo.jbuilder
+- app/views/fedipub/server/published/_publishable.activitypub.jbuilder
+- app/views/fedipub/server/published/_tombstone.activitypub.jbuilder
+- app/views/fedipub/server/published/show.activitypub.jbuilder
+- app/views/fedipub/server/shared/ordered_collection.activitypub.jbuilder
+- app/views/fedipub/server/shared/ordered_collection_page.activitypub.jbuilder
+- app/views/fedipub/server/web_finger/find.jrd.jbuilder
+- app/views/fedipub/server/web_finger/host_meta.xrd.erb
+- app/views/users/show.html.erb
+- config/initializers/mime_types.rb
+- config/initializers/security_vocab.rb
+- config/routes.rb
+- db/migrate/20200712133150_create_federails_actors.rb
+- db/migrate/20200712143127_create_federails_followings.rb
+- db/migrate/20200712174938_create_federails_activities.rb
+- db/migrate/20241002094500_add_uuids.rb
+- db/migrate/20241002094501_add_keypair_to_actors.rb
+- db/migrate/20250122160618_add_extensions_to_federails_actors.rb
+- db/migrate/20250301082500_add_local_to_actors.rb
+- db/migrate/20250329123939_add_actor_type_to_actors.rb
+- db/migrate/20250329123940_add_tombstoned_at_to_actors.rb
+- db/migrate/20250426061729_create_federails_hosts.rb
+- db/migrate/20251121160720_add_to_and_cc_to_federails_activities.rb
+- db/migrate/20260421170640_add_result_and_instrument_to_federails_activities.rb
+- db/migrate/20260723113716_rename_federails_to_fedipub.rb
 - lib/fedipub.rb
+- lib/fedipub/configuration.rb
+- lib/fedipub/data_transformer/note.rb
+- lib/fedipub/engine.rb
+- lib/fedipub/maintenance/actors_updater.rb
+- lib/fedipub/maintenance/hosts_updater.rb
+- lib/fedipub/utils/actor.rb
+- lib/fedipub/utils/context.rb
+- lib/fedipub/utils/host.rb
+- lib/fedipub/utils/json_request.rb
+- lib/fedipub/utils/object.rb
+- lib/fedipub/utils/response_codes.rb
 - lib/fedipub/version.rb
-homepage: https://gitlab.com/fedipub/fedipub/
+- lib/fediverse.rb
+- lib/fediverse/collection.rb
+- lib/fediverse/inbox.rb
+- lib/fediverse/node_info.rb
+- lib/fediverse/notifier.rb
+- lib/fediverse/request.rb
+- lib/fediverse/signature.rb
+- lib/fediverse/webfinger.rb
+- lib/generators/fedipub/copy_client_policies/USAGE
+- lib/generators/fedipub/copy_client_policies/copy_client_policies_generator.rb
+- lib/generators/fedipub/copy_client_views/USAGE
+- lib/generators/fedipub/copy_client_views/copy_client_views_generator.rb
+- lib/generators/fedipub/copy_factories/USAGE
+- lib/generators/fedipub/copy_factories/copy_factories_generator.rb
+- lib/generators/fedipub/install/USAGE
+- lib/generators/fedipub/install/install_generator.rb
+- lib/generators/fedipub/install/templates/fedipub.rb
+- lib/generators/fedipub/install/templates/fedipub.yml
+- lib/tasks/factory_bot.rake
+- lib/tasks/fedipub_tasks.rake
+homepage: https://experimentslabs.com
 licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-  homepage_uri: https://gitlab.com/fedipub/fedipub/
+  homepage_uri: https://experimentslabs.com
   source_code_uri: https://gitlab.com/fedipub/fedipub/
   changelog_uri: https://gitlab.com/fedipub/fedipub/-/blob/main/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -38,15 +288,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.2
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: An ActivityPub engine for Ruby on Rails
 test_files: []