⚠️ In Development
The gem is currently in development and is NOT recommended for production use. I'm currently working on a beta branch with complete docs, tests, and updated endpoints. Feel free to try the beta branch out!
Tweetkit is a Ruby wrapper for Twitter's V2 API.
Add this line to your application's Gemfile:
And then execute:
$ bundle install
Or install it yourself as:
$ gem install tweetkit
- Require the gem.
- Initialize a
Tweetkit::Clientinstance by passing in your
Bearer Tokento work with Twitter's
OAuth 2.0authorization requirement. You should also pass in your consumer key and token to perform requests that require
# Initializing via options client = Tweetkit::Client.new(bearer_token: 'YOUR_BEARER_TOKEN_HERE') # Initializing via options with OAuth 1.0 credentials client = Tweetkit::Client.new(bearer_token: 'YOUR_BEARER_TOKEN_HERE', consumer_key: 'YOUR_CONSUMER_KEY_HERE', consumer_secret: 'YOUR_CONSUMER_SECRET_HERE') # You can also initialize the client with a block client = Tweetkit::Client.new do |config| config.bearer_token = 'YOUR_BEARER_TOKEN_HERE' config.consumer_key = 'YOUR_CONSUMER_KEY_HERE' config.consumer_secret = 'YOUR_CONSUMER_SECRET_HERE' end
- Interact with the Twitter API as needed. Below is an example of fetching a tweet with id
response = client.tweet(1234567890)
After checking out the repo, run
bin/setup to install dependencies.
To run tests, first copy
.env, and modify it to include a valid Bearer token for the Twitter v2 API. Then, run
bundle exec rspec to run the tests. You can also run
bin/console for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run
bundle exec rake install. To release a new version, update the version number in
version.rb, and then run
bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the
.gem file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/julianfssen/tweetkit.