rubyku

DESCRIPTION:

Rubyku is a ruby library for accessing data via the Jaiku API.

FEATURES/PROBLEMS:

Rubyku 0.2.0: Talk to me!

Basic functionality: complete! You can now post to Jaiku from Rubyku. There are still some nice functionalities that need to be added in, like support for icons, generated posts, and locations. Also it’d be nice if we had some means of responding to posts… the API doesn’t allow for that just yet, but we may be able to do something.

EXAMPLE:

Just to whet your appetite:

#provide log in details for the service
cred = Rubyku::Credentials.new
cred.username = 'duwanis'
cred.password = 'password' # or cred.api_key = 'apikeygoeshere' if you want to do it that way
Rubyku::Settings.jaiku_credentials = cred #so you don't have to keep passing cred around
user = Rubyku::User.fetch 'duwanis' #and now we're off to the races
user.updates # => a list of Rubyku::Messages representing my latest updates
user.stream # => a list of Rubyku::Messages representing my contacts' latest updates
Rubyku::Request.update "I'm Rubykutacular!" # posts "I'm Rubykutacular!" to your Jaiku stream.

etc. Have fun :)

REQUIREMENTS:

Currently, the only other gem required for rubyku is json > 1.0.0. I’m trying to keep it simple.

TESTING:

Hah, notice how there isn’t any automated testing? I’d really like to have automated test suites for rubyku, but it’s not an easy thing to do since it’s so tightly coupled with a web service that requires authentication. Let me know if you have any ideas, though.

INSTALL:

sudo gem install duwanis-rubyku –source=gems.github.com

LICENSE:

(The MIT License)

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.