Current File : //lib/python2.7/site-packages/salt/modules/slack_notify.pyc
�
���^c @@ s# d Z d d l m Z m Z m Z d d l Z d d l Z d d l Z d d l m
Z
d d l m Z
d d l m Z d d l m Z d d l Z e j e � Z d Z d � Z d
� Z d � Z d d � Z d d
� Z d d � Z d d � Z d d d � Z d d e d d d d d � Z! d S( uh
Module for sending messages to Slack
.. versionadded:: 2015.5.0
:configuration: This module can be used by either passing an api key and version
directly or by specifying both in a configuration profile in the salt
master/minion config.
For example:
.. code-block:: yaml
slack:
api_key: peWcBiMOS9HrZG15peWcBiMOS9HrZG15
i ( t absolute_importt unicode_literalst print_functionN( t SaltInvocationError( t urlencode( t urljoin( t rangeu slackc C@ s t S( uZ
Return virtual name of the module.
:return: The virtual name of the module.
( t __virtualname__( ( ( s= /usr/lib/python2.7/site-packages/salt/modules/slack_notify.pyt __virtual__) s c C@ s9 t d d � p t d d � } | s5 t d � � n | S( Nu
config.getu
slack.api_keyu
slack:api_keyu No Slack API key found.( t __salt__R ( t api_key( ( s= /usr/lib/python2.7/site-packages/salt/modules/slack_notify.pyt _get_api_key2 s
c C@ s9 t d d � p t d d � } | s5 t d � � n | S( Nu
config.getu
slack.hooku
slack:hooku No Slack WebHook url found( R R ( t url( ( s= /usr/lib/python2.7/site-packages/salt/modules/slack_notify.pyt _get_hook_id< s
c C@ s4 | s t � } n t j j j d d d | d t � S( u
List all Slack rooms.
:param api_key: The Slack admin api key.
:return: The room list.
CLI Example:
.. code-block:: bash
salt '*' slack.list_rooms
salt '*' slack.list_rooms api_key=peWcBiMOS9HrZG15peWcBiMOS9HrZG15
t functionu roomsR
t opts( R t saltt utilst slackt queryt __opts__( R
( ( s= /usr/lib/python2.7/site-packages/salt/modules/slack_notify.pyt
list_roomsE s
c C@ s4 | s t � } n t j j j d d d | d t � S( u
List all Slack users.
:param api_key: The Slack admin api key.
:return: The user list.
CLI Example:
.. code-block:: bash
salt '*' slack.list_users
salt '*' slack.list_users api_key=peWcBiMOS9HrZG15peWcBiMOS9HrZG15
R u usersR
R ( R R R R R R ( R
( ( s= /usr/lib/python2.7/site-packages/salt/modules/slack_notify.pyt
list_users[ s
c C@ s� | s t � } n | j d � r. | d } n t | � } | d r� | d } | r� x< t d t | � � D]" } | | d | k rj | | Sqj Wq� n t S( uW
Find a room by name and return it.
:param name: The room name.
:param api_key: The Slack admin api key.
:return: The room object.
CLI Example:
.. code-block:: bash
salt '*' slack.find_room name="random"
salt '*' slack.find_room name="random" api_key=peWcBiMOS9HrZG15peWcBiMOS9HrZG15
u #i u resu messagei u name( R t
startswithR R t lent False( t nameR
t rett roomst room( ( s= /usr/lib/python2.7/site-packages/salt/modules/slack_notify.pyt find_roomq s
c C@ s~ | s t � } n t | � } | d rz | d } | rz x< t d t | � � D]" } | | d | k rN | | SqN Wqz n t S( um
Find a user by name and return it.
:param name: The user name.
:param api_key: The Slack admin api key.
:return: The user object.
CLI Example:
.. code-block:: bash
salt '*' slack.find_user name="ThomasHatch"
salt '*' slack.find_user name="ThomasHatch" api_key=peWcBiMOS9HrZG15peWcBiMOS9HrZG15
u resu messagei u name( R R R R R ( R R
R t userst user( ( s= /usr/lib/python2.7/site-packages/salt/modules/slack_notify.pyt find_user� s
c C@ s< | s t � } n | s( t j d � n | j d � rm | j d � rm t j d | | � d j | � } n | s� t j d � n | s� t j d � n | s� t j d � n i | d 6| d 6| d
6} | d k r� | | d <n t j j j
d d
d | d d d i d d 6d t | � d t � } | d r4t
S| Sd S( ub
Send a message to a Slack channel.
:param channel: The channel name, either will work.
:param message: The message to send to the Slack channel.
:param from_name: Specify who the message is from.
:param api_key: The Slack api key, if not specified in the configuration.
:param icon: URL to an image to use as the icon for this message
:return: Boolean if message was sent successfully.
CLI Example:
.. code-block:: bash
salt '*' slack.post_message channel="Development Room" message="Build is done" from_name="Build Server"
u channel is a required option.u #u @ui Channel name must start with a hash or @. Prepending a hash and using "#%s" as channel name instead of %su #{0}u from_name is a required option.u message is a required option.u channelu usernameu textu icon_urlR u messageR
t methodu POSTt header_dictu! application/x-www-form-urlencodedu Content-Typet dataR u resN( R t logt errorR t warningt formatt NoneR R R R t
_urlencodeR t True( t channelt messaget from_nameR
t icont
parameterst result( ( s= /usr/lib/python2.7/site-packages/salt/modules/slack_notify.pyt post_message� s:
u goodc
C@ sL d } | s t � } n t | | � } | s= t j d � n | r� i i | d 6| d 6| d 6i | d 6| d 6g d 6g d 6}
n
i | d
6}
| r� | |
d <n | r� | |
d <n | r� | |
d
<n t i t j j j |
� d 6� } t j j j
| d d d | d t �} | d d k r&t Si t d 6| j
d | d � d 6Sd S( u-
Send message to Slack incoming webhook.
:param message: The topic of message.
:param attachment: The message to send to the Slacke WebHook.
:param color: The color of border of left side
:param short: An optional flag indicating whether the value is short
enough to be displayed side-by-side with other values.
:param identifier: The identifier of WebHook.
:param channel: The channel to use instead of the WebHook default.
:param username: Username to use instead of WebHook default.
:param icon_emoji: Icon to use instead of WebHook default.
:return: Boolean if message was sent successfully.
CLI Example:
.. code-block:: bash
salt '*' slack.call_hook message='Hello, from SaltStack'
u! https://hooks.slack.com/services/u message is required optionu fallbacku coloru pretextu valueu shortu fieldsu attachmentsu textu channelu usernameu
icon_emojiu payloadR" u POSTR$ t statusu statusi� u resu bodyu messageN( R
t _urljoinR% R& R* R R t jsont dumpst httpR R+ R t get(
R- t
attachmentt colort shortt
identifierR, t usernamet
icon_emojit base_urlR t payloadR$ R1 ( ( s= /usr/lib/python2.7/site-packages/salt/modules/slack_notify.pyt call_hook� s@
'(" t __doc__t
__future__R R R t loggingt salt.utils.jsonR t salt.utils.slackt salt.exceptionsR t salt.ext.six.moves.urllib.parseR R* R R4 t salt.ext.six.movesR t salt.ext.six.moves.http_clientt getLoggert __name__R% R R R R
R) R R R R! R2 R RA ( ( ( s= /usr/lib/python2.7/site-packages/salt/modules/slack_notify.pyt <module> s6
" A
Mini Shell