feat(IAM): Change iam_api_key to iam_apikey

maxnussbaum · maxnussbaum · commit 9c7bde80a533 · 2018-07-20T14:45:02.000-04:00
diff --git a/README.md b/README.md
@@ -90,15 +90,15 @@ You supply either an IAM service **API key** or an **access token**:
 # In the constructor, letting the SDK manage the IAM token
 discovery = IBMWatson::DiscoveryV1.new(
   version: "2017-10-16",
-  iam_api_key: "<iam_api_key>",
+  iam_apikey: "<iam_apikey>",
   iam_url: "<iam_url>" # optional - the default value is https://iam.ng.bluemix.net/identity/token
 )
 ```
 
 ```ruby
 # after instantiation, letting the SDK manage the IAM token
 discovery = IBMWatson::DiscoveryV1.new(version: "2017-10-16")
-discovery._iam_api_key(iam_api_key: "<iam_api_key>")
+discovery._iam_apikey(iam_apikey: "<iam_apikey>")
 ```
 
 #### Supplying the access token
diff --git a/examples/assistant_v1.rb b/examples/assistant_v1.rb
@@ -5,7 +5,7 @@
 
 # If using IAM
 assistant = AssistantV1(
-  iam_api_key: "IAM API KEY",
+  iam_apikey: "IAM API KEY",
   version: "2018-02-16"
 )
 
diff --git a/examples/discovery_v1.rb b/examples/discovery_v1.rb
@@ -5,7 +5,7 @@
 
 # If using IAM
 discovery = IBMWatson::DiscoveryV1.new(
-  iam_api_key: "IAM API KEY",
+  iam_apikey: "IAM API KEY",
   version: "2018-03-05"
 )
 
diff --git a/examples/language_translator_v3.rb b/examples/language_translator_v3.rb
@@ -8,7 +8,7 @@
   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"
+  iam_apikey: "your_api_key"
 )
 
 # If you have username & password in your credentials use:
diff --git a/examples/natural_language_classifier_v1.rb b/examples/natural_language_classifier_v1.rb
@@ -5,7 +5,7 @@
 
 # If using IAM
 natural_language_classifier = IBMWatson::NaturalLanguageClassifierV1.new(
-  iam_api_key: "IAM API KEY"
+  iam_apikey: "IAM API KEY"
 )
 
 # If you have username & password in your credentials use:
diff --git a/examples/natural_language_understanding_v1.rb b/examples/natural_language_understanding_v1.rb
@@ -5,7 +5,7 @@
 
 # If using IAM
 natural_language_understanding = IBMWatson::NaturalLanguageUnderstandingV1.new(
-  iam_api_key: "IAM API KEY",
+  iam_apikey: "IAM API KEY",
   version: "2018-03-16"
 )
 
diff --git a/examples/personality_insights_v3.rb b/examples/personality_insights_v3.rb
@@ -8,7 +8,7 @@
 
 # If using IAM
 personality_insights = IBMWatson::PersonalityInsightsV3.new(
-  iam_api_key: "IAM API KEY",
+  iam_apikey: "IAM API KEY",
   version: "2017-10-13"
 )
 
diff --git a/examples/speech_to_text_v1.rb b/examples/speech_to_text_v1.rb
@@ -5,7 +5,7 @@
 
 # If using IAM
 speech_to_text = IBMWatson::SpeechToTextV1.new(
-  iam_api_key: "IAM API KEY"
+  iam_apikey: "IAM API KEY"
 )
 
 # If you have username & password in your credentials use:
diff --git a/examples/text_to_speech_v1.rb b/examples/text_to_speech_v1.rb
@@ -5,7 +5,7 @@
 
 # If using IAM
 text_to_speech = IBMWatson::TextToSpeechV1.new(
-  iam_api_key: "IAM API KEY"
+  iam_apikey: "IAM API KEY"
 )
 
 # If you have username & password in your credentials use:
diff --git a/examples/tone_analyzer_v3.rb b/examples/tone_analyzer_v3.rb
@@ -5,7 +5,7 @@
 
 # If using IAM
 tone_analyzer = ToneAnalyzerV3(
-  iam_api_key: "IAM API KEY",
+  iam_apikey: "IAM API KEY",
   version: "2017-09-21"
 )
 
diff --git a/examples/visual_recognition_v3.rb b/examples/visual_recognition_v3.rb
@@ -8,7 +8,7 @@
 # If using IAM
 visual_recognition = IBMWatson::VisualRecognitionV3.new(
   version: "2018-03-19",
-  iam_api_key: "IAM API KEY"
+  iam_apikey: "IAM API KEY"
 )
 
 # If you have username & password in your credentials use:
diff --git a/lib/ibm_watson/assistant_v1.rb b/lib/ibm_watson/assistant_v1.rb
@@ -59,7 +59,7 @@ class AssistantV1
     #   application locally or outside of Bluemix. When running on
     #   Bluemix, the credentials will be automatically loaded from the
     #   `VCAP_SERVICES` environment variable.
-    # @option args iam_api_key [String] An API key that can be used to request IAM tokens. If
+    # @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.
@@ -76,7 +76,7 @@ def initialize(args = {})
       defaults[:url] = "https://gateway.watsonplatform.net/assistant/api"
       defaults[:username] = nil
       defaults[:password] = nil
-      defaults[:iam_api_key] = nil
+      defaults[:iam_apikey] = nil
       defaults[:iam_access_token] = nil
       defaults[:iam_url] = nil
       args = defaults.merge(args)
@@ -85,7 +85,7 @@ def initialize(args = {})
         url: args[:url],
         username: args[:username],
         password: args[:password],
-        iam_api_key: args[:iam_api_key],
+        iam_apikey: args[:iam_apikey],
         iam_access_token: args[:iam_access_token],
         iam_url: args[:iam_url],
         use_vcap_services: true
@@ -102,8 +102,8 @@ def _iam_access_token(iam_access_token:)
       @watson_service._iam_access_token(iam_access_token: iam_access_token)
     end
 
-    def _iam_api_key(iam_api_key:)
-      @watson_service._iam_api_key(iam_api_key: iam_api_key)
+    def _iam_apikey(iam_apikey:)
+      @watson_service._iam_apikey(iam_apikey: iam_apikey)
     end
 
     # @return [DetailedResponse]
diff --git a/lib/ibm_watson/discovery_v1.rb b/lib/ibm_watson/discovery_v1.rb
@@ -61,7 +61,7 @@ class DiscoveryV1
     #   application locally or outside of Bluemix. When running on
     #   Bluemix, the credentials will be automatically loaded from the
     #   `VCAP_SERVICES` environment variable.
-    # @option args iam_api_key [String] An API key that can be used to request IAM tokens. If
+    # @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.
@@ -78,7 +78,7 @@ def initialize(args = {})
       defaults[:url] = "https://gateway.watsonplatform.net/discovery/api"
       defaults[:username] = nil
       defaults[:password] = nil
-      defaults[:iam_api_key] = nil
+      defaults[:iam_apikey] = nil
       defaults[:iam_access_token] = nil
       defaults[:iam_url] = nil
       args = defaults.merge(args)
@@ -87,7 +87,7 @@ def initialize(args = {})
         url: args[:url],
         username: args[:username],
         password: args[:password],
-        iam_api_key: args[:iam_api_key],
+        iam_apikey: args[:iam_apikey],
         iam_access_token: args[:iam_access_token],
         iam_url: args[:iam_url],
         use_vcap_services: true
@@ -104,8 +104,8 @@ def _iam_access_token(iam_access_token:)
       @watson_service._iam_access_token(iam_access_token: iam_access_token)
     end
 
-    def _iam_api_key(iam_api_key:)
-      @watson_service._iam_api_key(iam_api_key: iam_api_key)
+    def _iam_apikey(iam_apikey:)
+      @watson_service._iam_apikey(iam_apikey: iam_apikey)
     end
 
     # @return [DetailedResponse]
@@ -1224,7 +1224,7 @@ def query_notices(environment_id:, collection_id:, filter: nil, query: nil, natu
         "passages" => passages,
         "aggregation" => aggregation,
         "count" => count,
-        "return_fields" => return_fields.to_a,
+        "return" => return_fields.to_a,
         "offset" => offset,
         "sort" => sort.to_a,
         "highlight" => highlight,
@@ -1320,7 +1320,7 @@ def federated_query(environment_id:, collection_ids:, filter: nil, query: nil, n
         "natural_language_query" => natural_language_query,
         "aggregation" => aggregation,
         "count" => count,
-        "return_fields" => return_fields.to_a,
+        "return" => return_fields.to_a,
         "offset" => offset,
         "sort" => sort.to_a,
         "highlight" => highlight,
@@ -1409,7 +1409,7 @@ def federated_query_notices(environment_id:, collection_ids:, filter: nil, query
         "natural_language_query" => natural_language_query,
         "aggregation" => aggregation,
         "count" => count,
-        "return_fields" => return_fields.to_a,
+        "return" => return_fields.to_a,
         "offset" => offset,
         "sort" => sort.to_a,
         "highlight" => highlight,
diff --git a/lib/ibm_watson/iam_token_manager.rb b/lib/ibm_watson/iam_token_manager.rb
@@ -16,8 +16,8 @@
 # Class to manage IAM Token Authentication
 class IAMTokenManager
   attr_accessor :token_info, :user_access_token
-  def initialize(iam_api_key: nil, iam_access_token: nil, iam_url: nil)
-    @iam_api_key = iam_api_key
+  def initialize(iam_apikey: nil, iam_access_token: nil, iam_url: nil)
+    @iam_apikey = iam_apikey
     @user_access_token = iam_access_token
     @iam_url = iam_url.nil? ? DEFAULT_IAM_URL : iam_url
     @token_info = {
@@ -82,7 +82,7 @@ def _request_token
     }
     data = {
       "grant_type" => REQUEST_TOKEN_GRANT_TYPE,
-      "apikey" => @iam_api_key,
+      "apikey" => @iam_apikey,
       "response_type" => REQUEST_TOKEN_RESPONSE_TYPE
     }
     response = request(
@@ -121,8 +121,8 @@ def _access_token(iam_access_token:)
   end
 
   # Set the IAM api key
-  def _iam_api_key(iam_api_key:)
-    @iam_api_key = iam_api_key
+  def _iam_apikey(iam_apikey:)
+    @iam_apikey = iam_apikey
   end
 
   # Check if currently stored token is expired.
diff --git a/lib/ibm_watson/language_translator_v3.rb b/lib/ibm_watson/language_translator_v3.rb
@@ -61,7 +61,7 @@ class LanguageTranslatorV3
     #   application locally or outside of Bluemix. When running on
     #   Bluemix, the credentials will be automatically loaded from the
     #   `VCAP_SERVICES` environment variable.
-    # @option args iam_api_key [String] An API key that can be used to request IAM tokens. If
+    # @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.
@@ -78,7 +78,7 @@ def initialize(args = {})
       defaults[:url] = "https://gateway.watsonplatform.net/language-translator/api"
       defaults[:username] = nil
       defaults[:password] = nil
-      defaults[:iam_api_key] = nil
+      defaults[:iam_apikey] = nil
       defaults[:iam_access_token] = nil
       defaults[:iam_url] = nil
       args = defaults.merge(args)
@@ -87,7 +87,7 @@ def initialize(args = {})
         url: args[:url],
         username: args[:username],
         password: args[:password],
-        iam_api_key: args[:iam_api_key],
+        iam_apikey: args[:iam_apikey],
         iam_access_token: args[:iam_access_token],
         iam_url: args[:iam_url],
         use_vcap_services: true
@@ -104,8 +104,8 @@ def _iam_access_token(iam_access_token:)
       @watson_service._iam_access_token(iam_access_token: iam_access_token)
     end
 
-    def _iam_api_key(iam_api_key:)
-      @watson_service._iam_api_key(iam_api_key: iam_api_key)
+    def _iam_apikey(iam_apikey:)
+      @watson_service._iam_apikey(iam_apikey: iam_apikey)
     end
 
     # @return [DetailedResponse]
diff --git a/lib/ibm_watson/natural_language_classifier_v1.rb b/lib/ibm_watson/natural_language_classifier_v1.rb
@@ -50,7 +50,7 @@ class NaturalLanguageClassifierV1
     #   application locally or outside of Bluemix. When running on
     #   Bluemix, the credentials will be automatically loaded from the
     #   `VCAP_SERVICES` environment variable.
-    # @option args iam_api_key [String] An API key that can be used to request IAM tokens. If
+    # @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.
@@ -66,7 +66,7 @@ def initialize(args = {})
       defaults[:url] = "https://gateway.watsonplatform.net/natural-language-classifier/api"
       defaults[:username] = nil
       defaults[:password] = nil
-      defaults[:iam_api_key] = nil
+      defaults[:iam_apikey] = nil
       defaults[:iam_access_token] = nil
       defaults[:iam_url] = nil
       args = defaults.merge(args)
@@ -75,7 +75,7 @@ def initialize(args = {})
         url: args[:url],
         username: args[:username],
         password: args[:password],
-        iam_api_key: args[:iam_api_key],
+        iam_apikey: args[:iam_apikey],
         iam_access_token: args[:iam_access_token],
         iam_url: args[:iam_url],
         use_vcap_services: true
@@ -91,8 +91,8 @@ def _iam_access_token(iam_access_token:)
       @watson_service._iam_access_token(iam_access_token: iam_access_token)
     end
 
-    def _iam_api_key(iam_api_key:)
-      @watson_service._iam_api_key(iam_api_key: iam_api_key)
+    def _iam_apikey(iam_apikey:)
+      @watson_service._iam_apikey(iam_apikey: iam_apikey)
     end
 
     # @return [DetailedResponse]
diff --git a/lib/ibm_watson/natural_language_understanding_v1.rb b/lib/ibm_watson/natural_language_understanding_v1.rb
@@ -65,7 +65,7 @@ class NaturalLanguageUnderstandingV1
     #   application locally or outside of Bluemix. When running on
     #   Bluemix, the credentials will be automatically loaded from the
     #   `VCAP_SERVICES` environment variable.
-    # @option args iam_api_key [String] An API key that can be used to request IAM tokens. If
+    # @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.
@@ -82,7 +82,7 @@ def initialize(args = {})
       defaults[:url] = "https://gateway.watsonplatform.net/natural-language-understanding/api"
       defaults[:username] = nil
       defaults[:password] = nil
-      defaults[:iam_api_key] = nil
+      defaults[:iam_apikey] = nil
       defaults[:iam_access_token] = nil
       defaults[:iam_url] = nil
       args = defaults.merge(args)
@@ -91,7 +91,7 @@ def initialize(args = {})
         url: args[:url],
         username: args[:username],
         password: args[:password],
-        iam_api_key: args[:iam_api_key],
+        iam_apikey: args[:iam_apikey],
         iam_access_token: args[:iam_access_token],
         iam_url: args[:iam_url],
         use_vcap_services: true
@@ -108,8 +108,8 @@ def _iam_access_token(iam_access_token:)
       @watson_service._iam_access_token(iam_access_token: iam_access_token)
     end
 
-    def _iam_api_key(iam_api_key:)
-      @watson_service._iam_api_key(iam_api_key: iam_api_key)
+    def _iam_apikey(iam_apikey:)
+      @watson_service._iam_apikey(iam_apikey: iam_apikey)
     end
 
     # @return [DetailedResponse]
diff --git a/lib/ibm_watson/personality_insights_v3.rb b/lib/ibm_watson/personality_insights_v3.rb
@@ -76,7 +76,7 @@ class PersonalityInsightsV3
     #   application locally or outside of Bluemix. When running on
     #   Bluemix, the credentials will be automatically loaded from the
     #   `VCAP_SERVICES` environment variable.
-    # @option args iam_api_key [String] An API key that can be used to request IAM tokens. If
+    # @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.
@@ -93,7 +93,7 @@ def initialize(args = {})
       defaults[:url] = "https://gateway.watsonplatform.net/personality-insights/api"
       defaults[:username] = nil
       defaults[:password] = nil
-      defaults[:iam_api_key] = nil
+      defaults[:iam_apikey] = nil
       defaults[:iam_access_token] = nil
       defaults[:iam_url] = nil
       args = defaults.merge(args)
@@ -102,7 +102,7 @@ def initialize(args = {})
         url: args[:url],
         username: args[:username],
         password: args[:password],
-        iam_api_key: args[:iam_api_key],
+        iam_apikey: args[:iam_apikey],
         iam_access_token: args[:iam_access_token],
         iam_url: args[:iam_url],
         use_vcap_services: true
@@ -119,8 +119,8 @@ def _iam_access_token(iam_access_token:)
       @watson_service._iam_access_token(iam_access_token: iam_access_token)
     end
 
-    def _iam_api_key(iam_api_key:)
-      @watson_service._iam_api_key(iam_api_key: iam_api_key)
+    def _iam_apikey(iam_apikey:)
+      @watson_service._iam_apikey(iam_apikey: iam_apikey)
     end
 
     # @return [DetailedResponse]
diff --git a/lib/ibm_watson/speech_to_text_v1.rb b/lib/ibm_watson/speech_to_text_v1.rb
diff --git a/lib/ibm_watson/text_to_speech_v1.rb b/lib/ibm_watson/text_to_speech_v1.rb
diff --git a/lib/ibm_watson/tone_analyzer_v3.rb b/lib/ibm_watson/tone_analyzer_v3.rb
diff --git a/lib/ibm_watson/visual_recognition_v3.rb b/lib/ibm_watson/visual_recognition_v3.rb
diff --git a/lib/ibm_watson/watson_service.rb b/lib/ibm_watson/watson_service.rb
diff --git a/test/integration/test_iam_assistant_v1.rb b/test/integration/test_iam_assistant_v1.rb
diff --git a/test/integration/test_visual_recognition_v3.rb b/test/integration/test_visual_recognition_v3.rb
diff --git a/test/unit/test_iam_token_manager.rb b/test/unit/test_iam_token_manager.rb
diff --git a/test/unit/test_language_translator_v3.rb b/test/unit/test_language_translator_v3.rb

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`
`6`	`6`	`# If using IAM`
`7`	`7`	`assistant = AssistantV1(`
`8`		`- iam_api_key: "IAM API KEY",`
	`8`	`+ iam_apikey: "IAM API KEY",`
`9`	`9`	`version: "2018-02-16"`
`10`	`10`	`)`
`11`	`11`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`
`6`	`6`	`# If using IAM`
`7`	`7`	`discovery = IBMWatson::DiscoveryV1.new(`
`8`		`- iam_api_key: "IAM API KEY",`
	`8`	`+ iam_apikey: "IAM API KEY",`
`9`	`9`	`version: "2018-03-05"`
`10`	`10`	`)`
`11`	`11`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@`
`8`	`8`	`version: "2018-05-31",`
`9`	`9`	`### url is optional, and defaults to the URL below. Use the correct URL for your region.`
`10`	`10`	`# url: "https://gateway.watsonplatform.net/language-translator/api",`
`11`		`- iam_api_key: "your_api_key"`
	`11`	`+ iam_apikey: "your_api_key"`
`12`	`12`	`)`
`13`	`13`
`14`	`14`	`# If you have username & password in your credentials use:`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`
`6`	`6`	`# If using IAM`
`7`	`7`	`natural_language_classifier = IBMWatson::NaturalLanguageClassifierV1.new(`
`8`		`- iam_api_key: "IAM API KEY"`
	`8`	`+ iam_apikey: "IAM API KEY"`
`9`	`9`	`)`
`10`	`10`
`11`	`11`	`# If you have username & password in your credentials use:`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`
`6`	`6`	`# If using IAM`
`7`	`7`	`natural_language_understanding = IBMWatson::NaturalLanguageUnderstandingV1.new(`
`8`		`- iam_api_key: "IAM API KEY",`
	`8`	`+ iam_apikey: "IAM API KEY",`
`9`	`9`	`version: "2018-03-16"`
`10`	`10`	`)`
`11`	`11`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`
`6`	`6`	`# If using IAM`
`7`	`7`	`speech_to_text = IBMWatson::SpeechToTextV1.new(`
`8`		`- iam_api_key: "IAM API KEY"`
	`8`	`+ iam_apikey: "IAM API KEY"`
`9`	`9`	`)`
`10`	`10`
`11`	`11`	`# If you have username & password in your credentials use:`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`
`6`	`6`	`# If using IAM`
`7`	`7`	`text_to_speech = IBMWatson::TextToSpeechV1.new(`
`8`		`- iam_api_key: "IAM API KEY"`
	`8`	`+ iam_apikey: "IAM API KEY"`
`9`	`9`	`)`
`10`	`10`
`11`	`11`	`# If you have username & password in your credentials use:`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`
`6`	`6`	`# If using IAM`
`7`	`7`	`tone_analyzer = ToneAnalyzerV3(`
`8`		`- iam_api_key: "IAM API KEY",`
	`8`	`+ iam_apikey: "IAM API KEY",`
`9`	`9`	`version: "2017-09-21"`
`10`	`10`	`)`
`11`	`11`