Plugin import phase 1 (#22)

* Added import plugin

* Tests passed

Author: btoron

.gitignore

@@ -1,6 +1,167 @@
-
 dist/
 .env
 *.pyc
 .DS_Store
 *.xslx
+tests/test.xml
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

README.md

@@ -71,17 +71,21 @@ Experimental:
 
 ### Metadata / Properties
     get_properties (self, offset=0, limit=100, response_type=FULL_RESPONSE)
-    get_property(self, label: str, response_type=JSON_RESPONSE):
+    get_property(self, label: str, response_type=JSON_RESPONSE)
     create_or_replace_property(self, property: Property, response_type=JSON_RESPONSE)
 
 ### Metadata / Workskills
     get_workskills (self, offset=0, limit=100, response_type=FULL_RESPONSE)
     get_workskill(self, label: str, response_type=FULL_RESPONSE)
     create_or_update_workskill(self, skill: Workskill, response_type=FULL_RESPONSE)
     delete_workskill(self, label: str, response_type=FULL_RESPONSE)
-    get_workskill_conditions(self, response_type=FULL_RESPONSE):
+    get_workskill_conditions(self, response_type=FULL_RESPONSE)
     replace_workskill_conditions(self, data: WorskillConditionList, response_type=FULL_RESPONSE
 
+### Metadata / Plugins
+    import_plugin(self, plugin: str)
+    import_plugin_file(self, plugin: Path)
+
 ### Metadata / Resource Types
     get_resource_types(self, response_type=JSON_RESPONSE):
 
@@ -96,6 +100,7 @@ OFS REST API Version | PyOFSC
 21A| 1.8, 1.8,1, 1.9
 21D| 1.15
 22B| 1.16, 1.17
+22D| 1.18
 
 ## Deprecation Warning
 

ofsc/__init__.py

@@ -15,9 +15,12 @@ class OFSC:
 
     API_PORTAL = "https://api.etadirect.com"
 
-    def __init__(self, clientID, companyName, secret, baseUrl=API_PORTAL):
+    def __init__(self, clientID, companyName, secret, root=None, baseUrl=API_PORTAL):
         self._config = OFSConfig(
-            baseURL=baseUrl, clientID=clientID, secret=secret, companyName=companyName
+            baseURL=baseUrl,
+            clientID=clientID,
+            secret=secret,
+            companyName=companyName,
         )
         self.headers = {}
         self.headers["Authorization"] = "Basic " + self._config.authString.decode(

ofsc/metadata.py

@@ -2,6 +2,7 @@
 import json
 import logging
 import urllib
+from pathlib import Path
 from typing import List
 from urllib.parse import urljoin
 
@@ -252,3 +253,24 @@ def get_resource_types(self):
         url = urljoin(self.baseUrl, "/rest/ofscMetadata/v1/resourceTypes")
         response = requests.get(url, headers=self.headers)
         return response
+
+    # 202212 Import plugin
+    @wrap_return(response_type=FULL_RESPONSE, expected=[204])
+    def import_plugin_file(self, plugin: Path):
+        url = urljoin(
+            self.baseUrl, f"/rest/ofscMetadata/v1/plugins/custom-actions/import"
+        )
+        headers = self.headers
+        files = [("pluginFile", (plugin.name, plugin.read_text(), "text/xml"))]
+        response = requests.post(url, headers=self.headers, files=files)
+        return response
+
+    # 202212 Import plugin
+    @wrap_return(response_type=FULL_RESPONSE, expected=[204])
+    def import_plugin(self, plugin: str):
+        url = urljoin(
+            self.baseUrl, f"/rest/ofscMetadata/v1/plugins/custom-actions/import"
+        )
+        files = [("pluginFile", ("noname.xml", plugin, "text/xml"))]
+        response = requests.post(url, headers=self.headers, files=files)
+        return response

ofsc/models.py

@@ -12,7 +12,7 @@ class OFSConfig(BaseModel):
     clientID: str
     secret: str
     companyName: str
-    root: str
+    root: Optional[str]
 
     @property
     def authString(self):
@@ -44,6 +44,7 @@ class SharingEnum(str, Enum):
     minimal = "minimal"
     summary = "summary"
 
+
 class EntityEnum(str, Enum):
     activity = "activity"
     inventory = "inventory"
@@ -83,7 +84,7 @@ class Workskill(BaseModel):
     active: bool = True
     name: str = ""
     sharing: SharingEnum
-    translations: TranslationList = []
+    translations: Optional[TranslationList]
 
     @validator("translations", always=True)
     def set_default(cls, field_value, values):
@@ -144,6 +145,7 @@ def __iter__(self):
     def __getitem__(self, item):
         return self.__root__[item]
 
+
 class Property(BaseModel):
     label: str
     name: str
@@ -236,4 +238,3 @@ def __iter__(self):
 
     def __getitem__(self, item):
         return self.__root__[item]
-        

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ofsc"
-version = "1.17.4.15"
+version = "1.18.0.0"
 license = "MIT"
 description = "Python wrapper for Oracle Field Service API"
 authors = ["Borja Toron <borja.toron@gmail.com>"]

tests/OFSC_metadata_test.py

@@ -27,19 +27,6 @@ def setUp(self):
         )
         self.date = os.environ.get("OFSC_TEST_DATE")
 
-    # Test M.P.01 Get Properties
-    def test_get_properties(self):
-        self.logger.info("...M.P.01 Get Properties")
-        instance = self.instance
-        logger = self.logger
-        raw_response = instance.get_properties(response_type=FULL_RESPONSE)
-        logging.debug(self.pp.pformat(raw_response.json()))
-        response = raw_response.json()
-        logger.debug(self.pp.pformat(response))
-        self.assertIsNotNone(response["totalResults"])
-        self.assertEqual(response["totalResults"], 453)  # 22.B
-        self.assertEqual(response["items"][0]["label"], "ITEM_NUMBER")
-
     # Test C.P.10 Get File Property 01
     def test_get_file_property_01(self):
         self.logger.info("...C.P.01 Get File Property")

tests/OFSC_test.py

@@ -21,11 +21,12 @@ def setUp(self):
         self.pp = pprint.PrettyPrinter(indent=4)
         self.logger.setLevel(logging.DEBUG)
         # todo add credentials to test run
-        logging.warning("Here {}".format(os.environ.get("OFSC_CLIENT_ID")))
+        logging.info("ClientID {}".format(os.environ.get("OFSC_CLIENT_ID")))
         self.instance = OFSC(
             clientID=os.environ.get("OFSC_CLIENT_ID"),
             secret=os.environ.get("OFSC_CLIENT_SECRET"),
             companyName=os.environ.get("OFSC_COMPANY"),
+            root=os.environ.get("OFSC_ROOT"),
         )
         self.date = os.environ.get("OFSC_TEST_DATE")
 

tests/conftest.py

@@ -17,6 +17,7 @@ def instance():
         clientID=os.environ.get("OFSC_CLIENT_ID"),
         secret=os.environ.get("OFSC_CLIENT_SECRET"),
         companyName=os.environ.get("OFSC_COMPANY"),
+        root=os.environ.get("OFSC_ROOT"),
     )
     return instance