Bonfire.Social.Quotes (Bonfire v1.0.0-social-rc.2.20)

View Source

Handles quote post requests and approvals following FEP-044f.

Provides functionality for requesting permission to quote posts, accepting/rejecting requests, and verifying quote authorizations.

Summary

Functions

accept(request, quote_creator \\ nil, quoted_creator \\ nil, opts)
accept_quote(quote_object, quoted_object, opts \\ [])
accept_quote_request(request, quote_object, quoted_object, opts \\ [])
ap_publish_activity(subject, verb, request)
ap_receive_activity(subject, quote_request_activity, quoted_object)
check_quote_permission(user, quoted_object, opts \\ [])
create_quote_requests(user, pending_quotes, quote_post, opts \\ [])

Creates quote requests for pending quotes after the post has been created.

federation_module()

Callback implementation for Bonfire.Federate.ActivityPub.FederationModules.federation_module/0.

fetch_fresh_quote_authorization(quote_post, quoted_object \\ nil)

Fetches the QuoteAuthorization for a quote post using fresh data.

process_quote(user, quoted_object, opts)
process_quotes(user, quoted_objects, opts \\ [])

Requests permission to quote a post, checking boundaries and creating requests as needed.

quote_verb_id()
reject(request, opts)

Rejects a quote request.

reject(request, quote_object, quoted_object, opts)
reject_quote(quote_object, quoted_object, opts \\ [])
requested(quote_object, quoted_object, opts \\ [])
requested?(subject, quote_post, quoted_object)

Checks if a quote request has been made.

update_quote_add(subject, quote_post, quoted_object, opts)
update_quote_remove(quote_post, quoted_object)
verify_quote_authorization(quote_post, quoted_object \\ nil, authorization \\ nil)

Verifies that a quote authorization is valid.

Functions

accept(request, quote_creator \\ nil, quoted_creator \\ nil, opts)

accept_quote(quote_object, quoted_object, opts \\ [])

accept_quote_request(request, quote_object, quoted_object, opts \\ [])

ap_publish_activity(subject, verb, request)

ap_receive_activity(subject, quote_request_activity, quoted_object)

check_quote_permission(user, quoted_object, opts \\ [])

create_quote_requests(user, pending_quotes, quote_post, opts \\ [])

Creates quote requests for pending quotes after the post has been created.

federation_module()

Callback implementation for Bonfire.Federate.ActivityPub.FederationModules.federation_module/0.

fetch_fresh_quote_authorization(quote_post, quoted_object \\ nil)

Fetches the QuoteAuthorization for a quote post using fresh data.

Parameters

  • quote_post: The quote post to get authorization for
  • quoted_object: The quoted object (optional - if not provided, gets first quoted object)

Returns

{:ok, authorization} if found, {:error, :not_found} otherwise.

Examples

iex> fetch_fresh_quote_authorization(quote_post)
{:ok, %ActivityPub.Object{}}

iex> fetch_fresh_quote_authorization(quote_post, quoted_object)
{:ok, %ActivityPub.Object{}}

process_quote(user, quoted_object, opts)

process_quotes(user, quoted_objects, opts \\ [])

Requests permission to quote a post, checking boundaries and creating requests as needed.

Returns a tuple with {approved_quotes, pending_quotes} where:

  • approved_quotes can be tagged immediately
  • pending_quotes need quote requests after post creation

quote_verb_id()

reject(request, opts)

Rejects a quote request.

Parameters

  • request: The request to ignore
  • opts: Additional options

Returns

Result of the ignore operation.

Examples

iex> reject(request, current_user: user)
{:ok, ignored_request}

reject(request, quote_object, quoted_object, opts)

reject_quote(quote_object, quoted_object, opts \\ [])

requested(quote_object, quoted_object, opts \\ [])

requested?(subject, quote_post, quoted_object)

Checks if a quote request has been made.

Parameters

  • subject: The subject (requester)
  • quote_post: The quote post (instrument)
  • quoted_object: The quoted object

Returns

Boolean indicating if a quote request exists.

Examples

iex> Bonfire.Social.Quotes.requested?(user, quote_post, quoted_object)
true

update_quote_add(subject, quote_post, quoted_object, opts)

update_quote_remove(quote_post, quoted_object)

verify_quote_authorization(quote_post, quoted_object \\ nil, authorization \\ nil)

Verifies that a quote authorization is valid.

Parameters

  • quote_post: The quote post to verify authorization for
  • quoted_object: The quoted object (optional - will call get_quote_authorization to get it)

Returns

  • {:ok, :valid} if authorization exists and is valid
  • {:error, :invalid} if authorization exists but is invalid (wrong signatures, etc)
  • {:error, :revoked} if authorization was deleted/revoked or network errors

Examples

iex> Bonfire.Social.Quotes.verify_quote_authorization(quote_post)
{:ok, :valid}

iex> Bonfire.Social.Quotes.verify_quote_authorization(quote_post, quoted_object)
{:error, :invalid}