Treat your tweets like your inbox
Ruby JavaScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
app
config
db/migrate
public
.rvmrc
Gemfile
Gemfile.lock
README.md
Rakefile
config.ru

README.md

Hoi Polloi!

Treat your tweets like an inbox

Hoi Polloi! is a small Twitter client that regularly reads in your tweets and mentions and generates conversations. It allows you to keep track of what mentions you've replied to and what conversations you're having.

It's pretty basic and slow right now, so I wouldn't recommend it for serious use. I'm working improving the code base, adding some tests and expanding the functionality. Additionally, the conversation generation engine is a little funky.

What It Does

  • Pulls in tweets and mentions
  • Organises tweets by conversation
  • Intelligent conversation 'reading'
  • Inline reply

What It Will Do

  • Entire back-catalogue of tweets
  • Searching
  • Starred tweets (maybe linking in with favourites?)
  • Pagination
  • Exposing the tweets as an SMTP server for use with a real mail client
  • API
  • Tags/categories

The Tech

Currently, Hoi Polloi! is written with:

  • Ruby 1.9.2
  • Sinatra 1.3.2
  • MySQL 5.5.15

However, I'm seriously rethinking using MySQL, in favour of MongoDB. I'm umming and ahhing about the best way to store the large amounts of data that accrue with using this app.

How to get it running locally

Clone the repository and change into the directory. Make sure you add your database connection DSN string, and your Twitter API consumer token and secret as environment variables:

$ export DATABASE_URL=mysql://root@localhost/hoipolloi_development
$ export TWITTER_CONSUMER_KEY=blah
$ export TWITTER_CONSUMER_SECRET=blah

Set up the environment with Bundler:

$ bundle install

Run the migrations:

$ rake db:migrate

And rack it up!

$ bundle exec rackup config.ru

What's the name about?

Hoi polloi is a wonderful gem I discovered in the English lexicon describing, in plural, the masses, the people, les gens. The exclamation point is there because exclamation points are awesome.

It's pronounced hoy pol-oy.

License

The Hoi Polloi! codebase is licensed under the MIT license, which means you can do whatever you like with it, as long as you keep the copyright notices in the code.

Copyright (C) 2012 Jamie Rumbelow.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.