federails 0.0.1 → 0.1.0

data/lib/fediverse/webfinger.rb

@@ -0,0 +1,93 @@
+require 'faraday'
+require 'faraday/follow_redirects'
+
+require 'federails/utils/host'
+
+module Fediverse
+  class Webfinger
+    class << self
+      ACCOUNT_REGEX = /(?<username>[a-z0-9\-_.]+)(?:@(?<domain>.*))?/
+
+      def split_resource_account(account)
+        /\Aacct:#{ACCOUNT_REGEX}\z/io.match account
+      end
+
+      def split_account(account)
+        /\A#{ACCOUNT_REGEX}\z/io.match account
+      end
+
+      def local_user?(account)
+        account[:username] && (account[:domain].nil? || (account[:domain] == Federails::Utils::Host.localhost))
+      end
+
+      def fetch_actor(username, domain)
+        fetch_actor_url webfinger(username, domain)
+      end
+
+      def fetch_actor_url(url)
+        webfinger_to_actor get_json url
+      end
+
+      # Returns actor id
+      def webfinger(username, domain)
+        scheme = Federails.configuration.force_ssl ? 'https' : 'http'
+        json = get_json "#{scheme}://#{domain}/.well-known/webfinger", resource: "acct:#{username}@#{domain}"
+        link = json['links'].find { |l| l['type'] == 'application/activity+json' }
+
+        link['href'] if link
+      end
+
+      private
+
+      def webfinger_to_actor(data)
+        uri    = URI.parse data['id']
+        server = uri.host
+        server += ":#{uri.port}" if uri.port && [80, 443].exclude?(uri.port)
+        Federails::Actor.new federated_url:  data['id'],
+                             username:       data['preferredUsername'],
+                             name:           data['name'],
+                             server:         server,
+                             inbox_url:      data['inbox'],
+                             outbox_url:     data['outbox'],
+                             followers_url:  data['followers'],
+                             followings_url: data['following'],
+                             profile_url:    data['url']
+      end
+
+      def get_json(url, payload = {})
+        response = get(url, payload: payload, headers: { accept: 'application/json' })
+
+        if response.status != 200
+          Rails.logger.debug { "Unhandled status code #{response.status} for GET #{url}" }
+          raise ActiveRecord::RecordNotFound
+        end
+
+        JSON.parse(response.body)
+      rescue JSON::ParserError
+        Rails.logger.debug { "Invalid JSON response GET #{url}" }
+
+        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...
+      def get(url, payload: {}, headers: {})
+        connection = Faraday.new url: url, params: payload, headers: headers do |faraday|
+          faraday.response :follow_redirects # use Faraday::FollowRedirects::Middleware
+          faraday.adapter Faraday.default_adapter
+        end
+
+        begin
+          response = connection.get
+        rescue Faraday::ConnectionFailed
+          Rails.logger.debug { "Failed to reach server for GET #{url}" }
+          raise ActiveRecord::RecordNotFound
+        end
+
+        response
+      end
+    end
+  end
+end

data/lib/generators/federails/install/USAGE

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

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

@@ -0,0 +1,10 @@
+module Federails
+  class InstallGenerator < Rails::Generators::Base
+    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'
+    end
+  end
+end

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

@@ -0,0 +1 @@
+Federails.config_from 'federails'

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

@@ -0,0 +1,23 @@
+---
+defaults: &defaults
+  app_name:
+  app_version:
+  force_ssl: false
+  site_host: http://localhost
+  site_port: 3000
+  enable_discovery: true
+  app_layout: 'layouts/application'
+  server_routes_path: federation
+  client_routes_path: app
+
+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

metadata

@@ -1,15 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: federails
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Manuel Tancoigne
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-04 00:00:00.000000000 Z
+date: 2024-09-04 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: 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: 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
@@ -24,7 +108,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 7.0.4
-description: Ruby on Rails engine to add support to Activity Pub
+description: An ActivityPub engine for Ruby on Rails
 email:
 - manu@experimentslabs.com
 executables: []
@@ -36,15 +120,84 @@ files:
 - 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/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/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/federails/activity.rb
+- app/models/federails/actor.rb
 - app/models/federails/application_record.rb
-- app/views/layouts/federails/application.html.erb
+- app/models/federails/following.rb
+- app/policies/federails/client/activity_policy.rb
+- app/policies/federails/client/actor_policy.rb
+- app/policies/federails/client/following_policy.rb
+- app/policies/federails/federails_policy.rb
+- app/policies/federails/server/activity_policy.rb
+- app/policies/federails/server/actor_policy.rb
+- app/policies/federails/server/following_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
+- app/views/federails/client/activities/feed.html.erb
+- app/views/federails/client/activities/feed.json.jbuilder
+- app/views/federails/client/activities/index.html.erb
+- 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/index.html.erb
+- 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/followings/_follow.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
+- app/views/federails/client/followings/index.html.erb
+- app/views/federails/client/followings/index.json.jbuilder
+- app/views/federails/client/followings/show.html.erb
+- app/views/federails/client/followings/show.json.jbuilder
+- app/views/federails/server/activities/_activity.json.jbuilder
+- app/views/federails/server/activities/outbox.json.jbuilder
+- app/views/federails/server/activities/show.json.jbuilder
+- app/views/federails/server/actors/_actor.json.jbuilder
+- app/views/federails/server/actors/followers.json.jbuilder
+- app/views/federails/server/actors/following.json.jbuilder
+- app/views/federails/server/actors/show.json.jbuilder
+- app/views/federails/server/followings/_following.json.jbuilder
+- app/views/federails/server/followings/show.json.jbuilder
+- app/views/federails/server/nodeinfo/index.json.jbuilder
+- app/views/federails/server/nodeinfo/show.json.jbuilder
+- app/views/federails/server/web_finger/find.json.jbuilder
+- app/views/federails/server/web_finger/host_meta.xml.erb
 - 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/20240731145400_change_actor_entity_rel_to_polymorphic.rb
 - lib/federails.rb
+- lib/federails/configuration.rb
 - lib/federails/engine.rb
+- lib/federails/utils/host.rb
 - lib/federails/version.rb
+- lib/fediverse/inbox.rb
+- lib/fediverse/notifier.rb
+- lib/fediverse/request.rb
+- lib/fediverse/webfinger.rb
+- lib/generators/federails/install/USAGE
+- lib/generators/federails/install/install_generator.rb
+- lib/generators/federails/install/templates/federails.rb
+- lib/generators/federails/install/templates/federails.yml
+- lib/tasks/factory_bot.rake
 - lib/tasks/federails_tasks.rake
 homepage: https://experimentslabs.com
 licenses:
@@ -52,7 +205,9 @@ licenses:
 metadata:
   rubygems_mfa_required: 'true'
   homepage_uri: https://experimentslabs.com
-post_install_message: 
+  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
@@ -60,15 +215,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.1.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
-signing_key: 
+rubygems_version: 3.4.15
+signing_key:
 specification_version: 4
-summary: Ruby on Rails engine to add support to Activity Pub
+summary: An ActivityPub engine for Ruby on Rails
 test_files: []

data/app/views/layouts/federails/application.html.erb

@@ -1,15 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>Federails</title>
-  <%= csrf_meta_tags %>
-  <%= csp_meta_tag %>
-
-  <%= stylesheet_link_tag    "federails/application", media: "all" %>
-</head>
-<body>
-
-<%= yield %>
-
-</body>
-</html>