ibm_watson 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25afe3adf84e90212b0b4f7e9a98651e25b3a5165f94a814e3ff899db82ee6f4
-  data.tar.gz: 4c1bcb3d15a29138cf78e9447245d3f740ecbc80a0ef8260498e4f0787e965d3
+  metadata.gz: 0e5497c0b4d5432eeebd77445b2563795c103cd37eb7110d6405c28658d10ffa
+  data.tar.gz: 0ff12a91d90c19d074672665a2539ed5a9a4b2bafd0922e613d0e4121441be67
 SHA512:
-  metadata.gz: 0a1e2d370f74a61eb68c658bcf07aed4e998db2989fafc397b9710b7aa9ae6c2697cd01747d3b53d28e2a4c6a36be731c6557b2b283f826c8153bbe159e42bf4
-  data.tar.gz: 3a7bad0a95abda16db5b9b85ac953473e6caf55f7b3d86d7302e72a1ecdb65e6e016f45189c79ab6ff2eb379556ddb5e3f2c7b915494ae9973e6d6e982d915b9
+  metadata.gz: 734634cbd63a3a5b3dda1e4fa6b77ba8285f7c493d4b8c107abd2119e4564b42e96eff6af4387da504c83ae2697a8a13fef8ade200e80d6b7d6142ce2fd334ef
+  data.tar.gz: 42d4aca1005a5a614411d10d0c8ca50d3227558f3cb9d9490fdb8386737850c0e490dbab6b8bf02a3581f4c927f657dba08575bfb99fdd6fdf91ff3c2a431a19

data/README.md

@@ -22,6 +22,7 @@ Ruby gem to quickly get started with the various [IBM Watson][wdc] services.
   * [Sending requests asynchronously](#sending-requests-asynchronously)
   * [Sending request headers](#sending-request-headers)
   * [Parsing HTTP response info](#parsing-http-response-info)
+  * [Configuring the HTTP client](#configuring-the-http-client)
   * [Using Websockets](#using-websockets)
   * [Ruby version](#ruby-version)
   * [Contributing](#contributing)
@@ -71,9 +72,9 @@ Watson services are migrating to token-based Identity and Access Management (IAM
 To find out which authentication to use, view the service credentials. You find the service credentials for authentication the same way for all Watson services:
 
 1.  Go to the IBM Cloud **[Dashboard][watson-dashboard]** page.
-1.  Either click an existing Watson service instance or click **Create**.
-1.  Click **Show** to view your service credentials.
-1.  Copy the `url` and either `apikey` or `username` and `password`.
+2.  Either click an existing Watson service instance or click **Create**.
+3.  Click **Show** to view your service credentials.
+4.  Copy the `url` and either `apikey` or `username` and `password`.
 
 ### IAM
 
@@ -211,6 +212,41 @@ Headers: "<http response headers>"
 Result: "<response returned by service>"
 ```
 
+## Configuring the HTTP client
+To set client configs like timeout or proxy use the `configure_http_client` function and pass in the configurations.
+
+```ruby
+require "ibm_watson/assistant_v1"
+include IBMWatson
+
+assistant = AssistantV1.new(
+  username: "{username}",
+  password: "{password}",
+  version: "2018-07-10"
+)
+
+assistant.configure_http_client(
+  timeout: {
+    # Accepts either :per_operation or :global
+    per_operation: { # The individual timeouts for each operation
+      read: 5,
+      write: 7,
+      connect: 10
+    }
+    # global: 30 # The total timeout time
+  },
+  proxy: {
+    address: "bogus_address.com",
+    port: 9999,
+    username: "username",
+    password: "password",
+    headers: {
+      bogus_header: true
+    }
+  }
+)
+```
+
 ## Using Websockets
 
 The Speech-to-Text service supports websockets with the `recognize-with-websockets` method. The method accepts a custom callback class. The `eventmachine` loop that the websocket uses blocks the main thread by default. Here is an example of using the websockets method:

data/lib/ibm_watson/assistant_v1.rb

@@ -142,6 +142,21 @@ module IBMWatson
     def url
       @watson_service.url
     end
+
+    # @!method configure_http_client(proxy: {}, timeout: {})
+    # Sets the http client config, currently works with timeout and proxies
+    # @param proxy [Hash] The hash of proxy configurations
+    # @option proxy address [String] The address of the proxy
+    # @option proxy port [Integer] The port of the proxy
+    # @option proxy username [String] The username of the proxy, if authentication is needed
+    # @option proxy password [String] The password of the proxy, if authentication is needed
+    # @option proxy headers [Hash] The headers to be used with the proxy
+    # @param timeout [Hash] The hash for configuring timeouts. `per_operation` has priority over `global`
+    # @option timeout per_operation [Hash] Timeouts per operation. Requires `read`, `write`, `connect`
+    # @option timeout global [Integer] Upper bound on total request time
+    def configure_http_client(proxy: {}, timeout: {})
+      @watson_service.configure_http_client(proxy: proxy, timeout: timeout)
+    end
     # :nocov:
     #########################
     # Message

data/lib/ibm_watson/discovery_v1.rb

@@ -144,6 +144,21 @@ module IBMWatson
     def url
       @watson_service.url
     end
+
+    # @!method configure_http_client(proxy: {}, timeout: {})
+    # Sets the http client config, currently works with timeout and proxies
+    # @param proxy [Hash] The hash of proxy configurations
+    # @option proxy address [String] The address of the proxy
+    # @option proxy port [Integer] The port of the proxy
+    # @option proxy username [String] The username of the proxy, if authentication is needed
+    # @option proxy password [String] The password of the proxy, if authentication is needed
+    # @option proxy headers [Hash] The headers to be used with the proxy
+    # @param timeout [Hash] The hash for configuring timeouts. `per_operation` has priority over `global`
+    # @option timeout per_operation [Hash] Timeouts per operation. Requires `read`, `write`, `connect`
+    # @option timeout global [Integer] Upper bound on total request time
+    def configure_http_client(proxy: {}, timeout: {})
+      @watson_service.configure_http_client(proxy: proxy, timeout: timeout)
+    end
     # :nocov:
     #########################
     # Environments

data/lib/ibm_watson/language_translator_v3.rb

@@ -144,6 +144,21 @@ module IBMWatson
     def url
       @watson_service.url
     end
+
+    # @!method configure_http_client(proxy: {}, timeout: {})
+    # Sets the http client config, currently works with timeout and proxies
+    # @param proxy [Hash] The hash of proxy configurations
+    # @option proxy address [String] The address of the proxy
+    # @option proxy port [Integer] The port of the proxy
+    # @option proxy username [String] The username of the proxy, if authentication is needed
+    # @option proxy password [String] The password of the proxy, if authentication is needed
+    # @option proxy headers [Hash] The headers to be used with the proxy
+    # @param timeout [Hash] The hash for configuring timeouts. `per_operation` has priority over `global`
+    # @option timeout per_operation [Hash] Timeouts per operation. Requires `read`, `write`, `connect`
+    # @option timeout global [Integer] Upper bound on total request time
+    def configure_http_client(proxy: {}, timeout: {})
+      @watson_service.configure_http_client(proxy: proxy, timeout: timeout)
+    end
     # :nocov:
     #########################
     # Translation

data/lib/ibm_watson/natural_language_classifier_v1.rb

@@ -131,6 +131,21 @@ module IBMWatson
     def url
       @watson_service.url
     end
+
+    # @!method configure_http_client(proxy: {}, timeout: {})
+    # Sets the http client config, currently works with timeout and proxies
+    # @param proxy [Hash] The hash of proxy configurations
+    # @option proxy address [String] The address of the proxy
+    # @option proxy port [Integer] The port of the proxy
+    # @option proxy username [String] The username of the proxy, if authentication is needed
+    # @option proxy password [String] The password of the proxy, if authentication is needed
+    # @option proxy headers [Hash] The headers to be used with the proxy
+    # @param timeout [Hash] The hash for configuring timeouts. `per_operation` has priority over `global`
+    # @option timeout per_operation [Hash] Timeouts per operation. Requires `read`, `write`, `connect`
+    # @option timeout global [Integer] Upper bound on total request time
+    def configure_http_client(proxy: {}, timeout: {})
+      @watson_service.configure_http_client(proxy: proxy, timeout: timeout)
+    end
     # :nocov:
     #########################
     # Classify text

data/lib/ibm_watson/natural_language_understanding_v1.rb

@@ -148,6 +148,21 @@ module IBMWatson
     def url
       @watson_service.url
     end
+
+    # @!method configure_http_client(proxy: {}, timeout: {})
+    # Sets the http client config, currently works with timeout and proxies
+    # @param proxy [Hash] The hash of proxy configurations
+    # @option proxy address [String] The address of the proxy
+    # @option proxy port [Integer] The port of the proxy
+    # @option proxy username [String] The username of the proxy, if authentication is needed
+    # @option proxy password [String] The password of the proxy, if authentication is needed
+    # @option proxy headers [Hash] The headers to be used with the proxy
+    # @param timeout [Hash] The hash for configuring timeouts. `per_operation` has priority over `global`
+    # @option timeout per_operation [Hash] Timeouts per operation. Requires `read`, `write`, `connect`
+    # @option timeout global [Integer] Upper bound on total request time
+    def configure_http_client(proxy: {}, timeout: {})
+      @watson_service.configure_http_client(proxy: proxy, timeout: timeout)
+    end
     # :nocov:
     #########################
     # Analyze

data/lib/ibm_watson/personality_insights_v3.rb

@@ -159,6 +159,21 @@ module IBMWatson
     def url
       @watson_service.url
     end
+
+    # @!method configure_http_client(proxy: {}, timeout: {})
+    # Sets the http client config, currently works with timeout and proxies
+    # @param proxy [Hash] The hash of proxy configurations
+    # @option proxy address [String] The address of the proxy
+    # @option proxy port [Integer] The port of the proxy
+    # @option proxy username [String] The username of the proxy, if authentication is needed
+    # @option proxy password [String] The password of the proxy, if authentication is needed
+    # @option proxy headers [Hash] The headers to be used with the proxy
+    # @param timeout [Hash] The hash for configuring timeouts. `per_operation` has priority over `global`
+    # @option timeout per_operation [Hash] Timeouts per operation. Requires `read`, `write`, `connect`
+    # @option timeout global [Integer] Upper bound on total request time
+    def configure_http_client(proxy: {}, timeout: {})
+      @watson_service.configure_http_client(proxy: proxy, timeout: timeout)
+    end
     # :nocov:
     #########################
     # Methods

data/lib/ibm_watson/speech_to_text_v1.rb

@@ -179,6 +179,21 @@ module IBMWatson
     def url
       @watson_service.url
     end
+
+    # @!method configure_http_client(proxy: {}, timeout: {})
+    # Sets the http client config, currently works with timeout and proxies
+    # @param proxy [Hash] The hash of proxy configurations
+    # @option proxy address [String] The address of the proxy
+    # @option proxy port [Integer] The port of the proxy
+    # @option proxy username [String] The username of the proxy, if authentication is needed
+    # @option proxy password [String] The password of the proxy, if authentication is needed
+    # @option proxy headers [Hash] The headers to be used with the proxy
+    # @param timeout [Hash] The hash for configuring timeouts. `per_operation` has priority over `global`
+    # @option timeout per_operation [Hash] Timeouts per operation. Requires `read`, `write`, `connect`
+    # @option timeout global [Integer] Upper bound on total request time
+    def configure_http_client(proxy: {}, timeout: {})
+      @watson_service.configure_http_client(proxy: proxy, timeout: timeout)
+    end
     # :nocov:
     #########################
     # Models

data/lib/ibm_watson/text_to_speech_v1.rb

@@ -180,6 +180,21 @@ module IBMWatson
     def url
       @watson_service.url
     end
+
+    # @!method configure_http_client(proxy: {}, timeout: {})
+    # Sets the http client config, currently works with timeout and proxies
+    # @param proxy [Hash] The hash of proxy configurations
+    # @option proxy address [String] The address of the proxy
+    # @option proxy port [Integer] The port of the proxy
+    # @option proxy username [String] The username of the proxy, if authentication is needed
+    # @option proxy password [String] The password of the proxy, if authentication is needed
+    # @option proxy headers [Hash] The headers to be used with the proxy
+    # @param timeout [Hash] The hash for configuring timeouts. `per_operation` has priority over `global`
+    # @option timeout per_operation [Hash] Timeouts per operation. Requires `read`, `write`, `connect`
+    # @option timeout global [Integer] Upper bound on total request time
+    def configure_http_client(proxy: {}, timeout: {})
+      @watson_service.configure_http_client(proxy: proxy, timeout: timeout)
+    end
     # :nocov:
     #########################
     # Voices

data/lib/ibm_watson/tone_analyzer_v3.rb

@@ -150,6 +150,21 @@ module IBMWatson
     def url
       @watson_service.url
     end
+
+    # @!method configure_http_client(proxy: {}, timeout: {})
+    # Sets the http client config, currently works with timeout and proxies
+    # @param proxy [Hash] The hash of proxy configurations
+    # @option proxy address [String] The address of the proxy
+    # @option proxy port [Integer] The port of the proxy
+    # @option proxy username [String] The username of the proxy, if authentication is needed
+    # @option proxy password [String] The password of the proxy, if authentication is needed
+    # @option proxy headers [Hash] The headers to be used with the proxy
+    # @param timeout [Hash] The hash for configuring timeouts. `per_operation` has priority over `global`
+    # @option timeout per_operation [Hash] Timeouts per operation. Requires `read`, `write`, `connect`
+    # @option timeout global [Integer] Upper bound on total request time
+    def configure_http_client(proxy: {}, timeout: {})
+      @watson_service.configure_http_client(proxy: proxy, timeout: timeout)
+    end
     # :nocov:
     #########################
     # Methods

data/lib/ibm_watson/version.rb

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

data/lib/ibm_watson/visual_recognition_v3.rb

@@ -131,6 +131,21 @@ module IBMWatson
     def url
       @watson_service.url
     end
+
+    # @!method configure_http_client(proxy: {}, timeout: {})
+    # Sets the http client config, currently works with timeout and proxies
+    # @param proxy [Hash] The hash of proxy configurations
+    # @option proxy address [String] The address of the proxy
+    # @option proxy port [Integer] The port of the proxy
+    # @option proxy username [String] The username of the proxy, if authentication is needed
+    # @option proxy password [String] The password of the proxy, if authentication is needed
+    # @option proxy headers [Hash] The headers to be used with the proxy
+    # @param timeout [Hash] The hash for configuring timeouts. `per_operation` has priority over `global`
+    # @option timeout per_operation [Hash] Timeouts per operation. Requires `read`, `write`, `connect`
+    # @option timeout global [Integer] Upper bound on total request time
+    def configure_http_client(proxy: {}, timeout: {})
+      @watson_service.configure_http_client(proxy: proxy, timeout: timeout)
+    end
     # :nocov:
     #########################
     # General

data/lib/ibm_watson/watson_service.rb

@@ -29,7 +29,6 @@ class WatsonService
       password: nil,
       use_vcap_services: true,
       api_key: nil,
-      x_watson_learning_opt_out: false,
       iam_apikey: nil,
       iam_access_token: nil,
       iam_url: nil
@@ -48,7 +47,6 @@ class WatsonService
     headers = {
       "User-Agent" => user_agent_string
     }
-    headers["x-watson-learning-opt-out"] = true if vars[:x_watson_learning_opt_out]
     if vars[:use_vcap_services]
       @vcap_service_credentials = load_from_vcap_services(service_name: vars[:vcap_services_name])
       if !@vcap_service_credentials.nil? && @vcap_service_credentials.instance_of?(Hash)
@@ -74,11 +72,6 @@ class WatsonService
 
     @conn = HTTP::Client.new(
       headers: headers
-    ).timeout(
-      :per_operation,
-      read: 60,
-      write: 60,
-      connect: 60
     )
   end
 
@@ -177,4 +170,52 @@ class WatsonService
     @temp_headers = headers
     self
   end
+
+  # @!method configure_http_client(proxy: {}, timeout: {})
+  # Sets the http client config, currently works with timeout and proxies
+  # @param proxy [Hash] The hash of proxy configurations
+  # @option proxy address [String] The address of the proxy
+  # @option proxy port [Integer] The port of the proxy
+  # @option proxy username [String] The username of the proxy, if authentication is needed
+  # @option proxy password [String] The password of the proxy, if authentication is needed
+  # @option proxy headers [Hash] The headers to be used with the proxy
+  # @param timeout [Hash] The hash for configuring timeouts. `per_operation` has priority over `global`
+  # @option timeout per_operation [Hash] Timeouts per operation. Requires `read`, `write`, `connect`
+  # @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 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,
+        read: 0
+      }
+      time = defaults.merge(timeout[:per_operation])
+      @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
+
+  def add_proxy(proxy)
+    if (proxy[:username].nil? || proxy[:password].nil?) && proxy[:headers].nil?
+      @conn = @conn.via(proxy[:address], proxy[:port])
+    elsif !proxy[:username].nil? && !proxy[:password].nil? && proxy[:headers].nil?
+      @conn = @conn.via(proxy[:address], proxy[:port], proxy[:username], proxy[:password])
+    elsif !proxy[:headers].nil? && (proxy[:username].nil? || proxy[:password].nil?)
+      @conn = @conn.via(proxy[:address], proxy[:port], proxy[:headers])
+    else
+      @conn = @conn.via(proxy[:address], proxy[:port], proxy[:username], proxy[:password], proxy[:headers])
+    end
+  end
 end

data/test/unit/test_configure_http_client.rb

@@ -0,0 +1,162 @@
+# 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 = IBMWatson::NaturalLanguageUnderstandingV1.new(
+      version: "2018-03-16",
+      username: "username",
+      password: "password"
+    )
+    def service.conn
+      @watson_service.conn
+    end
+    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 = IBMWatson::NaturalLanguageUnderstandingV1.new(
+      version: "2018-03-16",
+      username: "username",
+      password: "password"
+    )
+    def service.conn
+      @watson_service.conn
+    end
+    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 = IBMWatson::NaturalLanguageUnderstandingV1.new(
+      version: "2018-03-16",
+      username: "username",
+      password: "password"
+    )
+    def service.conn
+      @watson_service.conn
+    end
+    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 = IBMWatson::NaturalLanguageUnderstandingV1.new(
+      version: "2018-03-16",
+      username: "username",
+      password: "password"
+    )
+    def service.conn
+      @watson_service.conn
+    end
+    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 = IBMWatson::NaturalLanguageUnderstandingV1.new(
+      version: "2018-03-16",
+      username: "username",
+      password: "password"
+    )
+    def service.conn
+      @watson_service.conn
+    end
+    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 = IBMWatson::NaturalLanguageUnderstandingV1.new(
+      version: "2018-03-16",
+      username: "username",
+      password: "password"
+    )
+    def service.conn
+      @watson_service.conn
+    end
+    service.configure_http_client(
+      timeout: {
+        global: 20
+      }
+    )
+    timeout_class = service.conn.default_options.timeout_class
+    assert_equal(HTTP::Timeout::Global, timeout_class)
+
+    expected_timeouts = {
+      read_timeout: 0,
+      write_timeout: 20,
+      connect_timeout: 0
+    }
+    timeout = service.conn.default_options.timeout_options
+    assert_equal(expected_timeouts, timeout)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ibm_watson
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Max Nussbaum
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-20 00:00:00.000000000 Z
+date: 2018-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -247,6 +247,7 @@ files:
 - test/integration/test_visual_recognition_v3.rb
 - test/test_helper.rb
 - test/unit/test_assistant_v1.rb
+- test/unit/test_configure_http_client.rb
 - test/unit/test_discovery_v1.rb
 - test/unit/test_iam_token_manager.rb
 - test/unit/test_language_translator_v3.rb