mss-python 0.1.2__tar.gz → 0.1.5__tar.gz

mss_python-0.1.5/.flake8

@@ -0,0 +1,3 @@
+[flake8]
+exclude = simple  # Exclude for the moment
+ignore = E501,E265,E266,E402

mss_python-0.1.5/.github/workflows/python-publish.yml

@@ -0,0 +1,46 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    permissions:
+      id-token: write
+
+    environment:
+      name: pypi
+      url: https://pypi.org/p/mss-python
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: "3.x"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+      - name: Build package
+        run: python -m build
+      - name: Publish package
+        uses: pypa/gh-action-pypi-publish@release/v1

mss_python-0.1.5/.gitignore

@@ -0,0 +1,8 @@
+XML-samples
+.env
+__pycache__
+src/mss_python.egg-info/
+setup.cfg
+.DS_Store
+dist/
+_version.py

mss_python-0.1.5/.vscode/settings.json

@@ -0,0 +1,4 @@
+{
+    "editor.formatOnSave": true,
+    "python.analysis.typeCheckingMode": "off"
+}

mss_python-0.1.5/PKG-INFO

@@ -0,0 +1,99 @@
+Metadata-Version: 2.1
+Name: mss-python
+Version: 0.1.5
+Summary: MSS API wrapper for Python projects
+Author-email: HGV <development@hgv.it>
+License: MIT License
+        
+        Copyright (c) 2024 Booking Südtirol
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Repository, https://github.com/bookingsuedtirol/mss-python
+Requires-Python: <4,>=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# mss-python
+
+MSS API client for Python projects
+
+<!-- ## Dependencies
+
+This library requires an IANA Time Zone database to be present on the operating system (because it uses https://pkg.go.dev/time#LoadLocation). This database comes pre-installed with many Linux distros. If it’s unavailable (such as on Windows), https://pkg.go.dev/time/tzdata can be imported in the main program (which uses mss-go) instead. -->
+
+## Available methods
+
+- [x] getHotelList
+- [x] getHotelListByFilter
+- [x] getSpecialList
+- [x] getRoomList
+- [x] getWidgetConfig
+- [x] getBooking
+- [x] cancelBooking
+- [x] prepareBooking
+- [x] getAvailability
+- [x] getRoomAvailability
+- [x] getDayAvailability
+- [x] getPriceList
+- [x] createInquiry
+- [x] getLocationList
+- [x] getThemeList
+- [x] getMasterpackagesList
+- [x] notifyMasterpackages
+- [x] getLastMinuteQuotation
+- [x] validateCoupon
+- [x] getHotelPictures
+- [x] getHotelPictureGroups
+- [x] getOptionalServices
+
+## Example Execution
+
+`pip install -r requirements.txt`
+
+`python3 -m examples.simple.main`
+
+<!-- -
+
+TODO
+
+- [x] getInquiry - how to find booking IDs?
+
+
+- [x] getUserSources
+
+  -->
+
+<!-- Warning: Only the methods with a ✓ next to them have been tested so far.
+
+## Before running examples/tests
+
+Set the environment variables with:
+
+```Bash
+export $(make env)
+```
+
+## Examples
+
+Run `make simple` or `make advanced`
+
+## Tests
+
+Run `make test` -->

{mss_python-0.1.2 → mss_python-0.1.5}/README.md

@@ -8,20 +8,20 @@ This library requires an IANA Time Zone database to be present on the operating
 
 ## Available methods
 
-- [x] getHotelList 
+- [x] getHotelList
 - [x] getHotelListByFilter
-- [x] getSpecialList 
+- [x] getSpecialList
 - [x] getRoomList
-- [x] getWidgetConfig 
+- [x] getWidgetConfig
 - [x] getBooking
-- [x] cancelBooking 
-- [x] prepareBooking 
-- [x] getAvailability 
+- [x] cancelBooking
+- [x] prepareBooking
+- [x] getAvailability
 - [x] getRoomAvailability
 - [x] getDayAvailability
-- [x] getPriceList 
+- [x] getPriceList
 - [x] createInquiry
-- [x] getLocationList 
+- [x] getLocationList
 - [x] getThemeList
 - [x] getMasterpackagesList
 - [x] notifyMasterpackages
@@ -31,25 +31,20 @@ This library requires an IANA Time Zone database to be present on the operating
 - [x] getHotelPictureGroups
 - [x] getOptionalServices
 
-
 ## Example Execution
 
-`cd ./examples/simple`
-
-`python3 main.py`
-
-or
+`pip install -r requirements.txt`
 
-`python3 -m main`
+`python3 -m examples.simple.main`
 
-<!-- - 
+<!-- -
 
 TODO
 
 - [x] getInquiry - how to find booking IDs?
 
 
-- [x] getUserSources 
+- [x] getUserSources
 
   -->
 

mss_python-0.1.5/examples/simple/main.py

@@ -0,0 +1,42 @@
+from src.mss_python.client import Client
+from src.mss_python.request.types_mss import (
+    Credentials,
+    Request,
+    Search,
+    Options,
+    HotelDetails,
+)
+from src.mss_python.request.methods import MethodName
+
+
+if __name__ == "__main__":
+    credentials = Credentials(
+        "MSS_SERVICE_USERNAME",
+        "MSS_SERVICE_PASSWORD",
+        "MSS_SERVICE_SOURCE",
+    )
+    lang = "de"
+    client = Client(credentials, lang)
+
+    req = Request(
+        Search("de", id=["YOUR_HOTEL_ID_1", "YOUR_HOTEL_ID_2", "YOUR_HOTEL_ID_3"]),
+        Options(HotelDetails.BasicInfo | HotelDetails.Coordinates),
+    )
+
+    try:
+
+        resp = client.request(
+            "MSS_SERVICE_URL",
+            MethodName.GetHotelList,
+            req,
+        )
+
+        hotel = resp["result"]["hotel"][0]
+
+        print(type(hotel["name"]), hotel["name"])
+        print(type(hotel["stars"]), hotel["stars"])
+
+        print(type(hotel["geolocation"]["latitude"]), hotel["geolocation"]["latitude"])
+
+    except Exception as e:
+        print(e)

mss_python-0.1.5/pyproject.toml

@@ -0,0 +1,23 @@
+[build-system]
+requires = ["setuptools>=64", "setuptools_scm>=8"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "mss-python"
+description = "MSS API wrapper for Python projects"
+readme = "README.md"
+requires-python = ">=3.7, <4"
+license = { file = "LICENSE" }
+authors = [{ name = "HGV", email = "development@hgv.it" }]
+dynamic = ["version"]
+
+[project.urls]
+Repository = "https://github.com/bookingsuedtirol/mss-python"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["mss_python"]
+namespaces = false
+
+[tool.setuptools_scm]
+version_file = "src/mss_python/_version.py"

mss_python-0.1.5/requirements.txt

@@ -0,0 +1 @@
+xmltodict==0.13.0

mss_python-0.1.5/src/mss_python/_version.py

@@ -0,0 +1,16 @@
+# file generated by setuptools_scm
+# don't change, don't track in version control
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple, Union
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+else:
+    VERSION_TUPLE = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+
+__version__ = version = '0.1.5'
+__version_tuple__ = version_tuple = (0, 1, 5)

mss_python-0.1.5/src/mss_python/client.py

@@ -0,0 +1,111 @@
+import requests
+import xmltodict
+import xml.etree.ElementTree as ET
+
+from .request.methods import Method
+from .request.types_mss import Root, BaseType, Credentials, Search, MethodName, Literal
+
+
+# maybe recursion should be used instead of doing if checks?
+def change_structure(root: Root, child: BaseType):
+    if child.tag == "root":
+        return child
+
+    if child.tag == "request":
+        root.request = child
+
+    elif child.tag == "search":
+        root.request.search = child
+
+    elif child.tag == "order":
+        root.request.order = child
+
+    elif child.tag == "options":
+        root.request.options = child
+
+    elif child.tag == "logging":
+        root.request.logging = child
+
+    elif child.tag == "header":
+        root.header = child
+
+    return root
+
+
+class Client:
+    def __init__(
+        self, cred: Credentials, lang: list, elements: list | None = None
+    ) -> None:
+        self.cred = cred
+        self.lang = Search(lang)
+
+    def request(
+        self,
+        url: str,
+        method_name: MethodName,
+        data: BaseType | None = None,
+        _print: Literal[True, False] = False,
+    ) -> dict:
+        """
+        Makes a post request to the given URL with the specified data and method name.
+
+        data: ElementTree with the data required in the XML
+        url: Service URL
+        method: Method to be executed by the service
+        """
+
+        method = Method(method_name)
+
+        root = method.get_base_xml(self.cred, self.lang)
+
+        if data is None:
+            root = change_structure(root, data)
+
+        if _print is True:
+            print(ET.tostring(root.request.to_xml(), encoding="unicode"))
+
+        response = requests.post(
+            url,
+            data=ET.tostring(root.to_xml(), encoding="unicode"),
+            headers={"Content-Type": "application/xml"},
+        )
+
+        responseRoot = xmltodict.parse(response.content)
+        error = responseRoot["root"]["header"]["error"]
+        if int(error["code"]) > 0:
+            raise Exception(
+                f'MSS returned an error: code {error["code"]}, message: "{error["message"]}"'
+            )
+
+        return refine_response(responseRoot["root"], method_name)
+
+
+def refine_response(resp: dict, meth: MethodName) -> dict:
+    if meth == MethodName.GetHotelList:
+        return refine_getHotelList(resp)
+
+    return resp
+
+
+def refine_getHotelList(resp: dict) -> dict:
+    if resp["result"] is None:
+        return resp
+    elif "hotel" not in resp["result"] or resp["result"]["hotel"] is None:
+        return resp
+    elif resp["result"]["hotel"] is list:
+        resp["result"]["hotel"] = [resp["result"]["hotel"]]
+
+    for hotel in resp["result"]["hotel"]:
+        ensure_list_value(hotel, "pictures", "picture")
+        ensure_list_value(hotel, "gallery", "picture")
+        ensure_list_value(hotel, "feature_view", "feature")
+        ensure_list_value(hotel, "pos", "id_pos")
+
+    return resp
+
+
+def ensure_list_value(hotel: dict, parent_fld: str, child_fld: str) -> None:
+    if parent_fld not in hotel:
+        hotel[parent_fld] = {child_fld: []}
+    elif hotel[parent_fld][child_fld] is list:
+        hotel[parent_fld][child_fld] = [hotel[parent_fld][child_fld]]

mss_python-0.1.5/src/mss_python/request/method_names.py

@@ -0,0 +1,28 @@
+from enum import Enum
+
+
+class MethodName(Enum):
+    GetHotelList = "getHotelList"
+    GetHotelListByFilter = "getHotelListByFilter"
+    GetSpecialList = "getSpecialList"
+    GetRoomList = "getRoomList"
+    GetWidgetConfig = "getWidgetConfig"
+    GetPriceList = "getPriceList"
+    GetAvailability = "getAvailability"
+    GetRoomAvailability = "getRoomAvailability"
+    GetDayAvailability = "getDayAvailability"
+    PrepareBooking = "prepareBooking"
+    GetBooking = "getBooking"
+    CancelBooking = "cancelBooking"
+    CreateInquiry = "createInquiry"
+    GetInquiry = "getInquiry"
+    GetUserSources = "getUserSources"
+    GetLocationList = "getLocationList"
+    GetMasterpackagesList = "getMasterpackagesList"
+    NotifyMasterpackages = "notifyMasterpackages"
+    GetThemeList = "getThemeList"
+    GetLastminuteQuotations = "getLastminuteQuotations"
+    GetHotelPictures = "getHotelPictures"
+    GetHotelPictureGroups = "getHotelPictureGroups"
+    GetOptionalServices = "getOptionalServices"
+    ValidateCoupon = "validateCoupon"

mss_python-0.1.5/src/mss_python/request/methods.py

@@ -0,0 +1,23 @@
+from __future__ import annotations
+
+from .method_names import MethodName
+from .types_mss import Credentials, Search, Root, Header, Request
+
+
+class Method:
+    def __init__(self, name: MethodName):
+        self.name = name
+
+    def get_base_xml(self, cred: Credentials, lang: Search) -> Root:
+        """
+        Returns an XML (ElementTree) with the mandatory elements needed for the request.
+
+        cred: XML Credentials Element (username, password, source)
+
+        lang: XML Search Element with the language element defined
+        """
+
+        header = Header(cred, self.name)
+        req = Request(lang)
+        root = Root(header, req)
+        return root