Adding py sample for google analytics core reporting api

samples/analytics/sample_utils.py

 #!/usr/bin/python
 #
 # Copyright 2012 Google Inc. All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
 #      http://www.apache.org/licenses/LICENSE-2.0
 #
@@ skipping 69 matching lines @@
                    'Set the level of logging detail.')
 
 
 # Name of file that will store the access and refresh tokens to access
 # the API without having to login each time. Make sure this file is in
 # a secure place.
 TOKEN_FILE_NAME = 'analytics.dat'
 
 
 def process_flags(argv):
-  """Uses the command-line flags to set the logging level."""

[jcgregorio_google, 2012/03/06 15:01:59]

document parameter

[api.nickm1, 2012/04/26 06:30:16]

Done.

+  """Uses the command-line flags to set the logging level.
+
+  Args:
+    argv: List of command line arguments passed to the python script.
+  """
 
   # Let the gflags module process the command-line arguments.
   try:
     argv = FLAGS(argv)
   except gflags.FlagsError, e:
     print '%s\nUsage: %s ARGS\n%s' % (e, argv[0], FLAGS)
     sys.exit(1)
 
   # Set the logging according to the command-line flag.
   logging.getLogger().setLevel(getattr(logging, FLAGS.logging_level))
 
 
-def prepare_credentials():

[jcgregorio_google, 2012/03/06 15:01:59]

Seems gratuitous to break out prepare_credentials and retrieve_service as
separate functions given how little they do and that only initialize_service is
called from outside this file. Either collapse into initialize_service or mark
them as private and document their parameters.

[api.nickm1, 2012/04/26 06:30:16]

I decided to remove them.

On 2012/03/06 15:01:59, jcgregorio_google wrote:

-  """Handles auth. Reuses credentialss if available or runs the auth flow."""
+def initialize_service():
+  """Returns an instance of service from discovery data and does auth.
 
-  # If the credentials don't exist or are invalid run through the native client
-  # flow. The Storage object will ensure that if successful the good
-  # Credentials will get written back to a file.
-  storage = Storage(TOKEN_FILE_NAME)
-  credentials = storage.get()
-  if credentials is None or credentials.invalid:
-    credentials = run(FLOW, storage)
-  return credentials
+  This method tries to read any existing OAuth 2.0 credentials from the
+  Storage object. If the credentials do not exist, new credentials are
+  obtained. The crdentials are used to authorize an http object. The
+  http object is used to build the analytics service object.
 
-
-def retrieve_service(http):
-  """Retrieves an Anaytics API service via the discovery service."""
-
-  # Construct a service object via the discovery service.
-  return build('analytics', 'v3', http=http)
-
-
-def initialize_service():
-  """Builds instance of service from discovery data and does auth."""

[jcgregorio_google, 2012/03/06 15:01:59]

document return value

[api.nickm1, 2012/04/26 06:30:16]

Done.

+  Returns:
+    An analytics v3 service object.
+  """
 
   # Create an httplib2.Http object to handle our HTTP requests.
   http = httplib2.Http()
 
   # Prepare credentials, and authorize HTTP object with them.
-  credentials = prepare_credentials()
+  storage = Storage(TOKEN_FILE_NAME)
+  credentials = storage.get()
+  if credentials is None or credentials.invalid:
+    credentials = run(FLOW, storage)
+
   http = credentials.authorize(http)
 
   # Retrieve service.
-  return retrieve_service(http)
+  return build('analytics', 'v3', http=http)