Package: dropbox-test-api
Getting startedAPI for testing OAuth2 with DropboxHow to BuildYou must have Python2 >=2.7.9or Python3 >=3.4installed on your system to install and run this SDK. This SDK package depends on other Python packages like nose, jsonpickle etc.
These dependencies are defined in therequirements.txtfile that comes with the SDK.
To resolve these dependencies, you can use the PIP Dependency manager. Install it by following steps athttps://pip.pypa.io/en/stable/installing/.Python and PIP executables should be defined in your PATH. Open command prompt and typepip --version.
This should display the version of the PIP Dependency Manager installed if your installation was successful and the paths are properly defined.Using command line, navigate to the directory containing the generated files (includingrequirements.txt) for the SDK.Run the commandpip install -r requirements.txt. This should install all the required dependencies.How to UseThe following section explains how to use the DropboxTestApi SDK package in a new project.1. Open Project in an IDEOpen up a Python IDE like PyCharm. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.Click onOpenin PyCharm to browse to your generated SDK directory and then clickOK.The project files will be displayed in the side bar as follows:2. Add a new Test ProjectCreate a new directory by right clicking on the solution name as shown below:Name the directory as "test"Add a python file to this project with the name "testsdk"Name it "testsdk"In your python file you will be required to import the generated python library using the following code linesfromdropbox_test_api.dropbox_test_api_clientimportDropboxTestApiClientAfter this you can write code to instantiate an API client object, get a controller object and  make API calls. Sample code is given in the subsequent sections.3. Run the Test ProjectTo run the file within your test project, right click on your Python file inside your Test project and click onRunHow to TestYou can test the generated SDK and the server with automatically generated test
cases. unittest is used as the testing framework and nose is used as the test
runner. You can run the tests as follows:From terminal/cmd navigate to the root directory of the SDK.Invokepip install -r test-requirements.txtInvokenosetestsInitializationAuthenticationIn order to setup authentication and initialization of the API client, you need the following information.ParameterDescriptiono_auth_client_idOAuth 2 Client IDo_auth_client_secretOAuth 2 Client Secreto_auth_redirect_uriOAuth 2 Redirection endpoint or Callback UriAPI client can be initialized as following.# Configuration parameters and credentialso_auth_client_id='o_auth_client_id'# OAuth 2 Client IDo_auth_client_secret='o_auth_client_secret'# OAuth 2 Client Secreto_auth_redirect_uri='o_auth_redirect_uri'# OAuth 2 Redirection endpoint or Callback Uriclient=DropboxTestApiClient(o_auth_client_id,o_auth_client_secret,o_auth_redirect_uri)You must now authorize the client.Authorizing your clientYour application must obtain user authorization before it can execute an endpoint call.
The SDK usesOAuth 2.0 authorizationto obtain a user's consent to perform an API request on the user's behalf.1. Obtain user consentTo obtain user's consent, you must redirect the user to the authorization page. Theget_authorization_url()method creates the URL to the authorization page.auth_url=client.auth.get_authorization_url()2. Handle the OAuth server responseOnce the user responds to the consent request, the OAuth 2.0 server responds to your application's access request by redirecting the user to your redirect URI.If the user approves the request, the authorization code will be sent as thecodequery string:https://example.com/oauth/callback?code=XXXXXXXXXXXXXXXXXXXXXXXXXIf the user does not approve the request, the response contains anerrorquery string:https://example.com/oauth/callback?error=access_denied3. Authorize the client using the codeAfter the server receives the code, it can exchange this for anaccess token. The access token is an object containing information for authorizing client requests and refreshing the token itself.try:client.auth.authorize('code')exceptOAuthProviderExceptionasex:# handle exceptionRefreshing tokenAn access token may expire after some time. To extend its lifetime, you must refresh the token.ifclient.auth.token_expired():try:client.auth.refresh_token()exceptOAuthProviderExceptionasex:# handle exceptionIf a token expires, the SDK will attempt to automatically refresh the token before the next endpoint call requiring authentication.Storing an access token for reuseIt is recommended that you store the access token for reuse.You can store the access token in a file or a database.# store tokensave_token_to_database(client.config.o_auth_token)However, since the the SDK will attempt to automatically refresh the token when it expires, it is recommended that you register atoken update callbackto detect any change to the access token.client.config.o_auth_callback=save_token_to_databaseThe token update callback will be fired upon authorization as well as token refresh.Creating a client from a stored tokenTo authorize a client from a stored access token, just set the access token after creating the client:client=DropboxTestApiClient()client.config.o_auth_token=load_token_from_database()Class ReferenceList of ControllersFilesControllerFilesControllerGet controller instanceAn instance of theFilesControllerclass can be accessed from the API Client.files_controller=client.filesget_file_countTODO: Add a method descriptiondefget_file_count(self)Example Usageresult=files_controller.get_file_count()Back to List of Controllers