Dear followers!
There are many social networks out there. This software aggregates information from different networks to one xml-stream, which you can reuse. For instance on your personal website to show some of your activity to your audience or as your personal news feed.
Basically the system is designed to be extensible via plugins. It's shipped with the following ones:
- Facebook (
facebook) - Google+ (
google_plus) - Twitter (
twitter) - LastFM (
lastfm) - YouTube - maybe later
- RSS feeds (
feed)- dosen't work on Windows at the moment
xml and callbacks
Right now the aggregator supports the following platform:
- Ruby 2.1 on Linux and Windows
Please write a bug report or feature requests to improve the software. Send pull requests to be an active user. Thank you very much!
- Set up
RubyorJRuby(real multithreading),RubyGemsand a supported database system - Get your version of the social aggregator and change to it's directory
- Run
bundle installto install all the necesserily gems - Run
rake installto get the social aggregator ready - Set up and configure plugins/providers
- Execute the
Aggregator.rb(e. g.ruby Aggregator.rb -h) and have fun!
- Connect to database
- Add a role for aggregator:
CREATE ROLE aggregator WITH CREATEDB LOGIN PASSWORD 'aggregator'; - Create database:
CREATE DATABASE aggregator OWNER aggregator; - Setup suitable authentication for created role
If your copy is still linked with this git repository, then you can follow this two steps:
- Run
git remote updateto update the Social Aggreator - Run
rake aggregator:migrateto migrate the database to the updates version.
Please use file access restriction to protect your sensitive data:
- Plugin configuration files, which contain api keys
- Database, which contains all personal data
Please protect the REST API from foreign access.
The following rake tasks are defined:
rake aggregator:[task]
| task | parameter | description |
|---|---|---|
migrate |
[env=(development|test|production)](default: production)[ver=(version number)](default: last version) |
Initialize/Migrate database |
install |
[env=(development|test|production)](default: production)[ver=(version number)](default: last version) |
Set up the environment for aggregator |
truncate |
[env=(development|test|production)](default: production) |
Truncate database (all data from database). |
You can utilize the aggregator directly via commandline. It uses a built in webrick server in this case. It's planned that other servers can be used, but that is not implemented yet.
aggregator.rb [arguments]
| shortcut | parameter | description |
|---|---|---|
-e |
--environment |
Select an environment (development, test or production) |
-q |
--quiet |
No output to stdout |
-v |
--verbose |
Run verbosely |
-c |
--console |
Start a console session |
-h |
--help |
Show this message |
--version |
Show version |
Usually it's a good idea to have a look into the log files, especially the tmp/log/aggregator.log could be interesting, while the software is quite talkative. You should also consider to utilize the interactive ruby shell.
Please have a look into the wiki.
There is a built-in command line (IRB). You'll have access from there to:
- all models
You can generate the source code documentation anytime with yardoc from the document root. You'll find the generated documentation in ./doc/yard/.
Things, which need to be said!
Thank you JetBrains for providing us a license for our open source project.
Thanks to all users, who helped to improve the software!
- Thanks for the icons, which are used in the banner.
- Thanks for the font, which is used in the banner.
- Thanks for the twitter gem, which is used in the twitter plugin.
- Thanks for the feedzirra gem, which is used in the feed plugin.
- Thanks for the lastfm gem, which is used in the lastfm plugin.
This projected is licensed under the terms of the GPL v3 license. Please consult the license file for further information.
Copyright © 2013 - 2014 Robin Bühler