https://github.com/yuce/twitter_kit

Erlang Twitter Kit
https://github.com/yuce/twitter_kit

Last synced: 11 months ago
JSON representation

Erlang Twitter Kit

• Host: GitHub
• URL: https://github.com/yuce/twitter_kit
• Owner: yuce
• License: mit
• Created: 2014-11-15T20:05:49.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2015-10-16T17:16:22.000Z (over 10 years ago)
• Last Synced: 2025-01-03T13:46:51.667Z (over 1 year ago)
• Language: Erlang
• Size: 450 KB
• Stars: 1
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
# Twitter Kit

## Introduction

Twitter Kit is an Erlang library for Twitter REST API.

Twitter Kit tries to do as little as it can while abstracting away the boring parts of Twitter API, like authentication and cursors/timelines.

The library is composed of three parts:

1. Authentication functions in `twitter_auth` module,

2. Generic `GET` and `POST` request functions in `twitter_rest` module,

3. Easy and concise API in the `twitter` module.

You won't need to use `twitter_rest` module unless you need something which is not implemented in `twitter` module.

### Features:

 - OAuth authentication,

 - Application (_Bearer_) authentication,

 - Twitter REST API,

 - Cursor and timelines,

 - Media upload,

 - Comprehensive documentation, examples and tests.

### Todo:

 - Easy API for the following REST endpoints: direct_messages, account, blocks, users, mutes, favorites, lists, saved_searches, geo, trends, application, help

 - Streaming API

 - More tests

 - Test on non-recent Erlang versions and Linux

## Install

Twitter Kit uses [Rebar](https://github.com/rebar/rebar) as its build tool. You just need to add it to your `rebar.config` as a dependency:

    {deps, [{twitter_kit, "1.*", {git, "https://github.com/yuce/twitter_kit.git", "master"}}]}.

Twitter Kit uses [jsx](https://github.com/talentdeficit/jsx) to decode JSON responses. You don't need to add it to your config.

## Usage

Here's a simple example which shows how to traverse user timelines:

    % ConsumerKey and ConsumerSecret are defined somewhere.

    % AccessToken and AccessTokenSecret are defined somewhere.

    % They come from the "Keys and Access Tokens" tab of your

    % Twitter "Application Management" page, linked from

    % https://apps.twitter.com

    Auth = twitter_auth:new({consumer, ConsumerKey, ConsumerSecret},

                            {token, AccessToken, AccessTokenSecret}),

    Api = twitter:new(Auth),

    {ok, {Pointer, Tweets}} = twitter:get(Api, {statuses, user_timeline},

                            [{screen_name, "twitter"},

                             {count, 10}]).

    % Do something with the tweets

    % Fetch earlier tweets

    {ok, {Pointer2, EarlierTweets}} = twitter:prev(Pointer).

And another one which shows how to post a tweet with an attached photo:

    % ConsumerKey and ConsumerSecret are defined somewhere.

    % AccessToken and AccessTokenSecret are defined somewhere.

    % They come from the "Keys and Access Tokens" tab of your

    % Twitter "Application Management" page, linked from

    % https://apps.twitter.com

    Auth = twitter_auth:new({consumer, ConsumerKey, ConsumerSecret},

                            {token, AccessToken, AccessTokenSecret}),

    Api = twitter:new(Auth),

    % MediaBinary is the image data, loaded from somewhere, e.g., file system

    {ok, Data} = twitter:post(Api, {media, upload}, {media, "Sample Photo", MediaBinary}),

    {_, MediaId} = lists:keyfind(<<"media_id">>, 1, Data),

    % Post the tweet

    Text = "This is my funny tweet",

    MediaIdStr = integer_to_list(MediaId),

    {ok, Tweet} = twitter:post(Api, {statuses, update}, [{status, Text}, {media_ids, MediaIdStr}]).

See the [docs](doc/) for more documentation.

## Examples and tests

There are some [example scripts](examples/) which show how some common tasks are done.

See: [README for tests](test/README.md).