ibm_watson 0.5.1 → 0.6.0

data/lib/ibm_watson/watson_service.rb

@@ -39,6 +39,7 @@ class WatsonService
     @password = nil
     @token_manager = nil
     @temp_headers = nil
+    @icp_prefix = vars[:password]&.start_with?("icp-") ? true : false
 
     user_agent_string = "watson-apis-ruby-sdk-" + IBMWatson::VERSION
     user_agent_string += " #{RbConfig::CONFIG["host"]}"
@@ -60,10 +61,10 @@ class WatsonService
     end
 
     if !vars[:iam_access_token].nil? || !vars[:iam_apikey].nil?
-      _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])
     elsif !vars[:username].nil? && !vars[:password].nil?
-      if vars[:username] == "apikey"
-        _iam_apikey(iam_apikey: vars[:password])
+      if vars[:username] == "apikey" && !@icp_prefix
+        iam_apikey(iam_apikey: vars[:password])
       else
         @username = vars[:username]
         @password = vars[:password]
@@ -86,24 +87,16 @@ class WatsonService
 
   def add_default_headers(headers: {})
     raise TypeError unless headers.instance_of?(Hash)
-    headers.each_pair { |k, v| @conn.default_options.headers.add(k, v) }
-  end
 
-  def _token_manager(iam_apikey: nil, iam_access_token: nil, iam_url: 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)
+    headers.each_pair { |k, v| @conn.default_options.headers.add(k, v) }
   end
 
-  def _iam_access_token(iam_access_token:)
-    @token_manager&._access_token(iam_access_token: iam_access_token)
+  def iam_access_token(iam_access_token:)
     @token_manager = IAMTokenManager.new(iam_access_token: iam_access_token) if @token_manager.nil?
     @iam_access_token = iam_access_token
   end
 
-  def _iam_apikey(iam_apikey:)
-    @token_manager&._iam_apikey(iam_apikey: iam_apikey)
+  def iam_apikey(iam_apikey:)
     @token_manager = IAMTokenManager.new(iam_apikey: iam_apikey) if @token_manager.nil?
     @iam_apikey = iam_apikey
   end
@@ -125,14 +118,14 @@ class WatsonService
     args.delete_if { |_, v| v.nil? }
     args[:headers].delete("Content-Type") if args.key?(:form) || args[:json].nil?
 
-    if @username == "apikey"
-      _iam_apikey(iam_apikey: @password)
+    if @username == "apikey" && !@icp_prefix
+      iam_apikey(iam_apikey: @password)
       @username = nil
     end
 
     conn = @conn
     if !@token_manager.nil?
-      access_token = @token_manager._token
+      access_token = @token_manager.token
       args[:headers]["Authorization"] = "Bearer #{access_token}"
     elsif !@username.nil? && !@password.nil?
       conn = @conn.basic_auth(user: @username, pass: @password)
@@ -159,6 +152,7 @@ class WatsonService
       )
     end
     return DetailedResponse.new(response: response) if (200..299).cover?(response.code)
+
     raise WatsonApiException.new(response: response)
   end
 
@@ -167,6 +161,7 @@ class WatsonService
   # @return [self]
   def headers(headers)
     raise TypeError("Expected Hash type, received #{headers.class}") unless headers.instance_of?(Hash)
+
     @temp_headers = headers
     self
   end
@@ -184,16 +179,26 @@ class WatsonService
   # @option timeout global [Integer] Upper bound on total request time
   def configure_http_client(proxy: {}, timeout: {})
     raise TypeError("proxy parameter must be a Hash") unless proxy.empty? || proxy.instance_of?(Hash)
+
     raise TypeError("timeout parameter must be a Hash") unless timeout.empty? || timeout.instance_of?(Hash)
+
     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))
   end
 
   private
 
+  def set_token_manager(iam_apikey: nil, iam_access_token: nil, iam_url: 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)
+  end
+
   def add_timeout(timeout)
     if timeout.key?(:per_operation)
       raise TypeError("per_operation in timeout must be a Hash") unless timeout[:per_operation].instance_of?(Hash)
+
       defaults = {
         write: 0,
         connect: 0,
@@ -203,6 +208,7 @@ class WatsonService
       @conn = @conn.timeout(:per_operation, write: time[:write], connect: time[:connect], read: time[:read])
     else
       raise TypeError("global in timeout must be an Integer") unless timeout[:global].is_a?(Integer)
+
       @conn = @conn.timeout(:global, write: timeout[:global], connect: 0, read: 0)
     end
   end

data/lib/ibm_watson/websocket/speech_to_text_websocket_listener.rb

@@ -151,6 +151,7 @@ class WebSocketClient
 
   def send_chunk(chunk:, final: false)
     return if chunk.nil?
+
     @bytes_sent += chunk.size
     @client.send(chunk.bytes)
     @client.send({ "action" => "stop" }.to_json) if final

data/test/integration/test_iam_assistant_v1.rb

@@ -11,8 +11,7 @@ if !ENV["ASSISTANT_IAM_URL"].nil? && !ENV["ASSISTANT_IAM_APIKEY"].nil?
         url: ENV["ASSISTANT_IAM_URL"],
         version: "2018-02-16"
       )
-      service._iam_apikey(iam_apikey: ENV["ASSISTANT_IAM_APIKEY"])
-      service._iam_apikey(iam_apikey: ENV["ASSISTANT_IAM_APIKEY"])
+      service.iam_apikey(iam_apikey: ENV["ASSISTANT_IAM_APIKEY"])
       service.add_default_headers(
         headers: {
           "X-Watson-Learning-Opt-Out" => "1",
@@ -48,8 +47,7 @@ if !ENV["ASSISTANT_IAM_URL"].nil? && !ENV["ASSISTANT_IAM_APIKEY"].nil?
         url: ENV["ASSISTANT_IAM_URL"],
         version: "2018-02-16"
       )
-      service._iam_apikey(iam_apikey: ENV["ASSISTANT_IAM_APIKEY"])
-      service._iam_apikey(iam_apikey: ENV["ASSISTANT_IAM_APIKEY"])
+      service.iam_apikey(iam_apikey: ENV["ASSISTANT_IAM_APIKEY"])
       service.add_default_headers(
         headers: {
           "X-Watson-Learning-Opt-Out" => "1",
@@ -706,7 +704,7 @@ if !ENV["ASSISTANT_IAM_URL"].nil? && !ENV["ASSISTANT_IAM_APIKEY"].nil?
       )
       error_received = false
       begin
-        service._iam_apikey(iam_apikey: "bogus_api_key")
+        service.iam_apikey(iam_apikey: "bogus_api_key")
         service.list_workspaces
       rescue WatsonApiException => e
         assert_equal("Provided API key could not be found", e.info["errorMessage"])

data/test/unit/test_assistant_v1.rb

@@ -40,6 +40,37 @@ class AssistantV1Test < Minitest::Test
     assert_equal(response, service_response.result)
   end
 
+  def test_plain_to_json_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(:post, "https://gateway.watsonplatform.net/assistant/api/v1/workspaces/boguswid/counterexamples?version=2018-02-16")
+      .with(
+        body: "{\"text\":\"I want financial advice today.\"}",
+        headers: {
+          "Accept" => "application/json",
+          "Authorization" => "Basic YXBpa2V5OmljcC14eXo=",
+          "Content-Type" => "application/json",
+          "Host" => "gateway.watsonplatform.net"
+        }
+      ).to_return(status: 201, body: response.to_json, headers: headers)
+    service = IBMWatson::AssistantV1.new(
+      version: "2018-02-16",
+      username: "apikey",
+      password: "icp-xyz"
+    )
+    service_response = service.create_counterexample(
+      workspace_id: "boguswid",
+      text: "I want financial advice today."
+    )
+    assert_equal(response, service_response.result)
+  end
+
   def test_rate_limit_exceeded
     error_code = 429
     error_msg = "Rate limit exceeded"

data/test/unit/test_configure_http_client.rb

@@ -14,9 +14,6 @@ class HTTPConfigTest < Minitest::Test
       username: "username",
       password: "password"
     )
-    def service.conn
-      @watson_service.conn
-    end
     service.configure_http_client(
       proxy: {
         address: "bogus_address.com",
@@ -34,9 +31,6 @@ class HTTPConfigTest < Minitest::Test
       username: "username",
       password: "password"
     )
-    def service.conn
-      @watson_service.conn
-    end
     service.configure_http_client(
       proxy: {
         address: "bogus_address.com",
@@ -58,9 +52,6 @@ class HTTPConfigTest < Minitest::Test
       username: "username",
       password: "password"
     )
-    def service.conn
-      @watson_service.conn
-    end
     service.configure_http_client(
       proxy: {
         address: "bogus_address.com",
@@ -82,9 +73,6 @@ class HTTPConfigTest < Minitest::Test
       username: "username",
       password: "password"
     )
-    def service.conn
-      @watson_service.conn
-    end
     service.configure_http_client(
       proxy: {
         address: "bogus_address.com",
@@ -110,9 +98,6 @@ class HTTPConfigTest < Minitest::Test
       username: "username",
       password: "password"
     )
-    def service.conn
-      @watson_service.conn
-    end
     service.configure_http_client(
       timeout: {
         per_operation: {
@@ -140,9 +125,6 @@ class HTTPConfigTest < Minitest::Test
       username: "username",
       password: "password"
     )
-    def service.conn
-      @watson_service.conn
-    end
     service.configure_http_client(
       timeout: {
         global: 20

data/test/unit/test_iam_token_manager.rb

@@ -33,7 +33,7 @@ class IAMTokenManagerTest < Minitest::Test
           "Host" => "iam.bluemix.net"
         }
       ).to_return(status: 200, body: response.to_json, headers: {})
-    token_response = token_manager._request_token
+    token_response = token_manager.send(:request_token)
     assert_equal(response, token_response)
   end
 
@@ -61,7 +61,7 @@ class IAMTokenManagerTest < Minitest::Test
           "Host" => "iam.bluemix.net"
         }
       ).to_return(status: 200, body: response.to_json, headers: {})
-    token_response = token_manager._refresh_token
+    token_response = token_manager.send(:refresh_token)
     assert_equal(response, token_response)
   end
 
@@ -79,9 +79,9 @@ class IAMTokenManagerTest < Minitest::Test
       "refresh_token" => "jy4gl91BQ"
     }
 
-    refute(token_manager._is_token_expired?)
+    refute(token_manager.send(:token_expired?))
     token_manager.token_info["expiration"] = Time.now.to_i - 3600
-    assert(token_manager._is_token_expired?)
+    assert(token_manager.send(:token_expired?))
   end
 
   def test_is_refresh_token_expired
@@ -98,9 +98,9 @@ class IAMTokenManagerTest < Minitest::Test
       "refresh_token" => "jy4gl91BQ"
     }
 
-    refute(token_manager._is_refresh_token_expired?)
+    refute(token_manager.send(:refresh_token_expired?))
     token_manager.token_info["expiration"] = Time.now.to_i - (8 * 24 * 3600)
-    assert(token_manager._is_token_expired?)
+    assert(token_manager.send(:token_expired?))
   end
 
   def test_get_token
@@ -111,7 +111,7 @@ class IAMTokenManagerTest < Minitest::Test
     )
     token_manager.user_access_token = "user_access_token"
 
-    token = token_manager._token
+    token = token_manager.token
     assert_equal(token_manager.user_access_token, token)
 
     response = {
@@ -132,11 +132,11 @@ class IAMTokenManagerTest < Minitest::Test
         }
       ).to_return(status: 200, body: response.to_json, headers: {})
     token_manager.user_access_token = ""
-    token = token_manager._token
+    token = token_manager.token
     assert_equal("hellohello", token)
 
     token_manager.token_info["expiration"] = Time.now.to_i - (20 * 24 * 3600)
-    token = token_manager._token
+    token = token_manager.token
     assert_equal("hellohello", token)
 
     stub_request(:post, "https://iam.bluemix.net/identity/token")
@@ -149,7 +149,7 @@ class IAMTokenManagerTest < Minitest::Test
         }
       ).to_return(status: 200, body: response.to_json, headers: {})
     token_manager.token_info["expiration"] = Time.now.to_i - 4000
-    token = token_manager._token
+    token = token_manager.token
     assert_equal("hellohello", token)
 
     token_manager.token_info = {
@@ -159,7 +159,17 @@ class IAMTokenManagerTest < Minitest::Test
       "expiration" => Time.now.to_i + 3600,
       "refresh_token" => "jy4gl91BQ"
     }
-    token = token_manager._token
+    token = token_manager.token
     assert_equal("dummy", token)
   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)
+  end
 end

data/test/unit/test_visual_recognition_v3.rb

@@ -12,8 +12,7 @@ class VisualRecognitionV3Test < Minitest::Test
     service = IBMWatson::VisualRecognitionV3.new(
       version: "2018-03-19"
     )
-    service._iam_access_token(iam_access_token: "bogus_access_token")
-    service._iam_access_token(iam_access_token: "bogus_access_token")
+    service.iam_access_token(iam_access_token: "bogus_access_token")
     response = {
       "classifier_id" => "bogusnumber",
       "name" => "Dog Breeds",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ibm_watson
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Max Nussbaum
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-05 00:00:00.000000000 Z
+date: 2018-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby