ibm_watson 0.1.0

data/test/unit/test_text_to_speech_v1.rb

@@ -0,0 +1,336 @@
+# 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 Text to Speech V1 Service
+class TextToSpeechV1Test < Minitest::Test
+  def test_success
+    voices_response = {
+      "voices" => [
+        {
+          "url" => "https://stream.watsonplatform.net/text-to-speech/api/v1/voices/VoiceEnUsLisa",
+          "gender" => "female",
+          "name" => "VoiceEnUsLisa",
+          "language" => "en-US"
+        }, {
+          "url" => "https://stream.watsonplatform.net/text-to-speech/api/v1/voices/VoiceEsEsEnrique",
+          "gender" => "male",
+          "name" => "VoiceEsEsEnrique",
+          "language" => "es-ES"
+        }, {
+          "url" => "https://stream.watsonplatform.net/text-to-speech/api/v1/voices/VoiceEnUsMichael",
+          "gender" => "male",
+          "name" => "VoiceEnUsMichael",
+          "language" => "en-US"
+        }, {
+          "url" => "https://stream.watsonplatform.net/text-to-speech/api/v1/voices/VoiceEnUsAllison",
+          "gender" => "female",
+          "name" => "VoiceEnUsAllison",
+          "language" => "en-US"
+        }
+      ]
+    }
+    voice_response = {
+      "url" => "https://stream.watsonplatform.net/text-to-speech/api/v1/voices/en-US_AllisonVoice",
+      "name" => "en-US_AllisonVoice",
+      "language" => "en-US",
+      "customizable" => true,
+      "gender" => "female",
+      "description" => "Allison: American English female voice.",
+      "supported_features" => {
+        "custom_pronunciation" => true,
+        "voice_transformation" => true
+      }
+    }
+    synthesize_response_body = "<binary response>"
+    stub_request(:get, "https://stream.watsonplatform.net/text-to-speech/api/v1/voices")
+      .with(
+        headers: {
+          "Accept" => "application/json",
+          "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
+          "Host" => "stream.watsonplatform.net"
+        }
+      ).to_return(status: 200, body: voices_response.to_json, headers: { "Content-Type" => "application/json" })
+    service = IBMWatson::TextToSpeechV1.new(
+      username: "username",
+      password: "password"
+    )
+    service_response = service.list_voices
+    assert_equal(voices_response, service_response.result)
+
+    stub_request(:get, "https://stream.watsonplatform.net/text-to-speech/api/v1/voices/en-us_AllisonVoice")
+      .with(
+        headers: {
+          "Accept" => "application/json",
+          "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
+          "Host" => "stream.watsonplatform.net"
+        }
+      ).to_return(status: 200, body: voice_response.to_json, headers: { "Content-Type" => "application/json" })
+    service_response = service.get_voice(
+      voice: "en-us_AllisonVoice"
+    )
+    assert_equal(voice_response, service_response.result)
+
+    stub_request(:post, "https://stream.watsonplatform.net/text-to-speech/api/v1/synthesize")
+      .with(
+        body: "{\"text\":\"hello\"}",
+        headers: {
+          "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
+          "Content-Type" => "application/json",
+          "Host" => "stream.watsonplatform.net"
+        }
+      ).to_return(status: 200, body: synthesize_response_body, headers: {})
+    service_response = service.synthesize(
+      text: "hello"
+    )
+    assert_equal(synthesize_response_body, service_response.result)
+  end
+
+  def test_get_pronunciation
+    response = {
+      "pronunciation" => "pronunciation info"
+    }
+    service = IBMWatson::TextToSpeechV1.new(
+      username: "username",
+      password: "password"
+    )
+    stub_request(:get, "https://stream.watsonplatform.net/text-to-speech/api/v1/pronunciation?text=this%20is%20some%20text")
+      .with(
+        headers: {
+          "Accept" => "application/json",
+          "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
+          "Host" => "stream.watsonplatform.net"
+        }
+      ).to_return(status: 200, body: response.to_json, headers: { "Content-Type" => "application/json" })
+    service_response = service.get_pronunciation(
+      text: "this is some text"
+    )
+    assert_equal(response, service_response.result)
+
+    stub_request(:get, "https://stream.watsonplatform.net/text-to-speech/api/v1/pronunciation?text=yo&voice=VoiceEnUsLisa")
+      .with(
+        headers: {
+          "Accept" => "application/json",
+          "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
+          "Host" => "stream.watsonplatform.net"
+        }
+      ).to_return(status: 200, body: response.to_json, headers: { "Content-Type" => "application/json" })
+    service_response = service.get_pronunciation(
+      text: "yo",
+      voice: "VoiceEnUsLisa"
+    )
+    assert_equal(response, service_response.result)
+
+    stub_request(:get, "https://stream.watsonplatform.net/text-to-speech/api/v1/pronunciation?format=ipa&text=yo&voice=VoiceEnUsLisa")
+      .with(
+        headers: {
+          "Accept" => "application/json",
+          "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
+          "Host" => "stream.watsonplatform.net"
+        }
+      ).to_return(status: 200, body: response.to_json, headers: { "Content-Type" => "application/json" })
+    service_response = service.get_pronunciation(
+      text: "yo",
+      voice: "VoiceEnUsLisa",
+      format: "ipa"
+    )
+    assert_equal(response, service_response.result)
+  end
+
+  def test_custom_voice_models
+    response = { "customizations" => "yep" }
+    service = IBMWatson::TextToSpeechV1.new(
+      username: "username",
+      password: "password"
+    )
+    stub_request(:get, "https://stream.watsonplatform.net/text-to-speech/api/v1/customizations")
+      .with(
+        headers: {
+          "Accept" => "application/json",
+          "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
+          "Host" => "stream.watsonplatform.net"
+        }
+      ).to_return(status: 200, body: response.to_json, headers: { "Content-Type" => "application/json" })
+    service_response = service.list_voice_models
+    assert_equal(response, service_response.result)
+
+    stub_request(:get, "https://stream.watsonplatform.net/text-to-speech/api/v1/customizations?language=en-US")
+      .with(
+        headers: {
+          "Accept" => "application/json",
+          "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
+          "Host" => "stream.watsonplatform.net"
+        }
+      ).to_return(status: 200, body: response.to_json, headers: { "Content-Type" => "application/json" })
+    service_response = service.list_voice_models(
+      language: "en-US"
+    )
+    assert_equal(response, service_response.result)
+
+    stub_request(:post, "https://stream.watsonplatform.net/text-to-speech/api/v1/customizations")
+      .with(
+        body: "{\"name\":\"name\",\"description\":\"description\"}",
+        headers: {
+          "Accept" => "application/json",
+          "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
+          "Content-Type" => "application/json",
+          "Host" => "stream.watsonplatform.net"
+        }
+      ).to_return(status: 200, body: response.to_json, headers: { "Content-Type" => "application/json" })
+    service_response = service.create_voice_model(
+      name: "name",
+      description: "description"
+    )
+    assert_equal(response, service_response.result)
+
+    stub_request(:get, "https://stream.watsonplatform.net/text-to-speech/api/v1/customizations/custid")
+      .with(
+        headers: {
+          "Accept" => "application/json",
+          "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
+          "Host" => "stream.watsonplatform.net"
+        }
+      ).to_return(status: 200, body: { "customization" => "yep, just one" }.to_json, headers: { "Content-Type" => "application/json" })
+    service_response = service.get_voice_model(
+      customization_id: "custid"
+    )
+    assert_equal({ "customization" => "yep, just one" }, service_response.result)
+
+    stub_request(:post, "https://stream.watsonplatform.net/text-to-speech/api/v1/customizations/custid")
+      .with(
+        body: "{\"name\":\"name\",\"description\":\"description\"}",
+        headers: {
+          "Accept" => "application/json",
+          "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
+          "Content-Type" => "application/json",
+          "Host" => "stream.watsonplatform.net"
+        }
+      ).to_return(status: 200, body: "", headers: {})
+    service_response = service.update_voice_model(
+      customization_id: "custid",
+      name: "name",
+      description: "description"
+    )
+    assert(service_response.nil?)
+
+    stub_request(:delete, "https://stream.watsonplatform.net/text-to-speech/api/v1/customizations/custid")
+      .with(
+        headers: {
+          "Accept" => "application/json",
+          "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
+          "Host" => "stream.watsonplatform.net"
+        }
+      ).to_return(status: 200, body: "", headers: {})
+    service_response = service.delete_voice_model(
+      customization_id: "custid"
+    )
+    assert(service_response.nil?)
+  end
+
+  def test_custom_words
+    response = { "customizations" => "yep" }
+    service = IBMWatson::TextToSpeechV1.new(
+      username: "username",
+      password: "password"
+    )
+    stub_request(:get, "https://stream.watsonplatform.net/text-to-speech/api/v1/customizations/custid/words")
+      .with(
+        headers: {
+          "Accept" => "application/json",
+          "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
+          "Host" => "stream.watsonplatform.net"
+        }
+      ).to_return(status: 200, body: response.to_json, headers: { "Content-Type" => "application/json" })
+    service_response = service.list_words(
+      customization_id: "custid"
+    )
+    assert_equal(response, service_response.result)
+
+    stub_request(:post, "https://stream.watsonplatform.net/text-to-speech/api/v1/customizations/custid/words")
+      .with(
+        body: "{\"words\":[{\"word\":\"one\",\"translation\":\"one\"},{\"word\":\"two\",\"translation\":\"two\"}]}",
+        headers: {
+          "Accept" => "application/json",
+          "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
+          "Content-Type" => "application/json",
+          "Host" => "stream.watsonplatform.net"
+        }
+      ).to_return(status: 200, body: "", headers: { "Content-Type" => "application/json" })
+    service_response = service.add_words(
+      customization_id: "custid",
+      words: [
+        { "word" => "one", "translation" => "one" },
+        { "word" => "two", "translation" => "two" }
+      ]
+    )
+    assert(service_response.nil?)
+
+    stub_request(:get, "https://stream.watsonplatform.net/text-to-speech/api/v1/customizations/custid/words/word")
+      .with(
+        headers: {
+          "Accept" => "application/json",
+          "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
+          "Host" => "stream.watsonplatform.net"
+        }
+      ).to_return(status: 200, body: { "customization" => "yep, just one" }.to_json, headers: { "Content-Type" => "application/json" })
+    service_response = service.get_word(
+      customization_id: "custid",
+      word: "word"
+    )
+    assert_equal({ "customization" => "yep, just one" }, service_response.result)
+
+    stub_request(:put, "https://stream.watsonplatform.net/text-to-speech/api/v1/customizations/custid/words/word")
+      .with(
+        body: "{\"translation\":\"I'm translated\"}",
+        headers: {
+          "Accept" => "application/json",
+          "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
+          "Content-Type" => "application/json",
+          "Host" => "stream.watsonplatform.net"
+        }
+      ).to_return(status: 200, body: "", headers: { "Content-Type" => "application/json" })
+    service_response = service.add_word(
+      customization_id: "custid",
+      word: "word",
+      translation: "I'm translated"
+    )
+    assert(service_response.nil?)
+
+    stub_request(:delete, "https://stream.watsonplatform.net/text-to-speech/api/v1/customizations/custid/words/word")
+      .with(
+        headers: {
+          "Accept" => "application/json",
+          "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
+          "Host" => "stream.watsonplatform.net"
+        }
+      ).to_return(status: 200, body: "", headers: { "Content-Type" => "application/json" })
+    service_response = service.delete_word(
+      customization_id: "custid",
+      word: "word"
+    )
+    assert(service_response.nil?)
+  end
+
+  def test_delete_user_data
+    service = IBMWatson::TextToSpeechV1.new(
+      username: "username",
+      password: "password"
+    )
+    stub_request(:delete, "https://stream.watsonplatform.net/text-to-speech/api/v1/user_data?customer_id=id")
+      .with(
+        headers: {
+          "Accept" => "application/json",
+          "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
+          "Host" => "stream.watsonplatform.net"
+        }
+      ).to_return(status: 200, body: "", headers: {})
+    service_response = service.delete_user_data(
+      customer_id: "id"
+    )
+    assert(service_response.nil?)
+  end
+end

data/test/unit/test_tone_analyzer_v3.rb

@@ -0,0 +1,200 @@
+# frozen_string_literal: true
+
+require_relative("./../../lib/ibm_watson/watson_api_exception.rb")
+require("json")
+require_relative("./../test_helper.rb")
+require("webmock/minitest")
+
+WebMock.disable_net_connect!(allow_localhost: true)
+
+# Unit tests for the Tone Analyzer V3 Service
+class ToneAnalyzerV3Test < Minitest::Test
+  def test_tone
+    tone_response = JSON.parse(File.read(Dir.getwd + "/resources/tone-v3-expect1.json"))
+    headers = {
+      "Content-Type" => "application/json"
+    }
+    expected_response = DetailedResponse.new(status: 200, headers: headers, body: tone_response)
+    tone_text = File.read(Dir.getwd + "/resources/personality.txt")
+    stub_request(:post, "https://gateway.watsonplatform.net/tone-analyzer/api/v3/tone?version=2017-09-21")
+      .with(
+        body: tone_text,
+        headers: {
+          "Accept" => "application/json",
+          "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
+          "Content-Type" => "application/json",
+          "Host" => "gateway.watsonplatform.net"
+        }
+      ).to_return(status: 200, body: tone_response.to_json, headers: headers)
+    service = IBMWatson::ToneAnalyzerV3.new(
+      version: "2017-09-21",
+      username: "username",
+      password: "password"
+    )
+    service_response = service.tone(tone_input: tone_text, content_type: "application/json")
+    assert_equal(expected_response.status, service_response.status)
+    assert_equal(expected_response.result, service_response.result)
+    expected_response.headers.each_key do |key|
+      assert(service_response.headers.key?(key))
+      assert(expected_response.headers[key] == service_response.headers[key])
+    end
+  end
+
+  def test_tone_with_args
+    tone_response = JSON.parse(File.read(Dir.getwd + "/resources/tone-v3-expect1.json"))
+    headers = {
+      "Content-Type" => "application/json"
+    }
+    tone_text = File.read(Dir.getwd + "/resources/personality.txt")
+    expected_response = DetailedResponse.new(status: 200, headers: headers, body: tone_response)
+    stub_request(:post, "https://gateway.watsonplatform.net/tone-analyzer/api/v3/tone?sentences=false&version=2017-09-21")
+      .with(
+        body: tone_text,
+        headers: {
+          "Accept" => "application/json",
+          "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
+          "Content-Type" => "application/json",
+          "Host" => "gateway.watsonplatform.net"
+        }
+      ).to_return(status: 200, body: tone_response.to_json, headers: headers)
+    service = IBMWatson::ToneAnalyzerV3.new(
+      version: "2017-09-21",
+      username: "username",
+      password: "password"
+    )
+    service_response = service.tone(tone_input: tone_text, content_type: "application/json", sentences: false)
+    assert_equal(expected_response.status, service_response.status)
+    assert_equal(expected_response.result, service_response.result)
+    expected_response.headers.each_key do |key|
+      assert(service_response.headers.key?(key))
+      assert(expected_response.headers[key] == service_response.headers[key])
+    end
+  end
+
+  def test_tone_chat
+    tone_response = JSON.parse(File.read(Dir.getwd + "/resources/tone-v3-expect2.json"))
+    headers = {
+      "Content-Type" => "application/json"
+    }
+    expected_response = DetailedResponse.new(body: tone_response, status: 200, headers: headers)
+    stub_request(:post, "https://gateway.watsonplatform.net/tone-analyzer/api/v3/tone_chat?version=2017-09-21")
+      .with(
+        body: "{\"utterances\":[{\"text\":\"I am very happy\",\"user\":\"glenn\"}]}",
+        headers: {
+          "Accept" => "application/json",
+          "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
+          "Content-Type" => "application/json",
+          "Host" => "gateway.watsonplatform.net"
+        }
+      ).to_return(status: 200, body: tone_response.to_json, headers: headers)
+    service = IBMWatson::ToneAnalyzerV3.new(
+      version: "2017-09-21",
+      username: "username",
+      password: "password"
+    )
+    utterances = [
+      {
+        "text" => "I am very happy",
+        "user" => "glenn"
+      }
+    ]
+    service_response = service.tone_chat(utterances: utterances)
+    assert_equal(expected_response.status, service_response.status)
+    assert_equal(expected_response.result, service_response.result)
+    expected_response.headers.each_key do |key|
+      assert(service_response.headers.key?(key))
+      assert(expected_response.headers[key] == service_response.headers[key])
+    end
+  end
+
+  def test_error
+    error_code = 400
+    error_message = "Invalid Json at line 2, column 12"
+    headers = {
+      "Content-Type" => "application/json"
+    }
+    tone_response = {
+      "code" => error_code,
+      "sub_code" => "C00012",
+      "error" => error_message
+    }
+    text = "Team, I know that times are tough!"
+    stub_request(:post, "https://gateway.watsonplatform.net/tone-analyzer/api/v3/tone?version=2017-09-21")
+      .with(
+        body: text,
+        headers: {
+          "Accept" => "application/json",
+          "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
+          "Content-Type" => "application/json",
+          "Host" => "gateway.watsonplatform.net"
+        }
+      ).to_return(status: 400, body: tone_response.to_json, headers: headers)
+    service = IBMWatson::ToneAnalyzerV3.new(
+      version: "2017-09-21",
+      username: "username",
+      password: "password"
+    )
+    begin
+      service.tone(tone_input: text, content_type: "application/json")
+    rescue WatsonApiException => e
+      assert_equal(error_code, e.code)
+      assert_equal(error_message, e.error)
+      assert_equal("C00012", e.info["sub_code"])
+    end
+  end
+
+  # Test to ensure that custom headers are sent
+  def test_tone_with_custom_headers
+    tone_response = JSON.parse(File.read(Dir.getwd + "/resources/tone-v3-expect1.json"))
+    headers = {
+      "Content-Type" => "application/json"
+    }
+    tone_text = File.read(Dir.getwd + "/resources/personality.txt")
+    stub_request(:post, "https://gateway.watsonplatform.net/tone-analyzer/api/v3/tone?version=2017-09-21")
+      .with(
+        body: tone_text,
+        headers: {
+          "Accept" => "application/json",
+          "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
+          "Content-Type" => "Custom/Type",
+          "Host" => "gateway.watsonplatform.net",
+          "Custom-Header-One" => "yes"
+        }
+      ).to_return(status: 200, body: tone_response.to_json, headers: headers)
+    service = IBMWatson::ToneAnalyzerV3.new(
+      version: "2017-09-21",
+      username: "username",
+      password: "password"
+    )
+    service_response = service.headers(
+      "Custom-Header-One" => "yes",
+      "Content-Type" => "Custom/Type"
+    ).tone(tone_input: tone_text, content_type: "application/json")
+    assert_equal(tone_response, service_response.result)
+  end
+
+  def test_tone_with_application_json
+    tone_response = JSON.parse(File.read(Dir.getwd + "/resources/tone-v3-expect1.json"))
+    headers = {
+      "Content-Type" => "application/json"
+    }
+    tone_text = { "text" => "This is the text to be analyzed" }
+    stub_request(:post, "https://gateway.watsonplatform.net/tone-analyzer/api/v3/tone?version=2017-09-21")
+      .with(
+        body: tone_text,
+        headers: {
+          "Accept" => "application/json",
+          "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
+          "Content-Type" => "application/json",
+          "Host" => "gateway.watsonplatform.net"
+        }
+      ).to_return(status: 200, body: tone_response.to_json, headers: headers)
+    service = IBMWatson::ToneAnalyzerV3.new(
+      version: "2017-09-21",
+      username: "username",
+      password: "password"
+    )
+    service_response = service.tone(tone_input: tone_text, content_type: "application/json")
+    assert_equal(tone_response, service_response.result)
+  end
+end