federails 0.4.0 → 0.6.0

data/lib/fediverse/request.rb

@@ -11,6 +11,7 @@ module Fediverse
       @id = id
     end
 
+    # FIXME: Replace by `Webfinger.get_json` (move other method here as class method)
     def get
       Rails.logger.debug { "GET #{@id}" }
       @response = Faraday.get(@id, nil, BASE_HEADERS)
@@ -21,6 +22,18 @@ module Fediverse
       def get(id)
         new(id).get
       end
+
+      # Dereferences a value
+      #
+      # @param value [String, Hash]
+      #
+      # @return [Hash, nil]
+      def dereference(value)
+        return value if value.is_a? Hash
+        return get(value) if value.is_a? String
+
+        raise "Unhandled object type #{value.class}"
+      end
     end
 
     private

data/lib/fediverse/webfinger.rb

@@ -4,39 +4,69 @@ require 'faraday/follow_redirects'
 require 'federails/utils/host'
 
 module Fediverse
+  # Methods related to Webfinger: find accounts, fetch actors,...
   class Webfinger
     class << self
       ACCOUNT_REGEX = /(?<username>[a-z0-9\-_.]+)(?:@(?<domain>.*))?/
 
-      def split_resource_account(account)
-        /\Aacct:#{ACCOUNT_REGEX}\z/io.match account
-      end
-
+      # 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#{ACCOUNT_REGEX}\z/io.match account
+        /\A(acct:|@)?#{ACCOUNT_REGEX}\z/io.match account
       end
 
-      def local_user?(account)
-        account[:username] && (account[:domain].nil? || (account[:domain] == Federails::Utils::Host.localhost))
+      # 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] == Federails::Utils::Host.localhost))
       end
 
+      # Fetches a distant actor
+      #
+      # @param username [String]
+      # @param domain [String]
+      #
+      # @return [Federails::Actor, nil] Federails 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 [Federails::Actor, nil] Federails actor or nothing when not found
       def fetch_actor_url(url)
         webfinger_to_actor get_json url
       end
 
-      # Returns actor id
+      # 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| l['type'] == 'application/activity+json' }
+        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' }
@@ -51,13 +81,17 @@ module Fediverse
 
       private
 
+      # Makes a webfinger request for a given username/domain
+      # @return [Hash] Webfinger response's content
       def webfinger_response(username, domain)
         scheme = Federails.configuration.force_ssl ? 'https' : 'http'
         get_json "#{scheme}://#{domain}/.well-known/webfinger", resource: "acct:#{username}@#{domain}"
       end
 
-      def server_and_port(id)
-        uri = URI.parse id
+      # 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
@@ -65,19 +99,29 @@ module Fediverse
         end
       end
 
-      def webfinger_to_actor(data)
-        Federails::Actor.new federated_url:  data['id'],
-                             username:       data['preferredUsername'],
-                             name:           data['name'],
-                             server:         server_and_port(data['id']),
-                             inbox_url:      data['inbox'],
-                             outbox_url:     data['outbox'],
-                             followers_url:  data['followers'],
-                             followings_url: data['following'],
-                             profile_url:    data['url'],
-                             public_key:     data.dig('publicKey', 'publicKeyPem')
+      # Builds a +Federails::Actor+ from a Webfinger response
+      # @param data [Hash] Webfinger response
+      # @return [Federails::Actor]
+      def webfinger_to_actor(data) # rubocop:disable Metrics/MethodLength
+        data = data.clone
+        id = data.delete('id')
+        Federails::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, payload = {})
         response = get(url, payload: payload, headers: { accept: 'application/json' })
 
@@ -93,10 +137,12 @@ module Fediverse
         raise ActiveRecord::RecordNotFound
       end
 
-      # Only perform a GET request and throws an ActiveRecord::RecordNotFound
-      # on error.
-      # That's "ok-ish"; when an actor is unavailable, whatever the reason is, it's
-      # not found...
+      # Only perform a GET request and throws an ActiveRecord::RecordNotFound on error.
+      #
+      # That's "ok-ish"; when an actor is unavailable, whatever the reason is, it's not found...
+      #
+      # @return [Faraday::Response]
+      # @raise [ActiveRecord::RecordNotFound] when the response is invalid
       def get(url, payload: {}, headers: {})
         connection = Faraday.new url: url, params: payload, headers: headers do |faraday|
           faraday.response :follow_redirects # use Faraday::FollowRedirects::Middleware

data/lib/fediverse.rb

@@ -0,0 +1,3 @@
+# This module includes classes and helpers to interact with the Fediverse.
+module Fediverse
+end

data/lib/tasks/federails_tasks.rake

@@ -1,4 +1,8 @@
-# desc "Explaining what the task does"
-# task :federails do
-#   # Task goes here
-# end
+namespace :federails do
+  desc 'Re-fetches every remote actors to update database'
+  task sync_actors: :environment do
+    Federails::Maintenance::ActorUpdater.run do |actor, status|
+      puts "#{actor.federated_url}: #{status}"
+    end
+  end
+end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: federails
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Manuel Tancoigne
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-02 00:00:00.000000000 Z
+date: 2025-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -115,6 +114,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
 - README.md
 - Rakefile
 - app/assets/config/federails_manifest.js
@@ -127,6 +127,7 @@ files:
 - 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/published_controller.rb
 - app/controllers/federails/server/web_finger_controller.rb
 - app/controllers/federails/server_controller.rb
 - app/helpers/federails/server_helper.rb
@@ -134,6 +135,8 @@ files:
 - app/jobs/federails/notify_inbox_job.rb
 - app/mailers/federails/application_mailer.rb
 - app/models/concerns/federails/actor_entity.rb
+- app/models/concerns/federails/data_entity.rb
+- app/models/concerns/federails/handles_delete_requests.rb
 - app/models/concerns/federails/has_uuid.rb
 - app/models/federails/activity.rb
 - app/models/federails/actor.rb
@@ -146,6 +149,7 @@ files:
 - app/policies/federails/server/activity_policy.rb
 - app/policies/federails/server/actor_policy.rb
 - app/policies/federails/server/following_policy.rb
+- app/policies/federails/server/publishable_policy.rb
 - app/views/federails/client/activities/_activity.html.erb
 - app/views/federails/client/activities/_activity.json.jbuilder
 - app/views/federails/client/activities/_index.json.jbuilder
@@ -155,6 +159,7 @@ files:
 - app/views/federails/client/activities/index.json.jbuilder
 - app/views/federails/client/actors/_actor.json.jbuilder
 - app/views/federails/client/actors/_lookup_form.html.erb
+- app/views/federails/client/actors/gone.html.erb
 - app/views/federails/client/actors/index.html.erb
 - app/views/federails/client/actors/index.json.jbuilder
 - app/views/federails/client/actors/show.html.erb
@@ -173,6 +178,7 @@ files:
 - app/views/federails/server/activities/outbox.activitypub.jbuilder
 - app/views/federails/server/activities/show.activitypub.jbuilder
 - app/views/federails/server/actors/_actor.activitypub.jbuilder
+- app/views/federails/server/actors/_tombstone.activitypub.jbuilder
 - app/views/federails/server/actors/followers.activitypub.jbuilder
 - app/views/federails/server/actors/following.activitypub.jbuilder
 - app/views/federails/server/actors/show.activitypub.jbuilder
@@ -180,6 +186,9 @@ files:
 - app/views/federails/server/followings/show.activitypub.jbuilder
 - app/views/federails/server/nodeinfo/index.nodeinfo.jbuilder
 - app/views/federails/server/nodeinfo/show.nodeinfo.jbuilder
+- app/views/federails/server/published/_publishable.activitypub.jbuilder
+- app/views/federails/server/published/_tombstone.activitypub.jbuilder
+- app/views/federails/server/published/show.activitypub.jbuilder
 - app/views/federails/server/web_finger/find.jrd.jbuilder
 - app/views/federails/server/web_finger/host_meta.xrd.erb
 - config/initializers/mime_types.rb
@@ -189,11 +198,20 @@ files:
 - 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
 - lib/federails.rb
 - lib/federails/configuration.rb
+- lib/federails/data_transformer/note.rb
 - lib/federails/engine.rb
+- lib/federails/maintenance/actors_updater.rb
+- lib/federails/utils/actor.rb
 - lib/federails/utils/host.rb
+- lib/federails/utils/object.rb
 - lib/federails/version.rb
+- lib/fediverse.rb
 - lib/fediverse/inbox.rb
 - lib/fediverse/notifier.rb
 - lib/fediverse/request.rb
@@ -215,7 +233,6 @@ metadata:
   homepage_uri: https://experimentslabs.com
   source_code_uri: https://gitlab.com/experimentslabs/federails/
   changelog_uri: https://gitlab.com/experimentslabs/federails/-/blob/main/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -230,8 +247,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.6.5
 specification_version: 4
 summary: An ActivityPub engine for Ruby on Rails
 test_files: []