Announcements

Mailing List

Apps Wiki

Does your project or organization use this gem? Add it to the apps
wiki!

Configuration

Twitter API v1.1 requires you to authenticate via OAuth, so you'll need to
register your application with Twitter. Once you've registered an
application, make sure to set the correct access level, otherwise you may see
the error:

Read-only application cannot POST

Your new application will be assigned a consumer key/secret pair and you will
be assigned an OAuth access token/secret pair for that application. You'll need
to configure these values before you make a request or else you'll get the
error:

Bad Authentication data

You can pass configuration options as a block to Twitter::REST::Client.new.

Object Graph

This entity-relationship diagram is generated programatically. If you add or
remove any Twitter objects, please regenerate the ERD with the following
command:

bundle exec rake erd

Supported Ruby Versions

This library aims to support and is tested against the following Ruby
versions:

Ruby 1.9.3

Ruby 2.0.0

Ruby 2.1

JRuby 1.7 (in Ruby 1.9 mode)

If something doesn't work on one of these versions, it's a bug.

This library may inadvertently work (or seem to work) on other Ruby versions,
however support will only be provided for the versions listed above.

If you would like this library to support another Ruby version or
implementation, you may volunteer to be a maintainer. Being a maintainer
entails making sure all tests run and pass on that implementation. When
something breaks on your implementation, you will be responsible for providing
patches in a timely fashion. If critical issues for a particular implementation
exist at the time of a major release, support for that Ruby version may be
dropped.

Versioning

This library aims to adhere to Semantic Versioning 2.0.0. Violations
of this scheme should be reported as bugs. Specifically, if a minor or patch
version is released that breaks backward compatibility, that version should be
immediately yanked and/or a new version should be immediately released that
restores compatibility. Breaking changes to the public API will only be
introduced with new major versions. As a result of this policy, you can (and
should) specify a dependency on this gem using the Pessimistic Version
Constraint with two digits of precision. For example: