[ { "path": ".editorconfig", "content": "# top-most EditorConfig file\nroot = true\n\n# Unix-style newlines with a newline ending every file\n[*]\nend_of_line = lf\ninsert_final_newline = true\n\n# Matches multiple files with brace expansion notation\n# Set default charset\n[*.{py}]\ncharset = utf-8\n\n# 4 space indentation\n[*.py]\nindent_style = space\nindent_size = 4\ntrim_trailing_whitespace = true" }, { "path": ".github/CONTRIBUTING.md", "content": "# How to contribute\n\nSo you want to contribute to Mycroft?\nThis should be as easy as possible for you but there are a few things to consider when contributing.\nThe following guidelines for contribution should be followed if you want to submit a pull request.\n\n## How to prepare\n\n* You need a [GitHub account](https://github.com/signup/free)\n* Submit an [issue ticket](https://github.com/MycroftAI/mycroft/issues) for your issue if there is not one yet.\n\t* Describe the issue and include steps to reproduce if it's a bug.\n\t* Ensure to mention the earliest version that you know is affected.\n* If you are able and want to fix this, fork the repository on GitHub\n\n\n## Make Changes\n\n 1. [Fork the Project](https://help.github.com/articles/fork-a-repo/)\n 2. [Create a new Issue](https://help.github.com/articles/creating-an-issue/)\n 3. Create a **feature** or **bugfix** branch based on **dev** with your issue identifier. For example, if your issue identifier is: **issue-123** then you will create either: **feature/issue-123** or **bugfix/issue-123**. Use **feature** prefix for issues related to new functionalities or enhancements and **bugfix** in case of bugs found on the **dev** branch\n 4. Make sure you stick to the coding style and OO patterns that are used already.\n 5. Document code using [Google-style docstrings](http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html). Our automated documentation tools expect that format. All functions and class methods that are expected to be called externally should include a docstring. (And those that aren't [should be prefixed with a single underscore](https://docs.python.org/2/tutorial/classes.html#private-variables-and-class-local-references)).\n 6. Make commits in logical units and describe them properly. Use your issue identifier at the very begin of each commit. For instance:\n`git commit -m \"Issues-123 - Fixing 'A' sound on Spelling Skill\"`\n 7. Before committing, format your code following the PEP8 rules and organize your imports removing unused libs. To check whether you are following these rules, install pep8 and run `pep8 mycroft test` while in the `mycroft-core` folder. This will check for formatting issues in the `mycroft` and `test` folders.\n 8. Once you have committed everything and are done with your branch, you have to rebase your code with **dev**. Do the following steps:\n 1. Make sure you do not have any changes left on your branch\n 2. Checkout on dev branch and make sure it is up-to-date\n 3. Checkout your branch and rebase it with dev\n 4. Resolve any conflicts you have\n 5. You will have to force your push since the historical base has changed\n 6. Suggested steps are:\n ```\ngit checkout dev\ngit fetch\ngit reset --hard origin/dev\ngit checkout \ngit rebase dev\ngit push -f\n```\n 9. If possible, create unit tests for your changes\n * [Unit Tests for most contributions](https://github.com/MycroftAI/mycroft-core/tree/dev/test)\n * [Intent Tests for new skills](https://docs.mycroft.ai/development/creating-a-skill#testing-your-skill)\n * We utilize TRAVIS-CI, which will test each pull request. To test locally you can run: `./start.sh unittest`\n 10. Once everything is OK, you can finally [create a Pull Request (PR) on Github](https://help.github.com/articles/using-pull-requests/) in order to be reviewed and merged.\n\n**Note**: Even if you have write access to the master branch, do not work directly on master!\n\n## Submit Changes\n\n* Push your changes to a topic branch in your fork of the repository.\n* Open a pull request to the original repository and choose the right original branch you want to patch.\n\t_Advanced users may install the `hub` gem and use the [`hub pull-request` command](https://github.com/defunkt/hub#git-pull-request)._\n* If not done in commit messages (which you really should do) please reference and update your issue with the code changes. But _please do not close the issue yourself_.\n* Even if you have write access to the repository, do not directly push or merge pull-requests. Let another team member review your pull request and approve.\n\n# Additional Resources\n\n* [General GitHub documentation](http://help.github.com/)\n* [GitHub pull request documentation](https://help.github.com/articles/about-pull-requests/)\n* [Read the Issue Guidelines by @necolas](https://github.com/necolas/issue-guidelines/blob/master/CONTRIBUTING.md) for more details\n" }, { "path": ".github/ISSUE_TEMPLATE.md", "content": "# How to submit an Issue to a Mycroft repository\n\nWhen submitting an Issue to a Mycroft repository, please follow these guidelines to help us help you. \n\n## Be clear about the software, hardware and version you are running\n\nFor example: \n\n* I'm running a Mark 1\n* With version 0.9.10 of the Mycroft software\n* With the standard Wake Word\n\n## Try to provide steps that we can use to replicate the Issue\n\nFor example: \n\n1. Burn the 0.9.10 image to Micro SD card using Etcher\n2. Seat the Micro SD card in the RPi 3\n3. Boot Picroft\n4. Wait 3 minutes\n5. The red light will come on indicating that the RPi 3 is overheating\n6. Running `htop` via the command line indicates a number of Zombie'd processes\n\n## Be as specific as possible about the expected condition, and the deviation from expected condition. \n\nThis is called _object-deviation format_. Specify the object, then the deviation of the object from an expected condition. \n\nExample 1: \n\n* When I say \"Hey Mycroft, set your eyes to cadet blue\", the eyes turn purple instead of blue. \n\nExample 2: \n\n* When I say \"Hey Mycroft, what time is it in Paris\", the time spoken is out by one hour - it's not observing daylight savings time. \n\nExample 3: \n\n* When I run `msm default` on my Mark 1, I receive lots of Git 'locked file' errors on the command line. \n\n## Provide log files or other output to help us see the error\n\nWe will normally require log files or other troubleshooting information to assist you with your Issue. \n\nThis [documentation](https://mycroft.ai/documentation/troubleshooting/) explains how to find log files. \n\nAs of version 0.9.10, the [Support Skill](https://github.com/MycroftAI/skill-support) also helps to automate gathering support information. \n\nSimply say: \n\n* \"Create a support ticket\" _or_\n* \"You're not working!\" _or_\n* \"Send me debug info\"\n\nand the Skill will put together a support package which you can email to us. \n\n## Upload any files to the Issue that will be useful in helping us to investigate\n\nPlease ensure you upload any relevant files - such as screenshots - which will aid us investigating. \n" }, { "path": ".github/PULL_REQUEST_TEMPLATE.md", "content": "## Description\n(Description of what the PR does, such as fixes # {issue number})\n\n## How to test\n(Description of how to validate or test this PR)\n\n## Contributor license agreement signed?\nCLA [ ] (Whether you have signed a [CLA - Contributor Licensing Agreement](https://mycroft.ai/cla/)\n" }, { "path": ".github/SUPPORT.md", "content": "# How to get support with Mycroft software, hardware and products\n\nThere are multiple ways to seek support with Mycroft software, hardware and products.\n\n## Forum\n\nWe maintain a [Forum](https://community.mycroft.ai) which is regularly monitored. \nFeel free to post questions, bugs, and requests for assistance in the relevant Forum Topic. \n\n## Chat\n\nMycroft staff are regularly available in our [Chat](https://chat.mycroft.ai) platform. \nThere are specific rooms available for different projects and products. \n\n## Contact\n\nYou can contact us via [our online form](https://mycroft.ai/contact), or give a call. \n\n## GitHub\n\nWe welcome you raising Issues and Pull Requests on our public GitHub repositories. \nSee the [CONTRIBUTING.md](CONTRIBUTING.md) file for more information.\n\n## Helping us to help you\n\nOur [documentation](https://mycroft.ai/documentation/troubleshooting/) contains troubleshooting information, and information on log files and other files that we may need to help us help you.\n\n\n" }, { "path": ".gitignore", "content": "# See http://help.github.com/ignore-files/ for more about ignoring files.\n\n# compiled output\n/dist\n/tmp\n/out-tsc\n**/*.egg-info\n\n# dependencies\n**/node_modules\n\n# python notebooks\n*.ipynb\n\n# IDEs and editors\n**/.idea\n.project\n.classpath\n.c9/\n*.launch\n.settings/\n*.sublime-workspace\n__pycache__/\n\n# IDE - VSCode\n.vscode/*\n!.vscode/settings.json\n!.vscode/tasks.json\n!.vscode/launch.json\n!.vscode/extensions.json\n\n# misc\n/.sass-cache\n/connect.lock\n/coverage\n/libpeerconnection.log\nnpm-debug.log\nyarn-error.log\ntestem.log\n/typings\n\n# System Files\n.DS_Store\nThumbs.db\n\n\n" }, { "path": ".pre-commit-config.yaml", "content": "repos:\n- repo: https://github.com/pre-commit/pre-commit-hooks\n rev: v2.3.0\n hooks:\n - id: check-yaml\n - id: end-of-file-fixer\n - id: trailing-whitespace\n- repo: https://github.com/psf/black\n rev: 22.3.0\n hooks:\n - id: black\n" }, { "path": "AUTHORS", "content": "The Mycroft Server was initially developed by Mycroft AI Inc\n\nIt lives on as an open source project with many contributors, a self-updating\nlist is at: https://github.com/mycroftai/selene-backend/graphs/contributors" }, { "path": "CODE_OF_CONDUCT.md", "content": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at kathy.reid@mycroft.ai. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" }, { "path": "Dockerfile", "content": "# Multi-stage Dockerfile for running Selene APIs or their test suites.\n#\n# ASSUMPTION:\n# This Dockerfile assumes its resulting containers will run on a Docker network. A Postgres container named\n# \"selene-db\" and a Redis container named \"selene-cache\" also need to be running on this network. To create the\n# network and the Postgres/Redis containers, use the following commands:\n# docker network create --driver bridge \n# docker run -d --net --name selene-cache redis:6\n# docker run -d -e POSTGRES_PASSWORD=selene --net --name selene-db postgres:10\n# The DB_HOST environment variable is set to the name of the Postgres container and the REDIS_HOST environment\n# variable is set to the name of he Redis container. When running images created from this Dockerfile, include the\n# \"--net \" argument.\n\n# Build steps that apply to all of the selene applications.\nFROM python:3.9 as base-build\nRUN apt-get update && apt-get -y install gcc git libsndfile-dev\nRUN curl -sSL https://install.python-poetry.org | python3 -\nENV PATH ${PATH}:/root/.local/bin\nRUN poetry --version\nRUN mkdir -p /root/allure /opt/selene/selene-backend /root/code-quality /var/log/mycroft\nWORKDIR /opt/selene/selene-backend\nENV DB_HOST selene-db\nENV DB_NAME mycroft\nENV DB_PASSWORD adam\nENV DB_USER selene\nENV JWT_ACCESS_SECRET access-secret\nENV JWT_REFRESH_SECRET refresh-secret\nENV REDIS_HOST selene-cache\nENV REDIS_PORT 6379\nENV SALT testsalt\nENV SELENE_ENVIRONMENT dev\n\n# Put the copy of the shared library code in its own section to avoid reinstalling base software every time\nFROM base-build as selene-base\nCOPY shared shared\n\n# Code quality scripts and user agreements are stored in the MycroftAI/devops repository. This repository is private.\n# builds for publicly available images should not use this build stage.\n#\n# The GitHub API key is sensitive information and can change depending on who is running the application.\n# It is used here to clone the private MycroftAI/devops repository.\nFROM selene-base as devops-build\nARG github_api_key\nENV GITHUB_API_KEY=$github_api_key\nRUN mkdir -p /opt/mycroft\nWORKDIR /opt/mycroft\nRUN git clone https://${github_api_key}@github.com/MycroftAI/devops.git\nWORKDIR /opt/mycroft/devops/jenkins\nRUN poetry install\n\n# Run a linter and code formatter against the API specified in the build argument\nFROM devops-build as api-code-check\nARG api_name\nWORKDIR /opt/selene/selene-backend\nCOPY api/${api_name} api/${api_name}\nWORKDIR /opt/selene/selene-backend/api/${api_name}\nRUN poetry install\nENV PYTHONPATH=$PYTHONPATH:/opt/selene/selene-backend/api/${api_name}\nWORKDIR /opt/mycroft/devops/jenkins\nENTRYPOINT [\"poetry\", \"run\", \"python\", \"-m\", \"pipeline.code_check\", \"--repository\", \"selene-backend\", \"--base-dir\", \"/opt/selene\"]\n\n# Bootstrap the Selene database as it will be needed to run any Selene applications.\nFROM devops-build as db-bootstrap\nENV POSTGRES_PASSWORD selene\nWORKDIR /opt/selene/selene-backend\nCOPY db db\nWORKDIR /opt/selene/selene-backend/db\nRUN poetry install\nRUN mkdir -p /tmp/selene\nENTRYPOINT [\"poetry\", \"run\", \"python\", \"scripts/bootstrap_mycroft_db.py\", \"--ci\"]\n\n# Run the tests defined in the Account API\nFROM selene-base as account-api-test\nARG stripe_api_key\nENV ACCOUNT_BASE_URL https://account.mycroft.test\nENV PANTACOR_API_TOKEN pantacor-token\nENV PANTACOR_API_BASE_URL pantacor.test.url\nENV PYTHONPATH=$PYTHONPATH:/opt/selene/selene-backend/api/account\nENV STRIPE_PRIVATE_KEY $stripe_api_key\nCOPY api/account api/account\nWORKDIR /opt/selene/selene-backend/api/account\nRUN poetry install\nWORKDIR /opt/selene/selene-backend/api/account/tests\nENTRYPOINT [\"poetry\", \"run\", \"behave\", \"-f\", \"allure_behave.formatter:AllureFormatter\", \"-o\", \"/root/allure/allure-result\"]\n\n# Run the tests defined in the Single Sign On API\nFROM selene-base as sso-api-test\nARG github_client_id\nARG github_client_secret\nENV PYTHONPATH=$PYTHONPATH:/opt/selene/selene-backend/api/sso\nENV JWT_RESET_SECRET reset-secret\n# The GitHub client ID and secret are sensitive information and can change depending on who is running the application.\n# They are used here to facilitate user authentication using a GitHub account.\nENV GITHUB_CLIENT_ID $github_client_id\nENV GITHUB_CLIENT_SECRET $github_client_secret\nCOPY api/sso api/sso\nWORKDIR /opt/selene/selene-backend/api/sso\nRUN poetry install\nWORKDIR /opt/selene/selene-backend/api/sso/tests\nENTRYPOINT [\"poetry\", \"run\", \"behave\", \"-f\", \"allure_behave.formatter:AllureFormatter\", \"-o\", \"/root/allure/allure-result\"]\n\n# Run the tests defined in the Public Device API\nFROM selene-base as public-api-test\nRUN mkdir -p /opt/selene/data\nARG google_stt_key\nARG stt_api_key\nARG wolfram_alpha_key\nENV GOOGLE_APPLICATION_CREDENTIALS=\"/root/secrets/transcription-test-363101-6532632520e1.json\"\nENV GOOGLE_STT_KEY $google_stt_key\nENV PANTACOR_API_TOKEN pantacor-token\nENV PANTACOR_API_BASE_URL pantacor.test.url\nENV PYTHONPATH=$PYTHONPATH:/opt/selene/selene-backend/api/public\nENV GOOGLE_STT_KEY $google_stt_key\nENV SENDGRID_API_KEY test_sendgrid_key\nENV WOLFRAM_ALPHA_KEY $wolfram_alpha_key\nENV WOLFRAM_ALPHA_URL https://api.wolframalpha.com\nCOPY api/public api/public\nWORKDIR /opt/selene/selene-backend/api/public\nRUN poetry install\nWORKDIR /opt/selene/selene-backend/api/public/tests\nENTRYPOINT [\"poetry\", \"run\", \"behave\", \"-f\", \"allure_behave.formatter:AllureFormatter\", \"-o\", \"/root/allure/allure-result\"]\n" }, { "path": "Jenkinsfile", "content": "pipeline {\n agent any\n options {\n // Running builds concurrently could cause a race condition with\n // building the Docker image.\n disableConcurrentBuilds()\n buildDiscarder(logRotator(numToKeepStr: '5'))\n ansiColor('xterm')\n }\n environment {\n // Some branches have a \"/\" in their name (e.g. feature/new-and-cool)\n // Some commands, such as those that deal with directories, don't\n // play nice with this naming convention. Define an alias for the\n // branch name that can be used in these scenarios.\n BRANCH_ALIAS = sh(\n script: 'echo $BRANCH_NAME | sed -e \"s#/#-#g\"',\n returnStdout: true\n ).trim()\n DOCKER_BUILDKIT=1\n //spawns GITHUB_USR and GITHUB_PSW environment variables\n GITHUB_API_KEY=credentials('38b2e4a6-167a-40b2-be6f-d69be42c8190')\n GITHUB_CLIENT_ID=credentials('380f58b1-8a33-4a9d-a67b-354a9b0e792e')\n GITHUB_CLIENT_SECRET=credentials('71626c21-de59-4450-bfad-5034fd596fb2')\n GOOGLE_STT_KEY=credentials('287949f8-2ada-4450-8806-1fe2dd8e4c4d')\n STRIPE_KEY=credentials('9980e41f-d418-49af-9d62-341d1246f555')\n WOLFRAM_ALPHA_KEY=credentials('f718e0a1-c19c-4c7f-af88-0689738ccaa1')\n }\n stages {\n stage('Lint & Format') {\n // Run PyLint and Black to check code quality.\n when {\n anyOf {\n changeRequest target: 'dev'\n changeRequest target: 'master'\n }\n }\n steps {\n labelledShell label: 'Account API Setup', script: \"\"\"\n docker build \\\n --build-arg github_api_key=${GITHUB_API_KEY} \\\n --build-arg api_name=account \\\n --target api-code-check --no-cache \\\n -t selene-linter:${BRANCH_ALIAS} .\n \"\"\"\n labelledShell label: 'Account API Check', script: \"\"\"\n docker run selene-linter:${BRANCH_ALIAS} --poetry-dir api/account --pull-request=${BRANCH_NAME}\n \"\"\"\n labelledShell label: 'Single Sign On API Setup', script: \"\"\"\n docker build \\\n --build-arg github_api_key=${GITHUB_API_KEY} \\\n --build-arg api_name=sso \\\n --target api-code-check --no-cache \\\n -t selene-linter:${BRANCH_ALIAS} .\n \"\"\"\n labelledShell label: 'Single Sign On API Check', script: \"\"\"\n docker run selene-linter:${BRANCH_ALIAS} --poetry-dir api/sso --pull-request=${BRANCH_NAME}\n \"\"\"\n labelledShell label: 'Public API Setup', script: \"\"\"\n docker build \\\n --build-arg github_api_key=${GITHUB_API_KEY} \\\n --build-arg api_name=public \\\n --target api-code-check --no-cache \\\n --label job=${JOB_NAME} \\\n -t selene-linter:${BRANCH_ALIAS} .\n \"\"\"\n labelledShell label: 'Public API Check', script: \"\"\"\n docker run selene-linter:${BRANCH_ALIAS} --poetry-dir api/public --pull-request=${BRANCH_NAME}\n \"\"\"\n }\n }\n stage('Bootstrap DB') {\n when {\n anyOf {\n branch 'dev'\n branch 'master'\n changeRequest target: 'dev'\n changeRequest target: 'master'\n }\n }\n steps {\n labelledShell label: 'Building Docker image', script: \"\"\"\n docker build \\\n --target db-bootstrap \\\n --build-arg github_api_key=${GITHUB_API_KEY} \\\n --label job=${JOB_NAME} \\\n -t selene-db:${BRANCH_ALIAS} .\n \"\"\"\n timeout(time: 5, unit: 'MINUTES')\n {\n labelledShell label: 'Run database bootstrap script', script: \"\"\"\n docker run \\\n -v '${HOME}/selene:/tmp/selene' \\\n --net selene-net selene-db:${BRANCH_ALIAS}\n \"\"\"\n }\n }\n }\n stage('Account API Tests') {\n when {\n anyOf {\n branch 'dev'\n branch 'master'\n changeRequest target: 'dev'\n changeRequest target: 'master'\n }\n }\n steps {\n labelledShell label: 'Building Docker image', script: \"\"\"\n docker build \\\n --build-arg stripe_api_key=${STRIPE_KEY} \\\n --target account-api-test \\\n --label job=${JOB_NAME} \\\n -t selene-account:${BRANCH_ALIAS} .\n \"\"\"\n timeout(time: 5, unit: 'MINUTES')\n {\n sh 'mkdir -p $HOME/selene/$BRANCH_ALIAS/allure'\n labelledShell label: 'Running behave tests', script: \"\"\"\n docker run \\\n --net selene-net \\\n -v '$HOME/selene/$BRANCH_ALIAS/allure/:/root/allure' \\\n --label job=${JOB_NAME} \\\n selene-account:${BRANCH_ALIAS}\n \"\"\"\n }\n }\n post {\n always {\n sh 'docker run \\\n -v \"$HOME/selene/$BRANCH_ALIAS/allure:/root/allure\" \\\n --entrypoint=/bin/bash \\\n --label build=${JOB_NAME} \\\n selene-account:${BRANCH_ALIAS} \\\n -x -c \"chown $(id -u $USER):$(id -g $USER) \\\n -R /root/allure/\"'\n }\n }\n }\n stage('Single Sign On API Tests') {\n when {\n anyOf {\n branch 'dev'\n branch 'master'\n changeRequest target: 'dev'\n changeRequest target: 'master'\n }\n }\n steps {\n labelledShell label: 'Building Docker image', script: \"\"\"\n docker build \\\n --build-arg github_client_id=${GITHUB_CLIENT_ID} \\\n --build-arg github_client_secret=${GITHUB_CLIENT_SECRET} \\\n --target sso-api-test \\\n --label job=${JOB_NAME} \\\n -t selene-sso:${BRANCH_ALIAS} .\n \"\"\"\n timeout(time: 2, unit: 'MINUTES')\n {\n labelledShell label: 'Running behave tests', script: \"\"\"\n docker run \\\n --net selene-net \\\n -v '$HOME/selene/$BRANCH_ALIAS/allure/:/root/allure' \\\n selene-sso:${BRANCH_ALIAS}\n \"\"\"\n }\n }\n post {\n always {\n sh 'docker run \\\n -v \"$HOME/selene/$BRANCH_ALIAS/allure:/root/allure\" \\\n --entrypoint=/bin/bash \\\n --label build=${JOB_NAME} \\\n selene-sso:${BRANCH_ALIAS} \\\n -x -c \"chown $(id -u $USER):$(id -g $USER) \\\n -R /root/allure/\"'\n }\n }\n }\n stage('Public Device API Tests') {\n when {\n anyOf {\n branch 'dev'\n branch 'master'\n changeRequest target: 'dev'\n changeRequest target: 'master'\n }\n }\n steps {\n labelledShell label: 'Building Docker image', script: \"\"\"\n docker build \\\n --build-arg wolfram_alpha_key=${WOLFRAM_ALPHA_KEY} \\\n --build-arg google_stt_key=${GOOGLE_STT_KEY} \\\n --target public-api-test \\\n --label job=${JOB_NAME} \\\n -t selene-public:${BRANCH_ALIAS} .\n \"\"\"\n timeout(time: 2, unit: 'MINUTES')\n {\n labelledShell label: 'Running behave tests', script: \"\"\"\n docker run \\\n --net selene-net \\\n -v '$HOME/selene/$BRANCH_ALIAS/allure/:/root/allure' \\\n -v '$HOME/selene/secrets/:/root/secrets' \\\n selene-public:${BRANCH_ALIAS}\n \"\"\"\n }\n }\n post {\n always {\n sh 'docker run \\\n -v \"$HOME/selene/$BRANCH_ALIAS/allure:/root/allure\" \\\n --entrypoint=/bin/bash \\\n --label build=${JOB_NAME} \\\n selene-account:${BRANCH_ALIAS} \\\n -x -c \"chown $(id -u $USER):$(id -g $USER) \\\n -R /root/allure/\"'\n }\n }\n }\n }\n post {\n always {\n sh 'rm -rf allure-result/*'\n sh 'mkdir -p $HOME/selene/$BRANCH_ALIAS/allure/allure-result'\n sh 'mv $HOME/selene/$BRANCH_ALIAS/allure/allure-result allure-result'\n // This directory should now be empty, rmdir will intentionally fail if not.\n sh 'rmdir $HOME/selene/$BRANCH_ALIAS/allure'\n script {\n allure([\n includeProperties: false,\n jdk: '',\n properties: [],\n reportBuildPolicy: 'ALWAYS',\n results: [[path: 'allure-result']]\n ])\n }\n sh(\n label: 'Cleanup lingering docker containers and images.',\n script: \"\"\"\n docker container prune --force;\n docker image prune --force;\n \"\"\"\n )\n }\n success {\n // Docker images should remain upon failure for troubleshooting purposes. However,\n // if the stage is successful, there is no reason to look back at the Docker image. In theory\n // broken builds will eventually be fixed so this step should run eventually for every PR\n sh(\n label: 'Delete Docker Image on Success',\n script: '''\n docker image prune --all --force --filter label=job=${JOB_NAME};\n '''\n )\n }\n }\n}\n" }, { "path": "LICENSE", "content": " GNU AFFERO GENERAL PUBLIC LICENSE\n Version 3, 19 November 2007\n\n Copyright (C) 2007 Free Software Foundation, Inc. \n Everyone is permitted to copy and distribute verbatim copies\n of this license document, but changing it is not allowed.\n\n Preamble\n\n The GNU Affero General Public License is a free, copyleft license for\nsoftware and other kinds of works, specifically designed to ensure\ncooperation with the community in the case of network server software.\n\n The licenses for most software and other practical works are designed\nto take away your freedom to share and change the works. By contrast,\nour General Public Licenses are intended to guarantee your freedom to\nshare and change all versions of a program--to make sure it remains free\nsoftware for all its users.\n\n When we speak of free software, we are referring to freedom, not\nprice. Our General Public Licenses are designed to make sure that you\nhave the freedom to distribute copies of free software (and charge for\nthem if you wish), that you receive source code or can get it if you\nwant it, that you can change the software or use pieces of it in new\nfree programs, and that you know you can do these things.\n\n Developers that use our General Public Licenses protect your rights\nwith two steps: (1) assert copyright on the software, and (2) offer\nyou this License which gives you legal permission to copy, distribute\nand/or modify the software.\n\n A secondary benefit of defending all users' freedom is that\nimprovements made in alternate versions of the program, if they\nreceive widespread use, become available for other developers to\nincorporate. Many developers of free software are heartened and\nencouraged by the resulting cooperation. However, in the case of\nsoftware used on network servers, this result may fail to come about.\nThe GNU General Public License permits making a modified version and\nletting the public access it on a server without ever releasing its\nsource code to the public.\n\n The GNU Affero General Public License is designed specifically to\nensure that, in such cases, the modified source code becomes available\nto the community. It requires the operator of a network server to\nprovide the source code of the modified version running there to the\nusers of that server. Therefore, public use of a modified version, on\na publicly accessible server, gives the public access to the source\ncode of the modified version.\n\n An older license, called the Affero General Public License and\npublished by Affero, was designed to accomplish similar goals. This is\na different license, not a version of the Affero GPL, but Affero has\nreleased a new version of the Affero GPL which permits relicensing under\nthis license.\n\n The precise terms and conditions for copying, distribution and\nmodification follow.\n\n TERMS AND CONDITIONS\n\n 0. Definitions.\n\n \"This License\" refers to version 3 of the GNU Affero General Public License.\n\n \"Copyright\" also means copyright-like laws that apply to other kinds of\nworks, such as semiconductor masks.\n\n \"The Program\" refers to any copyrightable work licensed under this\nLicense. Each licensee is addressed as \"you\". \"Licensees\" and\n\"recipients\" may be individuals or organizations.\n\n To \"modify\" a work means to copy from or adapt all or part of the work\nin a fashion requiring copyright permission, other than the making of an\nexact copy. The resulting work is called a \"modified version\" of the\nearlier work or a work \"based on\" the earlier work.\n\n A \"covered work\" means either the unmodified Program or a work based\non the Program.\n\n To \"propagate\" a work means to do anything with it that, without\npermission, would make you directly or secondarily liable for\ninfringement under applicable copyright law, except executing it on a\ncomputer or modifying a private copy. Propagation includes copying,\ndistribution (with or without modification), making available to the\npublic, and in some countries other activities as well.\n\n To \"convey\" a work means any kind of propagation that enables other\nparties to make or receive copies. Mere interaction with a user through\na computer network, with no transfer of a copy, is not conveying.\n\n An interactive user interface displays \"Appropriate Legal Notices\"\nto the extent that it includes a convenient and prominently visible\nfeature that (1) displays an appropriate copyright notice, and (2)\ntells the user that there is no warranty for the work (except to the\nextent that warranties are provided), that licensees may convey the\nwork under this License, and how to view a copy of this License. If\nthe interface presents a list of user commands or options, such as a\nmenu, a prominent item in the list meets this criterion.\n\n 1. Source Code.\n\n The \"source code\" for a work means the preferred form of the work\nfor making modifications to it. \"Object code\" means any non-source\nform of a work.\n\n A \"Standard Interface\" means an interface that either is an official\nstandard defined by a recognized standards body, or, in the case of\ninterfaces specified for a particular programming language, one that\nis widely used among developers working in that language.\n\n The \"System Libraries\" of an executable work include anything, other\nthan the work as a whole, that (a) is included in the normal form of\npackaging a Major Component, but which is not part of that Major\nComponent, and (b) serves only to enable use of the work with that\nMajor Component, or to implement a Standard Interface for which an\nimplementation is available to the public in source code form. A\n\"Major Component\", in this context, means a major essential component\n(kernel, window system, and so on) of the specific operating system\n(if any) on which the executable work runs, or a compiler used to\nproduce the work, or an object code interpreter used to run it.\n\n The \"Corresponding Source\" for a work in object code form means all\nthe source code needed to generate, install, and (for an executable\nwork) run the object code and to modify the work, including scripts to\ncontrol those activities. However, it does not include the work's\nSystem Libraries, or general-purpose tools or generally available free\nprograms which are used unmodified in performing those activities but\nwhich are not part of the work. For example, Corresponding Source\nincludes interface definition files associated with source files for\nthe work, and the source code for shared libraries and dynamically\nlinked subprograms that the work is specifically designed to require,\nsuch as by intimate data communication or control flow between those\nsubprograms and other parts of the work.\n\n The Corresponding Source need not include anything that users\ncan regenerate automatically from other parts of the Corresponding\nSource.\n\n The Corresponding Source for a work in source code form is that\nsame work.\n\n 2. Basic Permissions.\n\n All rights granted under this License are granted for the term of\ncopyright on the Program, and are irrevocable provided the stated\nconditions are met. This License explicitly affirms your unlimited\npermission to run the unmodified Program. The output from running a\ncovered work is covered by this License only if the output, given its\ncontent, constitutes a covered work. This License acknowledges your\nrights of fair use or other equivalent, as provided by copyright law.\n\n You may make, run and propagate covered works that you do not\nconvey, without conditions so long as your license otherwise remains\nin force. You may convey covered works to others for the sole purpose\nof having them make modifications exclusively for you, or provide you\nwith facilities for running those works, provided that you comply with\nthe terms of this License in conveying all material for which you do\nnot control copyright. Those thus making or running the covered works\nfor you must do so exclusively on your behalf, under your direction\nand control, on terms that prohibit them from making any copies of\nyour copyrighted material outside their relationship with you.\n\n Conveying under any other circumstances is permitted solely under\nthe conditions stated below. Sublicensing is not allowed; section 10\nmakes it unnecessary.\n\n 3. Protecting Users' Legal Rights From Anti-Circumvention Law.\n\n No covered work shall be deemed part of an effective technological\nmeasure under any applicable law fulfilling obligations under article\n11 of the WIPO copyright treaty adopted on 20 December 1996, or\nsimilar laws prohibiting or restricting circumvention of such\nmeasures.\n\n When you convey a covered work, you waive any legal power to forbid\ncircumvention of technological measures to the extent such circumvention\nis effected by exercising rights under this License with respect to\nthe covered work, and you disclaim any intention to limit operation or\nmodification of the work as a means of enforcing, against the work's\nusers, your or third parties' legal rights to forbid circumvention of\ntechnological measures.\n\n 4. Conveying Verbatim Copies.\n\n You may convey verbatim copies of the Program's source code as you\nreceive it, in any medium, provided that you conspicuously and\nappropriately publish on each copy an appropriate copyright notice;\nkeep intact all notices stating that this License and any\nnon-permissive terms added in accord with section 7 apply to the code;\nkeep intact all notices of the absence of any warranty; and give all\nrecipients a copy of this License along with the Program.\n\n You may charge any price or no price for each copy that you convey,\nand you may offer support or warranty protection for a fee.\n\n 5. Conveying Modified Source Versions.\n\n You may convey a work based on the Program, or the modifications to\nproduce it from the Program, in the form of source code under the\nterms of section 4, provided that you also meet all of these conditions:\n\n a) The work must carry prominent notices stating that you modified\n it, and giving a relevant date.\n\n b) The work must carry prominent notices stating that it is\n released under this License and any conditions added under section\n 7. This requirement modifies the requirement in section 4 to\n \"keep intact all notices\".\n\n c) You must license the entire work, as a whole, under this\n License to anyone who comes into possession of a copy. This\n License will therefore apply, along with any applicable section 7\n additional terms, to the whole of the work, and all its parts,\n regardless of how they are packaged. This License gives no\n permission to license the work in any other way, but it does not\n invalidate such permission if you have separately received it.\n\n d) If the work has interactive user interfaces, each must display\n Appropriate Legal Notices; however, if the Program has interactive\n interfaces that do not display Appropriate Legal Notices, your\n work need not make them do so.\n\n A compilation of a covered work with other separate and independent\nworks, which are not by their nature extensions of the covered work,\nand which are not combined with it such as to form a larger program,\nin or on a volume of a storage or distribution medium, is called an\n\"aggregate\" if the compilation and its resulting copyright are not\nused to limit the access or legal rights of the compilation's users\nbeyond what the individual works permit. Inclusion of a covered work\nin an aggregate does not cause this License to apply to the other\nparts of the aggregate.\n\n 6. Conveying Non-Source Forms.\n\n You may convey a covered work in object code form under the terms\nof sections 4 and 5, provided that you also convey the\nmachine-readable Corresponding Source under the terms of this License,\nin one of these ways:\n\n a) Convey the object code in, or embodied in, a physical product\n (including a physical distribution medium), accompanied by the\n Corresponding Source fixed on a durable physical medium\n customarily used for software interchange.\n\n b) Convey the object code in, or embodied in, a physical product\n (including a physical distribution medium), accompanied by a\n written offer, valid for at least three years and valid for as\n long as you offer spare parts or customer support for that product\n model, to give anyone who possesses the object code either (1) a\n copy of the Corresponding Source for all the software in the\n product that is covered by this License, on a durable physical\n medium customarily used for software interchange, for a price no\n more than your reasonable cost of physically performing this\n conveying of source, or (2) access to copy the\n Corresponding Source from a network server at no charge.\n\n c) Convey individual copies of the object code with a copy of the\n written offer to provide the Corresponding Source. This\n alternative is allowed only occasionally and noncommercially, and\n only if you received the object code with such an offer, in accord\n with subsection 6b.\n\n d) Convey the object code by offering access from a designated\n place (gratis or for a charge), and offer equivalent access to the\n Corresponding Source in the same way through the same place at no\n further charge. You need not require recipients to copy the\n Corresponding Source along with the object code. If the place to\n copy the object code is a network server, the Corresponding Source\n may be on a different server (operated by you or a third party)\n that supports equivalent copying facilities, provided you maintain\n clear directions next to the object code saying where to find the\n Corresponding Source. Regardless of what server hosts the\n Corresponding Source, you remain obligated to ensure that it is\n available for as long as needed to satisfy these requirements.\n\n e) Convey the object code using peer-to-peer transmission, provided\n you inform other peers where the object code and Corresponding\n Source of the work are being offered to the general public at no\n charge under subsection 6d.\n\n A separable portion of the object code, whose source code is excluded\nfrom the Corresponding Source as a System Library, need not be\nincluded in conveying the object code work.\n\n A \"User Product\" is either (1) a \"consumer product\", which means any\ntangible personal property which is normally used for personal, family,\nor household purposes, or (2) anything designed or sold for incorporation\ninto a dwelling. In determining whether a product is a consumer product,\ndoubtful cases shall be resolved in favor of coverage. For a particular\nproduct received by a particular user, \"normally used\" refers to a\ntypical or common use of that class of product, regardless of the status\nof the particular user or of the way in which the particular user\nactually uses, or expects or is expected to use, the product. A product\nis a consumer product regardless of whether the product has substantial\ncommercial, industrial or non-consumer uses, unless such uses represent\nthe only significant mode of use of the product.\n\n \"Installation Information\" for a User Product means any methods,\nprocedures, authorization keys, or other information required to install\nand execute modified versions of a covered work in that User Product from\na modified version of its Corresponding Source. The information must\nsuffice to ensure that the continued functioning of the modified object\ncode is in no case prevented or interfered with solely because\nmodification has been made.\n\n If you convey an object code work under this section in, or with, or\nspecifically for use in, a User Product, and the conveying occurs as\npart of a transaction in which the right of possession and use of the\nUser Product is transferred to the recipient in perpetuity or for a\nfixed term (regardless of how the transaction is characterized), the\nCorresponding Source conveyed under this section must be accompanied\nby the Installation Information. But this requirement does not apply\nif neither you nor any third party retains the ability to install\nmodified object code on the User Product (for example, the work has\nbeen installed in ROM).\n\n The requirement to provide Installation Information does not include a\nrequirement to continue to provide support service, warranty, or updates\nfor a work that has been modified or installed by the recipient, or for\nthe User Product in which it has been modified or installed. Access to a\nnetwork may be denied when the modification itself materially and\nadversely affects the operation of the network or violates the rules and\nprotocols for communication across the network.\n\n Corresponding Source conveyed, and Installation Information provided,\nin accord with this section must be in a format that is publicly\ndocumented (and with an implementation available to the public in\nsource code form), and must require no special password or key for\nunpacking, reading or copying.\n\n 7. Additional Terms.\n\n \"Additional permissions\" are terms that supplement the terms of this\nLicense by making exceptions from one or more of its conditions.\nAdditional permissions that are applicable to the entire Program shall\nbe treated as though they were included in this License, to the extent\nthat they are valid under applicable law. If additional permissions\napply only to part of the Program, that part may be used separately\nunder those permissions, but the entire Program remains governed by\nthis License without regard to the additional permissions.\n\n When you convey a copy of a covered work, you may at your option\nremove any additional permissions from that copy, or from any part of\nit. (Additional permissions may be written to require their own\nremoval in certain cases when you modify the work.) You may place\nadditional permissions on material, added by you to a covered work,\nfor which you have or can give appropriate copyright permission.\n\n Notwithstanding any other provision of this License, for material you\nadd to a covered work, you may (if authorized by the copyright holders of\nthat material) supplement the terms of this License with terms:\n\n a) Disclaiming warranty or limiting liability differently from the\n terms of sections 15 and 16 of this License; or\n\n b) Requiring preservation of specified reasonable legal notices or\n author attributions in that material or in the Appropriate Legal\n Notices displayed by works containing it; or\n\n c) Prohibiting misrepresentation of the origin of that material, or\n requiring that modified versions of such material be marked in\n reasonable ways as different from the original version; or\n\n d) Limiting the use for publicity purposes of names of licensors or\n authors of the material; or\n\n e) Declining to grant rights under trademark law for use of some\n trade names, trademarks, or service marks; or\n\n f) Requiring indemnification of licensors and authors of that\n material by anyone who conveys the material (or modified versions of\n it) with contractual assumptions of liability to the recipient, for\n any liability that these contractual assumptions directly impose on\n those licensors and authors.\n\n All other non-permissive additional terms are considered \"further\nrestrictions\" within the meaning of section 10. If the Program as you\nreceived it, or any part of it, contains a notice stating that it is\ngoverned by this License along with a term that is a further\nrestriction, you may remove that term. If a license document contains\na further restriction but permits relicensing or conveying under this\nLicense, you may add to a covered work material governed by the terms\nof that license document, provided that the further restriction does\nnot survive such relicensing or conveying.\n\n If you add terms to a covered work in accord with this section, you\nmust place, in the relevant source files, a statement of the\nadditional terms that apply to those files, or a notice indicating\nwhere to find the applicable terms.\n\n Additional terms, permissive or non-permissive, may be stated in the\nform of a separately written license, or stated as exceptions;\nthe above requirements apply either way.\n\n 8. Termination.\n\n You may not propagate or modify a covered work except as expressly\nprovided under this License. Any attempt otherwise to propagate or\nmodify it is void, and will automatically terminate your rights under\nthis License (including any patent licenses granted under the third\nparagraph of section 11).\n\n However, if you cease all violation of this License, then your\nlicense from a particular copyright holder is reinstated (a)\nprovisionally, unless and until the copyright holder explicitly and\nfinally terminates your license, and (b) permanently, if the copyright\nholder fails to notify you of the violation by some reasonable means\nprior to 60 days after the cessation.\n\n Moreover, your license from a particular copyright holder is\nreinstated permanently if the copyright holder notifies you of the\nviolation by some reasonable means, this is the first time you have\nreceived notice of violation of this License (for any work) from that\ncopyright holder, and you cure the violation prior to 30 days after\nyour receipt of the notice.\n\n Termination of your rights under this section does not terminate the\nlicenses of parties who have received copies or rights from you under\nthis License. If your rights have been terminated and not permanently\nreinstated, you do not qualify to receive new licenses for the same\nmaterial under section 10.\n\n 9. Acceptance Not Required for Having Copies.\n\n You are not required to accept this License in order to receive or\nrun a copy of the Program. Ancillary propagation of a covered work\noccurring solely as a consequence of using peer-to-peer transmission\nto receive a copy likewise does not require acceptance. However,\nnothing other than this License grants you permission to propagate or\nmodify any covered work. These actions infringe copyright if you do\nnot accept this License. Therefore, by modifying or propagating a\ncovered work, you indicate your acceptance of this License to do so.\n\n 10. Automatic Licensing of Downstream Recipients.\n\n Each time you convey a covered work, the recipient automatically\nreceives a license from the original licensors, to run, modify and\npropagate that work, subject to this License. You are not responsible\nfor enforcing compliance by third parties with this License.\n\n An \"entity transaction\" is a transaction transferring control of an\norganization, or substantially all assets of one, or subdividing an\norganization, or merging organizations. If propagation of a covered\nwork results from an entity transaction, each party to that\ntransaction who receives a copy of the work also receives whatever\nlicenses to the work the party's predecessor in interest had or could\ngive under the previous paragraph, plus a right to possession of the\nCorresponding Source of the work from the predecessor in interest, if\nthe predecessor has it or can get it with reasonable efforts.\n\n You may not impose any further restrictions on the exercise of the\nrights granted or affirmed under this License. For example, you may\nnot impose a license fee, royalty, or other charge for exercise of\nrights granted under this License, and you may not initiate litigation\n(including a cross-claim or counterclaim in a lawsuit) alleging that\nany patent claim is infringed by making, using, selling, offering for\nsale, or importing the Program or any portion of it.\n\n 11. Patents.\n\n A \"contributor\" is a copyright holder who authorizes use under this\nLicense of the Program or a work on which the Program is based. The\nwork thus licensed is called the contributor's \"contributor version\".\n\n A contributor's \"essential patent claims\" are all patent claims\nowned or controlled by the contributor, whether already acquired or\nhereafter acquired, that would be infringed by some manner, permitted\nby this License, of making, using, or selling its contributor version,\nbut do not include claims that would be infringed only as a\nconsequence of further modification of the contributor version. For\npurposes of this definition, \"control\" includes the right to grant\npatent sublicenses in a manner consistent with the requirements of\nthis License.\n\n Each contributor grants you a non-exclusive, worldwide, royalty-free\npatent license under the contributor's essential patent claims, to\nmake, use, sell, offer for sale, import and otherwise run, modify and\npropagate the contents of its contributor version.\n\n In the following three paragraphs, a \"patent license\" is any express\nagreement or commitment, however denominated, not to enforce a patent\n(such as an express permission to practice a patent or covenant not to\nsue for patent infringement). To \"grant\" such a patent license to a\nparty means to make such an agreement or commitment not to enforce a\npatent against the party.\n\n If you convey a covered work, knowingly relying on a patent license,\nand the Corresponding Source of the work is not available for anyone\nto copy, free of charge and under the terms of this License, through a\npublicly available network server or other readily accessible means,\nthen you must either (1) cause the Corresponding Source to be so\navailable, or (2) arrange to deprive yourself of the benefit of the\npatent license for this particular work, or (3) arrange, in a manner\nconsistent with the requirements of this License, to extend the patent\nlicense to downstream recipients. \"Knowingly relying\" means you have\nactual knowledge that, but for the patent license, your conveying the\ncovered work in a country, or your recipient's use of the covered work\nin a country, would infringe one or more identifiable patents in that\ncountry that you have reason to believe are valid.\n\n If, pursuant to or in connection with a single transaction or\narrangement, you convey, or propagate by procuring conveyance of, a\ncovered work, and grant a patent license to some of the parties\nreceiving the covered work authorizing them to use, propagate, modify\nor convey a specific copy of the covered work, then the patent license\nyou grant is automatically extended to all recipients of the covered\nwork and works based on it.\n\n A patent license is \"discriminatory\" if it does not include within\nthe scope of its coverage, prohibits the exercise of, or is\nconditioned on the non-exercise of one or more of the rights that are\nspecifically granted under this License. You may not convey a covered\nwork if you are a party to an arrangement with a third party that is\nin the business of distributing software, under which you make payment\nto the third party based on the extent of your activity of conveying\nthe work, and under which the third party grants, to any of the\nparties who would receive the covered work from you, a discriminatory\npatent license (a) in connection with copies of the covered work\nconveyed by you (or copies made from those copies), or (b) primarily\nfor and in connection with specific products or compilations that\ncontain the covered work, unless you entered into that arrangement,\nor that patent license was granted, prior to 28 March 2007.\n\n Nothing in this License shall be construed as excluding or limiting\nany implied license or other defenses to infringement that may\notherwise be available to you under applicable patent law.\n\n 12. No Surrender of Others' Freedom.\n\n If conditions are imposed on you (whether by court order, agreement or\notherwise) that contradict the conditions of this License, they do not\nexcuse you from the conditions of this License. If you cannot convey a\ncovered work so as to satisfy simultaneously your obligations under this\nLicense and any other pertinent obligations, then as a consequence you may\nnot convey it at all. For example, if you agree to terms that obligate you\nto collect a royalty for further conveying from those to whom you convey\nthe Program, the only way you could satisfy both those terms and this\nLicense would be to refrain entirely from conveying the Program.\n\n 13. Remote Network Interaction; Use with the GNU General Public License.\n\n Notwithstanding any other provision of this License, if you modify the\nProgram, your modified version must prominently offer all users\ninteracting with it remotely through a computer network (if your version\nsupports such interaction) an opportunity to receive the Corresponding\nSource of your version by providing access to the Corresponding Source\nfrom a network server at no charge, through some standard or customary\nmeans of facilitating copying of software. This Corresponding Source\nshall include the Corresponding Source for any work covered by version 3\nof the GNU General Public License that is incorporated pursuant to the\nfollowing paragraph.\n\n Notwithstanding any other provision of this License, you have\npermission to link or combine any covered work with a work licensed\nunder version 3 of the GNU General Public License into a single\ncombined work, and to convey the resulting work. The terms of this\nLicense will continue to apply to the part which is the covered work,\nbut the work with which it is combined will remain governed by version\n3 of the GNU General Public License.\n\n 14. Revised Versions of this License.\n\n The Free Software Foundation may publish revised and/or new versions of\nthe GNU Affero General Public License from time to time. Such new versions\nwill be similar in spirit to the present version, but may differ in detail to\naddress new problems or concerns.\n\n Each version is given a distinguishing version number. If the\nProgram specifies that a certain numbered version of the GNU Affero General\nPublic License \"or any later version\" applies to it, you have the\noption of following the terms and conditions either of that numbered\nversion or of any later version published by the Free Software\nFoundation. If the Program does not specify a version number of the\nGNU Affero General Public License, you may choose any version ever published\nby the Free Software Foundation.\n\n If the Program specifies that a proxy can decide which future\nversions of the GNU Affero General Public License can be used, that proxy's\npublic statement of acceptance of a version permanently authorizes you\nto choose that version for the Program.\n\n Later license versions may give you additional or different\npermissions. However, no additional obligations are imposed on any\nauthor or copyright holder as a result of your choosing to follow a\nlater version.\n\n 15. Disclaimer of Warranty.\n\n THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY\nAPPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT\nHOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM \"AS IS\" WITHOUT WARRANTY\nOF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,\nTHE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR\nPURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM\nIS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF\nALL NECESSARY SERVICING, REPAIR OR CORRECTION.\n\n 16. Limitation of Liability.\n\n IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING\nWILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS\nTHE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY\nGENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE\nUSE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF\nDATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD\nPARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),\nEVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF\nSUCH DAMAGES.\n\n 17. Interpretation of Sections 15 and 16.\n\n If the disclaimer of warranty and limitation of liability provided\nabove cannot be given local legal effect according to their terms,\nreviewing courts shall apply local law that most closely approximates\nan absolute waiver of all civil liability in connection with the\nProgram, unless a warranty or assumption of liability accompanies a\ncopy of the Program in return for a fee.\n\n END OF TERMS AND CONDITIONS\n\n How to Apply These Terms to Your New Programs\n\n If you develop a new program, and you want it to be of the greatest\npossible use to the public, the best way to achieve this is to make it\nfree software which everyone can redistribute and change under these terms.\n\n To do so, attach the following notices to the program. It is safest\nto attach them to the start of each source file to most effectively\nstate the exclusion of warranty; and each file should have at least\nthe \"copyright\" line and a pointer to where the full notice is found.\n\n \n Copyright (C) \n\n This program is free software: you can redistribute it and/or modify\n it under the terms of the GNU Affero General Public License as published by\n the Free Software Foundation, either version 3 of the License, or\n (at your option) any later version.\n\n This program is distributed in the hope that it will be useful,\n but WITHOUT ANY WARRANTY; without even the implied warranty of\n MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n GNU Affero General Public License for more details.\n\n You should have received a copy of the GNU Affero General Public License\n along with this program. If not, see .\n\nAlso add information on how to contact you by electronic and paper mail.\n\n If your software can interact with users remotely through a computer\nnetwork, you should also make sure that it provides a way for users to\nget its source. For example, if your program is a web application, its\ninterface could display a \"Source\" link that leads users to an archive\nof the code. There are many ways you could offer source, and different\nsolutions will be better for different programs; see section 13 for the\nspecific requirements.\n\n You should also get your employer (if you work as a programmer) or school,\nif any, to sign a \"copyright disclaimer\" for the program, if necessary.\nFor more information on this, and how to apply and follow the GNU AGPL, see\n." }, { "path": "README.md", "content": "[![License](https://img.shields.io/badge/License-GNU_AGPL%203.0-blue.svg)](LICENSE)\n[![CLA](https://img.shields.io/badge/CLA%3F-Required-blue.svg)](https://mycroft.ai/cla)\n[![Team](https://img.shields.io/badge/Team-Mycroft_Backend-violetblue.svg)](https://github.com/MycroftAI/contributors/blob/master/team/Mycroft%20Backend.md)\n![Status](https://img.shields.io/badge/-Production_ready-green.svg)\n\n[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)\n[![Join chat](https://img.shields.io/badge/Mattermost-join_chat-brightgreen.svg)](https://chat.mycroft.ai)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n\n\n\nSelene -- Mycroft's Server Backend\n==========\n\nSelene provides the services used by [Mycroft Core](https://github.com/mycroftai/mycroft-core) to manage devices, skills\nand settings. It consists of two repositories. This one contains Python and SQL representing the database definition,\ndata access layer, APIs and scripts. The second repository, [Selene UI](https://github.com/mycroftai/selene-ui),\ncontains Angular web applications that use the APIs defined in this repository.\n\nThere are four APIs defined in this repository, account management, single sign on, skill marketplace and device.\nThe first three support account.mycroft.ai (aka home.mycroft.ai), sso.mycroft.ai, and market.mycroft.ai, respectively.\nThe device API is how devices running Mycroft Core communicate with the server. Also included in this repository is\na package containing batch scripts for maintenance and the definition of the database schema.\n\nEach API is designed to run independently of the others. Code common to each of the APIs, such as the Data Access Layer,\ncan be found in the \"shared\" directory. The shared code is an independent Python package required by each of the APIs.\nEach API has its own Pipfile so that it can be run in its own virtual environment.\n\n## Installation\nThe Python code utilizes features introduced in Python 3.7, such as data classes.\n[Pipenv](https://pipenv.readthedocs.io/en/latest/) is used for virtual environment and package management.\nIf you prefer to use pip and pyenv (or virtualenv), you can find the required libraries in the files named \"Pipfile\".\nThese instructions will use pipenv commands.\n\nIf the Selene applications will be servicing a large number of devices (enterprise usage, for example), it is\nrecommended that each of the applications run on their own server or virtual machine. This configuration makes it\neasier to scale and monitor each application independently. However, all applications can be run on a single server.\nThis configuration could be more practical for a household running a handful of devices.\n\nThese instructions will assume a multi-server setup for several thousand devices. To run on a single server servicing a\nsmall number of devices, the recommended system requirements are 4 CPU, 8GB RAM and 100GB of disk. There are a lot of\nmanual steps in this section that will eventually be replaced with an installation script.\n\nAll Selene applications are time zone agnostic. It is recommended that the time zone on any server running Selene be UTC.\n\nIt is recommended to create an application specific user. In these instructions this user will be `mycroft`.\n\n### Postgres DB\n* Recommended server configuration: [Ubuntu 18.04 LTS (server install)](https://releases.ubuntu.com/bionic/), 2 CPU, 4GB RAM, 50GB disk.\n* Use the package management system to install Python 3.7, Python 3 pip and PostgreSQL 10\n```\nsudo apt-get install postgresql python3.7 python python3-pip\n```\n* Set Postgres to start on boot\n```\nsudo systemctl enable postgresql\n```\n* Clone the selene-backend and documentation repositories\n```\nsudo mkdir -p /opt/selene\nsudo chown -R mycroft:users /opt/selene\ncd /opt/selene\ngit clone https://github.com/MycroftAI/selene-backend.git\n```\n* Create the virtual environment for the database code\n```\nsudo python3.7 -m pip install pipenv\ncd /opt/selene/selene-backend/db\npipenv install\n```\n* Download files from geonames.org used to populate the geography schema tables\n```\nmkdir -p /opt/selene/data\ncd /opt/selene/data\nwget http://download.geonames.org/export/dump/countryInfo.txt\nwget http://download.geonames.org/export/dump/timeZones.txt\nwget http://download.geonames.org/export/dump/admin1CodesASCII.txt\nwget http://download.geonames.org/export/dump/cities500.zip\n```\n* Add environment variables containing these passwords for the bootstrap script\n```\nexport DB_PASSWORD=\nexport POSTGRES_PASSWORD=\n```\n* Generate secure passwords for the postgres user and selene user on the database\n```\nsudo -u postgres psql -c \"ALTER USER postgres PASSWORD '$POSTGRES_PASSWORD'\"\nsudo -u postgres psql -c \"CREATE ROLE selene WITH LOGIN ENCRYPTED PASSWORD '$DB_PASSWORD'\"\n```\n* Run the bootstrap script\n```\ncd /opt/selene/selene-backend/db/scripts\npipenv run python bootstrap_mycroft_db.py\n```\n * Note: if you get an authentication error you can temporarily edit `/etc/postgresql//main/pg_hba.conf` replacing the following lines:\n ```\n # \"local\" is for Unix domain socket connections only\n local all all trust\n # IPv4 local connections:\n host all all 127.0.0.1/32 trust\n ```\n* By default, Postgres only listens on localhost. This will not do for a multi-server setup. Change the\n`listen_addresses` value in the `posgresql.conf` file to the private IP of the database server. This file is owned by\nthe `postgres` user so use the following command to edit it (substituting vi for your favorite editor)\n```\nsudo -u postgres vi /etc/postgres/10/main/postgresql.conf\n```\n* By default, Postgres only allows connections from localhost. This will not do for a multi-server setup either. Add\nan entry to the `pg_hba.conf` file for each server that needs to access this database. This file is also owned by\nthe `postgres` user so use the following command to edit it (substituting vi for your favorite editor)\n```\nsudo -u postgres vi /etc/postgres/10/main/pg_hba.conf\n```\n* Instructions on how to update the `pg_hba.conf` file can be found in\n[Postgres' documentation](https://www.postgresql.org/docs/10/auth-pg-hba-conf.html). Below is an example for reference.\n```\n# IPv4 Selene connections\nhost mycroft selene /32 md5\n```\n* Restart Postgres for the `postgres.conf` and `pg_hba.conf` changes to take effect.\n```\nsudo systemctl restart postgresql\n```\n\n### Redis DB\n\n* Recommended server configuration: Ubuntu 18.04 LTS, 1 CPU, 1GB RAM, 5GB disk.\nSo as to not reinvent the wheel, here are some easy-to-follow instructions for\n[installing Redis on Ubuntu 18.04](https://www.digitalocean.com/community/tutorials/how-to-install-and-secure-redis-on-ubuntu-18-04).\n* By default, Redis only listens on local host. For multi-server setups, one additional step is to change the \"bind\" variable in `/etc/redis/redis.conf` to be the private IP of the Redis host.\n\n### APIs\n\nThe majority of the setup for each API is the same. This section defines the steps common to all APIs. Steps specific\nto each API will be defined in their respective sections.\n* Add an application user to the VM. Either give this user sudo privileges or execute the sudo commands below as a user\nwith sudo privileges. These instructions will assume a user name of \"mycroft\"\n* Use the package management system to install Python 3.7, Python 3 pip and Python 3.7 Developer Tools\n```\nsudo apt install python3.7 python3-pip python3.7-dev\nsudo python3.7 -m pip install pipenv\n```\n* Setup the Backend Application Directory\n```\nsudo mkdir -p /opt/selene\nsudo chown -R mycroft:users /opt/selene\n```\n* Setup the Log Directory\n```\nsudo mkdir -p /var/log/mycroft\nsudo chown -R mycroft:users /var/log/mycroft\n```\n* Clone the Selene Backend Repository\n```\ncd /opt/selene\ngit clone https://github.com/MycroftAI/selene-backend.git\n```\n* If running in a test environment, be sure to checkout the \"test\" branch of the repository\n\n#### Single Sign On API\nRecommended server configuration: Ubuntu 18.04 LTS, 1 CPU, 1GB RAM, 5GB disk\n* Create the virtual environment and install the requirements for the application\n```\ncd /opt/selene/selene-backend/api/sso\npipenv install\n```\n\n#### Account API\n* Recommended server configuration: Ubuntu 18.04 LTS, 1 CPU, 1GB RAM, 5GB disk\n* Create the virtual environment and install the requirements for the application\n```\ncd /opt/selene/selene-backend/api/account\npipenv install\n```\n\n#### Marketplace API\n* Recommended server configuration: Ubuntu 18.04 LTS, 1 CPU, 1GB RAM, 10GB disk\n* Create the virtual environment and install the requirements for the application\n```\ncd /opt/selene/selene-backend/api/market\npipenv install\n```\n\n#### Device API\n* Recommended server configuration: Ubuntu 18.04 LTS, 2 CPU, 2GB RAM, 50GB disk\n* Create the virtual environment and install the requirements for the application\n```\ncd /opt/selene/selene-backend/api/public\npipenv install\n```\n\n#### Precise API\n* Recommended server configuration: Ubuntu 18.04 LTS, 1 CPU, 1GB RAM, 5GB disk\n* Create the virtual environment and install the requirements for the application\n```\ncd /opt/selene/selene-backend/api/precise\npipenv install\n```\n### Running the APIs\nEach API is configured to run on port 5000. This is not a problem if each is running in its own VM but will be an\nissue if all APIs are running on the same server, or if port 5000 is already in use. To address these scenarios,\nchange the port numbering in the uwsgi.ini file for each API.\n\n#### Single Sign On API\n* The SSO application uses three JWTs for authentication. First is an access key, which is required to authenticate a\nuser for API calls. Second is a refresh key that automatically refreshes the access key when it expires. Third is a\nreset key, which is used in a password reset scenario. Generate a secret key for each JWT.\n* Any data that can identify a user is encrypted. Generate a salt that will be used with the encryption algorithm.\n* Access to the Github API is required to support logging in with your Github account. Details can be found\n[here](https://developer.github.com/v3/guides/basics-of-authentication/).\n* The password reset functionality sends an email to the user with a link to reset their password. Selene uses\nSendGrid to send these emails so a SendGrid account and API key are required.\n* Define a systemd service to run the API. The service defines environment variables that use the secret and API keys\ngenerated in previous steps.\n```\nsudo vim /etc/systemd/system/sso_api.service\n```\n```\n[Unit]\nDescription=Mycroft Single Sign On Api\nAfter=network.target\n\n[Service]\nUser=mycroft\nGroup=www-data\nRestart=always\nType=simple\nWorkingDirectory=/opt/selene/selene-backend/api/sso\nExecStart=/usr/local/bin/pipenv run uwsgi --ini uwsgi.ini\nEnvironment=DB_HOST=\nEnvironment=DB_NAME=mycroft\nEnvironment=DB_PASSWORD=\nEnvironment=DB_PORT=5432\nEnvironment=DB_USER=selene\nEnvironment=GITHUB_CLIENT_ID=\nEnvironment=GITHUB_CLIENT_SECRET=\nEnvironment=JWT_ACCESS_SECRET=\nEnvironment=JWT_REFRESH_SECRET=\nEnvironment=JWT_RESET_SECRET=\nEnvironment=SALT=\nEnvironment=SELENE_ENVIRONMENT=\nEnvironment=SENDGRID_API_KEY=\nEnvironment=SSO_BASE_URL=\n\n[Install]\nWantedBy=multi-user.target\n```\n* Start the sso_api service and set it to start on boot\n```\nsudo systemctl start sso_api.service\nsudo systemctl enable sso_api.service\n```\n\n#### Account API\n* The account API uses the same authentication mechanism as the single sign on API. The JWT_ACCESS_SECRET,\nJWT_REFRESH_SECRET and SALT environment variables must be the same values as those on the single sign on API.\n* This application uses the Redis database so the service needs to know where it resides.\n* Define a systemd service to run the API. The service defines environment variables that use the secret and API keys\ngenerated in previous steps.\n```\nsudo vim /etc/systemd/system/account_api.service\n```\n```\n[Unit]\nDescription=Mycroft Account API\nAfter=network.target\n\n[Service]\nUser=mycroft\nGroup=www-data\nRestart=always\nType=simple\nWorkingDirectory=/opt/selene/selene-backend/api/account\nExecStart=/usr/local/bin/pipenv run uwsgi --ini uwsgi.ini\nEnvironment=DB_HOST=\nEnvironment=DB_NAME=mycroft\nEnvironment=DB_PASSWORD=\nEnvironment=DB_PORT=5432\nEnvironment=DB_USER=selene\nEnvironment=JWT_ACCESS_SECRET=\nEnvironment=JWT_REFRESH_SECRET=\nEnvironment=OAUTH_BASE_URL=\nEnvironment=REDIS_HOST=\nEnvironment=REDIS_PORT=6379\nEnvironment=SELENE_ENVIRONMENT=\nEnvironment=SALT=\n\n[Install]\nWantedBy=multi-user.target\n```\n* Start the account_api service and set it to start on boot\n```\nsudo systemctl start account_api.service\nsudo systemctl enable account_api.service\n```\n\n#### Marketplace API\n* The marketplace API uses the same authentication mechanism as the single sign on API. The JWT_ACCESS_SECRET,\nJWT_REFRESH_SECRET and SALT environment variables must be the same values as those on the single sign on API.\n* This application uses the Redis database so the service needs to know where it resides.\n* Define a systemd service to run the API. The service defines environment variables that use the secret and API keys\ngenerated in previous steps.\n```\nsudo vim /etc/systemd/system/market_api.service\n```\n```\n[Unit]\nDescription=Mycroft Marketplace API\nAfter=network.target\n\n[Service]\nUser=mycroft\nGroup=www-data\nRestart=always\nType=simple\nWorkingDirectory=/opt/selene/selene-backend/api/market\nExecStart=/usr/local/bin/pipenv run uwsgi --ini uwsgi.ini\nEnvironment=DB_HOST=\nEnvironment=DB_NAME=mycroft\nEnvironment=DB_PASSWORD=\nEnvironment=DB_PORT=5432\nEnvironment=DB_USER=selene\nEnvironment=JWT_ACCESS_SECRET=\nEnvironment=JWT_REFRESH_SECRET=\nEnvironment=OAUTH_BASE_URL=\nEnvironment=REDIS_HOST=\nEnvironment=REDIS_PORT=6379\nEnvironment=SELENE_ENVIRONMENT=\nEnvironment=SALT=\n\n[Install]\nWantedBy=multi-user.target\n```\n* Start the market_api service and set it to start on boot\n```\nsudo systemctl start market_api.service\nsudo systemctl enable market_api.service\n```\n* The marketplace API assumes that the skills it supplies to the web application are in the Postgres database. To get\nthem there, a script needs to be run to download them from Github. The script requires the GITHUB_USER, GITHUB_PASSWORD,\nDB_HOST, DB_NAME, DB_USER and DB_PASSWORD environment variables to run. Use the same values as those in the service\ndefinition files.\n```\ncd /opt/selene/selene-backend/batch\npipenv install\npipenv run python load_skill_display_data.py --core-version \n```\n\n#### Device API\n* The device API uses the same authentication mechanism as the single sign on API. The JWT_ACCESS_SECRET,\nJWT_REFRESH_SECRET and SALT environment variables must be the same values as those on the single sign on API.\n* This application uses the Redis database so the service needs to know where it resides.\n* The weather skill requires a key to the Open Weather Map API\n* The speech to text engine requires a key to Google's STT API.\n* The Wolfram Alpha skill requires an API key to the Wolfram Alpha API\n* Define a systemd service to run the API. The service defines environment variables that use the secret and API keys\ngenerated in previous steps.\n```\nsudo vim /etc/systemd/system/public_api.service\n```\n```\n[Unit]\nDescription=Mycroft Public API\nAfter=network.target\n\n[Service]\nUser=mycroft\nGroup=www-data\nRestart=always\nType=simple\nWorkingDirectory=/opt/selene/selene-backend/api/public\nExecStart=/usr/local/bin/pipenv run uwsgi --ini uwsgi.ini\nEnvironment=DB_HOST=\nEnvironment=DB_NAME=mycroft\nEnvironment=DB_PASSWORD=\nEnvironment=DB_PORT=5432\nEnvironment=DB_USER=selene\nEnvironment=EMAIL_SERVICE_HOST=\nEnvironment=EMAIL_SERVICE_PORT=\nEnvironment=EMAIL_SERVICE_USER=\nEnvironment=EMAIL_SERVICE_PASSWORD=\nEnvironment=GOOGLE_STT_KEY=\nEnvironment=JWT_ACCESS_SECRET=\nEnvironment=JWT_REFRESH_SECRET=\nEnvironment=OAUTH_BASE_URL=\nEnvironment=OWM_KEY=\nEnvironment=OWM_URL=https://api.openweathermap.org/data/2.5\nEnvironment=REDIS_HOST=\nEnvironment=REDIS_PORT=6379\nEnvironment=SELENE_ENVIRONMENT=\nEnvironment=SALT=\nEnvironment=WOLFRAM_ALPHA_KEY=.\n" }, { "path": "api/account/account_api/api.py", "content": "# Mycroft Server - Backend\n# Copyright (C) 2019 Mycroft AI Inc\n# SPDX-License-Identifier: \tAGPL-3.0-or-later\n#\n# This file is part of the Mycroft Server.\n#\n# The Mycroft Server is free software: you can redistribute it and/or\n# modify it under the terms of the GNU Affero General Public License as\n# published by the Free Software Foundation, either version 3 of the\n# License, or (at your option) any later version.\n#\n# This program is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU Affero General Public License for more details.\n#\n# You should have received a copy of the GNU Affero General Public License\n# along with this program. If not, see .\n\n\"\"\"Entry point for the API that supports the Mycroft Marketplace.\"\"\"\nfrom flask import Flask\n\nfrom selene.api import get_base_config, selene_api, SeleneResponse\nfrom selene.api.endpoints import (\n AccountEndpoint,\n AgreementsEndpoint,\n ValidateEmailEndpoint,\n)\nfrom selene.util.cache import SeleneCache\nfrom selene.util.log import configure_selene_logger\nfrom .endpoints import (\n AccountDefaultsEndpoint,\n CityEndpoint,\n CountryEndpoint,\n EmailAddressChangeEndpoint,\n DeviceEndpoint,\n DeviceCountEndpoint,\n GeographyEndpoint,\n MembershipEndpoint,\n RegionEndpoint,\n PairingCodeEndpoint,\n PasswordChangeEndpoint,\n PreferencesEndpoint,\n SkillsEndpoint,\n SkillOauthEndpoint,\n SkillSettingsEndpoint,\n SoftwareUpdateEndpoint,\n SshKeyValidatorEndpoint,\n TimezoneEndpoint,\n VerifyEmailAddressEndpoint,\n VoiceEndpoint,\n WakeWordEndpoint,\n)\n\nconfigure_selene_logger(\"account_api\")\n\n\n# Define the Flask application\nacct = Flask(__name__)\nacct.config.from_object(get_base_config())\nacct.response_class = SeleneResponse\nacct.register_blueprint(selene_api)\nacct.config[\"SELENE_CACHE\"] = SeleneCache()\n\naccount_endpoint = AccountEndpoint.as_view(\"account_endpoint\")\nacct.add_url_rule(\n \"/api/account\", view_func=account_endpoint, methods=[\"GET\", \"PATCH\", \"DELETE\"]\n)\n\nagreements_endpoint = AgreementsEndpoint.as_view(\"agreements_endpoint\")\nacct.add_url_rule(\n \"/api/agreement/\",\n view_func=agreements_endpoint,\n methods=[\"GET\"],\n)\n\ncity_endpoint = CityEndpoint.as_view(\"city_endpoint\")\nacct.add_url_rule(\"/api/cities\", view_func=city_endpoint, methods=[\"GET\"])\n\ncountry_endpoint = CountryEndpoint.as_view(\"country_endpoint\")\nacct.add_url_rule(\"/api/countries\", view_func=country_endpoint, methods=[\"GET\"])\n\ndefaults_endpoint = AccountDefaultsEndpoint.as_view(\"defaults_endpoint\")\nacct.add_url_rule(\n \"/api/defaults\", view_func=defaults_endpoint, methods=[\"GET\", \"PATCH\", \"POST\"]\n)\n\ndevice_endpoint = DeviceEndpoint.as_view(\"device_endpoint\")\nacct.add_url_rule(\n \"/api/devices\",\n defaults={\"device_id\": None},\n view_func=device_endpoint,\n methods=[\"GET\"],\n)\nacct.add_url_rule(\"/api/devices\", view_func=device_endpoint, methods=[\"POST\"])\nacct.add_url_rule(\n \"/api/devices/\",\n view_func=device_endpoint,\n methods=[\"DELETE\", \"GET\", \"PATCH\"],\n)\n\ndevice_count_endpoint = DeviceCountEndpoint.as_view(\"device_count_endpoint\")\nacct.add_url_rule(\"/api/device-count\", view_func=device_count_endpoint, methods=[\"GET\"])\n\nchange_email_endpoint = EmailAddressChangeEndpoint.as_view(\"change_email_endpoint\")\nacct.add_url_rule(\"/api/change-email\", view_func=change_email_endpoint, methods=[\"PUT\"])\n\nchange_password_endpoint = PasswordChangeEndpoint.as_view(\"change_password_endpoint\")\nacct.add_url_rule(\n \"/api/change-password\", view_func=change_password_endpoint, methods=[\"PUT\"]\n)\n\ngeography_endpoint = GeographyEndpoint.as_view(\"geography_endpoint\")\nacct.add_url_rule(\"/api/geographies\", view_func=geography_endpoint, methods=[\"GET\"])\n\nmembership_endpoint = MembershipEndpoint.as_view(\"membership_endpoint\")\nacct.add_url_rule(\"/api/memberships\", view_func=membership_endpoint, methods=[\"GET\"])\n\npairing_code_endpoint = PairingCodeEndpoint.as_view(\"pairing_code_endpoint\")\nacct.add_url_rule(\n \"/api/pairing-code/\",\n view_func=pairing_code_endpoint,\n methods=[\"GET\"],\n)\n\npreferences_endpoint = PreferencesEndpoint.as_view(\"preferences_endpoint\")\nacct.add_url_rule(\n \"/api/preferences\", view_func=preferences_endpoint, methods=[\"GET\", \"PATCH\", \"POST\"]\n)\n\nregion_endpoint = RegionEndpoint.as_view(\"region_endpoint\")\nacct.add_url_rule(\"/api/regions\", view_func=region_endpoint, methods=[\"GET\"])\n\nsetting_endpoint = SkillSettingsEndpoint.as_view(\"setting_endpoint\")\nacct.add_url_rule(\n \"/api/skills//settings\",\n view_func=setting_endpoint,\n methods=[\"GET\", \"PUT\"],\n)\n\nskill_endpoint = SkillsEndpoint.as_view(\"skill_endpoint\")\nacct.add_url_rule(\"/api/skills\", view_func=skill_endpoint, methods=[\"GET\"])\n\nskill_oauth_endpoint = SkillOauthEndpoint.as_view(\"skill_oauth_endpoint\")\nacct.add_url_rule(\n \"/api/skills/oauth/\", view_func=skill_oauth_endpoint, methods=[\"GET\"]\n)\n\nsoftware_update_endpoint = SoftwareUpdateEndpoint.as_view(\"software_update_endpoint\")\nacct.add_url_rule(\n \"/api/software-update\", view_func=software_update_endpoint, methods=[\"PATCH\"]\n)\n\nssh_key_validation_endpoint = SshKeyValidatorEndpoint.as_view(\n \"ssh_key_validation_endpoint\"\n)\nacct.add_url_rule(\n \"/api/ssh-key\",\n view_func=ssh_key_validation_endpoint,\n methods=[\"GET\"],\n)\n\ntimezone_endpoint = TimezoneEndpoint.as_view(\"timezone_endpoint\")\nacct.add_url_rule(\"/api/timezones\", view_func=timezone_endpoint, methods=[\"GET\"])\n\nvalidate_email_endpoint = ValidateEmailEndpoint.as_view(\"validate_email_endpoint\")\nacct.add_url_rule(\n \"/api/validate-email\", view_func=validate_email_endpoint, methods=[\"GET\"]\n)\n\nverify_email_endpoint = VerifyEmailAddressEndpoint.as_view(\"verify_email_endpoint\")\nacct.add_url_rule(\"/api/verify-email\", view_func=verify_email_endpoint, methods=[\"PUT\"])\n\nvoice_endpoint = VoiceEndpoint.as_view(\"voice_endpoint\")\nacct.add_url_rule(\"/api/voices\", view_func=voice_endpoint, methods=[\"GET\"])\n\nwake_word_endpoint = WakeWordEndpoint.as_view(\"wake_word_endpoint\")\nacct.add_url_rule(\"/api/wake-words\", view_func=wake_word_endpoint, methods=[\"GET\"])\n" }, { "path": "api/account/account_api/endpoints/__init__.py", "content": "# Mycroft Server - Backend\n# Copyright (C) 2019 Mycroft AI Inc\n# SPDX-License-Identifier: \tAGPL-3.0-or-later\n#\n# This file is part of the Mycroft Server.\n#\n# The Mycroft Server is free software: you can redistribute it and/or\n# modify it under the terms of the GNU Affero General Public License as\n# published by the Free Software Foundation, either version 3 of the\n# License, or (at your option) any later version.\n#\n# This program is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU Affero General Public License for more details.\n#\n# You should have received a copy of the GNU Affero General Public License\n# along with this program. If not, see .\n\"\"\"Public API into the endpoints package.\"\"\"\n\nfrom .preferences import PreferencesEndpoint\nfrom .change_email_address import EmailAddressChangeEndpoint\nfrom .change_password import PasswordChangeEndpoint\nfrom .city import CityEndpoint\nfrom .country import CountryEndpoint\nfrom .defaults import AccountDefaultsEndpoint\nfrom .device import DeviceEndpoint\nfrom .device_count import DeviceCountEndpoint\nfrom .geography import GeographyEndpoint\nfrom .membership import MembershipEndpoint\nfrom .pairing_code import PairingCodeEndpoint\nfrom .region import RegionEndpoint\nfrom .skills import SkillsEndpoint\nfrom .skill_oauth import SkillOauthEndpoint\nfrom .skill_settings import SkillSettingsEndpoint\nfrom .software_update import SoftwareUpdateEndpoint\nfrom .ssh_key_validator import SshKeyValidatorEndpoint\nfrom .timezone import TimezoneEndpoint\nfrom .verify_email_address import VerifyEmailAddressEndpoint\nfrom .voice_endpoint import VoiceEndpoint\nfrom .wake_word_endpoint import WakeWordEndpoint\n" }, { "path": "api/account/account_api/endpoints/change_email_address.py", "content": "# Mycroft Server - Backend\n# Copyright (c) 2022 Mycroft AI Inc\n# SPDX-License-Identifier: \tAGPL-3.0-or-later\n# #\n# This file is part of the Mycroft Server.\n# #\n# The Mycroft Server is free software: you can redistribute it and/or\n# modify it under the terms of the GNU Affero General Public License as\n# published by the Free Software Foundation, either version 3 of the\n# License, or (at your option) any later version.\n# #\n# This program is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU Affero General Public License for more details.\n# #\n# You should have received a copy of the GNU Affero General Public License\n# along with this program. If not, see .\n#\n\"\"\"Defines the password change endpoint for the account API.\n\nThis endpoint does not update the email address in the database. The user needs to\nverify the email address is correct before the change is applied. See the\nverify_email_address module in this package for the verification step.\n\"\"\"\nfrom binascii import a2b_base64, b2a_base64\nfrom http import HTTPStatus\nfrom os import environ\n\nfrom selene.api import APIError, SeleneEndpoint\nfrom selene.util.email import EmailMessage, SeleneMailer, validate_email_address\n\n\nclass EmailAddressChangeEndpoint(SeleneEndpoint):\n \"\"\"Adds authentication to the common password changing endpoint.\"\"\"\n\n def put(self):\n \"\"\"Executes an HTTP PUT request.\"\"\"\n self._authenticate()\n new_email_address = self._validate_request()\n self._send_notification()\n self._send_verification_email(new_email_address)\n\n return \"\", HTTPStatus.NO_CONTENT\n\n def _validate_request(self) -> str:\n \"\"\"Validates the content of the API request.\n\n :returns: A validated and normalized email address\n :raises: APIError when email address is invalid\n \"\"\"\n request_token = self.request.json[\"token\"]\n new_email_address = a2b_base64(request_token).decode()\n normalized_address, error = validate_email_address(new_email_address)\n if error is not None:\n raise APIError(error)\n\n return normalized_address\n\n def _send_notification(self):\n \"\"\"Notifies the current email address' owner of the requested change.\"\"\"\n _, error = validate_email_address(self.account.email_address)\n if error is None:\n email = EmailMessage(\n recipient=self.account.email_address,\n sender=\"Mycroft AI\",\n subject=\"Email Address Changed\",\n template_file_name=\"email_change.html\",\n )\n mailer = SeleneMailer(email)\n mailer.send(using_jinja=True)\n\n @staticmethod\n def _send_verification_email(new_email_address):\n \"\"\"Sends an email with a link for email verification to the requested address.\n\n :param new_email_address: the recipient of the verification email\n \"\"\"\n base_url = environ[\"ACCOUNT_BASE_URL\"]\n token = b2a_base64(new_email_address.encode(), newline=False).decode()\n url = f\"{base_url}/verify-email?token={token}\"\n email = EmailMessage(\n recipient=new_email_address,\n sender=\"Mycroft AI\",\n subject=\"Email Change Verification\",\n template_file_name=\"email_verification.html\",\n template_variables=dict(email_verification_url=url),\n )\n mailer = SeleneMailer(email)\n mailer.send(using_jinja=True)\n" }, { "path": "api/account/account_api/endpoints/change_password.py", "content": "# Mycroft Server - Backend\n# Copyright (c) 2022 Mycroft AI Inc\n# SPDX-License-Identifier: \tAGPL-3.0-or-later\n# #\n# This file is part of the Mycroft Server.\n# #\n# The Mycroft Server is free software: you can redistribute it and/or\n# modify it under the terms of the GNU Affero General Public License as\n# published by the Free Software Foundation, either version 3 of the\n# License, or (at your option) any later version.\n# #\n# This program is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU Affero General Public License for more details.\n# #\n# You should have received a copy of the GNU Affero General Public License\n# along with this program. If not, see .\n#\n\"\"\"Defines the password change endpoint for the account API.\"\"\"\nfrom selene.api.endpoints import PasswordChangeEndpoint as CommonPasswordChangeEndpoint\nfrom selene.util.email import EmailMessage, SeleneMailer\n\n\nclass PasswordChangeEndpoint(CommonPasswordChangeEndpoint):\n \"\"\"Adds authentication to the common password changing endpoint.\"\"\"\n\n @property\n def account_id(self):\n return self.account.id\n\n def _send_email(self):\n email = EmailMessage(\n recipient=self.account.email_address,\n sender=\"Mycroft AI\",\n subject=\"Password Changed\",\n template_file_name=\"password_change.html\",\n )\n mailer = SeleneMailer(email)\n mailer.send(using_jinja=True)\n" }, { "path": "api/account/account_api/endpoints/city.py", "content": "# Mycroft Server - Backend\n# Copyright (C) 2019 Mycroft AI Inc\n# SPDX-License-Identifier: \tAGPL-3.0-or-later\n#\n# This file is part of the Mycroft Server.\n#\n# The Mycroft Server is free software: you can redistribute it and/or\n# modify it under the terms of the GNU Affero General Public License as\n# published by the Free Software Foundation, either version 3 of the\n# License, or (at your option) any later version.\n#\n# This program is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU Affero General Public License for more details.\n#\n# You should have received a copy of the GNU Affero General Public License\n# along with this program. If not, see .\n\"\"\"Account API endpoint for retrieving city geographical information.\"\"\"\nfrom http import HTTPStatus\n\nfrom selene.api import SeleneEndpoint\nfrom selene.data.geography import CityRepository\n\n\nclass CityEndpoint(SeleneEndpoint):\n \"\"\"Retrieve a city in a region\"\"\"\n\n def get(self):\n \"\"\"Process an HTTP GET request.\"\"\"\n region_id = self.request.args[\"region\"]\n city_repository = CityRepository(self.db)\n cities = city_repository.get_cities_by_region(region_id=region_id)\n\n for city in cities:\n city.longitude = float(city.longitude)\n city.latitude = float(city.latitude)\n\n return cities, HTTPStatus.OK\n" }, { "path": "api/account/account_api/endpoints/country.py", "content": "# Mycroft Server - Backend\n# Copyright (C) 2019 Mycroft AI Inc\n# SPDX-License-Identifier: \tAGPL-3.0-or-later\n#\n# This file is part of the Mycroft Server.\n#\n# The Mycroft Server is free software: you can redistribute it and/or\n# modify it under the terms of the GNU Affero General Public License as\n# published by the Free Software Foundation, either version 3 of the\n# License, or (at your option) any later version.\n#\n# This program is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU Affero General Public License for more details.\n#\n# You should have received a copy of the GNU Affero General Public License\n# along with this program. If not, see .\n\nfrom http import HTTPStatus\n\nfrom selene.api import SeleneEndpoint\nfrom selene.data.geography import CountryRepository\n\n\nclass CountryEndpoint(SeleneEndpoint):\n def get(self):\n country_repository = CountryRepository(self.db)\n countries = country_repository.get_countries()\n\n return countries, HTTPStatus.OK\n" }, { "path": "api/account/account_api/endpoints/defaults.py", "content": "# Mycroft Server - Backend\n# Copyright (C) 2019 Mycroft AI Inc\n# SPDX-License-Identifier: \tAGPL-3.0-or-later\n#\n# This file is part of the Mycroft Server.\n#\n# The Mycroft Server is free software: you can redistribute it and/or\n# modify it under the terms of the GNU Affero General Public License as\n# published by the Free Software Foundation, either version 3 of the\n# License, or (at your option) any later version.\n#\n# This program is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU Affero General Public License for more details.\n#\n# You should have received a copy of the GNU Affero General Public License\n# along with this program. If not, see .\n\"\"\"Account API endpoint for account defaults.\"\"\"\nfrom http import HTTPStatus\nfrom flask import json\nfrom schematics import Model\nfrom schematics.types import StringType\n\nfrom selene.api import SeleneEndpoint\nfrom selene.data.device import DefaultsRepository\nfrom selene.util.log import get_selene_logger\n\n_log = get_selene_logger(__name__)\n\n\nclass DefaultsRequest(Model):\n \"\"\"Data model of the POST request.\"\"\"\n\n city = StringType()\n country = StringType()\n region = StringType()\n timezone = StringType()\n voice = StringType()\n wake_word = StringType()\n\n\nclass AccountDefaultsEndpoint(SeleneEndpoint):\n \"\"\"Handle account default HTTP requests.\"\"\"\n\n def __init__(self):\n super().__init__()\n self.defaults = None\n\n def get(self):\n \"\"\"Process a HTTP GET request.\"\"\"\n self._authenticate()\n self._get_defaults()\n if self.defaults is None:\n response_data = \"\"\n response_code = HTTPStatus.NO_CONTENT\n else:\n response_data = self.defaults\n response_code = HTTPStatus.OK\n\n return response_data, response_code\n\n def _get_defaults(self):\n \"\"\"Get the account defaults from the database.\"\"\"\n default_repository = DefaultsRepository(self.db, self.account.id)\n self.defaults = default_repository.get_account_defaults()\n if self.defaults is not None and self.defaults.wake_word.name is not None:\n self.defaults.wake_word.name = self.defaults.wake_word.name.title()\n\n def post(self):\n \"\"\"Process a HTTP POST request.\"\"\"\n self._authenticate()\n defaults = self._validate_request()\n self._upsert_defaults(defaults)\n\n return \"\", HTTPStatus.NO_CONTENT\n\n def patch(self):\n \"\"\"Process an HTTP PATCH request.\"\"\"\n self._authenticate()\n defaults = self._validate_request()\n self._upsert_defaults(defaults)\n\n return \"\", HTTPStatus.NO_CONTENT\n\n def _validate_request(self) -> dict:\n \"\"\"Validate the data on the POST/PATCH request\"\"\"\n request_data = json.loads(self.request.data)\n defaults = DefaultsRequest()\n defaults.city = request_data.get(\"city\")\n defaults.country = request_data.get(\"country\")\n defaults.region = request_data.get(\"region\")\n defaults.timezone = request_data.get(\"timezone\")\n defaults.voice = request_data[\"voice\"]\n defaults.wake_word = request_data[\"wakeWord\"]\n defaults.validate()\n\n return defaults.to_native()\n\n def _upsert_defaults(self, defaults: dict):\n \"\"\"Apply the changes in the request to the database.\"\"\"\n defaults_repository = DefaultsRepository(self.db, self.account.id)\n wake_word_default = defaults.get(\"wake_word\")\n if wake_word_default is not None:\n defaults[\"wake_word\"] = defaults[\"wake_word\"].lower()\n defaults_repository.upsert(defaults)\n" }, { "path": "api/account/account_api/endpoints/device.py", "content": "# Mycroft Server - Backend\n# Copyright (C) 2019 Mycroft AI Inc\n# SPDX-License-Identifier: \tAGPL-3.0-or-later\n#\n# This file is part of the Mycroft Server.\n#\n# The Mycroft Server is free software: you can redistribute it and/or\n# modify it under the terms of the GNU Affero General Public License as\n# published by the Free Software Foundation, either version 3 of the\n# License, or (at your option) any later version.\n#\n# This program is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU Affero General Public License for more details.\n#\n# You should have received a copy of the GNU Affero General Public License\n# along with this program. If not, see .\n\"\"\"Account API endpoint for retrieving and maintaining device information.\"\"\"\nfrom dataclasses import asdict\nfrom datetime import datetime, timedelta\nfrom http import HTTPStatus\nfrom typing import List, Optional\n\nfrom flask import json\nfrom schematics import Model\nfrom schematics.exceptions import ValidationError\nfrom schematics.types import BooleanType, StringType\n\nfrom selene.api import SeleneEndpoint\nfrom selene.api.etag import ETagManager\nfrom selene.api.pantacor import get_pantacor_pending_deployment, update_pantacor_config\nfrom selene.api.public_endpoint import delete_device_login\nfrom selene.data.device import Device, DeviceRepository, Geography, GeographyRepository\nfrom selene.util.cache import (\n DEVICE_LAST_CONTACT_KEY,\n DEVICE_PAIRING_CODE_KEY,\n DEVICE_PAIRING_TOKEN_KEY,\n SeleneCache,\n)\nfrom selene.util.db import use_transaction\nfrom selene.util.log import get_selene_logger\n\nONE_DAY = 86400\nCONNECTED = \"Connected\"\nDISCONNECTED = \"Disconnected\"\nDORMANT = \"Dormant\"\n\n_log = get_selene_logger(__name__)\n\n\ndef validate_pairing_code(pairing_code):\n \"\"\"Ensure the pairing code exists in the cache of valid pairing codes.\"\"\"\n cache_key = DEVICE_PAIRING_CODE_KEY.format(pairing_code=pairing_code)\n cache = SeleneCache()\n pairing_cache = cache.get(cache_key)\n\n if pairing_cache is None:\n raise ValidationError(\"pairing code not found\")\n\n\nclass UpdateDeviceRequest(Model):\n \"\"\"Schematic for a request to update a device.\"\"\"\n\n city = StringType(required=True)\n country = StringType(required=True)\n name = StringType(required=True)\n placement = StringType()\n region = StringType(required=True)\n timezone = StringType(required=True)\n wake_word = StringType(required=True, deserialize_from=\"wakeWord\")\n voice = StringType(required=True)\n auto_update = BooleanType(deserialize_from=\"autoUpdate\")\n ssh_public_key = StringType(deserialize_from=\"sshPublicKey\")\n release_channel = StringType(deserialize_from=\"releaseChannel\")\n\n\nclass NewDeviceRequest(UpdateDeviceRequest):\n \"\"\"Schematic for a request to add a device.\"\"\"\n\n pairing_code = StringType(\n required=True,\n deserialize_from=\"pairingCode\",\n validators=[validate_pairing_code],\n )\n\n\nclass DeviceEndpoint(SeleneEndpoint):\n \"\"\"Retrieve and maintain device information for the Account API\"\"\"\n\n _device_repository = None\n\n def __init__(self):\n super().__init__()\n self.devices = None\n self.validated_request = None\n self.cache = self.config[\"SELENE_CACHE\"]\n self.etag_manager: ETagManager = ETagManager(self.cache, self.config)\n self.pantacor_channels = dict(\n myc200_dev_test=\"Development\",\n myc200_beta_qa_test=\"Beta QA\",\n myc200_beta=\"Beta\",\n myc200_stable=\"Stable\",\n myc200_lts=\"LTS\",\n )\n\n @property\n def device_repository(self):\n \"\"\"Lazily instantiate the device repository.\"\"\"\n if self._device_repository is None:\n self._device_repository = DeviceRepository(self.db)\n\n return self._device_repository\n\n def get(self, device_id: str):\n \"\"\"Process an HTTP GET request.\"\"\"\n self._authenticate()\n if device_id is None:\n response_data = self._get_devices()\n else:\n response_data = self._get_device(device_id)\n\n return response_data, HTTPStatus.OK\n\n def _get_devices(self) -> List[dict]:\n \"\"\"Get a list of the devices belonging to the account in the request JWT\n\n :return: list of devices to be returned to the UI.\n \"\"\"\n devices = self.device_repository.get_devices_by_account_id(self.account.id)\n response_data = []\n for device in devices:\n response_device = self._format_device_for_response(device)\n response_data.append(response_device)\n\n return response_data\n\n def _get_device(self, device_id: str) -> dict:\n \"\"\"Get the device information for a specific device.\n\n :param device_id: Identifier of the device to retrieve\n :return: device information to return to the UI\n \"\"\"\n device = self.device_repository.get_device_by_id(device_id)\n response_data = self._format_device_for_response(device)\n\n return response_data\n\n def _format_device_for_response(self, device: Device) -> dict:\n \"\"\"Convert device object into a response object for this endpoint.\n\n :param device: the device data retrieved from the database.\n :return: device information formatted for the UI\n \"\"\"\n pantacor_config = self._format_pantacor_config(device.pantacor_config)\n device_status, disconnect_duration = self._format_device_status(device)\n formatted_device = asdict(device)\n formatted_device[\"pantacor_config\"].update(pantacor_config)\n formatted_device[\"wake_word\"].update(name=device.wake_word.name.title())\n formatted_device.update(\n status=device_status,\n disconnect_duration=disconnect_duration,\n voice=formatted_device.pop(\"text_to_speech\"),\n )\n\n return formatted_device\n\n def _format_pantacor_config(self, config) -> dict[str, str]:\n \"\"\"Converts Pantacor config values in the database into displayable values.\n\n :param config: Pantacor config database values\n :returns: Pantacor config displayable values\n \"\"\"\n formatted_config = dict(deployment_id=None)\n manual_update = config.auto_update is not None and not config.auto_update\n if manual_update:\n formatted_config.update(\n deployment_id=get_pantacor_pending_deployment(config.pantacor_id)\n )\n if config.release_channel is not None:\n formatted_config.update(\n release_channel=self.pantacor_channels.get(config.release_channel)\n )\n\n return formatted_config\n\n def _format_device_status(self, device: Device) -> tuple[str, Optional[str]]:\n \"\"\"Determines the status of the device being returned.\n\n :param device: The device to determine the status of\n :return: status of the device and the duration of disconnect (if applicable)\n \"\"\"\n last_contact_age = self._get_device_last_contact(device)\n device_status = self._determine_device_status(last_contact_age)\n if device_status == DISCONNECTED:\n disconnect_duration = self._determine_disconnect_duration(last_contact_age)\n else:\n disconnect_duration = None\n\n return device_status, disconnect_duration\n\n def _get_device_last_contact(self, device: Device) -> timedelta:\n \"\"\"Get the last time the device contacted the backend.\n\n The timestamp returned by this method will be used to determine if a\n device is active or not.\n\n The device table has a last contacted column but it is only updated\n daily via batch script. The real-time values are kept in Redis.\n If the Redis query returns nothing, the device hasn't contacted the\n backend yet. This could be because it was just activated. Give the\n device a couple of minutes to make that first call to the backend.\n\n :param device: the device data retrieved from the database.\n :return: the timestamp the device was last seen by Selene\n \"\"\"\n last_contact_ts = self.cache.get(\n DEVICE_LAST_CONTACT_KEY.format(device_id=device.id)\n )\n if last_contact_ts is None:\n if device.last_contact_ts is None:\n last_contact_age = datetime.utcnow() - device.add_ts\n else:\n last_contact_age = datetime.utcnow() - device.last_contact_ts\n else:\n last_contact_ts = last_contact_ts.decode()\n last_contact_ts = datetime.strptime(last_contact_ts, \"%Y-%m-%d %H:%M:%S.%f\")\n last_contact_age = datetime.utcnow() - last_contact_ts\n\n return last_contact_age\n\n @staticmethod\n def _determine_device_status(last_contact_age: timedelta) -> str:\n \"\"\"Derive device status from the last time device contacted servers.\n\n :param last_contact_age: amount of time since the device was last seen\n :return: the status of the device\n \"\"\"\n if last_contact_age <= timedelta(seconds=120):\n device_status = CONNECTED\n elif timedelta(seconds=120) < last_contact_age < timedelta(days=30):\n device_status = DISCONNECTED\n else:\n device_status = DORMANT\n\n return device_status\n\n @staticmethod\n def _determine_disconnect_duration(last_contact_age: timedelta) -> str:\n \"\"\"Derive device status from the last time device contacted servers.\n\n :param last_contact_age: amount of time since the device was last seen\n :return human readable amount of time since the device was last seen\n \"\"\"\n disconnect_duration = \"unknown\"\n days, _ = divmod(last_contact_age, timedelta(days=1))\n if days:\n disconnect_duration = str(days) + \" days\"\n else:\n hours, remaining = divmod(last_contact_age, timedelta(hours=1))\n if hours:\n disconnect_duration = str(hours) + \" hours\"\n else:\n minutes, _ = divmod(remaining, timedelta(minutes=1))\n if minutes:\n disconnect_duration = str(minutes) + \" minutes\"\n\n return disconnect_duration\n\n def post(self):\n \"\"\"Handle a HTTP POST request.\"\"\"\n self._authenticate()\n self._validate_request()\n self._pair_device()\n\n return \"\", HTTPStatus.NO_CONTENT\n\n @use_transaction\n def _pair_device(self):\n \"\"\"Add the paired device to the database.\"\"\"\n cache_key = DEVICE_PAIRING_CODE_KEY.format(\n pairing_code=self.validated_request[\"pairing_code\"]\n )\n pairing_data = self._get_pairing_data(cache_key)\n device_id = self._add_device()\n pairing_data[\"uuid\"] = device_id\n self.cache.delete(cache_key)\n self._build_pairing_token(pairing_data)\n\n def _get_pairing_data(self, cache_key) -> dict:\n \"\"\"Checking if there's one pairing session for the pairing code.\n\n :return: the pairing code information from the Redis database\n \"\"\"\n pairing_cache = self.cache.get(cache_key)\n pairing_data = json.loads(pairing_cache)\n\n return pairing_data\n\n def _add_device(self) -> str:\n \"\"\"Creates a device and associate it to a pairing session.\n\n :return: the database identifier of the new device\n \"\"\"\n self._ensure_geography_exists()\n device_id = self.device_repository.add(self.account.id, self.validated_request)\n\n return device_id\n\n def _build_pairing_token(self, pairing_data: dict):\n \"\"\"Add a pairing token to the Redis database.\n\n :param pairing_data: the pairing data retrieved from Redis\n \"\"\"\n self.cache.set_with_expiration(\n key=DEVICE_PAIRING_TOKEN_KEY.format(pairing_token=pairing_data[\"token\"]),\n value=json.dumps(pairing_data),\n expiration=ONE_DAY,\n )\n\n def delete(self, device_id: str):\n \"\"\"Handle an HTTP DELETE request.\n\n :param device_id: database identifier of a device\n \"\"\"\n self._authenticate()\n self._delete_device(device_id)\n\n return \"\", HTTPStatus.NO_CONTENT\n\n def _delete_device(self, device_id: str):\n \"\"\"Delete the specified device from the database.\n\n There are other tables related to the device table in the database. This\n method assumes that the child tables contain \"delete cascade\" clauses.\n\n :param device_id: database identifier of a device\n \"\"\"\n self.device_repository.remove(device_id)\n delete_device_login(device_id, self.cache)\n\n def patch(self, device_id: str):\n \"\"\"Handle a HTTP PATCH request.\n\n :param device_id: database identifier of a device\n \"\"\"\n self._authenticate()\n self._validate_request()\n self._update_device(device_id)\n self.etag_manager.expire_device_etag_by_device_id(device_id)\n self.etag_manager.expire_device_location_etag_by_device_id(device_id)\n self.etag_manager.expire_device_setting_etag_by_device_id(device_id)\n\n return \"\", HTTPStatus.NO_CONTENT\n\n def _validate_request(self):\n \"\"\"Validate the contents of the HTTP POST request.\"\"\"\n if self.request.method == \"POST\":\n device = NewDeviceRequest(self.request.json)\n else:\n device = UpdateDeviceRequest(self.request.json)\n device.validate()\n self.validated_request = device.to_native()\n self.validated_request.update(\n wake_word=self.validated_request[\"wake_word\"].lower()\n )\n if self.validated_request[\"release_channel\"] is not None:\n self.validated_request.update(\n release_channel=self.validated_request[\"release_channel\"].lower()\n )\n\n def _ensure_geography_exists(self):\n \"\"\"If the requested geography is not linked to the account, add it.\n\n :return: database identifier for the geography\n \"\"\"\n geography = Geography(\n city=self.validated_request.pop(\"city\"),\n country=self.validated_request.pop(\"country\"),\n region=self.validated_request.pop(\"region\"),\n time_zone=self.validated_request.pop(\"timezone\"),\n )\n geography_repository = GeographyRepository(self.db, self.account.id)\n geography_id = geography_repository.get_geography_id(geography)\n if geography_id is None:\n geography_id = geography_repository.add(geography)\n\n self.validated_request.update(geography_id=geography_id)\n\n @use_transaction\n def _update_device(self, device_id: str):\n \"\"\"Update the device attributes on the database based on the request.\n\n If the device's continuous delivery is managed by Pantacor, attempt the\n Pantacor API calls first. That way, if they fail, the database updates won't\n happen and we won't get stuck in a half-updated state.\n\n :param device_id: database identifier of a device\n \"\"\"\n device = self.device_repository.get_device_by_id(device_id)\n if device.pantacor_config.pantacor_id is not None:\n self._update_pantacor_config(device)\n self._ensure_geography_exists()\n self.device_repository.update_device_from_account(\n self.account.id, device_id, self.validated_request\n )\n\n def _update_pantacor_config(self, device: Device):\n \"\"\"Update the Pantacor configuration on the database based on the request.\n\n :param device: data object representing a Mycroft-enabled device\n \"\"\"\n new_pantacor_config = dict(\n auto_update=self.validated_request.pop(\"auto_update\"),\n release_channel=self.validated_request.pop(\"release_channel\"),\n ssh_public_key=self.validated_request.pop(\"ssh_public_key\"),\n )\n pantacor_channel_name = self._convert_release_channel(\n new_pantacor_config[\"release_channel\"]\n )\n new_pantacor_config.update(release_channel=pantacor_channel_name)\n old_pantacor_config = asdict(device.pantacor_config)\n update_pantacor_config(old_pantacor_config, new_pantacor_config)\n self.device_repository.update_pantacor_config(device.id, new_pantacor_config)\n\n def _convert_release_channel(self, release_channel: str) -> str:\n \"\"\"Converts the channel sent in the request to one recognized by Pantacor.\n\n :param release_channel: the value of the release channel in the request\n :returns: the release channel as recognized by Pantacor\n \"\"\"\n pantacor_channel_name = None\n for channel_name, channel_display in self.pantacor_channels.items():\n if channel_display.lower() == release_channel:\n pantacor_channel_name = channel_name\n\n _log.info(\"pantacor channel name: %s\", pantacor_channel_name)\n return pantacor_channel_name\n" }, { "path": "api/account/account_api/endpoints/device_count.py", "content": "# Mycroft Server - Backend\n# Copyright (C) 2019 Mycroft AI Inc\n# SPDX-License-Identifier: \tAGPL-3.0-or-later\n#\n# This file is part of the Mycroft Server.\n#\n# The Mycroft Server is free software: you can redistribute it and/or\n# modify it under the terms of the GNU Affero General Public License as\n# published by the Free Software Foundation, either version 3 of the\n# License, or (at your option) any later version.\n#\n# This program is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU Affero General Public License for more details.\n#\n# You should have received a copy of the GNU Affero General Public License\n# along with this program. If not, see .\n\nfrom http import HTTPStatus\nfrom selene.api import SeleneEndpoint\nfrom selene.data.device import DeviceRepository\n\n\nclass DeviceCountEndpoint(SeleneEndpoint):\n def get(self):\n self._authenticate()\n device_count = self._get_devices()\n\n return dict(deviceCount=device_count), HTTPStatus.OK\n\n def _get_devices(self):\n device_repository = DeviceRepository(self.db)\n device_count = device_repository.get_account_device_count(self.account.id)\n\n return device_count\n" }, { "path": "api/account/account_api/endpoints/geography.py", "content": "# Mycroft Server - Backend\n# Copyright (C) 2019 Mycroft AI Inc\n# SPDX-License-Identifier: \tAGPL-3.0-or-later\n#\n# This file is part of the Mycroft Server.\n#\n# The Mycroft Server is free software: you can redistribute it and/or\n# modify it under the terms of the GNU Affero General Public License as\n# published by the Free Software Foundation, either version 3 of the\n# License, or (at your option) any later version.\n#\n# This program is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU Affero General Public License for more details.\n#\n# You should have received a copy of the GNU Affero General Public License\n# along with this program. If not, see .\n\nfrom http import HTTPStatus\n\nfrom selene.api import SeleneEndpoint\nfrom selene.data.device import GeographyRepository\n\n\nclass GeographyEndpoint(SeleneEndpoint):\n def get(self):\n self._authenticate()\n response_data = self._build_response_data()\n\n return response_data, HTTPStatus.OK\n\n def _build_response_data(self):\n geography_repository = GeographyRepository(self.db, self.account.id)\n geographies = geography_repository.get_account_geographies()\n\n response_data = []\n for geography in geographies:\n response_data.append(\n dict(id=geography.id, name=geography.country, user_defined=True)\n )\n\n return response_data\n" }, { "path": "api/account/account_api/endpoints/membership.py", "content": "# Mycroft Server - Backend\n# Copyright (C) 2019 Mycroft AI Inc\n# SPDX-License-Identifier: \tAGPL-3.0-or-later\n#\n# This file is part of the Mycroft Server.\n#\n# The Mycroft Server is free software: you can redistribute it and/or\n# modify it under the terms of the GNU Affero General Public License as\n# published by the Free Software Foundation, either version 3 of the\n# License, or (at your option) any later version.\n#\n# This program is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU Affero General Public License for more details.\n#\n# You should have received a copy of the GNU Affero General Public License\n# along with this program. If not, see .\n\nfrom http import HTTPStatus\n\nfrom selene.api import SeleneEndpoint\nfrom selene.data.account import MembershipRepository\n\n\nclass MembershipEndpoint(SeleneEndpoint):\n def get(self):\n membership_repository = MembershipRepository(self.db)\n membership_types = membership_repository.get_membership_types()\n for membership_type in membership_types:\n membership_type.rate = float(membership_type.rate)\n\n return membership_types, HTTPStatus.OK\n" }, { "path": "api/account/account_api/endpoints/pairing_code.py", "content": "# Mycroft Server - Backend\n# Copyright (C) 2019 Mycroft AI Inc\n# SPDX-License-Identifier: \tAGPL-3.0-or-later\n#\n# This file is part of the Mycroft Server.\n#\n# The Mycroft Server is free software: you can redistribute it and/or\n# modify it under the terms of the GNU Affero General Public License as\n# published by the Free Software Foundation, either version 3 of the\n# License, or (at your option) any later version.\n#\n# This program is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU Affero General Public License for more details.\n#\n# You should have received a copy of the GNU Affero General Public License\n# along with this program. If not, see .\n\nfrom http import HTTPStatus\n\nfrom selene.api import SeleneEndpoint\n\n\nclass PairingCodeEndpoint(SeleneEndpoint):\n def __init__(self):\n super(PairingCodeEndpoint, self).__init__()\n self.cache = self.config[\"SELENE_CACHE\"]\n\n def get(self, pairing_code):\n self._authenticate()\n pairing_code_is_valid = self._get_pairing_data(pairing_code)\n\n return dict(isValid=pairing_code_is_valid), HTTPStatus.OK\n\n def _get_pairing_data(self, pairing_code: str) -> bool:\n \"\"\"Checking if there's one pairing session for the pairing code.\"\"\"\n pairing_code_is_valid = False\n cache_key = \"pairing.code:\" + pairing_code\n pairing_cache = self.cache.get(cache_key)\n if pairing_cache is not None:\n pairing_code_is_valid = True\n\n return pairing_code_is_valid\n" }, { "path": "api/account/account_api/endpoints/preferences.py", "content": "# Mycroft Server - Backend\n# Copyright (C) 2019 Mycroft AI Inc\n# SPDX-License-Identifier: \tAGPL-3.0-or-later\n#\n# This file is part of the Mycroft Server.\n#\n# The Mycroft Server is free software: you can redistribute it and/or\n# modify it under the terms of the GNU Affero General Public License as\n# published by the Free Software Foundation, either version 3 of the\n# License, or (at your option) any later version.\n#\n# This program is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU Affero General Public License for more details.\n#\n# You should have received a copy of the GNU Affero General Public License\n# along with this program. If not, see .\n\nfrom dataclasses import asdict\nfrom http import HTTPStatus\n\nfrom schematics import Model\nfrom schematics.types import StringType\n\nfrom selene.api import SeleneEndpoint\nfrom selene.api.etag import ETagManager\nfrom selene.data.device import AccountPreferences, PreferenceRepository\n\n\nclass PreferencesRequest(Model):\n date_format = StringType(required=True, choices=[\"DD/MM/YYYY\", \"MM/DD/YYYY\"])\n measurement_system = StringType(required=True, choices=[\"Imperial\", \"Metric\"])\n time_format = StringType(required=True, choices=[\"12 Hour\", \"24 Hour\"])\n\n\nclass PreferencesEndpoint(SeleneEndpoint):\n def __init__(self):\n super(PreferencesEndpoint, self).__init__()\n self.preferences = None\n self.cache = self.config[\"SELENE_CACHE\"]\n self.etag_manager: ETagManager = ETagManager(self.cache, self.config)\n\n def get(self):\n self._authenticate()\n self._get_preferences()\n if self.preferences is None:\n response_data = \"\"\n response_code = HTTPStatus.NO_CONTENT\n else:\n response_data = asdict(self.preferences)\n response_code = HTTPStatus.OK\n\n return response_data, response_code\n\n def _get_preferences(self):\n preference_repository = PreferenceRepository(self.db, self.account.id)\n self.preferences = preference_repository.get_account_preferences()\n\n def post(self):\n self._authenticate()\n self._validate_request()\n self._upsert_preferences()\n self.etag_manager.expire_device_setting_etag_by_account_id(self.account.id)\n return \"\", HTTPStatus.NO_CONTENT\n\n def patch(self):\n self._authenticate()\n self._validate_request()\n self._upsert_preferences()\n self.etag_manager.expire_device_setting_etag_by_account_id(self.account.id)\n return \"\", HTTPStatus.NO_CONTENT\n\n def _validate_request(self):\n self.preferences = PreferencesRequest()\n self.preferences.date_format = self.request.json[\"dateFormat\"]\n self.preferences.measurement_system = self.request.json[\"measurementSystem\"]\n self.preferences.time_format = self.request.json[\"timeFormat\"]\n self.preferences.validate()\n\n def _upsert_preferences(self):\n preferences_repository = PreferenceRepository(self.db, self.account.id)\n preferences = AccountPreferences(**self.preferences.to_native())\n preferences_repository.upsert(preferences)\n" }, { "path": "api/account/account_api/endpoints/region.py", "content": "# Mycroft Server - Backend\n# Copyright (C) 2019 Mycroft AI Inc\n# SPDX-License-Identifier: \tAGPL-3.0-or-later\n#\n# This file is part of the Mycroft Server.\n#\n# The Mycroft Server is free software: you can redistribute it and/or\n# modify it under the terms of the GNU Affero General Public License as\n# published by the Free Software Foundation, either version 3 of the\n# License, or (at your option) any later version.\n#\n# This program is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU Affero General Public License for more details.\n#\n# You should have received a copy of the GNU Affero General Public License\n# along with this program. If not, see .\n\nfrom http import HTTPStatus\n\nfrom selene.api import SeleneEndpoint\nfrom selene.data.geography import RegionRepository\n\n\nclass RegionEndpoint(SeleneEndpoint):\n def get(self):\n country_id = self.request.args[\"country\"]\n region_repository = RegionRepository(self.db)\n regions = region_repository.get_regions_by_country(country_id)\n\n return regions, HTTPStatus.OK\n" }, { "path": "api/account/account_api/endpoints/skill_oauth.py", "content": "# Mycroft Server - Backend\n# Copyright (C) 2019 Mycroft AI Inc\n# SPDX-License-Identifier: \tAGPL-3.0-or-later\n#\n# This file is part of the Mycroft Server.\n#\n# The Mycroft Server is free software: you can redistribute it and/or\n# modify it under the terms of the GNU Affero General Public License as\n# published by the Free Software Foundation, either version 3 of the\n# License, or (at your option) any later version.\n#\n# This program is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU Affero General Public License for more details.\n#\n# You should have received a copy of the GNU Affero General Public License\n# along with this program. If not, see .\n\nimport os\n\nimport requests\n\nfrom selene.api import SeleneEndpoint\n\n\nclass SkillOauthEndpoint(SeleneEndpoint):\n def __init__(self):\n super(SkillOauthEndpoint, self).__init__()\n self.oauth_base_url = os.environ[\"OAUTH_BASE_URL\"]\n\n def get(self, oauth_id):\n self._authenticate()\n return self._get_oauth_url(oauth_id)\n\n def _get_oauth_url(self, oauth_id):\n url = \"{base_url}/auth/{oauth_id}/auth_url?uuid={account_id}\".format(\n base_url=self.oauth_base_url, oauth_id=oauth_id, account_id=self.account.id\n )\n response = requests.get(url)\n return response.text, response.status_code\n" }, { "path": "api/account/account_api/endpoints/skill_settings.py", "content": "# Mycroft Server - Backend\n# Copyright (C) 2019 Mycroft AI Inc\n# SPDX-License-Identifier: \tAGPL-3.0-or-later\n#\n# This file is part of the Mycroft Server.\n#\n# The Mycroft Server is free software: you can redistribute it and/or\n# modify it under the terms of the GNU Affero General Public License as\n# published by the Free Software Foundation, either version 3 of the\n# License, or (at your option) any later version.\n#\n# This program is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU Affero General Public License for more details.\n#\n# You should have received a copy of the GNU Affero General Public License\n# along with this program. If not, see .\n\n\"\"\"Endpoint to return the skill settings for a given skill family.\"\"\"\nfrom http import HTTPStatus\n\nfrom flask import json, Response\n\nfrom selene.api import SeleneEndpoint\nfrom selene.api.etag import ETagManager\nfrom selene.data.skill import SkillSettingRepository, AccountSkillSetting\n\n\nclass SkillSettingsEndpoint(SeleneEndpoint):\n _setting_repository = None\n\n def __init__(self):\n super(SkillSettingsEndpoint, self).__init__()\n self.account_skills = None\n self.family_settings = None\n self.etag_manager: ETagManager = ETagManager(\n self.config[\"SELENE_CACHE\"], self.config\n )\n\n @property\n def setting_repository(self):\n \"\"\"Only instantiate the SkillSettingsRepository if needed.\"\"\"\n if self._setting_repository is None:\n self._setting_repository = SkillSettingRepository(self.db)\n\n return self._setting_repository\n\n def get(self, skill_family_name):\n \"\"\"Process an HTTP GET request\"\"\"\n self._authenticate()\n self.family_settings = self.setting_repository.get_family_settings(\n self.account.id, skill_family_name\n )\n self._parse_selection_options()\n response_data = self._build_response_data()\n\n # The response object is manually built here to bypass the\n # camel case conversion so settings are displayed correctly\n return Response(\n response=json.dumps(response_data),\n status=HTTPStatus.OK,\n content_type=\"application/json\",\n )\n\n def _parse_selection_options(self):\n \"\"\"Parse the dropdown options string into a list of options.\n\n Drop-down options are defined in a skill's settingsmeta.json as such:\n