AzureAD · rayluo · Jun 4, 2018 · May 24, 2018 · May 24, 2018 · May 29, 2018
diff --git a/README.md b/README.md
@@ -1,72 +1,33 @@
 # Microsoft Azure Active Directory Authentication Library (ADAL) for Python
 
-The ADAL for python library makes it easy for python applications to authenticate to AAD in order to access AAD protected web resources.
+ `master` branch    | `dev` branch    | Reference Docs
+--------------------|-----------------|---------------
+[![Build Status](https://travis-ci.org/AzureAD/azure-activedirectory-library-for-python.svg?branch=master)](https://travis-ci.org/AzureAD/azure-activedirectory-library-for-python) | [![Build Status](https://travis-ci.org/AzureAD/azure-activedirectory-library-for-python.svg?branch=dev)](https://travis-ci.org/AzureAD/azure-activedirectory-library-for-python) | [![Documentation Status](https://readthedocs.org/projects/adal-python/badge/?version=latest)](https://adal-python.readthedocs.io/en/latest/?badge=latest)
 
-## Usage
+|[Getting Started](https://github.com/AzureAD/azure-activedirectory-library-for-python/wiki)| [Docs](https://aka.ms/aaddev)| [Samples](https://github.com/azure-samples?query=active-directory)| [Support](README.md#community-help-and-support)
+| --- | --- | --- | --- |
 
-### Install
 
-To support 'service principal' with certificate, ADAL depends on the 'cryptography' package. For smooth installation, some suggestions:
+The ADAL for Python library enables python applications to authenticate with Azure AD and get tokens to access Azure AD protected web resources.
 
-* For Windows and macOS
+You can learn in detail about ADAL Python functionality and usage documented in the [Wiki](https://github.com/AzureAD/azure-activedirectory-library-for-python/wiki).
 
-  Upgrade to the latest pip (8.1.2 as of June 2016) and just do `pip install adal`.
+## Installation and Usage
 
-* For Linux
+You can find the steps to install and basic usage of the library under [ADAL Basics](https://github.com/AzureAD/azure-activedirectory-library-for-python/wiki/ADAL-basics) page in the Wiki.
 
-  Upgrade to the latest pip (8.1.2 as of June 2016).
-
-  You'll need a C compiler, libffi + its development headers, and openssl + its development headers.
-  Refer to [cryptography installation](https://cryptography.io/en/latest/installation/)
-
-* To install from source:
-
-  Upgrade to the latest pip (8.1.2 as of June 2016).
-  To avoid dealing with compilation errors from cryptography, first run `pip install cryptography` to use statically-linked wheels.
-  Next, run `python setup.py install`
-
-  If you still like to build from source, refer to [cryptography installation](https://cryptography.io/en/latest/installation/).
-  For more context, start with this [stackoverflow thread](http://stackoverflow.com/questions/22073516/failed-to-install-python-cryptography-package-with-pip-and-setup-py).
-
-### Acquire Token with Client Credentials
-
-In order to use this token acquisition method, you need to configure a service principal. Please follow [this walkthrough](https://azure.microsoft.com/en-us/documentation/articles/resource-group-create-service-principal-portal/).
-
-Find the `Main logic` part in the [sample](sample/client_credentials_sample.py#L46-L55).
-
-### Acquire Token with client certificate
-A service principal is also required.
-Find the `Main logic` part in the [sample](sample/certificate_credentials_sample.py#L55-L64).
-
-### Acquire Token with Refresh Token
-Find the `Main logic` part in the [sample](sample/refresh_token_sample.py#L47-L69).
-
-### Acquire Token with device code
-Find the `Main logic` part in the [sample](sample/device_code_sample.py#L49-L54).
-
-### Acquire Token with authorization code
-Find the `Main logic` part in the [sample](sample/website_sample.py#L107-L115) for a complete bare bones web site that makes use of the code below.
-
-## Logging
-
-#### Personal Identifiable Information (PII) & Organizational Identifiable Information (OII)
-
-Starting from ADAL Python 0.5.1, by default, ADAL logging does not capture or log any PII or OII.  The library allows app developers to turn this on by configuring the `enable_pii` flag on the AuthenticationContext. By turning on PII or OII, the app takes responsibility for safely handling highly-sensitive data and complying with any regulatory requirements.
+## Samples and Documentation
+We provide a full suite of [sample applications on GitHub](https://github.com/azure-samples?utf8=%E2%9C%93&q=active-directory&type=&language=) to help you get started with learning the Azure Identity system. This includes tutorials for native clients and web applications. We also provide full walkthroughs for authentication flows such as OAuth2, OpenID Connect and for calling APIs such as the Graph API.
 
-```python
-//PII or OII logging disabled. Default Logger does not capture any PII or OII.
-auth_context = AuthenticationContext(...)
+You can find the relevant samples by scenarios listed in this [wiki page for acquiring tokens using ADAL Python](https://github.com/AzureAD/azure-activedirectory-library-for-python/wiki/Acquire-tokens#adal-python-apis-for-corresponding-flows).
 
-//PII or OII logging enabled
-auth_context = AuthenticationContext(..., enable_pii=True)
-```
+The documents on [Auth Scenarios](https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-authentication-scenarios#application-types-and-scenarios) and [Auth protocols](https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-protocols-openid-connect-code) are recommended reading.
 
-## Samples and Documentation
-We provide a full suite of [sample applications on GitHub](https://github.com/azure-samples?utf8=%E2%9C%93&q=active-directory&type=&language=) and an [Azure AD developer landing page](https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-developers-guide) to help you get started with learning the Azure Identity system. This includes tutorials for native clients and web applications. We also provide full walkthroughs for authentication flows such as OAuth2, OpenID Connect and for calling APIs such as the Graph API.
+## Versions
 
-It is recommended to read the [Auth Scenarios](https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-authentication-scenarios) doc, specifically the [Scenarios section](https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-authentication-scenarios#application-types-and-scenarios).  For some topics about registering/integrating an app, checkout [this doc](https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-integrating-applications).  And finally, we have a great topic on the Auth protocols you would be using and how they play with Azure AD in [this doc](https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-protocols-openid-connect-code).
+This library follows [Semantic Versioning](http://semver.org/).
 
-While Python-specific samples will be added into the aforementioned documents as an on-going effort, you can always find [most relevant samples just inside this library repo](https://github.com/AzureAD/azure-activedirectory-library-for-python/tree/dev/sample).
+You can find the changes for each version under [Releases](https://github.com/AzureAD/azure-activedirectory-library-for-python/releases).
 
 ## Community Help and Support
 
@@ -80,29 +41,8 @@ If you find a security issue with our libraries or services please report it to
 
 ## Contributing
 
-All code is licensed under the MIT license and we triage actively on GitHub. We enthusiastically welcome contributions and feedback. You can clone the repo and start contributing now.
+All code is licensed under the MIT license and we triage actively on GitHub. We enthusiastically welcome contributions and feedback. Please read the [contributing guide](./contributing.md) before starting.
 
 ## We Value and Adhere to the Microsoft Open Source Code of Conduct
 
 This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
-
-## Quick Start
-
-### Installation
-
-``` $ pip install adal ```
-
-### http tracing/proxy
-If you need to bypass self-signed certificates, turn on the environment variable of `ADAL_PYTHON_SSL_NO_VERIFY`
-
-
-## Note
-
-### Changes on 'client_id' and 'resource' arguments after 0.1.0
-The convenient methods in 0.1.0 have been removed, and now your application should provide parameter values to `client_id` and `resource`.
-
-2 Reasons:
-
-* Each adal client should have an Application ID representing a valid application registered in a tenant. The old methods borrowed the client-id of [azure-cli](https://github.com/Azure/azure-xplat-cli), which is never right. It is simple to register your application and get a client id. You can follow [this walkthrough](https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-integrating-applications). Do check out if you are new to AAD.
-
-* The old method defaults the `resource` argument to 'https://management.core.windows.net/', now you can just supply this value explictly. Please note, there are lots of different azure resources you can acquire tokens through adal though, for example, the samples in the repository acquire for the 'graph' resource. Because it is not an appropriate assumption to be made at the library level, we removed the old defaults.
diff --git a/adal/__init__.py b/adal/__init__.py
@@ -27,7 +27,7 @@
 
 # pylint: disable=wrong-import-position
 
-__version__ = '0.6.0'
+__version__ = '1.0.0'
 
 import logging
 

diff --git a/adal/authentication_context.py b/adal/authentication_context.py
@@ -47,7 +47,7 @@ class AuthenticationContext(object):
 
     def __init__(
             self, authority, validate_authority=None, cache=None,
-            api_version='1.0', timeout=None, enable_pii=False, verify_ssl=None, proxies=None):
+            api_version=None, timeout=None, enable_pii=False, verify_ssl=None, proxies=None):
         '''Creates a new AuthenticationContext object.
 
         By default the authority will be checked against a list of known Azure
@@ -68,9 +68,9 @@ def __init__(
             AuthenticationContexts.
         :param api_version: (optional) Specifies API version using on the wire.
             Historically it has a hardcoded default value as "1.0".
-            Developers are now encouraged to set it as None explicitly,
+            Developers have been encouraged to set it as None explicitly,
             which means the underlying API version will be automatically chosen.
-            In next major release, this default value will be changed to None.
+            Starting from ADAL Python 1.0, this default value becomes None.
         :param timeout: (optional) requests timeout. How long to wait for the server to send
             data before giving up, as a float, or a `(connect timeout,
             read timeout) <timeouts>` tuple.

diff --git a/adal/token_request.py b/adal/token_request.py
@@ -335,7 +335,6 @@ def get_token_with_authorization_code(self, authorization_code, client_secret, c
         self._cache_driver.add(token)
         return token
 
-
     def _get_token_with_refresh_token(self, refresh_token, resource, client_secret):
 
         self._log.info("Getting a new token from a refresh token")

diff --git a/sample/certificate_credentials_sample.py b/sample/certificate_credentials_sample.py
@@ -57,7 +57,7 @@ def get_private_key(filename):
 turn_on_logging()
 
 ### Main logic begins
-context = adal.AuthenticationContext(authority_url, api_version=None)
+context = adal.AuthenticationContext(authority_url)
 key = get_private_key(sample_parameters['privateKeyFile'])
 
 token = context.acquire_token_with_client_certificate(

diff --git a/sample/client_credentials_sample.py b/sample/client_credentials_sample.py
@@ -50,7 +50,7 @@ def turn_on_logging():
 ### Main logic begins
 context = adal.AuthenticationContext(
     authority_url, validate_authority=sample_parameters['tenant'] != 'adfs',
-    api_version=None)
+    )
 
 token = context.acquire_token_with_client_credentials(
     RESOURCE,

diff --git a/sample/device_code_sample.py b/sample/device_code_sample.py
@@ -51,7 +51,7 @@ def turn_on_logging():
 #turn_on_logging()
 
 ### Main logic begins
-context = adal.AuthenticationContext(authority_url, api_version=None)
+context = adal.AuthenticationContext(authority_url)
 code = context.acquire_user_code(RESOURCE, clientid)
 print(code['message'])
 token = context.acquire_token_with_device_code(RESOURCE, code, clientid)

diff --git a/sample/refresh_token_sample.py b/sample/refresh_token_sample.py
@@ -51,7 +51,7 @@ def turn_on_logging():
 ### Main logic begins
 context = adal.AuthenticationContext(
     authority_url, validate_authority=sample_parameters['tenant'] != 'adfs',
-    api_version=None)
+    )
 
 token = context.acquire_token_with_username_password(
     RESOURCE,

diff --git a/sample/website_sample.py b/sample/website_sample.py
@@ -88,7 +88,7 @@ def do_GET(self):
                 token_response = self._acquire_token()
                 message = 'response: ' + json.dumps(token_response)
                 #Later, if the access token is expired it can be refreshed.
-                auth_context = AuthenticationContext(authority_url, api_version=None)
+                auth_context = AuthenticationContext(authority_url)
                 token_response = auth_context.acquire_token_with_refresh_token(
                     token_response['refreshToken'],
                     sample_parameters['clientId'],
@@ -109,7 +109,7 @@ def _acquire_token(self):
         if state != cookie['auth_state'].value:
             raise ValueError('state does not match')
         ### Main logic begins
-        auth_context = AuthenticationContext(authority_url, api_version=None)
+        auth_context = AuthenticationContext(authority_url)
         return auth_context.acquire_token_with_authorization_code(
             code,
             REDIRECT_URI,

diff --git a/tests/test_api_version.py b/tests/test_api_version.py
@@ -45,7 +45,8 @@ def test_api_version_default_value(self):
             warnings.simplefilter("always")
             context = adal.AuthenticationContext(
                 "https://login.windows.net/tenant")
-            self.assertEqual(context._call_context['api_version'], '1.0')
+            self.assertEqual(context._call_context['api_version'], None)
+            self.assertEqual(len(caught_warnings), 0)
             if len(caught_warnings) == 1:
                 # It should be len(caught_warnings)==1, but somehow it works on
                 # all my local test environment but not on Travis-CI.

diff --git a/tests/util.py b/tests/util.py
@@ -374,7 +374,7 @@ def val_exists(val):
 def match_standard_request_headers(mock_request):
     matches = []
     matches.append(mock_request.headers.get('x-client-SKU', None) == 'Python')
-    matches.append(mock_request.headers.get('x-client-Ver', "").startswith('0.'))
+    assert mock_request.headers.get('x-client-Ver') is not None
     matches.append(mock_request.headers.get('x-client-OS', None) != None)
     matches.append(mock_request.headers.get('x-client-CPU', None) != None)
     request_id = correlation_id_regex.match(mock_request.headers.get('client-request-id'))