vazco/Universe Any Join

 

-- Abandonware. This package is deprecated! --

 

This package adds functionality of joining between user and any universe document. In very easy way, you can adds possibility of joining to your entity, for example to events or groups. You can add multi joining types to one document.

For example: You can be a member of group, but also a friend of the same group or just observer.

Installation

$ meteor add vazco:universe-any-join

Joining types

Joining mode can work in three different types of joining.

• UniAnyJoin.TYPE_JOIN_REQUEST (default mode)

  To join to entity, user must send joining request, authorized persons can accept or rejects each one request.

• UniAnyJoin.TYPE_JOIN_INVITATION

  The ability to invite members to subject. No one can join to without invitation.

  Notice: Authorized persons can always send invitation, regardless from current type.

• UniAnyJoin.TYPE_JOIN_OPEN

  Anyone can join without accepting by someone

Permissions

Possibilities of users are dependent from joining policy on current subject for selected joining name. Rights to management of joining like sending invitation or accepting request, is based on "can" methods. As a default, this roles accrue for universe admin and owner of subject.

Of course, You can influence on that, who can what. Defining own callbacks, you can decide who and on what rules: canResign, canChangePolicy, canAcceptRequest, canSendRequest, canSendInvitation, canJoinDirectly.

Making from any universe collection a joinable collection.

You can attach AnyJoin functionality to collection using instruction:

yourCollection.attachAnyJoin(name, callbacks);

• name It's a joining name, because you can attach many of joins on single collection. This name will be used to recognize joining.
• callbacks Using this parameter you can define your own logic of access policy for each 'can*' methods. Additionally you can define reaction, which will be executed after actions.

Adding new callback.

If there is callback, wraps it.

yourCollection.addAnyJoinCallback(name, event, callback);

• name It's a joining name, because you can attach many of joins on single collection. This name will be used to recognize joining.
• event Event we are listening to.
• callback Callback.

Callbacks for access control

( available anywhere )

All following callbacks to grant or deny permission should return an boolean. Any other type of returned value will be filtered out and method will be continue execution of the default logic.

• canResign(joiningName, user, initiator)

  is called when 'initiator' tries detach 'user'. ( It can be the same user e.g. : 'Someone wants leave a group' )

  default logic: entry possessor, admin and owner of subject, can change policy

• canChangePolicy(joiningName, user)

  called to check if 'user' can change type of policy for 'joiningName'

  default logic: only admin and owner of subject can change policy

• canAcceptRequest(joiningName, acceptor)

  checks if 'acceptor' has rights to accept joining requests for joiningName

  default logic: only admin and owner of subject can accept request

• canSendRequest(joiningName, user)

  is invoked to checking if user can send joining request

  default logic: every user can send invitation, if type for current joiningName is UniAnyJoin.TYPE_JOIN_REQUEST

• canSendInvitation(joiningName, user)

  is invoked to checking if user can send invitation to join

  default logic: only admin and owner of subject can send invitations

• canJoinDirectly(joiningName, userId, acceptorId)

  called to validate if userId can be joined without someone's permission (open to join or is already invited) or if provided 'acceptorId' can join a 'userId' (admin/owner)

  default logic: true if mode is open to join, user is already invited or 'acceptorId' is admin or subject owner

• isJoined(joiningName, userId)

  Checks if user is joined to current subject by joiningName.

  default logic: checks if status is equal constant of UniAnyJoin.STATUS_JOINED in joiningName for userId.

Callbacks on events

( available just on the server )

You can also do your stuff as a reaction on event. E.g.: site will be send email every time when someone sends joining request or invitation.

• onInvitation(joiningName, uniAnyJoinDocument, toUser, originator)

  fired after invitation was saved in db

• onRequest(joiningName, uniAnyJoinDocument, fromUser, originator)

  fired after joining request was send

• onAcceptRequest(joiningName, uniAnyJoinDocument, fromUser, acceptor)

  called when 'acceptor' accept 'fromUser'

• onAcceptInvitation(joiningName, uniAnyJoinDocument, receiverId)

  invoked just after receiver accepted the invitation

• onJoin(joiningName, uniAnyJoinDocument, userId, acceptorId)

  called after someone was marked as a joined

• onResign(joiningName, uniAnyJoinDocument, user, acceptor)

  invoked when someone resigns from join or authorized person helped him to leave.

• onGetDefaultPolicy(joiningName, collection)

  invoke when new document of joinable collection will be saved in db. Should return default type of policy for joiningName in collection

Extending Documents

This package using function helpers on collection to extending prototype of document constructor. After you attached AnyJoin functionality on every document from joinable collection will be have following methods:

• Same on both sides

  • joinGetRow(joiningName, userId) Gets document for passed arguments (joiningName, userId) for current subject (document)
  • joinIsJoined(joiningName, userId) Checks if user is joined to current subject by joiningName
  • joinCanJoinDirectly(joiningName, userId, acceptorId) Checks if user can join directly (free for join or user is admin)
  • joinCanSendInvitation(joiningName, user) Checks if user can invite someone
  • joinCanSendRequest(joiningName, user) Checks if user can send joining request
  • joinCanAcceptRequest(joiningName, acceptor) Checks if user can accept joining request
  • joinCanChangePolicy(joiningName, user) Checks if user can change policy of joining process.
  • joinGetPolicy(joiningName) Gets current policy of joining
  • joinIsUserInvited(joiningName, userId) Checks if user is invited to subject
  • joinIsRequestSent(joiningName, userId) Checks if is waiting request
  • joinCanResign(joiningName, acceptor, use) Checks if user can resign/reject invitation/request or leave subject
  • joinCanGetPossessorsOfEntries: function(joiningName, statuses, caller) Checks if user can gets possessors, you can use statuses to filter possessors of selected statuses. Possible statuses: UniAnyJoin.STATUS_JOINED, UniAnyJoin.STATUS_INVITED, UniAnyJoin.STATUS_REQUESTED, UniAnyJoin.STATUS_REJECTED

• Different implementation client/server

On server additionally last parameter is the user context to execute method, but on client is callback

- **joinSendInvitation(joiningName, toUser, {caller/callback})** Sends Invitation to joining
- **joinSendRequest(joiningName, {fromUser, originator/callback})** Sends joining request
- **joinAcceptRequest(joiningName, fromUser, {acceptor/callback})** Accepts users request and join him to subject
- **joinAcceptInvitation(joiningName, {fromUser, acceptor/callback})** Accepts invitation to joining
- **join(joiningName, user, {acceptor/callback})** Joins to subject, if free to join
- **joinChangePolicy(joiningName, type, {acceptor/callback})** Sets policy of joining, allowed types:
*UniAnyJoin.TYPE_JOIN_REQUEST, UniAnyJoin.TYPE_JOIN_INVITATION, UniAnyJoin.TYPE_JOIN_OPEN*
- **joinResign(joiningName, user, {acceptor/callback})** Resigns from joining, rejects user request or invitation
- **joinGetPossessorsOfEntries(joiningName, statuses, usersAdditionalSelector, {caller, usersFindOptions/callback})** Gets array of users (can be filtering by statuses)

Templates & Publications

Pre prepared templates

This package provide pre prepared templates which are ready to use.

• {{> uniAnyJoinInvitations}} listing of invitations for current logged in user
• {{> uniAnyJoinSearchUsers joiningName subjectId subjectName}} search list of users with buttons for management of invitation, joins, requests
• {{> uniAnyJoinPossessorsList joiningName subjectId subjectName}} listing of users which need acceptance of joining requests and invitations which are waiting for them.
• {{> uniAnyJoinButton joiningName subjectId subjectName}} send request button, leave button, accept invitation button

joiningName - name of joining like members, subjectName - name of subject collection, subjectId - id of document.

Any templates you can replace or change by package template extension

Publications

This package provides four publications of universe.

• uniAnyJoinMyInvitations
• uniAnyJoin
• uniAnyJoinUsersToAccept
• uniAnyJoinSearchUsers

They are made by universe access package, so you can replace them by define self with option override: true. Additionally you can using allow/deny publish, to manipulate of permissions for published documents. details here

Check other amazing universe packages:

• Atmosphere js
• Github

License

Like every package maintained by Vazco, Universe Any Join is MIT licensed.