Sign in with Twitter

A Ruby on Rails application that demonstrates how to use the Sign in with Twitter workflow using the twitter gem and OmniAuth.

Demo

You can see a running version of the application at http://sign-in-with-twitter.herokuapp.com/.

Installation

git clone git://github.com/sferik/sign-in-with-twitter.git
cd sign-in-with-twitter
bundle install

Usage

Sign in with Twitter requires you to register an app with Twitter to obtain OAuth credentials. Once you obtain credentials, substitute your consumer key and secret into the command below.

Sign in with twitter requires a callback url, otherwise you will see a "401 Unauthorized" error. The callback url can be any url, except localhost.

CONSUMER_KEY=abc CONSUMER_SECRET=123 rails server

Contributing

In the spirit of free software, everyone is encouraged to help improve this project.

Here are some ways you can contribute:

by using alpha, beta, and prerelease versions
by reporting bugs
by suggesting new features
by writing or editing documentation
by writing specifications
by writing code (no patch is too small: fix typos, add comments, clean up inconsistent whitespace)
by refactoring code
by closing issues
by reviewing patches

Submitting an Issue

We use the GitHub issue tracker to track bugs and features. Before submitting a bug report or feature request, check to make sure it hasn't already been submitted. When submitting a bug report, please include a Gist that includes a stack trace and any details that may be necessary to reproduce the bug, including your gem version, Ruby version, and operating system. Ideally, a bug report should include a pull request with failing specs.

Submitting a Pull Request

Fork the repository.
Create a topic branch.
Add specs for your unimplemented feature or bug fix.
Run bundle exec rake test. If your specs pass, return to step 3.
Implement your feature or bug fix.
Run bundle exec rake test. If your specs fail, return to step 5.
Run open coverage/index.html. If your changes are not completely covered by your tests, return to step 3.
Add, commit, and push your changes.
Submit a pull request.

Supported Ruby Version

This library aims to support and is tested against Ruby version 2.2.2.

If something doesn't work on this version, it should be considered a bug.

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

If you would like this library to support another Ruby version, 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 personally 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.

sferik/sign-in-with-twitter

sferik

Reviews

Repository Details