class RapleafApi:
headers = {'User-Agent' : 'RapleafApi/Python/1.1'}
basePath = '/v4/dr'
host = 'personalize.rapleaf.com'
timeout = 2.0
def __init__(self, apiKey):
self.handle = HTTPSConnectionPool(RapleafApi.host, timeout = RapleafApi.timeout)
self.basePath = RapleafApi.basePath + '?api_key=%s' % (apiKey)
def query_by_email(self, email, hash_email = False, show_available = False):
"""
Takes an e-mail and returns a hash which maps attribute fields onto attributes
If the hash_email option is set, then the email will be hashed before it's sent to Rapleaf.
If the show_available option is set, then the string "Data Available" will be returned for
those fields which the API account is not subscribed but for which RapLeaf has data.
"""
if hash_email:
s = hashlib.sha1()
s.update(email.lower())
return self.query_by_sha1(s.hexdigest(), show_available)
url = '%s&email=%s' % (self.basePath, urllib.quote(email))
return self.__get_json_response(url, show_available)
def query_by_md5(self, md5_email, show_available = False):
"""
Takes an e-mail that has already been hashed by md5
and returns a hash which maps attribute fields onto attributes.
If the show_available option is set, then the string "Data Available" will be returned for
those fields which the API account is not subscribed but for which RapLeaf has data.
"""
url = '%s&md5_email=%s' % (self.basePath, urllib.quote(md5_email))
return self.__get_json_response(url, show_available)
def query_by_sha1(self, sha1_email, show_available = False):
"""
Takes an e-mail that has already been hashed by sha1
and returns a hash which maps attribute fields onto attributes.
If the show_available option is set, then the string "Data Available" will be returned for
those fields which the API account is not subscribed but for which RapLeaf has data.
"""
url = '%s&sha1_email=%s' % (self.basePath, urllib.quote(sha1_email))
return self.__get_json_response(url, show_available)
def query_by_nap(self, first, last, street, city, state, email = None, show_available = False):
"""
Takes first name, last name, and postal (street, city, and state acronym),
and returns a hash which maps attribute fields onto attributes
Though not necessary, adding an e-mail increases hit rate.
If the show_available option is set, then the string "Data Available" will be returned for
those fields which the API account is not subscribed but for which RapLeaf has data.
"""
if email:
url = '%s&email=%s&first=%s&last=%s&street=%s&city=%s&state=%s' % (self.basePath,
urllib.quote(email), urllib.quote(first), urllib.quote(last),
urllib.quote(street), urllib.quote(city), urllib.quote(state))
else:
url = '%s&first=%s&last=%s&street=%s&city=%s&state=%s' % (self.basePath,
urllib.quote(first), urllib.quote(last),
urllib.quote(street), urllib.quote(city), urllib.quote(state))
return self.__get_json_response(url, show_available)
def query_by_naz(self, first, last, zip4, email = None, show_available = False):
"""
Takes first name, last name, and zip4 code (5-digit zip
and 4-digit extension separated by a dash as a string),
and returns a hash which maps attribute fields onto attributes
Though not necessary, adding an e-mail increases hit rate.
If the show_available option is set, then the string "Data Available" will be returned for
those fields which the API account is not subscribed but for which RapLeaf has data.
"""
if email:
url = '%s&email=%s&first=%s&last=%s&zip4=%s' % (self.basePath,
urllib.quote(email), urllib.quote(first), urllib.quote(last), zip4)
else:
url = '%s&first=%s&last=%s&zip4=%s' % (self.basePath,
urllib.quote(first), urllib.quote(last), zip4)
return self.__get_json_response(url, show_available)
def __get_json_response(self, path, show_available = False):
"""
Pre: Path is an extension to personalize.rapleaf.com
Note that an exception is raised if an HTTP response code
other than 200 is sent back. In this case, both the error code
the error code and error body are accessible from the exception raised
"""
if show_available:
path += '&show_available'
json_response = self.handle.get_url(path, headers = RapleafApi.headers)
if 200 <= json_response.status < 300:
if json_response.data:
return json.JSONDecoder().decode(json_response.data)
else:
return {}
else:
raise Exception(json_response.status, json_response.data)
class RapleafApi:
apiKey = 'SET_ME' # Set your API key here
headers = {'User-Agent' : 'RapleafApi/Python/1.1'}
basePath = '/v4/dr?api_key=%s' %(apiKey)
host = 'personalize.rapleaf.com'
timeout = 2.0
def __init__(self):
self.handle = HTTPSConnectionPool(RapleafApi.host, timeout = RapleafApi.timeout)
def query_by_email(self, email, hash_email = False):
"""
Takes an e-mail and returns a hash which maps attribute fields onto attributes
If the hash_email option is set, then the email will be hashed before it's sent to Rapleaf
"""
if hash_email:
s = hashlib.sha1()
s.update(email)
return self.query_by_sha1(s.digest())
url = '%s&email=%s' % (RapleafApi.basePath, urllib.quote(email))
return self.__get_json_response(url)
def query_by_md5(self, md5_email):
"""
Takes an e-mail that has already been hashed by md5
and returns a hash which maps attribute fields onto attributes
"""
url = '%s&md5_email=%s' % (RapleafApi.basePath, urllib.quote(md5_email))
return self.__get_json_response(url)
def query_by_sha1(self, sha1_email):
"""
Takes an e-mail that has already been hashed by sha1
and returns a hash which maps attribute fields onto attributes
"""
url = '%s&sha1_email=%s' % (RapleafApi.basePath, urllib.quote(sha1_email))
return self.__get_json_response(url)
def query_by_nap(self, first, last, street, city, state, email = None):
"""
Takes first name, last name, and postal (street, city, and state acronym),
and returns a hash which maps attribute fields onto attributes
Though not necessary, adding an e-mail increases hit rate
"""
if email:
url = '%s&email=%s&first=%s&last=%s&street=%s&city=%s&state=%s' % (RapleafApi.basePath,
urllib.quote(email), urllib.quote(first), urllib.quote(last),
urllib.quote(street), urllib.quote(city), urllib.quote(state))
else:
url = '%s&first=%s&last=%s&street=%s&city=%s&state=%s' % (RapleafApi.basePath,
urllib.quote(first), urllib.quote(last),
urllib.quote(street), urllib.quote(city), urllib.quote(state))
return self.__get_json_response(url)
def query_by_naz(self, first, last, zip4, email = None):
"""
Takes first name, last name, and zip4 code (5-digit zip
and 4-digit extension separated by a dash as a string),
and returns a hash which maps attribute fields onto attributes
Though not necessary, adding an e-mail increases hit rate
"""
if email:
url = '%s&email=%s&first=%s&last=%s&zip4=%s' % (RapleafApi.basePath,
urllib.quote(email), urllib.quote(first), urllib.quote(last), zip4)
else:
url = '%s&first=%s&last=%s&zip4=%s' % (RapleafApi.basePath,
urllib.quote(first), urllib.quote(last), zip4)
return self.__get_json_response(url)
def __get_json_response(self, path):
"""
Pre: Path is an extension to personalize.rapleaf.com
Note that an exception is raised if an HTTP response code
other than 200 is sent back. In this case, both the error code
the error code and error body are accessible from the exception raised
"""
json_response = self.handle.get_url(path, headers = RapleafApi.headers)
if 200 <= json_response.status < 300:
if json_response.data:
return json.JSONDecoder().decode(json_response.data)
else:
return {}
else:
raise Exception(json_response.status, json_response.data)
