federails 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e489a0088b05ef80d9cc112164f054a030f0cb007406cb14789372a5a52c490f
-  data.tar.gz: b6832c622e5c33bf85f520839604a9e6e516821097d70bb6c6acb7df92f0d4b3
+  metadata.gz: a3463b1a877ca8224ade011016236c1fdbcbe41e31712b609347f41592d30531
+  data.tar.gz: 16ec7975b26bc5fbec1e243a4653c27d8b0239c7dbda42544150c9e5680d65f5
 SHA512:
-  metadata.gz: 59e24e51b83545daabfa7dc0c878183d8b0bc14276b559b529fb5ee48183739c49b1a1987eb4a5e8d0d795dcfbe6970d6a3478691f9a13cd12c399903df61695
-  data.tar.gz: 01f6e7bef60bd2d15e142b7b55fecf25dd76ab67571c994c3c8aae1eba23fbcc75d02fb03775131a070b3cc6c18021d33ce91bb8645e937d94c1425a0a7433a3
+  metadata.gz: b54850967223bb1be7aadd54547f757a9e5fbe6ccc8d84249a4a2b340a494b275905c25e862c493b2d2b177a7cc5e12abf2d6e44c4f84b4bec76796a7b9cba5f
+  data.tar.gz: cc00b05153d4434eacc6409a4422575d5e851e07c332001a72fc818e5f64d1bf6f2cd35f6eaa5f4025b3150fe9009a370665a044d44f84a60399690186a8f5e8

data/README.md

@@ -132,7 +132,7 @@ Federails provides a concern to include in your "user" model or whatever will pu
 
 class User < ApplicationRecord
   # Include the concern here:
-  include Federails::Entity
+  include Federails::ActorEntity
 
   # Configure field names
   acts_as_federails_actor username_field: :username, name_field: :name, profile_url_method: :user_url
@@ -145,7 +145,7 @@ an existing model with existing data, you will need to generate the correspondin
 Usage example:
 
 ```rb
-actor = User.find(1).actor
+actor = User.find(1).federails_actor
 
 actor.inbox
 actor.outbox

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

@@ -14,7 +14,7 @@ module Federails
       # GET /app/feed
       # GET /app/feed.json
       def feed
-        @activities = Activity.feed_for(current_user.actor)
+        @activities = Activity.feed_for(current_user.federails_actor)
       end
 
       private

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

@@ -32,7 +32,7 @@ module Federails
       # POST /app/followings.json
       def create
         @following = Following.new(following_params)
-        @following.actor = current_user.actor
+        @following.actor = current_user.federails_actor
         authorize @following, policy_class: Federails::Client::FollowingPolicy
 
         save_and_render
@@ -44,7 +44,7 @@ module Federails
         authorize Federails::Following, policy_class: Federails::Client::FollowingPolicy
 
         begin
-          @following = Following.new_from_account following_account_params, actor: current_user.actor
+          @following = Following.new_from_account following_account_params, actor: current_user.federails_actor
         rescue ::ActiveRecord::RecordNotFound
           # Renders a 422 instead of a 404
           respond_to do |format|
@@ -86,7 +86,7 @@ module Federails
       end
 
       def save_and_render # rubocop:disable Metrics/AbcSize
-        url = federails.client_actor_url current_user.actor
+        url = federails.client_actor_url current_user.federails_actor
 
         respond_to do |format|
           if @following.save

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

@@ -12,7 +12,7 @@ module Federails
 
         @total = @active_halfyear = @active_month = 0
         @has_user_counts = false
-        Federails::Configuration.entity_types.each_value do |config|
+        Federails::Configuration.actor_types.each_value do |config|
           next unless (method = config[:user_count_method]&.to_sym)
 
           @has_user_counts = true

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

@@ -11,7 +11,7 @@ module Federails
         when %r{^https?://.+}
           @user = Federails::Actor.find_by_federation_url(resource)&.entity
         when /^acct:.+/
-          Federails::Configuration.entity_types.each_value do |entity|
+          Federails::Configuration.actor_types.each_value do |entity|
             @user ||= entity[:class].find_by(entity[:username_field] => username)
           end
         end

data/app/jobs/federails/application_job.rb

@@ -1,4 +1,8 @@
 module Federails
   class ApplicationJob < ActiveJob::Base
+    discard_on ActiveJob::DeserializationError
+    after_discard do |_job, exception|
+      Rails.logger.info exception.to_s
+    end
   end
 end

data/app/models/concerns/federails/{entity.rb → actor_entity.rb}

@@ -1,5 +1,5 @@
 module Federails
-  module Entity
+  module ActorEntity
     extend ActiveSupport::Concern
 
     included do # rubocop:todo Metrics/BlockLength
@@ -24,12 +24,12 @@ module Federails
         Fediverse::Inbox.register_handler(activity_type, object_type, self, method)
       end
 
-      has_one :actor, class_name: 'Federails::Actor', as: :entity, dependent: :destroy
+      has_one :federails_actor, class_name: 'Federails::Actor', as: :entity, dependent: :destroy
 
-      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
+      after_create :create_federails_actor, if: lambda {
+        raise("Entity not configured for #{self.class.name}. Did you use \"acts_as_federails_actor\"?") unless Federails.actor_entity? self
 
-        Federails::Configuration.entity_types[self.class.name][:auto_create_actors]
+        Federails.actor_entity(self)[:auto_create_actors]
       }
 
       # Configures the mapping between entity and actor
@@ -53,7 +53,7 @@ module Federails
         user_count_method: nil,
         auto_create_actors: true
       )
-        Federails::Configuration.register_entity(
+        Federails::Configuration.register_actor_class(
           self,
           username_field:     username_field,
           name_field:         name_field,
@@ -90,7 +90,7 @@ module Federails
 
       private
 
-      def create_actor
+      def create_federails_actor
         Federails::Actor.create! entity: self
       end
     end

data/app/models/federails/actor.rb

@@ -91,9 +91,9 @@ module Federails
     end
 
     def entity_configuration
-      raise("Entity not configured for #{entity_type}. Did you use \"acts_as_federails_actor\"?") unless Federails::Configuration.entity_types.key? entity_type
+      raise("Entity not configured for #{entity_type}. Did you use \"acts_as_federails_actor\"?") unless Federails.actor_entity? entity_type
 
-      Federails::Configuration.entity_types[entity_type]
+      Federails.actor_entity entity_type
     end
 
     class << self
@@ -102,8 +102,8 @@ module Federails
 
         if Fediverse::Webfinger.local_user? parts
           actor = nil
-          Federails::Configuration.entity_types.each_value do |entity|
-            actor ||= entity[:class].find_by(entity[:username_field] => parts[:username])&.actor
+          Federails::Configuration.actor_types.each_value do |entity|
+            actor ||= entity[:class].find_by(entity[:username_field] => parts[:username])&.federails_actor
           end
           raise ActiveRecord::RecordNotFound if actor.nil?
         else

data/app/models/federails/following.rb

@@ -2,7 +2,7 @@ module Federails
   class Following < ApplicationRecord
     include Federails::HasUuid
 
-    enum status: { pending: 0, accepted: 1 }
+    enum :status, pending: 0, accepted: 1
 
     validates :target_actor_id, uniqueness: { scope: [:actor_id, :target_actor_id] }
 

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

@@ -10,7 +10,7 @@ module Federails
       end
 
       def accept?
-        in_following? && @record.target_actor_id == @user.actor.id
+        in_following? && @record.target_actor_id == @user.federails_actor.id
       end
 
       def follow?
@@ -19,7 +19,7 @@ module Federails
 
       class Scope < Scope
         def resolve
-          scope.with_actor(@user.actor)
+          scope.with_actor(@user.federails_actor)
         end
       end
 
@@ -28,7 +28,7 @@ module Federails
       def in_following?
         return false unless user_with_actor?
 
-        @record.actor_id == @user.actor&.id || @record.target_actor_id == @user.actor&.id
+        @record.actor_id == @user.federails_actor&.id || @record.target_actor_id == @user.federails_actor&.id
       end
     end
   end

data/app/policies/federails/federails_policy.rb

@@ -53,11 +53,11 @@ module Federails
     def owner?
       return false unless @user
 
-      @record.actor_id == @user.actor.id
+      @record.actor_id == @user.federails_actor.id
     end
 
     def user_with_actor?
-      @user && Federails.actor_entity?(@user) && !!@user.actor
+      @user && Federails.actor_entity?(@user) && !!@user.federails_actor
     end
   end
 end

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

@@ -11,14 +11,14 @@ Federation:
   <%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>
+  <% if Federails.actor_entity?(user) && user.federails_actor.present? %>
+    <li><%= link_to "You (#{user.federails_actor.username})", federails.client_actor_path(user.federails_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? %>
+<% elsif !user.federails_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

@@ -6,7 +6,7 @@
 %>
 <p>
   <% if Federails::Client::FollowingPolicy.new(user, Federails::Following).create? %>
-    <% follow = user.actor.follows? actor %>
+    <% follow = user.federails_actor.follows? actor %>
     <% if actor.entity == user %>
       <button type="button" role="button" disabled="disabled">That's you</button>
     <% elsif follow %>
@@ -16,7 +16,7 @@
       <%= button_to "Follow #{actor.username}", federails.follow_client_followings_path, params: { account: actor.at_address }, method: :post %>
     <% end %>
 
-    <% followed = actor.follows? user.actor %>
+    <% followed = actor.follows? user.federails_actor %>
     <% if followed %>
       <% if followed.pending? %>
         <%= actor.username %> wants to follow you.

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

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

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

@@ -5,16 +5,16 @@ links = [
   {
     rel:  'self',
     type: Mime[:activitypub].to_s,
-    href: @user.actor.federated_url,
+    href: @user.federails_actor.federated_url,
   },
 ]
 
 # User profile URL if configured
 # TODO: Add a profile controller/action in dummy to test this
-if @user.actor.profile_url
+if @user.federails_actor.profile_url
   links.push rel:  'https://webfinger.net/rel/profile-page',
              type: 'text/html',
-             href: @user.actor.profile_url
+             href: @user.federails_actor.profile_url
 end
 
 # Remote following

data/lib/federails/configuration.rb

@@ -59,12 +59,12 @@ module Federails
       Federails::Engine.routes.default_url_options[:port] = value
     end
 
-    # List of entity types
-    mattr_reader :entity_types
-    @@entity_types = {}
+    # List of actor types (classes using Federails::ActorEntity)
+    mattr_reader :actor_types
+    @@actor_types = {}
 
-    def self.register_entity(klass, config = {})
-      @@entity_types[klass.name] = config.merge(class: klass)
+    def self.register_actor_class(klass, config = {})
+      @@actor_types[klass.name] = config.merge(class: klass)
     end
   end
   # rubocop:enable Style/ClassVars

data/lib/federails/version.rb

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

data/lib/federails.rb

@@ -10,35 +10,58 @@ module Federails
   # Make factories available
   config.factory_bot.definition_file_paths += [File.expand_path('spec/factories', __dir__)] if defined?(FactoryBotRails)
 
-  def self.configure
-    yield @@configuration
-  end
+  class << self
+    def 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,
-      :open_registrations,
-      :app_layout,
-      :server_routes_path,
-      :client_routes_path,
-      :remote_follow_url_method,
-      :base_client_controller,
-    ].each { |key| Configuration.send :"#{key}=", config[key] if config.key?(key) }
-  end
+    def 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,
+        :open_registrations,
+        :app_layout,
+        :server_routes_path,
+        :client_routes_path,
+        :remote_follow_url_method,
+        :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 actor
+    #
+    # @example
+    #   puts "Follow #{some_actor.name}" if actor_entity? current_user
+    def actor_entity?(class_or_instance)
+      Configuration.actor_types.key? class_or_instance_name(class_or_instance)
+    end
+
+    # @return [Hash] The configuration for the given actor entity
+    def actor_entity(class_or_instance)
+      klass = class_or_instance_name(class_or_instance)
+      raise "#{klass} is not a configured actor entity" unless Configuration.actor_types.key?(klass)
+
+      Configuration.actor_types[klass]
+    end
+
+    private
 
-  # @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
+    # @return [String] Class name of the provided class or instance
+    def class_or_instance_name(class_or_instance)
+      case class_or_instance
+      when String
+        class_or_instance
+      when Class
+        class_or_instance.name
+      else
+        class_or_instance.class.name
+      end
+    end
   end
 end
 # rubocop:enable Style/ClassVars

data/lib/fediverse/inbox.rb

@@ -15,11 +15,12 @@ module Fediverse
         handlers.each_pair do |klass, method|
           klass.send method, payload
         end
-        return unless handlers.empty?
+        return true unless handlers.empty?
 
         # FIXME: Fails silently
         # raise NotImplementedError
         Rails.logger.debug { "Unhandled activity type: #{payload['type']}" }
+        false
       end
 
       private

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: federails
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Manuel Tancoigne
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-23 00:00:00.000000000 Z
+date: 2024-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -133,7 +133,7 @@ files:
 - app/jobs/federails/application_job.rb
 - app/jobs/federails/notify_inbox_job.rb
 - app/mailers/federails/application_mailer.rb
-- app/models/concerns/federails/entity.rb
+- app/models/concerns/federails/actor_entity.rb
 - app/models/concerns/federails/has_uuid.rb
 - app/models/federails/activity.rb
 - app/models/federails/actor.rb