fasp_client 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 79b0748608e7c9b2fc0c9cb096954fa37b8270b8467c839175d0799ce809afec
+  data.tar.gz: 7f0c2a9d5d9cef162b00edde1711d52d175ce726725db8e79ddea15aa5ace00c
+SHA512:
+  metadata.gz: 3c93b8087b5fb053fde2c40cfab4e8fe212c10416a80791aa1bb74935f3e2a689aa0368847f20f06f28bec1d1ea6abd65e316757f4d37b25d6064c0f67293f53
+  data.tar.gz: 5261bfcaf33617dc941f57e07f8bf0689be42d48bfcbbb382aa6d50523797e555dad3765c2407907f0d1e72192542e0caca796ddbb0c6bc07aae60c37f0d5646

data/LICENSE.md

@@ -0,0 +1,9 @@
+# The MIT License
+
+Copyright 2025 James Smith <james@floppy.org.uk>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,119 @@
+# FaspClient
+A Rails engine that implements the non-provider side of the [Fediverse Auxiliary Service Provider (FASP)](https://fediscovery.org) standard.
+
+## Features
+
+* [Base URL discovery](https://github.com/mastodon/fediverse_auxiliary_service_provider_specifications/blob/main/general/v0.1/protocol_basics.md#base-url) ✅
+* [Request integrity](https://github.com/mastodon/fediverse_auxiliary_service_provider_specifications/blob/main/general/v0.1/protocol_basics.md#request-integrity) ✅
+* [Authentication](https://github.com/mastodon/fediverse_auxiliary_service_provider_specifications/blob/main/general/v0.1/protocol_basics.md#authentication) ✅
+* [Provider registration](https://github.com/mastodon/fediverse_auxiliary_service_provider_specifications/blob/main/general/v0.1/registration.md) ✅
+* [Accepting registration requests](https://github.com/mastodon/fediverse_auxiliary_service_provider_specifications/blob/main/general/v0.1/registration.md) ✅
+* [Selecting capabilities](https://github.com/mastodon/fediverse_auxiliary_service_provider_specifications/blob/main/general/v0.1/registration.md#selecting-capabilities) ✅
+* [Fetching FASP information](https://github.com/mastodon/fediverse_auxiliary_service_provider_specifications/blob/main/general/v0.1/provider_info.md) ✅
+* [Capability APIs](https://github.com/mastodon/fediverse_auxiliary_service_provider_specifications/blob/main/general/v0.1/provider_specifications.md) ⏳
+
+## Installation
+
+Add to your application's Gemfile:
+
+```ruby
+gem "fasp_client"
+```
+
+Install configuration and run migrations (you'll also want to do this when upgrading).
+
+```shell
+bin/rails generate fasp_client:install && bin/rails db:migrate
+```
+
+You will probably want to customise the view templates used for editing and listing providers.
+You can copy the default views like so:
+
+```shell
+bin/rails generate fasp_client:views
+```
+
+## Usage
+
+Mount the engine in your `routes.rb` file:
+
+```ruby
+mount FaspClient::Engine => "/fasp"
+```
+
+Add the base URL to your nodeinfo metadata:
+
+```ruby
+"faspBaseUrl" => Rails.application.routes.url_helpers.fasp_client_url
+```
+
+If you're using [Federails](https://gitlab.com/experimentslabs/federails), you can add this to the metadata using the configuration option (currently only on the `nodeinfo-metadata` branch):
+
+```ruby
+conf.nodeinfo_metadata = -> do
+	{"faspBaseUrl" => Rails.application.routes.url_helpers.fasp_client_url}
+end
+```
+
+Edit `config/initializers/fasp_client.rb` and add customise the template `authenticate` method. It should return true if the current user should be able to access the provider approval/edit pages.
+
+Once you've done that, you can sign up to FASP providers using the URL of your site, and you should be able to register, approve, and choose capabilities.
+
+### Capabilities
+
+#### account_search
+
+Get a list of accounts matching the provided search term, returned as a simple array of account URIs. Provide the optional `limit` parameter to control now many results are returned (default = 20).
+
+```ruby
+my_provider.account_search("mastodon", limit: 5)
+=> ["https://mastodon.social/users/Gargron"]
+```
+
+#### data_sharing
+
+Automatically shares data from your app to the FASP on demand. To configure one of your models to be included in data sharing, include the appropriate concern and set the configuration:
+
+```ruby
+class MyModel < ApplicationRecord
+  include FaspClient::DataSharing::Lifecycle
+
+  fasp_share_lifecycle category: "account", uri_method: :my_canonical_uri
+
+	def my_canonical_uri
+		# Any method that returns the canonical activitypub URI for this object
+	end
+end
+```
+
+Only lifecycle events are currently supported, trending events will be implemented in future. Valid categories are currently `account`, or `content` (see [the spec](https://github.com/mastodon/fediverse_auxiliary_service_provider_specifications/blob/main/discovery/data_sharing/v0.1/data_sharing.md) for details).
+
+The actual announcements are then sent to all subscribed providers by a background ActiveJob, using the `default` queue. You can set a specific queue name by adding an optional `queue` parameter to `fasp_share_lifecycle`:
+
+```ruby
+fasp_share_lifecycle category: "account", uri_method: :my_canonical_uri, queue: "fasp_broadcasts"
+```
+
+Only new lifecycle events are currently sent. Whilst backfill requests can be made, they aren't serviced yet (see https://github.com/manyfold3d/fasp_client/issues/25).
+
+#### follow_recommendation
+
+Get a list of follow recommendations, returned as a simple array of account URIs. The account URI argument is required by the [spec](https://github.com/mastodon/fediverse_auxiliary_service_provider_specifications/blob/main/discovery/follow_recommendation/v0.1/follow_recommendation.md), but won't necessarily affect the results, depending on the server implementation.
+
+```ruby
+my_provider.follow_recommendation(your_account_uri)
+=> [
+	"https://mastodon.me.uk/users/Floppy",
+	"https://mastodon.social/users/Gargron"
+]
+```
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Credits
+
+This code was originally written for the [Manyfold](https://github.com/manyfold3d/manyfold) project, which is funded through [NGI0 Entrust](https://nlnet.nl/entrust), a fund established by [NLnet](https://nlnet.nl) with financial support from the European Commission's [Next Generation Internet](https://ngi.eu) program. Learn more at the [NLnet project page](https://nlnet.nl/project/Personal-3D-archive).
+
+[<img src="https://nlnet.nl/logo/banner.png" alt="NLnet foundation logo" width="20%" />](https://nlnet.nl)
+[<img src="https://nlnet.nl/image/logos/NGI0_tag.svg" alt="NGI Zero Logo" width="20%" />](https://nlnet.nl/entrust)

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/controllers/fasp_client/application_controller.rb

@@ -0,0 +1,44 @@
+module FaspClient
+  class ApplicationController < FaspClient::Configuration.instance.controller_base.constantize
+    layout FaspClient::Configuration.instance.layout
+
+    after_action :sign_response
+
+    def fasp_client_controller?
+      true
+    end
+
+    def get_provider
+      head :unauthorized and return unless request.headers.key?("Signature-Input")
+      m = request.headers["Signature-Input"].match(/keyid=\"([^\"]+)\"/)
+      @provider = FaspClient::Provider.find_by(uuid: m[1]) if m
+      head :unauthorized if @provider.nil?
+    end
+
+    def verify_request
+      head :unauthorized unless @provider.valid_request?(request)
+    end
+
+    private
+
+    def authenticate
+      head :forbidden unless FaspClient::Configuration.instance.authenticate.call(request)
+    end
+
+    def sign_response
+      if @provider
+        response["date"] = Time.now.utc.to_s
+        response["content-digest"] = "sha-256=:"+Digest::SHA256.base64digest(response.body || "")+":"
+        Linzer.sign!(
+          response,
+          key: @provider.local_linzer_key,
+          components: %w[@status content-digest],
+          label: "sig1",
+          params: {
+            created: Time.now.utc.to_i
+          }
+        )
+      end
+    end
+  end
+end

data/app/controllers/fasp_client/backfill_requests_controller.rb

@@ -0,0 +1,21 @@
+module FaspClient
+  class BackfillRequestsController < ApplicationController
+    wrap_parameters :backfill_request, include: [ :category, :maxCount ]
+    before_action :get_provider
+    before_action :verify_request
+
+    def create
+      options = params.deep_transform_keys(&:underscore).expect(backfill_request: [ :category, :max_count ])
+      req = FaspClient::BackfillRequest.create(options.merge(fasp_client_provider: @provider))
+      if req.valid?
+        respond_to do |format|
+          format.json do
+            render json: { "backfillRequest" => { "id" => req.id.to_s } }, status: :created
+          end
+        end
+      else
+        head :unprocessable_content
+      end
+    end
+  end
+end

data/app/controllers/fasp_client/event_subscriptions_controller.rb

@@ -0,0 +1,31 @@
+module FaspClient
+  class EventSubscriptionsController < ApplicationController
+    wrap_parameters :event_subscription, include: [ :category, :subscriptionType ]
+    before_action :get_provider
+    before_action :verify_request
+
+    def create
+      options = params.deep_transform_keys(&:underscore).expect(event_subscription: [ :category, :subscription_type ])
+      if options[:category] == "content" && options[:subscription_type] == "trends"
+        head :not_implemented
+        return
+      end
+      sub = FaspClient::EventSubscription.create(options.merge(fasp_client_provider: @provider))
+      if sub.valid?
+        respond_to do |format|
+          format.json do
+            render json: { "subscription" => { "id" => sub.id.to_s } }, status: :created
+          end
+        end
+      else
+        head :unprocessable_content
+      end
+    end
+
+    def destroy
+      @subscription = @provider.fasp_client_event_subscriptions.find(params[:id])
+      @subscription.destroy
+      head :no_content
+    end
+  end
+end

data/app/controllers/fasp_client/providers_controller.rb

@@ -0,0 +1,46 @@
+module FaspClient
+  class ProvidersController < ApplicationController
+    wrap_parameters :provider, include: [ :name, :baseUrl, :serverId, :publicKey ]
+    protect_from_forgery with: :null_session, only: :create
+    before_action :authenticate, except: [ :create ]
+    before_action :get_provider, except: [ :create, :index ]
+
+    def create
+      attributes = params.deep_transform_keys(&:underscore).expect(provider: [ :name, :base_url, :server_id, :public_key ])
+      @provider = Provider.create(attributes)
+      if @provider.valid?
+        render json: {
+          faspId: @provider.uuid,
+          publicKey: Base64.strict_encode64(@provider.ed25519_signing_key.verify_key.to_bytes),
+          registrationCompletionUri: edit_provider_url(@provider)
+        }, status: :created
+      else
+        head :bad_request
+      end
+    end
+
+    def index
+      @providers = Provider.all
+    end
+
+    def update
+      provider_params = params.expect(provider: [ :status, enable_capability: [ :id, :version ], disable_capability: [ :id, :version ] ])
+      head :bad_request and return unless provider_params
+      if provider_params[:enable_capability]
+        success = @provider.enable(provider_params[:enable_capability][:id], provider_params[:enable_capability][:version])
+        redirect_back_or_to edit_provider_path(@provider), notice: success ? "Enabled" : "Failed"
+      elsif provider_params[:disable_capability]
+        success = @provider.disable(provider_params[:disable_capability][:id], provider_params[:disable_capability][:version])
+        redirect_back_or_to edit_provider_path(@provider), notice: success ? "Disabled" : "Failed"
+      elsif @provider.update!(provider_params)
+        redirect_back_or_to edit_provider_path(@provider)
+      else
+        head :bad_request
+      end
+    end
+
+    def get_provider
+      @provider = Provider.find_by(id: params[:id])
+    end
+  end
+end

data/app/helpers/fasp_client/application_helper.rb

@@ -0,0 +1,11 @@
+module FaspClient
+  module ApplicationHelper
+    def method_missing(method, *args, &block)
+      if main_app.respond_to?(method)
+        main_app.send(method, *args)
+      else
+        super
+      end
+    end
+  end
+end

data/app/jobs/fasp_client/lifecycle_announcement_job.rb

@@ -0,0 +1,7 @@
+class FaspClient::LifecycleAnnouncementJob < ::ApplicationJob
+  def perform(event_type:, category:, uri:)
+    FaspClient::EventSubscription.where(category: category, subscription_type: "lifecycle").find_each do |sub|
+      sub.announce_lifecycle event_type: event_type, uri: uri
+    end
+  end
+end

data/app/models/concerns/fasp_client/data_sharing/lifecycle.rb

@@ -0,0 +1,36 @@
+module FaspClient
+  module DataSharing
+    module Lifecycle
+      extend ActiveSupport::Concern
+
+      class_methods do
+        def fasp_share_lifecycle(category:, uri_method:, queue: "default")
+          self.fasp_uri_method = uri_method
+          self.fasp_category = category
+          self.fasp_job_queue = queue
+        end
+      end
+
+      included do
+        cattr_accessor :fasp_category
+        cattr_accessor :fasp_uri_method
+        cattr_accessor :fasp_job_queue
+
+        after_commit -> { fasp_emit_lifecycle_announcement "new" }, on: :create
+        after_commit -> { fasp_emit_lifecycle_announcement "update" }, on: :update
+        before_destroy -> { fasp_emit_lifecycle_announcement "delete" }
+      end
+
+      private
+
+      def fasp_object_uri
+        raise NotImplementedError("set object URI method using `fasp_share_lifecycle`") unless respond_to?(fasp_uri_method)
+        send(fasp_uri_method)
+      end
+
+      def fasp_emit_lifecycle_announcement(event_type)
+        LifecycleAnnouncementJob.set(queue: fasp_job_queue).perform_later(event_type: event_type, category: fasp_category, uri: fasp_object_uri)
+      end
+    end
+  end
+end

data/app/models/fasp_client/application_record.rb

@@ -0,0 +1,7 @@
+module FaspClient
+  class ApplicationRecord < ActiveRecord::Base
+    CATEGORIES = [ "content", "account" ]
+
+    self.abstract_class = true
+  end
+end

data/app/models/fasp_client/backfill_request.rb

@@ -0,0 +1,9 @@
+module FaspClient
+  class BackfillRequest < ApplicationRecord
+    belongs_to :fasp_client_provider, class_name: "FaspClient::Provider"
+
+    validates :fasp_client_provider, presence: true
+    validates :category, presence: true, inclusion: FaspClient::ApplicationRecord::CATEGORIES
+    validates :max_count, presence: true
+  end
+end

data/app/models/fasp_client/event_subscription.rb

@@ -0,0 +1,28 @@
+module FaspClient
+  class EventSubscription < ApplicationRecord
+    belongs_to :fasp_client_provider, class_name: "FaspClient::Provider"
+
+    validates :fasp_client_provider, presence: true
+    validates :category, presence: true, inclusion: FaspClient::ApplicationRecord::CATEGORIES
+    validates :subscription_type, presence: true, inclusion: [ "lifecycle", "trends" ], if: -> { category == "content" }
+    validates :subscription_type, presence: true, inclusion: [ "lifecycle" ], unless: -> { category == "content" }
+
+    def announce_lifecycle(event_type:, uri:)
+      return if subscription_type != "lifecycle"
+      Rails.logger.debug("Announcing #{subscription_type} event: #{event_type} #{category} #{uri}")
+      request = Net::HTTP::Post.new(URI(fasp_client_provider.base_url + "/data_sharing/v0/announcements"))
+      request.body = {
+        source: {
+          subscription: {
+            id: id.to_s
+          }
+        },
+        category: category,
+        eventType: event_type,
+        objectUris: [ uri ]
+      }.to_json
+      request.content_type = "application/json"
+      HttpRequestService.new(provider: fasp_client_provider).execute!(request)
+    end
+  end
+end

data/app/models/fasp_client/provider.rb

@@ -0,0 +1,115 @@
+require "ed25519"
+require "fasp_client/ed25519_signing_key_coder"
+
+module FaspClient
+  class Provider < ApplicationRecord
+    enum :status, { pending: nil, approved: 1, denied: -1 }, default: :pending, validate: true
+
+    has_many :fasp_client_event_subscriptions, class_name: "FaspClient::EventSubscription", foreign_key: "fasp_client_provider_id"
+    has_many :fasp_client_backfill_requests, class_name: "FaspClient::BackfillRequest", foreign_key: "fasp_client_provider_id"
+
+    validates :uuid, presence: true
+    validates :name, presence: true
+    validates :base_url, presence: true
+    validates :server_id, presence: true
+    validates :public_key, presence: true
+    validates :ed25519_signing_key, presence: true
+
+    serialize :ed25519_signing_key, coder: FaspClient::Ed25519SigningKeyCoder
+
+    attribute :capabilities, :json, default: []
+    attribute :privacy_policy, :json, default: []
+
+    before_validation on: :create do
+      self.uuid ||= SecureRandom.uuid
+      self.ed25519_signing_key ||= Ed25519::SigningKey.generate
+    end
+
+    before_save :fetch_provider_info, if: -> { approved? && status_changed? }
+
+    def verify_key
+      Ed25519::VerifyKey.new(Base64.strict_decode64(public_key))
+    end
+
+    def fingerprint
+      Digest::SHA256.base64digest(verify_key)
+    end
+
+    def has_capability?(capability, version = nil)
+      version ? capability_versions(capability).include?(version) : capability_versions(capability).any?
+    end
+
+    def capability_versions(capability)
+      capabilities.filter_map { |it| it["version"] if it["id"] == capability.to_s }
+    end
+
+    def capability_ids
+      capabilities.map { |it| it["id"] }.uniq.map(&:to_sym)
+    end
+
+    def fetch_provider_info
+      assign_attributes(ProviderInfoService.new(provider: self).to_provider_attributes) if approved?
+    end
+
+    def enable(capability, version)
+      return unless has_capability?(capability, version)
+      CapabilityActivationService.new(provider: self, capability: capability, version: version).enable!
+    end
+
+    def disable(capability, version)
+      return unless has_capability?(capability, version)
+      CapabilityActivationService.new(provider: self, capability: capability, version: version).disable!
+    end
+
+    def follow_recommendation(account_uri)
+      FollowRecommendationService.new(provider: self).for(account_uri: account_uri)
+    end
+
+    def account_search(query, limit: 20)
+      AccountSearchService.new(provider: self).search(query: query, limit: limit)
+    end
+
+    def valid_request?(request)
+      HttpRequestService.new(provider: self).verified?(request)
+    end
+
+    def local_linzer_key
+      asn1 = OpenSSL::ASN1.Sequence(
+        [
+          OpenSSL::ASN1::Integer(OpenSSL::BN.new(0)),
+          OpenSSL::ASN1.Sequence(
+            [
+              OpenSSL::ASN1.ObjectId("ED25519")
+            ]
+          ),
+          OpenSSL::ASN1.OctetString(OpenSSL::ASN1.OctetString(ed25519_signing_key.to_bytes).to_der)
+        ]
+      )
+      pem = <<~PEM
+        -----BEGIN PRIVATE KEY-----
+        #{Base64.strict_encode64(asn1.to_der)}
+        -----END PRIVATE KEY-----
+      PEM
+      Linzer.new_ed25519_key(pem, server_id)
+    end
+
+    def fasp_linzer_key
+      asn1 = OpenSSL::ASN1.Sequence(
+        [
+          OpenSSL::ASN1.Sequence(
+            [
+              OpenSSL::ASN1.ObjectId("ED25519")
+            ]
+          ),
+          OpenSSL::ASN1.BitString(verify_key.to_bytes)
+        ]
+      )
+      pem = <<~PEM
+        -----BEGIN PUBLIC KEY-----
+        #{Base64.strict_encode64(asn1.to_der)}
+        -----END PUBLIC KEY-----
+      PEM
+      Linzer.new_ed25519_key(pem, uuid)
+    end
+  end
+end

data/app/services/fasp_client/account_search_service.rb

@@ -0,0 +1,16 @@
+require "linzer"
+
+module FaspClient
+  class AccountSearchService
+    def initialize(provider:)
+      @provider = provider
+    end
+
+    def search(query:, limit: 20)
+      response = HttpRequestService.new(provider: @provider).execute!(
+        Net::HTTP::Get.new(URI(@provider.base_url + "/account_search/v0/search?limit=#{limit}&term=" + CGI.escape(query)))
+      )
+      JSON.parse(response.body)
+    end
+  end
+end

data/app/services/fasp_client/capability_activation_service.rb

@@ -0,0 +1,27 @@
+module FaspClient
+  class CapabilityActivationService
+    def initialize(provider:, capability:, version:)
+      @provider = provider
+      @capability = capability
+      @major_version = version.split(".").first
+    end
+
+    def enable!
+      HttpRequestService.new(provider: @provider).execute!(
+        Net::HTTP::Post.new(uri)
+      ).code == "204"
+    end
+
+    def disable!
+      HttpRequestService.new(provider: @provider).execute!(
+        Net::HTTP::Delete.new(uri)
+      ).code == "204"
+    end
+
+    private
+
+    def uri
+      URI("#{@provider.base_url}/capabilities/#{@capability}/#{@major_version}/activation")
+    end
+  end
+end

data/app/services/fasp_client/follow_recommendation_service.rb

@@ -0,0 +1,16 @@
+require "linzer"
+
+module FaspClient
+  class FollowRecommendationService
+    def initialize(provider:)
+      @provider = provider
+    end
+
+    def for(account_uri:)
+      response = HttpRequestService.new(provider: @provider).execute!(
+        Net::HTTP::Get.new(URI(@provider.base_url + "/follow_recommendation/v0/accounts?accountUri=" + CGI.escape(account_uri)))
+      )
+      JSON.parse(response.body)
+    end
+  end
+end

data/app/services/fasp_client/http_request_service.rb

@@ -0,0 +1,32 @@
+module FaspClient
+  class HttpRequestService
+    def initialize(provider:)
+      @provider = provider
+    end
+
+    def execute!(request)
+      request["date"] = Time.now.utc.to_s
+      request["Content-Digest"] = "sha-256=:"+Digest::SHA256.base64digest(request.body || "")+":"
+      Linzer.sign!(
+        request,
+        key: @provider.local_linzer_key,
+        components: %w[@method @target-uri content-digest],
+        label: "sig1",
+        params: {
+          created: Time.now.utc.to_i
+        }
+      )
+      response = nil
+      Net::HTTP.start request.uri.hostname, request.uri.port, use_ssl: (request.uri.scheme == "https") do |http|
+        response = http.request request
+      end
+      response
+    end
+
+    def verified?(request_or_response)
+      Linzer.verify!(request_or_response, key: @provider.fasp_linzer_key)
+    rescue Linzer::Error
+      false
+    end
+  end
+end

data/app/services/fasp_client/provider_info_service.rb

@@ -0,0 +1,23 @@
+require "linzer"
+
+module FaspClient
+  class ProviderInfoService
+    def initialize(provider:)
+      @provider = provider
+    end
+
+    def to_provider_attributes
+      response = HttpRequestService.new(provider: @provider).execute!(
+        Net::HTTP::Get.new(URI(@provider.base_url + "/provider_info"))
+      )
+      json ||= JSON.parse(response.body)
+      json.slice(
+        "capabilities",
+        "privacyPolicy",
+        "signInUrl",
+        "contactEmail",
+        "fediverseAccount"
+      ).deep_transform_keys(&:underscore).deep_symbolize_keys
+    end
+  end
+end

data/app/views/fasp_client/providers/edit.html.erb

@@ -0,0 +1,29 @@
+<%= notice %>
+
+<h1>Provider: <%= link_to @provider.name, @provider.base_url %></h1>
+
+<div>
+	<p>Requested at: <%= @provider.created_at %></p>
+	<p>Status: <%= @provider.status %></p>
+
+	<% if @provider.pending? %>
+		<p>
+			Fingerprint:
+			<code>
+				<%= @provider.fingerprint %>
+			</code>
+		</p>
+		<%= button_to "Approve", @provider, method: :patch, params: {provider: {status: "approved"}}, form: {style: "display: inline"} %>
+		<%= button_to "Deny", @provider, method: :patch, params: {provider: {status: "denied"}}, form: {style: "display: inline"} %>
+	<% else %>
+		<table>
+			<% @provider.capabilities.each do |cap| %>
+				<tr>
+					<td><%= cap["id"] %> (<%= cap["version"] %>)</td>
+					<td><%= button_to "Enable", @provider, method: :patch, params: {provider: {enable_capability: {id: cap["id"], version: cap["version"]}}}, form: {style: "display: inline"} %></td>
+					<td><%= button_to "Disable", @provider, method: :patch, params: {provider: {disable_capability: {id: cap["id"], version: cap["version"]}}}, form: {style: "display: inline"} %></td>
+				</tr>
+			<% end %>
+		</table>
+	<% end %>
+</div>

data/app/views/fasp_client/providers/index.html.erb

@@ -0,0 +1,13 @@
+<h1>FASP Providers</h1>
+
+<% @providers.each do |provider| %>
+	<div>
+		<h2>
+			<%= link_to provider.name, provider.base_url %>
+		</h2>
+		<p>Requested at: <%= provider.created_at %></p>
+		<p>Status: <%= provider.status %></p>
+		<%= link_to "Edit", edit_provider_path(provider) %>
+	</div>
+
+<% end %>

data/config/routes.rb

@@ -0,0 +1,6 @@
+FaspClient::Engine.routes.draw do
+  post "/registration" => "providers#create"
+  resources :providers, only: [ :index, :edit, :update ]
+  resources :event_subscriptions, only: [ :create, :destroy ], path: "data_sharing/v0/event_subscriptions"
+  resources :backfill_requests, only: [ :create ], path: "data_sharing/v0/backfill_requests"
+end

data/db/migrate/20250801150509_create_fasp_client_providers.rb

@@ -0,0 +1,19 @@
+class CreateFaspClientProviders < ActiveRecord::Migration[8.0]
+  def change
+    create_table :fasp_client_providers do |t|
+      t.string :uuid
+      t.string :name
+      t.string :base_url
+      t.string :server_id
+      t.string :public_key
+      t.string :ed25519_signing_key
+      t.integer :status
+      t.json :capabilities
+      t.json :privacy_policy
+      t.string :sign_in_url
+      t.string :contact_email
+      t.string :fediverse_account
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20250905153345_create_fasp_client_event_subscriptions.rb

@@ -0,0 +1,11 @@
+class CreateFaspClientEventSubscriptions < ActiveRecord::Migration[8.0]
+  def change
+    create_table :fasp_client_event_subscriptions do |t|
+      t.references :fasp_client_provider, null: false, foreign_key: true
+      t.string :category
+      t.string :subscription_type
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20250908164011_create_fasp_client_backfill_requests.rb

@@ -0,0 +1,11 @@
+class CreateFaspClientBackfillRequests < ActiveRecord::Migration[8.0]
+  def change
+    create_table :fasp_client_backfill_requests do |t|
+      t.references :fasp_client_provider, null: false, foreign_key: true
+      t.string :category
+      t.integer :max_count
+
+      t.timestamps
+    end
+  end
+end

data/lib/fasp_client/configuration.rb

@@ -0,0 +1,15 @@
+module FaspClient
+  class Configuration
+    include Singleton
+
+    attr_accessor :authenticate
+    attr_accessor :layout
+    attr_accessor :controller_base
+
+    def initialize
+      @authenticate = ->(request) { }
+      @layout = "application"
+      @controller_base = "ActionController::Base"
+    end
+  end
+end

data/lib/fasp_client/ed25519_signing_key_coder.rb

@@ -0,0 +1,11 @@
+module FaspClient
+  class Ed25519SigningKeyCoder
+    def self.dump(value)
+      Base64.strict_encode64(value.to_bytes)
+    end
+
+    def self.load(string)
+      Ed25519::SigningKey.new(Base64.strict_decode64(string)) if string
+    end
+  end
+end

data/lib/fasp_client/engine.rb

@@ -0,0 +1,15 @@
+require "linzer"
+
+module FaspClient
+  class Engine < ::Rails::Engine
+    isolate_namespace FaspClient
+
+    config.to_prepare do
+      # Include main application helpers so we can allow it to override views
+      FaspClient::ApplicationController.helper Rails.application.helpers
+
+      Linzer::Message.register_adapter(ActionDispatch::Request, Linzer::Message::Adapter::Rack::Request)
+      Linzer::Message.register_adapter(ActionDispatch::Response, Linzer::Message::Adapter::Rack::Response)
+    end
+  end
+end

data/lib/fasp_client/version.rb

@@ -0,0 +1,3 @@
+module FaspClient
+  VERSION = "0.5.0"
+end

data/lib/fasp_client.rb

@@ -0,0 +1,13 @@
+require "fasp_client/version"
+require "fasp_client/engine"
+require "fasp_client/configuration"
+
+module FaspClient
+  def self.table_name_prefix
+    "fasp_client_"
+  end
+
+  def self.configure
+    yield Configuration.instance
+  end
+end

data/lib/generators/fasp_client/install/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Copies initializer and installs migrations
+
+Example:
+    bin/rails generate fasp_client:install
+
+    This will create:
+        config/initializers/fasp_client.rb
+        db/migrations/*.fasp_client.rb

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

@@ -0,0 +1,13 @@
+module FaspClient
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("templates", __dir__)
+
+    def create_initializer_file
+      copy_file "fasp_client.rb", Rails.root.join("config", "initializers", "fasp_client.rb")
+    end
+
+    def generate_migrations
+      rake "fasp_client:install:migrations"
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+FaspClient.configure do |conf|
+  conf.authenticate = ->(request) do
+    # Return a truthy value if the current user should be able to access and edit FASP providers, otherwise
+    # return falsey. For example:
+    #
+    # Warden / Devise:
+    # request.env["warden"]&.user&.is_administrator?
+  end
+
+  # Configure the layout name that should be used for views; defaults to "application"
+  # conf.layout = "application"
+
+  # For even tighter integration, you might want to use your own ApplicationController as the base
+  # class for FaspClient controllers.
+  # conf.controller_base = "::ApplicationController"
+end

data/lib/generators/fasp_client/views/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Copies fasp_client views to be overridden in main application
+
+Example:
+    bin/rails generate fasp_client:views
+
+    This will create:
+        app/views/fasp_client/**/*

data/lib/generators/fasp_client/views/views_generator.rb

@@ -0,0 +1,9 @@
+module FaspClient
+  class ViewsGenerator < Rails::Generators::Base
+    source_root File.expand_path("../../../../app/views", __dir__)
+
+    def copy_views
+      directory "fasp_client", Rails.root.join("app", "views", "fasp_client")
+    end
+  end
+end

data/lib/tasks/fasp_client_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :fasp_client do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,221 @@
+--- !ruby/object:Gem::Specification
+name: fasp_client
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- James Smith
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: ed25519
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: linzer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails-omakase
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-uuid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.3'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.25'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.25'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.5'
+description: A Rails engine that implements the non-provider side of the Fediverse
+  Auxiliary Service Provider (FASP) standard.
+email:
+- james@floppy.org.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- Rakefile
+- app/controllers/fasp_client/application_controller.rb
+- app/controllers/fasp_client/backfill_requests_controller.rb
+- app/controllers/fasp_client/event_subscriptions_controller.rb
+- app/controllers/fasp_client/providers_controller.rb
+- app/helpers/fasp_client/application_helper.rb
+- app/jobs/fasp_client/lifecycle_announcement_job.rb
+- app/models/concerns/fasp_client/data_sharing/lifecycle.rb
+- app/models/fasp_client/application_record.rb
+- app/models/fasp_client/backfill_request.rb
+- app/models/fasp_client/event_subscription.rb
+- app/models/fasp_client/provider.rb
+- app/services/fasp_client/account_search_service.rb
+- app/services/fasp_client/capability_activation_service.rb
+- app/services/fasp_client/follow_recommendation_service.rb
+- app/services/fasp_client/http_request_service.rb
+- app/services/fasp_client/provider_info_service.rb
+- app/views/fasp_client/providers/edit.html.erb
+- app/views/fasp_client/providers/index.html.erb
+- config/routes.rb
+- db/migrate/20250801150509_create_fasp_client_providers.rb
+- db/migrate/20250905153345_create_fasp_client_event_subscriptions.rb
+- db/migrate/20250908164011_create_fasp_client_backfill_requests.rb
+- lib/fasp_client.rb
+- lib/fasp_client/configuration.rb
+- lib/fasp_client/ed25519_signing_key_coder.rb
+- lib/fasp_client/engine.rb
+- lib/fasp_client/version.rb
+- lib/generators/fasp_client/install/USAGE
+- lib/generators/fasp_client/install/install_generator.rb
+- lib/generators/fasp_client/install/templates/fasp_client.rb
+- lib/generators/fasp_client/views/USAGE
+- lib/generators/fasp_client/views/views_generator.rb
+- lib/tasks/fasp_client_tasks.rake
+homepage: https://github.com/manyfold3d/fasp_client
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/manyfold3d/fasp_client
+  source_code_uri: https://github.com/manyfold3d/fasp_client
+  changelog_uri: https://github.com/manyfold3d/fasp_client/releases
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: A Rails engine for FASP client apps
+test_files: []