Merge pull request #12 from alma/add-support-for-py35+

Handle client for Python3.5+ rather than Python3.7+

Author: Natim

.travis.yml

@@ -4,6 +4,8 @@ cache: pip
 install: pip install tox tox-travis
 script: tox -v
 python:
+- 3.5
+- 3.6
 - 3.7
 - 3.8
 matrix:

alma/client.py

@@ -31,7 +31,11 @@ def __init__(self, api_key, **options):
             raise TypeError("`api_root` option must be a dict or a string")
 
         if options["mode"] not in (ApiModes.LIVE, ApiModes.TEST):
-            raise ValueError(f"`mode` option must be one of ({ApiModes.LIVE}, {ApiModes.TEST})")
+            raise ValueError(
+                "`mode` option must be one of ({LIVE}, {TEST})".format(
+                    LIVE=ApiModes.LIVE, TEST=ApiModes.TEST
+                )
+            )
 
         self.context = Context(api_key, options)
 

alma/context.py

@@ -20,10 +20,12 @@ def mode(self):
     def url_for(self, path):
         root = self.api_root[self.mode].rstrip("/")
 
-        return f"{root}/{path.lstrip('/')}"
+        return "{root}/{path}".format(root=root, path=path.lstrip("/"))
 
     def add_user_agent_component(self, component, version):
-        self.user_agent_components.append(f"{component}/{version}")
+        self.user_agent_components.append(
+            "{component}/{version}".format(component=component, version=version)
+        )
 
     def user_agent_string(self):
         return "; ".join(self.user_agent_components[::-1])

alma/endpoints/exports.py

@@ -1,33 +1,42 @@
-from functools import partial
 from datetime import datetime
+from functools import partial
 from io import BytesIO
 
-from . import Base
-from ..entities import Export, ExportType, ExportFormat
+from ..entities import Export, ExportFormat, ExportType
 from ..paginated_results import PaginatedResults
+from . import Base
 
 
 class Exports(Base):
     EXPORTS_PATH = "/v1/data-exports"
 
-    def create(self, export_type: ExportType, payout_id: str = None,
-               start: datetime = None, end: datetime = None):
+    def create(
+        self,
+        export_type: ExportType,
+        payout_id: str = None,
+        start: datetime = None,
+        end: datetime = None,
+    ):
         """ Create a new export"""
         data = {"type": export_type.value}
         if payout_id:
-            data['payout'] = payout_id
+            data["payout"] = payout_id
 
         if start:
-            data['start'] = int(start.timestamp())
+            data["start"] = int(start.timestamp())
 
         if end:
-            data['end'] = int(end.timestamp())
+            data["end"] = int(end.timestamp())
 
         response = self.request(self.EXPORTS_PATH).set_body(data).post()
         return Export(response.json)
 
     def get_file(self, export_id: str, export_format: ExportFormat = None):
-        request = self.request(f"{self.EXPORTS_PATH}/{export_id}")
+        request = self.request(
+            "{EXPORTS_PATH}/{export_id}".format(
+                EXPORTS_PATH=self.EXPORTS_PATH, export_id=export_id
+            )
+        )
         if export_format:
             request.set_query_params({"format": export_format.value})
 
@@ -44,5 +53,9 @@ def fetch(self, export_id: str = None, limit: int = 5, **filters):
         if export_id is None:
             return self.fetch_all(limit=limit, **filters)
         else:
-            response = self.request(f"{self.EXPORTS_PATH}/{export_id}").get()
+            response = self.request(
+                "{EXPORTS_PATH}/{export_id}".format(
+                    EXPORTS_PATH=self.EXPORTS_PATH, export_id=export_id
+                )
+            ).get()
             return Export(response.json)

alma/endpoints/orders.py

@@ -9,7 +9,13 @@ class Orders(Base):
     ORDERS_PATH = "/v1/orders"
 
     def update(self, order_id, data):
-        response = self.request(f"{self.ORDERS_PATH}/{order_id}").set_body(data).put()
+        response = (
+            self.request(
+                "{ORDERS_PATH}/{order_id}".format(ORDERS_PATH=self.ORDERS_PATH, order_id=order_id)
+            )
+            .set_body(data)
+            .put()
+        )
         return Order(response.json)
 
     def fetch_all(self, limit: int = 20, starting_after: str = None, **filters):
@@ -31,5 +37,7 @@ def fetch(self, order_id: str = None, limit: int = 20, **filters):
         if order_id is None:
             return self.fetch_all(limit=limit, **filters)
         else:
-            response = self.request(f"{self.ORDERS_PATH}/{order_id}").get()
+            response = self.request(
+                "{ORDERS_PATH}/{order_id}".format(ORDERS_PATH=self.ORDERS_PATH, order_id=order_id)
+            ).get()
             return Order(response.json)

alma/endpoints/payments.py

@@ -10,7 +10,11 @@ class Payments(Base):
     PAYMENTS_PATH = "/v1/payments"
 
     def eligibility(self, order_data):
-        response = self.request(f"{self.PAYMENTS_PATH}/eligibility").set_body(order_data).post()
+        response = (
+            self.request("{PAYMENTS_PATH}/eligibility".format(PAYMENTS_PATH=self.PAYMENTS_PATH))
+            .set_body(order_data)
+            .post()
+        )
 
         return Eligibility(response.json)
 
@@ -34,11 +38,19 @@ def fetch(self, payment_id=None, limit=20, states=None):
         if payment_id is None:
             return self.fetch_all(limit=limit, states=states)
         else:
-            response = self.request(f"{self.PAYMENTS_PATH}/{payment_id}").get()
+            response = self.request(
+                "{PAYMENTS_PATH}/{payment_id}".format(
+                    PAYMENTS_PATH=self.PAYMENTS_PATH, payment_id=payment_id
+                )
+            ).get()
             return Payment(response.json)
 
     def flag_as_potential_fraud(self, payment_id, reason=None):
-        request = self.request(f"{self.PAYMENTS_PATH}/{payment_id}/potential-fraud")
+        request = self.request(
+            "{PAYMENTS_PATH}/{payment_id}/potential-fraud".format(
+                PAYMENTS_PATH=self.PAYMENTS_PATH, payment_id=payment_id
+            )
+        )
 
         if reason:
             request.set_body({"reason": reason})
@@ -59,7 +71,11 @@ def add_orders_to(self, payment_id, order_data: Union[List[dict], dict]) -> List
             order_data = [order_data]
 
         response = (
-            self.request(f"{self.PAYMENTS_PATH}/{payment_id}/orders")
+            self.request(
+                "{PAYMENTS_PATH}/{payment_id}/orders".format(
+                    PAYMENTS_PATH=self.PAYMENTS_PATH, payment_id=payment_id
+                )
+            )
             .set_body({"orders": order_data})
             .put()
         )
@@ -79,15 +95,23 @@ def set_orders_for(self, payment_id, order_data: Union[List[dict], dict]) -> Lis
             order_data = [order_data]
 
         response = (
-            self.request(f"{self.PAYMENTS_PATH}/{payment_id}/orders")
+            self.request(
+                "{PAYMENTS_PATH}/{payment_id}/orders".format(
+                    PAYMENTS_PATH=self.PAYMENTS_PATH, payment_id=payment_id
+                )
+            )
             .set_body({"orders": order_data})
             .post()
         )
 
         return [Order(o) for o in response.json]
 
     def get_orders_for(self, payment_id) -> List[Order]:
-        response = self.request(f"{self.PAYMENTS_PATH}/{payment_id}/orders").get()
+        response = self.request(
+            "{PAYMENTS_PATH}/{payment_id}/orders".format(
+                PAYMENTS_PATH=self.PAYMENTS_PATH, payment_id=payment_id
+            )
+        ).get()
         return [Order(o) for o in response.json]
 
     def refund(self, payment_id: str, amount: int, full_refund: bool = False, **params) -> Payment:
@@ -102,7 +126,11 @@ def refund(self, payment_id: str, amount: int, full_refund: bool = False, **para
                             Default: false.
         :return: Updated payment object
         """
-        req = self.request(f"{self.PAYMENTS_PATH}/{payment_id}/refund")
+        req = self.request(
+            "{PAYMENTS_PATH}/{payment_id}/refund".format(
+                PAYMENTS_PATH=self.PAYMENTS_PATH, payment_id=payment_id
+            )
+        )
 
         refund_params = {}
         if not full_refund:
@@ -120,6 +148,10 @@ def send_sms(self, payment_id: str):
         Will raise RequestError if the SMS API is not activated on your account or
         in case of any other error, otherwise returns True.
         """
-        self.request(f"{self.PAYMENTS_PATH}/{payment_id}/send-sms").post()
+        self.request(
+            "{PAYMENTS_PATH}/{payment_id}/send-sms".format(
+                PAYMENTS_PATH=self.PAYMENTS_PATH, payment_id=payment_id
+            )
+        ).post()
 
         return True

alma/request.py

@@ -17,7 +17,9 @@ def __init__(self, context, url):
 
         self.headers = {
             "User-Agent": self.context.user_agent_string(),
-            "Authorization": f"Alma-Auth {self.context.api_key}",
+            "Authorization": "Alma-Auth {context_api_key}".format(
+                context_api_key=self.context.api_key
+            ),
             "Accept": "application/json",
         }
         self.params = {}

dev-requirements.txt

@@ -2,9 +2,3 @@ black
 flake8
 isort
 mypy
-pytest<5.4
-pytest-cache
-pytest-cov
-pytest-sugar
-pytest-xdist
-tox

setup.py

@@ -14,7 +14,7 @@
     name="alma-client",
     version="1.0.2.dev0",
     description="Python API client for the Alma Installments API",
-    long_description=f"{README}\n\n{CHANGELOG}",
+    long_description="{README}\n\n{CHANGELOG}".format(README=README, CHANGELOG=CHANGELOG),
     long_description_content_type="text/markdown",
     url="https://github.com/alma/alma-python-client",
     author="Alma",

test-requirements.txt

@@ -0,0 +1,6 @@
+pytest<5.4
+pytest-cache
+pytest-cov
+pytest-sugar
+pytest-xdist
+tox