Twitter provides a streaming API with which you can do interesting things such as listening for tweets that contain specific strings or actions a user might take (e.g. liking a tweet, following someone,...). This package makes it very easy to work with the API.
TwitterStreamingApi::publicStream()
->whenHears('#laravel', function(array $tweet) {
echo "{$tweet['user']['screen_name']} tweeted {$tweet['text']}";
})
->startListening();Here's an example Laravel application with the package pre-installed. It contains an artisan command to kick off the listening process.
We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.
You can install the package via composer:
composer require spatie/laravel-twitter-streaming-apiThe config file must be published with this command:
php artisan vendor:publish --provider="Spatie\LaravelTwitterStreamingApi\TwitterStreamingApiServiceProvider" --tag="config"It will be published in config/laravel-twitter-streaming-api.php
return [
/*
* To work with Twitter's Streaming API you'll need some credentials.
*
* If you don't have credentials yet, head over to https://developers.twitter.com/
*/
'handle' => env('TWITTER_HANDLE'),
'api_key' => env('TWITTER_API_KEY'),
'api_secret_key' => env('TWITTER_API_SECRET_KEY'),
'bearer_token' => env('TWITTER_BEARER_TOKEN'),
];In order to use this package you'll need to get some credentials from Twitter. Head over to the Developer Portal on Twitter to create an application.
Once you've created your application, click on the Keys and tokens tab to retrieve your bearer_token, api_key
and api_secret_key.
Currently, this package works with the public stream and the user stream. Both the PublicStream and UserStream
classes provide a startListening function that kicks of the listening process. Unless you cancel it your PHP process
will execute that function forever. No code after the function will be run.
In the example below a facade is used. If you don't like facades you can replace them with
app(Spatie\LaravelTwitterStreamingApi\TwitterStreamingApi::class)The public stream can be used to listen for specific words that are being tweeted.
The first parameter of whenHears must be a string, or an array containing the word or words you want to listen for. The
second parameter should be a callable that will be executed when one of your words is used on Twitter.
use TwitterStreamingApi;
TwitterStreamingApi::publicStream()
->whenHears('#laravel', function(array $tweet) {
echo "{$tweet['user']['screen_name']} tweeted {$tweet['text']}";
})
->startListening();use TwitterStreamingApi;
TwitterStreamingApi::userStream()
->onEvent(function(array $event) {
if ($event['event'] === 'favorite') {
echo "Our tweet {$event['target_object']['text']} got favorited by {$event['source']['screen_name']}";
}
})
->startListening();When using this in production you could opt to create an artisan command to listen for incoming events from Twitter. You can use Supervisord to make sure that command is running all the time.
These APIs work in realtime, so they could report a lot of activity. If you need to do some heavy work processing that activity it's best to put that work in a queue to keep your listening process fast.
Please see CHANGELOG for more information what has changed recently.
$ composer testPlease see CONTRIBUTING for details.
If you've found a bug regarding security please mail security@spatie.be instead of using the issue tracker.
The MIT License (MIT). Please see License File for more information.
