bonnie_bundler 2.0.3 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ee582288be3cfd05d88916295b4cddd2002350c0
-  data.tar.gz: 052e03dc984ea038e5469c45f60bc44307befc3c
+  metadata.gz: 61b0e2dce988134311e1747adf13ea68859a5799
+  data.tar.gz: 7e8638a383ead0635f662fa55da51baedf4ae0cd
 SHA512:
-  metadata.gz: b228407edd054902045f684c4ed9e1faa96c34a2d68f15f532a4035fa0dbffe33e0398e19e3f6493252aa0db8ffa5a5223408232ee62f916cf4459c2e57bd9ee
-  data.tar.gz: c2885dbe838270ee02367978e472fbef37b570ffbdfe7b5d3da5d164ed3e364012b362f68e6465dadac53a4411d53bccbcff37fd756b61d7c7bbd685835b63c7
+  metadata.gz: ac0422c09d3a74be3c68bccd8cc595ca02f44d64c5bc9b3ab64f46c88dbc96c9d5b4f1e360c4c4b04d6f108fe3f30f8749757581a9aec7d376779aab08a7cc85
+  data.tar.gz: d1ffdbdd9a4bf57ee3def0d184960164c77074c18a65cbee955e464cc0d7fa76ab73929c328ee04b4446e3ae0ff21f9062b2241dcce3689cceb0d91f23bedf58

data/Gemfile

@@ -1,7 +1,7 @@
 source "https://rubygems.org"
 gemspec
 
-# gem 'health-data-standards', :git => 'https://github.com/projectcypress/health-data-standards.git', :branch => 'cql4bonnie'
+# gem 'health-data-standards', :git => 'https://github.com/projectcypress/health-data-standards.git', :branch => 'master_bonnie'
 # gem 'quality-measure-engine', :git => 'https://github.com/projectcypress/quality-measure-engine.git', :branch => 'master'
 # gem 'hqmf2js', :git => 'https://github.com/projecttacoma/hqmf2js.git', :branch => 'master'
 # gem 'hquery-patient-api', :git => 'https://github.com/projecttacoma/patientapi.git', :branch => 'master'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bonnie_bundler (2.0.3)
+    bonnie_bundler (2.1.0)
       diffy (~> 3.0.0)
       health-data-standards (~> 4.0)
       hqmf2js (~> 1.4)
@@ -84,7 +84,7 @@ GEM
     globalid (0.4.1)
       activesupport (>= 4.2.0)
     hashdiff (0.3.6)
-    health-data-standards (4.0.2)
+    health-data-standards (4.0.4)
       activesupport (~> 4.2.0)
       builder (~> 3.1)
       erubis (~> 2.7.0)
@@ -119,7 +119,7 @@ GEM
     json (2.1.0)
     libv8 (3.16.14.19)
     log4r (1.1.10)
-    loofah (2.1.1)
+    loofah (2.2.2)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     macaddr (1.7.1)
@@ -183,8 +183,8 @@ GEM
       activesupport (>= 4.2.0.beta, < 5.0)
       nokogiri (~> 1.6)
       rails-deprecated_sanitizer (>= 1.0.1)
-    rails-html-sanitizer (1.0.3)
-      loofah (~> 2.0)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
     railties (4.2.10)
       actionpack (= 4.2.10)
       activesupport (= 4.2.10)
@@ -264,4 +264,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   1.15.4
+   1.16.1

data/bonnie-bundler.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.email = "pophealth-talk@googlegroups.com"
   s.homepage = "http://github.com/projecttacoma/bonnie_bundler"
   s.authors = ["The MITRE Corporation"]
-  s.version = '2.0.3'
+  s.version = '2.1.0'
   s.license = 'Apache-2.0'
 
   s.add_dependency 'health-data-standards', '~> 4.0'

data/lib/bonnie_bundler.rb

@@ -24,6 +24,7 @@ require_relative 'ext/valueset.rb'
 require_relative 'measures/elm_parser.rb'
 require_relative 'measures/cql_to_elm_helper.rb'
 require_relative '../config/initializers/mongo.rb'
+require_relative 'util/vsac_api.rb'
 
 module BonnieBundler
   class << self

data/lib/measures/loading/cql_loader.rb

@@ -22,7 +22,7 @@ module Measures
       end
     end
 
-    def self.load_mat_cql_exports(user, zip_file, out_dir, measure_details, vsac_user, vsac_password, overwrite_valuesets=false, cache=false, includeDraft=false, ticket_granting_ticket=nil)
+    def self.load_mat_cql_exports(user, zip_file, out_dir, measure_details, vsac_options, vsac_ticket_granting_ticket)
       measure = nil
       cql = nil
       hqmf_path = nil
@@ -35,7 +35,7 @@ module Measures
       # Get main measure from hqmf parser
       main_cql_library = hqmf_model.cql_measure_library
 
-      cql_artifacts = process_cql(files, main_cql_library, user, vsac_user, vsac_password, overwrite_valuesets, cache, includeDraft, ticket_granting_ticket, hqmf_model.hqmf_set_id)
+      cql_artifacts = process_cql(files, main_cql_library, user, vsac_options, vsac_ticket_granting_ticket, hqmf_model.hqmf_set_id)
 
       # Create CQL Measure
       hqmf_model.backfill_patient_characteristics_with_codes(cql_artifacts[:all_codes_and_code_names])
@@ -83,16 +83,16 @@ module Measures
       return json['source_data_criteria'], json['data_criteria']
     end
 
-    def self.load(file, user, measure_details, vsac_user=nil, vsac_password=nil, overwrite_valuesets=false, cache=false, includeDraft=false, ticket_granting_ticket=nil)
+    def self.load(file, user, measure_details, vsac_options, vsac_ticket_granting_ticket)
       measure = nil
       Dir.mktmpdir do |dir|
-        measure = load_mat_cql_exports(user, file, dir, measure_details, vsac_user, vsac_password, overwrite_valuesets, cache, includeDraft, ticket_granting_ticket)
+        measure = load_mat_cql_exports(user, file, dir, measure_details, vsac_options, vsac_ticket_granting_ticket)
       end
       measure
     end
 
     # Manages all of the CQL processing that is not related to the HQMF.
-    def self.process_cql(files, main_cql_library, user, vsac_user=nil, vsac_password=nil, overwrite_valuesets=nil, cache=nil, includeDraft=nil, ticket_granting_ticket=nil, measure_id=nil)
+    def self.process_cql(files, main_cql_library, user, vsac_options, vsac_ticket_granting_ticket, measure_id=nil)
       elm_strings = files[:ELM_JSON]
       # Removes 'urn:oid:' from ELM for Bonnie and Parse the JSON
       elm_strings.each { |elm_string| elm_string.gsub! 'urn:oid:', '' }
@@ -103,8 +103,11 @@ module Measures
       cql_definition_dependency_structure = populate_cql_definition_dependency_structure(main_cql_library, elms)
       # Go back for the library statements
       cql_definition_dependency_structure = populate_used_library_dependencies(cql_definition_dependency_structure, main_cql_library, elms)
+      # Add unused libraries to structure and set the value to empty hash
+      cql_definition_dependency_structure = populate_unused_included_libraries(cql_definition_dependency_structure, elms)
 
-      # fix up statement names in cql_statement_dependencies to not use periods
+      # fix up statement names in cql_statement_dependencies to not use periods <<WRAP 1>>
+      # this is matched with an UNWRAP in MeasuresController in the bonnie project
       Measures::MongoHashKeyWrapper::wrapKeys cql_definition_dependency_structure
 
       # Depening on the value of the value set version, change it to null, strip out a substring or leave it alone.
@@ -122,12 +125,9 @@ module Measures
       end
       # Get Value Sets
       value_set_models = []
-      if (vsac_user && vsac_password) || ticket_granting_ticket
-        begin
-          value_set_models =  Measures::ValueSetLoader.load_value_sets_from_vsac(elm_value_sets, vsac_user, vsac_password, user, overwrite_valuesets, includeDraft, ticket_granting_ticket, cache, measure_id)
-        rescue Exception => e
-          raise VSACException.new "Error Loading Value Sets from VSAC: #{e.message}"
-        end
+      # Only load value sets from VSAC if there is a ticket_granting_ticket.
+      if !vsac_ticket_granting_ticket.nil?
+        value_set_models =  Measures::ValueSetLoader.load_value_sets_from_vsac(elm_value_sets, vsac_options, vsac_ticket_granting_ticket, user, measure_id)
       else
         # No vsac credentials were provided grab the valueset and valueset versions from the 'value_set_oid_version_object' on the existing measure
         db_measure = CqlMeasure.by_user(user).where(hqmf_set_id: measure_id).first
@@ -422,6 +422,19 @@ module Measures
       starting_hash
     end
 
+    # add the unused libraries and set them to have empty hashes.
+    def self.populate_unused_included_libraries(cql_definition_dependency_structure, elms)
+      if elms.count > cql_definition_dependency_structure.keys.count
+        elms.each do |elm|
+          # If the number of libraries included in the elm is greater than
+          # the number of libraries included in the dependency structure
+          library_name = elm['library']['identifier']['id']
+          cql_definition_dependency_structure[library_name] = {} if cql_definition_dependency_structure[library_name].nil?
+        end
+      end
+      cql_definition_dependency_structure
+    end
+
     # Traverse list, create keys and drill down for each key.
     # If key is already in place, skip.
     def self.create_hash_for_all(starting_hash, key_statement, elms)

data/lib/measures/loading/exceptions.rb

@@ -1,8 +1,6 @@
 module Measures
   class ValueSetException < Exception
   end
-  class VSACException < Exception
-  end
   class HQMFException < Exception
   end
   class MeasureLoadingException < Exception

data/lib/measures/loading/value_set_loader.rb

@@ -19,119 +19,99 @@ module Measures
       HealthDataStandards::SVS::ValueSet.by_user(user).in(oid: value_set_oids)
     end
 
-    def self.load_value_sets_from_vsac(value_sets, username, password, user=nil, overwrite=false, includeDraft=false, ticket_granting_ticket=nil, use_cache=false, measure_id=nil)
-      # Get a list of just the oids
-      value_set_oids = value_sets.map {|value_set| value_set[:oid]}
+    def self.load_value_sets_from_vsac(value_sets, vsac_options, vsac_ticket_granting_ticket, user=nil, measure_id=nil)
       value_set_models = []
       from_vsac = 0
       existing_value_set_map = {}
-      begin
-        backup_vs = []
-        if overwrite
-          backup_vs = get_existing_vs(user, value_set_oids).to_a
-          delete_existing_vs(user, value_set_oids)
+
+      errors = {}
+      api = Util::VSAC::VSACAPI.new(config: APP_CONFIG['vsac'], ticket_granting_ticket: vsac_ticket_granting_ticket)
+
+      RestClient.proxy = ENV["http_proxy"]
+      value_sets.each do |value_set|
+        # The vsac_options that will be used for this specific value set. Default to using passed in options from measures controller
+        vs_vsac_options = vsac_options
+
+        # If we are allowing measure_defined value sets, determine vsac_options for this value set based on elm info.
+        if vsac_options[:measure_defined] == true
+          if !value_set[:profile].nil?
+            vs_vsac_options = { profile: value_set[:profile] }
+          elsif !value_set[:version].nil?
+            vs_vsac_options = { version: value_set[:version] }
+          end
+          # if no parseable options in the ELM were found, we stick with the passed in options from measures controller
         end
-        nlm_config = APP_CONFIG["nlm"]
 
-        errors = {}
-        api = HealthDataStandards::Util::VSApiV2.new(nlm_config["ticket_url"],nlm_config["api_url"],username, password, ticket_granting_ticket)
+        # Determine version to store value sets as after parsing and to use to looking for existing set.
+        query_version = ""
+        if vs_vsac_options[:include_draft] == true
+          query_version = "Draft-#{measure_id}" # Unique draft version based on measure id
+        elsif vs_vsac_options[:profile]
+          query_version = "Profile:#{vs_vsac_options[:profile]}" # Profile calls return 'N/A' so note profile use.
+        elsif vs_vsac_options[:version]
+          query_version = vs_vsac_options[:version]
+        elsif vs_vsac_options[:release]
+          query_version = "Release:#{vs_vsac_options[:release]}"
+        end
+
+        # TODO: remove the usage of existing value sets. future work will be always fetching value sets from VSAC and
+        # associating them with the new measure.
+
+        # check if we already have this valuset loaded for this user
+        set = HealthDataStandards::SVS::ValueSet.where({user_id: user.id, oid: value_set[:oid], version: query_version}).first()
 
-        if use_cache
-          codeset_base_dir = Measures::Loader::VALUE_SET_PATH
-          FileUtils.mkdir_p(codeset_base_dir)
+        # delete existing if we are doing include_draft option sinc the existing may be stale. note that this may delete 
+        # and effectively replace value sets for a measure load that may fail. Unintentionally updating the value sets.
+        if (vs_vsac_options[:include_draft] && set)
+          set.delete
+          set = nil
         end
 
-        RestClient.proxy = ENV["http_proxy"]
-        value_sets.each do |value_set|
-          value_set_version = value_set[:version] ? value_set[:version] : "N/A"
-          #When querying vsac via profile, the version is always set to N/A
-          #As such, we can set the version to the profile.
-          #However, a value_set can have a version and profile that are identical, as such the versions that are profiles are denoted as such.
-          value_set_profile = (value_set[:profile] && !includeDraft) ? value_set[:profile] : nlm_config["profile"]
-          value_set_profile = "Profile:#{value_set_profile}"
-
-          query_version = ""
-          if includeDraft
-            query_version = "Draft-#{measure_id}"
-          elsif value_set[:profile]
-            query_version = value_set_profile
-          else
-            query_version = value_set_version
-          end
-          # only access the database if we don't intend on using cached values
-          set = HealthDataStandards::SVS::ValueSet.where({user_id: user.id, oid: value_set[:oid], version: query_version}).first() unless use_cache
-          if (includeDraft && set)
-            set.delete
-            set = nil
-          end
-          if (set)
+        # use the existing value set if it exists
+        if (set)
+          existing_value_set_map[set.oid] = set
+
+        # load this value set from VSAC
+        else
+          vs_data = api.get_valueset(value_set[:oid], vs_vsac_options)
+
+          # there are some funky unicodes coming out of the vs response that are not in ASCII as the string reports to be
+          vs_data.force_encoding("utf-8")
+          from_vsac += 1
+
+          doc = Nokogiri::XML(vs_data)
+
+          doc.root.add_namespace_definition("vs","urn:ihe:iti:svs:2008")
+
+          vs_element = doc.at_xpath("/vs:RetrieveValueSetResponse/vs:ValueSet|/vs:RetrieveMultipleValueSetsResponse/vs:DescribedValueSet")
+
+          if vs_element && vs_element['ID'] == value_set[:oid]
+            vs_element['id'] = value_set[:oid]
+            set = HealthDataStandards::SVS::ValueSet.load_from_xml(doc)
+            # make sure this value set has concepts, delete it and raise error if it is empty
+            if set.concepts.empty?
+              set.delete
+              raise Util::VSAC::VSEmptyError.new(value_set[:oid])
+            end
+            set.user = user
+
+            # bundle id for user should always be the same 1 user to 1 bundle
+            # using this to allow cat I generation without extensive modification to HDS
+            set.bundle = user.bundle if (user && user.respond_to?(:bundle))
+
+            # As of 9/7/2017, when valuesets are retrieved from VSAC via profile, their version defaults to N/A
+            # As such, we set the version to the profile with an indicator.
+            set.version = query_version
+            set.save!
             existing_value_set_map[set.oid] = set
           else
-            vs_data = nil
-
-            # try to access the cached result for the value set if it exists.
-            cached_service_result = File.join(codeset_base_dir,"#{value_set[:oid]}.xml") if use_cache
-            if (cached_service_result && File.exists?(cached_service_result))
-              vs_data = File.read cached_service_result
-            else
-              # If includeDraft is true the latest vs are required, so the latest profile should be used.
-              if includeDraft
-                vs_data = api.get_valueset(value_set[:oid], include_draft: includeDraft, profile: nlm_config["profile"])
-              elsif value_set[:version]
-                vs_data = api.get_valueset(value_set[:oid], version: value_set[:version])
-              else
-                # If no version, call with profile.
-                # If a profile is specified, use it.  Otherwise, use default.
-                profile = value_set[:profile] ? value_set[:profile] : nlm_config["profile"]
-                vs_data = api.get_valueset(value_set[:oid], profile: profile)
-              end
-            end
-            vs_data.force_encoding("utf-8") # there are some funky unicodes coming out of the vs response that are not in ASCII as the string reports to be
-            from_vsac += 1
-            # write all valueset data retrieved if using a cache
-            File.open(cached_service_result, 'w') {|f| f.write(vs_data) } if use_cache
-
-            doc = Nokogiri::XML(vs_data)
-
-            doc.root.add_namespace_definition("vs","urn:ihe:iti:svs:2008")
-
-            vs_element = doc.at_xpath("/vs:RetrieveValueSetResponse/vs:ValueSet|/vs:RetrieveMultipleValueSetsResponse/vs:DescribedValueSet")
-
-            if vs_element && vs_element['ID'] == value_set[:oid]
-              vs_element['id'] = value_set[:oid]
-              set = HealthDataStandards::SVS::ValueSet.load_from_xml(doc)
-              set.user = user
-              #bundle id for user should always be the same 1 user to 1 bundle
-              #using this to allow cat I generation without extensive modification to HDS
-              set.bundle = user.bundle if (user && user.respond_to?(:bundle))
-              # As of t9/7/2017, when valuesets are retrieved from VSAC via profile, their version defaults to N/A
-              # As such, we set the version to the profile with an indicator.
-              set.version = query_version
-              set.save!
-              existing_value_set_map[set.oid] = set
-            else
-              raise "Value set not found: #{oid}"
-            end
+            raise Util::VSAC::VSNotFoundError.new(value_set[:oid])
           end
         end
-      rescue Exception => e
-        if (overwrite)
-          delete_existing_vs(user, value_set_oids)
-          backup_vs.each {|vs| HealthDataStandards::SVS::ValueSet.new(vs.attributes).save }
-        end
-        raise VSACException.new "#{e.message}"
       end
 
       puts "\tloaded #{from_vsac} value sets from vsac" if from_vsac > 0
       existing_value_set_map.values
     end
-
-    def self.get_existing_vs(user, value_set_oids)
-      HealthDataStandards::SVS::ValueSet.by_user(user).where(oid: {'$in'=>value_set_oids})
-    end
-    def self.delete_existing_vs(user, value_set_oids)
-      get_existing_vs(user, value_set_oids).delete_all()
-    end
-
   end
 end

data/lib/util/vsac_api.rb

@@ -0,0 +1,274 @@
+require 'rest_client'
+require 'uri'
+
+module Util
+  module VSAC
+
+    # Generic VSAC related exception.
+    class VSACError < StandardError
+    end
+
+    # Error represnting a not found response from the API. Includes OID for reporting to user.
+    class VSNotFoundError < VSACError
+      attr_reader :oid
+      def initialize(oid)
+        super("Value Set (#{oid}) was not found.")
+        @oid = oid
+      end
+    end
+
+    # Error represnting a program not found response from the API.
+    class VSACProgramNotFoundError < VSACError
+      attr_reader :oid
+      def initialize(program)
+        super("VSAC Program #{program} does not exist.")
+      end
+    end
+
+    # Error represnting a response from the API that had no concepts.
+    class VSEmptyError < VSACError
+      attr_reader :oid
+      def initialize(oid)
+        super("Value Set (#{oid}) is empty.")
+        @oid = oid
+      end
+    end
+
+    # Raised when the ticket granting ticket has expired.
+    class VSACTicketExpiredError < VSACError
+      def initialize
+        super('VSAC session expired. Please re-enter credentials and try again.')
+      end
+    end
+
+    # Raised when the user credentials were invalid.
+    class VSACInvalidCredentialsError < VSACError
+      def initialize
+        super('VSAC ULMS credentials are invalid.')
+      end
+    end
+
+    # Raised when a call requiring auth is attempted when no ticket_granting_ticket or credentials were provided.
+    class VSACNoCredentialsError < VSACError
+      def initialize
+        super('VSAC ULMS credentials were not provided.')
+      end
+    end
+
+    # Raised when the arguments passed in are bad.
+    class VSACArgumentError < VSACError
+    end
+
+    class VSACAPI
+      # The default program to use for get_program_details and get_program_release_names calls.
+      # This can be overriden by providing a :program in the config or by the single optional parameter for those
+      # methods.
+      DEFAULT_PROGRAM = "CMS eCQM"
+
+      # This is the value of the service parameter passed when getting a ticket. This never changes.
+      TICKET_SERVICE_PARAM = "http://umlsks.nlm.nih.gov"
+
+      # The ticket granting that will be obtained if needed. Accessible so it may be stored in user session.
+      # Is a hash of the :ticket and time it :expires.
+      attr_reader :ticket_granting_ticket
+
+      ##
+      # Creates a new VSACAPI. If credentials were provided they are checked now. If no credentials
+      # are provided then the API can still be used for utility methods.
+      #
+      # Options for the API are passed in as a hash.
+      # * config -
+      def initialize(options)
+        # check that :config exists and has needed fields
+        if options[:config].nil?
+          raise VSACArgumentError.new("Required param :config is missing or empty.")
+        else
+          symbolized_config = options[:config].symbolize_keys
+          if check_config symbolized_config
+            @config = symbolized_config
+          else
+            raise VSACArgumentError.new("Required param :config is missing required URLs.")
+          end
+        end
+
+        # if a ticket_granting_ticket was passed in, check it and raise errors if found
+        # username and password will be ignored
+        if !options[:ticket_granting_ticket].nil?
+          provided_ticket_granting_ticket = options[:ticket_granting_ticket]
+          if provided_ticket_granting_ticket[:ticket].nil? || provided_ticket_granting_ticket[:expires].nil?
+            raise VSACArgumentError.new("Optional param :ticket_granting_ticket is missing :ticket or :expires")
+          end
+
+          # check if it has expired
+          if Time.now > provided_ticket_granting_ticket[:expires]
+            raise VSACTicketExpiredError.new
+          end
+
+          # ticket granting ticket looks good
+          @ticket_granting_ticket = { ticket: provided_ticket_granting_ticket[:ticket],
+            expires: provided_ticket_granting_ticket[:expires] }
+
+        # if username and password were provided use them to get a ticket granting ticket
+        elsif !options[:username].nil? && !options[:password].nil?
+          @ticket_granting_ticket = get_ticket_granting_ticket(options[:username], options[:password])
+        end
+      end
+
+      ##
+      # Gets the list of profiles. This may be used without credentials.
+      #
+      # Returns a list of profile names. These are kept in the order that VSAC provides them in.
+      def get_profile_names
+        profiles_response = RestClient.get("#{@config[:utility_url]}/profiles")
+        profiles = []
+
+        # parse xml response and get text content of each profile element
+        doc = Nokogiri::XML(profiles_response)
+        profile_list = doc.at_xpath("/ProfileList")
+        profile_list.xpath("//profile").each do |profile|
+          profiles << profile.text
+        end
+
+        return profiles
+      end
+
+      ##
+      # Gets the list of programs. This may be used without credentials.
+      #
+      # Returns a list of program names. These are kept in the order that VSAC provides them in.
+      def get_program_names
+        programs_response = RestClient.get("#{@config[:utility_url]}/programs")
+        program_names = []
+
+        # parse json response and return the names of the programs
+        programs_info = JSON.parse(programs_response)['Program']
+        programs_info.each do |program|
+          program_names << program['name']
+        end
+
+        return program_names
+      end
+
+      ##
+      # Gets the details for a program. This may be used without credentials.
+      #
+      # Optional parameter program is the program to request from the API. If it is not provided it will look for
+      # a :program in the config passed in during construction. If there is no :program in the config it will use 
+      # the DEFAULT_PROGRAM constant for the program.
+      #
+      # Returns the JSON parsed response for program details.
+      def get_program_details(program = nil)
+        # if no program was provided use the one in the config or default in constant
+        if program.nil?
+          program = @config.fetch(:program, DEFAULT_PROGRAM)
+        end
+
+        begin
+          # parse json response and return it
+          return JSON.parse(RestClient.get("#{@config[:utility_url]}/program/#{ERB::Util.url_encode(program)}"))
+        rescue RestClient::ResourceNotFound
+          raise VSACProgramNotFoundError.new(program)
+        end
+      end
+
+      ##
+      # Gets the releases for a program. This may be used without credentials.
+      #
+      # Optional parameter program is the program to request from the API. If it is not provided it will look for
+      # a :program in the config passed in during construction. If there is no :program in the config it will use
+      # the DEFAULT_PROGRAM constant for the program.
+      #
+      # Returns a list of release names in a program. These are kept in the order that VSAC provides them in.
+      def get_program_release_names(program = nil)
+        program_details = get_program_details(program)
+        releases = []
+
+        # pull just the release names out
+        program_details['release'].each do |release|
+          releases << release['name']
+        end
+
+        return releases
+      end
+
+      ##
+      # Gets a valueset. This requires credentials.
+      #
+      def get_valueset(oid, options = {})
+        # base parameter oid is always needed
+        params = { id: oid }
+
+        # release parameter, should be used moving forward
+        if !options[:release].nil?
+          params[:release] = options[:release]
+        end
+
+        # profile parameter, may be needed for getting draft value sets
+        if !options[:profile].nil?
+          params[:profile] = options[:profile]
+          if !options[:include_draft].nil?
+            params[:includeDraft] = if !!options[:include_draft] then 'yes' else 'no' end
+          end
+        else
+          if !options[:include_draft].nil?
+            raise VSACArgumentError.new("Option :include_draft requires :profile to be provided.")
+          end
+        end
+
+        # version parameter, rarely used
+        if !options[:version].nil?
+          params[:version] = options[:version]
+        end
+
+        # get a new service ticket
+        params[:ticket] = get_ticket
+
+        # run request
+        begin
+          return RestClient.get("#{@config[:content_url]}/RetrieveMultipleValueSets", params: params)
+        rescue RestClient::ResourceNotFound
+          raise VSNotFoundError.new(oid)
+        rescue RestClient::InternalServerError
+          raise VSACError.new("Server error response from VSAC for (#{oid}).")
+        end
+      end
+
+      private
+
+      def get_ticket
+        # if there is no ticket granting ticket then we should raise an error
+        raise VSACNoCredentialsError.new unless @ticket_granting_ticket
+        # if the ticket granting ticket has expired, throw an error
+        raise VSACTicketExpiredError.new if Time.now > @ticket_granting_ticket[:expires]
+
+        # attempt to get a ticket
+        begin
+          ticket = RestClient.post("#{@config[:auth_url]}/Ticket/#{@ticket_granting_ticket[:ticket]}", service: TICKET_SERVICE_PARAM)
+          return ticket.to_s
+        rescue RestClient::Unauthorized
+          @ticket_granting_ticket[:expires] = Time.now
+          raise VSACTicketExpiredError.new
+        end
+      end
+
+      def get_ticket_granting_ticket(username, password)
+        begin
+          ticket = RestClient.post("#{@config[:auth_url]}/Ticket", username: username, password: password)
+          return { ticket: String.new(ticket), expires: Time.now + 8.hours }
+        rescue RestClient::Unauthorized
+          raise VSACInvalidCredentialsError.new
+        end
+      end
+
+      # Checks to ensure the API config has all necessary fields
+      def check_config(config)
+        return config != nil &&
+               !config[:auth_url].nil? &&
+               !config[:content_url].nil? &&
+               !config[:utility_url].nil?
+      end
+
+    end
+
+  end
+end