{"id":20039249,"url":"https://github.com/sampatbadhe/isbndb-ruby","last_synced_at":"2025-05-05T07:32:34.293Z","repository":{"id":41584077,"uuid":"245688371","full_name":"sampatbadhe/isbndb-ruby","owner":"sampatbadhe","description":"Unofficial Ruby library for ISBNdb API V2","archived":false,"fork":false,"pushed_at":"2024-06-15T15:05:01.000Z","size":44,"stargazers_count":4,"open_issues_count":0,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-03T09:08:18.978Z","etag":null,"topics":["api-wrapper","isbndb","ruby","v2"],"latest_commit_sha":null,"homepage":"https://isbndb.com/apidocs/v2","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sampatbadhe.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-03-07T18:57:01.000Z","updated_at":"2024-06-15T15:05:04.000Z","dependencies_parsed_at":"2024-11-13T10:48:31.004Z","dependency_job_id":null,"html_url":"https://github.com/sampatbadhe/isbndb-ruby","commit_stats":{"total_commits":15,"total_committers":2,"mean_commits":7.5,"dds":0.06666666666666665,"last_synced_commit":"c19cfa570a0cdbc4f35f566b09f379f1cb7dcc30"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sampatbadhe%2Fisbndb-ruby","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sampatbadhe%2Fisbndb-ruby/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sampatbadhe%2Fisbndb-ruby/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sampatbadhe%2Fisbndb-ruby/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sampatbadhe","download_url":"https://codeload.github.com/sampatbadhe/isbndb-ruby/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252458599,"owners_count":21751068,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-wrapper","isbndb","ruby","v2"],"created_at":"2024-11-13T10:36:38.021Z","updated_at":"2025-05-05T07:32:33.917Z","avatar_url":"https://github.com/sampatbadhe.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Ruby library for ISBNdb API v2\n\n[![Build Status](https://semaphoreci.com/api/v1/sampat-badhe/isbndb-ruby/branches/master/badge.svg)](https://semaphoreci.com/sampat-badhe/isbndb-ruby)\n[![Test Coverage](https://api.codeclimate.com/v1/badges/b3e523707c8cbaf73ea3/test_coverage)](https://codeclimate.com/github/sampatbadhe/isbndb-ruby/test_coverage)\n\n* [Homepage](https://isbndb.com/)\n* [API Documentation](https://isbndb.com/apidocs/v2)\n* [Register](https://isbndb.com/isbn-database)\n\n## Description\n\nProvides a Ruby interface to [ISBNdb](https://isbndb.com/). This library is designed to help ruby applications consume the ISBNdb API v2.\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'isbndb-ruby'\n```\n\nAnd then execute:\n\n    $ bundle\n\nOr install it yourself as:\n\n    $ gem install isbndb-ruby\n\n## Usage\n\n### Setup\n\nRegister for your API KEY at https://isbndb.com/isbn-database\n\n**Initialize**\n```ruby\n  require 'isbndb'\n\n  isbndb_api_client = ISBNdb::ApiClient.new(api_key: api_key)\n```\n\n**Account Stats**\n```ruby\n  #=\u003e Returns a status object about the ISBNDB database.\n  isbndb_api_client.stats\n```\n\n**Author**\n\n- Get single author details\n\n```ruby\n  #=\u003e Returns the author name and a list of books by the author.\n  isbndb_api_client.author.find(name, options)\n    name = `The name of an author in the Author's database`\n    options = {\n      page: 1,\n      pageSize: 20\n    }\n```\n\n- Authors List\n\n```ruby\n  #=\u003e This returns a list of authors who's name matches the given query.\n  isbndb_api_client.author.batch(query, options)\n    query = `A string to search for in the Author’s database`\n    options = {\n      page: 1, # for books\n      pageSize: 20 # for books\n    }\n```\n\n- Authors Search\n\n```ruby\n  #=\u003e This returns a list of authors who's name matches the given query.\n  isbndb_api_client.author.search(options)\n    options = {\n      page: 1,\n      pageSize: 20,\n      author: `The name of an author in the Author's database`,\n      text: `A string to search for determinate author database`\n    }\n```\n\n**Book**\n\n- Get single book details\n\n```ruby\n  #=\u003e Returns the book details\n  isbndb_api_client.book.find(isbn)\n    isbn = `an ISBN 10 or ISBN 13 in the Books database`\n```\n\n- Books List\n\n```ruby\n  #=\u003e This returns a list of books that match the query\n  isbndb_api_client.book.batch(query, options)\n    query = `A string to search for in the Book’s database`\n    options = {\n      page: 1,\n      pageSize: 20,\n      column: specify the column to search\n              - '' - Empty value search in every column\n              - title - Only searches in Books Title\n              - author - Only searches books by the given Author\n              - Available values : , title, author,\n      beta: A integer (1 or 0) for enable or disable beta searching.\n            Default value : 0 (disabled)\n```\n\n- Books Search\n\n```ruby\n  #=\u003e This returns a list of authors who's name matches the given query.\n  isbndb_api_client.author.search(options)\n    options = {\n      page: 1,\n      pageSize: 20,\n      isbn: `an ISBN 10 in the Books database`,\n      isbn13: `an ISBN 13 in the Books database`,\n      text: `A string to search for determinate author database`\n    }\n```\n\n**Publisher**\n\n- Get single publisher details\n\n```ruby\n  #=\u003e Returns the publisher name and a list of books by the publisher.\n  isbndb_api_client.publisher.find(name, options)\n    name =  `The name of a publisher in the Publisher's database`\n    options = {\n      page: 1,\n      pageSize: 20\n    }\n```\n\n- Publishers List\n\n```ruby\n  #=\u003e This returns a list of publishers who's name matches the given query.\n  isbndb_api_client.publisher.batch(query, options)\n    query = `A string to search for in the Publisher’s database`\n    options = {\n      page: 1, # for books\n      pageSize: 20 # for books\n    }\n```\n\n- Publishers Search\n\n```ruby\n  #=\u003e This returns a list of publishers who's name matches the given query.\n  isbndb_api_client.publisher.search(options)\n    options = {\n      page: 1,\n      pageSize: 20,\n      publisher: `The name of an publisher in the publisher's database`,\n      text: `A string to search for determinate publisher database`\n    }\n```\n\n**Subject**\n\n- Get single subject details\n\n```ruby\n  #=\u003e Returns the subject name and a list of books by the subject.\n  isbndb_api_client.subject.find(name, options)\n    name = `A subject in the Subject's database`\n    options = {\n      page: 1,\n      pageSize: 20\n    }\n```\n\n- Subjects List\n\n```ruby\n  #=\u003e This returns a list of subjects matches the given query.\n  isbndb_api_client.subject.batch(query, options)\n    query = `A string to search for in the Subject’s database`\n    options = {\n      page: 1, # for books\n      pageSize: 20 # for books\n    }\n```\n\n- Subjects Search\n\n```ruby\n  #=\u003e This returns a list of subjects who's name matches the given query.\n  isbndb_api_client.subject.search(options)\n    options = {\n      page: 1,\n      pageSize: 20,\n      subject: `A subject in the Subject's database`,\n      text: `A string to search for determinate subject database`\n    }\n```\n\n## Development\n\nAfter 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.\n\nTo 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](https://rubygems.org).\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/isbndb-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).\n\n## Code of Conduct\n\nEveryone interacting in the ISBNdb project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/isbndb-ruby/blob/master/CODE_OF_CONDUCT.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsampatbadhe%2Fisbndb-ruby","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsampatbadhe%2Fisbndb-ruby","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsampatbadhe%2Fisbndb-ruby/lists"}