Merge pull request #87 from watson-developer-cloud/docs/transaction-id

docs: add instructions to get transaction id

Author: mamoonraja

README.md

@@ -267,6 +267,28 @@ Headers: "<http response headers>"
 Result: "<response returned by service>"
 ```
 
+### Transaction IDs
+
+Every SDK call will return a response which will contain a transaction ID, accessible via the `x-global-transaction-id` header. This transaction ID is useful for troubleshooting and accessing relevant logs from your service instance.
+
+```ruby
+require "ibm_watson"
+include IBMWatson
+
+assistant = AssistantV1.new(
+  authenticator: "<authenticator>"
+  version: "2017-04-21"
+)
+
+begin
+  response = assistant.list_workspaces
+  p "Global transaction id: #{response.headers["X-Global-Transaction-Id"]}"
+rescue IBMCloudSdkCore::ApiException => e
+  # Global transaction on failed api call is contained in the error message
+  print "Error: ##{e}"
+end
+```
+
 ## Configuring the HTTP client
 
 To set client configs like timeout or proxy use the `configure_http_client` function and pass in the configurations.
@@ -399,4 +421,4 @@ We'd love to highlight cool open-source projects that use this SDK! If you'd lik
 [license]: http://www.apache.org/licenses/LICENSE-2.0
 [vcap_services]: https://cloud.ibm.com/docs/services/watson?topic=watson-vcapServices
 [ibm-cloud-onboarding]: http://cloud.ibm.com/registration?target=/developer/watson&cm_sp=WatsonPlatform-WatsonServices-_-OnPageNavLink-IBMWatson_SDKs-_-Ruby
-[ivar]: http://ruby-concurrency.github.io/concurrent-ruby/Concurrent/IVar.html
+[ivar]: http://ruby-concurrency.github.io/concurrent-ruby/Concurrent/IVar.html

ibm_watson.gemspec

@@ -36,7 +36,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "eventmachine", "~> 1.2"
   spec.add_runtime_dependency "faye-websocket", "~> 0.10"
   spec.add_runtime_dependency "http", "~> 4.1.0"
-  spec.add_runtime_dependency "ibm_cloud_sdk_core", "~> 1.1"
+  spec.add_runtime_dependency "ibm_cloud_sdk_core", "~> 1.1.1"
   spec.add_runtime_dependency "jwt", "~> 2.2.1"
 
   spec.add_development_dependency "bundler", "~> 1.16"

resources/vcap-testing.json

@@ -3,7 +3,7 @@
   	{
   		"credentials": {
   			"password": "password",
-  			"url": "https://gateway.watsonplatform.net/personality-insights/api",
+  			"url": "https://gateway-wdc.watsonplatform.net/personality-insights/api",
   			"username": "username"
   		},
   		"label": "personality",

test/unit/test_personality_insights_v3.rb

@@ -33,6 +33,7 @@ def test_plain_to_json
       version: "2017-10-13",
       authenticator: authenticator
     )
+    service.service_url = "https://gateway.watsonplatform.net/personality-insights/api"
     service_response = service.profile(
       accept: "application/json",
       content: personality_text,
@@ -88,6 +89,7 @@ def test_json_to_json
       version: "2017-10-13",
       authenticator: authenticator
     )
+    service.service_url = "https://gateway.watsonplatform.net/personality-insights/api"
     service_response = service.profile(
       accept: "application/json",
       content: personality_text,
@@ -128,6 +130,7 @@ def test_json_to_csv
       version: "2017-10-13",
       authenticator: authenticator
     )
+    service.service_url = "https://gateway.watsonplatform.net/personality-insights/api"
     service_response = service.profile(
       content: personality_text,
       content_type: "application/json",
@@ -171,6 +174,7 @@ def test_plain_to_json_es
       version: "2017-10-13",
       authenticator: authenticator
     )
+    service.service_url = "https://gateway.watsonplatform.net/personality-insights/api"
     service_response = service.profile(
       accept: "application/json",
       content: personality_text,

test/unit/test_vcap_using_personality_insights.rb

@@ -17,14 +17,14 @@ def test_plain_to_json
       "Content-Type" => "application/json"
     }
     expected_response = IBMWatson::DetailedResponse.new(status: 200, body: JSON.parse(profile_response), headers: headers)
-    stub_request(:post, "https://gateway.watsonplatform.net/personality-insights/api/v3/profile?version=2017-10-13")
+    stub_request(:post, "https://gateway-wdc.watsonplatform.net/personality-insights/api/v3/profile?version=2017-10-13")
       .with(
         body: personality_text,
         headers: {
           "Accept" => "application/json",
           "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
           "Content-Type" => "text/plain;charset=utf-8",
-          "Host" => "gateway.watsonplatform.net"
+          "Host" => "gateway-wdc.watsonplatform.net"
         }
       ).to_return(status: 200, body: profile_response, headers: headers)
     authenticator = IBMWatson::Authenticators::ConfigBasedAuthenticatorFactory.new.get_authenticator(service_name: "sample_service")
@@ -52,14 +52,14 @@ def test_json_to_json
       "Content-Type" => "applicaiton/json"
     }
     expected_response = IBMWatson::DetailedResponse.new(status: 200, body: profile_response, headers: headers)
-    stub_request(:post, "https://gateway.watsonplatform.net/personality-insights/api/v3/profile?consumption_preferences=true&raw_scores=true&version=2017-10-13")
+    stub_request(:post, "https://gateway-wdc.watsonplatform.net/personality-insights/api/v3/profile?consumption_preferences=true&raw_scores=true&version=2017-10-13")
       .with(
         body: personality_text,
         headers: {
           "Accept" => "application/json",
           "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
           "Content-Type" => "application/json",
-          "Host" => "gateway.watsonplatform.net"
+          "Host" => "gateway-wdc.watsonplatform.net"
         }
       ).to_return(status: 200, body: profile_response, headers: headers)
     authenticator = IBMWatson::Authenticators::ConfigBasedAuthenticatorFactory.new.get_authenticator(service_name: "sample_service")
@@ -89,14 +89,14 @@ def test_json_to_csv
       "Content-Type" => "text/csv"
     }
     expected_response = IBMWatson::DetailedResponse.new(status: 200, body: profile_response, headers: headers)
-    stub_request(:post, "https://gateway.watsonplatform.net/personality-insights/api/v3/profile?consumption_preferences=true&csv_headers=true&raw_scores=true&version=2017-10-13")
+    stub_request(:post, "https://gateway-wdc.watsonplatform.net/personality-insights/api/v3/profile?consumption_preferences=true&csv_headers=true&raw_scores=true&version=2017-10-13")
       .with(
         body: personality_text,
         headers: {
           "Accept" => "text/csv",
           "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
           "Content-Type" => "application/json",
-          "Host" => "gateway.watsonplatform.net"
+          "Host" => "gateway-wdc.watsonplatform.net"
         }
       ).to_return(status: 200, body: profile_response, headers: headers)
     authenticator = IBMWatson::Authenticators::ConfigBasedAuthenticatorFactory.new.get_authenticator(service_name: "sample_service")
@@ -127,7 +127,7 @@ def test_plain_to_json_es
       "Content-Type" => "application/json"
     }
     expected_response = IBMWatson::DetailedResponse.new(status: 200, body: profile_response, headers: headers)
-    stub_request(:post, "https://gateway.watsonplatform.net/personality-insights/api/v3/profile?version=2017-10-13")
+    stub_request(:post, "https://gateway-wdc.watsonplatform.net/personality-insights/api/v3/profile?version=2017-10-13")
       .with(
         body: personality_text,
         headers: {
@@ -136,7 +136,7 @@ def test_plain_to_json_es
           "Authorization" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
           "Content-Language" => "es",
           "Content-Type" => "text/plain;charset=utf-8",
-          "Host" => "gateway.watsonplatform.net"
+          "Host" => "gateway-wdc.watsonplatform.net"
         }
       ).to_return(status: 200, body: profile_response.to_json, headers: headers)
     authenticator = IBMWatson::Authenticators::ConfigBasedAuthenticatorFactory.new.get_authenticator(service_name: "sample_service")