bozupy 0.1.2__tar.gz

bozupy-0.1.2/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

bozupy-0.1.2/PKG-INFO

@@ -0,0 +1,11 @@
+Metadata-Version: 2.4
+Name: bozupy
+Version: 0.1.2
+Summary: **Unofficial**: cybozu.com(kintone,Garoon,common) Python SDK
+Author-email: SirTeaBear <sirteabear@gmail.com>
+Requires-Python: >=3.13.0
+License-File: LICENSE
+Requires-Dist: lxml
+Requires-Dist: python-dotenv
+Requires-Dist: requests
+Dynamic: license-file

bozupy-0.1.2/README.md

@@ -0,0 +1,57 @@
+# bozupy
+
+> [!WARNING]
+> This is not an officially supported Cybozu/Kintone product. Please do not send requests for additional features or bug fixes to account manager or customer support.
+
+> [!WARNING]
+> このリポジトリは cybozu.com の一利用者として業務で kintone を利用しているサイボウズ社員によって作られたものを現状のまま ("AS IS") で公開しているものです。kintone のサービスの一部として提供しているものではありません。機能の追加や不具合の修正のリクエストをカスタマーサポートや担当営業に送ることはお控えください。公式の SDK の提供要望は [kintone 開発チームへのフィードバックとしてお送りください](https://jp.cybozu.help/k/ja/trouble_shooting/general/send_feedback.html) 😉
+
+
+[![test](https://github.com/cybozu/bozupy/actions/workflows/test.yaml/badge.svg)](https://github.com/cybozu/bozupy/actions/workflows/test.yaml)
+![PyPI - Version](https://img.shields.io/pypi/v/bozupy)
+
+cybozu.com Python library
+
+## 設定
+### 環境変数
+
+以下の環境変数を設定すると自動で使用してくれます。
+
+```env
+CYBOZU_SUBDOMAIN=
+CYBOZU_USERNAME=
+CYBOZU_PASSWORD=
+
+KINTONE_APP_TOKEN_<アプリID>=
+```
+
+## 使い方
+
+```python
+# kintone
+from bozupy import kintone
+from bozupy.kintone.record import KintoneRecord, KintoneRecordSingleLineTextField
+
+# env: KINTONE_APP_TOKEN_1=xxxxx を設定しておくとアクセストークンを使ってアクセスする 
+# それがなければユーザー名とパスワードを使ってアクセスする
+record: KintoneRecord = kintone.record.get_record(app_id=1, record_id=1)
+print(record.get_field("code", KintoneRecordSingleLineTextField).value)
+
+## 環境変数以外の認証情報を使うことも可能
+from bozupy import AccessData
+access_data: AccessData = AccessData('<subdomain>', 'username', 'password')
+record = kintone.record.get_record(app_id=1, record_id=1, access_data=access_data)
+
+
+# garoon
+from bozupy import garoon
+from bozupy.garoon.schedule import GaroonEvent
+
+event: GaroonEvent = garoon.schedule.get_event(event_id=1)
+
+# slash
+from bozupy import slash
+from bozupy.slash import User
+
+users: list[User] = [u for u in slash.get_users(access_data=access_data)]
+```

bozupy-0.1.2/bozupy/__init__.py

@@ -0,0 +1,22 @@
+from . import slash, garoon, kintone, exception
+from .cybozu.dto import AccessData, Comment, CybozuDotComUrl, Notification
+from .cybozu.constant import Locales, Regions
+from .cybozu.url import parse_url
+from .setting import BOZUPY_VERSION
+
+__VERSION__: str = BOZUPY_VERSION
+
+
+__all__: list[str] = [
+    Locales.__name__,
+    Regions.__name__,
+    AccessData.__name__,
+    Comment.__name__,
+    CybozuDotComUrl.__name__,
+    Notification.__name__,
+    slash.__name__,
+    garoon.__name__,
+    kintone.__name__,
+    exception.__name__,
+    parse_url.__name__
+]

bozupy-0.1.2/bozupy/cybozu/constant.py

@@ -0,0 +1,32 @@
+from __future__ import annotations
+from enum import Enum
+
+
+class Locales(Enum):
+    JA = "ja"
+    EN = "en"
+    ZH = "zh"
+    OTHER = "other"
+
+    @classmethod
+    def from_str(cls, value: str | None) -> Locales:
+        if value is None:
+            return Locales.OTHER
+        try:
+            return cls(value.lower())
+        except ValueError:
+            return Locales.OTHER
+
+
+class Regions(Enum):
+    JP = "jp"
+    CN = "cn"
+
+    @classmethod
+    def from_str(cls, value: str | None) -> Regions:
+        if value is None:
+            return Regions.JP
+        try:
+            return cls(value.lower())
+        except ValueError:
+            return Regions.JP

bozupy-0.1.2/bozupy/cybozu/dto.py

@@ -0,0 +1,118 @@
+from __future__ import annotations
+
+from abc import ABCMeta, abstractmethod
+from dataclasses import dataclass, field
+from datetime import datetime
+
+from .constant import Regions
+from ..setting import DEFAULT_CYBOZU_SUBDOMAIN, DEFAULT_CYBOZU_USERNAME, DEFAULT_CYBOZU_PASSWORD, \
+    DEFAULT_OTP_SECRET, DEFAULT_CYBOZU_REGION, DEFAULT_APP_TOKENS
+
+
+@dataclass
+class AccessData:
+    subdomain: str = DEFAULT_CYBOZU_SUBDOMAIN
+    username: str = DEFAULT_CYBOZU_USERNAME
+    password: str = DEFAULT_CYBOZU_PASSWORD
+    is_dev: bool = False
+    otp_secret: str = DEFAULT_OTP_SECRET
+    region: Regions = Regions.from_str(DEFAULT_CYBOZU_REGION)
+    app_tokens: dict[int, str] = field(default_factory=lambda: DEFAULT_APP_TOKENS.copy())
+
+    @property
+    def has_auth(self) -> bool:
+        return len(self.username) > 0 and len(self.password) > 0
+
+    @property
+    def host(self) -> str:
+        host: str = f"{self.subdomain}.cybozu"
+        if self.is_dev:
+            host = host + "-dev"
+        if self.region == Regions.JP:
+            host = host + ".com"
+        elif self.region == Regions.CN:
+            host = host + ".cn"
+        else:
+            raise NotImplementedError(f"Region {self.region} is not implemented.")
+        return host
+
+
+@dataclass
+class CybozuDotComUrl(metaclass=ABCMeta):
+    subdomain: str
+    is_dev: bool
+
+    @property
+    def path(self) -> str:
+        return ""
+
+    @property
+    @abstractmethod
+    def _product(self) -> str:
+        raise NotImplementedError()
+
+    @property
+    def fragment(self) -> str:
+        return ""
+
+    @property
+    def params(self) -> dict[str, str]:
+        return {}
+
+    def fqdn(self, is_secure: bool = False) -> str:
+        fqdn: str = f"{self.subdomain}"
+        if is_secure:
+            fqdn = fqdn + ".s"
+        fqdn = fqdn + ".cybozu"
+        if self.is_dev:
+            fqdn = fqdn + "-dev"
+        fqdn = fqdn + ".com"
+        return fqdn
+
+    def url(self, is_secure: bool = False, params: dict[str, str] | None = None) -> str:
+        url_: str = f"https://{self.fqdn(is_secure)}/{self._product}/{self.path}"
+        if self.fragment:
+            url_ += "#" + self.fragment
+        params_: dict[str, str] = params if params else {}
+        params_.update(self.params)
+        if params_:
+            url_ += "?" + "&".join([f"{k}={v}" for k, v in params_.items()])
+        return url_
+
+    def __str__(self) -> str:
+        return self.url()
+
+
+@dataclass
+class Notification:
+    notify_at: datetime
+    user_code: str
+    text: str
+    has_mention: bool
+    subdomain: str
+    is_dev: bool
+
+    @property
+    @abstractmethod
+    def url(self) -> CybozuDotComUrl:
+        raise NotImplementedError()
+
+
+@dataclass(order=True)
+class Comment(metaclass=ABCMeta):
+    id: int = field(compare=False)
+    text: str = field(compare=False)
+    commented_at: datetime = field(compare=True)
+    like_count: int = field(compare=False)
+    like_codes: set[str] = field(compare=False)
+    creator_code: str = field(compare=False)
+    mention_codes: set[str] = field(compare=False)
+    mention_org_codes: set[str] = field(compare=False)
+    mention_group_codes: set[str] = field(compare=False)
+    subdomain: str = field(compare=False)
+    is_dev: bool = field(compare=False)
+
+    @property
+    @abstractmethod
+    def url(self) -> CybozuDotComUrl:
+        raise NotImplementedError()

bozupy-0.1.2/bozupy/cybozu/url.py

@@ -0,0 +1,11 @@
+from .dto import CybozuDotComUrl
+from ..kintone.url import logic as kintone_logic
+from ..garoon.url import logic as garoon_logic
+
+
+def parse_url(url_str: str) -> CybozuDotComUrl | None:
+    if "/k/" in url_str:
+        return kintone_logic.parse_kintone_url(url_str)
+    elif "/g/" in url_str:
+        return garoon_logic.parse_garoon_url(url_str)
+    return None

bozupy-0.1.2/bozupy/cybozu/util.py

@@ -0,0 +1,85 @@
+import base64
+import logging
+from typing import Iterator
+
+import requests
+
+from .dto import AccessData
+from ..exception import LoginRequired, AccessForbidden, RateLimitExceeded, RequestNotSuccess, APIError, NoJsonResponse
+from ..setting import USER_AGENT
+from ..util import debug_response_print
+
+
+def get_headers(access_data: AccessData | None, has_body: bool = False, app_ids: set[int] | int | None = None) -> dict[str, str]:
+    if access_data is None:
+        access_data = AccessData()
+    headers: dict[str, str] = {
+        "Host": f"{access_data.host}:443",
+        "User-Agent": USER_AGENT
+    }
+    if has_body:
+        headers["Content-Type"] = "application/json"
+    tokens: set[str] = set([])
+    if app_ids is None:
+        app_ids = set([])
+    elif isinstance(app_ids, int):
+        app_ids = {app_ids}
+    for app_id in app_ids:
+        if app_id in access_data.app_tokens:
+            tokens.add(access_data.app_tokens[app_id])
+    if tokens and app_ids and len(tokens) == len(app_ids):
+        headers["X-Cybozu-API-Token"] = ",".join(sorted(tokens))
+        logging.info("Use API Token")
+    elif access_data.has_auth:
+        headers["X-Cybozu-Authorization"] = base64.b64encode(
+            f"{access_data.username}:{access_data.password}".encode()).decode()
+        logging.info("Use Password")
+    else:
+        raise ValueError("No Auth Data")
+    return headers
+
+
+def check_response(res: requests.Response, is_plain: bool = False):
+    debug_response_print(res)
+    # エラーを出し分けたいのでres.raise_for_status()は使わない
+    if res.status_code <= 299:
+        if is_plain:
+            return
+        elif "application/json" not in res.headers.get("Content-Type", ""):
+            raise NoJsonResponse(res)
+        try:
+            res_json: dict | list = res.json()
+        except ValueError:
+            raise NoJsonResponse(res)
+        if not isinstance(res_json, dict) or "success" not in res_json or res_json["success"]:
+            return
+        else:
+            raise RequestNotSuccess(res)
+    elif res.status_code == 401:
+        raise LoginRequired(res)
+    elif res.status_code == 302 and "/login" in res.headers.get("Location", ""):
+        raise LoginRequired(res)
+    elif res.status_code == 403:
+        raise AccessForbidden(res)
+    elif res.status_code == 429:
+        raise RateLimitExceeded(res)
+    elif res.status_code == 502 and "一時的な過負荷かメンテナンス" in res.text:
+        raise RateLimitExceeded(res)
+    elif res.status_code == 520:
+        raise APIError(res)
+    raise requests.HTTPError(response=res)
+
+
+def get_offset_request(url: str, headers: dict, params: dict, key: str, limit: int) -> Iterator[dict]:
+    offset: int = 0
+    params["size"] = limit
+    while True:
+        ps: dict = params.copy()
+        ps["offset"] = offset
+        res: requests.Response = requests.get(url, headers=headers, params=ps)
+        check_response(res)
+        result: list[dict] = res.json()[key]
+        yield from result
+        if len(result) < limit:
+            break
+        offset += len(result)

bozupy-0.1.2/bozupy/exception.py

@@ -0,0 +1,39 @@
+from dataclasses import dataclass
+
+import requests
+
+
+@dataclass
+class LoginRequired(requests.HTTPError):
+    # 401
+    response: requests.Response
+
+
+@dataclass
+class AccessForbidden(requests.HTTPError):
+    # 403
+    response: requests.Response
+
+
+@dataclass
+class RateLimitExceeded(requests.HTTPError):
+    # 429
+    response: requests.Response
+
+
+@dataclass
+class RequestNotSuccess(requests.HTTPError):
+    # 520
+    response: requests.Response | None
+    json_: dict | None = None
+
+
+@dataclass
+class APIError(requests.HTTPError):
+    # 520
+    response: requests.Response
+
+
+@dataclass
+class NoJsonResponse(requests.HTTPError):
+    response: requests.Response

bozupy-0.1.2/bozupy/garoon/__init__.py

@@ -0,0 +1,13 @@
+from .base.dto import GaroonComment
+from .constant import EventTypes, OperationTypes
+from . import notification, schedule, url, user
+
+__all__: list[str] = [
+    EventTypes.__name__,
+    GaroonComment.__name__,
+    OperationTypes.__name__,
+    notification.__name__,
+    schedule.__name__,
+    url.__name__,
+    user.__name__
+]

bozupy-0.1.2/bozupy/garoon/base/dto.py

@@ -0,0 +1,11 @@
+from __future__ import annotations
+
+from abc import ABCMeta
+from dataclasses import dataclass
+
+from ...cybozu.dto import Comment
+
+
+@dataclass(order=True)
+class GaroonComment(Comment, metaclass=ABCMeta):
+    pass

bozupy-0.1.2/bozupy/garoon/constant.py

@@ -0,0 +1,31 @@
+from __future__ import annotations
+from enum import Enum
+
+
+class EventTypes(Enum):
+    REGULAR = "REGULAR"
+    REPEATING = "REPEATING"
+    ALL_DAY = "ALL_DAY"
+    TEMPORARY = "TEMPORARY"
+    OTHER = "OTHER"
+
+    @classmethod
+    def from_str(cls, s: str) -> EventTypes:
+        try:
+            return cls(s)
+        except ValueError:
+            return cls.OTHER
+
+
+class OperationTypes(Enum):
+    ADD = "add"
+    MODIFY = "modify"
+    REMOVE = "remove"
+    OTHER = "other"
+
+    @classmethod
+    def from_str(cls, s: str) -> OperationTypes:
+        try:
+            return cls(s)
+        except ValueError:
+            return cls.OTHER

bozupy-0.1.2/bozupy/garoon/notification/__init__.py

@@ -0,0 +1,7 @@
+from .client import get_notifications
+from .dto import GaroonNotification
+
+__all__: list[str] = [
+    get_notifications.__name__,
+    GaroonNotification.__name__
+]