ndfrt 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f83510323baec54e499e676d6fd287d68d7d59a4
+  data.tar.gz: 40d26c69554f2c923b64c097ef3ad6e8e0b7a0a3
+SHA512:
+  metadata.gz: 2dbe4c29dec6d77b66e0e55a78e181b2cf2ade21f6076083a41597de8a718796d4bc3ebf141b89479f3728947c1d2bb7c16d18c4309f3a71dab9febad7283c1c
+  data.tar.gz: 733e811672c5a2372aea9529e1d085e0aadf0070c0f38355ed08b162aff9a738144c2d2bb3418600340f55e9591326c217599e050f46a2440053594d2ceea0ab

data/README.md

@@ -0,0 +1,7 @@
+## NDF-RT API [![Build Status](https://travis-ci.org/jbender/ndfrt_ruby.png?branch=master)](https://travis-ci.org/jbender/ndfrt_ruby) [![Code Climate](https://codeclimate.com/github/jbender/ndfrt_ruby.png)](https://codeclimate.com/github/jbender/ndfrt_ruby)
+
+This project aims to make it easier for rubyists to work with the [NDR-FT REST API](http://rxnav.nlm.nih.gov/NdfrtAPIREST.html).
+
+## License
+
+NDRFT is released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+ 
+task default: :spec

data/lib/ndfrt.rb

@@ -0,0 +1,110 @@
+require 'net/http'
+require 'nori'
+require 'nokogiri'
+require 'ostruct'
+project_root = File.dirname(File.absolute_path(__FILE__))
+Dir.glob(project_root + '/ndfrt/*', &method(:require))
+
+class NDFRT
+
+  def initialize
+    @nori = Nori.new(convert_tags_to: -> tag { tag.snakecase.to_sym })
+  end
+
+  def api_version
+    get_response_hash("/version")[:version][:version_name].to_s
+  end
+
+  def possible_options_for type
+    get_options type.to_s.downcase
+  end
+  alias_method :available_options_for, :possible_options_for
+
+  def possible_associations
+    get_options "association"
+  end
+
+  def possible_types
+    get_options "type"
+  end
+
+  def possible_kinds
+    get_options "kind"
+  end
+
+  def possible_properties
+    get_options "property"
+  end
+
+  def possible_roles
+    get_options "role"
+  end
+
+  def find_by hash
+    return find_by_id(hash[:type], hash[:id]) if hash.has_key? :id
+    return find_by_name(hash[:name], hash[:kind]) if hash.has_key? :name
+  end
+
+  def find_by_id type, id
+    type = type.upcase
+    query = "/idType=#{type}&idString=#{id}"
+    return get_concepts query
+  end
+
+  def find_by_name name, kind = nil
+    query = "/search?conceptName=#{name}"
+    unless kind.nil?
+      kind = kind.upcase + '_KIND'
+      query += "&kindName=#{kind}"
+    end
+    return get_concepts query
+  end
+
+  def find_interacting_drugs nui, scope = 3
+    query = "/interaction/nui=#{nui}&scope=#{scope}"
+    response = get_response_hash query
+    data = response[:group_interactions][:interactions][:group_interacting_drugs][:interacting_drug]
+    data = [data] unless data.is_a? Array
+    return data.map { |i| NDFRT::Concept.new i[:concept] }
+  end
+
+  def find_interactions_between nuis, scope = 3
+    query = "/interaction?nuis=#{nuis.join('+')}&scope=#{scope}"
+    data = get_response_hash query
+    return data[:full_interaction_group][:full_interaction].map do |fi|
+      NDFRT::Interaction.new fi[:interaction_triple_group][:interaction_triple]
+    end
+  end
+
+  def get_info nui
+    query = "/allInfo/#{nui}"
+    return OpenStruct.new get_response_hash(query)[:full_concept]
+  end
+
+  def all_records_by_kind kind
+    kind = kind.upcase + "_KIND"
+    query = "/allconcepts?kind=#{kind}"
+    data = get_response_hash query
+  end
+  alias_method :all_concepts_by_kind, :all_records_by_kind
+
+  private
+
+  def get_response_hash query
+    request = URI.parse('http://rxnav.nlm.nih.gov/REST/Ndfrt' + query)
+    return @nori.parse(Net::HTTP.get request)[:ndfrtdata]
+  end
+
+  def get_options type
+    data = get_response_hash "/#{type}List"
+    return data["#{type}_list".to_sym]["#{type}_name".to_sym].map { |a| a.to_s }
+  end
+
+  def get_concepts query
+    response = get_response_hash query
+    data = response[:group_concepts][:concept]
+    data = [data] unless data.is_a?(Array)
+    return data.map { |c| NDFRT::Concept.new(c) }
+  end
+
+end

data/spec/ndfrt_spec.rb

@@ -0,0 +1,118 @@
+require_relative '../lib/ndfrt'
+
+describe NDFRT do
+  before :all do
+    @ndfrt = NDFRT.new
+  end
+
+  describe "#api_version" do
+    it "returns a string" do
+      expect(@ndfrt.api_version.class).to eq(String)
+    end
+  end
+
+  describe "#possible_associations" do
+    before :all do
+      @associations = @ndfrt.possible_associations
+    end
+    
+    it "returns an array" do
+      expect(@associations.class).to eq(Array)
+    end
+    
+    it "returns an array of strings" do
+      expect(@associations.first.class).to eq(String)
+    end
+  end
+
+  describe "#find_by_id for type RXCUI and id 161" do
+    before :all do
+      @asprin = @ndfrt.find_by_id 'RXCUI', '161'
+    end
+
+    it "returns an array of objects" do
+      expect(@asprin.class).to eq(Array)
+    end
+
+    it "returns Acetaminophen for first object name" do
+      expect(@asprin.first.name).to eq('Acetaminophen')
+    end
+
+    it "returns N0000145898 for first object nui" do
+      expect(@asprin.first.nui).to eq('N0000145898')
+    end
+
+    it "returns Drug for first object kind" do
+      expect(@asprin.first.kind).to eq('Drug')
+    end
+  end
+
+  describe "#find_by_name morphine without kind" do
+    before :all do
+      @morphine = @ndfrt.find_by_name 'morphine'
+    end
+
+    it "returns an array of objects" do
+      expect(@morphine.class).to eq(Array)
+    end
+
+    it "returns Morphine for first object name" do
+      expect(@morphine.first.name).to eq('Morphine')
+    end
+
+    it "returns N0000145914 for first object nui" do
+      expect(@morphine.first.nui).to eq('N0000145914')
+    end
+
+    it "returns Drug for first object kind" do
+      expect(@morphine.first.kind).to eq('Drug')
+    end
+  end
+
+  describe "#find_by_name morphine with kind ingredient" do
+    before :all do
+      @morphine = @ndfrt.find_by_name 'morphine', 'ingredient'
+    end
+
+    it "returns an array of objects" do
+      expect(@morphine.class).to eq(Array)
+    end
+
+    it "returns Morphine for first object name" do
+      expect(@morphine.first.name).to eq('Morphine')
+    end
+
+    it "returns N0000007070 for first object nui" do
+      expect(@morphine.first.nui).to eq('N0000007070')
+    end
+
+    it "returns Ingredient for first object kind" do
+      expect(@morphine.first.kind).to eq('Ingredient')
+    end
+  end
+
+  describe "#find_by with hash of name" do
+    it "should return the same as find_by_name" do
+      @generic_find = @ndfrt.find_by name: 'morphine'
+      @specific_find = @ndfrt.find_by_name 'morphine'
+      expect(@generic_find == @specific_find).to eq(true)
+    end
+  end
+
+  describe "#find_by with hash of name and kind" do
+    it "should return the same as find_by_name" do
+      @generic_find = @ndfrt.find_by name: 'morphine', kind: 'ingredient'
+      @specific_find = @ndfrt.find_by_name 'morphine', 'ingredient'
+      expect(@generic_find == @specific_find).to eq(true)
+    end
+  end
+
+  describe "#find_by with hash of type and id" do
+    it "should return the same as find_by_name" do
+      @generic_find = @ndfrt.find_by type: 'RXCUI', id: '161'
+      @specific_find = @ndfrt.find_by_id 'RXCUI', '161'
+      expect(@generic_find == @specific_find).to eq(true)
+    end
+  end
+
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: ndfrt
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jonathan Bender
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nori
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: A ruby-based way of interacting with the NDF-RT RESTful API (http://rxnav.nlm.nih.gov/NdfrtAPIREST.html)
+email: jlbender@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- lib/ndfrt.rb
+- spec/ndfrt_spec.rb
+- README.md
+homepage: http://github.com/jbender/ndfrt_rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.10
+signing_key: 
+specification_version: 4
+summary: A ruby wrapper to the NDF-RT RESTful API
+test_files: []