ibm_watson 1.0.0.rc2 → 1.0.0.rc3

data/lib/ibm_watson/visual_recognition_v3.rb

@@ -15,8 +15,8 @@
 # limitations under the License.
 
 # The IBM Watson™ Visual Recognition service uses deep learning algorithms to
-# identify scenes, objects, and faces  in images you upload to the service. You can create
-# and train a custom classifier to identify subjects that suit your needs.
+# identify scenes and objects in images that you upload to the service. You can create and
+# train a custom classifier to identify subjects that suit your needs.
 
 require "concurrent"
 require "erb"
@@ -45,34 +45,21 @@ module IBMWatson
     #   Instead, specify a version date that is compatible with your
     #   application, and don't change it until your application is
     #   ready for a later version.
-    # @option args url [String] The base url to use when contacting the service (e.g.
-    #   "https://gateway.watsonplatform.net/visual-recognition/api").
-    #   The base url may differ between IBM Cloud regions.
-    # @option args iam_apikey [String] An API key that can be used to request IAM tokens. If
-    #   this API key is provided, the SDK will manage the token and handle the
-    #   refreshing.
-    # @option args iam_access_token [String] An IAM access token is fully managed by the application.
-    #   Responsibility falls on the application to refresh the token, either before
-    #   it expires or reactively upon receiving a 401 from the service as any requests
-    #   made with an expired token will fail.
-    # @option args iam_url [String] An optional URL for the IAM service API. Defaults to
-    #   'https://iam.cloud.ibm.com/identity/token'.
-    # @option args iam_client_id [String] An optional client id for the IAM service API.
-    # @option args iam_client_secret [String] An optional client secret for the IAM service API.
-    # @option args authentication_type [STRING] Specifies the authentication pattern to use. Values that it
-    #   takes are basic, iam or icp4d.
+    # @option args service_url [String] The base service URL to use when contacting the service.
+    #   The base service_url may differ between IBM Cloud regions.
+    # @option args authenticator [Object] The Authenticator instance to be configured for this service.
     def initialize(args = {})
       @__async_initialized__ = false
       defaults = {}
       defaults[:version] = nil
-      defaults[:url] = "https://gateway.watsonplatform.net/visual-recognition/api"
+      defaults[:service_url] = "https://gateway.watsonplatform.net/visual-recognition/api"
       defaults[:authenticator] = nil
-      defaults[:authentication_type] = nil
       args = defaults.merge(args)
       @version = args[:version]
       raise ArgumentError.new("version must be provided") if @version.nil?
 
-      args[:display_name] = "Visual Recognition"
+      args[:service_name] = "visual_recognition"
+      args[:authenticator] = IBMCloudSdkCore::ConfigBasedAuthenticatorFactory.new.get_authenticator(service_name: args[:service_name]) if args[:authenticator].nil?
       super
     end
 
@@ -152,81 +139,6 @@ module IBMWatson
 
       method_url = "/v3/classify"
 
-      headers = authenticator.authenticate(headers)
-      response = request(
-        method: "POST",
-        url: method_url,
-        headers: headers,
-        params: params,
-        form: form_data,
-        accept_json: true
-      )
-      response
-    end
-    #########################
-    # Face
-    #########################
-
-    ##
-    # @!method detect_faces(images_file: nil, images_filename: nil, images_file_content_type: nil, url: 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://cloud.ibm.com/docs/services/visual-recognition?topic=visual-recognition-release-notes#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
-    #   **Detect faces** method does not support general biometric facial recognition.
-    #
-    #   Supported image formats include .gif, .jpg, .png, and .tif. The maximum image size
-    #   is 10 MB. The minimum recommended pixel density is 32X32 pixels, but the service
-    #   tends to perform better with images that are at least 224 x 224 pixels.
-    # @param images_file [File] An image file (gif, .jpg, .png, .tif.) or .zip file with images. Limit the .zip
-    #   file to 100 MB. You can include a maximum of 15 images in a request.
-    #
-    #   Encode the image and .zip file names in UTF-8 if they contain non-ASCII
-    #   characters. The service assumes UTF-8 encoding if it encounters non-ASCII
-    #   characters.
-    #
-    #   You can also include an image with the **url** parameter.
-    # @param images_filename [String] The filename for images_file.
-    # @param images_file_content_type [String] The content type of images_file.
-    # @param url [String] The URL of an image to analyze. Must be in .gif, .jpg, .png, or .tif format. The
-    #   minimum recommended pixel density is 32X32 pixels, but the service tends to
-    #   perform better with images that are at least 224 x 224 pixels. The maximum image
-    #   size is 10 MB. Redirects are followed, so you can use a shortened URL.
-    #
-    #   You can also include images with the **images_file** parameter.
-    # @param accept_language [String] The desired language of parts of the response. See the response for details.
-    # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
-    def detect_faces(images_file: nil, images_filename: nil, images_file_content_type: nil, url: nil, accept_language: nil)
-      headers = {
-        "Accept-Language" => accept_language
-      }
-      sdk_headers = Common.new.get_sdk_headers("watson_vision_combined", "V3", "detect_faces")
-      headers.merge!(sdk_headers)
-
-      params = {
-        "version" => @version
-      }
-
-      form_data = {}
-
-      unless images_file.nil?
-        unless images_file.instance_of?(StringIO) || images_file.instance_of?(File)
-          images_file = images_file.respond_to?(:to_json) ? StringIO.new(images_file.to_json) : StringIO.new(images_file)
-        end
-        images_filename = images_file.path if images_filename.nil? && images_file.respond_to?(:path)
-        form_data[:images_file] = HTTP::FormData::File.new(images_file, content_type: images_file_content_type.nil? ? "application/octet-stream" : images_file_content_type, filename: images_filename)
-      end
-
-      form_data[:url] = HTTP::FormData::Part.new(url.to_s, content_type: "text/plain") unless url.nil?
-
-      method_url = "/v3/detect_faces"
-
-      headers = authenticator.authenticate(headers)
       response = request(
         method: "POST",
         url: method_url,
@@ -316,7 +228,6 @@ module IBMWatson
 
       method_url = "/v3/classifiers"
 
-      headers = authenticator.authenticate(headers)
       response = request(
         method: "POST",
         url: method_url,
@@ -347,7 +258,6 @@ module IBMWatson
 
       method_url = "/v3/classifiers"
 
-      headers = authenticator.authenticate(headers)
       response = request(
         method: "GET",
         url: method_url,
@@ -378,7 +288,6 @@ module IBMWatson
 
       method_url = "/v3/classifiers/%s" % [ERB::Util.url_encode(classifier_id)]
 
-      headers = authenticator.authenticate(headers)
       response = request(
         method: "GET",
         url: method_url,
@@ -467,7 +376,6 @@ module IBMWatson
 
       method_url = "/v3/classifiers/%s" % [ERB::Util.url_encode(classifier_id)]
 
-      headers = authenticator.authenticate(headers)
       response = request(
         method: "POST",
         url: method_url,
@@ -498,7 +406,6 @@ module IBMWatson
 
       method_url = "/v3/classifiers/%s" % [ERB::Util.url_encode(classifier_id)]
 
-      headers = authenticator.authenticate(headers)
       request(
         method: "DELETE",
         url: method_url,
@@ -533,7 +440,6 @@ module IBMWatson
 
       method_url = "/v3/classifiers/%s/core_ml_model" % [ERB::Util.url_encode(classifier_id)]
 
-      headers = authenticator.authenticate(headers)
       response = request(
         method: "GET",
         url: method_url,
@@ -574,7 +480,6 @@ module IBMWatson
 
       method_url = "/v3/user_data"
 
-      headers = authenticator.authenticate(headers)
       request(
         method: "DELETE",
         url: method_url,

data/lib/ibm_watson/websocket/speech_to_text_websocket_listener.rb

@@ -11,14 +11,14 @@ TEN_MILLISECONDS = 0.01
 
 # Class for interacting with the WebSocket API
 class WebSocketClient
-  def initialize(audio: nil, chunk_data:, options:, recognize_callback:, url:, headers:, disable_ssl_verification: false)
+  def initialize(audio: nil, chunk_data:, options:, recognize_callback:, service_url:, headers:, disable_ssl_verification: false)
     @audio = audio
     @options = options
     @callback = recognize_callback
     @bytes_sent = 0
     @headers = headers
     @is_listening = false
-    @url = url
+    @service_url = service_url
     @timer = nil
     @chunk_data = chunk_data
     @mic_running = false
@@ -79,10 +79,10 @@ class WebSocketClient
     EM&.reactor_thread&.join
     EM.run do
       if @disable_ssl_verification
-        @url = @url.sub("wss:", "ws:")
-        @client = Faye::WebSocket::Client.new(@url, nil, tls: { verify_peer: false, fail_if_no_peer_cert: false }, headers: @headers)
+        @service_url = @service_url.sub("wss:", "ws:")
+        @client = Faye::WebSocket::Client.new(@service_url, nil, tls: { verify_peer: false, fail_if_no_peer_cert: false }, headers: @headers)
       else
-        @client = Faye::WebSocket::Client.new(@url, nil, headers: @headers)
+        @client = Faye::WebSocket::Client.new(@service_url, nil, headers: @headers)
       end
       @client.onclose = on_close
       @client.onerror = on_error

data/lib/ibm_watson.rb

@@ -7,6 +7,15 @@ module IBMWatson
   ApiException = IBMCloudSdkCore::ApiException
   DetailedResponse = IBMCloudSdkCore::DetailedResponse
 
+  module Authenticators
+    BasicAuthenticator = IBMCloudSdkCore::BasicAuthenticator
+    BearerTokenAuthenticator = IBMCloudSdkCore::BearerTokenAuthenticator
+    CloudPakForDataAuthenticator = IBMCloudSdkCore::CloudPakForDataAuthenticator
+    ConfigBasedAuthenticatorFactory = IBMCloudSdkCore::ConfigBasedAuthenticatorFactory
+    IamAuthenticator = IBMCloudSdkCore::IamAuthenticator
+    NoAuthAuthenticator = IBMCloudSdkCore::NoAuthAuthenticator
+  end
+
   require_relative("./ibm_watson/personality_insights_v3.rb")
   require_relative("./ibm_watson/tone_analyzer_v3.rb")
   require_relative("./ibm_watson/assistant_v1.rb")

data/test/integration/test_assistant_v1.rb

@@ -11,7 +11,7 @@ if !ENV["ASSISTANT_APIKEY"].nil? && !ENV["ASSISTANT_URL"].nil?
     include Minitest::Hooks
     attr_accessor :service
     def before_all
-      authenticator = IBMCloudSdkCore::IamAuthenticator.new(
+      authenticator = IBMWatson::Authenticators::IamAuthenticator.new(
         apikey: ENV["ASSISTANT_APIKEY"],
         version: "2018-02-16"
       )

data/test/integration/test_assistant_v2.rb

@@ -11,7 +11,7 @@ if !ENV["ASSISTANT_APIKEY"].nil? && !ENV["ASSISTANT_URL"].nil?
     include Minitest::Hooks
     attr_accessor :service
     def before_all
-      authenticator = IBMCloudSdkCore::IamAuthenticator.new(
+      authenticator = IBMWatson::Authenticators::IamAuthenticator.new(
         apikey: ENV["ASSISTANT_APIKEY"]
       )
       @service = IBMWatson::AssistantV2.new(

data/test/integration/test_compare_comply_v1.rb

@@ -11,7 +11,7 @@ if !ENV["COMPARE_COMPLY_APIKEY"].nil?
     attr_accessor :service, :environment_id, :collection_id
 
     def before_all
-      authenticator = IBMCloudSdkCore::IamAuthenticator.new(
+      authenticator = IBMWatson::Authenticators::IamAuthenticator.new(
         apikey: ENV["ASSISTANT_APIKEY"]
       )
       @service = IBMWatson::CompareComplyV1.new(

data/test/integration/test_discovery_v1.rb

@@ -10,7 +10,7 @@ if !ENV["DISCOVERY_APIKEY"].nil? && !ENV["DISCOVERY_URL"].nil?
     attr_accessor :service, :environment_id, :collection_id
 
     def before_all
-      authenticator = IBMCloudSdkCore::IamAuthenticator.new(
+      authenticator = IBMWatson::Authenticators::IamAuthenticator.new(
         apikey: ENV["DISCOVERY_APIKEY"]
       )
       @service = IBMWatson::DiscoveryV1.new(
@@ -203,9 +203,6 @@ if !ENV["DISCOVERY_APIKEY"].nil? && !ENV["DISCOVERY_URL"].nil?
       assert_equal("deleted", delete_doc["status"])
     end
 
-    # def test_queries
-    # end
-
     def test_list_credentials
       credentials = @service.list_credentials(
         environment_id: @environment_id

data/test/integration/test_language_translator_v3.rb

@@ -10,7 +10,7 @@ if !ENV["LANGUAGE_TRANSLATOR_APIKEY"].nil? && !ENV["LANGUAGE_TRANSLATOR_URL"].ni
     include Minitest::Hooks
     attr_accessor :service
     def before_all
-      authenticator = IBMCloudSdkCore::IamAuthenticator.new(
+      authenticator = IBMWatson::Authenticators::IamAuthenticator.new(
         apikey: ENV["LANGUAGE_TRANSLATOR_APIKEY"]
       )
       @service = IBMWatson::LanguageTranslatorV3.new(

data/test/integration/test_natural_language_classifier_v1.rb

@@ -10,7 +10,7 @@ if !ENV["NATURAL_LANGUAGE_CLASSIFIER_APIKEY"].nil? && !ENV["NATURAL_LANGUAGE_CLA
     include Minitest::Hooks
     attr_accessor :service
     def before_all
-      authenticator = IBMCloudSdkCore::IamAuthenticator.new(
+      authenticator = IBMWatson::Authenticators::IamAuthenticator.new(
         apikey: ENV["NATURAL_LANGUAGE_CLASSIFIER_APIKEY"]
       )
       @service = IBMWatson::NaturalLanguageClassifierV1.new(

data/test/integration/test_natural_language_understanding_v1.rb

@@ -9,7 +9,7 @@ if !ENV["NATURAL_LANGUAGE_UNDERSTANDING_APIKEY"].nil? && !ENV["NATURAL_LANGUAGE_
     include Minitest::Hooks
     attr_accessor :service
     def before_all
-      authenticator = IBMCloudSdkCore::IamAuthenticator.new(
+      authenticator = IBMWatson::Authenticators::IamAuthenticator.new(
         apikey: ENV["NATURAL_LANGUAGE_UNDERSTANDING_APIKEY"]
       )
       @service = IBMWatson::NaturalLanguageUnderstandingV1.new(

data/test/integration/test_personality_insights_v3.rb

@@ -9,7 +9,7 @@ if !ENV["PERSONALITY_INSIGHTS_APIKEY"].nil? && !ENV["PERSONALITY_INSIGHTS_URL"].
     include Minitest::Hooks
     attr_accessor :service
     def before_all
-      authenticator = IBMCloudSdkCore::IamAuthenticator.new(
+      authenticator = IBMWatson::Authenticators::IamAuthenticator.new(
         apikey: ENV["PERSONALITY_INSIGHTS_APIKEY"]
       )
       @service = IBMWatson::PersonalityInsightsV3.new(

data/test/integration/test_speech_to_text_v1.rb

@@ -28,7 +28,7 @@ if !ENV["SPEECH_TO_TEXT_APIKEY"].nil? && !ENV["SPEECH_TO_TEXT_URL"].nil?
     include Minitest::Hooks
     attr_accessor :service
     def before_all
-      authenticator = IBMCloudSdkCore::IamAuthenticator.new(
+      authenticator = IBMWatson::Authenticators::IamAuthenticator.new(
         apikey: ENV["SPEECH_TO_TEXT_APIKEY"]
       )
       @service = IBMWatson::SpeechToTextV1.new(
@@ -246,7 +246,7 @@ if !ENV["SPEECH_TO_TEXT_APIKEY"].nil? && !ENV["SPEECH_TO_TEXT_URL"].nil?
       audio_file = File.open(Dir.getwd + "/resources/speech.wav")
       atomic_boolean = Concurrent::AtomicBoolean.new
       mycallback = MyRecognizeCallback.new(atomic_boolean: atomic_boolean)
-      authenticator = IBMCloudSdkCore::BearerTokenAuthenticator.new(
+      authenticator = IBMWatson::Authenticators::BearerTokenAuthenticator.new(
         bearer_token: "bogus_iam_access_token"
       )
       temp_service = IBMWatson::SpeechToTextV1.new(

data/test/integration/test_text_to_speech_v1.rb

@@ -9,7 +9,7 @@ if !ENV["TEXT_TO_SPEECH_APIKEY"].nil? && !ENV["TEXT_TO_SPEECH_URL"].nil?
     include Minitest::Hooks
     attr_accessor :service
     def before_all
-      authenticator = IBMCloudSdkCore::IamAuthenticator.new(
+      authenticator = IBMWatson::Authenticators::IamAuthenticator.new(
         apikey: ENV["TEXT_TO_SPEECH_APIKEY"]
       )
       @service = IBMWatson::TextToSpeechV1.new(

data/test/integration/test_tone_analyzer_v3.rb

@@ -9,7 +9,7 @@ if !ENV["TONE_ANALYZER_APIKEY"].nil? && !ENV["TONE_ANALYZER_URL"].nil?
     include Minitest::Hooks
     attr_accessor :service
     def before_all
-      authenticator = IBMCloudSdkCore::IamAuthenticator.new(
+      authenticator = IBMWatson::Authenticators::IamAuthenticator.new(
         apikey: ENV["TONE_ANALYZER_APIKEY"]
       )
       @service = IBMWatson::ToneAnalyzerV3.new(

data/test/integration/test_visual_recognition_v3.rb

@@ -10,7 +10,7 @@ if !ENV["VISUAL_RECOGNITION_APIKEY"].nil? && !ENV["VISUAL_RECOGNITION_URL"].nil?
     include Minitest::Hooks
     attr_accessor :service, :classifier_id
     def before_all
-      authenticator = IBMCloudSdkCore::IamAuthenticator.new(
+      authenticator = IBMWatson::Authenticators::IamAuthenticator.new(
         apikey: ENV["VISUAL_RECOGNITION_APIKEY"]
       )
       @service = IBMWatson::VisualRecognitionV3.new(
@@ -37,13 +37,6 @@ if !ENV["VISUAL_RECOGNITION_APIKEY"].nil? && !ENV["VISUAL_RECOGNITION_URL"].nil?
       refute(dog_results.nil?)
     end
 
-    def test_detect_faces
-      output = @service.detect_faces(
-        url: "https://www.ibm.com/ibm/ginni/images/ginni_bio_780x981_v4_03162016.jpg"
-      ).result
-      refute(output.nil?)
-    end
-
     def test_custom_classifier
       skip "Time Consuming"
       cars = File.open(Dir.getwd + "/resources/cars.zip")