adding Production and Staging URL fetch + support Library via string ID

Author: pitchmuc

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

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
 

docs/releases.md

@@ -3,6 +3,12 @@
 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. 
+
 ## 0.4.3
 * Refactor `Translator` class for removing `pandas` dependency\
 Patch:

launchpy/__version__.py

@@ -1 +1 @@
-__version__ = "0.4.3-3"
+__version__ = "0.4.4"

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 @@ def __init__(self, data: dict,config_object:dict=config.config_object,header:dic
  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 @@ def getExtensions(self,page:int=0,pageSize:int=50,origin:bool=True)->list:
  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 @@ def setEnvironments(self, environments_list: list, dev_name: str = None)->None:
  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/property.py

@@ -99,8 +99,15 @@ def getEnvironments(self)->object:
  """
  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:
@@ -1187,6 +1194,22 @@ def deleteLibrary(self,library:str=None,components:bool=False)->str:
  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:
  """