User:Mark Hershberger/specs - Revision history

Mark Hershberger: more docs

2020-07-06T03:55:19Z

more docs

← Older revision		Revision as of 23:55, 5 July 2020
Line 10:		Line 10:
	** Individual memberships should be purchased on a dedicated page by logged in users.		** Individual memberships should be purchased on a dedicated page by logged in users.
	** Non-logged in users will be denied access with UserNotLoggedIn.		** Non-logged in users will be denied access with UserNotLoggedIn.
	** The corporate membership page will only be available to people who have the <code>member</code>		** The corporate membership page will only be available to people who have the <code>member</code>.
	**		** People who do not have the <code>corp-admin</code> permission will be offered any of the available corporate memberships.
	** ~~WhPeople without an individual mebership,~~		** People who have the <code>corp-admin</code> permission will be offered higher levels of memberships.
	** ~~The~~ special page ~~to create corporate memberships~~		** Finally, a third special page (fundrasing?) should be created where arbitrary amounts of money can be given.
	* Credit card info should NOT be stored anywhere.		* Credit card info should NOT be stored anywhere.
	* Billing address information should be collected.		* Billing address information should be collected.
Line 28:		Line 28:
	=== Permissions ===		=== Permissions ===

	The <code>member</code> permission will be given to the <code>individual-subcription</code> by default.		* The <code>member</code> permission will be given to the <code>individual-subcription</code> by default.
			* The <code>corp-admin</code> permission will be given to anyone who purchases a bronze level or above membership.
	Users with the <		* ''(soft requirement)'' Users with <code>corp-admin</code> permission will be able to allocate their votes to on-wiki users as they wish.
			: For instance, if a person with the <code>corp-admin</code> permission has 40 votes, they would be able to allocate 20 to themselves and 10 to another user of their choosing and give the remaining 10 to 10 arbitrary wiki users.

	=== Membership tiers ===		=== Membership tiers ===
Line 39:		Line 40:
	"member-individual": {		"member-individual": {
	"cost": "100",		"cost": "100",
	~~“vote”~~: 1		"permission": "member",
			"vote": 1
	},		},
	"member-bronze": {		"member-bronze": {
	"cost": "250",		"cost": "250",
	"dependant": "member-individual",		"dependant": "member-individual",
	~~“vote”~~: 10		"permission": "corp-admin"
			"vote": 10
	},		},
	"member-silver": {		"member-silver": {
	"cost": "1000",		"cost": "1000",
	"dependant": "member-bronze",		"dependant": "member-bronze",
	~~“vote”~~: 25		"vote": 25
	},		},
	"member-gold": {		"member-gold": {
	"cost": 2500,		"cost": 2500,
	"dependant": "member-silver",		"dependant": "member-silver",
	~~“vote”~~: 40		"vote": 40
	},		},
	"member-platinum": {		"member-platinum": {
	"cost": 5000,		"cost": 5000,
	"dependant": "member-gold",		"dependant": "member-gold",
	~~“vote”~~: 50		"vote": 50
	}		}
	}		}
Line 69:		Line 72:

	Immediately after a successful payment the user is assigned to a the group specified in the key (''e.g.'' <code>member-individual</code>). If a <code>dependant</code> has also been given, the extension will also assign the groups for that dependant recursively. So, for instance, if someone purchases the <code>member-silver</code> level, they would get assigned the groups <code>member-silver</code>, <code>member-bronze</code> and <code>member-individual</code>.		Immediately after a successful payment the user is assigned to a the group specified in the key (''e.g.'' <code>member-individual</code>). If a <code>dependant</code> has also been given, the extension will also assign the groups for that dependant recursively. So, for instance, if someone purchases the <code>member-silver</code> level, they would get assigned the groups <code>member-silver</code>, <code>member-bronze</code> and <code>member-individual</code>.

			== See also ==

			* Wikimedia Deutschland's [[https://github.com/wmde/FundraisingFrontend\|FundraisingFrontend]] for ideas.
			* [[mw:Extension:DonationInterface\|Extension:DonationInterface]] “renders payment forms and provides fundraising mechanisms for collecting and tracking payments through various payment gateways” and is probably a good source of ideas.
			* [https://wikitech.wikimedia.org/wiki/Category:Fundraising Public WMF Fundraising documents] that may be useful.

Mark Hershberger: add votes

2020-07-06T03:22:02Z

add votes

← Older revision		Revision as of 23:22, 5 July 2020
Line 7:		Line 7:
	* If a user chooses monthly payments, then it should be the yearly amount divided by 12 and rounded up to the nearest $.		* If a user chooses monthly payments, then it should be the yearly amount divided by 12 and rounded up to the nearest $.
	: So, at the $100 level, it would be $100 ÷ 12 = 8.3̅ ≆ $9 per month		: So, at the $100 level, it would be $100 ÷ 12 = 8.3̅ ≆ $9 per month
			* Corporate meberships can only be purchased after an individual membership is purchased.
			** Individual memberships should be purchased on a dedicated page by logged in users.
			** Non-logged in users will be denied access with UserNotLoggedIn.
			** The corporate membership page will only be available to people who have the <code>member</code>
			**
			** WhPeople without an individual mebership,
			** The special page to create corporate memberships
	* Credit card info should NOT be stored anywhere.		* Credit card info should NOT be stored anywhere.
	* Billing address information should be collected.		* Billing address information should be collected.
Line 18:		Line 25:

	== Implementation notes ==		== Implementation notes ==

			=== Permissions ===

			The <code>member</code> permission will be given to the <code>individual-subcription</code> by default.

			Users with the <

	=== Membership tiers ===		=== Membership tiers ===
Line 25:		Line 38:
	{		{
	"member-individual": {		"member-individual": {
	"cost": "100"		"cost": "100",
			“vote”: 1
	},		},
	"member-bronze": {		"member-bronze": {
	"cost": "250",		"cost": "250",
	"dependant": "member-individual"		"dependant": "member-individual",
			“vote”: 10
	},		},
	"member-silver": {		"member-silver": {
	"cost": "1000",		"cost": "1000",
	"dependant": "member-bronze"		"dependant": "member-bronze",
			“vote”: 25
	},		},
	"member-gold": {		"member-gold": {
	"cost": 2500,		"cost": 2500,
	"dependant": "member-silver"		"dependant": "member-silver",
			“vote”: 40
	},		},
	"member-platinum": {		"member-platinum": {
	"cost": 5000,		"cost": 5000,
	"dependant": "member-gold"		"dependant": "member-gold",
			“vote”: 50
	}		}
	}		}

Mark Hershberger: cleanup

2020-07-05T00:21:23Z

cleanup

← Older revision		Revision as of 20:21, 4 July 2020
Line 15:		Line 15:
	* The user should be able to cancel their subscription. If they do, they should be removed from the group.		* The user should be able to cancel their subscription. If they do, they should be removed from the group.
	* Administrators are users that have the <code>managemembership</code> right.		* Administrators are users that have the <code>managemembership</code> right.
	* ''''(soft requirement)'''' If a monthly or yearly payment is missed (''''e.g.'''' because of an automatic transaction error at Authorize.Net), then the user and the administrators should be sent a [[mw:Extension:Echo/Creating_a_new_notification_type\|notification]].		* ''(soft requirement)'' If a monthly or yearly payment is missed (''e.g.'' because of an automatic transaction error at Authorize.Net), then the user and the administrators should be sent a [[mw:Extension:Echo/Creating_a_new_notification_type\|notification]].

	== Implementation notes ==		== Implementation notes ==
Line 46:		Line 46:
	</syntaxhighlight>		</syntaxhighlight>

	Each object in this associative array represents a membership level. The keys (''''e.g.'''' <code>member-gold</code>) indicate the group name that the user is put in. These group names coorespond with the top-level key of the two-dimensional array that is contained in <code>[[mw:$wgGroupPermissions\|$wgGroupPermissions]]</code>The usual MediaWiki system for managing labels for these groups are used. See [[mw:Manual:User_rights#Creating_a_new_group_and_assigning_permissions_to_it\|the MW manual for “Creating a new group”]] for how to handle the display of these groups.		Each object in this associative array represents a membership level. The keys (''e.g.'' <code>member-gold</code>) indicate the group name that the user is put in. These group names coorespond with the top-level key of the two-dimensional array that is contained in <code>[[mw:$wgGroupPermissions\|$wgGroupPermissions]]</code>The usual MediaWiki system for managing labels for these groups are used. See [[mw:Manual:User_rights#Creating_a_new_group_and_assigning_permissions_to_it\|the MW manual for “Creating a new group”]] for how to handle the display of these groups.

	For each object, the <code>cost</code> parameter is required, and any other parameters are optional.		For each object, the <code>cost</code> parameter is required, and any other parameters are optional.

	Immediately after a successful payment the user is assigned to a the group specified in the key (''''e.g.'''' <code>member-individual</code>). If a <code>dependant</code> has also been given, the extension will also assign the groups for that dependant recursively. So, for instance, if someone purchases the <code>member-silver</code> level, they would get assigned the groups <code>member-silver</code>, <code>member-bronze</code> and <code>member-individual</code>.		Immediately after a successful payment the user is assigned to a the group specified in the key (''e.g.'' <code>member-individual</code>). If a <code>dependant</code> has also been given, the extension will also assign the groups for that dependant recursively. So, for instance, if someone purchases the <code>member-silver</code> level, they would get assigned the groups <code>member-silver</code>, <code>member-bronze</code> and <code>member-individual</code>.

Mark Hershberger at 00:19, 5 July 2020

2020-07-05T00:19:56Z

← Older revision		Revision as of 20:19, 4 July 2020
Line 14:		Line 14:
	* Group memberships would be set to [[mw:Help:User_rights_and_groups#User_group_expiry\|automatically expire after one year]].		* Group memberships would be set to [[mw:Help:User_rights_and_groups#User_group_expiry\|automatically expire after one year]].
	* The user should be able to cancel their subscription. If they do, they should be removed from the group.		* The user should be able to cancel their subscription. If they do, they should be removed from the group.
	* If a monthly or yearly payment is missed, then the user and the administrators should be sent a [[mw:Extension:Echo/Creating_a_new_notification_type\|notification]].
	* Administrators are users that have the <code>managemembership</code> right.		* Administrators are users that have the <code>managemembership</code> right.
			* ''''(soft requirement)'''' If a monthly or yearly payment is missed (''''e.g.'''' because of an automatic transaction error at Authorize.Net), then the user and the administrators should be sent a [[mw:Extension:Echo/Creating_a_new_notification_type\|notification]].

	== Implementation notes ==		== Implementation notes ==

Mark Hershberger: initial pass

2020-07-05T00:11:20Z

initial pass

New page

This document provides the specifications for a credit card processing engine that MWStakeholders is having developed.

== Requirements ==

* The extension should use [https://omnipay.thephpleague.com/ Omnipay] to handle [https://developer.authorize.net/ Authorize.Net] transactions and it should set up recurring payments (probably using [https://github.com/cimpleo/omnipay-authorizenetrecurring this package] by [https://cimpleo.com/ cimpleo]), either yearly or monthly.
* The yearly amounts are given on our [[Bylaws/Dues|dues page]].
* If a user chooses monthly payments, then it should be the yearly amount divided by 12 and rounded up to the nearest $.
: So, at the $100 level, it would be $100 ÷ 12 = 8.3̅ ≆ $9 per month
* Credit card info should NOT be stored anywhere.
* Billing address information should be collected.
* Once a person has signed up for a level, they should be put into a corresponding MW group. Group names should correspond with the level of payment.
: At the $100 level, the group would be the individual-subscription, for the $250 level, it would be bronze-subscription, etc.
* Permissions granted by lower groups should automatically be given to the higher group.
* Group memberships would be set to [[mw:Help:User_rights_and_groups#User_group_expiry|automatically expire after one year]].
* The user should be able to cancel their subscription. If they do, they should be removed from the group.
* If a monthly or yearly payment is missed, then the user and the administrators should be sent a [[mw:Extension:Echo/Creating_a_new_notification_type|notification]].
* Administrators are users that have the <code>managemembership</code> right.

== Implementation notes ==

=== Membership tiers ===

Configuration for membership tiers:
<syntaxhighlight lang="json">
{
"member-individual": {
"cost": "100"
},
"member-bronze": {
"cost": "250",
"dependant": "member-individual"
},
"member-silver": {
"cost": "1000",
"dependant": "member-bronze"
},
"member-gold": {
"cost": 2500,
"dependant": "member-silver"
},
"member-platinum": {
"cost": 5000,
"dependant": "member-gold"
}
}
</syntaxhighlight>

Each object in this associative array represents a membership level. The keys (''''e.g.'''' <code>member-gold</code>) indicate the group name that the user is put in. These group names coorespond with the top-level key of the two-dimensional array that is contained in <code>[[mw:$wgGroupPermissions|$wgGroupPermissions]]</code>The usual MediaWiki system for managing labels for these groups are used. See [[mw:Manual:User_rights#Creating_a_new_group_and_assigning_permissions_to_it|the MW manual for “Creating a new group”]] for how to handle the display of these groups.

For each object, the <code>cost</code> parameter is required, and any other parameters are optional.

Immediately after a successful payment the user is assigned to a the group specified in the key (''''e.g.'''' <code>member-individual</code>). If a <code>dependant</code> has also been given, the extension will also assign the groups for that dependant recursively. So, for instance, if someone purchases the <code>member-silver</code> level, they would get assigned the groups <code>member-silver</code>, <code>member-bronze</code> and <code>member-individual</code>.