launchpy 0.4.3.post3__tar.gz → 0.4.4.post1__tar.gz

{launchpy-0.4.3.post3/launchpy.egg-info → launchpy-0.4.4.post1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: launchpy
-Version: 0.4.3.post3
+Version: 0.4.4.post1
 Summary: Adobe Launch API wrapper
 Home-page: https://github.com/pitchmuc/launchpy
 Author: Julien Piccini
@@ -30,6 +30,9 @@ Requires-Dist: pathlib2
 Requires-Dist: pathlib
 Provides-Extra: dynamic
 Requires-Dist: version; extra == "dynamic"
+Dynamic: author
+Dynamic: home-page
+Dynamic: requires-python
 
 # Launchpy
 

{launchpy-0.4.3.post3 → launchpy-0.4.4.post1}/docs/library.md

@@ -33,10 +33,10 @@ The different attributes are the following:
 
 * id : id of the library
 * name : name of the library
-* state : is it “development”, “staging” or “production” environment
+* state : is it "development", "staging" or "production" environment
 * build_required : is a build required or not (Boolean)
 * builds : The build attache to this library
-* buid_status : Is the last build has been “successful” ?
+* buid_status : Is the last build has been "successful" ?
 * relationships : the different element attached to this Library
 * _environments = a dictionary of the different environment possible.
 
@@ -45,10 +45,11 @@ The different attributes are the following:
 The get methods will enable you to retrieve the elements that have been attached to this library.
 The different get methods are the followings:
 
-* getDataElements
-* getExtensions
-* getRules
+* getDataElements : get the data element in that library
+* getExtensions : get the Extension in that library
+* getRules : get the rules in the library
 * getFullLibrary : It is a combinaison of all of the 3 above.
+* getBuilds : Retrieve the builds of that library
 
 ## Adding element to a library
 
@@ -62,7 +63,7 @@ They are the following:
 
 ## Environments settings
 
-Before you can actually start building the library and pass it from one state to another (“development” -> “staging”). You would need to set the different environments.
+Before you can actually start building the library and pass it from one state to another ("development" -> "staging"). You would need to set the different environments.
 
 The method used for that is : setEnvironments().
 It takes 2 arguments:
@@ -90,7 +91,7 @@ myLib.build() # require that you have set your environment.
 As it is your goal to publish your library, you want to transition it from the dev to the staging environment and so forth.
 In order to do that, you can use the transition() method.
 ***Note*** : You would need to build your library between 2 transition.
-At the end of the funnel, you just need to build your library when you are in the “approved” state.
+At the end of the funnel, you just need to build your library when you are in the "approved" state.
 The transition method takes 1 argument:
 
 * action : it can be either

{launchpy-0.4.3.post3 → launchpy-0.4.4.post1}/docs/property.md

@@ -98,6 +98,10 @@ The different get methods are the following :
   Arguments:
   * element : REQUIRED : the element definition dictionary
 
+* **getProductionEndpoint** : Get the URL for the production library
+
+* **getStagingEndpoint** : Get the URL for the staging library
+
 
 ## Create methods
 
@@ -322,6 +326,10 @@ They are not propertly defined by the Launch API, they have some business logic
   * save : OPTIONAL : bool, if you want to save the setting in a JS or JSON file, set it to true. (default False)
   * encoding : OPTIONAL : encoding to be used for saving the file.
 
+* **extractRuleComponents** : Extract the ruleComponents reference URL from the rule definition. It can be useful for extracting rule components from the last published rule.
+  Arguments:
+  * rule : REQUIRED : A dictionary that provide the definition of the rule.
+
 * **findRuleComponentSettingsFileName** : Return the filename use to save your custom code of your ruleComponent in a file using the extractSettings method.\
   Returns None when this is not a Custom code from CORE or Adobe Analytics. \
   Argument:

{launchpy-0.4.3.post3 → launchpy-0.4.4.post1}/docs/releases.md

@@ -3,6 +3,16 @@
 This page gathered the changes made between version of the launchpy module.\
 This has been started after the 0.3.0 release.\
 
+## 0.4.4
+* adding a `getBuilds` method on the `Library` class instance
+* extend support for pagination on `getEnvironments`
+* adding `getProductionEndpoint` and `getStagingEndpoint` to retrieve the URL to use on websites
+* support the instantiation of the `Library` class via a single libraryId string.\
+Patch:
+* adding a name parameter for the `checkExtensionUpdate` method
+* adding the `extractRuleComponents` method in property.
+
+
 ## 0.4.3
 * Refactor `Translator` class for removing `pandas` dependency\
 Patch:

{launchpy-0.4.3.post3 → launchpy-0.4.4.post1}/docs/synchronizer.md

@@ -240,4 +240,12 @@ The logic that will be applied during the sync is the following:
     * IF the component name is in that list, **and not** in the `exclComponents` list, it will be sync
     * IF the component name is in that list **and** in the `exclComponents` list, it will **NOT** be sync
   * IF there is no list of `inclComponents` for that target property (or empty list), **and not** in the `exclComponents` list, the component will be synced
-* ELSE: it will be sync
+* ELSE: it will be sync
+
+### Regular expression in Python
+
+One common issue seeing the pattern used in Regular Expression is the use of the quantifier `*` without any character before.\
+This can lead to some errors when using the following regular expression: `*some pattern*`\
+This type of pattern needs to be replaced by `.*some pattern.*`\
+
+The `*` is a quantifier that needs to have a character before it so it can know which character or pattern to repeat (or not).

launchpy-0.4.4.post1/launchpy/__version__.py

@@ -0,0 +1 @@
+__version__ = "0.4.4-1"

{launchpy-0.4.3.post3 → launchpy-0.4.4.post1}/launchpy/library.py

@@ -1,13 +1,14 @@
 import time
 # Non standard libraries
 from launchpy import config, connector
+from typing import Union
 
 class Library:
     """
     A class that handle the library in a Launch environment.
     """
 
-    def __init__(self, data: dict,config_object:dict=config.config_object,header:dict=config.header):
+    def __init__(self, data: Union[str,dict],config_object:dict=config.config_object,header:dict=config.header):
         """
         The instantiator for the library.
         Arguments:
@@ -19,6 +20,8 @@ class Library:
             config_object=config_object, header=header)
         self.header = self.connector.header
         self.endpoint = config.endpoints['global']
+        if type(data) == str:
+            data = self.connector.getData("https://reactor.adobe.io/libraries/"+data).get('data')
         self.id = data['id']
         self.name = data['attributes']['name']
         self.state = data['attributes']['state']
@@ -100,6 +103,23 @@ class Library:
             return dataOrigin
         self.relationships['extensions'] = data
         return data
+    
+    def getBuilds(self)->list:
+        """
+        Retrieve the last builds.
+        Return a list of build
+        """
+        params = {'page[number]':1}
+        res = self.connector.getData(self._Builds,params=params)
+        builds = res.get('data',[])
+        next_page = res.get('meta',{}).get('pagination',{}).get('next_page',None)
+        while next_page is not None:
+            params['page[number]'] +=1
+            res = self.connector.getData(self._Builds,params=params)
+            builds += res.get('data',[])
+            next_page = res.get('meta',{}).get('pagination',{}).get('next_page',None)
+        return builds
+
 
     def getRules(self,page:int=0,pageSize:int=50,origin:bool=True)->list:
         """
@@ -296,7 +316,7 @@ class Library:
         Save the different environments ids available. 
         It is required to use the library class.
         Arguments : 
-            environments_list : REQUIRED : list of environment retrieved by the getEnvironment method
+            environments_list : REQUIRED : list of environment retrieved by the getEnvironments method
             dev_name : OPTIONAL : Name of your dev environment. If not defined, will take the first dev environment.
         """
         for env in environments_list:

{launchpy-0.4.3.post3 → launchpy-0.4.4.post1}/launchpy/property.py

@@ -99,8 +99,15 @@ class Property:
         """
         Retrieve the environment sets for this property
         """
+        params = {"page[number]":1}
         env = self.connector.getData(self._Environments)
         data = env['data']  # skip meta for now
+        next_page = env.get('meta',{}).get('pagination',{}).get('next_page',None)
+        while next_page is not None:
+            params['page[number]'] = next_page
+            env = self.connector.getData(self._Environments,params=params)
+            data += env.get('data',[])
+            next_page = env.get('meta',{}).get('pagination',{}).get('next_page',None)
         return data
 
     def getHost(self)->object:
@@ -139,13 +146,14 @@ class Property:
             data = extensions
         return data
 
-    def checkExtensionUpdate(self, platform: str = "web", verbose: bool = False):
+    def checkExtensionUpdate(self, name:str=None, platform: str = "web", verbose: bool = False):
         """
         Returns a dictionary of extensions with their names, ids and if there is an update. 
         If there is an update available, the id returned is the latest id (to be used for installation). 
         It can be re-use for installation and for checking for update. 
         Arguments:
-            platform : REQUIRED : if you need to look for extension on a specific platform (default web).
+            name : OPTIONAL : If you want to check for a specific extension
+            platform : OPTIONAL : if you need to look for extension on a specific platform (default web).
             verbose: OPTIONAL : if set to True, will print the different name and id of the extensions checked.
         Dictionary example: 
         {'adobe-mcid':
@@ -155,13 +163,18 @@ class Property:
         }
         """
         extensions = self.getExtensions()
-        dict_extensions = {ext['attributes']['name']: {'package_id': ext['relationships']['extension_package']['data']['id'],
+        if name is None:
+            dict_extensions = {ext['attributes']['name']: {'package_id': ext['relationships']['extension_package']['data']['id'],
                                                        'update': False,
                                                        'internal_id': ext['id']
                                                        } for ext in extensions}
+        else:
+            dict_extensions = {ext['attributes']['name']: {'package_id': ext['relationships']['extension_package']['data']['id'],
+                                                       'update': False,
+                                                       'internal_id': ext['id']
+                                                       } for ext in extensions if ext['attributes']['name'] == name}
         for name in dict_extensions:
-            new_id = self._getExtensionPackage(
-                name, platform=platform, verbose=verbose)
+            new_id = self._getExtensionPackage(name, platform=platform, verbose=verbose)
             if new_id != dict_extensions[name]['package_id']:
                 dict_extensions[name]['package_id'] = new_id
                 dict_extensions[name]['update'] = True
@@ -258,9 +271,9 @@ class Property:
         """
         filters = {}
         if name != None:
-            filters['filter[name]=CONTAINS '] = f"EQ {name}"
+            filters['filter[name]'] = f"EQ {name}"
         if name_contains != None:
-            filters['filter[name]=CONTAINS '] = f"CONTAINS {name_contains}"
+            filters['filter[name]'] = f"CONTAINS {name_contains}"
         if dirty != None:
             filters['filter[dirty]'] = f"EQ {str(dirty).lower()}"
         if enabled != None:
@@ -297,6 +310,27 @@ class Property:
                 'url': rule['links']['rule_components']
             }
         return data
+    
+    def extractRuleComponents(self,rule:dict=None)->list:
+        """
+        Extract the rule component based on the rule definition.
+        Arguments:
+            rule : REQUIRED : The rule definition
+        """
+        if rule is None:
+            raise ValueError("No rule definition provided")
+        params={'page[number]':0}
+        rc_endpoint = rule['relationships']['rule_components']['links']['related']
+        page1 = self.getRessource(rc_endpoint)
+        data = page1.get('data',{})
+        next_page = page1.get('meta',{}).get('pagination',{}).get('next_page',None)
+        while next_page is not None:
+            params['page[number]'] = next_page
+            pageN = self.connector.getData(rc_endpoint,params=params)
+            data += pageN.get('data',[])
+            next_page = pageN.get('meta',{}).get('pagination',{}).get('next_page',None)
+        return data
+
 
     def getRuleComponents(self, verbose:bool=False,**kwargs)->dict:
         """
@@ -1187,6 +1221,22 @@ class Property:
         for de in dataelements:
             self.deleteDataElement(de['id'])
         return res
+    
+    def getProductionEndpoint(self)->dict:
+        """
+        Returns the production library URL to use on the website
+        """
+        envs = self.getEnvironments()
+        prod = [env for env in envs if env['attributes']['stage'] == 'production'][0]
+        return prod['meta']['script_sources'][0]["license_path"]
+
+    def getStagingEndpoint(self)->dict:
+        """
+        Returns the staging library URL to use on the website
+        """
+        envs = self.getEnvironments()
+        staging = [env for env in envs if env['attributes']['stage'] == 'staging'][0]
+        return staging['meta']['script_sources'][0]["license_path"]
 
 def extensionsInfo(data: list)->dict:
     """
@@ -1551,4 +1601,4 @@ def extractAnalyticsCode(rcSettings: str, save: bool = False, filename: str = No
         filename = filename.replace('/', '_').replace('|', '_')
         if save:
             saveFile(json_code,filename,type='js',encoding=encoding)
-        return json_code
+        return json_code

{launchpy-0.4.3.post3 → launchpy-0.4.4.post1}/launchpy/synchronizer.py

@@ -37,7 +37,7 @@ class Synchronizer:
             raise KeyError("The base property name has not been found in your account")
         self.base = {}
         self.base["name"] = base
-        self.base["api"] = Property(base_property[0])
+        self.base["api"]:Property = Property(base_property[0])
         self.base['rules'] = self.base['api'].getRules()
         self.base['dataElements'] = self.base['api'].getDataElements()
         self.base['extensions'] = self.base['api'].getExtensions()
@@ -353,6 +353,26 @@ class Synchronizer:
             if len(newDataElements)>0:
                 self.targets[target]['library'].addDataElements(newDataElements)
 
+    def upgradeTargetExtension(self,extensionName:str=None,platform:str="web")->dict:
+        """
+        Upgrade the name extension in the target properties.
+        Arguments:
+            extensionName : REQUIRED : The name of the extension to upgrade.
+                                        ex : "core" or "adobe-analytics"
+            platform : OPTIONAL : If you want to update the extension of a specific platform (default "web")
+        """
+        if extensionName is None:
+            raise ValueError("Require an extension name")
+        for prop, target in self.targets:
+            try:
+                extensionUpdate = target['api'].checkExtensionUpdate(extensionName)
+            except:
+                raise ValueError(f"Could not find an extension name: {extensionName}")
+            
+
+
+
+
     def renameComponent(self,old_name:str=None,new_name:str=None)->None:
         """
         Passing the old and new name of a component, it will rename the component in the different target properties.

{launchpy-0.4.3.post3 → launchpy-0.4.4.post1/launchpy.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: launchpy
-Version: 0.4.3.post3
+Version: 0.4.4.post1
 Summary: Adobe Launch API wrapper
 Home-page: https://github.com/pitchmuc/launchpy
 Author: Julien Piccini
@@ -30,6 +30,9 @@ Requires-Dist: pathlib2
 Requires-Dist: pathlib
 Provides-Extra: dynamic
 Requires-Dist: version; extra == "dynamic"
+Dynamic: author
+Dynamic: home-page
+Dynamic: requires-python
 
 # Launchpy
 

launchpy-0.4.3.post3/launchpy/__version__.py

@@ -1 +0,0 @@
-__version__ = "0.4.3-3"