Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stratigos/medlineplus_ruby
:shipit: Rubygem for accessing and parsing the MedlineplusConnect API from the National Library of Medicine.
https://github.com/stratigos/medlineplus_ruby
medicine medlineplus-connect nlm-api ruby rubygem
Last synced: 3 days ago
JSON representation
:shipit: Rubygem for accessing and parsing the MedlineplusConnect API from the National Library of Medicine.
- Host: GitHub
- URL: https://github.com/stratigos/medlineplus_ruby
- Owner: stratigos
- License: mit
- Created: 2017-06-06T19:39:57.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-06-17T13:48:05.000Z (over 7 years ago)
- Last Synced: 2024-09-17T11:28:35.145Z (16 days ago)
- Topics: medicine, medlineplus-connect, nlm-api, ruby, rubygem
- Language: Ruby
- Homepage: https://toddsmedlinedemo.herokuapp.com/
- Size: 32.2 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# medlineplus_ruby
[](https://badge.fury.io/rb/medlineplus_ruby)
:construction: *Under Development*
:gem: This Rubygem facilitates retrieval of data from the National Libray of Medicine's Medlineplus Connect API. The NLM API is non intuitive to work with. This gem provides an easier to use interface, and parses the responses to a more meaningful hash for the modern Ruby developer.
## Installation
:thumbsup: Add this line to your application's Gemfile:
```ruby
gem 'medlineplus_ruby'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install medlineplus_ruby
## Usage
:running: Currently there is one feature, retrieving a set of descriptions associated with an ICD-10 diagnosis code. This can be demonstrated through the `pry` REPL, via the `./bin/console` script in the gem root dir:
```ruby
client = MedlineplusRuby::Client.new
descriptions = client.description_data_for_code 'J01.01'
```
:dizzy: Example usage can also be found in the wrapper application, [Medlineplus Connect Demo](https://github.com/stratigos/medline_plus_connect_demo), which is currently [hosted on Heroku](https://toddsmedlinedemo.herokuapp.com).
## Tests
:guardsman: Download the gem locally, and run `rspec spec` to run the test suite.
## Development
:neutral_face: After checking out the repo, run `bin/setup` to install dependencies. You can
also run `bin/console` for an interactive prompt that will allow you to experiment.
:computer: 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](https://rubygems.org).
## Contributing
:trollface: Bug reports and PRs from forks are welcome on GitHub at https://github.com/stratigos/medlineplus_ruby.
## License
:cop: The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).