commit: 0b95eb36128077b3074f661dd451a90a18441ef0
parent: e6408b2e7ade3dac8dcf14bcda5b5c6a159fa74c
Author: Eugen Rochko <eugen@zeonfederated.com>
Date: Sat, 11 Feb 2017 16:21:07 +0100
Improve docs
Diffstat:
2 files changed, 51 insertions(+), 12 deletions(-)
diff --git a/docs/Extensions.md b/docs/Extensions.md
@@ -3,13 +3,54 @@ Protocol extensions
Some functionality in Mastodon required some additions to the protocols to enable seamless federation of those features:
-1. ActivityStreams was lacking verbs for block/unblock. Mastodon creates Salmon slaps for block and unblock events, which are not part of a user's public feed, but are nevertheless delivered to the target user. The intent of these Salmon slaps is not to notify the target user, but to notify the target user's server, so that it can perform any number of UX-related tasks such as removing the target user as a follower of the blocker, and/or displaying a message to the target user such as "You can't follow this person because you've been blocked"
+### Federation of blocks/unblocks
- The Salmon slaps have the exact same structure as standard follow/unfollow slaps, the verbs are namespaced:
+ActivityStreams was lacking verbs for block/unblock. Mastodon creates Salmon slaps for block and unblock events, which are not part of a user's public feed, but are nevertheless delivered to the target user. The intent of these Salmon slaps is not to notify the target user, but to notify the target user's server, so that it can perform any number of UX-related tasks such as removing the target user as a follower of the blocker, and/or displaying a message to the target user such as "You can't follow this person because you've been blocked"
- - `http://mastodon.social/schema/1.0/block`
- - `http://mastodon.social/schema/1.0/unblock`
+The Salmon slaps have the exact same structure as standard follow/unfollow slaps, the verbs are namespaced:
-2. Statuses can be marked as containing sensitive (or not safe for work) media. This is symbolized by a `<category term="nsfw" />` on the Atom entry
+- `http://mastodon.social/schema/1.0/block`
+- `http://mastodon.social/schema/1.0/unblock`
-3. Statuses that are intended to be listed publicly on e.g. "whole known network" or "public" timelines contain a `<link rel="mentioned" href="http://activityschema.org/collection/public" ostatus:object-type="http://activitystrea.ms/schema/1.0/collection"/>`. Conversely, statuses which do not contain that, are intended to be low key, unlisted
+### Federation of sensitive material
+
+Statuses can be marked as containing sensitive (or not safe for work) media. This is symbolized by a `<category term="nsfw" />` on the Atom entry
+
+### Federation of privacy features
+#### Locked accounts and status privacy levels
+
+Accounts and statuses have an access "scope":
+
+Accounts can be "private" or "public". The former requires a follow request to be approved before a follow relationship can be established, the latter can be followed directly.
+
+Statuses can be "private", "unlisted" or "public". Private must only be shown to the followers of the account, public can be displayed publicly. Unlisted statuses may be displayed publicly but preferably outside of any spotlights e.g. "whole known network" or "public" timelines.
+
+Namespace of the scope element is `http://mastodon.social/schema/1.0`. Example:
+
+```xml
+<entry>
+ <!-- ... -->
+ <author>
+ <!-- ... -->
+ <mastodon:scope>private</mastodon:scope>
+ </author>
+ <!-- ... -->
+ <mastodon:scope>private</mastodon:scope>
+</entry>
+```
+
+#### Follow requests
+
+Mastodon uses the following Salmon slaps to signal a follow request, a follow request authorization and a follow request rejection:
+
+- `http://activitystrea.ms/schema/1.0/request-friend`
+- `http://activitystrea.ms/schema/1.0/authorize`
+- `http://activitystrea.ms/schema/1.0/reject`
+
+The activity object of the slaps is the account in question. Request-friend slap is sent to that account, when the end-user of that account decides, the authorize/reject decision slap is sent back to the requester.
+
+#### PuSH amendment
+
+Mastodon will only deliver PuSH payloads to callback URLs the domain of which matches at least one follower of the account in question. That means anonymous manual/subscriptions are not possible.
+
+Private statuses do not appear on Atom feeds, but do get delivered in PuSH payloads to the domains of approved followers.
diff --git a/spec/i18n_spec.rb b/spec/i18n_spec.rb
@@ -2,17 +2,15 @@
require 'i18n/tasks'
RSpec.describe 'I18n' do
- let(:i18n) { I18n::Tasks::BaseTask.new }
+ let(:i18n) { I18n::Tasks::BaseTask.new }
let(:missing_keys) { i18n.missing_keys }
- let(:unused_keys) { i18n.unused_keys }
+ let(:unused_keys) { i18n.unused_keys }
xit 'does not have missing keys' do
- expect(missing_keys).to be_empty,
- "Missing #{missing_keys.leaves.count} i18n keys, run `i18n-tasks missing' to show them"
+ expect(missing_keys).to be_empty, "Missing #{missing_keys.leaves.count} i18n keys, run `i18n-tasks missing' to show them"
end
xit 'does not have unused keys' do
- expect(unused_keys).to be_empty,
- "#{unused_keys.leaves.count} unused i18n keys, run `i18n-tasks unused' to show them"
+ expect(unused_keys).to be_empty, "#{unused_keys.leaves.count} unused i18n keys, run `i18n-tasks unused' to show them"
end
end
