FZjCJ&dZddlmZddlZddlZddlmZddlZddlZddl m Z ddl m Z ddl mZdd lmZmZdd lmZmZmZdd lmZmZdd lmZmZd ZGddeZGddeZGdde Z edddfdZ!dZ"eddfdZ#dZ$dZ%gdZ&y)zR mygeotab.api ~~~~~~~~~~~~ Public objects and methods wrapping the MyGeotab API. )unicode_literalsN)urlparse) HTTPAdapter)Timeout)create_urllib3_context) __title__ __version__)AuthenticationExceptionMyGeotabExceptionTimeoutException)camelcaseify_parametersconvert_get_parameters)json_deserializejson_serializei,ceZdZdZddddeddfdZedZedZdZ dZ d Z d Z d Z d Zd ZedZy)APIz3A simple and Pythonic wrapper for the MyGeotab API.N my.geotab.comc | td| | tdt||||||_||_||_d|_||_y)aInitialize the MyGeotab API object with credentials. :param username: The username used for MyGeotab servers. Usually an email address. :type username: str :param password: The password associated with the username. Optional if `session_id` is provided. :type password: str :param database: The database or company name. Optional as this usually gets resolved upon authentication. :type database: str :param session_id: A session ID, assigned by the server. :type session_id: str :param server: The server ie. my23.geotab.com. Optional as this usually gets resolved upon authentication. :type server: str or None :param timeout: The timeout to make the call, in seconds. By default, this is 300 seconds (or 5 minutes). :type timeout: float or None :param proxies: The proxies dictionary to apply to the request. :type proxies: dict or None :param cert: The path to client certificate. A single path to .pem file or a Tuple (.cer file, .key file). :type cert: str or Tuple or None :raise Exception: Raises an Exception if a username, or one of the session_id or password is not provided. Nz`username` cannot be Nonez1`password` and `session_id` must not both be Noneusername session_iddatabaseserverpasswordr) Exception Credentials credentialstimeout_proxies_API__reauthorize_count_cert) selfrrrrrrproxiescerts NC:\Users\Rodrigo\frota-trucks-cliente\python\Lib\site-packages\mygeotab/api.py__init__z API.__init__!sf>  78 8   2OP P&*xPVai   #$  c||jjsd|j_|jjS)Nr)rrr#s r&_serverz API._serverLs1&&&5D   #&&&r(c.tfddD S)zyWhether or not SSL be verified. :rtype: bool :return: True if the calls are being made locally. c3LK|]}|tjvywN) get_api_urlr+).0sr#s r& z%API._is_verify_ssl..Ys"Z?Y!qK 55?Ys!$)z 127.0.0.1 localhost)anyr*s`r&_is_verify_sslzAPI._is_verify_sslRsZ?YZZZZr(c x| tdt|}|jr&|jjs|j d|vr3|jjr|jj |d< t |j|||j|j|j|j}|d|_ |S#t$r}|jdk(s|jdk(rd|jvr|jdk(rS|jj r=|xjd z c_ |j |j"|fi|cYd}~St%|jj&|jj(|jj*|d}~wwxYw) aMakes a call to the API. :param method: The method name. :type method: str :param parameters: Additional parameters to send (for example, search=dict(id='b123') ). :raise MyGeotabException: Raises when an exception occurs on the MyGeotab server. :raise TimeoutException: Raises when the request does not respond after some time. :return: The results from the server. :rtype: dict or list NA method name must be specifiedr verify_sslr$r%rInvalidUserExceptionDbUnavailableException Initializingr)rrrr authenticate get_param_queryr+rr5r r"r!r namemessagercallr rrr)r#method parametersparamsresult exceptions r&rBzAPI.call[s >=> >(4   D$4$4$?$?      &4+;+;+F+F$($4$4$>$>$@F= !   .. ZZF!+,(M ~~!77"::~QZQbQb?b++q0T5E5E5N5N,,1,%%'$499V:z::1((1143C3C3L3LdN^N^NeNe$%  s'AC F9BF4#F9)A F44F9c |Dcgc]%}t|dt|dkDr|dni'}}|jd|Scc}w)aPerforms a multi-call to the API. :param calls: A list of call 2-tuples with method name and params (for example, ('Get', dict(typeName='Trip')) ). :type calls: list((str, dict)) :raise MyGeotabException: Raises when an exception occurs on the MyGeotab server. :raise TimeoutException: Raises when the request does not respond after some time. :return: The results from the server. :rtype: list rr)rCrEExecuteMultiCall)calls)dictlenrB)r#rJrBformatted_callss r& multi_callzAPI.multi_callsSfkkej]a4tAw#d)a-tAwUWXejkyy+?yCCls*Ac <|jdd|it|S)aXGets entities using the API. Shortcut for using call() with the 'Get' method. :param type_name: The type of entity. :type type_name: str :param parameters: Additional parameters to send. A parameter called `resultsLimit` or `results_limit` will limit the number of entries returned. A `search` parameter can further limit results, for example search=dict(id='b123'). If a parameter called `search` is omitted, any additional parameters are automatically added to a `search` dictionary. This simplifies basic usage. The following are equivalent calls: api.get("Device", search={"id":"b2"}) api.get("Device", id="b2) :raise MyGeotabException: Raises when an exception occurs on the MyGeotab server. :raise TimeoutException: Raises when the request does not respond after some time. :return: The results from the server. :rtype: list type_name)Get)rBr)r#rPrDs r&getzAPI.gets#&tyyZ)Z7Mj7YZZr(c*|jd||S)aAdds an entity using the API. Shortcut for using call() with the 'Add' method. :param type_name: The type of entity. :type type_name: str :param entity: The entity to add. :type entity: dict :raise MyGeotabException: Raises when an exception occurs on the MyGeotab server. :raise TimeoutException: Raises when the request does not respond after some time. :return: The id of the object added. :rtype: str AddrPentityrBr#rPrVs r&addzAPI.addsyy)FyCCr(c*|jd||S)aSets an entity using the API. Shortcut for using call() with the 'Set' method. :param type_name: The type of entity. :type type_name: str :param entity: The entity to set. :type entity: dict :raise MyGeotabException: Raises when an exception occurs on the MyGeotab server. :raise TimeoutException: Raises when the request does not respond after some time. SetrUrWrXs r&setzAPI.setsyy)FyCCr(c*|jd||S)aRemoves an entity using the API. Shortcut for using call() with the 'Remove' method. :param type_name: The type of entity. :type type_name: str :param entity: The entity to remove. :type entity: dict :raise MyGeotabException: Raises when an exception occurs on the MyGeotab server. :raise TimeoutException: Raises when the request does not respond after some time. RemoverUrWrXs r&removez API.removesyyYvyFFr(c  |jjr|jjst|jj|jj |jj}t |jd||j|j|j|j|jSt|jj|jj |jj}t |jd||j|j|j|j}|rud|vr"|jjr |jS|d}|jj}|dk7r|}|d}t|d |d |d ||_|jSy#t$r}|jd k(s+|jd k(rfd|j vsd|j vrJt#|jj |jj|jj|d}~wwxYw)aAuthenticates against the API server. :raise AuthenticationException: Raises if there was an issue with authenticating or logging in. :raise MyGeotabException: Raises when an exception occurs on the MyGeotab server. :raise TimeoutException: Raises when the request does not respond after some time. :return: A Credentials object with a session ID created by the server. :rtype: Credentials )ruserName sessionId ExtendSessionr8)rrar Authenticatepath ThisServerrrarbrr:r;r<UnknownDatabaseN)rrrrKrrr?r+rr5r r"rrr r@rAr )r#extend_session_data auth_datarF new_serverrrrGs r&r=zAPI.authenticates(6 **43C3C3L3L&*!--66!--66"..99'# LL#'LL#22 MM'''))22))22))22I   .. ZZF'D,<,<,G,G+++#F^ ))00-'F$]3 #. +[-E{S]G^`f$ '''! ~~!77"::#y'8'88AG I!BII!ct|j|j|j|j|j S)aReturns a new API object from an existing Credentials object. :param credentials: The existing saved credentials. :type credentials: Credentials :return: A new API object populated with MyGeotab credentials. :rtype: API )rrrrr)rrrrrr)rs r&from_credentialszAPI.from_credentialss> )) )) ))"--%%   r()__name__ __module__ __qualname____doc__DEFAULT_TIMEOUTr'propertyr+r5rBrNrRrYr\r_r= staticmethodrlr(r&rrs=  )V'' [[,\ D[* D D G?B  r(rc*eZdZdZddZdZdZdZy)rz The MyGeotab Credentials object.NcJ||_||_||_||_||_y)aInitialize the Credentials object. :param username: The username used for MyGeotab servers. Usually an email address. :type username: str :param session_id: A session ID, assigned by the server. :type session_id: str :param database: The database or company name. Optional as this usually gets resolved upon authentication. :type database: str or None :param server: The server ie. my23.geotab.com. Optional as this usually gets resolved upon authentication. :type server: str or None :param password: The password associated with the username. Optional if `session_id` is provided. :type password: str or None Nr)r#rrrrrs r&r'zCredentials.__init__(s'! $     r(cddj|j|j|jS)Nz {0} @ {1}/{2})formatrrrr*s r&__str__zCredentials.__str__<s#%%dmmT[[$--PPr(cPdj|j|jS)Nz5Credentials(username={username}, database={database}))rr)rxrrr*s r&__repr__zCredentials.__repr__?s&FMMW[WdWdoso|o|M}}r(cZt|j|j|jS)zA simple representation of the credentials object for passing into the API.authenticate() server call. :return: The simple credentials object for use by API.authenticate(). :rtype: dict )rarbr)rKrrrr*s r&r>zCredentials.get_paramBs" T]]dooPTP]P]^^r(r.)rmrnrorpr'ryr{r>rtr(r&rr%s*!(Q~_r(rceZdZdZddZy)GeotabHTTPAdapterz-HTTP adapter to enforce use of TLS for HTTPS.c ttj}|jt tdr#|xj tj zc_tjjd||||d||_y)N) ssl_versionOP_ENABLE_MIDDLEBOX_COMPAT) num_poolsmaxsizeblock ssl_contextrt) rsslPROTOCOL_TLS_CLIENTload_default_certshasattroptionsrurllib3 poolmanager PoolManager)r# connectionsrr pool_kwargsrs r&init_poolmanagerz"GeotabHTTPAdapter.init_poolmanagerNso,9P9PQ &&( 34 5   3#A#A A "..:: !7%[ \g r(N)F)rmrnrorprrtr(r&r~r~Ks 7 r(r~Tc :t|}td||xsi}t} tj5} | j dt |r|| _ | j|t|| d|||} ddd j| jjd} | rd| jvr | j St#t%| j S#t$r} t|| d} ~ wwxYw#1swYxYw) aBFormats and performs the query against the API. :param server: The MyGeotab server. :type server: str :param method: The method name. :type method: str :param parameters: The parameters to send with the query. :type parameters: dict :param timeout: The timeout to make the call, in seconds. By default, this is 300 seconds (or 5 minutes). :type timeout: float :param verify_ssl: If True, verify the SSL certificate. It's recommended not to modify this. :type verify_ssl: bool :param proxies: The proxies dictionary to apply to the request. :type proxies: dict or None :param cert: The path to client certificate. A single path to .pem file or a Tuple (.cer file, .pem file) :type cert: str or Tuple or None :raise MyGeotabException: Raises when an exception occurs on the MyGeotab server. :raise TimeoutException: Raises when the request does not respond after some time. :raise urllib2.HTTPError: Raises when there is an HTTP status code that indicates failure. :return: The JSON-decoded result from the server. )idrCrEhttps://T)dataheadersallow_redirectsrverifyr$Nz Content-Typezapplication/json)r/rK get_headersrequestsSessionmountr~r%postrrr raise_for_statusrrRlowertext_processr)rrCrDrr9r$r% api_endpointrErsessionresponseexc content_types r&r?r?Xs,v&L Rz/?R @FmG    w j"3"56 GL 4||#F+ $!$H   ##''7L*,2D2D2FF}} $X]]3 44  4"6* 3 4  s)$D!!C44 D= D  DDDc@|rd|vrt|dd|vr|dS|S)zProcesses the returned JSON from the server. :param data: The JSON data in dict form. :raise MyGeotabException: Raises when a server exception was encountered. :return: The result data. errorrF)r )rs r&rrs4 d?#DM2 2 t > ! Kr(c n| td| tdt|}t||||||S)aNMakes a call to an un-authenticated method on a server :param method: The method name. :type method: str :param server: The MyGeotab server. :type server: str :param timeout: The timeout to make the call, in seconds. By default, this is 300 seconds (or 5 minutes). :type timeout: float :param verify_ssl: If True, verify the SSL certificate. It's recommended not to modify this. :type verify_ssl: bool :param proxies: The proxies dictionary to apply to the request. :type proxies: dict or None :param parameters: Additional parameters to send (for example, search=dict(id='b123') ). :raise MyGeotabException: Raises when an exception occurs on the MyGeotab server. :raise TimeoutException: Raises when the request does not respond after some time. :return: The result from the server. r7z/A server (eg. my3.geotab.com) must be specified)rr9r$)rrr?)rCrrr9r$rDs r& server_callrsF$~9:: ~IJJ(4J &&*g*^e ffr(ct|}|jr |jn |j}|jddd|zdzS)zFormats the server URL properly in order to query the API. :return: A valid MyGeotab API request URL. :rtype: str /rz/apiv1)rnetlocrereplace)rparsedbase_urls r&r/r/sC f F & v}}6;;H S"  8 ++r(c\ddjtjttdS)zLGets the request headers. :return: The user agent :rtype: dict zapplication/json; charset=UTF-8z8Python/{py_version[0]}.{py_version[1]} {title}/{version}) py_versiontitleversion)z Content-typez User-Agent)rxsys version_infor r rtr(r&rrs2:PWW''y+X  r()rrr r )'rp __future__rrr urllib.parserrrrequests.adaptersrrequests.exceptionsrurllib3.util.ssl_rrr r exceptionsr r r rDrr serializersrrrqobjectrrr~r?rrr/r__all__rtr(r&rs( !)'4$TTG9D &D N#_&#_L   0?4Y]dh-5` )8DRVg4 ,  Qr(