ibm_watson 0.10.0 → 0.11.0

data/lib/ibm_watson/version.rb

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

data/lib/ibm_watson/visual_recognition_v3.rb

@@ -86,12 +86,7 @@ module IBMWatson
     #   assumes UTF-8 encoding if it encounters non-ASCII characters.
     #
     #   You can also include an image with the **url** parameter.
-    # @param accept_language [String] The language of the output class names. The full set of languages is supported for
-    #   the built-in classifier IDs: `default`, `food`, and `explicit`. The class names of
-    #   custom classifiers are not translated.
-    #
-    #   The response might not be in the specified language when the requested language is
-    #   not supported or when there is no translation for the class name.
+    # @param accept_language [String] The desired language of parts of the response. See the response for details.
     # @param url [String] The URL of an image to analyze. Must be in .jpg, or .png format. The minimum
     #   recommended pixel density is 32X32 pixels per inch, and the maximum image size is
     #   10 MB.
@@ -167,13 +162,13 @@ module IBMWatson
     #########################
 
     ##
-    # @!method detect_faces(images_file: nil, url: nil, images_file_content_type: nil, images_filename: nil)
+    # @!method detect_faces(images_file: nil, url: nil, images_file_content_type: nil, images_filename: nil, accept_language: nil)
     # Detect faces in images.
     # **Important:** On April 2, 2018, the identity information in the response to calls
     #   to the Face model was removed. The identity information refers to the `name` of
     #   the person, `score`, and `type_hierarchy` knowledge graph. For details about the
     #   enhanced Face model, see the [Release
-    #   notes](https://console.bluemix.net/docs/services/visual-recognition/release-notes.html#2april2018).
+    #   notes](https://cloud.ibm.com/docs/services/visual-recognition/release-notes.html#2april2018).
     #
     #   Analyze and get data about faces in images. Responses can include estimated age
     #   and gender. This feature uses a built-in model, so no training is necessary. The
@@ -196,9 +191,11 @@ module IBMWatson
     #   You can also include images with the **images_file** parameter.
     # @param images_file_content_type [String] The content type of images_file.
     # @param images_filename [String] The filename for images_file.
+    # @param accept_language [String] The desired language of parts of the response. See the response for details.
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
-    def detect_faces(images_file: nil, url: nil, images_file_content_type: nil, images_filename: nil)
+    def detect_faces(images_file: nil, url: nil, images_file_content_type: nil, images_filename: nil, accept_language: nil)
       headers = {
+        "Accept-Language" => accept_language
       }
 
       params = {
@@ -375,7 +372,7 @@ module IBMWatson
     # Update a custom classifier by adding new positive or negative classes (examples)
     #   or by adding new images to existing classes. You must supply at least one set of
     #   positive or negative examples. For details, see [Updating custom
-    #   classifiers](https://console.bluemix.net/docs/services/visual-recognition/customizing.html#updating-custom-classifiers).
+    #   classifiers](https://cloud.ibm.com/docs/services/visual-recognition/customizing.html#updating-custom-classifiers).
     #
     #   Encode all names in UTF-8 if they contain non-ASCII characters (.zip and image
     #   file names, and classifier and class names). The service assumes UTF-8 encoding if
@@ -524,7 +521,7 @@ module IBMWatson
     #   You associate a customer ID with data by passing the `X-Watson-Metadata` header
     #   with a request that passes data. For more information about personal data and
     #   customer IDs, see [Information
-    #   security](https://console.bluemix.net/docs/services/visual-recognition/information-security.html).
+    #   security](https://cloud.ibm.com/docs/services/visual-recognition/information-security.html).
     # @param customer_id [String] The customer ID for which all data is to be deleted.
     # @return [nil]
     def delete_user_data(customer_id:)

data/lib/ibm_watson/watson_service.rb

@@ -36,9 +36,11 @@ class WatsonService
     @url = vars[:url]
     @username = nil
     @password = nil
+    @iam_apikey = nil
     @token_manager = nil
     @temp_headers = nil
     @icp_prefix = vars[:password]&.start_with?("icp-") ? true : false
+    @disable_ssl = false
 
     user_agent_string = "watson-apis-ruby-sdk-" + IBMWatson::VERSION
     user_agent_string += " #{RbConfig::CONFIG["host"]}"
@@ -69,6 +71,10 @@ class WatsonService
         @password = vars[:password]
       end
     end
+    raise ArgumentError.new('The username shouldn\'t start or end with curly brackets or quotes. Be sure to remove any {} and \" characters surrounding your username') if check_bad_first_or_last_char(@username)
+    raise ArgumentError.new('The password shouldn\'t start or end with curly brackets or quotes. Be sure to remove any {} and \" characters surrounding your password') if check_bad_first_or_last_char(@password)
+    raise ArgumentError.new('The url shouldn\'t start or end with curly brackets or quotes. Be sure to remove any {} and \" characters surrounding your url') if check_bad_first_or_last_char(@url)
+    raise ArgumentError.new('The apikey shouldn\'t start or end with curly brackets or quotes. Be sure to remove any {} and \" characters surrounding your apikey') if check_bad_first_or_last_char(@iam_apikey)
 
     @conn = HTTP::Client.new(
       headers: headers
@@ -165,7 +171,7 @@ class WatsonService
     self
   end
 
-  # @!method configure_http_client(proxy: {}, timeout: {})
+  # @!method configure_http_client(proxy: {}, timeout: {}, disable_ssl: false)
   # 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
@@ -176,17 +182,28 @@ class WatsonService
   # @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: {})
+  # @param disable_ssl [Boolean] Disable the SSL verification (Note that this has serious security implications - only do this if you really mean to!)
+  def configure_http_client(proxy: {}, timeout: {}, disable_ssl: false)
     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)
 
+    @disable_ssl = disable_ssl
+    if disable_ssl
+      ssl_context = OpenSSL::SSL::SSLContext.new
+      ssl_context.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      @conn.default_options = { ssl_context: ssl_context }
+    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))
   end
 
   private
 
+  def check_bad_first_or_last_char(str)
+    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)
     @iam_apikey = iam_apikey
     @iam_access_token = iam_access_token

data/test/integration/test_discovery_v1.rb

@@ -198,7 +198,6 @@ if !ENV["DISCOVERY_USERNAME"].nil? && !ENV["DISCOVERY_PASSWORD"].nil?
         filter: "extracted_metadata.sha1::9181d244*",
         return_fields: "extracted_metadata.sha1"
       ).result
-      puts query_results
       refute(query_results.nil?)
     end
 
@@ -208,6 +207,33 @@ if !ENV["DISCOVERY_USERNAME"].nil? && !ENV["DISCOVERY_PASSWORD"].nil?
       ).result
       refute(credentials.nil?)
     end
+
+    def test_list_gateways
+      response = @service.list_gateways(
+        environment_id: @environment_id
+      ).result
+      refute(response.nil?)
+    end
+
+    def test_create_get_delete_gateways
+      gateway = @service.create_gateway(
+        environment_id: @environment_id,
+        name: "test"
+      ).result
+      refute(gateway.nil?)
+
+      response = @service.get_gateway(
+        environment_id: @environment_id,
+        gateway_id: gateway["gateway_id"]
+      ).result
+      refute(response.nil?)
+
+      response = @service.delete_gateway(
+        environment_id: @environment_id,
+        gateway_id: gateway["gateway_id"]
+      ).result
+      refute(response.nil?)
+    end
   end
 else
   class DiscoveryV1Test < Minitest::Test

data/test/integration/test_speech_to_text_v1.rb

@@ -112,6 +112,7 @@ if !ENV["SPEECH_TO_TEXT_USERNAME"].nil? && !ENV["SPEECH_TO_TEXT_PASSWORD"].nil?
     end
 
     def test_recognitions
+      skip "Skip because of timeouts"
       output = @service.check_jobs.result
       refute_nil(output)
     end

data/test/unit/test_configure_http_client.rb

@@ -141,4 +141,14 @@ class HTTPConfigTest < Minitest::Test
     timeout = service.conn.default_options.timeout_options
     assert_equal(expected_timeouts, timeout)
   end
+
+  def test_disable_ssl
+    service = IBMWatson::NaturalLanguageUnderstandingV1.new(
+      version: "2018-03-16",
+      username: "username",
+      password: "password"
+    )
+    service.configure_http_client(disable_ssl: true)
+    refute_nil(service.conn.default_options.ssl_context)
+  end
 end

data/test/unit/test_discovery_v1.rb

@@ -1368,4 +1368,128 @@ class DiscoveryV1Test < Minitest::Test
     )
     assert_equal({ "updated" => "true" }, service_response.result)
   end
+
+  def test_create_stopword_list
+    service = IBMWatson::DiscoveryV1.new(
+      username: "username",
+      password: "password",
+      version: "2018-03-05"
+    )
+    stub_request(:post, "https://gateway.watsonplatform.net/compare-comply/api/v1/element_classification").with do |req|
+    end
+
+    stub_request(:post, "https://gateway.watsonplatform.net/discovery/api/v1/environments/envid/collections/colid/word_lists/stopwords?version=2018-03-05").with do |req|
+      assert_equal(req.headers["Accept"], "application/json")
+      assert_match(%r{\Amultipart/form-data}, req.headers["Content-Type"])
+      assert_match(/Content-Disposition: form-data/, req.body)
+    end
+    service.create_stopword_list(
+      environment_id: "envid",
+      collection_id: "colid",
+      stopword_file: "file"
+    )
+  end
+
+  def test_delete_stopword_list
+    service = IBMWatson::DiscoveryV1.new(
+      username: "username",
+      password: "password",
+      version: "2018-03-05"
+    )
+    stub_request(:delete, "https://gateway.watsonplatform.net/discovery/api/v1/environments/envid/collections/colid/word_lists/stopwords?version=2018-03-05")
+      .with(
+        headers: {
+          "Accept" => "application/json",
+          "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
+          "Host" => "gateway.watsonplatform.net"
+        }
+      ).to_return(status: 200, body: { "deleted" => "true" }.to_json, headers: { "Content-Type" => "application/json" })
+    service_response = service.delete_stopword_list(
+      environment_id: "envid",
+      collection_id: "colid"
+    )
+    assert_nil(service_response)
+  end
+
+  def test_list_gateways
+    service = IBMWatson::DiscoveryV1.new(
+      username: "username",
+      password: "password",
+      version: "2018-03-05"
+    )
+    stub_request(:get, "https://gateway.watsonplatform.net/discovery/api/v1/environments/envid/gateways?version=2018-03-05")
+      .with(
+        headers: {
+          "Accept" => "application/json",
+          "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
+          "Host" => "gateway.watsonplatform.net"
+        }
+      ).to_return(status: 200, body: { "received" => "true" }.to_json, headers: { "Content-Type" => "application/json" })
+    service_response = service.list_gateways(
+      environment_id: "envid"
+    )
+    assert_equal({ "received" => "true" }, service_response.result)
+  end
+
+  def test_create_gateway
+    service = IBMWatson::DiscoveryV1.new(
+      username: "username",
+      password: "password",
+      version: "2018-03-05"
+    )
+    stub_request(:post, "https://gateway.watsonplatform.net/discovery/api/v1/environments/envid/gateways?version=2018-03-05")
+      .with(
+        headers: {
+          "Accept" => "application/json",
+          "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
+          "Host" => "gateway.watsonplatform.net"
+        }
+      ).to_return(status: 200, body: { "received" => "true" }.to_json, headers: { "Content-Type" => "application/json" })
+    service_response = service.create_gateway(
+      environment_id: "envid"
+    )
+    assert_equal({ "received" => "true" }, service_response.result)
+  end
+
+  def test_get_gateway
+    service = IBMWatson::DiscoveryV1.new(
+      username: "username",
+      password: "password",
+      version: "2018-03-05"
+    )
+    stub_request(:get, "https://gateway.watsonplatform.net/discovery/api/v1/environments/envid/gateways/gatewayid?version=2018-03-05")
+      .with(
+        headers: {
+          "Accept" => "application/json",
+          "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
+          "Host" => "gateway.watsonplatform.net"
+        }
+      ).to_return(status: 200, body: { "received" => "true" }.to_json, headers: { "Content-Type" => "application/json" })
+    service_response = service.get_gateway(
+      environment_id: "envid",
+      gateway_id: "gatewayid"
+    )
+    assert_equal({ "received" => "true" }, service_response.result)
+  end
+
+  def test_delete_gateway
+    service = IBMWatson::DiscoveryV1.new(
+      username: "username",
+      password: "password",
+      version: "2018-03-05"
+    )
+    stub_request(:delete, "https://gateway.watsonplatform.net/discovery/api/v1/environments/envid/gateways/gatewayid?version=2018-03-05")
+      .with(
+        headers: {
+          "Accept" => "application/json",
+          "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
+          "Host" => "gateway.watsonplatform.net"
+        }
+      ).to_return(status: 200, body: { "received" => "true" }.to_json, headers: { "Content-Type" => "application/json" })
+    service_response = service.delete_gateway(
+      environment_id: "envid",
+      gateway_id: "gatewayid"
+    )
+    assert_equal({ "received" => "true" }, service_response.result)
+  end
 end

data/test/unit/test_speech_to_text_v1.rb

@@ -545,6 +545,87 @@ class SpeechToTextV1Test < Minitest::Test
     assert_equal({ "get response" => "yep" }, service_response.result)
   end
 
+  def test_list_grammars
+    service = IBMWatson::SpeechToTextV1.new(
+      username: "username",
+      password: "password"
+    )
+    stub_request(:get, "https://stream.watsonplatform.net/speech-to-text/api/v1/customizations/custid/grammars")
+      .with(
+        headers: {
+          "Accept" => "application/json",
+          "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
+          "Host" => "stream.watsonplatform.net"
+        }
+      ).to_return(status: 200, body: { "get response" => "yep" }.to_json, headers: { "Content-Type" => "application/json" })
+    service_response = service.list_grammars(
+      customization_id: "custid"
+    )
+    assert_equal({ "get response" => "yep" }, service_response.result)
+  end
+
+  def test_add_grammar
+    service = IBMWatson::SpeechToTextV1.new(
+      username: "username",
+      password: "password"
+    )
+    stub_request(:post, "https://stream.watsonplatform.net/speech-to-text/api/v1/customizations/custid/grammars/grammar")
+      .with(
+        headers: {
+          "Accept" => "application/json",
+          "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
+          "Host" => "stream.watsonplatform.net"
+        }
+      ).to_return(status: 200, body: { "get response" => "yep" }.to_json, headers: { "Content-Type" => "application/json" })
+    response = service.add_grammar(
+      customization_id: "custid",
+      grammar_name: "grammar",
+      grammar_file: "file",
+      content_type: "application/srgs"
+    )
+    assert_nil(response)
+  end
+
+  def test_get_grammar
+    service = IBMWatson::SpeechToTextV1.new(
+      username: "username",
+      password: "password"
+    )
+    stub_request(:get, "https://stream.watsonplatform.net/speech-to-text/api/v1/customizations/custid/grammars/grammar")
+      .with(
+        headers: {
+          "Accept" => "application/json",
+          "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
+          "Host" => "stream.watsonplatform.net"
+        }
+      ).to_return(status: 200, body: { "get response" => "yep" }.to_json, headers: { "Content-Type" => "application/json" })
+    response = service.get_grammar(
+      customization_id: "custid",
+      grammar_name: "grammar"
+    )
+    assert_equal({ "get response" => "yep" }, response.result)
+  end
+
+  def test_delete_grammar
+    service = IBMWatson::SpeechToTextV1.new(
+      username: "username",
+      password: "password"
+    )
+    stub_request(:delete, "https://stream.watsonplatform.net/speech-to-text/api/v1/customizations/custid/grammars/grammar")
+      .with(
+        headers: {
+          "Accept" => "application/json",
+          "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
+          "Host" => "stream.watsonplatform.net"
+        }
+      ).to_return(status: 200, body: { "get response" => "yep" }.to_json, headers: { "Content-Type" => "application/json" })
+    response = service.delete_grammar(
+      customization_id: "custid",
+      grammar_name: "grammar"
+    )
+    assert_nil(response)
+  end
+
   def test_custom_audio_resources
     service = IBMWatson::SpeechToTextV1.new(
       username: "username",

data/test/unit/test_watson_service.rb

@@ -0,0 +1,44 @@
+# 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 watson_service
+class WatsonServiceTest < Minitest::Test
+  def test_wrong_username
+    assert_raises do
+      IBMWatson::AssistantV2.new(
+        username: "\"username",
+        password: "password"
+      )
+    end
+  end
+
+  def test_wrong_apikey
+    assert_raises do
+      IBMWatson::AssistantV1.new(
+        iam_apikey: "{apikey"
+      )
+    end
+  end
+
+  def test_wrong_url
+    assert_raises do
+      IBMWatson::AssistantV1.new(
+        iam_apikey: "apikey",
+        url: "url}"
+      )
+    end
+  end
+
+  def test_correct_creds
+    service = IBMWatson::AssistantV1.new(
+      username: "username",
+      password: "password"
+    )
+    refute_nil(service)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ibm_watson
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Max Nussbaum
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-07 00:00:00.000000000 Z
+date: 2019-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -196,16 +196,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.57'
+        version: '0.62'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.57'
+        version: '0.62'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -294,6 +294,7 @@ files:
 - test/unit/test_tone_analyzer_v3.rb
 - test/unit/test_vcap_using_personality_insights.rb
 - test/unit/test_visual_recognition_v3.rb
+- test/unit/test_watson_service.rb
 homepage: https://www.github.com/watson-developer-cloud
 licenses:
 - Apache-2.0
@@ -316,8 +317,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: Official client library to use the IBM Watson Services