[MAT-1757] Replacing VSAC Username/Password with API Key in VSAC Calls (

#114) * Replacing vsac username/password with api key.
projecttacoma · Sep 14, 2020 · b890b31 · b890b31
1 parent 5b6d682
commit b890b31
Show file tree

Hide file tree

Showing 47 changed files with 74 additions and 99 deletions.
diff --git a/lib/measure-loader/vsac_value_set_loader.rb b/lib/measure-loader/vsac_value_set_loader.rb
@@ -7,8 +7,7 @@ def initialize(options)
       options.symbolize_keys!
       @vsac_options = options[:options]
       @vsac_ticket_granting_ticket = options[:ticket_granting_ticket]
-      @vsac_username = options[:username]
-      @vsac_password = options[:password]
+      @vsac_api_key = options[:api_key]
       @vs_model_cache = {}
     end
 
@@ -48,7 +47,7 @@ def retrieve_and_modelize_value_sets_from_vsac(value_sets)
 
     def load_api
       return @api if @api.present?
-      @api = Util::VSAC::VSACAPI.new(config: APP_CONFIG['vsac'], ticket_granting_ticket: @vsac_ticket_granting_ticket, username: @vsac_username, password: @vsac_password)
+      @api = Util::VSAC::VSACAPI.new(config: APP_CONFIG['vsac'], ticket_granting_ticket: @vsac_ticket_granting_ticket, api_key: @vsac_api_key)
       return @api
     end
 

diff --git a/lib/util/vsac_api.rb b/lib/util/vsac_api.rb
@@ -7,7 +7,7 @@ module VSAC
     class VSACError < StandardError
     end
 
-    # Error represnting a not found response from the API. Includes OID for reporting to user.
+    # Error representing a not found response from the API. Includes OID for reporting to user.
     class VSNotFoundError < VSACError
       attr_reader :oid
       def initialize(oid)
@@ -23,15 +23,15 @@ def initialize
       end
     end
 
-    # Error represnting a program not found response from the API.
+    # Error representing 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.
+    # Error representing a response from the API that had no concepts.
     class VSEmptyError < VSACError
       attr_reader :oid
       def initialize(oid)
@@ -50,14 +50,14 @@ def initialize
     # Raised when the user credentials were invalid.
     class VSACInvalidCredentialsError < VSACError
       def initialize
-        super('VSAC ULMS credentials are invalid.')
+        super('VSAC UMLS 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.')
+        super('VSAC UMLS credentials were not provided.')
       end
     end
 
@@ -93,7 +93,7 @@ def initialize(options)
         end
 
         # if a ticket_granting_ticket was passed in, check it and raise errors if found
-        # username and password will be ignored
+        # VSAC API Key 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?
@@ -105,9 +105,9 @@ def initialize(options)
           @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])
+          # if api key was provided use it to get a ticket granting ticket
+        elsif !options[:api_key].nil?
+          @ticket_granting_ticket = get_ticket_granting_ticket(options[:api_key])
         end
       end
 
@@ -304,13 +304,11 @@ def create_service_ticket_request
                                      params: { service: TICKET_SERVICE_PARAM})
       end
 
-      # Use your username and password to retrive a ticket granting ticket from VSAC
-      def get_ticket_granting_ticket(username, password)
+      # Use your API Key to retrive a ticket granting ticket from VSAC
+      def get_ticket_granting_ticket(api_key)
         response = Typhoeus.post(
           "#{@config[:auth_url]}/Ticket",
-          # looks like typheous sometimes switches the order of username/password when encoding
-          # which vsac cant handle (!?), so encode first
-          body: URI.encode_www_form(username: username, password: password)
+          body: URI.encode_www_form(apikey: api_key)
         )
         raise VSACInvalidCredentialsError.new if response.response_code == 401
         validate_http_status(response.response_code)

diff --git a/test/fixtures/vcr_cassettes/measure__definition_with_same_name_as_a_library_definition.yml b/test/fixtures/vcr_cassettes/measure__definition_with_same_name_as_a_library_definition.yml
diff --git a/...res/vcr_cassettes/measure__direct_reference_code_handles_creation_of_codeListId_hash1.yml b/...res/vcr_cassettes/measure__direct_reference_code_handles_creation_of_codeListId_hash1.yml
diff --git a/...res/vcr_cassettes/measure__direct_reference_code_handles_creation_of_codeListId_hash2.yml b/...res/vcr_cassettes/measure__direct_reference_code_handles_creation_of_codeListId_hash2.yml
diff --git a/...tures/vcr_cassettes/measure__invalid_composite_measure_with_missing_component_measure.yml b/...tures/vcr_cassettes/measure__invalid_composite_measure_with_missing_component_measure.yml
diff --git a/...vcr_cassettes/measure__invalid_composite_measure_with_missing_composite_measure_files.yml b/...vcr_cassettes/measure__invalid_composite_measure_with_missing_composite_measure_files.yml
diff --git a/test/fixtures/vcr_cassettes/measure__load_composite_measure.yml b/test/fixtures/vcr_cassettes/measure__load_composite_measure.yml
@@ -5,7 +5,7 @@ http_interactions:
     uri: https://vsac.nlm.nih.gov/vsac/ws/Ticket
     body:
       encoding: US-ASCII
-      string: username=<VSAC_USERNAME>&password=<VSAC_PASSWORD>
+      string: apikey=<VSAC_API_KEY>
     headers:
       User-Agent:
       - Typhoeus - https://github.com/typhoeus/typhoeus

diff --git a/test/fixtures/vcr_cassettes/measure__measure_including_draft.yml b/test/fixtures/vcr_cassettes/measure__measure_including_draft.yml
diff --git a/test/fixtures/vcr_cassettes/measure__negated_source_criteria_with_drc.yml b/test/fixtures/vcr_cassettes/measure__negated_source_criteria_with_drc.yml
diff --git a/test/fixtures/vcr_cassettes/measure__population_titles.yml b/test/fixtures/vcr_cassettes/measure__population_titles.yml
diff --git a/test/fixtures/vcr_cassettes/measure__source_data_criteria_creation.yml b/test/fixtures/vcr_cassettes/measure__source_data_criteria_creation.yml
diff --git a/test/fixtures/vcr_cassettes/measure__stratifications_and_observations.yml b/test/fixtures/vcr_cassettes/measure__stratifications_and_observations.yml
diff --git a/test/fixtures/vcr_cassettes/measure__test_5_4_CQL_measure.yml b/test/fixtures/vcr_cassettes/measure__test_5_4_CQL_measure.yml
diff --git a/test/fixtures/vcr_cassettes/measure__test_can_use_cache.yml b/test/fixtures/vcr_cassettes/measure__test_can_use_cache.yml
diff --git a/test/fixtures/vcr_cassettes/measure__test_cms_id.yml b/test/fixtures/vcr_cassettes/measure__test_cms_id.yml
diff --git a/...ettes/measure__test_invalid_composite_measure_with_component_measure_missing_xml_file.yml b/...ettes/measure__test_invalid_composite_measure_with_component_measure_missing_xml_file.yml
diff --git a/test/fixtures/vcr_cassettes/measure__test_measure.yml b/test/fixtures/vcr_cassettes/measure__test_measure.yml
diff --git a/test/fixtures/vcr_cassettes/measure__test_multiple_libraries.yml b/test/fixtures/vcr_cassettes/measure__test_multiple_libraries.yml
diff --git a/test/fixtures/vcr_cassettes/measure__test_proportional_cv_measure.yml b/test/fixtures/vcr_cassettes/measure__test_proportional_cv_measure.yml
@@ -5,7 +5,7 @@ http_interactions:
     uri: https://vsac.nlm.nih.gov/vsac/ws/Ticket
     body:
       encoding: US-ASCII
-      string: username=<VSAC_USERNAME>&password=<VSAC_PASSWORD>
+      string: apikey=<VSAC_API_KEY>
     headers:
       User-Agent:
       - Typhoeus - https://github.com/typhoeus/typhoeus

diff --git a/test/fixtures/vcr_cassettes/measure__test_ratio_cv_measure.yml b/test/fixtures/vcr_cassettes/measure__test_ratio_cv_measure.yml
diff --git a/test/fixtures/vcr_cassettes/measure__unique_characters_stored_correctly.yml b/test/fixtures/vcr_cassettes/measure__unique_characters_stored_correctly.yml
diff --git a/test/fixtures/vcr_cassettes/vs_loading_draft_no_profile_version.yml b/test/fixtures/vcr_cassettes/vs_loading_draft_no_profile_version.yml
diff --git a/test/fixtures/vcr_cassettes/vs_loading_draft_profile.yml b/test/fixtures/vcr_cassettes/vs_loading_draft_profile.yml
diff --git a/test/fixtures/vcr_cassettes/vs_loading_draft_verion.yml b/test/fixtures/vcr_cassettes/vs_loading_draft_verion.yml
diff --git a/test/fixtures/vcr_cassettes/vs_loading_empty_concept_list.yml b/test/fixtures/vcr_cassettes/vs_loading_empty_concept_list.yml
diff --git a/test/fixtures/vcr_cassettes/vs_loading_meausre_defined_no_backup_profile.yml b/test/fixtures/vcr_cassettes/vs_loading_meausre_defined_no_backup_profile.yml
diff --git a/test/fixtures/vcr_cassettes/vs_loading_no_profile_version.yml b/test/fixtures/vcr_cassettes/vs_loading_no_profile_version.yml
diff --git a/test/fixtures/vcr_cassettes/vs_loading_not_found_response.yml b/test/fixtures/vcr_cassettes/vs_loading_not_found_response.yml
diff --git a/test/fixtures/vcr_cassettes/vs_loading_profile.yml b/test/fixtures/vcr_cassettes/vs_loading_profile.yml
diff --git a/test/fixtures/vcr_cassettes/vs_loading_release.yml b/test/fixtures/vcr_cassettes/vs_loading_release.yml
@@ -5,7 +5,7 @@ http_interactions:
     uri: https://vsac.nlm.nih.gov/vsac/ws/Ticket
     body:
       encoding: US-ASCII
-      string: username=<VSAC_USERNAME>&password=<VSAC_PASSWORD>
+      string: apikey=<VSAC_API_KEY>
     headers:
       User-Agent:
       - Typhoeus - https://github.com/typhoeus/typhoeus

diff --git a/test/fixtures/vcr_cassettes/vs_loading_version.yml b/test/fixtures/vcr_cassettes/vs_loading_version.yml
@@ -5,7 +5,7 @@ http_interactions:
     uri: https://vsac.nlm.nih.gov/vsac/ws/Ticket
     body:
       encoding: US-ASCII
-      string: username=<VSAC_USERNAME>&password=<VSAC_PASSWORD>
+      string: apikey=<VSAC_API_KEY>
     headers:
       User-Agent:
       - Typhoeus - https://github.com/typhoeus/typhoeus

diff --git a/test/fixtures/vcr_cassettes/vs_loading_with_username_password.yml b/test/fixtures/vcr_cassettes/vs_loading_with_username_password.yml
@@ -5,7 +5,7 @@ http_interactions:
     uri: https://vsac.nlm.nih.gov/vsac/ws/Ticket
     body:
       encoding: US-ASCII
-      string: username=<VSAC_USERNAME>&password=<VSAC_PASSWORD>
+      string: apikey=<VSAC_API_KEY>
     headers:
       User-Agent:
       - Typhoeus - https://github.com/typhoeus/typhoeus

diff --git a/test/fixtures/vcr_cassettes/vsac_auth_bad_credentials.yml b/test/fixtures/vcr_cassettes/vsac_auth_bad_credentials.yml
diff --git a/test/fixtures/vcr_cassettes/vsac_auth_good_credentials.yml b/test/fixtures/vcr_cassettes/vsac_auth_good_credentials.yml