chore(examples): Add more information about authentication to examples

Author: maxnussbaum

examples/assistant_v1.rb

@@ -1,12 +1,18 @@
 require("watson_apis/assistant_v1")
 
+# If using IAM
 assistant = AssistantV1(
-  # username: "YOUR SERVICE USERNAME",
-  # password: "YOUR SERVICE PASSWORD",
   iam_api_key: "IAM API KEY",
   version: "2018-02-16"
 )
 
+# If you have username & password in your credentials use:
+# assistant = AssistantV1(
+#   username: "YOUR SERVICE USERNAME",
+#   password: "YOUR SERVICE PASSWORD",
+#   version: "2018-02-16"
+# )
+
 #########################
 # Workspaces
 #########################

examples/discovery_v1.rb

@@ -1,12 +1,18 @@
 require("watson_apis/discovery_v1")
 
+# If using IAM
 discovery = WatsonAPIs::DiscoveryV1.new(
-  # username: "username",
-  # password: "password",
   iam_api_key: "IAM API KEY",
   version: "2018-03-05"
 )
 
+# If you have username & password in your credentials use:
+# discovery = WatsonAPIs::DiscoveryV1.new(
+#   username: "username",
+#   password: "password",
+#   version: "2018-03-05"
+# )
+
 environments = discovery.list_environments.body
 p environments
 

examples/language_translator_v3.rb

@@ -1,17 +1,18 @@
 require("watson_apis/language_translator_v3")
 
+# If using IAM
 language_translator = WatsonAPIs::LanguageTranslatorV3.new(
   version: "2018-05-31",
   ### url is optional, and defaults to the URL below. Use the correct URL for your region.
   # url: "https://gateway.watsonplatform.net/language-translator/api",
   iam_api_key: "your_api_key"
 )
 
-## Authenticate with username/password if your service instance doesn't provide an API key
+# If you have username & password in your credentials use:
 # language_translator = WatsonAPIs::LanguageTranslatorV3.new(
 #   version: "2018-05-31",
-#   username: "your_username",
-#   password: "your_password"
+#   username: "username",
+#   password: "password"
 # )
 
 ## Translate

examples/natural_language_classifier_v1.rb

@@ -1,11 +1,16 @@
 require("watson_apis/natural_language_classifier_v1")
 
+# If using IAM
 natural_language_classifier = WatsonAPIs::NaturalLanguageClassifierV1.new(
-  # username: "YOUR SERVICE USERNAME",
-  # password: "YOUR SERVICE PASSWORD"
   iam_api_key: "IAM API KEY"
 )
 
+# If you have username & password in your credentials use:
+# natural_language_classifier = WatsonAPIs::NaturalLanguageClassifierV1.new(
+#   username: "YOUR SERVICE USERNAME",
+#   password: "YOUR SERVICE PASSWORD"
+# )
+
 classifiers = natural_language_classifier.list_classifiers.body
 p classifiers
 

examples/natural_language_understanding_v1.rb

@@ -1,12 +1,18 @@
 require("watson_apis/natural_language_understanding_v1")
 
+# If using IAM
 natural_language_understanding = WatsonAPIs::NaturalLanguageUnderstandingV1.new(
-  # username: "YOUR SERVICE USERNAME",
-  # password: "YOUR SERVICE PASSWORD",
   iam_api_key: "IAM API KEY",
   version: "2018-03-16"
 )
 
+# If you have username & password in your credentials use:
+# natural_language_understanding = WatsonAPIs::NaturalLanguageUnderstandingV1.new(
+#   username: "YOUR SERVICE USERNAME",
+#   password: "YOUR SERVICE PASSWORD",
+#   version: "2018-03-16"
+# )
+
 response = natural_language_understanding.analyze(
   text: "Bruce Banner is the Hulk and Bruce Wayne is BATMAN! " \
         "Superman fears not Banner, but Wayne",

examples/personality_insights_v3.rb

@@ -3,12 +3,19 @@
 # The example returns a JSON response whose content is the same as that in
 #   ../resources/personality-v3-expect2.txt
 
+# If using IAM
 personality_insights = WatsonAPIs::PersonalityInsightsV3.new(
-  # username: "YOUR SERVICE USERNAME",
-  # password: "YOUR SERVICE PASSWORD",
   iam_api_key: "IAM API KEY",
   version: "2017-10-13"
 )
+
+# If you have username & password in your credentials use:
+# personality_insights = WatsonAPIs::PersonalityInsightsV3.new(
+#   username: "YOUR SERVICE USERNAME",
+#   password: "YOUR SERVICE PASSWORD",
+#   version: "2017-10-13"
+# )
+
 profile = nil
 File.open(Dir.getwd + "/resources/personality-v3.json") do |profile_json|
   profile = personality_insights.profile(

examples/speech_to_text_v1.rb

@@ -1,12 +1,17 @@
 require("watson_apis/speech_to_text_v1")
 require("watson_apis/recognize_callback")
 
+# If using IAM
 speech_to_text = WatsonAPIs::SpeechToTextV1.new(
-  # username: "YOUR SERVICE USERNAME",
-  # password: "YOUR SERVICE PASSWORD"
   iam_api_key: "IAM API KEY"
 )
 
+# If you have username & password in your credentials use:
+# speech_to_text = WatsonAPIs::SpeechToTextV1.new(
+#   username: "YOUR SERVICE USERNAME",
+#   password: "YOUR SERVICE PASSWORD"
+# )
+
 p speech_to_text.list_models.body
 
 p speech_to_text.get_model(model_id: "en-US_BroadbandModel").body

examples/text_to_speech_v1.rb

@@ -1,11 +1,16 @@
 require("watson_apis/text_to_speech_v1")
 
+# If using IAM
 text_to_speech = WatsonAPIs::TextToSpeechV1.new(
-  # username: "YOUR SERVICE USERNAME",
-  # password: "YOUR SERVICE PASSWORD"
   iam_api_key: "IAM API KEY"
 )
 
+# If you have username & password in your credentials use:
+# text_to_speech = WatsonAPIs::TextToSpeechV1.new(
+#   username: "YOUR SERVICE USERNAME",
+#   password: "YOUR SERVICE PASSWORD"
+# )
+
 p text_to_speech.list_voices.body
 
 File.new("output.wav", "w+") do |audio_file|

examples/tone_analyzer_v3.rb

@@ -1,13 +1,19 @@
 require("watson_apis/tone_analyzer_v3")
 require("json")
 
+# If using IAM
 tone_analyzer = ToneAnalyzerV3(
-  # username: "YOUR SERVICE USERNAME",
-  # password: "YOUR SERVICE PASSWORD",
   iam_api_key: "IAM API KEY",
   version: "2017-09-21"
 )
 
+# If you have username & password in your credentials use:
+# tone_analyzer = ToneAnalyzerV3(
+#   username: "YOUR SERVICE USERNAME",
+#   password: "YOUR SERVICE PASSWORD",
+#   version: "2017-09-21"
+# )
+
 utterances = [
   {
     "text" => "I am very happy.",

examples/visual_recognition_v3.rb

@@ -2,11 +2,19 @@
 
 test_url = "https://www.ibm.com/ibm/ginni/images/ginni_bio_780x981_v4_03162016.jpg".freeze
 
+# If using IAM
 visual_recognition = WatsonAPIs::VisualRecognitionV3.new(
   version: "2018-03-19",
   iam_api_key: "IAM API KEY"
 )
 
+# If you have username & password in your credentials use:
+# visual_recognition = WatsonAPIs::VisualRecognitionV3.new(
+#   version: "2018-03-19",
+#   username: "YOUR SERVICE USERNAME",
+#   password: "YOUR SERVICE PASSWORD"
+# )
+
 # cars = File.open(Dir.getwd + "/resources/cars.zip")
 # trucks = File.open(Dir.getwd + "/resources/trucks.zip")
 # p visual_recognition.create_classifier(