ibm_cloud_sdk_core 0.1.1

data/lib/ibm_cloud_sdk_core/version.rb

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

data/rakefile

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "dotenv/tasks"
+require "rake/testtask"
+require "rubocop/rake_task"
+
+task default: %w[def]
+
+RuboCop::RakeTask.new
+
+namespace :test do
+  Rake::TestTask.new do |t|
+    t.name = "unit"
+    t.description = "Run unit tests"
+    t.libs << "test"
+    t.test_files = FileList["test/unit/*.rb"]
+    t.verbose = true
+    t.warning = true
+    t.deps = [:rubocop]
+  end
+
+  Rake::TestTask.new do |t|
+    t.name = "appveyor_status"
+    t.description = "Checks to ensure that AppVeyor tests pass before deploying from Travis"
+    t.libs << "test"
+    t.test_files = FileList["test/appveyor_status.rb"]
+    t.verbose = false
+    t.warning = false
+  end
+end
+
+desc "Run unit tests"
+task :test do
+  Rake::Task["test:unit"].invoke
+end
+
+desc "Run tests and generate a code coverage report"
+task :coverage do
+  ENV["COVERAGE"] = "true" if ENV["TRAVIS_RUBY_VERSION"] == "2.5.1" || ENV["CI"].nil?
+  Rake::Task["test"].execute
+end
+
+task def: %i[coverage] do
+end

data/test/test_helper.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require("simplecov")
+require("codecov")
+require("minitest/reporters")
+
+if ENV["COVERAGE"]
+  SimpleCov.formatter = SimpleCov::Formatter::Codecov if ENV["CI"]
+  unless SimpleCov.running
+    SimpleCov.start do
+      add_filter "/test/"
+      add_filter do |src_file|
+        File.basename(src_file.filename) == "version.rb"
+      end
+
+      command_name "Minitest"
+    end
+  end
+end
+
+require("minitest/autorun")
+require_relative("./../lib/ibm_cloud_sdk_core.rb")
+require("minitest/retry")
+
+Minitest::Retry.use!
+
+Minitest::Reporters.use! [Minitest::Reporters::DefaultReporter.new(color: true, slow_count: 10), Minitest::Reporters::SpecReporter.new, Minitest::Reporters::HtmlReporter.new] if ENV["CI"].nil?
+Minitest::Reporters.use! [Minitest::Reporters::DefaultReporter.new(color: true, slow_count: 10), Minitest::Reporters::SpecReporter.new] if ENV["CI"]

data/test/unit/test_base_service.rb

@@ -0,0 +1,304 @@
+# frozen_string_literal: true
+
+require("json")
+require_relative("./../test_helper.rb")
+require("webmock/minitest")
+
+WebMock.disable_net_connect!(allow_localhost: true)
+
+# Unit tests for the base service
+class BaseServiceTest < Minitest::Test
+  def test_wrong_username
+    assert_raises do
+      IBMCloudSdkCore::BaseService.new(
+        username: "\"username",
+        password: "password"
+      )
+    end
+  end
+
+  def test_wrong_apikey
+    assert_raises do
+      IBMCloudSdkCore::BaseService.new(
+        iam_apikey: "{apikey"
+      )
+    end
+  end
+
+  def test_wrong_url
+    assert_raises do
+      IBMCloudSdkCore::BaseService.new(
+        iam_apikey: "apikey",
+        url: "url}"
+      )
+    end
+  end
+
+  def test_correct_creds_and_headers
+    service = IBMCloudSdkCore::BaseService.new(
+      username: "username",
+      password: "password"
+    )
+    service.add_default_headers(
+      headers: {
+        "X-Watson-Learning-Opt-Out" => "1",
+        "X-Watson-Test" => "1"
+      }
+    )
+    service.headers("analytics" => "example")
+    refute_nil(service)
+  end
+
+  def test_iam_access_token
+    token = "new$token"
+    service = IBMCloudSdkCore::BaseService.new(
+      url: "https://we.the.best"
+    )
+    response = service.iam_access_token(iam_access_token: token)
+    assert_equal(response, token)
+  end
+
+  def test_set_credentials_from_path_in_env
+    file_path = File.join(File.dirname(__FILE__), "../../resources/ibm-credentials.env")
+    ENV["IBM_CREDENTIALS_FILE"] = file_path
+    service = IBMCloudSdkCore::BaseService.new(display_name: "Visual Recognition")
+    assert_equal(service.url, "https://gateway.ronaldo.com")
+    refute_nil(service)
+    ENV.delete("IBM_CREDENTIALS_FILE")
+  end
+
+  def test_vcap_services
+    ENV["VCAP_SERVICES"] = JSON.parse(File.read(Dir.getwd + "/resources/vcap-testing.json")).to_json
+    service = IBMCloudSdkCore::BaseService.new(vcap_services_name: "salah", use_vcap_services: true)
+    assert_equal(service.username, "mo")
+  end
+
+  def test_dummy_request
+    ENV["VCAP_SERVICES"] = JSON.parse(File.read(Dir.getwd + "/resources/vcap-testing.json")).to_json
+    stub_request(:get, "https://we.the.best/music")
+      .with(
+        headers: {
+          "Host" => "we.the.best"
+        }
+      ).to_return(status: 200, body: "", headers: {})
+    service = IBMCloudSdkCore::BaseService.new(display_name: "Salah", url: "https://we.the.best")
+    service_response = service.request(method: "GET", url: "/music", headers: {})
+    assert_equal("", service_response.result)
+  end
+
+  def test_dummy_request_form_data
+    service = IBMCloudSdkCore::BaseService.new(
+      iam_apikey: "apikey",
+      iam_access_token: "token",
+      url: "https://gateway.watsonplatform.net/"
+    )
+    form_data = {}
+    file = File.open(Dir.getwd + "/resources/cnc_test.pdf")
+    filename = file.path if filename.nil? && file.respond_to?(:path)
+    form_data[:file] = HTTP::FormData::File.new(file, content_type: "application/octet-stream", filename: filename)
+
+    stub_request(:post, "https://gateway.watsonplatform.net/").with do |req|
+      # Test the headers.
+      assert_equal(req.headers["Accept"], "application/json")
+      assert_match(%r{\Amultipart/form-data}, req.headers["Content-Type"])
+    end
+    service.request(
+      method: "POST",
+      form: form_data,
+      headers: { "Accept" => "application/json" },
+      url: ""
+    )
+  end
+
+  def test_dummy_request_fails
+    ENV["VCAP_SERVICES"] = JSON.parse(File.read(Dir.getwd + "/resources/vcap-testing.json")).to_json
+    response = {
+      "code" => "500",
+      "error" => "Oh no"
+    }
+    stub_request(:get, "https://we.the.best/music")
+      .with(
+        headers: {
+          "Host" => "we.the.best"
+        }
+      ).to_return(status: 500, body: response.to_json, headers: {})
+    service = IBMCloudSdkCore::BaseService.new(display_name: "Salah", url: "https://we.the.best")
+    assert_raises do
+      service.request(method: "GET", url: "/music", headers: {})
+    end
+  end
+
+  def test_dummy_request_icp
+    response = {
+      "text" => "I want financial advice today.",
+      "created" => "2016-07-11T16:39:01.774Z",
+      "updated" => "2015-12-07T18:53:59.153Z"
+    }
+    headers = {
+      "Content-Type" => "application/json"
+    }
+    stub_request(:get, "https://we.the.best/music")
+      .with(
+        headers: {
+          "Authorization" => "Basic YXBpa2V5OmljcC14eXo=",
+          "Host" => "we.the.best"
+        }
+      ).to_return(status: 200, body: response.to_json, headers: headers)
+    service = IBMCloudSdkCore::BaseService.new(
+      url: "https://we.the.best",
+      username: "apikey",
+      password: "icp-xyz"
+    )
+    service_response = service.request(method: "GET", url: "/music", headers: {})
+    assert_equal(response, service_response.result)
+  end
+
+  def test_dummy_request_icp_iam_apikey
+    response = {
+      "text" => "I want financial advice today.",
+      "created" => "2016-07-11T16:39:01.774Z",
+      "updated" => "2015-12-07T18:53:59.153Z"
+    }
+    headers = {
+      "Content-Type" => "application/json"
+    }
+    stub_request(:get, "https://we.the.best/music")
+      .with(
+        headers: {
+          "Authorization" => "Basic YXBpa2V5OmljcC14eXo=",
+          "Host" => "we.the.best"
+        }
+      ).to_return(status: 200, body: response.to_json, headers: headers)
+    service = IBMCloudSdkCore::BaseService.new(
+      url: "https://we.the.best",
+      iam_apikey: "icp-xyz"
+    )
+    service_response = service.request(method: "GET", url: "/music", headers: {})
+    assert_equal(response, service_response.result)
+  end
+
+  def test_dummy_request_icp_iam_apikey_cred_file
+    response = {
+      "text" => "I want financial advice today.",
+      "created" => "2016-07-11T16:39:01.774Z",
+      "updated" => "2015-12-07T18:53:59.153Z"
+    }
+    headers = {
+      "Content-Type" => "application/json"
+    }
+    stub_request(:get, "https://we.the.best/music")
+      .with(
+        headers: {
+          "Authorization" => "Basic YXBpa2V5OmljcC14eXo=",
+          "Host" => "we.the.best"
+        }
+      ).to_return(status: 200, body: response.to_json, headers: headers)
+    file_path = File.join(File.dirname(__FILE__), "../../resources/ibm-credentials.env")
+    ENV["IBM_CREDENTIALS_FILE"] = file_path
+    service = IBMCloudSdkCore::BaseService.new(
+      url: "https://we.the.best",
+      display_name: "messi"
+    )
+    service_response = service.request(method: "GET", url: "/music", headers: {})
+    assert_equal(response, service_response.result)
+  end
+
+  def test_dummy_request_username_apikey
+    response = {
+      "text" => "I want financial advice today.",
+      "created" => "2016-07-11T16:39:01.774Z",
+      "updated" => "2015-12-07T18:53:59.153Z"
+    }
+    token_response = {
+      "access_token" => "oAeisG8yqPY7sFR_x66Z15",
+      "token_type" => "Bearer",
+      "expires_in" => 3600,
+      "expiration" => 1_524_167_011,
+      "refresh_token" => "jy4gl91BQ"
+    }
+
+    headers = {
+      "Content-Type" => "application/json"
+    }
+    stub_request(:post, "https://iam.bluemix.net/identity/token")
+      .with(
+        body: {
+          "apikey" => "xyz",
+          "grant_type" => "urn:ibm:params:oauth:grant-type:apikey",
+          "response_type" => "cloud_iam"
+        },
+        headers: {
+          "Accept" => "application/json",
+          "Authorization" => "Basic Yng6Yng=",
+          "Connection" => "close",
+          "Content-Type" => "application/x-www-form-urlencoded",
+          "Host" => "iam.bluemix.net",
+          "User-Agent" => "http.rb/4.1.1"
+        }
+      ).to_return(status: 200, body: token_response.to_json, headers: {})
+    stub_request(:get, "https://we.the.best/music")
+      .with(
+        headers: {
+          "Authorization" => "Bearer oAeisG8yqPY7sFR_x66Z15",
+          "Host" => "we.the.best"
+        }
+      ).to_return(status: 200, body: response.to_json, headers: headers)
+    service = IBMCloudSdkCore::BaseService.new(
+      url: "https://we.the.best",
+      username: "apikey",
+      password: "xyz"
+    )
+    service_response = service.request(method: "GET", url: "/music", headers: {})
+    assert_equal(response, service_response.result)
+  end
+
+  def test_dummy_request_username_apikey_cred_file
+    response = {
+      "text" => "I want financial advice today.",
+      "created" => "2016-07-11T16:39:01.774Z",
+      "updated" => "2015-12-07T18:53:59.153Z"
+    }
+    token_response = {
+      "access_token" => "oAeisG8yqPY7sFR_x66Z15",
+      "token_type" => "Bearer",
+      "expires_in" => 3600,
+      "expiration" => 1_524_167_011,
+      "refresh_token" => "jy4gl91BQ"
+    }
+
+    headers = {
+      "Content-Type" => "application/json"
+    }
+    stub_request(:post, "https://iam.bluemix.net/identity/token")
+      .with(
+        body: {
+          "apikey" => "xyz",
+          "grant_type" => "urn:ibm:params:oauth:grant-type:apikey",
+          "response_type" => "cloud_iam"
+        },
+        headers: {
+          "Accept" => "application/json",
+          "Authorization" => "Basic Yng6Yng=",
+          "Connection" => "close",
+          "Content-Type" => "application/x-www-form-urlencoded",
+          "Host" => "iam.bluemix.net",
+          "User-Agent" => "http.rb/4.1.1"
+        }
+      ).to_return(status: 200, body: token_response.to_json, headers: {})
+    stub_request(:get, "https://we.the.best/music")
+      .with(
+        headers: {
+          "Authorization" => "Bearer oAeisG8yqPY7sFR_x66Z15",
+          "Host" => "we.the.best"
+        }
+      ).to_return(status: 200, body: response.to_json, headers: headers)
+    file_path = File.join(File.dirname(__FILE__), "../../resources/ibm-credentials.env")
+    ENV["IBM_CREDENTIALS_FILE"] = file_path
+    service = IBMCloudSdkCore::BaseService.new(
+      display_name: "ronaldo",
+      url: "https://we.the.best"
+    )
+    service_response = service.request(method: "GET", url: "/music", headers: {})
+    assert_equal(response, service_response.result)
+  end
+end

data/test/unit/test_configure_http_proxy.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+require("json")
+require_relative("./../test_helper.rb")
+require("webmock/minitest")
+
+WebMock.disable_net_connect!(allow_localhost: true)
+
+# Unit tests for the configure_http_client customizations, such as proxies and timeouts
+class HTTPConfigTest < Minitest::Test
+  def test_proxy_address_port
+    service = IBMCloudSdkCore::BaseService.new(
+      version: "2018-03-16",
+      username: "username",
+      password: "password"
+    )
+    service.configure_http_client(
+      proxy: {
+        address: "bogus_address.com",
+        port: 9999
+      }
+    )
+    proxy = service.conn.default_options.proxy
+    assert_equal("bogus_address.com", proxy[:proxy_address])
+    assert_equal(9999, proxy[:proxy_port])
+  end
+
+  def test_proxy_username_password
+    service = IBMCloudSdkCore::BaseService.new(
+      version: "2018-03-16",
+      username: "username",
+      password: "password"
+    )
+    service.configure_http_client(
+      proxy: {
+        address: "bogus_address.com",
+        port: 9999,
+        username: "username",
+        password: "password"
+      }
+    )
+    proxy = service.conn.default_options.proxy
+    assert_equal("bogus_address.com", proxy[:proxy_address])
+    assert_equal(9999, proxy[:proxy_port])
+    assert_equal("username", proxy[:proxy_username])
+    assert_equal("password", proxy[:proxy_password])
+  end
+
+  def test_proxy_headers
+    service = IBMCloudSdkCore::BaseService.new(
+      version: "2018-03-16",
+      username: "username",
+      password: "password"
+    )
+    service.configure_http_client(
+      proxy: {
+        address: "bogus_address.com",
+        port: 9999,
+        headers: {
+          bogus_header: true
+        }
+      }
+    )
+    proxy = service.conn.default_options.proxy
+    assert_equal("bogus_address.com", proxy[:proxy_address])
+    assert_equal(9999, proxy[:proxy_port])
+    assert_equal({ bogus_header: true }, proxy[:proxy_headers])
+  end
+
+  def test_proxy_username_password_headers
+    service = IBMCloudSdkCore::BaseService.new(
+      version: "2018-03-16",
+      username: "username",
+      password: "password"
+    )
+    service.configure_http_client(
+      proxy: {
+        address: "bogus_address.com",
+        port: 9999,
+        username: "username",
+        password: "password",
+        headers: {
+          bogus_header: true
+        }
+      }
+    )
+    proxy = service.conn.default_options.proxy
+    assert_equal("bogus_address.com", proxy[:proxy_address])
+    assert_equal(9999, proxy[:proxy_port])
+    assert_equal("username", proxy[:proxy_username])
+    assert_equal("password", proxy[:proxy_password])
+    assert_equal({ bogus_header: true }, proxy[:proxy_headers])
+  end
+
+  def test_timeout_per_operation
+    service = IBMCloudSdkCore::BaseService.new(
+      version: "2018-03-16",
+      username: "username",
+      password: "password"
+    )
+    service.configure_http_client(
+      timeout: {
+        per_operation: {
+          read: 5,
+          write: 7,
+          connect: 10
+        }
+      }
+    )
+    timeout_class = service.conn.default_options.timeout_class
+    assert_equal(HTTP::Timeout::PerOperation, timeout_class)
+
+    expected_timeouts = {
+      read_timeout: 5,
+      write_timeout: 7,
+      connect_timeout: 10
+    }
+    timeout = service.conn.default_options.timeout_options
+    assert_equal(expected_timeouts, timeout)
+  end
+
+  def test_timeout_global
+    service = IBMCloudSdkCore::BaseService.new(
+      version: "2018-03-16",
+      username: "username",
+      password: "password"
+    )
+    service.configure_http_client(
+      timeout: {
+        global: 20
+      }
+    )
+    timeout_class = service.conn.default_options.timeout_class
+    assert_equal(HTTP::Timeout::Global, timeout_class)
+
+    expected_timeouts = {
+      global_timeout: 20
+    }
+    timeout = service.conn.default_options.timeout_options
+    assert_equal(expected_timeouts, timeout)
+  end
+
+  def test_disable_ssl_verification
+    service = IBMCloudSdkCore::BaseService.new(
+      version: "2018-03-16",
+      username: "username",
+      password: "password"
+    )
+    service.configure_http_client(disable_ssl_verification: true)
+    refute_nil(service.conn.default_options.ssl_context)
+  end
+end