crystweet
crystweet
Writing a Twitter API Wrapper for the purposes of application-specific queries and streaming. Mainly for my own use. There are better Twitter libraries out there for user-specific queries, such as https://github.com/sferik/twitter-crystal.
TODO
- Call Rate Limit Endpoint when Rate Limit is hit so we don't sleep for more time than needed (https://developer.twitter.com/en/docs/developer-utilities/rate-limit-status/overview.html)
- Figure out how crystal library versions work
- Factor out core "cursor" iterator functionality into an interface/class, make individual subclasses/structs for individual cursors such as user id cursors and what not
- Ya know..., tests
- Verbose mode
- I'm pretty sure I'm using the wrong authentication for app-only queries, so we should either add another client constructor or add an app-specific client
- Lightweight tweet mode - Option to wrap tweet with model containing only essential data
- Support Enterprise Twitter API
- Add some kind of rate limit signal or call some user-inputted lambda on rate limit
Installation
Add this to your application's shard.yml
:
dependencies:
crystweet:
github: akarimcheese/crystweet
Usage
require "crystweet"
Creating a Stream Client
Twitter::Stream::Client.new(
ENV["TWITTER_CONSUMER_KEY"],
ENV["TWITTER_CONSUMER_SECRET"],
ENV["TWITTER_ACCESS_TOKEN"],
ENV["TWITTER_ACCESS_SECRET"]
)
Start a stream
client.stream(track: ["WWE", "John Cena"]) do |tweet|
# do something with Twitter::Response::Tweet instance
# e.g. puts tweet.text
end
Creating a REST Client
client = Twitter::Rest::Client.new(
ENV["TWITTER_CONSUMER_KEY"],
ENV["TWITTER_CONSUMER_SECRET"],
ENV["TWITTER_ACCESS_TOKEN"],
ENV["TWITTER_ACCESS_SECRET"]
)
Having REST Client sleep on rate limit
client.persistent
Finding follower ids for a user as an iterator (lazy query)
ids = client.user("JohnCena").followers_ids
# OR
ids = Twitter::REST::User.new(client, "John Cena").follower_ids
Get a user id iterator as an array (eager query)
ids = ids.to_a
Convert array of user ids to array of fully hydrated users
users = client.user_lookup(ids).lookup_users
# OR
users = Twitter::REST::UserLookup.new(client, ids).lookup_users
TODO: Convert iterator of user ids to fully hydrated users
Development
TODO: Write development instructions here
Contributing
- Fork it ( https://github.com/akarimcheese/crystweet/fork )
- Create your feature branch (git checkout -b my-new-feature)
- Commit your changes (git commit -am 'Add some feature')
- Push to the branch (git push origin my-new-feature)
- Create a new Pull Request
Contributors
- akarimcheese Ayman Karim - creator, maintainer
Repository
crystweet
Owner
Statistic
- 1
- 1
- 2
- 1
- 0
- almost 6 years ago
- September 6, 2017
License
MIT License
Links
Synced at
Mon, 23 Dec 2024 03:56:09 GMT
Languages