Skip to content
Spruce is a Ruby wrapper around the Forrst API
Ruby
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib
spec
.gitignore
MIT-LICENSE
README.rdoc
Rakefile
spruce.gemspec

README.rdoc

Spruce ↟

Spruce is a Ruby wrapper around the Forrst API. The Forrst API is currently a moving target and the plan is to develop Spruce alongside it, as close as possible. Spruce will support authentication via API tokens.

Installation

gem install spruce

Dependencies

The YAJL C Bindings for Ruby are so full of AWESOME that it is almost impossible to not use them everywhere JSON is involved, so I didn’t.

I’m also temporarily using the REST Client gem until the Forrst API returns the correct MIME type and status codes.

Getting started

require 'rubygems'
require 'forrst' # or require 'spruce'

# Retrieve a user by username
kyle = Forrst::User.find 'kyle'

# Kyles latest PUBLIC posts
kyle.public_posts

# The type of Kyles latest PUBLIC post
kyle.public_posts[0].post_type

# Kyles PUBLIC posts before post_id 5000
kyle.public_posts_before(5000)

# Retrieve a user by id
peter = Forrst::User.find 5079

Links

TODO

Implement the different post types by subclassing *Forrst::Post*

LICENCE

Copyright © 2010 Peter Hellberg

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.

You can’t perform that action at this time.