ibm_cloud_sdk_core 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a9ddbe886404d076c07ea7b657f691b3f2a09ad758bd20efaa7555f425d75d1
-  data.tar.gz: 9f3eb249e1f4d6408c233239eabd4ed28f146fa906bfa3b08c9b94bb26e06661
+  metadata.gz: 632fa6196faf266c004867a8002a4dc159aa652d9dd26144975a987cb9b0e7c0
+  data.tar.gz: 4d555fd04a96095a72e01dd78be693c66bb0e04e36f4307ee211042256960fe8
 SHA512:
-  metadata.gz: 3a12157d888a148803b7943f1b372bf54d7e84822d9408426a0a6d401af80f672b5fde0bff5a1b6623e8cc8a1fb74d7cf80bfb52ad7db0c129dcd4409c4479ad
-  data.tar.gz: ea21d829cdb3c02dc25874649f867d5ff65d4f0cb7cdcb06542774d1aba2bbb60350ea5ea5e8bd55c6d7f6d55b449aad0c32d53f9906be9e23459265ed0ce996
+  metadata.gz: bea320e17520b61c97bd2b48cb230a401fed62476749250779622598d5a40242f1b186fafee50e4829257d356b528b536c78010f389073e731619589ab985f22
+  data.tar.gz: 106b79e7a30871c74c84ad47ae8d17cbaa306dd98dc1174f06a23a471865cea42954d06030fd301174cac7ab868fdd76abd19db54bb4840eca47103b1b3e58f8

data/lib/ibm_cloud_sdk_core/base_service.rb

@@ -39,16 +39,11 @@ module IBMCloudSdkCore
 
       raise ArgumentError.new("authenticator must be provided") if @authenticator.nil?
 
-      if @service_name && !@service_url
-        config = get_service_properties(@service_name)
-        @service_url = config[:url] unless config.nil?
-      end
-
-      configure_http_client(disable_ssl_verification: @disable_ssl_verification)
-      @temp_headers = {}
       @conn = HTTP::Client.new(
         headers: {}
       ).use normalize_uri: { normalizer: NORMALIZER }
+      configure_service(@service_name)
+      @temp_headers = {}
     end
 
     def disable_ssl_verification=(disable_ssl_verification)
@@ -61,6 +56,15 @@ module IBMCloudSdkCore
       headers.each_pair { |k, v| @conn.default_options.headers.add(k, v) }
     end
 
+    def configure_service(service_name)
+      config = get_service_properties(service_name) if service_name
+
+      @service_url = config[:url] unless config.nil? || config[:url].nil?
+      disable_ssl_verification = explicitly_true(config[:disable_ssl]) unless config.nil? || config[:disable_ssl].nil?
+      # configure the http client if ssl is disabled
+      configure_http_client(disable_ssl_verification: disable_ssl_verification) if disable_ssl_verification
+    end
+
     # @return [DetailedResponse]
     def request(args)
       defaults = { method: nil, url: nil, accept_json: false, headers: nil, params: nil, json: {}, data: nil }
@@ -143,8 +147,6 @@ module IBMCloudSdkCore
         ssl_context = OpenSSL::SSL::SSLContext.new
         ssl_context.verify_mode = OpenSSL::SSL::VERIFY_NONE
         @conn.default_options = { ssl_context: ssl_context }
-
-        @token_manager&.ssl_verification(true)
       end
       add_proxy(proxy) unless proxy.empty? || !proxy.dig(:address).is_a?(String) || !proxy.dig(:port).is_a?(Integer)
       add_timeout(timeout) unless timeout.empty? || (!timeout.key?(:per_operation) && !timeout.key?(:global))

data/lib/ibm_cloud_sdk_core/utils.rb

@@ -16,6 +16,13 @@ def check_bad_first_or_last_char(str)
   return str.start_with?("{", "\"") || str.end_with?("}", "\"") unless str.nil?
 end
 
+# checks if the provided value is truthy
+def explicitly_true(value)
+  return value.to_s.casecmp("true").zero? unless value.nil?
+
+  false
+end
+
 # Initiates the credentials based on the credential file
 def load_from_credential_file(service_name, separator = "=")
   credential_file_path = ENV["IBM_CREDENTIALS_FILE"]
@@ -63,10 +70,20 @@ def load_from_vcap_services(service_name)
   vcap_services = ENV["VCAP_SERVICES"]
   unless vcap_services.nil?
     services = JSON.parse(vcap_services)
+    credentials = ""
+    # search for matching inner name value
+    services.each do |_key, val|
+      service = val.detect { |item| item["name"] == service_name }
+      credentials = service["credentials"] unless service.nil?
+      break unless credentials.nil? || credentials.empty?
+    end
     config = {}
-    credentials = services[service_name][0]["credentials"] if services.key?(service_name)
-    return config if credentials.nil?
-
+    # if no matching inner key is found, then search outer keys
+    if credentials.nil? || credentials.empty?
+      credentials = services[service_name][0]["credentials"] if services.key?(service_name) && !services[service_name].empty?
+      return config if credentials.nil? || credentials.empty?
+    end
+    # store credentials
     credentials.each do |key, val|
       config.store(key.to_sym, val)
     end

data/lib/ibm_cloud_sdk_core/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module IBMCloudSdkCore
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/test/unit/test_base_service.rb

@@ -26,6 +26,7 @@ class BaseServiceTest < Minitest::Test
     assert_raises do
       IBMCloudSdkCore::ConfigBasedAuthenticatorFactory.new.get_authenticator(service_name: "wrong")
     end
+    ENV.delete("IBM_CREDENTIALS_FILE")
   end
 
   def test_wrong_url
@@ -130,6 +131,7 @@ class BaseServiceTest < Minitest::Test
     service = IBMCloudSdkCore::BaseService.new(service_name: "leo_messi", url: "some.url", authenticator: authenticator)
     assert_equal(authenticator.authentication_type, "bearerToken")
     refute_nil(service)
+    ENV.delete("IBM_CREDENTIALS_FILE")
   end
 
   def test_vcap_services
@@ -138,6 +140,7 @@ class BaseServiceTest < Minitest::Test
     service = IBMCloudSdkCore::BaseService.new(service_name: "salah", authenticator: authenticator)
     assert_equal(authenticator.username, "mo")
     assert_equal(service.service_name, "salah")
+    ENV.delete("VCAP_SERVICES")
   end
 
   def test_dummy_request
@@ -149,9 +152,11 @@ class BaseServiceTest < Minitest::Test
         }
       ).to_return(status: 200, body: "", headers: {})
     authenticator = IBMCloudSdkCore::ConfigBasedAuthenticatorFactory.new.get_authenticator(service_name: "salah")
-    service = IBMCloudSdkCore::BaseService.new(service_name: "salah", authenticator: authenticator, service_url: "https://we.the.best")
+    service = IBMCloudSdkCore::BaseService.new(service_name: "salah", authenticator: authenticator)
+    service.service_url = "https://we.the.best"
     service_response = service.request(method: "GET", url: "/music", headers: {})
     assert_equal("", service_response.result)
+    ENV.delete("VCAP_SERVICES")
   end
 
   def test_dummy_request_form_data
@@ -192,10 +197,12 @@ class BaseServiceTest < Minitest::Test
         }
       ).to_return(status: 500, body: response.to_json, headers: {})
     authenticator = IBMCloudSdkCore::ConfigBasedAuthenticatorFactory.new.get_authenticator(service_name: "salah")
-    service = IBMCloudSdkCore::BaseService.new(service_name: "salah", authenticator: authenticator, service_url: "https://we.the.best")
+    service = IBMCloudSdkCore::BaseService.new(service_name: "salah", authenticator: authenticator)
+    service.service_url = "https://we.the.best"
     assert_raises IBMCloudSdkCore::ApiException do
       service.request(method: "GET", url: "/music", headers: {})
     end
+    ENV.delete("VCAP_SERVICES")
   end
 
   def test_dummy_request_icp
@@ -225,4 +232,103 @@ class BaseServiceTest < Minitest::Test
     service_response = service.request(method: "GET", url: "/music", headers: {})
     assert_equal(response, service_response.result)
   end
+
+  def test_configure_service_using_credentials_in_env
+    file_path = File.join(File.dirname(__FILE__), "../../resources/ibm-credentials.env")
+    ENV["IBM_CREDENTIALS_FILE"] = file_path
+
+    authenticator = IBMCloudSdkCore::BasicAuthenticator.new(
+      username: "apikey",
+      password: "icp-xyz"
+    )
+    service = IBMCloudSdkCore::BaseService.new(
+      authenticator: authenticator,
+      service_name: "visual_recognition"
+    )
+    service.configure_service("visual_recognition")
+
+    assert_equal("https://gateway.ronaldo.com", service.service_url)
+    assert(service.disable_ssl_verification)
+    ENV.delete("IBM_CREDENTIALS_FILE")
+  end
+
+  def test_configure_service_using_credentials_in_vcap_match_outer_key
+    authenticator = IBMCloudSdkCore::BasicAuthenticator.new(
+      username: "apikey",
+      password: "icp-xyz"
+    )
+    service = IBMCloudSdkCore::BaseService.new(
+      authenticator: authenticator,
+      service_name: "key_to_service_entry_1"
+    )
+    ENV["VCAP_SERVICES"] = JSON.parse(File.read(Dir.getwd + "/resources/vcap-testing.json")).to_json
+    service.configure_service("key_to_service_entry_1")
+
+    assert_equal("https://on.the.toolchainplatform.net/devops-insights/api", service.service_url)
+    ENV.delete("VCAP_SERVICES")
+  end
+
+  def test_configure_service_using_credentials_in_vcap_match_inner_key
+    authenticator = IBMCloudSdkCore::BasicAuthenticator.new(
+      username: "apikey",
+      password: "icp-xyz"
+    )
+    service = IBMCloudSdkCore::BaseService.new(
+      authenticator: authenticator,
+      service_name: "devops_insights"
+    )
+    ENV["VCAP_SERVICES"] = JSON.parse(File.read(Dir.getwd + "/resources/vcap-testing.json")).to_json
+    service.configure_service("devops_insights")
+
+    assert_equal("https://ibmtesturl.net/devops_insights/api", service.service_url)
+    ENV.delete("VCAP_SERVICES")
+  end
+
+  def test_configure_service_using_credentials_in_vcap_no_matching_key
+    authenticator = IBMCloudSdkCore::BasicAuthenticator.new(
+      username: "apikey",
+      password: "icp-xyz"
+    )
+    service = IBMCloudSdkCore::BaseService.new(
+      authenticator: authenticator,
+      service_name: "different_name_two"
+    )
+    ENV["VCAP_SERVICES"] = JSON.parse(File.read(Dir.getwd + "/resources/vcap-testing.json")).to_json
+    service.configure_service("different_name_two")
+
+    assert_equal("https://gateway.watsonplatform.net/different-name-two/api", service.service_url)
+    ENV.delete("VCAP_SERVICES")
+  end
+
+  def test_configure_service_using_credentials_in_vcap_empty_entry
+    authenticator = IBMCloudSdkCore::BasicAuthenticator.new(
+      username: "apikey",
+      password: "icp-xyz"
+    )
+    service = IBMCloudSdkCore::BaseService.new(
+      authenticator: authenticator,
+      service_name: "empty_service"
+    )
+    ENV["VCAP_SERVICES"] = JSON.parse(File.read(Dir.getwd + "/resources/vcap-testing.json")).to_json
+    service.configure_service("empty_service")
+
+    assert_nil(service.service_url)
+    ENV.delete("VCAP_SERVICES")
+  end
+
+  def test_configure_service_using_credentials_in_vcap_no_creds
+    authenticator = IBMCloudSdkCore::BasicAuthenticator.new(
+      username: "apikey",
+      password: "icp-xyz"
+    )
+    service = IBMCloudSdkCore::BaseService.new(
+      authenticator: authenticator,
+      service_name: "no-creds-service-two"
+    )
+    ENV["VCAP_SERVICES"] = JSON.parse(File.read(Dir.getwd + "/resources/vcap-testing.json")).to_json
+    service.configure_service("no-creds-service-two")
+
+    assert_nil(service.service_url)
+    ENV.delete("VCAP_SERVICES")
+  end
 end

data/test/unit/test_utils.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require("json")
+require("jwt")
+require_relative("./../test_helper.rb")
+require_relative("./../../lib/ibm_cloud_sdk_core/authenticators/basic_authenticator")
+require_relative("./../../lib/ibm_cloud_sdk_core/authenticators/config_based_authenticator_factory")
+require("webmock/minitest")
+
+WebMock.disable_net_connect!(allow_localhost: true)
+
+# Unit tests for the utility methods
+class UtilsTest < Minitest::Test
+  def test_explicitly_true
+    assert(explicitly_true("true"))
+    assert(explicitly_true("True"))
+    assert(explicitly_true(true))
+
+    assert_equal(explicitly_true("false"), false)
+    assert_equal(explicitly_true("False"), false)
+    assert_equal(explicitly_true("someothervalue"), false)
+    assert_equal(explicitly_true(""), false)
+    assert_equal(explicitly_true(false), false)
+    assert_equal(explicitly_true(nil), false)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ibm_cloud_sdk_core
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Mamoon Raja
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-30 00:00:00.000000000 Z
+date: 2019-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -253,6 +253,7 @@ files:
 - test/unit/test_iam_authenticator.rb
 - test/unit/test_iam_token_manager.rb
 - test/unit/test_jwt_token_manager.rb
+- test/unit/test_utils.rb
 homepage: https://www.github.com/IBM
 licenses:
 - Apache-2.0