Skip to content

Latest commit

 

History

History

fasp_data_sharing

README.md

FaspDataSharing

This rails engine includes building blocks needed to implement FASP data sharing.

It is based on fasp_base. See the top-level README for installation instructions.

This is not a complete solution to implement data sharing. At the very least you will still need to implement how to deal with incoming data.

Creating Subscriptions

FaspDataSharing::Subscription.subscribe_to_content(server, max_batch_size: 10)

FaspDataSharing::Subscription.subscribe_to_accounts(server, max_batch_size: 10)

FaspDataSharing::Subscription.subscribe_to_trends(server, max_batch_size: 10)

(server is an instance of FaspBase::Server.)

Creating Backfill Requests

FaspDataSharing::BackfillRequest.make(server, category: "content")

(Again, server is an instance of FaspBase::Server, category is one of "content", "account".

Handling Incoming Notifications

fasp_data_sharing expects that you handle incoming notifications from connected fediverse servers asynchronously using ActiveJob.

To this end it defines the following jobs:

  • FaspDataSharing::ProcessAccountBackfillJob
  • FaspDataSharing::ProcessAccountDeletionJob
  • FaspDataSharing::ProcessAccountUpdateJob
  • FaspDataSharing::ProcessContentBackfillJob
  • FaspDataSharing::ProcessContentDeletionJob
  • FaspDataSharing::ProcessContentUpdateJob
  • FaspDataSharing::ProcessNewAccountJob
  • FaspDataSharing::ProcessNewContentJob
  • FaspDataSharing::ProcessTrendingContentJob

Each job gets a single URI as its first and only parameter.

These classes are mostly empty. You need to overwrite them in your provider.

License

The gem is available as open source under the terms of the MIT License.