Update adexchangebuyer samples to use apiclient.sample_tools.

Reviewed in https://codereview.appspot.com/8410044/.

samples/adexchangebuyer/get_all_accounts.py

@@ -23,22 +23,22 @@ __author__ = 'david.t@google.com (David Torres)'
 
 import pprint
 import sys
-from oauth2client.client import AccessTokenRefreshError
+
-import sample_utils
+from apiclient import sample_tools
+from oauth2client import client
 
 
 def main(argv):
-  sample_utils.process_flags(argv)
+  # Authenticate and construct service.
-  pretty_printer = pprint.PrettyPrinter()
+  service, flags = sample_tools.init(
-
+      argv, 'adexchangebuyer', 'v1.2', __doc__, __file__,
-  # Authenticate and construct service
+      scope='https://www.googleapis.com/auth/adexchange.buyer')
-  service = sample_utils.initialize_service()
 
   try:
     # Retrieve account list and display data as received
     result = service.accounts().list().execute()
-    pretty_printer.pprint(result)
+    pprint.pprint(result)
-  except AccessTokenRefreshError:
+  except client.AccessTokenRefreshError:
     print ('The credentials have been revoked or expired, please re-run the '
            'application to re-authorize')
 

samples/adexchangebuyer/get_creative.py

@@ -22,31 +22,29 @@ Tags: creatives.insert
 __author__ = ('david.t@google.com (David Torres)',
               'jdilallo@google.com (Joseph DiLallo)')
 
+import argparse
 import pprint
 import sys
-import gflags
-from oauth2client.client import AccessTokenRefreshError
-import sample_utils
 
-# Declare command-line flags, and set them as required.
+from apiclient import sample_tools
-gflags.DEFINE_string('account_id', None,
+from oauth2client import client
-                     'The ID of the account that contains the creative',
+
-                     short_name='a')
+# Declare command-line flags.
-gflags.MarkFlagAsRequired('account_id')
+argparser = argparse.ArgumentParser(add_help=False)
-gflags.DEFINE_string('buyer_creative_id', None,
+argparser.add_argument('account_id', type=int,
-                     'A buyer-specific id that identifies this creative',
+                     help='The ID of the account that contains the creative')
-                     short_name='c')
+argparser.add_argument('buyer_creative_id',
-gflags.MarkFlagAsRequired('buyer_creative_id')
+                     help='A buyer-specific id that identifies this creative')
 
 
 def main(argv):
-  sample_utils.process_flags(argv)
-  account_id = gflags.FLAGS.account_id
-  buyer_creative_id = gflags.FLAGS.buyer_creative_id
-  pretty_printer = pprint.PrettyPrinter()
-
   # Authenticate and construct service.
-  service = sample_utils.initialize_service()
+  service, flags = sample_tools.init(
+      argv, 'adexchangebuyer', 'v1.2', __doc__, __file__, parents=[argparser],
+      scope='https://www.googleapis.com/auth/adexchange.buyer')
+
+  account_id = flags.account_id
+  buyer_creative_id = flags.buyer_creative_id
 
   try:
     # Construct the request.
@@ -54,8 +52,8 @@ def main(argv):
                                       buyerCreativeId=buyer_creative_id)
 
     # Execute request and print response.
-    pretty_printer.pprint(request.execute())
+    pprint.pprint(request.execute())
-  except AccessTokenRefreshError:
+  except client.AccessTokenRefreshError:
     print ('The credentials have been revoked or expired, please re-run the '
            'application to re-authorize')
 

samples/adexchangebuyer/get_direct_deals.py

@@ -23,16 +23,16 @@ __author__ = 'david.t@google.com (David Torres)'
 
 import pprint
 import sys
-from oauth2client.client import AccessTokenRefreshError
+
-import sample_utils
+from apiclient import sample_tools
+from oauth2client import client
 
 
 def main(argv):
-  sample_utils.process_flags(argv)
-  pretty_printer = pprint.PrettyPrinter()
-
   # Authenticate and construct service.
-  service = sample_utils.initialize_service()
+  service, flags = sample_tools.init(
+      argv, 'adexchangebuyer', 'v1.2', __doc__, __file__,
+      scope='https://www.googleapis.com/auth/adexchange.buyer')
 
   try:
     # Retrieve direct deals and display them as received if any.
@@ -40,10 +40,10 @@ def main(argv):
     if 'direct_deals' in result:
       deals = result['direct_deals']
       for deal in deals:
-        pretty_printer.pprint(deal)
+        pprint.pprint(deal)
     else:
       print 'No direct deals found'
-  except AccessTokenRefreshError:
+  except client.AccessTokenRefreshError:
     print ('The credentials have been revoked or expired, please re-run the '
            'application to re-authorize')
 

samples/adexchangebuyer/sample_utils.py

@@ -1,112 +0,0 @@
-#!/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
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-"""Auxiliary file for Ad Exchange Buyer API code samples.
-
-Handles various tasks to do with logging, authentication and initialization.
-"""
-
-__author__ = 'david.t@google.com (David Torres)'
-
-import logging
-import os
-import sys
-from apiclient.discovery import build
-import gflags
-import httplib2
-from oauth2client.client import flow_from_clientsecrets
-from oauth2client.client import OOB_CALLBACK_URN
-from oauth2client.file import Storage
-from oauth2client.tools import run
-
-
-FLAGS = gflags.FLAGS
-
-# CLIENT_SECRETS, name of a file containing the OAuth 2.0 information for this
-# application, including client_id and client_secret, which are found
-# on the API Access tab on the Google APIs
-# Console <http://code.google.com/apis/console>
-CLIENT_SECRETS = 'client_secrets.json'
-
-# Helpful message to display in the browser if the CLIENT_SECRETS file
-# is missing.
-MISSING_CLIENT_SECRETS_MESSAGE = """
-WARNING: Please configure OAuth 2.0
-
-To make this sample run you will need to populate the client_secrets.json file
-found at:
-
-   %s
-
-with information from the APIs Console <https://code.google.com/apis/console>.
-
-""" % os.path.join(os.path.dirname(__file__), CLIENT_SECRETS)
-
-# Set up a Flow object to be used if we need to authenticate.
-FLOW = flow_from_clientsecrets(
-    CLIENT_SECRETS,
-    scope='https://www.googleapis.com/auth/adexchange.buyer',
-    redirect_uri=OOB_CALLBACK_URN,
-    message=MISSING_CLIENT_SECRETS_MESSAGE
-    )
-
-# The gflags module makes defining command-line options easy for applications.
-# Run this program with the '--help' argument to see all the flags that it
-# understands.
-gflags.DEFINE_enum('logging_level', 'ERROR',
-                   ['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'],
-                   'Set the level of logging detail.')
-
-
-def process_flags(argv):
-  """Uses the command-line flags to set the logging level."""
-
-  # 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 initialize_service():
-  """Initializes and returns an instance of the Ad Exchange Buyer service.
-
-  Authorizes the user for use of the service and returns it backs.
-
-  Returns:
-      The authorized and initialized service.
-  """
-
-  # Create an httplib2.Http object to handle our HTTP requests.
-  http = httplib2.Http()
-
-  # Prepare credentials, and authorize HTTP object with them.
-  # 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('adexchangebuyer.dat')
-  credentials = storage.get()
-  if credentials is None or credentials.invalid:
-    credentials = run(FLOW, storage)
-  http = credentials.authorize(http)
-
-  # Construct a service object via the discovery service.
-  service = build('adexchangebuyer', 'v1.2', http=http)
-  return service

samples/adexchangebuyer/submit_creative.py

@@ -22,36 +22,33 @@ Tags: creatives.insert
 __author__ = ('david.t@google.com (David Torres)',
               'jdilallo@google.com (Joseph DiLallo)')
 
+import argparse
 import pprint
 import sys
-import gflags
-from oauth2client.client import AccessTokenRefreshError
-import sample_utils
 
-# Declare command-line flags, and set them as required.
+from apiclient import sample_tools
-gflags.DEFINE_string('account_id', None,
+from oauth2client import client
-                     'The ID of the account to which submit the creative',
+
-                     short_name='a')
+# Declare command-line flags.
-gflags.MarkFlagAsRequired('account_id')
+argparser = argparse.ArgumentParser(add_help=False)
-gflags.DEFINE_string('buyer_creative_id', None,
+argparser.add_argument('account_id', type=int,
-                     'A buyer-specific id identifying the creative in this ad',
+                     help='The ID of the account to which submit the creative')
-                     short_name='c')
+argparser.add_argument('buyer_creative_id',
-gflags.MarkFlagAsRequired('buyer_creative_id')
+                     help='A buyer-specific id identifying the creative in'
-gflags.DEFINE_string('agency_id', None,
+                       'this ad')
-                     'The id of the agency who created this ad',
+argparser.add_argument('agency_id', type=int,
-                     short_name='g')
+                     help='The ID of the agency who created this ad')
 
 
 def main(argv):
-  sample_utils.process_flags(argv)
-  account_id = gflags.FLAGS.account_id
-  buyer_creative_id = gflags.FLAGS.buyer_creative_id
-  agency_id = gflags.FLAGS.agency_id
-  pretty_printer = pprint.PrettyPrinter()
-
   # Authenticate and construct service.
-  service = sample_utils.initialize_service()
+  service, flags = sample_tools.init(
+      argv, 'adexchangebuyer', 'v1.2', __doc__, __file__, parents=[argparser],
+      scope='https://www.googleapis.com/auth/adexchange.buyer')
 
+  account_id = flags.account_id
+  agency_id = flags.agency_id
+  buyer_creative_id = flags.buyer_creative_id
   try:
     # Create a new creative to submit.
     creative_body = {
@@ -69,8 +66,8 @@ def main(argv):
     creative = service.creatives().insert(body=creative_body).execute()
     # Print the response. If the creative has been already reviewed, its status
     # and categories will be included in the response.
-    pretty_printer.pprint(creative)
+    pprint.pprint(creative)
-  except AccessTokenRefreshError:
+  except client.AccessTokenRefreshError:
     print ('The credentials have been revoked or expired, please re-run the '
            'application to re-authorize')
 

samples/adexchangebuyer/update_account.py

@@ -21,31 +21,29 @@ Tags: accounts.patch
 
 __author__ = 'david.t@google.com (David Torres)'
 
+import argparse
 import pprint
 import sys
-import gflags
-from oauth2client.client import AccessTokenRefreshError
-import sample_utils
 
-# Declare command-line flags, and set them as required.
+from apiclient import sample_tools
-gflags.DEFINE_string('account_id', None,
+from oauth2client import client
-                     'The ID of the account to which submit the creative',
+
-                     short_name='a')
+# Declare command-line flags.
-gflags.MarkFlagAsRequired('account_id')
+argparser = argparse.ArgumentParser(add_help=False)
-gflags.DEFINE_string('cookie_matching_url', None,
+argparser.add_argument('account_id', type=int,
-                     'New cookie matching URL to set for the account ',
+                     help='The ID of the account to which submit the creative')
-                     short_name='u')
+argparser.add_argument('cookie_matching_url',
-gflags.MarkFlagAsRequired('cookie_matching_url')
+                     help='New cookie matching URL to set for the account ')
 
 
 def main(argv):
-  sample_utils.process_flags(argv)
-  account_id = gflags.FLAGS.account_id
-  cookie_matching_url = gflags.FLAGS.cookie_matching_url
-  pretty_printer = pprint.PrettyPrinter()
-
   # Authenticate and construct service.
-  service = sample_utils.initialize_service()
+  service, flags = sample_tools.init(
+      argv, 'adexchangebuyer', 'v1.2', __doc__, __file__, parents=[argparser],
+      scope='https://www.googleapis.com/auth/adexchange.buyer')
+
+  account_id = flags.account_id
+  cookie_matching_url = flags.cookie_matching_url
 
   try:
     # Account information to be updated.
@@ -55,8 +53,8 @@ def main(argv):
         }
     account = service.accounts().patch(id=account_id,
                                        body=account_body).execute()
-    pretty_printer.pprint(account)
+    pprint.pprint(account)
-  except AccessTokenRefreshError:
+  except client.AccessTokenRefreshError:
     print ('The credentials have been revoked or expired, please re-run the '
            'application to re-authorize')