https://github.com/ebsco/edsapi-ruby
A Ruby interface to the EBSCO Discovery Services API
https://github.com/ebsco/edsapi-ruby
ebsco rubygems
Last synced: 4 months ago
JSON representation
A Ruby interface to the EBSCO Discovery Services API
- Host: GitHub
- URL: https://github.com/ebsco/edsapi-ruby
- Owner: ebsco
- License: mit
- Created: 2017-03-01T18:36:11.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2025-02-25T19:15:20.000Z (4 months ago)
- Last Synced: 2025-03-07T05:02:04.615Z (4 months ago)
- Topics: ebsco, rubygems
- Language: Ruby
- Size: 28 MB
- Stars: 7
- Watchers: 7
- Forks: 10
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
A Ruby interface to the EBSCO Discovery Services API.
[](https://travis-ci.org/ebsco/edsapi-ruby)
[](https://codecov.io/gh/ebsco/edsapi-ruby/branch/master)
[](http://rubygems.org/gems/ebsco-eds)
## Dependencies
* Ruby 2.4+
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'ebsco-eds'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install ebsco-eds
## Feature Support
- Research Starters are included in results response, when available
- Configurable auto-suggest or 'Did you mean' support
- Configurable auto-correct support
- Quick-view images can be included in results, when available - [screencast](https://youtu.be/HxtWEq_Fhks)
- RIS citations are now included in the record response
## Documentation
- [Configuration](https://github.com/ebsco/edsapi-ruby/wiki/Configuration)
- [Quick Start](https://github.com/ebsco/edsapi-ruby/wiki/Quick-Start)
- [Blacklight Support](https://github.com/ebsco/edsapi-ruby/wiki/Solr-and-Blacklight-Support)
### Models
- [Session](https://github.com/ebsco/edsapi-ruby/wiki/Session)
- [Results](https://github.com/ebsco/edsapi-ruby/wiki/Results)
- [Records](https://github.com/ebsco/edsapi-ruby/wiki/Records)
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/ebsco/edsapi-ruby.
## Development
After checking out the repo, run `bin/setup` to install dependencies.
You can 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`.
#### Running the tests
- `git clone git://github.com/ebsco/edsapi-ruby && cd edsapi-ruby`
- `bundle`
- Create a `.env.test` file
- It should look like the following:
```ruby
EDS_PROFILE=profile_name
EDS_GUEST=n
EDS_USER=your_user_id
EDS_PASS=secret
EDS_AUTH=ip
EDS_ORG=your_institution
```
- `rake test`
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).
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).