python-backlog 0.7.4__py3-none-any.whl → 0.7.6__py3-none-any.whl

backlog/attachment.py

@@ -20,10 +20,12 @@ class Attachment(object):
 
         _uri = "space/attachment"
         _method = "POST"
-        _files = {
-            'file': (os.path.basename(filename), open(filename, 'rb'), mimetypes.guess_type(filename))
-        }
+        _content_type = mimetypes.guess_type(filename)[0] or "application/octet-stream"
 
-        resp = self.api.invoke_method(_method, _uri, files=_files)
+        with open(filename, 'rb') as f:
+            _files = {
+                'file': (os.path.basename(filename), f, _content_type)
+            }
+            resp = self.api.invoke_method(_method, _uri, files=_files)
 
         return resp.json()

backlog/base.py

@@ -1,6 +1,6 @@
 # coding: utf-8
 
-from urllib.parse import urlencode
+import re
 import requests
 from backlog.wiki import Wiki
 from backlog.attachment import Attachment
@@ -13,6 +13,12 @@ from backlog.custom_field import CustomField
 
 BACKLOG_BASE_URL = "https://{space}.backlog.jp"
 BACKLOG_URI_PREFIX = "/api/v2/"
+BACKLOG_API_KEY_HEADER = "Backlog-API-Key"
+DEFAULT_TIMEOUT = 30
+
+# Space keys consist of alphanumerics and hyphens. Validating it prevents the
+# base URL (and therefore the API key) from being pointed at an arbitrary host.
+_SPACE_PATTERN = re.compile(r"^[A-Za-z0-9][A-Za-z0-9-]*$")
 
 
 class BacklogError(Exception):
@@ -20,9 +26,18 @@ class BacklogError(Exception):
 
 
 class BaseAPI(object):
-    def __init__(self, space, api_key=None):
+    def __init__(self, space, api_key=None, timeout=DEFAULT_TIMEOUT):
+        """
+        :param space: Backlog space key (the "xxx" of https://xxx.backlog.jp)
+        :param api_key: API key. It is sent in the "Backlog-API-Key" request header.
+        :param timeout: Default timeout (seconds) passed to the HTTP client.
+            Can be overridden per request with the "timeout" keyword argument. None disables it.
+        """
+        if not isinstance(space, str) or not _SPACE_PATTERN.match(space):
+            raise ValueError("Invalid space key: {!r}".format(space))
         self.space = space
         self.api_key = api_key
+        self.timeout = timeout
         self.base_url = BACKLOG_BASE_URL.format(space=space) + BACKLOG_URI_PREFIX
         self.api = None
         self._build_api()
@@ -30,7 +45,18 @@ class BaseAPI(object):
     def _build_api(self):
         self.api = None
 
-    def invoke_method(self, method, uri, query_param={}, request_param={}, headers=None, **kwargs):
+    def _build_headers(self, headers=None):
+        """
+        Merge authentication headers into the given headers without mutating it.
+        """
+        _headers = {}
+        if self.api_key is not None:
+            _headers[BACKLOG_API_KEY_HEADER] = self.api_key
+        if headers:
+            _headers.update(headers)
+        return _headers
+
+    def invoke_method(self, method, uri, query_param=None, request_param=None, headers=None, **kwargs):
         """
         Delegate requests to get/post/delete method.
         Each method implements by any http client, default client is requests.
@@ -39,10 +65,14 @@ class BaseAPI(object):
         :param uri: API Endpoint. 'uri' expects a URI excluded '/api/v2/' prefix
         :param query_param: dict of URL parameter. this will be url-encoded string
         :param request_param: dict of body parameter. this will use when invoke post request
-        :param headers: HTTP Header dict. Recommend value is None. if None, then use default implements of http client(requests).
+        :param headers: HTTP Header dict. Authentication headers are added automatically.
         :return: http response object
         """
-        query_param.setdefault("apiKey", self.api_key)
+        # Copy the arguments so that neither the caller's dicts nor any shared state are mutated.
+        query_param = dict(query_param or {})
+        request_param = dict(request_param or {})
+        headers = self._build_headers(headers)
+        kwargs.setdefault("timeout", self.timeout)
 
         method = method.lower()
 
@@ -100,64 +130,31 @@ class BacklogAPI(BaseAPI):
         self.category = Category(self)
         self.custom_field = CustomField(self)
 
-    def get(self, method, uri, query_param, request_param, headers, **kwargs):
-        _url = self.base_url + uri
-        if headers is not None:
-            resp = requests.get(_url, params=query_param, headers=headers, **kwargs)
-        else:
-            resp = requests.get(_url, params=query_param, **kwargs)
-
-        if resp.status_code // 100 == 2:
+    @staticmethod
+    def _raise_for_status(resp, ok):
+        if ok(resp.status_code):
             return resp
-
         raise BacklogError("Http response {status}: {message}".format(status=resp.status_code, message=resp.text))
 
-    def post(self, method, uri, query_param, request_param, headers, **kwargs):
-        _url = self.base_url + uri + "?" + urlencode(query_param)
-        if headers is not None:
-            resp = requests.post(_url, data=request_param, headers=headers, **kwargs)
-        else:
-            resp = requests.post(_url, data=request_param, **kwargs)
-
-        if resp.status_code // 100 == 2:
-            return resp
+    def get(self, method, uri, query_param, request_param, headers, **kwargs):
+        _url = self.base_url + uri
+        resp = requests.get(_url, params=query_param, headers=headers, **kwargs)
+        return self._raise_for_status(resp, lambda code: code // 100 == 2)
 
-        raise BacklogError("Http response {status}: {message}".format(status=resp.status_code, message=resp.text))
+    def post(self, method, uri, query_param, request_param, headers, **kwargs):
+        _url = self.base_url + uri
+        resp = requests.post(_url, params=query_param, data=request_param, headers=headers, **kwargs)
+        return self._raise_for_status(resp, lambda code: code // 100 == 2)
 
     def delete(self, method, uri, query_param, request_param, headers, **kwargs):
-        _url = self.base_url + uri + "?" + urlencode(query_param)
-        if headers is not None:
-            resp = requests.delete(_url, headers=headers, **kwargs)
-        else:
-            resp = requests.delete(_url, **kwargs)
-
-        if resp.status_code == 200:
-            return resp
-
-        raise BacklogError("Http response {status}: {message}".format(status=resp.status_code, message=resp.text))
+        _url = self.base_url + uri
+        resp = requests.delete(_url, params=query_param, data=request_param, headers=headers, **kwargs)
+        return self._raise_for_status(resp, lambda code: code // 100 == 2)
 
     def patch(self, method, uri, query_param, request_param, headers, **kwargs):
-        """
-        TODO: Implementation.
-
-        :param method:
-        :param uri:
-        :param query_param:
-        :param request_param:
-        :param headers:
-        :param kwargs:
-        :return:
-        """
-        _url = self.base_url + uri + "?" + urlencode(query_param)
-        if headers is not None:
-            resp = requests.ptach(_url, data=request_param, headers=headers, **kwargs)
-        else:
-            resp = requests.patch(_url, data=request_param, **kwargs)
-
-        if resp.status_code == 200:
-            return resp
-
-        raise BacklogError("Http response {status}: {message}".format(status=resp.status_code, message=resp.text))
+        _url = self.base_url + uri
+        resp = requests.patch(_url, params=query_param, data=request_param, headers=headers, **kwargs)
+        return self._raise_for_status(resp, lambda code: code // 100 == 2)
 
 
 class BacklogObject(object):

backlog/issue.py

@@ -124,7 +124,7 @@ class Issue(object):
         if attachmentId is not None:
             _data.update([("attachmentId[]", attachmentId)])
 
-        resp = self.api.invoke_method(_method, _uri, _data)
+        resp = self.api.invoke_method(_method, _uri, request_param=_data)
 
         return resp.json()
 

backlog/project.py

@@ -72,6 +72,7 @@ class Project(object):
         useOriginalImageSizeAtWiki: Optional[bool] = None,
         textFormattingRule: Optional[TextFormattingRule] = None,
         useDevAttributes: Optional[bool] = None,
+        chartEnabled: Optional[bool] = None,
     ) -> AddProjectResponse:
         """Add project
         https://developer.nulab.com/docs/backlog/api/2/add-project/#form-parameters
@@ -80,8 +81,10 @@ class Project(object):
         :type name: str
         :param key: Project Key (Uppercase letters (A-Z), numbers (0-9) and underscore (_) can be used.)
         :type key: str
-        :param chatEnabled: Enable chart
+        :param chatEnabled: Deprecated alias of chartEnabled, kept for backward compatibility
         :type chatEnabled: bool
+        :param chartEnabled: Enable chart
+        :type chartEnabled: bool
         :param useResolvedForChart: Consider Resolved and statuses after as Closed
         :type useResolvedForChart: bool
         :param subtaskingEnabled: Enable subtasking
@@ -109,10 +112,14 @@ class Project(object):
         """
         _path = "projects"
         _method = "POST"
+        if chartEnabled is not None and chatEnabled is not None and chartEnabled != chatEnabled:
+            raise ValueError("chartEnabled and its deprecated alias chatEnabled have conflicting values")
+        if chartEnabled is None:
+            chartEnabled = chatEnabled
         request_param = {
             "name": name,
             "key": key,
-            "chartEnabled": chatEnabled,
+            "chartEnabled": chartEnabled,
             "useResolvedForChart": useResolvedForChart,
             "subtaskingEnabled": subtaskingEnabled,
             "projectLeaderCanEditProjectLeader": projectLeaderCanEditProjectLeader,
@@ -241,7 +248,7 @@ class Project(object):
         _uri = "projects/{project_id_or_key}/users".format(project_id_or_key=projectIdOrKey)
         _method = "GET"
         _query_param = {
-            "excludeGroupMembers": "ture" if excludeGroupMembers else "false"
+            "excludeGroupMembers": "true" if excludeGroupMembers else "false"
         }
 
         resp = self.api.invoke_method(_method, _uri, query_param=_query_param)
@@ -361,7 +368,7 @@ class Project(object):
         )
         _method = "POST"
 
-        resp = self.api.invoke_method(_method, _uri)
+        resp = self.api.invoke_method(_method, _uri, request_param={"name": name})
 
         return resp.json()
 
@@ -380,7 +387,7 @@ class Project(object):
         )
         _method = "PATCH"
 
-        resp = self.api.invoke_method(_method, _uri)
+        resp = self.api.invoke_method(_method, _uri, request_param={"name": name})
 
         return resp.json()
 

backlog/user.py

@@ -51,7 +51,7 @@ class User(object):
         _method = "POST"
         params = dict(
             userId=userId,
-            passowrd=password,
+            password=password,
             name=name,
             mailAddress=mailAddress,
             roleType=roleType
@@ -61,7 +61,7 @@ class User(object):
 
         return resp.json()
 
-    def update(self, userId, password, name, mailAddress, roleType):
+    def update(self, userId, password=None, name=None, mailAddress=None, roleType=None):
         """
         https://developer.nulab.com/ja/docs/backlog/api/2/update-user/
 
@@ -75,12 +75,12 @@ class User(object):
         _uri = "users/{user_id}".format(user_id=userId)
         _method = "PATCH"
         params = dict(
-            userId=userId,
-            passowrd=password,
+            password=password,
             name=name,
             mailAddress=mailAddress,
             roleType=roleType
         )
+        params = {k: v for k, v in params.items() if v is not None}
 
         resp = self.api.invoke_method(_method, _uri, request_param=params)
 

backlog/wiki.py

@@ -1,5 +1,22 @@
 # coding: utf-8
 
+from email.message import Message
+
+
+def _filename_from_response(resp):
+    """
+    Extract the file name from the Content-Disposition header (supports RFC 6266 filename*).
+
+    :return: file name, or None if the header does not contain one
+    """
+    _content_disposition = resp.headers.get("Content-Disposition")
+    if not _content_disposition:
+        return None
+    _message = Message()
+    _message["Content-Disposition"] = _content_disposition
+    return _message.get_filename()
+
+
 class Wiki(object):
     def __init__(self, api):
         """
@@ -146,7 +163,7 @@ class Wiki(object):
 
         return {
             "id": attachmentId,
-            "name": "test",
+            "name": _filename_from_response(resp),
             "data": resp.content
         }
 

{python_backlog-0.7.4.dist-info → python_backlog-0.7.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: python-backlog
-Version: 0.7.4
+Version: 0.7.6
 Summary: Backlog API v2 wrapper
 Home-page: https://github.com/hassaku63/pbl
 Author: hassaku63
@@ -18,7 +18,20 @@ Classifier: Natural Language :: Japanese
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: requests ~=2.32.2
+Requires-Dist: requests~=2.32.2
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 # pbl
 
@@ -44,6 +57,8 @@ def main():
     """
     Initialize API Object
     """
+    # The API key is sent in the "Backlog-API-Key" request header.
+    # Requests time out after 30 seconds by default (configurable with `timeout=`).
     api = BacklogAPI("your-space", "your-api-key")
 
     """

python_backlog-0.7.6.dist-info/RECORD

@@ -0,0 +1,15 @@
+backlog/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+backlog/attachment.py,sha256=_Ex_ob7NC0ZMrt_5OM3MqLzIQrswx8SceKhOYNY5Wgs,872
+backlog/base.py,sha256=CnZ0LLGcHb8yJm6v4gXmVUcki_M1U3Wv8kNgZgyLGoc,6120
+backlog/category.py,sha256=DQ06yhOCXxtDbPMZ1Ig1QD8n7Ht_ZFrp8PJzO18IeZk,2530
+backlog/custom_field.py,sha256=dJ-XnrYv0rlpLvPhIkZEgcyNjZB8GR3352Or8HUPKlc,12243
+backlog/git.py,sha256=mazfvwn1Ekga0eeigk22Xf3vhXEo-P5Irfyq6r_QbaA,3056
+backlog/issue.py,sha256=E7bhNLLQd1KkSEilGcrmKYlkfi_w8rVfRF6xI-PGEtc,6650
+backlog/project.py,sha256=SCNbxjpzKwK5eijN58su9jHnBnIT8XcLqU8kv_vuE3s,14348
+backlog/user.py,sha256=kSEkInekQ8aGgYs5ygCdA5tsUYK3cxO9_Aay-sfaC2A,2890
+backlog/wiki.py,sha256=ThfWC-OlnHDHMYeARYJega92fd3QhZ817mhWF1OegT4,5943
+python_backlog-0.7.6.dist-info/licenses/LICENSE,sha256=1teWq4411yGkUz_9lD1V74mcHFRix2IqOAoFaghKYwo,1073
+python_backlog-0.7.6.dist-info/METADATA,sha256=zQYcB_HEpAJsShHe0HjN1GjWMWay4WlfCv_fxc7n9a0,2591
+python_backlog-0.7.6.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+python_backlog-0.7.6.dist-info/top_level.txt,sha256=qzHRU2P6F24ntkXGiIBl4Qf_AlV0BRebSc5tuLlcOIE,8
+python_backlog-0.7.6.dist-info/RECORD,,

{python_backlog-0.7.4.dist-info → python_backlog-0.7.6.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (74.1.2)
+Generator: setuptools (84.2.1)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

python_backlog-0.7.4.dist-info/RECORD

@@ -1,15 +0,0 @@
-backlog/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-backlog/attachment.py,sha256=RpaAcTnr_2CsJUDeeJHT1YSH0TwPImH5C0uwUOpDlHs,764
-backlog/base.py,sha256=-EUjAZr20vq3i8ekPe9LwbGvwJZ6PGhGCV8TsqZqIrs,5632
-backlog/category.py,sha256=DQ06yhOCXxtDbPMZ1Ig1QD8n7Ht_ZFrp8PJzO18IeZk,2530
-backlog/custom_field.py,sha256=dJ-XnrYv0rlpLvPhIkZEgcyNjZB8GR3352Or8HUPKlc,12243
-backlog/git.py,sha256=mazfvwn1Ekga0eeigk22Xf3vhXEo-P5Irfyq6r_QbaA,3056
-backlog/issue.py,sha256=of0DQ_1fsBPJ2aU6TS7IWlw0DzZIJRzo4fCGuKv2JY8,6636
-backlog/project.py,sha256=TOBDLV6eSpeQRxcjZ1ArrEE8lHRE7JIyaCJUQALSdSg,13839
-backlog/user.py,sha256=fgd1X1fom1mTPKDU6DFqBspPauq6UuhxrbFd9CCrptU,2829
-backlog/wiki.py,sha256=NjMkHopNb-9oic1yziiypzzpIHSdXcRfePZhOBKtDok,5431
-python_backlog-0.7.4.dist-info/LICENSE,sha256=1teWq4411yGkUz_9lD1V74mcHFRix2IqOAoFaghKYwo,1073
-python_backlog-0.7.4.dist-info/METADATA,sha256=mo6ZGBZstyo9QaRCpGCKbP8Nff3Mo0Nci7-rVaERduw,2166
-python_backlog-0.7.4.dist-info/WHEEL,sha256=cVxcB9AmuTcXqmwrtPhNK88dr7IR_b6qagTj0UvIEbY,91
-python_backlog-0.7.4.dist-info/top_level.txt,sha256=qzHRU2P6F24ntkXGiIBl4Qf_AlV0BRebSc5tuLlcOIE,8
-python_backlog-0.7.4.dist-info/RECORD,,