Twitter API Ruby thin client wrapper library
Installation
Add this line to your application's Gemfile:
gem 'twitter_api'
And then execute:
$ bundle
Or install it yourself as:
$ gem install twitter_api
Usage
require 'twitter_api'
require 'json'
# create a instance of API wrapper
t = TwitterAPI::Client.new({
:consumer_key => 'YOUR_CONSUMER_KEY',
:consumer_secret => 'YOUR_CONSUMER_SECRET',
:token => 'YOUR_ACCESS_TOKEN',
:token_secret => 'YOUR_ACCESS_SECRET'
})
# call GET statuses/user_timeline
res = t.get('https://api.twitter.com/1.1/statuses/user_timeline.json', {
'screen_name' => 'YOUR_SCREEN_NAME',
'count' => '1',
'tweet_mode' => 'extended'
})
puts res.headers
puts JSON.pretty_generate(JSON.parse(res.body))
# call GET statuses/user_timeline
res = t.statuses_user_timeline({
'screen_name' => 'YOUR_SCREEN_NAME',
'count' => '1',
'tweet_mode' => 'extended'
})
puts res.headers
puts JSON.pretty_generate(JSON.parse(res.body))
# call POST statuses/update
res = t.post('https://api.twitter.com/1.1/statuses/update.json', {
'status' => "hello, world #{Time.now.to_i}"
})
puts res.headers
puts JSON.pretty_generate(JSON.parse(res.body))
# call POST statuses/update
res = t.statuses_update({
'status' => "hello, world #{Time.now.to_i}"
})
puts res.headers
puts JSON.pretty_generate(JSON.parse(res.body))
Documentation
- Documentation for twitter_api http://www.rubydoc.info/gems/twitter_api/
- API reference index — Twitter Developers https://developer.twitter.com/en/docs/api-reference-index
- Tweet updates — Twitter Developers https://developer.twitter.com/en/docs/tweets/tweet-updates.html
- more than 140 characters, tweet_mode=extended, full_text
Development
$ rake -T
rake build # Build twitter_api-X.X.X.gem into the pkg directory
rake clean # Remove any temporary products
rake clobber # Remove any generated files
rake install # Build and install twitter_api-X.X.X.gem into system gems
rake install:local # Build and install twitter_api-X.X.X.gem into system gems without network access
rake release[remote] # Create tag vX.X.X and build and push twitter_api-X.X.X.gem to Rubygems
rake spec # Run RSpec code examples
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/niwasawa/twitter-api-ruby-thin-client-wrapper. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
License
The gem is available as open source under the terms of the MIT License.