Merge pull request #516 from watson-developer-cloud/develop

Release python 4.2.0

Author: ehdsouza

README.md

@@ -83,6 +83,8 @@ Watson services are migrating to token-based Identity and Access Management (IAM
 - In other instances, you authenticate by providing the **[username and password](#username-and-password)** for the service instance.
 - Visual Recognition uses a form of [API key](#api-key) only with instances created before May 23, 2018. Newer instances of Visual Recognition use IAM.
 
+**Note:** Authenticating with the X-Watson-Authorization-Token header is deprecated. The token continues to work with Cloud Foundry services, but is not supported for services that use Identity and Access Management (IAM) authentication. See [here](#iam) for details.
+
 ### Getting credentials
 To find out which authentication to use, view the service credentials. You find the service credentials for authentication the same way for all Watson services:
 

examples/language_translator_v3.py

@@ -50,7 +50,3 @@
 ## Get model details
 # model = language_translator.get_model(model_id='fdadfc3b-0b96-4276-a6e5-f5c4a29711fc')
 # print(json.dumps(model, indent=2))
-
-
-
-

examples/tone_analyzer_v3.py

@@ -2,6 +2,7 @@
 import json
 from os.path import join, dirname
 from watson_developer_cloud import ToneAnalyzerV3
+from watson_developer_cloud.tone_analyzer_v3 import ToneInput
 
 tone_analyzer = ToneAnalyzerV3(
     username='YOUR SERVICE USERNAME',
@@ -55,3 +56,11 @@
 print(tone)
 print(tone.get_headers())
 print(tone.get_result())
+tone_analyzer.set_detailed_response(False)
+
+print("\ntone() example 7:\n")
+tone_input = ToneInput('I am very happy. It is a good day.')
+tone = tone_analyzer.tone(
+    tone_input=tone_input,
+    content_type="application/json")
+print(json.dumps(tone, indent=2))

test/integration/test_discovery_v1.py

@@ -116,3 +116,37 @@ def test_queries(self):
             filter='extracted_metadata.sha1::9181d244*',
             return_fields='extracted_metadata.sha1')
         assert query_results is not None
+
+    def test_credentials(self):
+        credential_details = {
+            'credential_type': 'username_password',
+            'url': 'https://login.salesforce.com',
+            'username': 'user@email.com',
+            'password': 'xxx'
+        }
+        credentials = self.discovery.create_credentials(self.environment_id,
+                                                        'salesforce',
+                                                        credential_details)
+        assert credentials['credential_id'] is not None
+        credential_id = credentials['credential_id']
+
+        get_credentials = self.discovery.get_credentials(self.environment_id, credential_id)
+        assert get_credentials['credential_id'] == credential_id
+
+        list_credentials = self.discovery.list_credentials(self.environment_id)
+        assert list_credentials is not None
+
+        new_credential_details = {
+            'credential_type': 'username_password',
+            'url': 'https://logo.salesforce.com',
+            'username': 'user@email.com',
+            'password': 'xxx'
+        }
+        updated_credentials = self.discovery.update_credentials(self.environment_id, credential_id, 'salesforce', new_credential_details)
+        assert updated_credentials is not None
+
+        get_credentials = self.discovery.get_credentials(self.environment_id, credentials['credential_id'])
+        assert get_credentials['credential_details']['url'] == new_credential_details['url']
+
+        delete_credentials = self.discovery.delete_credentials(self.environment_id, credential_id)
+        assert delete_credentials['credential_id'] is not None

test/unit/test_discovery_v1.py

@@ -214,6 +214,45 @@ def test_collection():
                                      collection_id='collid')
     assert len(responses.calls) == 5
 
+@responses.activate
+def test_federated_query():
+    discovery_url = urljoin(base_discovery_url,
+                            'environments/envid/query')
+
+    responses.add(responses.GET, discovery_url,
+                  body="{\"body\": \"hello\"}", status=200,
+                  content_type='application/json')
+    discovery = watson_developer_cloud.DiscoveryV1('2016-11-07',
+                                                   username='username',
+                                                   password='password')
+    discovery.federated_query('envid', ['collid1', 'collid2'], filter='colls.sha1::9181d244*')
+
+    called_url = urlparse(responses.calls[0].request.url)
+    test_url = urlparse(discovery_url)
+
+    assert called_url.netloc == test_url.netloc
+    assert called_url.path == test_url.path
+    assert len(responses.calls) == 1
+
+@responses.activate
+def test_federated_query_notices():
+    discovery_url = urljoin(base_discovery_url,
+                            'environments/envid/notices')
+
+    responses.add(responses.GET, discovery_url,
+                  body="{\"body\": \"hello\"}", status=200,
+                  content_type='application/json')
+    discovery = watson_developer_cloud.DiscoveryV1('2016-11-07',
+                                                   username='username',
+                                                   password='password')
+    discovery.federated_query_notices('envid', ['collid1', 'collid2'], filter='notices.sha1::9181d244*')
+
+    called_url = urlparse(responses.calls[0].request.url)
+    test_url = urlparse(discovery_url)
+
+    assert called_url.netloc == test_url.netloc
+    assert called_url.path == test_url.path
+    assert len(responses.calls) == 1
 
 @responses.activate
 def test_query():
@@ -226,7 +265,12 @@ def test_query():
     discovery = watson_developer_cloud.DiscoveryV1('2016-11-07',
                                                    username='username',
                                                    password='password')
-    discovery.query('envid', 'collid', {'count': 10})
+    discovery.query('envid', 'collid',
+                    filter='extracted_metadata.sha1::9181d244*',
+                    count=1,
+                    passages=True,
+                    passages_fields=['x', 'y'],
+                    passages_count=2)
 
     called_url = urlparse(responses.calls[0].request.url)
     test_url = urlparse(discovery_url)
@@ -282,6 +326,29 @@ def test_query_entities():
     assert called_url.path == test_url.path
     assert len(responses.calls) == 1
 
+@responses.activate
+def test_query_notices():
+    discovery_url = urljoin(
+        base_discovery_url,
+        'environments/envid/collections/collid/notices')
+
+    responses.add(
+        responses.GET,
+        discovery_url,
+        body="{\"body\": \"hello\"}",
+        status=200,
+        content_type='application/json')
+
+    discovery = watson_developer_cloud.DiscoveryV1(
+        '2016-11-07', username='username', password='password')
+
+    discovery.query_notices('envid', 'collid', filter='notices.sha1::*')
+    called_url = urlparse(responses.calls[0].request.url)
+    test_url = urlparse(discovery_url)
+    assert called_url.netloc == test_url.netloc
+    assert called_url.path == test_url.path
+    assert len(responses.calls) == 1
+
 @responses.activate
 def test_configs():
     discovery_url = urljoin(base_discovery_url,
@@ -327,13 +394,20 @@ def test_configs():
 
     discovery.create_configuration(environment_id='envid',
                                    name='my name')
+    discovery.create_configuration(environment_id='envid',
+                                   name='my name',
+                                   source={'type': 'salesforce', 'credential_id': 'xxx'})
     discovery.update_configuration(environment_id='envid',
                                    configuration_id='confid',
                                    name='my new name')
+    discovery.update_configuration(environment_id='envid',
+                                   configuration_id='confid',
+                                   name='my new name',
+                                   source={'type': 'salesforce', 'credential_id': 'xxx'})
     discovery.delete_configuration(environment_id='envid',
                                    configuration_id='confid')
 
-    assert len(responses.calls) == 5
+    assert len(responses.calls) == 7
 
 
 @responses.activate
@@ -815,3 +889,65 @@ def test_delete_user_data():
     response = discovery.delete_user_data('id')
     assert response is None
     assert len(responses.calls) == 1
+
+@responses.activate
+def test_credentials():
+    discovery_credentials_url = urljoin(base_discovery_url, 'environments/envid/credentials')
+
+    results = {'credential_id': 'e68305ce-29f3-48ea-b829-06653ca0fdef',
+               'source_type': 'salesforce',
+               'credential_details': {
+                   'url': 'https://login.salesforce.com',
+                   'credential_type': 'username_password',
+                   'username':'user@email.com'}
+              }
+
+    iam_url = "https://iam.bluemix.net/identity/token"
+    iam_token_response = """{
+        "access_token": "oAeisG8yqPY7sFR_x66Z15",
+        "token_type": "Bearer",
+        "expires_in": 3600,
+        "expiration": 1524167011,
+        "refresh_token": "jy4gl91BQ"
+    }"""
+    responses.add(responses.POST, url=iam_url, body=iam_token_response, status=200)
+    responses.add(responses.GET, "{0}/{1}?version=2016-11-07".format(discovery_credentials_url, 'credential_id'),
+                  body=json.dumps(results),
+                  status=200,
+                  content_type='application/json')
+    responses.add(responses.GET, "{0}?version=2016-11-07".format(discovery_credentials_url),
+                  body=json.dumps([results]),
+                  status=200,
+                  content_type='application/json')
+
+    responses.add(responses.POST, "{0}?version=2016-11-07".format(discovery_credentials_url),
+                  body=json.dumps(results),
+                  status=200,
+                  content_type='application/json')
+    results['source_type'] = 'ibm'
+    responses.add(responses.PUT, "{0}/{1}?version=2016-11-07".format(discovery_credentials_url, 'credential_id'),
+                  body=json.dumps(results),
+                  status=200,
+                  content_type='application/json')
+    responses.add(responses.DELETE, "{0}/{1}?version=2016-11-07".format(discovery_credentials_url, 'credential_id'),
+                  body=json.dumps({'deleted': 'bogus -- ok'}),
+                  status=200,
+                  content_type='application/json')
+
+    discovery = watson_developer_cloud.DiscoveryV1('2016-11-07',
+                                                   iam_api_key='iam_api_key')
+    discovery.create_credentials('envid', 'salesforce', {
+        'url': 'https://login.salesforce.com',
+        'credential_type': 'username_password',
+        'username':'user@email.com'
+        })
+
+    discovery.get_credentials('envid', 'credential_id')
+
+    discovery.update_credentials(environment_id='envid',
+                                 credential_id='credential_id',
+                                 source_type='salesforce',
+                                 credential_details=results['credential_details'])
+    discovery.list_credentials('envid')
+    discovery.delete_credentials(environment_id='envid', credential_id='credential_id')
+    assert len(responses.calls) == 10

test/unit/test_watson_service.py

@@ -131,3 +131,19 @@ def test_iam():
                   content_type='application/json')
     service.any_service_call()
     assert "grant_type=refresh_token" in responses.calls[0].request.body
+
+@responses.activate
+def test_when_apikey_is_username():
+    service1 = AnyServiceV1('2017-07-07', username='apikey', password='xxxxx')
+    assert service1.token_manager is not None
+    assert service1.iam_api_key is 'xxxxx'
+    assert service1.username is None
+    assert service1.password is None
+    assert service1.token_manager.iam_url == 'https://iam.bluemix.net/identity/token'
+
+    service2 = AnyServiceV1('2017-07-07', username='apikey', password='xxxxx', iam_url='https://iam.stage1.bluemix.net/identity/token')
+    assert service2.token_manager is not None
+    assert service2.iam_api_key is 'xxxxx'
+    assert service2.username is None
+    assert service2.password is None
+    assert service2.token_manager.iam_url == 'https://iam.stage1.bluemix.net/identity/token'

watson_developer_cloud/assistant_v1.py

@@ -1469,7 +1469,7 @@ def create_value(self,
         - It must be no longer than 64 characters.
         :param list[str] patterns: An array of patterns for the entity value. You can
         provide either synonyms or patterns (as indicated by **type**), but not both. A
-        pattern is a regular expression no longer than 128 characters. For more
+        pattern is a regular expression no longer than 512 characters. For more
         information about how to specify a pattern, see the
         [documentation](https://console.bluemix.net/docs/services/conversation/entities.html#creating-entities).
         :param str value_type: Specifies the type of value.
@@ -1688,7 +1688,7 @@ def update_value(self,
         - It must be no longer than 64 characters.
         :param list[str] new_patterns: An array of patterns for the entity value. You can
         provide either synonyms or patterns (as indicated by **type**), but not both. A
-        pattern is a regular expression no longer than 128 characters. For more
+        pattern is a regular expression no longer than 512 characters. For more
         information about how to specify a pattern, see the
         [documentation](https://console.bluemix.net/docs/services/conversation/entities.html#creating-entities).
         :param dict headers: A `dict` containing the request headers
@@ -3257,7 +3257,7 @@ class CreateValue(object):
     - It must be no longer than 64 characters.
     :attr list[str] patterns: (optional) An array of patterns for the entity value. You
     can provide either synonyms or patterns (as indicated by **type**), but not both. A
-    pattern is a regular expression no longer than 128 characters. For more information
+    pattern is a regular expression no longer than 512 characters. For more information
     about how to specify a pattern, see the
     [documentation](https://console.bluemix.net/docs/services/conversation/entities.html#creating-entities).
     :attr str value_type: (optional) Specifies the type of value.
@@ -3286,7 +3286,7 @@ def __init__(self,
         - It must be no longer than 64 characters.
         :param list[str] patterns: (optional) An array of patterns for the entity value.
         You can provide either synonyms or patterns (as indicated by **type**), but not
-        both. A pattern is a regular expression no longer than 128 characters. For more
+        both. A pattern is a regular expression no longer than 512 characters. For more
         information about how to specify a pattern, see the
         [documentation](https://console.bluemix.net/docs/services/conversation/entities.html#creating-entities).
         :param str value_type: (optional) Specifies the type of value.

watson_developer_cloud/conversation_v1.py

@@ -1469,7 +1469,7 @@ def create_value(self,
         - It must be no longer than 64 characters.
         :param list[str] patterns: An array of patterns for the entity value. You can
         provide either synonyms or patterns (as indicated by **type**), but not both. A
-        pattern is a regular expression no longer than 128 characters. For more
+        pattern is a regular expression no longer than 512 characters. For more
         information about how to specify a pattern, see the
         [documentation](https://console.bluemix.net/docs/services/conversation/entities.html#creating-entities).
         :param str value_type: Specifies the type of value.
@@ -1688,7 +1688,7 @@ def update_value(self,
         - It must be no longer than 64 characters.
         :param list[str] new_patterns: An array of patterns for the entity value. You can
         provide either synonyms or patterns (as indicated by **type**), but not both. A
-        pattern is a regular expression no longer than 128 characters. For more
+        pattern is a regular expression no longer than 512 characters. For more
         information about how to specify a pattern, see the
         [documentation](https://console.bluemix.net/docs/services/conversation/entities.html#creating-entities).
         :param dict headers: A `dict` containing the request headers
@@ -3257,7 +3257,7 @@ class CreateValue(object):
     - It must be no longer than 64 characters.
     :attr list[str] patterns: (optional) An array of patterns for the entity value. You
     can provide either synonyms or patterns (as indicated by **type**), but not both. A
-    pattern is a regular expression no longer than 128 characters. For more information
+    pattern is a regular expression no longer than 512 characters. For more information
     about how to specify a pattern, see the
     [documentation](https://console.bluemix.net/docs/services/conversation/entities.html#creating-entities).
     :attr str value_type: (optional) Specifies the type of value.
@@ -3286,7 +3286,7 @@ def __init__(self,
         - It must be no longer than 64 characters.
         :param list[str] patterns: (optional) An array of patterns for the entity value.
         You can provide either synonyms or patterns (as indicated by **type**), but not
-        both. A pattern is a regular expression no longer than 128 characters. For more
+        both. A pattern is a regular expression no longer than 512 characters. For more
         information about how to specify a pattern, see the
         [documentation](https://console.bluemix.net/docs/services/conversation/entities.html#creating-entities).
         :param str value_type: (optional) Specifies the type of value.