BasicRequestHelper.py

"""This is where most universal code for the Python examples of API implementation exist.
   Much of the abstracted logic such as filling out credential objects and arrays
   resides in this class."""

import pw_pw as pw

SOURCE_NAME = pw.sourcename
SOURCE_PASSWORD = pw.password

USER_NAME = pw.uname
USER_PASSWORD = pw.upass

SITE_IDS = [-99]


def BuildWsdlUrl(serviceName):
    """This function lets us grab the WSDL for any service we need."""

    return "https://api.mindbodyonline.com/0_5/" + serviceName + "Service.asmx?wsdl"


def CreateStaffCredentials(service, user, password, siteIds):
    """This is a pretty basic method for generating a commonly used field (StaffCredentials)
       in API calls."""
    if(user == None or password == None or siteIds == None):
        return None
    else:
        creds = service.factory.create("StaffCredentials")
        creds.Username = user
        creds.Password = password
        creds.SiteIDs = FillArrayType(service, siteIds, "Int")

        return creds


def FillArrayType(service, elems, arrayType, elemName=None):
    """This method will create an 'ArrayOfX' object and then fill it with the array passed in.
       This takes advantage of the fact that every ArrayOfX object follows the same pattern
       (i.e., ArrayOfLong uses a "long" attribute. ArrayOfInt uses an "int" attribute, etc) a
       vast majority of the time. In the case where this doesn't apply (ArrayOfVisit has a
       capitalized Visit field instead of visit), elemName can be manually set to the desired
       value."""
    if elemName == None:
        elemName = arrayType.lower()

    if elems != None:
        ArrayObject = service.factory.create("ArrayOf" + arrayType)
        setattr(ArrayObject, elemName, elems)
        return ArrayObject
    else:
        return None


def FillAbstractObject(service, objectType, valueDict):
    """This method is useful for creating the "cartItems" and "payments" fields of
       the CheckoutShoppingCart method. It takes in the array currently being built,
       the name in the WSDL of the element to be added (e.g. DebitAccountInfo for payments
       or Package for the Item field of a CartItem."""
    newObject = service.factory.create(objectType)

    for currField in valueDict.keys():
        setattr(newObject, currField, valueDict[currField])

    return newObject


def SetEnumerable(service, enum, value):
    """This method will generate and return an instance of enum.value."""
    if enum == None or value == None:
        return None
    else:
        return getattr(service.factory.create(enum), value)


def FillDefaultCredentials(service, request, siteIDs):
    sourceCreds = service.factory.create('SourceCredentials')
    sourceCreds.SourceName = SOURCE_NAME
    sourceCreds.Password = SOURCE_PASSWORD
    sourceCreds.SiteIDs.int = siteIDs

    userCreds = service.factory.create('UserCredentials')
    userCreds.Username = USER_NAME
    userCreds.Password = USER_PASSWORD
    userCreds.SiteIDs.int = siteIDs

    request.SourceCredentials = sourceCreds
    request.UserCredentials = userCreds
    request.XMLDetail = "Full"
    request.PageSize = 25
    request.CurrentPageIndex = 0

    return request

"""Set siteIDs here to whichever site(s) you wish to make calls upon.
   This example represents site -99, the API Sandbox Site."""


def CreateBasicRequest(service, requestName, siteIDs=SITE_IDS):
    """Returns a request object defined by requestName in the WSDL with
       source and user credentials set."""
    request = service.factory.create(requestName)

    if hasattr(request, 'Request'):
        request = request.Request
    return FillDefaultCredentials(service, request, siteIDs)