U ڲg.+ @sdZddlmZddlZddlZddlmZddlmZedddZ dd d d d d dddZ dZ dZ dZ dZdZddZGdddeZGdddeZddZedd!dd ZdS)"aChannel notifications support. Classes and functions to support channel subscriptions and notifications on those channels. Notes: - This code is based on experimental APIs and is subject to change. - Notification does not do deduplication of notification ids, that's up to the receiver. - Storing the Channel between calls is up to the caller. Example setting up a channel: # Create a new channel that gets notifications via webhook. channel = new_webhook_channel("https://example.com/my_web_hook") # Store the channel, keyed by 'channel.id'. Store it before calling the # watch method because notifications may start arriving before the watch # method returns. ... resp = service.objects().watchAll( bucket="some_bucket_id", body=channel.body()).execute() channel.update(resp) # Store the channel, keyed by 'channel.id'. Store it after being updated # since the resource_id value will now be correct, and that's needed to # stop a subscription. ... An example Webhook implementation using webapp2. Note that webapp2 puts headers in a case insensitive dictionary, as headers aren't guaranteed to always be upper case. id = self.request.headers[X_GOOG_CHANNEL_ID] # Retrieve the channel by id. channel = ... # Parse notification from the headers, including validating the id. n = notification_from_headers(channel, self.request.headers) # Do app specific stuff with the notification here. if n.resource_state == 'sync': # Code to handle sync state. elif n.resource_state == 'exists': # Code to handle the exists state. elif n.resource_state == 'not_exists': # Code to handle the not exists state. Example of unsubscribing. service.channels().stop(channel.body()).execute() )absolute_importN)_helpers)errorsiaddressid expirationparams resource_id resource_uritypetoken)rrrr resourceId resourceUrir r zX-GOOG-CHANNEL-IDzX-GOOG-MESSAGE-NUMBERzX-GOOG-RESOURCE-STATEzX-GOOG-RESOURCE-URIzX-GOOG-RESOURCE-IDcCs&i}|D]\}}|||<q |S)N)itemsupper)headers new_headerskvr;/tmp/pip-unpacked-wheel-rfrvjkbl/googleapiclient/channel.py_upper_header_keysgsrc@s"eZdZdZedddZdS) NotificationaA Notification from a Channel. Notifications are not usually constructed directly, but are returned from functions like notification_from_headers(). Attributes: message_number: int, The unique id number of this notification. state: str, The state of the resource being monitored. uri: str, The address of the resource being monitored. resource_id: str, The unique identifier of the version of the resource at this event. cCs||_||_||_||_dS)aNotification constructor. Args: message_number: int, The unique id number of this notification. state: str, The state of the resource being monitored. Can be one of "exists", "not_exists", or "sync". resource_uri: str, The address of the resource being monitored. resource_id: str, The identifier of the watched resource. N)message_numberstater r )selfrrr r rrr__init__|s zNotification.__init__N)__name__ __module__ __qualname____doc__util positionalrrrrrrns rc@s4eZdZdZedd ddZddZd d ZdS) Channela A Channel for notifications. Usually not constructed directly, instead it is returned from helper functions like new_webhook_channel(). Attributes: type: str, The type of delivery mechanism used by this channel. For example, 'web_hook'. id: str, A UUID for the channel. token: str, An arbitrary string associated with the channel that is delivered to the target address with each event delivered over this channel. address: str, The address of the receiving entity where events are delivered. Specific to the channel type. expiration: int, The time, in milliseconds from the epoch, when this channel will expire. params: dict, A dictionary of string to string, with additional parameters controlling delivery channel behavior. resource_id: str, An opaque id that identifies the resource that is being watched. Stable across different API versions. resource_uri: str, The canonicalized ID of the watched resource. rNc Cs4||_||_||_||_||_||_||_||_dS)aCreate a new Channel. In user code, this Channel constructor will not typically be called manually since there are functions for creating channels for each specific type with a more customized set of arguments to pass. Args: type: str, The type of delivery mechanism used by this channel. For example, 'web_hook'. id: str, A UUID for the channel. token: str, An arbitrary string associated with the channel that is delivered to the target address with each event delivered over this channel. address: str, The address of the receiving entity where events are delivered. Specific to the channel type. expiration: int, The time, in milliseconds from the epoch, when this channel will expire. params: dict, A dictionary of string to string, with additional parameters controlling delivery channel behavior. resource_id: str, An opaque id that identifies the resource that is being watched. Stable across different API versions. resource_uri: str, The canonicalized ID of the watched resource. N)r rr rrr r r ) rr rr rrr r r rrrrs#zChannel.__init__cCsZ|j|j|j|jd}|jr&|j|d<|jr6|j|d<|jrF|j|d<|jrV|j|d<|S)zBuild a body from the Channel. Constructs a dictionary that's appropriate for passing into watch() methods as the value of body argument. Returns: A dictionary representation of the channel. )rr r rr rrr)rr r rr r r r)rresultrrrbodys     z Channel.bodycCs4tD]&\}}||}|dk rt|||qdS)aUpdate a channel with information from the response of watch(). When a request is sent to watch() a resource, the response returned from the watch() request is a dictionary with updated channel information, such as the resource_id, which is needed when stopping a subscription. Args: resp: dict, The response from a watch() method. N)CHANNEL_PARAMSrgetsetattr)rrespZ json_name param_namevaluerrrupdates  zChannel.update)NNr&r&) rr r!r"r#r$rr(r/rrrrr%s +r%cCsft|}|t}|j|kr0td|j|fn2t|t}|t}|t}|t }t ||||SdS)aParse a notification from the webhook request headers, validate the notification, and return a Notification object. Args: channel: Channel, The channel that the notification is associated with. headers: dict, A dictionary like object that contains the request headers from the webhook HTTP request. Returns: A Notification object. Raises: errors.InvalidNotificationError if the notification is invalid. ValueError if the X-GOOG-MESSAGE-NUMBER can't be converted to an int. zChannel id mismatch: %s != %sN) rX_GOOG_CHANNEL_IDrrZInvalidNotificationErrorintX_GOOG_MESSAGE_NUMBERX_GOOG_RESOURCE_STATEX_GOOG_RESOURCE_URIX_GOOG_RESOURCE_IDr)ZchannelrZ channel_idrrr r rrrnotification_from_headerss   r6cCsZd}|r>|t}|jd|j|jddd}|dkr>d}tdtt||||dS)aCreate a new webhook Channel. Args: url: str, URL to post notifications to. token: str, An arbitrary string associated with the channel that is delivered to the target address with each notification delivered over this channel. expiration: datetime.datetime, A time in the future when the channel should expire. Can also be None if the subscription should use the default expiration. Note that different services may have different limits on how long a subscription lasts. Check the response from the watch() method to see the value the service has set for an expiration time. params: dict, Extra parameters to pass on channel creation. Currently not used for webhook channels. riiZweb_hook)rr )EPOCH microsecondssecondsdaysr%struuidZuuid4)urlr rr Z expiration_msdeltarrrnew_webhook_channels  rA)NNN)r" __future__rdatetimer>Zgoogleapiclientrr#rr9r)r0r2r3r4r5robjectrr%r6r$rArrrrs49    n