Naughty Platypus Memorabilia
    Have ideas to improve npm?Join in the discussion! »

    juttle-twitter-adapter

    0.4.0 • Public • Published

    Juttle Twitter Adapter

    Twitter adapter for the Juttle data flow language.

    Examples

    Filter the real-time Twitter stream for all tweets containing "potus"

    read twitter -to :end: 'potus'

    Read the last 100 historical tweets referencing "potus":

    read twitter -from :0: -limit 100 'potus'
    

    An end-to-end example is described here and deployed to the demo system demo.juttle.io.

    Installation

    Like Juttle itself, the adapter is installed as a npm package. Both Juttle and the adapter need to be installed side-by-side:

    $ npm install juttle
    $ npm install juttle-twitter-adapter

    Configuration

    The adapter needs to be registered and configured so that it can be used from within Juttle. To do so, add the following to your ~/.juttle/config.json file:

    {
        "adapters": {
            "twitter": {
                "consumer_key": "...",
                "consumer_secret": "...",
                "access_token_key": "...",
                "access_token_secret": "..."
            }
        }
    }

    To obtain Twitter credentials, first set up a Twitter App and create an OAuth token.

    Usage

    The adapter can run in two modes -- streaming or historical, controlled by the -from and -to options.

    For historical searches, specify -from :0: (and optionally -to :now:) to indicate that the read should start at the beginning of time and continue to the present.

    For live searches, specify -to :end: (and optionally -from :now:) to indicate that the read should start at the current time and continue indefinitely.

    In both cases the adapter requires a single search term in the filter expression, as shown in the examples above.

    Historical searches are somewhat constrained by the fact that Twitter's API returns tweets in reverse chronological order, but Juttle semantics require data points to be emitted in order.

    To handle this, the adapter buffers all the points in memory before emitting them down the flowgraph. There is a limit to control how many points are buffered, which defaults to 1000. This can be overridden using the limit option.

    In streaming mode, the adapter will buffer all points for a configurable delay (the lag option) so that they can be properly sorted into increasing time order.

    Options

    Name Type Required Description
    from moment no time to start reading the data -- must be either :now: or :0:
    to moment no time to stop reading the data -- must be either :now: or 🔚
    limit integer no maximum number of tweets to emit in historical mode (default: 1000)
    fetchSize integer no number of tweets to fetch per round-trip in historical mode (default: 100, max: 100)
    lag duration no in streaming mode, delay for the given amount of time to reorder incoming points (default: 2 seconds)

    Contributing

    Want to contribute? Awesome! Don’t hesitate to file an issue or open a pull request.

    Install

    npm i juttle-twitter-adapter

    DownloadsWeekly Downloads

    1

    Version

    0.4.0

    License

    Apache-2.0

    Last publish

    Collaborators

    • avatar