This gem wraps openBD Web API.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
lib
sample
spec
.gitignore
.rspec
.ruby-version
.travis.yml
CHANGELOG.md
CODE_OF_CONDUCT.md
Gemfile
LICENSE.txt
README.md
Rakefile
openbd_api.gemspec

README.md

OpenBD

Gem Version Build Status

This gem wraps openBD Web API.

Installation

Add this line to your application's Gemfile:

gem 'openbd_api'

And then execute:

$ bundle

Or install it yourself as:

$ gem install openbd_api

Usage

Library

Like this.

require 'openbd_api'

# create instance
client = OpenBD::Client.new

# get
client.get 9784309226712
client.get '9784309226712'
client.get '9784309226712,9784309226729'
client.get [9784309226712,9784309226729]
client.get ['9784309226712','9784309226729']

# bulk_get
client.bulk_get 9784309226712
client.bulk_get '9784309226712'
client.bulk_get '9784309226712,9784309226729'
client.bulk_get [9784309226712,9784309226729]
client.bulk_get ['9784309226712','9784309226729']

# coverage
client.coverage

# schema
client.schema

CLI

openbd executable calls OpenBD `s methods.

$ openbd get 9784309226712
$ openbd bulk_get 9784309226712 9784309226729
$ openbd coverage
$ openbd schema
$ openbd --help
Usage: openbd <method> [arguments] [options]

Supported <method>:
  get       Find book data by ISBN(s)
  bulk_get  Find book data by ISBN(s)
  coverage  Show all ISBNs in openBD
  schema    Show the JSON Schema of openBD

    -v, --version  print the version
    -h, --help     print help

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/nasum/openbd. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

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