Shinybooru

A gem which returns an easy to use object for Gelbooru/Safebooru requests

Installation

Add this line to your application's Gemfile:

gem 'shinybooru'

And then execute:

$ bundle

Or install it yourself as:

$ gem install shinybooru

Usage

Creating Booru object

booru = Shinybooru::Booru.new

Optionally, provide the site URL. Only safebooru.org and gelbooru.com are supported at this time.

booru = Shinybooru::Booru.new 'safebooru.org'

Retrieving posts from Gelbooru server

booru = Shinybooru::Booru.new
post = booru.posts 1 #returns Shinybooru::Post

Retrieving posts from Gelbooru server

booru = Shinybooru::Booru.new
posts = booru.posts limit: 10 #returns Array of Shinybooru::Post

Searching for tags

booru = Shinybooru::Booru.new
posts = booru.posts tags: "highres" #returns Shinybooru::Post, with tag highres
posts = booru.posts tags: ["highres", "couple"] #returns Shinybooru::Post, with tags highres, couple

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/calvcoll/shinybooru.

License

The gem is available as open source under the terms of the MIT License.