Compare commits
5
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
c6520b761a | ||
|
|
55d1c34b1f | ||
|
|
565ee0a352 | ||
|
|
a41ad107a1 | ||
|
|
f19ed5c5f2 |
No files matched your search
@@ -30,6 +30,23 @@ You need two values from PayPal: a **Client ID** and a **Secret**.
|
||||
Start in **Sandbox**, make a test donation using a PayPal sandbox buyer account, then repeat the steps
|
||||
with the Live credentials and switch the mode to Live in Settings.
|
||||
|
||||
### Going live
|
||||
1. In the PayPal developer dashboard (Apps & Credentials), switch to **Live** and create a Live app (type Merchant).
|
||||
2. In StreamGoals > Settings, paste the Live **Client ID** and **Secret**.
|
||||
3. Switch the mode to **Live**, then **Save and test connection**.
|
||||
4. Webhook: the plugin registers it for you when the test succeeds (changing mode or credentials clears the old one, so
|
||||
the Live webhook is created fresh). It points to `https://YOUR-SITE/wp-json/streamgoals/v1/webhook` and listens for
|
||||
`PAYMENT.CAPTURE.COMPLETED`. If the message says it could not register it (needs a public https site, or a webhook
|
||||
for that address already exists), add it by hand in your Live app in the PayPal dashboard with that URL and that event.
|
||||
5. Make a small real donation and check it appears under Donations and on your goal, then refund yourself in PayPal if you like.
|
||||
6. Set the visitor IP header if needed (Settings > Advanced; Cloudflare is detected automatically).
|
||||
7. Add the overlays in OBS as Browser Sources (StreamGoals > Overlays).
|
||||
8. Turn on two-factor authentication for both your PayPal and WordPress accounts.
|
||||
|
||||
### Chargebacks and refunds
|
||||
Chargebacks and refunds are handled manually in PayPal. The plugin does not track them, so totals, timers, counters
|
||||
and tiers are not reduced. If you need to compensate, adjust the goal or its rules yourself by editing them.
|
||||
|
||||
### Behind Cloudflare?
|
||||
Nothing to do: the plugin recognises Cloudflare automatically (by its published addresses) so each visitor is rate
|
||||
limited separately. For another proxy, choose it in StreamGoals > Settings > Advanced; the panel there shows what your
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
.sg-donate{max-width:min(100%,440px);font:inherit}
|
||||
.sg-donate{width:100%;max-width:min(100%,440px);margin-left:auto;margin-right:auto;box-sizing:border-box;text-align:left;font:inherit}
|
||||
.sg-donate .sg-row{margin:0 0 .9rem}
|
||||
.sg-donate label{display:block;font-weight:600;margin-bottom:.25rem}
|
||||
.sg-donate label.sg-inline{display:flex;gap:.5rem;align-items:center;font-weight:400}
|
||||
@@ -53,3 +53,7 @@
|
||||
.sg-donate .sg-progress [hidden]{display:none}
|
||||
.sg-donate.sg-progress-only .sg-progress{margin-bottom:0}
|
||||
@media (prefers-reduced-motion:reduce){.sg-donate .sg-progress-fill{transition:none}}
|
||||
.sg-donate .sg-thanks{margin:.5rem 0 0;padding:1.1rem 1rem;border:1px solid rgba(26,127,55,.55);border-left-width:4px;border-radius:.4rem;text-align:center}
|
||||
.sg-donate .sg-thanks:focus{outline:0}
|
||||
.sg-donate .sg-thanks-title{margin:0;font-size:1.15em;font-weight:700;line-height:1.4;overflow-wrap:anywhere}
|
||||
.sg-donate [hidden]{display:none!important}
|
||||
+16
-3
@@ -79,7 +79,7 @@
|
||||
bar.setAttribute('aria-valuenow', String(pct));
|
||||
bar.setAttribute('aria-valuetext', p.reached ? (PT.reached || '') : of + ' (' + pct + '%)');
|
||||
bar.setAttribute('aria-label', String(PT.label || '%s').replace('%s', function () { return p.title; }));
|
||||
bar.firstChild.style.width = pct + '%';
|
||||
bar.firstChild.style.width = ((pct < 2 && (parseInt(p.raised_minor, 10) || 0) > 0) ? 2 : pct) + '%';
|
||||
box.querySelector('.sg-progress-amounts').textContent = of;
|
||||
box.querySelector('.sg-progress-pct').textContent = pct + '%';
|
||||
var tier = box.querySelector('.sg-progress-tier'), done = box.querySelector('.sg-progress-done');
|
||||
@@ -110,7 +110,7 @@
|
||||
refreshAll(true); // a cached page may hold old numbers
|
||||
}
|
||||
// After a successful donation: refresh now, and again shortly (a pending capture can finalize a moment later).
|
||||
function afterDonation() { refreshAll(true); setTimeout(function () { refreshAll(true); }, 5000); }
|
||||
function afterDonation() { refreshAll(true); [1500, 5000, 12000].forEach(function (ms) { setTimeout(function () { refreshAll(true); }, ms); }); }
|
||||
|
||||
function init(root) {
|
||||
var pinned = parseInt(root.getAttribute('data-goal'), 10) || 0;
|
||||
@@ -262,6 +262,18 @@
|
||||
};
|
||||
}
|
||||
|
||||
// Replace the form with a confirmation (keeps the progress bar). No way back until the page is reloaded,
|
||||
// so the donor does not pay twice thinking it failed.
|
||||
function showThanks(text) {
|
||||
state.renderToken++;
|
||||
Array.prototype.forEach.call(root.children, function (n) { if (n !== barBox) { n.hidden = true; } });
|
||||
var panel = el('div', { 'class': 'sg-thanks', role: 'status', tabindex: '-1' }, [
|
||||
el('p', { 'class': 'sg-thanks-title', text: text })
|
||||
]);
|
||||
root.appendChild(panel);
|
||||
try { panel.focus(); panel.scrollIntoView({ block: 'nearest', behavior: 'smooth' }); } catch (e) { /* ignore */ }
|
||||
}
|
||||
|
||||
function renderButtons() {
|
||||
var token = ++state.renderToken;
|
||||
buttons.textContent = '';
|
||||
@@ -277,7 +289,8 @@
|
||||
},
|
||||
onApprove: function (data) {
|
||||
return api('/orders/' + encodeURIComponent(data.orderID) + '/capture', { method: 'POST' }).then(function (r) {
|
||||
say(r.status === 'completed' ? T.thanks : T.processing, 'sg-ok');
|
||||
say('');
|
||||
showThanks(r.status === 'completed' ? T.thanks : T.processing);
|
||||
afterDonation();
|
||||
});
|
||||
},
|
||||
|
||||
@@ -98,13 +98,19 @@ final class DonationsPage {
|
||||
Admin::close();
|
||||
}
|
||||
|
||||
/** Moderation submenu exists only when moderation is on or items are pending (see Admin::menu); otherwise land on Donations. */
|
||||
public static function afterModerationPage( bool $moderationOn, int $pending ): string {
|
||||
return ( $moderationOn || $pending > 0 ) ? 'streamgoals-moderation' : 'streamgoals-donations';
|
||||
}
|
||||
|
||||
public static function handleModerate(): void {
|
||||
Admin::guard( 'sg_moderate' );
|
||||
$post = Admin::post_raw();
|
||||
$id = isset( $post['donation_id'] ) ? absint( $post['donation_id'] ) : 0;
|
||||
$to = isset( $post['decision'] ) && is_string( $post['decision'] ) ? $post['decision'] : '';
|
||||
$ok = $id && Store::setModeration( $id, $to );
|
||||
Admin::redirect( Admin::url( 'streamgoals-moderation' ), $ok ? 'success' : 'error', $ok ? ( 'approved' === $to ? 'Donation approved.' : 'Donation rejected.' ) : 'That donation could not be updated (it may already be reviewed).' );
|
||||
$page = self::afterModerationPage( (bool) Settings::get( 'moderate_messages' ), Store::pendingModerationCount() );
|
||||
Admin::redirect( Admin::url( $page ), $ok ? 'success' : 'error', $ok ? ( 'approved' === $to ? 'Donation approved.' : 'Donation rejected.' ) : 'That donation could not be updated (it may already be reviewed).' );
|
||||
}
|
||||
|
||||
public static function handleExport(): void {
|
||||
|
||||
@@ -76,13 +76,14 @@ final class Progress {
|
||||
public static function html( array $p, array $labels ): string {
|
||||
$e = static fn( string $s ): string => htmlspecialchars( $s, ENT_QUOTES, 'UTF-8' );
|
||||
$pct = max( 0, min( 100, (int) $p['percent'] ) );
|
||||
$fill = ( $pct < 2 && (int) ( $p['raised_minor'] ?? 0 ) > 0 ) ? 2 : $pct; // a first small donation still shows
|
||||
$sub = static fn( string $tpl, array $v ): string => (string) preg_replace_callback( '/%(\d)\$s/', static fn( array $m ): string => $v[ (int) $m[1] - 1 ] ?? '', $tpl );
|
||||
$of = $sub( $labels['of'] ?? '%1$s / %2$s', array( $p['raised_display'], $p['target_display'] ) );
|
||||
$out = '<div class="sg-progress' . ( $p['reached'] ? ' sg-progress-reached' : '' ) . '" data-goal="' . (int) $p['goal_id'] . '">';
|
||||
$out .= '<div class="sg-progress-bar" role="progressbar" aria-valuemin="0" aria-valuemax="100" aria-valuenow="' . $pct . '"'
|
||||
. ' aria-valuetext="' . $e( $p['reached'] ? ( $labels['reached'] ?? '' ) : $of . ' (' . $pct . '%)' ) . '"'
|
||||
. ' aria-label="' . $e( str_replace( '%s', (string) $p['title'], $labels['label'] ?? '%s' ) ) . '">'
|
||||
. '<span class="sg-progress-fill" style="width:' . $pct . '%"></span></div>';
|
||||
. '<span class="sg-progress-fill" style="width:' . $fill . '%"></span></div>';
|
||||
$out .= '<div class="sg-progress-text"><span class="sg-progress-amounts">' . $e( $of ) . '</span> <span class="sg-progress-pct">' . $pct . '%</span></div>';
|
||||
$out .= '<p class="sg-progress-tier"' . ( $p['tier'] ? '' : ' hidden' ) . '>'
|
||||
. ( $p['tier'] ? $e( $sub( $labels['tier'] ?? '%1$s (%2$s)', array( $p['tier']['title'], $p['tier']['target_display'] ) ) ) : '' ) . '</p>';
|
||||
|
||||
@@ -85,6 +85,7 @@ final class DonateController {
|
||||
$res = rest_ensure_response( self::progress_for( $goal ) );
|
||||
// Short shared cache lets a CDN collapse bursts; the page JS adds a cache-busting parameter after a donation.
|
||||
$res->header( 'Cache-Control', 'public, max-age=10, s-maxage=10' );
|
||||
$res->header( 'X-LiteSpeed-Cache-Control', 'no-cache' ); // LiteSpeed would otherwise hold REST responses for days
|
||||
return $res;
|
||||
}
|
||||
|
||||
|
||||
@@ -5,6 +5,7 @@ namespace StreamGoals\Tests\Unit;
|
||||
|
||||
use PHPUnit\Framework\TestCase;
|
||||
use StreamGoals\Admin\Csv;
|
||||
use StreamGoals\Admin\DonationsPage;
|
||||
use StreamGoals\Admin\Format;
|
||||
use StreamGoals\Admin\Input;
|
||||
use StreamGoals\Admin\RuleConfig;
|
||||
@@ -133,4 +134,11 @@ final class AdminLogicTest extends TestCase {
|
||||
$this->assertTrue( Format::isTest( array( 'paypal_order_id' => 'TEST-abc' ) ) );
|
||||
$this->assertFalse( Format::isTest( array( 'paypal_order_id' => '5O1234' ) ) );
|
||||
}
|
||||
|
||||
public function test_after_moderation_redirect_only_to_registered_page(): void {
|
||||
$this->assertSame( 'streamgoals-donations', DonationsPage::afterModerationPage( false, 0 ) );
|
||||
$this->assertSame( 'streamgoals-moderation', DonationsPage::afterModerationPage( false, 2 ) );
|
||||
$this->assertSame( 'streamgoals-moderation', DonationsPage::afterModerationPage( true, 0 ) );
|
||||
$this->assertSame( 'streamgoals-moderation', DonationsPage::afterModerationPage( true, 5 ) );
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user