medlineplus_ruby 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 74298631315bcea88050379dcaa144ca9f74d341
+  data.tar.gz: 1dc8518d0f3cf74e25db5ec63d4e379614e8cfa3
+SHA512:
+  metadata.gz: dff400e496b590ee21d9b58f4076d27b36d431f676ebad948e99f6a8688f09ceb53a78a4cc3e602e4d4cde4c090a441ed926373b3bfdd0f719c0f9d26d0febda
+  data.tar.gz: 83520bd0432eda769e7e81cc2c5124d1743ab5d0be7f6360bf49bdd5820e17ddf29530a6df652ce750be967c67e9f4f0e3b95aca38884ad7f5a47d49473e497e

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in medlineplus_ruby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 stratigos
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,47 @@
+# medlineplus_ruby
+
+:construction: *Under Construction*
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library
+into a gem. Put your Ruby code in the file `lib/medlineplus/ruby`. To experiment with that code, run `bin/console` for
+an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+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
+
+TODO: Write usage instructions here :construction_worker:
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can
+also 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`. 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
+
+Bug reports and PRs from forks are welcome on GitHub at https://github.com/stratigos/medlineplus_ruby.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'medlineplus_ruby'
+
+# You can add fixtures and/or initialization code here to make experimenting
+#  with your gem easier. You can also use a different console, if you like.
+
+require 'pry'
+Pry.start
+
+# Alternatively, switch to IRB for console environment.
+# require "irb"
+# IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/medlineplus_ruby.rb

@@ -0,0 +1,5 @@
+require 'medlineplus_ruby/version'
+require 'medlineplus_ruby/client'
+
+module MedlineplusRuby
+end

data/lib/medlineplus_ruby/api/api.rb

@@ -0,0 +1,22 @@
+require 'medlineplus_ruby/api/code_system'
+require 'medlineplus_ruby/api/request_format'
+require 'medlineplus_ruby/api/request'
+
+module MedlineplusRuby
+  module API
+
+    # Creates a Hash intended for use as a HTTP GET query, in which keys
+    #  represent both API endpoints and request parameters for the NLM
+    #  Medlineplus Connect API request.
+    def description_data_for_code(diagnosis_code, options = {})
+      code_description_params = {
+        'mainSearchCriteria.v.c'  => diagnosis_code,
+        'mainSearchCriteria.v.cs' => (options[:code_system]   || MedlineplusRuby::API::CodeSystem::SYSTEM_ICD10),
+        'knowledgeResponseType'   => (options[:response_type] || MedlineplusRuby::API::RequestFormat::RESPONSE_JSON)
+      }
+
+      MedlineplusRuby::API::Request.build.get_request code_description_params
+    end
+
+  end
+end

data/lib/medlineplus_ruby/api/code_system.rb

@@ -0,0 +1,10 @@
+module MedlineplusRuby
+  module API
+    module CodeSystem
+      # Medical diagnosis coding system identifiers, as understood by National
+      #  Library of Medicine's Medlineplus Connect API internals.
+      SYSTEM_ICD10 = '2.16.840.1.113883.6.90'.freeze
+      SYSTEM_ICD9  = '2.16.840.1.113883.6.103'.freeze
+    end
+  end
+end

data/lib/medlineplus_ruby/api/request.rb

@@ -0,0 +1,44 @@
+require 'medlineplus_ruby/error'
+require 'medlineplus_ruby/api/response_payload'
+require 'medlineplus_ruby/api/response_message'
+require 'rest-client'
+
+module MedlineplusRuby
+  module API
+    # MedlinePlus Connect is rate limited to 100 req/minute. Once this limit is
+    #  reached, service will not be restored for 300 seconds, or whenever the
+    #  request rate falls below 100/min, whichever is longer.
+    class Request
+
+      # Base location from which to make API requests.
+      API_URI = 'https://apps.nlm.nih.gov/medlineplus/services/mpconnect_service.cfm'.freeze
+
+      # Object to handle resulting response body.
+      attr_reader :response_payload
+
+      def self.build
+        new ResponsePayload.new
+      end
+
+      def initialize(response_payload_handler)
+        @response_payload = response_payload_handler
+      end
+
+      def get_request(req_params = {})
+
+        response = RestClient.get API_URI, { params: req_params }
+
+        # TODO: Check for failures and/or rate limitations, and return an
+        #  appropriate response. Provide an error message, or extract something
+        #  meaningful from the response if provided. Note: it appears as though
+        #  the National Library of Medicine has no such rate limitation at this
+        #  time.
+        raise MedlineplusRuby::Error,
+          MedlineplusRuby::API::ResponseMessage::ERROR_NO_RESPONSE if response.nil? || response.empty?
+
+        @response_payload.respond response.body
+      end
+
+    end
+  end
+end

data/lib/medlineplus_ruby/api/request_format.rb

@@ -0,0 +1,9 @@
+module MedlineplusRuby
+  module API
+    module RequestFormat
+      # Acceptable MedlinePlus Connect API response types.
+      RESPONSE_JSON = 'application/json'.freeze
+      RESPONSE_XML  = 'text/xml'.freeze
+    end
+  end
+end

data/lib/medlineplus_ruby/api/response_message.rb

@@ -0,0 +1,8 @@
+module MedlineplusRuby
+  module API
+    module ResponseMessage
+      ERROR_NO_RESPONSE = 'No response from National Library of Medicine API.'.freeze
+      ERROR_NO_PARSE    = 'Unable to parse response from National Library of Medicine API.'.freeze
+    end
+  end
+end

data/lib/medlineplus_ruby/api/response_payload.rb

@@ -0,0 +1,45 @@
+require 'medlineplus_ruby/api/response_message'
+require 'json'
+
+module MedlineplusRuby
+  module API
+    class ResponsePayload
+
+      def initialize
+      end
+
+      # Currently only supports 'application/json' responses.
+      def respond(api_response_body)
+        formatted_response = {
+          success: false,
+          errors: [],
+          data_requested: nil,
+          data: [],
+          response_raw: api_response_body
+        }
+
+        begin
+          parsed_body = JSON.parse api_response_body, symbolize_names: true
+        rescue JSON::ParserError => e
+          formatted_response[:errors] << MedlineplusRuby::API::ResponseMessage::ERROR_NO_PARSE
+        end
+
+        formatted_response.tap do |h|
+          h[:success]        = true
+          h[:data_requested] = parsed_body.dig :feed, :subtitle, :_value
+
+          parsed_body[:feed][:entry].each do |entry|
+            h[:data] << {
+              title:       entry[:title][:_value],
+              link:        entry[:link].first[:href],
+              description: entry[:summary][:_value]
+            }
+          end if !!parsed_body[:feed][:entry]
+        end if !!parsed_body
+
+        formatted_response
+      end
+
+    end
+  end
+end

data/lib/medlineplus_ruby/client.rb

@@ -0,0 +1,15 @@
+require 'medlineplus_ruby/api/api'
+
+module MedlineplusRuby
+  class Client
+    include MedlineplusRuby::API
+
+    def initialize(options = {})
+      options.each do |key, value|
+        instance_variable_set "@#{key}", value
+      end
+      yield(self) if block_given?
+    end
+
+  end
+end

data/lib/medlineplus_ruby/error.rb

@@ -0,0 +1,4 @@
+# Descriptive error object for client/service errors.
+module MedlineplusRuby
+  class Error < StandardError; end;
+end

data/lib/medlineplus_ruby/version.rb

@@ -0,0 +1,3 @@
+module MedlineplusRuby
+  VERSION = '0.1.1'.freeze
+end

data/medlineplus_ruby.gemspec

@@ -0,0 +1,49 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'medlineplus_ruby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'medlineplus_ruby'
+  spec.version       = MedlineplusRuby::VERSION
+  spec.authors       = ['Todd Morningstar']
+  spec.email         = ['techarchist@gmail.com']
+  spec.homepage      = 'https://github.com/stratigos/medlineplus_ruby'
+  spec.license       = 'MIT'
+  spec.summary       = 'Modernize access to the Medlineplus Connect API.'
+  spec.description   = 'The National Library of Medicine API, "Medlineplus Connect", can be somewhat cantankerous to ' \
+    'work with. Query params are non sensical to end users, query format is from a bygone era, and the resulting ' \
+    'responses often contain large amounts of superficial information. The response structures are somewhat ' \
+    'inconsistant, and are always non intuitive. This gem simplifies querying the NLM API, and parses the responses '\
+    'into something more sane and structured for the average Ruby dev to use. Note that at this time, the only ' \
+    'feature available through this gem is querying descriptions for ICD-10 codes, more API interfaces TBD.'
+  spec.post_install_message = 'Thanks for trying medlineplus_ruby!'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the
+  #  'allowed_push_host' to allow pushing to a single host or delete this
+  #  section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = 'http://mygemserver.com'
+  # else
+  #   raise 'RubyGems 2.0 or newer is required to protect against ' \
+  #     'public gem pushes.'
+  # end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  # spec.bindir        = 'exe'
+  # spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths         = ['lib']
+  spec.required_ruby_version = '>= 2.4.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.6'
+  spec.add_development_dependency 'webmock', '~> 3.0.1'
+
+  spec.add_runtime_dependency 'json', '~> 2.1.0'
+  spec.add_runtime_dependency 'rest-client', '~> 2.0.2'
+end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: medlineplus_ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Todd Morningstar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+description: The National Library of Medicine API, "Medlineplus Connect", can be somewhat
+  cantankerous to work with. Query params are non sensical to end users, query format
+  is from a bygone era, and the resulting responses often contain large amounts of
+  superficial information. The response structures are somewhat inconsistant, and
+  are always non intuitive. This gem simplifies querying the NLM API, and parses the
+  responses into something more sane and structured for the average Ruby dev to use.
+  Note that at this time, the only feature available through this gem is querying
+  descriptions for ICD-10 codes, more API interfaces TBD.
+email:
+- techarchist@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/medlineplus_ruby.rb
+- lib/medlineplus_ruby/api/api.rb
+- lib/medlineplus_ruby/api/code_system.rb
+- lib/medlineplus_ruby/api/request.rb
+- lib/medlineplus_ruby/api/request_format.rb
+- lib/medlineplus_ruby/api/response_message.rb
+- lib/medlineplus_ruby/api/response_payload.rb
+- lib/medlineplus_ruby/client.rb
+- lib/medlineplus_ruby/error.rb
+- lib/medlineplus_ruby/version.rb
+- medlineplus_ruby.gemspec
+homepage: https://github.com/stratigos/medlineplus_ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: Thanks for trying medlineplus_ruby!
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Modernize access to the Medlineplus Connect API.
+test_files: []