Merge pull request #116 from kurusugawa-computer/fix/endpoint-url

エンドポイント設定の不具合を修正

Author: yuji38kwmt

annofabapi/__version__.py

@@ -1 +1 @@
-__version__ = '0.25.0'
+__version__ = '0.25.1'

annofabapi/api.py

@@ -13,7 +13,7 @@
 
 logger = logging.getLogger(__name__)
 
-DEFAULT_ENDPOINT_URL = "https://annofab.com/api"
+DEFAULT_ENDPOINT_URL = "https://annofab.com"
 """AnnoFab WebAPIのデフォルトのエンドポイントURL"""
 
 
@@ -81,7 +81,7 @@ def __init__(self, login_user_id: str, login_password: str, endpoint_url: str =
         self.login_user_id = login_user_id
         self.login_password = login_password
         self.endpoint_url = endpoint_url
-        self.url_prefix = f"{endpoint_url}/v1"
+        self.url_prefix = f"{endpoint_url}/api/v1"
         self.session = requests.Session()
 
     #: login, refresh_tokenで取得したtoken情報
@@ -245,6 +245,8 @@ def login(self) -> Tuple[Dict[str, Any], requests.Response]:
 
         url = f"{self.url_prefix}/login"
         response = self.session.post(url, json=login_info)
+
+        annofabapi.utils.log_error_response(logger, response)
         annofabapi.utils.raise_for_status(response)
 
         json_obj = response.json()

annofabapi/api2.py

@@ -23,7 +23,7 @@ class AnnofabApi2(AbstractAnnofabApi2):
     """
     def __init__(self, api: AnnofabApi):
         self.api = api
-        self.url_prefix = f"{api.endpoint_url}/v2"
+        self.url_prefix = f"{api.endpoint_url}/api/v2"
 
     #: Signed Cookie情報
     cookies: Optional[Dict[str, Any]] = None

annofabapi/utils.py

@@ -5,13 +5,15 @@
 
 import copy
 import datetime
+import json
 import logging
 from pathlib import Path
-from typing import List, Optional
+from typing import Any, Dict, List, Optional, Union
 
 import dateutil
 import dateutil.tz
 import requests
+from requests.structures import CaseInsensitiveDict
 
 from annofabapi.models import TaskHistory, TaskPhase
 
@@ -36,7 +38,7 @@ def raise_for_status(response: requests.Response):
         raise e
 
 
-def log_error_response(arg_logger: logging.Logger, response: requests.Response):
+def log_error_response(arg_logger: logging.Logger, response: requests.Response) -> None:
     """
     HTTP Statusが400以上ならば、loggerにresponse/request情報を出力する
 
@@ -45,17 +47,36 @@ def log_error_response(arg_logger: logging.Logger, response: requests.Response):
         response: Response
 
     """
+    RequestBodyHeader = Union[Dict[str, Any], CaseInsensitiveDict]
+
+    def mask_key(d: RequestBodyHeader, key: str) -> RequestBodyHeader:
+        if key in d:
+            d[key] = "***"
+        return d
+
+    def mask_password(d: RequestBodyHeader) -> RequestBodyHeader:
+        d = mask_key(d, "password")
+        d = mask_key(d, "old_password")
+        d = mask_key(d, "new_password")
+        return d
 
     if 400 <= response.status_code < 600:
         headers = copy.deepcopy(response.request.headers)
-        if "Authorization" in headers:
-            # logにAuthorizationを出力しないようにマスクする
-            headers["Authorization"] = "***"
 
         arg_logger.debug(f"status_code = %s, response.text = %s", response.status_code, response.text)
         arg_logger.debug(f"request.url = %s %s", response.request.method, response.request.url)
+
+        # logにAuthorizationを出力しないようにマスクする
+        mask_key(headers, "Authorization")
         arg_logger.debug("request.headers = %s", headers)
-        arg_logger.debug("request.body = %s", response.request.body)
+
+        # request_bodyのpassword関係をマスクして、logに出力する
+        if response.request.body is None or response.request.body == "":
+            dict_request_body = {}
+        else:
+            dict_request_body = json.loads(response.request.body)
+
+        arg_logger.debug("request.body = %s", mask_password(dict_request_body))
 
 
 def download(url: str, dest_path: str):

tests/test_local_resource.py

@@ -34,5 +34,5 @@ def test_build_from_env(self):
 
     def test_build_with_endpoint(self):
         resource = annofabapi.build("test_user", "password", "https://localhost:8080")
-        assert resource.api.url_prefix == "https://localhost:8080/v1"
-        assert resource.api2.url_prefix == "https://localhost:8080/v2"
+        assert resource.api.url_prefix == "https://localhost:8080/api/v1"
+        assert resource.api2.url_prefix == "https://localhost:8080/api/v2"