ricardoboss/webhook-tweeter

This package is abandoned and no longer maintained. No replacement package was suggested.

Validating and parsing of GitHub webhook requests and posting to Twitter

v0.4 2023-03-18 11:47 UTC

Requires

• php: ^8.1
• coderjerk/bird-elephant: ^0.4
• psr/http-message: ^1.0

Requires (Dev)

• mockery/mockery: ^1.5
• nyholm/psr7: ^1.5
• phpunit/phpunit: ^9.6

MIT

• Ricardo Boss

README

This package aims to provide simple interfaces to implement a webhook-based tweeting system.

This can, for example, be used to tweet a release notification when a new release is published to a GitHub repository.

Installation

composer require ricardoboss/webhook-tweeter

Usage

<?php

use ricardoboss\WebhookTweeter\WebhookTweeterConfig;
use ricardoboss\WebhookTweeter\Simple\SimpleWebhookTweeterRenderer;
use ricardoboss\WebhookTweeter\Simple\SimpleWebhookTweeterTemplateLocator;
use ricardoboss\WebhookTweeter\WebhookTweeterHandler;
use ricardoboss\WebhookTweeter\API\BirdElephantTwitterAPI;

// 1. Create a config object
// you can also pass \Stringable objects instead of strings
$config = new WebhookTweeterConfig(
    'webhook_url',
    'webhook_secret' // nullable
);

// 2. Create an instance of WebhookTweeterRenderer
// either use your own renderer or use the simple renderer
$renderer = new SimpleWebhookTweeterRenderer();

// 3. Create a template locator instance
// the simple locator looks for files in the given directory and the given extension (name is passed to the getMatchingTemplate method)
$locator = new SimpleWebhookTweeterTemplateLocator(__DIR__ . '/templates', '.md');

// 4. Create a Twitter API client implementing WebhookTweeterTwitterAPI
$twitter = new BirdElephantTwitterAPI();
$twitter->setCredentials([
    'bearer_token' => xxxxxx, // OAuth 2.0 Bearer Token requests
    'consumer_key' => xxxxxx, // identifies your app, always needed
    'consumer_secret' => xxxxxx, // app secret, always needed
    'token_identifier' => xxxxxx, // OAuth 1.0a User Context requests
    'token_secret' => xxxxxx, // OAuth 1.0a User Context requests
]);

// 5. Create a WebhookTweeterHandler instance
$handler = new WebhookTweeterHandler($config, $renderer, $locator, $twitter);

// 6. Get a PSR-7 request object
$request = /* get your request implementation */;

// 7. Handle the request (sends a rendered tweet)
$result = $handler->handle($request);

The $result variable holds a WebhookTweeterResult instance. The result has the following properties:

• $result->success: true if the tweet was sent successfully, false otherwise
• $result->message: an error message if the tweet was not sent successfully
• $result->url: a URL to the tweet
• $result->tweet: the tweet object returned from the Twitter API

Credits

Thanks to danieldevine for creating BirdElephant and providing a neat PHP interface for the Twitter V2 API!

License

This project is licensed under the MIT license. Read more about it here.