├── MANIFEST.in ├── .gitignore ├── setup.cfg ├── README.md ├── CHANGES.txt ├── renovate.json ├── setup.py ├── .github └── workflows │ ├── publish.yml │ └── tests.yml ├── ubuntudesign └── __init__.py └── LICENSE.txt /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include *.txt 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .bzr/ 2 | *.pyc 3 | dist/ 4 | *.egg-info/ 5 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [metadata] 2 | description-file = README.rst 3 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # UbuntuDesign asset mapper 2 | 3 | A mapping class for manipulating assets in the ubuntu assets server. 4 | -------------------------------------------------------------------------------- /CHANGES.txt: -------------------------------------------------------------------------------- 1 | v0.1, 2014-12-19 -- Initial release. 2 | v0.8, 2014-08-03 -- More flexible parameters for "all" searching. 3 | v0.9, 2014-08-03 -- Fix error with joining parameters. 4 | v0.10, 2014-08-03 -- Fix string joining properly this time. 5 | -------------------------------------------------------------------------------- /renovate.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": [ 3 | "config:base", 4 | "schedule:monthly", 5 | "group:all" 6 | ], 7 | "packageRules": [ 8 | { 9 | "depTypeList": ["devDependencies"], 10 | "extends": [":automergeMinor"] 11 | } 12 | ] 13 | } 14 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from setuptools import setup 2 | 3 | setup( 4 | name="ubuntudesign-asset-mapper", 5 | version="0.10", 6 | author="Robin", 7 | author_email="robin.winslow@canonical.com", 8 | url="https://github.com/ubuntudesign/asset-mapper", 9 | packages=["ubuntudesign"], 10 | description=("A mapping class for using the Ubuntu asset server."), 11 | long_description=open("README.md").read(), 12 | long_description_content_type="text/markdown", 13 | install_requires=["requests >= 2.0"], 14 | ) 15 | -------------------------------------------------------------------------------- /.github/workflows/publish.yml: -------------------------------------------------------------------------------- 1 | name: Publish 2 | 3 | on: 4 | push: 5 | branches: 6 | - master 7 | 8 | jobs: 9 | publish: 10 | runs-on: ubuntu-latest 11 | 12 | steps: 13 | - uses: actions/checkout@v1 14 | 15 | - name: Install system dependencies 16 | run: | 17 | sudo apt update && sudo apt install -y --no-install-recommends python3-setuptools 18 | pip3 install --upgrade setuptools 19 | pip3 install wheel 20 | 21 | - name: Build package 22 | run: python3 setup.py sdist bdist_wheel 23 | 24 | - name: Publish to PyPI 25 | uses: pypa/gh-action-pypi-publish@e777b33388fefa46ce597d8afa9c15a5357af36f 26 | with: 27 | user: __token__ 28 | password: ${{ secrets.pypi_password }} 29 | -------------------------------------------------------------------------------- /.github/workflows/tests.yml: -------------------------------------------------------------------------------- 1 | name: Tests 2 | 3 | on: pull_request 4 | 5 | jobs: 6 | build: 7 | runs-on: ubuntu-latest 8 | 9 | steps: 10 | - uses: actions/checkout@v1 11 | 12 | - name: Install system dependencies 13 | run: | 14 | sudo apt update && sudo apt install -y --no-install-recommends python3-setuptools 15 | pip3 install --upgrade setuptools 16 | pip3 install wheel twine 17 | 18 | - name: Build package 19 | run: python3 setup.py sdist bdist_wheel 20 | 21 | - name: Twine check 22 | run: python3 -m twine check dist/* 23 | 24 | lint-python: 25 | runs-on: ubuntu-latest 26 | 27 | steps: 28 | - uses: actions/checkout@v1 29 | 30 | - name: Install system dependencies 31 | run: | 32 | pip3 install flake8 black 33 | 34 | - name: Lint Python 35 | run: python3 -m flake8 ubuntudesign setup.py && python3 -m black --line-length 79 --check ubuntudesign setup.py 36 | -------------------------------------------------------------------------------- /ubuntudesign/__init__.py: -------------------------------------------------------------------------------- 1 | # System 2 | import mimetypes 3 | from base64 import b64encode 4 | import urllib 5 | import urlparse 6 | 7 | # Modules 8 | import requests 9 | 10 | 11 | def add_query_params(url, params): 12 | """ 13 | Add query params to a URL 14 | """ 15 | 16 | url_parts = list(urlparse.urlparse(url)) 17 | query = dict(urlparse.parse_qsl(url_parts[4])) 18 | query.update(params) 19 | 20 | url_parts[4] = urllib.urlencode(query) 21 | 22 | return urlparse.urlunparse(url_parts) 23 | 24 | 25 | class AssetMapper: 26 | """ 27 | Map data from the Assets API into model objects 28 | """ 29 | 30 | auth_token = "" 31 | server_url = "" 32 | image_types = ["image/png", "image/jpeg", "image/svg+xml", "image/gif"] 33 | 34 | def __init__(self, server_url, auth_token): 35 | self.server_url = server_url 36 | self.auth_token = auth_token 37 | 38 | def get(self, file_path): 39 | asset_data_url = urlparse.urljoin( 40 | self.server_url, "{0}/info".format(file_path) 41 | ) 42 | 43 | api_response = self._request("get", asset_data_url) 44 | 45 | return self._format_asset(api_response.json()) 46 | 47 | def all(self, query_parameters={}): 48 | url = self.server_url 49 | 50 | # Search, if requested 51 | if query_parameters: 52 | query_strings = [] 53 | 54 | for param_name, param_value in query_parameters.iteritems(): 55 | query_strings.append("{}={}".format(param_name, param_value)) 56 | 57 | url += "?{}".format("&".join(query_strings)) 58 | 59 | api_response = self._request("get", url) 60 | 61 | return self._format_assets(api_response.json()) 62 | 63 | def create(self, asset_content, friendly_name, tags="", optimize=False): 64 | """ 65 | Create an asset on the server 66 | You must provide the asset with a friendly name 67 | for the server to generate a path from. 68 | """ 69 | 70 | return self._create_asset( 71 | { 72 | "asset": b64encode(asset_content), 73 | "friendly-name": friendly_name, 74 | "tags": tags, 75 | "optimize": optimize, 76 | "type": "base64", 77 | } 78 | ) 79 | 80 | def create_at_path(self, asset_content, url_path, tags=""): 81 | """ 82 | Create asset at a specific URL path on the server 83 | """ 84 | 85 | return self._create_asset( 86 | { 87 | "asset": b64encode(asset_content), 88 | "url-path": url_path, 89 | "tags": tags, 90 | "type": "base64", 91 | } 92 | ) 93 | 94 | def update(self, file_path, tags): 95 | asset_url = urlparse.urljoin(self.server_url, file_path) 96 | 97 | api_response = self._request("put", asset_url, data={"tags": tags}) 98 | 99 | return self._format_asset(api_response.json()) 100 | 101 | def _create_asset(self, asset_data): 102 | api_response = self._request( 103 | "post", self.server_url, data=asset_data, allowed_errors=[409] 104 | ) 105 | 106 | response = api_response.json() 107 | 108 | if api_response.status_code < 300: 109 | response = self._format_asset(response) 110 | 111 | return response 112 | 113 | def _format_assets(self, data): 114 | formatted_data = [] 115 | 116 | for datum in data: 117 | formatted_data.append(self._format_asset(datum)) 118 | 119 | return formatted_data 120 | 121 | def _format_asset(self, datum): 122 | mimetype = mimetypes.guess_type(datum["file_path"])[0] 123 | 124 | return { 125 | "file_path": datum["file_path"], 126 | "tags": datum["tags"], 127 | "url": urlparse.urljoin(self.server_url, datum["file_path"]), 128 | "image": mimetype in self.image_types, 129 | "created": datum["created"], 130 | } 131 | 132 | def _request( 133 | self, 134 | method, 135 | url, 136 | data=None, 137 | headers={}, 138 | allowed_errors=[], 139 | authorize_by_header=False, 140 | ): 141 | if self.auth_token: 142 | if authorize_by_header: 143 | headers["Authorization"] = "token {0}".format(self.auth_token) 144 | else: 145 | url = add_query_params(url, {"token": self.auth_token}) 146 | 147 | response = requests.request( 148 | method=method, url=url, data=data, headers=headers 149 | ) 150 | 151 | # Throw an error if we have a bad status 152 | if response.status_code not in allowed_errors: 153 | response.raise_for_status() 154 | 155 | return response 156 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | GNU LESSER GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | 9 | This version of the GNU Lesser General Public License incorporates 10 | the terms and conditions of version 3 of the GNU General Public 11 | License, supplemented by the additional permissions listed below. 12 | 13 | 0. Additional Definitions. 14 | 15 | As used herein, "this License" refers to version 3 of the GNU Lesser 16 | General Public License, and the "GNU GPL" refers to version 3 of the GNU 17 | General Public License. 18 | 19 | "The Library" refers to a covered work governed by this License, 20 | other than an Application or a Combined Work as defined below. 21 | 22 | An "Application" is any work that makes use of an interface provided 23 | by the Library, but which is not otherwise based on the Library. 24 | Defining a subclass of a class defined by the Library is deemed a mode 25 | of using an interface provided by the Library. 26 | 27 | A "Combined Work" is a work produced by combining or linking an 28 | Application with the Library. The particular version of the Library 29 | with which the Combined Work was made is also called the "Linked 30 | Version". 31 | 32 | The "Minimal Corresponding Source" for a Combined Work means the 33 | Corresponding Source for the Combined Work, excluding any source code 34 | for portions of the Combined Work that, considered in isolation, are 35 | based on the Application, and not on the Linked Version. 36 | 37 | The "Corresponding Application Code" for a Combined Work means the 38 | object code and/or source code for the Application, including any data 39 | and utility programs needed for reproducing the Combined Work from the 40 | Application, but excluding the System Libraries of the Combined Work. 41 | 42 | 1. Exception to Section 3 of the GNU GPL. 43 | 44 | You may convey a covered work under sections 3 and 4 of this License 45 | without being bound by section 3 of the GNU GPL. 46 | 47 | 2. Conveying Modified Versions. 48 | 49 | If you modify a copy of the Library, and, in your modifications, a 50 | facility refers to a function or data to be supplied by an Application 51 | that uses the facility (other than as an argument passed when the 52 | facility is invoked), then you may convey a copy of the modified 53 | version: 54 | 55 | a) under this License, provided that you make a good faith effort to 56 | ensure that, in the event an Application does not supply the 57 | function or data, the facility still operates, and performs 58 | whatever part of its purpose remains meaningful, or 59 | 60 | b) under the GNU GPL, with none of the additional permissions of 61 | this License applicable to that copy. 62 | 63 | 3. Object Code Incorporating Material from Library Header Files. 64 | 65 | The object code form of an Application may incorporate material from 66 | a header file that is part of the Library. You may convey such object 67 | code under terms of your choice, provided that, if the incorporated 68 | material is not limited to numerical parameters, data structure 69 | layouts and accessors, or small macros, inline functions and templates 70 | (ten or fewer lines in length), you do both of the following: 71 | 72 | a) Give prominent notice with each copy of the object code that the 73 | Library is used in it and that the Library and its use are 74 | covered by this License. 75 | 76 | b) Accompany the object code with a copy of the GNU GPL and this license 77 | document. 78 | 79 | 4. Combined Works. 80 | 81 | You may convey a Combined Work under terms of your choice that, 82 | taken together, effectively do not restrict modification of the 83 | portions of the Library contained in the Combined Work and reverse 84 | engineering for debugging such modifications, if you also do each of 85 | the following: 86 | 87 | a) Give prominent notice with each copy of the Combined Work that 88 | the Library is used in it and that the Library and its use are 89 | covered by this License. 90 | 91 | b) Accompany the Combined Work with a copy of the GNU GPL and this license 92 | document. 93 | 94 | c) For a Combined Work that displays copyright notices during 95 | execution, include the copyright notice for the Library among 96 | these notices, as well as a reference directing the user to the 97 | copies of the GNU GPL and this license document. 98 | 99 | d) Do one of the following: 100 | 101 | 0) Convey the Minimal Corresponding Source under the terms of this 102 | License, and the Corresponding Application Code in a form 103 | suitable for, and under terms that permit, the user to 104 | recombine or relink the Application with a modified version of 105 | the Linked Version to produce a modified Combined Work, in the 106 | manner specified by section 6 of the GNU GPL for conveying 107 | Corresponding Source. 108 | 109 | 1) Use a suitable shared library mechanism for linking with the 110 | Library. A suitable mechanism is one that (a) uses at run time 111 | a copy of the Library already present on the user's computer 112 | system, and (b) will operate properly with a modified version 113 | of the Library that is interface-compatible with the Linked 114 | Version. 115 | 116 | e) Provide Installation Information, but only if you would otherwise 117 | be required to provide such information under section 6 of the 118 | GNU GPL, and only to the extent that such information is 119 | necessary to install and execute a modified version of the 120 | Combined Work produced by recombining or relinking the 121 | Application with a modified version of the Linked Version. (If 122 | you use option 4d0, the Installation Information must accompany 123 | the Minimal Corresponding Source and Corresponding Application 124 | Code. If you use option 4d1, you must provide the Installation 125 | Information in the manner specified by section 6 of the GNU GPL 126 | for conveying Corresponding Source.) 127 | 128 | 5. Combined Libraries. 129 | 130 | You may place library facilities that are a work based on the 131 | Library side by side in a single library together with other library 132 | facilities that are not Applications and are not covered by this 133 | License, and convey such a combined library under terms of your 134 | choice, if you do both of the following: 135 | 136 | a) Accompany the combined library with a copy of the same work based 137 | on the Library, uncombined with any other library facilities, 138 | conveyed under the terms of this License. 139 | 140 | b) Give prominent notice with the combined library that part of it 141 | is a work based on the Library, and explaining where to find the 142 | accompanying uncombined form of the same work. 143 | 144 | 6. Revised Versions of the GNU Lesser General Public License. 145 | 146 | The Free Software Foundation may publish revised and/or new versions 147 | of the GNU Lesser General Public License from time to time. Such new 148 | versions will be similar in spirit to the present version, but may 149 | differ in detail to address new problems or concerns. 150 | 151 | Each version is given a distinguishing version number. If the 152 | Library as you received it specifies that a certain numbered version 153 | of the GNU Lesser General Public License "or any later version" 154 | applies to it, you have the option of following the terms and 155 | conditions either of that published version or of any later version 156 | published by the Free Software Foundation. If the Library as you 157 | received it does not specify a version number of the GNU Lesser 158 | General Public License, you may choose any version of the GNU Lesser 159 | General Public License ever published by the Free Software Foundation. 160 | 161 | If the Library as you received it specifies that a proxy can decide 162 | whether future versions of the GNU Lesser General Public License shall 163 | apply, that proxy's public statement of acceptance of any version is 164 | permanent authorization for you to choose that version for the 165 | Library. 166 | --------------------------------------------------------------------------------