THE RHYMESTORE PROJECT
The Rhymestore Project provides an easy way to create Twitter bots that respond to user mentions with a sentence that rhymes perfectly with the received message. It also provides a management interface to access the rhyme knowledge base.
The Rhymestore project uses Redis to store the rhymes. You can download it from: http://redis.io
Refer to Redis installation instructions if you need any help installing it.
Rhymestore can be compiled as a standard Maven project:
mvn clean package
That will run all unit tests, and generate the rhymestore.war file in the target/ folder.
You will need a running Redis instance while compiling, since unit tests will test persistence.
To run the integration tests to test Twitter and default rhyme downloading,
you need to configure the Twitter credentials. You can set the following
profile in your Maven
<profile> <id>rhymestore</id> <properties> <twitter.consumerKey>your_consumer_key</twitter.consumerKey> <twitter.consumerSecret>your_consumer_secret</twitter.consumerSecret> <twitter.accessToken>your_access_token</twitter.accessToken> <twitter.accessTokenSecret>your_access_token_secret</twitter.accessTokenSecret> </properties> </profile>
Once the Twitter credentials have been configured, you can build and run the integration tests as follows:
mvn clean verify -P rhymestore
If you don't have your accessToken and accessTokenSecret, you can use the
com.rhymestore.twitter.AccessTokenGenerator main class to generate them.
The generated rhymestore.war file can be deployed to any servlet container.
In order to connect to Twitter, you will need to configure the following system properties:
-Dtwitter4j.oauth.consumerKey=your_consumer_key -Dtwitter4j.oauth.consumerSecret=your_consumer_secret -Dtwitter4j.oauth.accessToken=your_access_token -Dtwitter4j.oauth.accessTokenSecret=your_access_token_secret
Once the application is started, you need to have a running Redis instance and Internet access to let the application connect to the configured Twitter account.
By default, the Rhymestore application comes with HTTP Basic Authentication
security configured. You can configure security in your application server
or disable the security settings in the
Customizing and Contributing
Currently, there is only support for the Spanish language. Support for rhymes in other
languages can be added by implementing the
and adding a unit test class that extends the base class:
The WordParser implementation to use can be configured in the
Any contribution to the project is welcome. Feel free to check it out from the Project site and play with it.
Note on patches/pull requests
- Fork the project.
- Make your feature addition or bug fix.
- Add tests for it. This is important so I don't break it in a future version unintentionally.
- Send me a pull request. Bonus points for topic branches.
If you find any issue, please submit it to the Bug tracking system and we will do our best to fix it.
See LICENSE file.
Special thanks to Andrea Cansirro (isochronic) for his generosity by hosting the first Rhymestore application and for his dedication in setting up an optimal environment to run it.