yoto-api 1.0.7__tar.gz

yoto_api-1.0.7/AUTHORS.rst

@@ -0,0 +1,13 @@
+=======
+Credits
+=======
+
+Development Lead
+----------------
+
+* 
+
+Contributors
+------------
+
+None yet. Why not be the first?

yoto_api-1.0.7/CONTRIBUTING.rst

@@ -0,0 +1,128 @@
+.. highlight:: shell
+
+============
+Contributing
+============
+
+Contributions are welcome, and they are greatly appreciated! Every little bit
+helps, and credit will always be given.
+
+You can contribute in many ways:
+
+Types of Contributions
+----------------------
+
+Report Bugs
+~~~~~~~~~~~
+
+Report bugs at https://github.com/cdnninja/yoto_api/issues.
+
+If you are reporting a bug, please include:
+
+* Your operating system name and version.
+* Any details about your local setup that might be helpful in troubleshooting.
+* Detailed steps to reproduce the bug.
+
+Fix Bugs
+~~~~~~~~
+
+Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
+wanted" is open to whoever wants to implement it.
+
+Implement Features
+~~~~~~~~~~~~~~~~~~
+
+Look through the GitHub issues for features. Anything tagged with "enhancement"
+and "help wanted" is open to whoever wants to implement it.
+
+Write Documentation
+~~~~~~~~~~~~~~~~~~~
+
+Hyundai / Kia Connect could always use more documentation, whether as part of the
+official Hyundai / Kia Connect docs, in docstrings, or even on the web in blog posts,
+articles, and such.
+
+Submit Feedback
+~~~~~~~~~~~~~~~
+
+The best way to send feedback is to file an issue at https://github.com/cdnninja/yoto_api/issues.
+
+If you are proposing a feature:
+
+* Explain in detail how it would work.
+* Keep the scope as narrow as possible, to make it easier to implement.
+* Remember that this is a volunteer-driven project, and that contributions
+  are welcome :)
+
+Get Started!
+------------
+
+Ready to contribute? Here's how to set up `yoto_api` for local development.
+
+1. Fork the `yoto_api` repo on GitHub.
+2. Clone your fork locally::
+
+    $ git clone git@github.com:your_name_here/yoto_api.git
+
+3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
+
+    $ mkvirtualenv yoto_api
+    $ cd yoto_api/
+    $ python setup.py develop
+
+4. Create a branch for local development::
+
+    $ git checkout -b name-of-your-bugfix-or-feature
+
+   Now you can make your changes locally.
+
+5. When you're done making changes, check that your changes pass flake8 and the
+   tests, including testing other Python versions with tox::
+
+    $ flake8 yoto_api tests
+    $ python setup.py test or pytest
+    $ tox
+
+   To get flake8 and tox, just pip install them into your virtualenv.
+
+6. Commit your changes and push your branch to GitHub::
+
+    $ git add .
+    $ git commit -m "Your detailed description of your changes."
+    $ git push origin name-of-your-bugfix-or-feature
+
+7. Submit a pull request through the GitHub website.
+
+Pull Request Guidelines
+-----------------------
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1. The pull request should include tests.
+2. If the pull request adds functionality, the docs should be updated. Put
+   your new functionality into a function with a docstring, and add the
+   feature to the list in README.rst.
+3. The pull request should work for Python 3.5, 3.6, 3.7 and 3.8, and for PyPy. Check
+   https://travis-ci.com/cdnninja/yoto_api/pull_requests
+   and make sure that the tests pass for all supported Python versions.
+
+Tips
+----
+
+To run a subset of tests::
+
+$ pytest tests.test_hyundai_kia_connect_api
+
+
+Deploying
+---------
+
+A reminder for the maintainers on how to deploy.
+Make sure all your changes are committed (including an entry in HISTORY.rst).
+Then run::
+
+$ bump2version patch # possible: major / minor / patch
+$ git push
+$ git push --tags
+
+Travis will then deploy to PyPI if tests pass.

yoto_api-1.0.7/HISTORY.rst

@@ -0,0 +1 @@
+no history

yoto_api-1.0.7/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.

yoto_api-1.0.7/MANIFEST.in

@@ -0,0 +1,12 @@
+include AUTHORS.rst
+include CONTRIBUTING.rst
+include HISTORY.rst
+include LICENSE
+include README.rst
+include requirements.txt
+
+recursive-include tests *
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+
+recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif

yoto_api-1.0.7/PKG-INFO

@@ -0,0 +1,41 @@
+Metadata-Version: 2.1
+Name: yoto_api
+Version: 1.0.7
+Summary: Python Boilerplate contains all the boilerplate you need to create a Python package.
+Home-page: https://github.com/cdnninja/yoto_api
+Author: cdnninja
+Author-email: 
+License: MIT license
+Keywords: yoto_api
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3.9
+Requires-Python: >=3.9
+License-File: LICENSE
+License-File: AUTHORS.rst
+Requires-Dist: auth0-python>=4.7.1
+Requires-Dist: paho-mqtt>=2.0.0
+
+Introduction
+============
+
+Early days of this API. Plan is to use this for home assistant. Basics are only item build for auth so far. 
+
+To run this code for test I am doing::
+
+    from pathlib import Path
+    import logging
+    import sys
+    import os
+
+    path_root = r"C:path to files GitHub\main\yoto_api"
+    sys.path.append(str(path_root))
+    from yoto_api import \*
+
+    logging.basicConfig(stream=sys.stdout, level=logging.DEBUG, format='%(asctime)s %(name)s %(levelname)s:%(message)s')
+    logger = logging.getLogger(**name**)
+
+    ym = YotoManager(username="username", password="password")
+    print (ym.players)

yoto_api-1.0.7/README.rst

@@ -0,0 +1,21 @@
+Introduction
+============
+
+Early days of this API. Plan is to use this for home assistant. Basics are only item build for auth so far. 
+
+To run this code for test I am doing::
+
+    from pathlib import Path
+    import logging
+    import sys
+    import os
+
+    path_root = r"C:path to files GitHub\main\yoto_api"
+    sys.path.append(str(path_root))
+    from yoto_api import \*
+
+    logging.basicConfig(stream=sys.stdout, level=logging.DEBUG, format='%(asctime)s %(name)s %(levelname)s:%(message)s')
+    logger = logging.getLogger(**name**)
+
+    ym = YotoManager(username="username", password="password")
+    print (ym.players)

yoto_api-1.0.7/requirements.txt

@@ -0,0 +1,2 @@
+auth0-python>=4.7.1
+paho-mqtt>=2.0.0

yoto_api-1.0.7/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

yoto_api-1.0.7/setup.py

@@ -0,0 +1,47 @@
+#!/usr/bin/env python
+
+"""The setup script."""
+
+from setuptools import setup, find_packages
+
+with open("README.rst") as readme_file:
+    readme = readme_file.read()
+
+with open("HISTORY.rst") as history_file:
+    history = history_file.read()
+
+with open("requirements.txt") as f:
+    requirements = f.read().splitlines()
+
+long_description = readme + "\n\n" + history
+long_description = readme
+
+test_requirements = [
+    "pytest>=3",
+]
+
+setup(
+    author="cdnninja",
+    author_email="",
+    python_requires=">=3.9",
+    classifiers=[
+        "Development Status :: 2 - Pre-Alpha",
+        "Intended Audience :: Developers",
+        "License :: OSI Approved :: MIT License",
+        "Natural Language :: English",
+        "Programming Language :: Python :: 3.9",
+    ],
+    description="Python Boilerplate contains all the boilerplate you need to create a Python package.",
+    install_requires=requirements,
+    license="MIT license",
+    long_description=long_description,
+    include_package_data=True,
+    keywords="yoto_api",
+    name="yoto_api",
+    packages=find_packages(include=["yoto_api", "yoto_api.*"]),
+    test_suite="tests",
+    tests_require=test_requirements,
+    url="https://github.com/cdnninja/yoto_api",
+    version="1.0.7",
+    zip_safe=False,
+)

yoto_api-1.0.7/tests/login_test.py

@@ -0,0 +1,12 @@
+""""""
+
+import os
+
+from yoto_api.YotoManager import YotoManager
+
+
+def login():
+    username = os.environ["CDNINJA_USERNAME"]
+    password = os.environ["CDNINJA_PASSWORD"]
+    yotomanager = YotoManager(username=username, password=password)
+    assert yotomanager

yoto_api-1.0.7/yoto_api/Card.py

@@ -0,0 +1,39 @@
+"""Card class"""
+
+from dataclasses import dataclass
+
+
+@dataclass
+class Track:
+    icon: str = None  # $.card.content.chapters[0].tracks[0].display.icon16x16 e.g. "https://card-content.yotoplay.com/yoto/SwcetJ..."
+    title: str = None  # $.card.content.chapters[0].tracks[0].title e.g. "Introduction"
+    duration: int = None  # $.card.content.chapters[0].tracks[0].duration e.g. 349
+    key: str = None  # $.card.content.chapters[0].tracks[0].key e.g. "01-INT"
+    format: str = None  # $.card.content.chapters[0].tracks[0].format e.g. "aac"
+    channels: str = None  # $.card.content.chapters[0].tracks[0].channels e.g. "mono"
+    trackUrl: str = None  # $.card.content.chapters[0].tracks[0].trackUrl e.g. "https://secure-media.yotoplay.com/yoto/mYZ6T..."
+    type: str = None  # $.card.content.chapters[0].tracks[0].type e.g. "audio"
+
+
+@dataclass
+class Chapter:
+    icon: str = None  # $.card.content.chapters[0].display.icon16x16 e.g. "https://card-content.yotoplay.com/yoto/SwcetJ..."
+    title: str = None  # $.card.content.chapters[0].title e.g. "Introduction"
+    duration: int = None  # $.card.content.chapters[0].duration e.g. 349
+    key: str = None  # $.card.content.chapters[0].key e.g. "01-INT"
+    tracks: list[Track] = None  # $.card.content.chapters[0].tracks
+
+
+@dataclass
+class Card:
+    id: str = None  # $.card.cardId e.g. "iYIMF"
+    title: str = None  # $.card.title e.g. "Ladybird Audio Adventures - Outer Space"
+    description: str = None  # $.card.metadata.description e.g. "The sky’s the limit for imaginations when it comes to..."
+    category: str = None  # $.card.metadata.category e.g. "stories"
+    author: str = None  # $.card.metadata.author e.g. "Ladybird Audio Adventures"
+    coverImageL: str = None  # $.card.metadata.cover.imageL e.g. "https://card-content.yotoplay.com/yoto/pub/WgoJMZ..."
+    seriestitle: str = (
+        None  # $.card.metadata.seriestitle e.g. "Ladybird Audio Adventures Volume 1"
+    )
+    seriesorder: int = None  # $.card.metadata.seriesorder e.g. 4
+    chapters: list[Chapter] = None  # $.card.content.chapters

yoto_api-1.0.7/yoto_api/Token.py

@@ -0,0 +1,18 @@
+"""Token.py"""
+
+from dataclasses import dataclass
+import datetime as dt
+
+
+@dataclass
+class Token:
+    """Token"""
+
+    username: str = None
+    password: str = None
+    access_token: str = None
+    refresh_token: str = None
+    id_token: str = None
+    scope: str = None
+    valid_until: dt.datetime = dt.datetime.min
+    token_type: str = None

yoto_api-1.0.7/yoto_api/YotoAPI.py

@@ -0,0 +1,395 @@
+"""API Methods"""
+
+import requests
+import logging
+from .const import DOMAIN
+from .Token import Token
+from .Card import Card
+from .YotoPlayer import YotoPlayer
+
+_LOGGER = logging.getLogger(__name__)
+
+
+class YotoAPI:
+    def __init__(self) -> None:
+        self.BASE_URL: str = "https://api.yotoplay.com"
+        self.CLIENT_ID: str = "4P2do5RhHDXvCDZDZ6oti27Ft2XdRrzr"
+        self.LOGIN_URL: str = "login.yotoplay.com"
+        self.TOKEN_URL: str = "https://api.yotoplay.com/auth/token"
+        self.SCOPE: str = "YOUR_SCOPE"
+        # self.MQTT_AUTH_NAME: str = "JwtAuthorizer_mGDDmvLsocFY"
+        # self.MQTT_URL: str = "wss://aqrphjqbp3u2z-ats.iot.eu-west-2.amazonaws.com"
+
+    def login(self, username: str, password: str) -> Token:
+        url = self.TOKEN_URL
+        payload = {}
+        # all the values here should be URL encoded - not sure if this is done automatically by requests
+        payload["audience"] = self.BASE_URL
+        payload["client_id"] = self.CLIENT_ID
+        payload["grant_type"] = "password"
+        payload["password"] = password
+        payload["scope"] = "openid email profile offline_access"
+        payload["username"] = username
+        headers = {"Content-Type": "application/x-www-form-urlencoded"}
+        response = requests.post(url, data=payload, headers=headers).json()
+        _LOGGER.debug(f"{DOMAIN} - Sign In Response {response}")
+
+        return Token(
+            username=username,
+            password=password,
+            access_token=response["access_token"],
+            refresh_token=response["refresh_token"],
+            token_type=response["token_type"],
+            scope=response["scope"],
+            valid_until=response["expires_in"],  # Needs to be adjusted to DT
+        )
+
+    # pass='audience=https%3A//api.yotoplay.com&client_id=FILL_THIS_IN&grant_type=password&password=FILL_THIS_IN&scope=openid%20email%20profile%20offline_access&username=FILL_THIS_IN%40gmail.com'
+    # curl -d "$pass" https://api.yotoplay.com/auth/token | jq '.access_token'
+
+    def update_devices(self, token) -> list[YotoPlayer]:
+        response = self._get_devices(token)
+        result = []
+        for device in response["devices"]:
+            player: YotoPlayer = YotoPlayer(
+                id=device["deviceId"],
+                name=device["name"],
+                deviceType=device["deviceType"],
+                online=device["online"],
+            )
+            result.append(player)
+
+        return result
+        # TODO: parse the data and return a list of yoto devices.
+
+    def update_library(self, token) -> list[Card]:
+        cards = self._get_cards(token)
+        return cards
+        # TODO: parse the data and return a list of cards.
+
+    def refresh_token(self, token: Token) -> Token:
+        # to do: add command to refresh token
+        # audience=https%3A//api.yotoplay.com&client_id=FILL_THIS_IN&grant_type=refresh_token&refresh_token=FILL_THIS_IN&scope=openid%20email%20profile%20offline_access
+
+        return token
+
+    def _get_devices(self, token) -> None:
+        url = self.BASE_URL + "/device-v2/devices/mine"
+
+        headers = self._get_authenticated_headers(token)
+
+        response = requests.get(url, headers=headers).json()
+        _LOGGER.debug(f"{DOMAIN} - Get Devices Response: {response}")
+        return response
+
+    def _get_cards(self, token) -> dict:
+        ############## Details below from snooping JSON requests of the app ######################
+
+        ############## ${BASE_URL}/auth/token #############
+        # Request POST contents:
+        # audience=https%3A//api.yotoplay.com&client_id=i42noid4b2oiboi4bo&grant_type=password&password=sndoinoinscoif&scope=openid%20email%20profile%20offline_access&username=anonymous%40gmail.com
+        #
+        # Response to above:
+        # {
+        #    "access_token": "kalfkbalsbljagsl",
+        #    "refresh_token":"akklabflkablksf",
+        #    "id_token":"klasblgkablksgb",
+        #    "scope":"openid email profile user-cards users offline_access",
+        #    "expires_in":86400,
+        #    "token_type":"Bearer"
+        # }
+        # Requests to endpoints below use contents of "access_token" in the header ->
+        # Authorization: Bearer access_token
+        # User-Agent: Yoto/2.73 (com.yotoplay.Yoto; build:10405; iOS 17.4.0) Alamofire/5.6.4
+
+        ############## ${BASE_URL}/card/family/library #############
+        url = self.BASE_URL + "/card/family/library"
+
+        headers = self._get_authenticated_headers(token)
+
+        response = requests.get(url, headers=headers).json()
+        _LOGGER.debug(f"{DOMAIN} - Get Card Library: {response}")
+        return response
+
+        # {
+        #   "cards": [
+        #     {
+        #       "cardId": "g5tcK",
+        #       "reason": "physical-add",
+        #       "shareType": "yoto",
+        #       "familyId": "ksdlbksbdgklb",
+        #       "card": {
+        #         "cardId": "g5tcK",
+        #         "content": {
+        #           "activity": "yoto_Player",
+        #           "editSettings": {
+        #             "editKeys": false,
+        #             "autoOverlayLabels": "disabled"
+        #           },
+        #           "config": {
+        #             "disableAutoOverlayLabels": false
+        #           },
+        #           "availability": "",
+        #           "cover": {
+        #             "imageL": "https://card-content.yotoplay.com/yoto/pub/jbfaljsblajsfblj-wcAgqZMvA"
+        #           },
+        #           "version": "1"
+        #         },
+        #         "slug": "ladybird-audio-adventures-the-frozen-world",
+        #         "userId": "yoto",
+        #         "sortkey": "ladybird-audio-adventures-the-frozen-world",
+        #         "title": "Ladybird Audio Adventures: The Frozen World",
+        #         "updatedAt": "2022-07-21T14:30:22.231Z",
+        #         "createdAt": "2020-09-03T17:30:17.911Z",
+        #         "metadata": {
+        #           "category": "stories",
+        #           "author": "Ladybird",
+        #           "previewAudio": "shopify-slug",
+        #           "status": {
+        #             "name": "live",
+        #             "updatedAt": "2020-11-24T17:08:54.839Z"
+        #           },
+        #           "seriestitle": "Ladybird Audio Adventures - Volume 2",
+        #           "media": {
+        #             "fileSize": 35189015,
+        #             "duration": 2883,
+        #             "hasStreams": false
+        #           },
+        #           "description": "Join our intrepid adventurers Otto and Cassandra (and Missy, the smartest bird in the Universe) as they embark on a brand new Ladybird Audio Adventure!\n\nIn this adventure, Otto and Missy are off to explore the Frozen World. Setting course for the Arctic and Antarctica they discover penguins, orcas and seals, and a whole lot of snow! Now if they can just figure out how to get the heating going in Otto's teleporter they'll be able to get back home! \n\nThese audiobooks help children learn about their environment on journey of discovery with the narrators Ben Bailey Smith (aka Doc Brown, rapper, comedian and writer) and Sophie Aldred (best known for her role as Ace in Doctor Who).",
+        #           "cover": {
+        #             "imageL": "https://card-content.yotoplay.com/yoto/pub/lajsbfljabsfljabsfljbasfljbalsjf-wcAgqZMvA?width=250"
+        #           },
+        #           "seriesorder": "2",
+        #           "languages": [
+        #             "en"
+        #           ]
+        #         }
+        #       },
+        #       "provenanceId": "kasfblasbflbaslkfl",
+        #       "inFamilyLibrary": true,
+        #       "updatedAt": "2024-04-10T03:58:16.732Z",
+        #       "createdAt": "2022-12-26T07:04:18.977Z",
+        #       "lastPlayedAt": "2024-04-11T04:30:49.402Z",
+        #       "masterUid": "asbkflbasflkblaksf"
+        #     },
+        #     {
+        #       "cardId": "iYIMF",
+        #       "reason": "physical-add",
+        #       "shareType": "yoto",
+        #       "familyId": "ksdlbksbdgklb",
+        #       "card": {
+        #         "cardId": "iYIMF",
+        #         "content": {
+        #           "activity": "yoto_Player",
+        #           "editSettings": {
+        #             "editKeys": false,
+        #             "autoOverlayLabels": "chapters-offset-1"
+        #           },
+        #           "config": {
+        #             "trackNumberOverlayTimeout": 0,
+        #             "disableAutoOverlayLabels": false
+        #           },
+        #           "availability": "",
+        #           "cover": {
+        #             "imageL": "https://card-content.yotoplay.com/yoto/pub/kdsgblkjsbgjlslbj"
+        #           },
+        #           "version": "1"
+        #         },
+        #         "slug": "ladybird-audio-adventures-outer-space",
+        #         "userId": "yoto",
+        #         "sortkey": "ladybird-audio-adventures-outer-space",
+        #         "title": "Ladybird Audio Adventures - Outer Space",
+        #         "updatedAt": "2022-07-21T14:25:14.090Z",
+        #         "createdAt": "2019-12-04T00:14:57.438Z",
+        #         "metadata": {
+        #           "category": "stories",
+        #           "author": "Ladybird Audio Adventures",
+        #           "previewAudio": "shopify-slug",
+        #           "status": {
+        #             "name": "live",
+        #             "updatedAt": "2020-11-16T11:13:50.060Z"
+        #           },
+        #           "seriestitle": "Ladybird Audio Adventures Volume 1",
+        #           "media": {
+        #             "fileSize": 27225336,
+        #             "duration": 3335,
+        #             "hasStreams": false
+        #           },
+        #           "description": "The sky’s the limit for imaginations when it comes to this audio adventure! Wave goodbye to Earth and blast off into the skies above to explore 'nearby' planets, stars and galaxies, alongside inventor Otto and Missy – the cleverest raven in the universe. So, hop aboard Otto’s spacecraft and get ready for a story that’s nothing short of out of this world!\n\nLadybird Audio Adventures is an original series for 4-to 7-year-olds; a new, entertaining and engaging way for children to learn about the world around them. These are special stories written exclusively for audio with fun sound and musical effects, perfect for listening at home, before bed and on long journeys. ",
+        #           "cover": {
+        #             "imageL": "https://card-content.yotoplay.com/yoto/pub/ksdlfbksdbgklsbdlgk?width=250"
+        #           },
+        #           "seriesorder": "4",
+        #           "languages": [
+        #             "en"
+        #           ]
+        #         }
+        #       },
+        #       "provenanceId": "641352b283571a15872a37ca",
+        #       "inFamilyLibrary": true,
+        #       "updatedAt": "2024-04-05T04:03:55.198Z",
+        #       "createdAt": "2023-03-16T17:32:34.249Z",
+        #       "lastPlayedAt": "2024-04-05T06:15:11.308Z",
+        #       "masterUid": "04dedd46720000"
+        #     }
+        # }
+
+    def _get_card_detail(self, token, cardid) -> dict:
+        ############## Details below from snooping JSON requests of the app ######################
+
+        url = self.BASE_URL + "/card/details/" + cardid
+        headers = self._get_authenticated_headers(token)
+
+        response = requests.post(url, headers=headers).json()
+        _LOGGER.debug(f"{DOMAIN} - Get Card Detail: {response}")
+        return response
+
+        ############# ${BASE_URL}/card/details/abcABC #############
+        # {
+        #   "card": {
+        #     "cardId": "abcABC", #string
+        #     "content": {
+        #       "activity": "yoto_Player",
+        #       "version": "1",
+        #       "availability": "",
+        #       "editSettings": {
+        #         "autoOverlayLabels": "chapters-offset-1",
+        #         "editKeys": false
+        #       },
+        #       "config": {
+        #         "trackNumberOverlayTimeout": 0,
+        #         "disableAutoOverlayLabels": false
+        #       },
+        #       "cover": {
+        #         "imageL": "https://card-content.yotoplay.com/yoto/pub/WgoJMZiFdH35UbDAR_4z2k1vL0MufKLHfR4ULd6I"
+        #       },
+        #       "chapters": [
+        #         {
+        #           "overlayLabel": "",
+        #           "title": "Introduction",
+        #           "key": "01-INT",
+        #           "overlayLabelOverride": null,
+        #           "ambient": null,
+        #           "defaultTrackDisplay": null,
+        #           "defaultTrackAmbient": null,
+        #           "duration": 349, #int
+        #           "fileSize": 2915405,
+        #           "hasStreams": false,
+        #           "display": {
+        #             "icon16x16": "https://card-content.yotoplay.com/yoto/SwcetJ_c1xt9yN5jn2wdwMk4xupHLWONik-rzcBh"
+        #           },
+        #           "tracks": [
+        #             {
+        #               "overlayLabel": "",
+        #               "format": "aac",
+        #               "title": "Introduction",
+        #               "type": "audio",
+        #               "key": "01-INT",
+        #               "overlayLabelOverride": null,
+        #               "ambient": null,
+        #               "fileSize": 2915405,
+        #               "channels": "mono",
+        #               "duration": 349,
+        #               "transitions": {},
+        #               "display": {
+        #                 "icon16x16": "https://card-content.yotoplay.com/yoto/SwcetJ_c1xt9yN5jn2wdwMk4xupHLWONik-rzcBhkd4"
+        #               },
+        #               "trackUrl": "https://secure-media.yotoplay.com/yoto/mYZ6TgL7VRAViZ_RQL5daYEdCBCCXjes?Expires=1712889341&Policy=eyJTdGF0ZnQiOlt7IlJlc291cmNlIjoiaHR0cHM6Ly9zZWN1cmUtbWVkaWEueW90b3BsYXkulvdG8vbVlaNlRnTDdWSTBxUkFWaVpfUlFMNWRhdtWS1aVElsWGplcyIsIkNvbmRpdGlvbiI6eyJEYXRlTGVzc1RoYW4iOnsiQVdTOkVwb2NoSI6MTcxMjg4OTM0fV19&Signature=EiZwaoCrCG7y-LgEECIxwrkGNZYzUeMOubfcDL1uuqamskan3wG8WYTe8CGOlsG9kvanhUFojuR-bnG~YqT0wPUkn6UUtR8KY9EOVUp~Gr8X9~yGE1I-klUGgykSRIXu1za6sGsF4KwQH2QUNPyS9yS8T50d09zEgAZlGYSDqcz1u1Rb7GZRm69bwtWr1PjLZLrWkV1C9~yV~4wwR17xdgT2JU20ZJ99kBWaTG1efjH9qBaQTkL1EvewHfJkYXFQs~o3mi1bp6d4LYzXa59yzb-f3-cRK~IWgMIRiKNY~0Mgx8S-VA__&Key-Pair-Id=K11LSW6MJ7KP#sha256=mYZ6TgL7VI0qRAViZ_RQL5daYEdCBCCWmY-ZTIlX"
+        #             }
+        #           ]
+        #         },
+        #         {
+        #           "overlayLabel": "1",
+        #           "title": "Not the Moon",
+        #           "key": "02-1",
+        #           "overlayLabelOverride": null,
+        #           "ambient": null,
+        #           "defaultTrackDisplay": null,
+        #           "defaultTrackAmbient": null,
+        #           "duration": 140,
+        #           "fileSize": 1111649,
+        #           "hasStreams": false,
+        #           "display": {
+        #             "icon16x16": "https://card-content.yotoplay.com/yoto/XZOm4YE9ssAm_x2ykzasHyResnOWJzYIVe_hfc"
+        #           },
+        #           "tracks": [
+        #             {
+        #               "overlayLabel": "1",
+        #               "format": "aac",
+        #               "title": "Not the Moon",
+        #               "type": "audio",
+        #               "key": "02-1",
+        #               "overlayLabelOverride": null,
+        #               "ambient": null,
+        #               "fileSize": 1111649,
+        #               "channels": "mono",
+        #               "duration": 140,
+        #               "transitions": {},
+        #               "display": {
+        #                 "icon16x16": "https://card-content.yotoplay.com/yoto/XZOm4YE9ssAm_x2ykzasHyWJhf5RYzYIVe_hfc"
+        #               },
+        #               "trackUrl": "long url"
+        #             }
+        #           ]
+        #         }
+        #       ]
+        #     },
+        #     "createdAt": "2019-12-04T00:14:57.438Z",
+        #     "metadata": {
+        #       "description": "The sky’s the limit for imaginations when it comes to this audio adventure! Wave goodbye to Earth and blast off into the skies above to explore 'nearby' planets, stars and galaxies, alongside inventor Otto and Missy – the cleverest raven in the universe. So, hop aboard Otto’s spacecraft and get ready for a story that’s nothing short of out of this world!\n\nLadybird Audio Adventures is an original series for 4-to 7-year-olds; a new, entertaining and engaging way for children to learn about the world around them. These are special stories written exclusively for audio with fun sound and musical effects, perfect for listening at home, before bed and on long journeys. ",
+        #       "category": "stories",
+        #       "author": "Ladybird Audio Adventures",
+        #       "previewAudio": "shopify-slug",
+        #       "seriestitle": "Ladybird Audio Adventures Volume 1",
+        #       "seriesorder": "4",
+        #       "cover": {
+        #         "imageL": "https://card-content.yotoplay.com/yoto/pub/WgoJMZiFdH35UbDAR_4z2k1vKLHfR4ULd6ItN4"
+        #       },
+        #       "languages": [
+        #         "en"
+        #       ],
+        #       "status": {
+        #         "name": "live",
+        #         "updatedAt": "2020-11-16T11:13:50.060Z"
+        #       },
+        #       "media": {
+        #         "duration": 3335,
+        #         "fileSize": 27225336,
+        #         "hasStreams": false
+        #       }
+        #     },
+        #     "slug": "ladybird-audio-adventures-outer-space",
+        #     "title": "Ladybird Audio Adventures - Outer Space",
+        #     "updatedAt": "2022-07-21T14:25:14.090Z",
+        #     "userId": "yoto",
+        #     "sortkey": "ladybird-audio-adventures-outer-space"
+        #   },
+        #   "ownership": {
+        #     "canAccess": true,
+        #     "userHasRole": false,
+        #     "cardIsFree": false,
+        #     "cardIsMadeByUser": false,
+        #     "cardIsInFamilyLibrary": true,
+        #     "cardIsCreatedByFamily": false,
+        #     "isAccessibleUsingSubscription": false
+        #   }
+        # }
+
+    def _get_authenticated_headers(self, token: Token) -> dict:
+        return {
+            "User-Agent": "Yoto/2.73 (com.yotoplay.Yoto; build:10405; iOS 17.4.0) Alamofire/5.6.4",
+            "Content-Type": "application/json",
+            "Authorization": token.token_type + " " + token.access_token,  # maybe?
+        }
+
+    def get_child_value(data, key):
+        value = data
+        for x in key.split("."):
+            try:
+                value = value[x]
+            except Exception:
+                try:
+                    value = value[int(x)]
+                except Exception:
+                    value = None
+        return value

yoto_api-1.0.7/yoto_api/YotoManager.py

@@ -0,0 +1,45 @@
+"""YotoManager.py"""
+
+import logging
+import datetime as dt
+import pytz
+from .YotoAPI import YotoAPI
+from .Token import Token
+from .const import DOMAIN
+
+_LOGGER = logging.getLogger(__name__)
+
+
+class YotoManager:
+    def __init__(self, username: str, password: str) -> None:
+        self.username: str = username
+        self.password: str = password
+        self.api: YotoAPI = YotoAPI()
+        self.players: dict = {}
+        self.token: Token = None
+
+        self.token: Token = self.api.login(self.username, self.password)
+        self.players: list = None
+        self.library: list = None
+        self.initialize()
+
+    def initialize(self) -> None:
+        self.update_player_status(self.token)
+        self.update_cards(self.token)
+
+    def update_player_status(self, token) -> None:
+        # TODO: Should update the self.players object with a current dict of players. Below isn't complete
+        self.players = self.api.update_devices(self.token)
+
+    def update_cards(self, token) -> None:
+        # TODO: Should update the self.library object with a current dict of players. Should it do details for all cards too or separate?
+        self.library = self.api.update_library(self.token)
+
+    def check_and_refresh_token(self) -> bool:
+        if self.token is None:
+            self.initialize()
+        if self.token.valid_until <= dt.datetime.now(pytz.utc):
+            _LOGGER.debug(f"{DOMAIN} - Refresh token expired")
+            self.token: Token = self.api.refresh_token(self.token)
+            return True
+        return False

yoto_api-1.0.7/yoto_api/YotoPlayer.py

@@ -0,0 +1,14 @@
+"""YotoPlayers class"""
+
+from dataclasses import dataclass
+
+
+@dataclass
+class YotoPlayer:
+    id: str = None
+    name: str = None
+    deviceType: str = None
+    online: bool = None
+
+
+# {'devices': [{'deviceId': 'y23IBS76kCaOSrGlz29XhIFO', 'name': 'Yoto Player', 'description': 'nameless.limit', 'online': False, 'releaseChannel': 'general', 'deviceType': 'v3', 'deviceFamily': 'v3', 'deviceGroup': '', 'hasUserGivenName': False}]}

yoto_api-1.0.7/yoto_api/__init__.py

@@ -0,0 +1,7 @@
+"""Top-level package for Yoto API"""
+# flake8: noqa
+
+from .YotoPlayer import YotoPlayer
+from .YotoManager import YotoManager
+from .YotoAPI import YotoAPI
+from .Token import Token

yoto_api-1.0.7/yoto_api/const.py

@@ -0,0 +1,3 @@
+"""const.py"""
+
+DOMAIN: str = "yoto_api"

yoto_api-1.0.7/yoto_api.egg-info/PKG-INFO

@@ -0,0 +1,41 @@
+Metadata-Version: 2.1
+Name: yoto_api
+Version: 1.0.7
+Summary: Python Boilerplate contains all the boilerplate you need to create a Python package.
+Home-page: https://github.com/cdnninja/yoto_api
+Author: cdnninja
+Author-email: 
+License: MIT license
+Keywords: yoto_api
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3.9
+Requires-Python: >=3.9
+License-File: LICENSE
+License-File: AUTHORS.rst
+Requires-Dist: auth0-python>=4.7.1
+Requires-Dist: paho-mqtt>=2.0.0
+
+Introduction
+============
+
+Early days of this API. Plan is to use this for home assistant. Basics are only item build for auth so far. 
+
+To run this code for test I am doing::
+
+    from pathlib import Path
+    import logging
+    import sys
+    import os
+
+    path_root = r"C:path to files GitHub\main\yoto_api"
+    sys.path.append(str(path_root))
+    from yoto_api import \*
+
+    logging.basicConfig(stream=sys.stdout, level=logging.DEBUG, format='%(asctime)s %(name)s %(levelname)s:%(message)s')
+    logger = logging.getLogger(**name**)
+
+    ym = YotoManager(username="username", password="password")
+    print (ym.players)

yoto_api-1.0.7/yoto_api.egg-info/SOURCES.txt

@@ -0,0 +1,23 @@
+AUTHORS.rst
+CONTRIBUTING.rst
+HISTORY.rst
+LICENSE
+MANIFEST.in
+README.rst
+requirements.txt
+setup.py
+tests/__init__.py
+tests/login_test.py
+yoto_api/Card.py
+yoto_api/Token.py
+yoto_api/YotoAPI.py
+yoto_api/YotoManager.py
+yoto_api/YotoPlayer.py
+yoto_api/__init__.py
+yoto_api/const.py
+yoto_api.egg-info/PKG-INFO
+yoto_api.egg-info/SOURCES.txt
+yoto_api.egg-info/dependency_links.txt
+yoto_api.egg-info/not-zip-safe
+yoto_api.egg-info/requires.txt
+yoto_api.egg-info/top_level.txt

yoto_api-1.0.7/yoto_api.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

yoto_api-1.0.7/yoto_api.egg-info/not-zip-safe

@@ -0,0 +1 @@
+

yoto_api-1.0.7/yoto_api.egg-info/requires.txt

@@ -0,0 +1,2 @@
+auth0-python>=4.7.1
+paho-mqtt>=2.0.0

yoto_api-1.0.7/yoto_api.egg-info/top_level.txt

@@ -0,0 +1 @@
+yoto_api