💎 A Ruby API wrapper library, and Rails 5 demo application, for retrieving information from the National Library of Medicine's "Medlineplus Connect" API.
👓 You can view a live demo of this application on Heroku. Free Heroku dynos take a few moments to wake from sleep.
🏥 Currently there is one feature: fetching consumer facing information associated with ICD-10 codes.
- Ruby >= 2.4.1
- Rails >= 5.1.1
- RSpec >= 3.6
- Hosted on Heroku's free tier.
📝 Note: This project focuses entirely on the back end, and not the presentation layer. As such, jQuery, SASS,
and Bootstrap are used together to simplify front end concerns. As the latest Bootstrap 4 alpha breaks version
alpha-4, its unlikely this application will update to follow subsequent releases of Bootstrap 4. You can check out
some of my front end work here.
💎 Rubygem: I have extracted the contents of lib/ to a rubygem: medlineplus_ruby. Currently it represents an API client that simplifies making requests to the NLM API. The NLM API is far removed from modern web standards, and this gem allows for a more seamless integration with Ruby medical applications. It is available on rubygems.org.
🚥 Tests: BDD is practiced when it is feasible, and I aim to have 100% spec coverage.
- Run
./bin/rails specfor the whole suite. - Run
./bin/rails spec:presentersfor only running specs on PORO/Non-Rails classes.presenterscan be replaced withservices, etc.
👔 Presenters: While there are some great gems out there for Rails presenters, I like to keep things as simple until there is a reasonable demand for robustness. I use PORO classes for Presenter objects.
🏭 Services: To keep models focused, I chose aldous for Service objects. This pattern also keeps
domain responsibilities modularized and composable, and components are easier to test. The aldous gem has a very
simple and light abstraction for Service objects and encourages a reliable and standardized pattern for message passing.
It also encourages a consistent methodology for exception handling. I would not object to using PORO classes for an
application Services layer either.
💾 Persistence: I write a lot of applications which interface with an RDBMS, and sometimes even dream in SQL. This application has no real need for a data layer, and as such does not demo my experience with MySQL and PostgreSQL. My DBA chops can be revealed here, { in a TBD Phoenix application }.
👋 You can also check out my other repositories, and my ever so humble website. Thanks!
MIT, see LICENSE file.