Vh]ddlmZmZmZeZdZdZdZddl Z ddl Z ddl m Z ddl m Z mZddl mZd Zdd lmZdd lmZd ZdZdZdZdZdZdZ dZ!dZ"e#dk(re"yy#e$rd ZdZ dZdZdZdZdZ dZdZYNwxYw))absolute_importdivisionprint_functiona module: pubnub_blocks short_description: PubNub blocks management module description: - 'This module allows Ansible to interface with the PubNub BLOCKS infrastructure by providing the following operations: create / remove, start / stop and rename for blocks and create / modify / remove for event handlers.' author: - PubNub (@pubnub) - Sergey Mamontov (@parfeon) requirements: - "pubnub_blocks_client >= 1.0" extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: none options: email: description: - Email from account for which new session should be started. - Not required if O(cache) contains result of previous module call (in same play). required: false type: str default: '' password: description: - Password which match to account to which specified O(email) belong. - Not required if O(cache) contains result of previous module call (in same play). required: false type: str default: '' cache: description: >- In case if single play use blocks management module few times it is preferred to enabled 'caching' by making previous module to share gathered artifacts and pass them to this parameter. required: false type: dict default: {} account: description: - Name of PubNub account for from which O(application) will be used to manage blocks. - User's account will be used if value not set or empty. type: str default: '' application: description: - Name of target PubNub application for which blocks configuration on specific O(keyset) will be done. type: str required: true keyset: description: - Name of application's keys set which is bound to managed blocks. type: str required: true state: description: - Intended block state after event handlers creation / update process will be completed. required: false default: 'present' choices: ['started', 'stopped', 'present', 'absent'] type: str name: description: - Name of managed block which will be later visible on admin.pubnub.com. required: true type: str description: description: - Short block description which will be later visible on U(https://admin.pubnub.com). - Used only if block does not exists and does not change description for existing block. required: false type: str event_handlers: description: - List of event handlers which should be updated for specified block O(name). - 'Each entry for new event handler should contain: V(name), V(src), V(channels), V(event). V(name) used as event handler name which can be used later to make changes to it.' - C(src) is full path to file with event handler code. - V(channels) is name of channel from which event handler is waiting for events. - 'V(event) is type of event which is able to trigger event handler: V(js-before-publish), V(js-after-publish), V(js-after-presence).' - Each entry for existing handlers should contain C(name) (so target handler can be identified). Rest parameters (C(src), C(channels) and C(event)) can be added if changes required for them. - It is possible to rename event handler by adding C(changes) key to event handler payload and pass dictionary, which will contain single key C(name), where new name should be passed. - To remove particular event handler it is possible to set C(state) for it to C(absent) and it will be removed. required: false default: [] type: list elements: dict changes: description: - List of fields which should be changed by block itself (does not affect any event handlers). - 'Possible options for change is: O(name).' required: false default: {} type: dict validate_certs: description: - This key allow to try skip certificates check when performing REST API calls. Sometimes host may have issues with certificates on it and this will cause problems to call PubNub REST API. - If check should be ignored V(false) should be passed to this parameter. required: false default: true type: bool a # Event handler create example. - name: Create single event handler community.general.pubnub_blocks: email: '{{ email }}' password: '{{ password }}' application: '{{ app_name }}' keyset: '{{ keyset_name }}' name: '{{ block_name }}' event_handlers: - src: '{{ path_to_handler_source }}' name: '{{ handler_name }}' event: 'js-before-publish' channels: '{{ handler_channel }}' # Change event handler trigger event type. - name: Change event handler 'event' community.general.pubnub_blocks: email: '{{ email }}' password: '{{ password }}' application: '{{ app_name }}' keyset: '{{ keyset_name }}' name: '{{ block_name }}' event_handlers: - name: '{{ handler_name }}' event: 'js-after-publish' # Stop block and event handlers. - name: Stopping block community.general.pubnub_blocks: email: '{{ email }}' password: '{{ password }}' application: '{{ app_name }}' keyset: '{{ keyset_name }}' name: '{{ block_name }}' state: stop # Multiple module calls with cached result passing - name: Create '{{ block_name }}' block register: module_cache community.general.pubnub_blocks: email: '{{ email }}' password: '{{ password }}' application: '{{ app_name }}' keyset: '{{ keyset_name }}' name: '{{ block_name }}' state: present - name: Add '{{ event_handler_1_name }}' handler to '{{ block_name }}' register: module_cache community.general.pubnub_blocks: cache: '{{ module_cache }}' application: '{{ app_name }}' keyset: '{{ keyset_name }}' name: '{{ block_name }}' state: present event_handlers: - src: '{{ path_to_handler_1_source }}' name: '{{ event_handler_1_name }}' channels: '{{ event_handler_1_channel }}' event: 'js-before-publish' - name: Add '{{ event_handler_2_name }}' handler to '{{ block_name }}' register: module_cache community.general.pubnub_blocks: cache: '{{ module_cache }}' application: '{{ app_name }}' keyset: '{{ keyset_name }}' name: '{{ block_name }}' state: present event_handlers: - src: '{{ path_to_handler_2_source }}' name: '{{ event_handler_2_name }}' channels: '{{ event_handler_2_channel }}' event: 'js-before-publish' - name: Start '{{ block_name }}' block register: module_cache community.general.pubnub_blocks: cache: '{{ module_cache }}' application: '{{ app_name }}' keyset: '{{ keyset_name }}' name: '{{ block_name }}' state: started z module_cache: description: - Cached account information. In case if with single play module used few times it is better to pass cached data to next module calls to speed up process. type: dict returned: always N)User)Block EventHandler) exceptionsTF) AnsibleModule)to_textcd}|j}|jdrP|djdr<|dd}t}|jt j |d|S|jdr>|jdr-t|jd|jd}|Sd }|j d |d |S) a{Create and configure user model if it possible. :type module: AnsibleModule :param module: Reference on module which contain module launch information and status report methods. :rtype: User :return: Reference on initialized and ready to use user or 'None' in case if not all required information has been passed to block. Ncache module_cachepnm_user)r emailpassword)rrzsIt looks like not account credentials has been passed or 'cache' field doesn't have result of previous module call.zMissing account credentials.Fmsg descriptionchanged)paramsgetrrestorecopydeepcopy fail_json)moduleuserrr err_msgs s/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/community/general/plugins/modules/pubnub_blocks.py pubnub_userr s D ]]F zz'vg22>Bw/v 4==z):; < K G J!7&**W- :8NO K  ;%,e  = Kc|j}|jdr[|jd}|j|jd}|%d}|jd|j |d|S|j d}|S)a&Create and configure account if it is possible. :type module: AnsibleModule :param module: Reference on module which contain module launch information and status report methods. :type user: User :param user: Reference on authorized user for which one of accounts should be used during manipulations with block. :rtype: Account :return: Reference on initialized and ready to use account or 'None' in case if not all required information has been passed to block. account)namezIt looks like there is no '{0}' account for authorized user. Please make sure what correct name has been passed during module configuration.zMissing account.Frr)rrr#rformataccounts)rrr account_namer#err_frmts rpubnub_accountr)s]]F zz)zz), ,,FJJy$9,: ?KH   !3)1)F%*  , N--/!$ Nr!c d}|j} |j|d}|Rd}|jj}|j|j|d||jt||S#tjtjf$rd}t |}t |dr |jn|jd}|j|||jt|Yd}~d}~wwxYw)ajRetrieve reference on target application from account model. NOTE: In case if account authorization will fail or there is no application with specified name, module will exit with error. :type module: AnsibleModule :param module: Reference on module which contain module launch information and status report methods. :type account: Account :param account: Reference on PubNub account model from which reference on application should be fetched. :rtype: Application :return: Reference on initialized and ready to use application model. N applicationmessagerrrrrzThere is no '{0}' application for {1}. Make sure what correct application name has been passed. If application doesn't exist you can create it on admin.pubnub.com.rrr)rr+r AccountErrorGeneralPubNubError_failure_title_from_exceptionhasattrr,argsrrdictownerrr%) rr#r+rexcexc_msg exc_descrerr_fmtrs rpubnub_applicationr:-sK ]]F5))&*?@ J ##W^^F=,A5I!(tG}  N   # #Z%B%B C5/4#*3 #:CKK W)!(&*7m  5 55sA::#DAC<<Dc|j}|j|d}|Fd}|j|j|d|j|j t ||S)aRetrieve reference on target keyset from application model. NOTE: In case if there is no keyset with specified name, module will exit with error. :type module: AnsibleModule :param module: Reference on module which contain module launch information and status report methods. :type account: Account :param account: Reference on PubNub account model which will be used in case of error to export cached data. :type application: Application :param application: Reference on PubNub application model from which reference on keyset should be fetched. :rtype: Keyset :return: Reference on initialized and ready to use keyset model. keysetzThere is no '{0}' keyset for '{1}' application. Make sure what correct keyset name has been passed. If keyset doesn't exist you can create it on admin.pubnub.com.r.)rr<rr%r$rr4)rr#r+rr<r9s r pubnub_keysetr=Rst$]]F   x 0 1F ~J W^^F8,<,7,<,<>!(tG}  N Mr!c Dd}|j} |j|d}|N|ddvrG|jd}|jdj||jt| |D|dd k(r> >*$ L# :>> >( L :>> >) L :BB B, L :EE EB L :CC CB L :FF F2 L :FF F0 L :FF F1 Lr!cd}|rUtjj|r6t|d5}|j } t |d}ddd|S|S#t $rYwxYw#1swY|SxYw)zRead file content. Try read content of file at specified path. :type path: str :param path: Full path to location of file which should be read'ed. :rtype: content :return: File content or 'None' Nrt)modesurrogate_or_strict)errors)ospathexistsopenreadr UnicodeError)rmcontent opened_file b_contents rrPrPs}G t$ $T " k#((*I !)4IJ  N7N      Ns)A+ A A(%A+'A((A++A5cttdddtddddtdddtddtdddtd dgd  tddtd ttd dttdttdtdd }t|d}ts|j d|j }t |}t||}t||}t|||}t|||}|duxr|jdk(}||ddk(r|j|d}||jdr!|djdr |dd|_|jdxs tD]>} | jdxsd } t| | } | dk(s+| s.|j!| @|r3|s1|dd!k(r|j#n|dd"k(r|j%|j&s |j)t|} | j7tt|#|j@xs |jB}|jE|| 'y#t*j,t*j.t*j0t*j2t*j4f$r} t|} | j7tt|#t9| }t;| d$r | j<n| j>d%}|j |||j@| &Yd} ~ 3d} ~ wwxYw)(NFstr)defaultrequiredtypeT)rxryrzno_log)ryrz)ryrzr{rB)r@rArBabsent)rxrzchoices)rzlistr4)rxrzelements)rxrzbool) rrr#r+r<r?r$revent_handlersrCr validate_certs) argument_specsupports_check_modez.pubnub_blocks_client required for this module.)r)r)r#)r#r+)r#r<r?r|rCr$r)rRrDr@rA)rr,rr-)rr)#r4r~r HAS_PUBNUB_BLOCKS_CLIENTrrr r)r:r=rHuid remove_blockrr$rTdelete_event_handlerstartstop check_modesaver APIAccessErrorrE BlockErrorEventHandlerErrorr0updater1r2r,r3r will_change exit_json)fieldsrrrr#r+r<rD is_new_blockevent_handler_datar?rNr6rr7r8changed_will_changes rmainrs 2E:b5uTJR%e<$U3Te<95FH 4e ,$E:JDF&ITV&146/Dv6 8FT JF #MN ]]F v DV$/G$VW=K 67 LF  @E$8bL VG_8E"  ::i VI%6%:%:6%B *62EJ#)**-=">"H$& : &**73@yE06H7<>M ]**=9  : \ '?i ' KKM G_ ) JJL    8 LLN=Ld4j12!//@W-@-@ 0|L)):+A+A%%z'C'C--/ 8 =L   d4j 9 :3C8G'.sI'> CHHQKI   i%,__*6  8 8 8s4J!!AM<1BM77M<__main__)$ __future__rrrrz __metaclass__ DOCUMENTATIONEXAMPLESRETURNrrlpubnub_blocks_clientrrrr r ImportErrorAccountOwner ApplicationKeysetansible.module_utils.basicr +ansible.module_utils.common.text.convertersr r r)r:r=rHrTr1rPr__name__r!rrsA@ j XQ f  )8/#5?<>"J>/d+\,^*MM` zFI  $ DG EK F ELJ sA''BB