https://github.com/wolfiestyle/LuaTwit

Lua library for accessing the Twitter REST and Streaming API v1.1
https://github.com/wolfiestyle/LuaTwit

Last synced: 12 months ago
JSON representation

Lua library for accessing the Twitter REST and Streaming API v1.1

• Host: GitHub
• URL: https://github.com/wolfiestyle/LuaTwit
• Owner: wolfiestyle
• License: mit
• Created: 2013-08-24T04:58:53.000Z (almost 13 years ago)
• Default Branch: master
• Last Pushed: 2017-11-02T21:15:06.000Z (over 8 years ago)
• Last Synced: 2024-11-25T02:33:16.270Z (over 1 year ago)
• Language: Lua
• Homepage:
• Size: 612 KB
• Stars: 27
• Watchers: 7
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# LuaTwit

Lua library for accessing the Twitter REST and Streaming API v1.1.

It implements simple parameter checking and returns metatable-typed JSON data.

## Dependencies

- dkjson

- lua-curl

- oauth_light

Also you'll need `ldoc` if you want to build the docs and `penlight` to run the examples.

## Documentation

Available online [here](http://darkstalker.github.io/LuaTwit/master).

## Installation

Using LuaRocks:

    luarocks install luatwit

## Usage

First, you need a set of app keys. You can get them from [here](https://apps.twitter.com/).

    local luatwit = require "luatwit"

    -- Fill in your app keys here

    local keys = {

        consumer_key = "",

        consumer_secret = "",

        oauth_token = "",

        oauth_token_secret= "",

    }

The twitter client is created by the method `luatwit.api.new`:

    local client = luatwit.api.new(keys)

Use this object to do API calls. The argument names are checked against the definitions in `luatwit.resources`:

    local result = client:get_home_timeline{ count = 1 }

The JSON data is returned in a table:

    print(result[1].user.screen_name, result[1].text)

The returned data has a metatable (from `luatwit.objects`) that describes the object type:

    print(result._type)         -- "tweet_list"

    print(result[1]._type)      -- "tweet"

    print(result[1].user._type) -- "user"

The type metatables also provide convenience methods:

    result[1]:set_favorite():retweet()

    result[1]:reply{ status = "answer!", _mention = true }

The methods can be called in async mode, and they'll return a future object that can be read with `:peek()` and `:wait()`:

    local res_f = client:get_user{ user_id = 783214, _async = true }

    print(res_f._type)          -- "future"

    print(res_f:wait().screen_name)