ibm_cloud_sdk_core 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f1a58243a7408312fa23e3d7628a6fea40359e2565ce9966da37b0655663b9c
-  data.tar.gz: 5f51521d8185cefa9f6101debb7da0214de20338d9c8d71d1997c9565fab8cd3
+  metadata.gz: 9807ace911b05d47e8d13b72e7623c1ed2a68693cebec40f3d68f2f7d3e437ae
+  data.tar.gz: db29d041a1ab924b050e357ed6dfc64ed9f806a231fc82d4f48fc8342103adfe
 SHA512:
-  metadata.gz: f5675f25b359c9109b57e40a12f187a5c859f6737f8f40ce53e4104c03e9d7d2f2ce16b19afde24a314469a2766615b591772a72e53704c0656b6c0e2e7b19b5
-  data.tar.gz: 2c6bf48c17328e76044178406ab364a5bb01ef23b10ff416e85972452bc0ac6130dbc4212f42110797de80bee6f390d67e96b36714e9ebc777900139832b89e7
+  metadata.gz: 7cd90962533f73d125c1ca06346fe4e49d775c43ef1a0b3cce2a974c389942b793301e98b4be532eaf3e566c2ef7f5737127c865736e322ac2a4f1fa2be92765
+  data.tar.gz: c271ba5ee551a6121af1f4c4a68b9c2a14ca91f5839cd15ed370b004836b1891fe75a67aed8caa9b4182c5c0bf7ff29024fcd105f6a5f3f688b34e7973dcf9e4

data/README.md

@@ -1,9 +1,10 @@
 [![Build Status](https://travis-ci.com/IBM/ruby-sdk-core.svg?branch=master)](https://travis-ci.com/IBM/ruby-sdk-core)
 [![codecov](https://codecov.io/gh/IBM/ruby-sdk-core/branch/master/graph/badge.svg)](https://codecov.io/gh/IBM/ruby-sdk-core)
-[![Gem Version](https://badge.fury.io/rb/ibm_watson.svg)](https://rubygems.org/gems/ibm_cloud_sdk_core)
+[![Gem Version](https://badge.fury.io/rb/ibm_cloud_sdk_core.svg)](https://rubygems.org/gems/ibm_cloud_sdk_core)
 
 # ruby-sdk-core
-This project contains the core functionality used by Ruby SDK's generated by the IBM OpenAPI 3 SDK Generator (openapi-sdkgen).
+This project contains the core functionality used by Ruby SDK's generated by the
+[IBM OpenAPI SDK Generator](https://github.ibm.com/CloudEngineering/openapi-sdkgen).
 Ruby code generated by openapi-sdkgen will depend on the function contained in this project.
 
 ## Installation
@@ -32,4 +33,4 @@ Find more open source projects on the [IBM Github Page](http://github.com/IBM)
 ## License
 
 This library is licensed under Apache 2.0. Full license text is
-available in [LICENSE](LICENSE).
+available in [LICENSE](LICENSE).

data/lib/ibm_cloud_sdk_core/base_service.rb

@@ -28,6 +28,8 @@ module IBMCloudSdkCore
         iam_apikey: nil,
         iam_access_token: nil,
         iam_url: nil,
+        iam_client_id: nil,
+        iam_client_secret: nil,
         display_name: nil
       }
       vars = defaults.merge(vars)
@@ -42,7 +44,9 @@ module IBMCloudSdkCore
       @display_name = vars[:display_name]
 
       if (!vars[:iam_access_token].nil? || !vars[:iam_apikey].nil?) && !@icp_prefix
-        set_token_manager(iam_apikey: vars[:iam_apikey], iam_access_token: vars[:iam_access_token], iam_url: vars[:iam_url])
+        set_token_manager(iam_apikey: vars[:iam_apikey], iam_access_token: vars[:iam_access_token],
+                          iam_url: vars[:iam_url], iam_client_id: vars[:iam_client_id],
+                          iam_client_secret: vars[:iam_client_secret])
       elsif !vars[:iam_apikey].nil? && @icp_prefix
         @username = "apikey"
         @password = vars[:iam_apikey]
@@ -244,11 +248,16 @@ module IBMCloudSdkCore
       return str.start_with?("{", "\"") || str.end_with?("}", "\"") unless str.nil?
     end
 
-    def set_token_manager(iam_apikey: nil, iam_access_token: nil, iam_url: nil)
+    def set_token_manager(iam_apikey: nil, iam_access_token: nil, iam_url: nil,
+                          iam_client_id: nil, iam_client_secret: nil)
       @iam_apikey = iam_apikey
       @iam_access_token = iam_access_token
       @iam_url = iam_url
-      @token_manager = IAMTokenManager.new(iam_apikey: iam_apikey, iam_access_token: iam_access_token, iam_url: iam_url)
+      @iam_client_id = iam_client_id
+      @iam_client_secret = iam_client_secret
+      @token_manager =
+        IAMTokenManager.new(iam_apikey: iam_apikey, iam_access_token: iam_access_token,
+                            iam_url: iam_url, iam_client_id: iam_client_id, iam_client_secret: iam_client_secret)
     end
 
     def add_timeout(timeout)

data/lib/ibm_cloud_sdk_core/iam_token_manager.rb

@@ -8,16 +8,19 @@ require_relative("./version.rb")
 module IBMCloudSdkCore
   # Class to manage IAM Token Authentication
   class IAMTokenManager
-    DEFAULT_IAM_URL = "https://iam.bluemix.net/identity/token"
+    DEFAULT_IAM_URL = "https://iam.cloud.ibm.com/identity/token"
     CONTENT_TYPE = "application/x-www-form-urlencoded"
     ACCEPT = "application/json"
     DEFAULT_AUTHORIZATION = "Basic Yng6Yng="
+    DEFAULT_CLIENT_ID = "bx"
+    DEFAULT_CLIENT_SECRET = "bx"
     REQUEST_TOKEN_GRANT_TYPE = "urn:ibm:params:oauth:grant-type:apikey"
     REQUEST_TOKEN_RESPONSE_TYPE = "cloud_iam"
     REFRESH_TOKEN_GRANT_TYPE = "refresh_token"
 
     attr_accessor :token_info, :user_access_token
-    def initialize(iam_apikey: nil, iam_access_token: nil, iam_url: nil)
+    def initialize(iam_apikey: nil, iam_access_token: nil, iam_url: nil,
+                   iam_client_id: nil, iam_client_secret: nil)
       @iam_apikey = iam_apikey
       @user_access_token = iam_access_token
       @iam_url = iam_url.nil? ? DEFAULT_IAM_URL : iam_url
@@ -28,12 +31,22 @@ module IBMCloudSdkCore
         "expires_in" => nil,
         "expiration" => nil
       }
+      # Both the client id and secret should be provided or neither should be provided.
+      if !iam_client_id.nil? && !iam_client_secret.nil?
+        @iam_client_id = iam_client_id
+        @iam_client_secret = iam_client_secret
+      elsif iam_client_id.nil? && iam_client_secret.nil?
+        @iam_client_id = DEFAULT_CLIENT_ID
+        @iam_client_secret = DEFAULT_CLIENT_SECRET
+      else
+        raise ArgumentError.new("Only one of 'iam_client_id' or 'iam_client_secret' were specified, but both parameters should be specified together.")
+      end
     end
 
     def request(method:, url:, headers: nil, params: nil, data: nil)
       response = nil
       if headers.key?("Content-Type") && headers["Content-Type"] == CONTENT_TYPE
-        response = HTTP.request(
+        response = HTTP.basic_auth(user: @iam_client_id, pass: @iam_client_secret).request(
           method,
           url,
           body: HTTP::URI.form_encode(data),
@@ -78,7 +91,6 @@ module IBMCloudSdkCore
     def request_token
       headers = {
         "Content-Type" => CONTENT_TYPE,
-        "Authorization" => DEFAULT_AUTHORIZATION,
         "Accept" => ACCEPT
       }
       data = {
@@ -99,7 +111,6 @@ module IBMCloudSdkCore
     def refresh_token
       headers = {
         "Content-Type" => CONTENT_TYPE,
-        "Authorization" => DEFAULT_AUTHORIZATION,
         "accept" => ACCEPT
       }
       data = {

data/lib/ibm_cloud_sdk_core/version.rb

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

data/test/unit/test_base_service.rb

@@ -220,7 +220,7 @@ class BaseServiceTest < Minitest::Test
     headers = {
       "Content-Type" => "application/json"
     }
-    stub_request(:post, "https://iam.bluemix.net/identity/token")
+    stub_request(:post, "https://iam.cloud.ibm.com/identity/token")
       .with(
         body: {
           "apikey" => "xyz",
@@ -232,7 +232,7 @@ class BaseServiceTest < Minitest::Test
           "Authorization" => "Basic Yng6Yng=",
           "Connection" => "close",
           "Content-Type" => "application/x-www-form-urlencoded",
-          "Host" => "iam.bluemix.net",
+          "Host" => "iam.cloud.ibm.com",
           "User-Agent" => "http.rb/4.1.1"
         }
       ).to_return(status: 200, body: token_response.to_json, headers: {})
@@ -269,7 +269,7 @@ class BaseServiceTest < Minitest::Test
     headers = {
       "Content-Type" => "application/json"
     }
-    stub_request(:post, "https://iam.bluemix.net/identity/token")
+    stub_request(:post, "https://iam.cloud.ibm.com/identity/token")
       .with(
         body: {
           "apikey" => "xyz",
@@ -281,7 +281,7 @@ class BaseServiceTest < Minitest::Test
           "Authorization" => "Basic Yng6Yng=",
           "Connection" => "close",
           "Content-Type" => "application/x-www-form-urlencoded",
-          "Host" => "iam.bluemix.net",
+          "Host" => "iam.cloud.ibm.com",
           "User-Agent" => "http.rb/4.1.1"
         }
       ).to_return(status: 200, body: token_response.to_json, headers: {})

data/test/unit/test_iam_token_manager.rb

@@ -8,7 +8,6 @@ WebMock.disable_net_connect!(allow_localhost: true)
 # Unit tests for the IAM Token Manager
 class IAMTokenManagerTest < Minitest::Test
   def test_request_token
-    iam_url = "https://iam.bluemix.net/identity/token"
     response = {
       "access_token" => "oAeisG8yqPY7sFR_x66Z15",
       "token_type" => "Bearer",
@@ -17,19 +16,19 @@ class IAMTokenManagerTest < Minitest::Test
       "refresh_token" => "jy4gl91BQ"
     }
 
+    # Use default iam_url, client id/secret
     token_manager = IBMCloudSdkCore::IAMTokenManager.new(
       iam_apikey: "iam_apikey",
-      iam_access_token: "iam_access_token",
-      iam_url: iam_url
+      iam_access_token: "iam_access_token"
     )
-    stub_request(:post, "https://iam.bluemix.net/identity/token")
+    stub_request(:post, "https://iam.cloud.ibm.com/identity/token")
       .with(
         body: { "apikey" => "iam_apikey", "grant_type" => "urn:ibm:params:oauth:grant-type:apikey", "response_type" => "cloud_iam" },
         headers: {
           "Accept" => "application/json",
           "Authorization" => "Basic Yng6Yng=",
           "Content-Type" => "application/x-www-form-urlencoded",
-          "Host" => "iam.bluemix.net"
+          "Host" => "iam.cloud.ibm.com"
         }
       ).to_return(status: 200, body: response.to_json, headers: {})
     token_response = token_manager.send(:request_token)
@@ -63,24 +62,22 @@ class IAMTokenManagerTest < Minitest::Test
   end
 
   def test_request_token_fails_catch_exception
-    iam_url = "https://iam.bluemix.net/identity/token"
     token_manager = IBMCloudSdkCore::IAMTokenManager.new(
       iam_apikey: "iam_apikey",
-      iam_access_token: "iam_access_token",
-      iam_url: iam_url
+      iam_access_token: "iam_access_token"
     )
     response = {
       "code" => "500",
       "error" => "Oh no"
     }
-    stub_request(:post, "https://iam.bluemix.net/identity/token")
+    stub_request(:post, "https://iam.cloud.ibm.com/identity/token")
       .with(
         body: { "apikey" => "iam_apikey", "grant_type" => "urn:ibm:params:oauth:grant-type:apikey", "response_type" => "cloud_iam" },
         headers: {
           "Accept" => "application/json",
           "Authorization" => "Basic Yng6Yng=",
           "Content-Type" => "application/x-www-form-urlencoded",
-          "Host" => "iam.bluemix.net"
+          "Host" => "iam.cloud.ibm.com"
         }
       ).to_return(status: 401, body: response.to_json, headers: {})
     begin
@@ -91,7 +88,7 @@ class IAMTokenManagerTest < Minitest::Test
   end
 
   def test_refresh_token
-    iam_url = "https://iam.bluemix.net/identity/token"
+    iam_url = "https://iam.cloud.ibm.com/identity/token"
     response = {
       "access_token" => "oAeisG8yqPY7sFR_x66Z15",
       "token_type" => "Bearer",
@@ -104,14 +101,14 @@ class IAMTokenManagerTest < Minitest::Test
       iam_access_token: "iam_access_token",
       iam_url: iam_url
     )
-    stub_request(:post, "https://iam.bluemix.net/identity/token")
+    stub_request(:post, "https://iam.cloud.ibm.com/identity/token")
       .with(
         body: { "grant_type" => "refresh_token", "refresh_token" => "" },
         headers: {
           "Accept" => "application/json",
           "Authorization" => "Basic Yng6Yng=",
           "Content-Type" => "application/x-www-form-urlencoded",
-          "Host" => "iam.bluemix.net"
+          "Host" => "iam.cloud.ibm.com"
         }
       ).to_return(status: 200, body: response.to_json, headers: {})
     token_response = token_manager.send(:refresh_token)
@@ -157,7 +154,7 @@ class IAMTokenManagerTest < Minitest::Test
   end
 
   def test_get_token
-    iam_url = "https://iam.bluemix.net/identity/token"
+    iam_url = "https://iam.cloud.ibm.com/identity/token"
     token_manager = IBMCloudSdkCore::IAMTokenManager.new(
       iam_apikey: "iam_apikey",
       iam_url: iam_url
@@ -174,14 +171,14 @@ class IAMTokenManagerTest < Minitest::Test
       "expiration" => 1_524_167_011,
       "refresh_token" => "jy4gl91BQ"
     }
-    stub_request(:post, "https://iam.bluemix.net/identity/token")
+    stub_request(:post, "https://iam.cloud.ibm.com/identity/token")
       .with(
         body: { "apikey" => "iam_apikey", "grant_type" => "urn:ibm:params:oauth:grant-type:apikey", "response_type" => "cloud_iam" },
         headers: {
           "Accept" => "application/json",
           "Authorization" => "Basic Yng6Yng=",
           "Content-Type" => "application/x-www-form-urlencoded",
-          "Host" => "iam.bluemix.net"
+          "Host" => "iam.cloud.ibm.com"
         }
       ).to_return(status: 200, body: response.to_json, headers: {})
     token_manager.user_access_token = ""
@@ -192,13 +189,13 @@ class IAMTokenManagerTest < Minitest::Test
     token = token_manager.token
     assert_equal("hellohello", token)
 
-    stub_request(:post, "https://iam.bluemix.net/identity/token")
+    stub_request(:post, "https://iam.cloud.ibm.com/identity/token")
       .with(
         headers: {
           "Accept" => "application/json",
           "Authorization" => "Basic Yng6Yng=",
           "Content-Type" => "application/x-www-form-urlencoded",
-          "Host" => "iam.bluemix.net"
+          "Host" => "iam.cloud.ibm.com"
         }
       ).to_return(status: 200, body: response.to_json, headers: {})
     token_manager.token_info["expiration"] = Time.now.to_i - 4000
@@ -216,11 +213,68 @@ class IAMTokenManagerTest < Minitest::Test
     assert_equal("dummy", token)
   end
 
+  def test_client_id_only
+    assert_raises do
+      IBMCloudSdkCore::IAMTokenManager.new(
+        iam_apikey: "iam_apikey",
+        iam_access_token: "iam_access_token",
+        iam_client_id: "client_id"
+      )
+    end
+  end
+
+  def test_client_secret_only
+    assert_raises do
+      IBMCloudSdkCore::IAMTokenManager.new(
+        iam_apikey: "iam_apikey",
+        iam_access_token: "iam_access_token",
+        iam_client_secret: "client_secret"
+      )
+    end
+  end
+
+  def test_request_token_nondefault_client_id_secret
+    response = {
+      "access_token" => "oAeisG8yqPY7sFR_x66Z15",
+      "token_type" => "Bearer",
+      "expires_in" => 3600,
+      "expiration" => 1_524_167_011,
+      "refresh_token" => "jy4gl91BQ"
+    }
+
+    token_manager = IBMCloudSdkCore::IAMTokenManager.new(
+      iam_apikey: "iam_apikey",
+      iam_client_id: "foo",
+      iam_client_secret: "bar"
+    )
+    stub_request(:post, "https://iam.cloud.ibm.com/identity/token")
+      .with(basic_auth: %w[foo bar]).to_return(status: 200, body: response.to_json, headers: {})
+    token_response = token_manager.send(:request_token)
+    assert_equal(response, token_response)
+  end
+
+  def test_request_token_default_client_id_secret
+    response = {
+      "access_token" => "oAeisG8yqPY7sFR_x66Z15",
+      "token_type" => "Bearer",
+      "expires_in" => 3600,
+      "expiration" => 1_524_167_011,
+      "refresh_token" => "jy4gl91BQ"
+    }
+
+    token_manager = IBMCloudSdkCore::IAMTokenManager.new(
+      iam_apikey: "iam_apikey"
+    )
+    stub_request(:post, "https://iam.cloud.ibm.com/identity/token")
+      .with(basic_auth: %w[bx bx]).to_return(status: 200, body: response.to_json, headers: {})
+    token_response = token_manager.send(:request_token)
+    assert_equal(response, token_response)
+  end
+
   def test_dont_leak_constants
     assert_nil(defined? DEFAULT_IAM_URL)
     assert_nil(defined? CONTENT_TYPE)
     assert_nil(defined? ACCEPT)
-    assert_nil(defined? DEFAULT_AUTHORIZATION)
     assert_nil(defined? REQUEST_TOKEN_GRANT_TYPE)
     assert_nil(defined? REQUEST_TOKEN_RESPONSE_TYPE)
     assert_nil(defined? REFRESH_TOKEN_GRANT_TYPE)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ibm_cloud_sdk_core
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Mamoon Raja
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-05 00:00:00.000000000 Z
+date: 2019-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby