Commit e9717f2b49713d5da5d4ab306b4bd3e35c321193 - mopidy-beets

first commit Janez Troha 11 years ago

10 changed file(s) with 473 addition(s) and 0 deletion(s). Raw diff Collapse all Expand all

+35

-0

.gitignore less more

	0	*.py[cod]
	1
	2	# C extensions
	3	*.so
	4
	5	# Packages
	6	*.egg
	7	*.egg-info
	8	dist
	9	build
	10	eggs
	11	parts
	12	bin
	13	var
	14	sdist
	15	develop-eggs
	16	.installed.cfg
	17	lib
	18	lib64
	19
	20	# Installer logs
	21	pip-log.txt
	22
	23	# Unit test / coverage reports
	24	.coverage
	25	.tox
	26	nosetests.xml
	27
	28	# Translations
	29	*.mo
	30
	31	# Mr Developer
	32	.mr.developer.cfg
	33	.project
	34	.pydevproject

-0

LICENSE less more

	0	Copyright (C) 2013 <dz0ny at shortmail dot com>
	1
	2	Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
	3
	4	The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
	5
	6	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.⏎

-0

MANIFEST.in less more

	0	include LICENSE
	1	include MANIFEST.in
	2	include README.rst
	3	include mopidy_beets/ext.conf

+38

-0

README.rst less more

	0	Mopidy-Beets
	1	=================
	2
	3	Mopidy http://www.mopidy.com/ extension for playing music from
	4	Beets http://www.beets.com
	5
	6	Usage
	7	-----
	8
	9	Install by running::
	10
	11	sudo pip install mopidy-beets
	12
	13
	14	Setup your beets host
	15
	16	[beets]
	17	host = "http://yourserver:port"
	18
	19
	20
	21	Project resources
	22	-----------------
	23
	24	- Source code https://github.com/dz0ny/mopidy-beets_
	25	- Issue tracker https://github.com/mopidy/mopidy-beets/issues
	26	- Download development snapshot https://github.com/dz0ny/mopidy-beets/tarball/develop#egg=mopidy-beets-dev
	27
	28	License
	29	-------
	30
	31	Copyright (C) 2013 <dz0ny at shortmail dot com>
	32
	33	Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
	34
	35	The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
	36
	37	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.⏎

+60

-0

mopidy_beets/__init__.py less more

	0	from __future__ import unicode_literals
	1
	2	import os
	3	from mopidy import ext, config
	4	from mopidy.exceptions import ExtensionError
	5
	6
	7	__doc__ = """A extension for playing music from Beets.
	8
	9	This extension handles URIs starting with ``beets:`` and enables you,
	10	to play music from Beets web service.
	11
	12	See https://github.com/dz0ny/mopidy-beets/ for further instructions on
	13	using this extension.
	14
	15	Issues:
	16
	17	https://github.com/dz0ny/mopidy-beets/issues
	18
	19	Dependencies:
	20
	21	requests
	22
	23	Default config
	24
	25	.. code-block:: ini
	26
	27	"""
	28
	29	__version__ = '1.0'
	30
	31
	32	class BeetsExtension(ext.Extension):
	33
	34	dist_name = 'Mopidy-Beets'
	35	ext_name = 'beets'
	36	version = __version__
	37
	38	def get_default_config(self):
	39	conf_file = os.path.join(os.path.dirname(__file__), 'ext.conf')
	40	return config.read(conf_file)
	41
	42	def get_config_schema(self):
	43	schema = super(BeetsExtension, self).get_config_schema()
	44	schema['hostname'] = config.String()
	45	return schema
	46
	47	def validate_config(self, config):
	48	if not config.getboolean('beets', 'enabled'):
	49	return
	50
	51	def validate_environment(self):
	52	try:
	53	import requests # noqa
	54	except ImportError as e:
	55	raise ExtensionError('Library requests not found', e)
	56
	57	def get_backend_classes(self):
	58	from .actor import BeetsBackend
	59	return [BeetsBackend]

+32

-0

mopidy_beets/actor.py less more

	0	from __future__ import unicode_literals
	1
	2	import logging
	3	import pykka
	4
	5	from mopidy.backends import base
	6
	7	from .library import BeetsLibraryProvider
	8	from .client import BeetsRemoteClient
	9
	10	logger = logging.getLogger('mopidy.backends.beets')
	11
	12
	13	class BeetsBackend(pykka.ThreadingActor, base.Backend):
	14
	15	def __init__(self, config, audio):
	16	super(BeetsBackend, self).__init__()
	17	self.beets_api = BeetsRemoteClient(config['beets']['hostname'])
	18	self.library = BeetsLibraryProvider(backend=self)
	19	self.playback = BeetsPlaybackProvider(audio=audio, backend=self)
	20	self.playlists = None
	21
	22	self.uri_schemes = ['beets']
	23
	24
	25	class BeetsPlaybackProvider(base.BasePlaybackProvider):
	26
	27	def play(self, track):
	28	id = track.uri.split(';')[1]
	29	logger.info('Getting info for track %s with id %s' % (track.uri, id))
	30	track = self.backend.beets_api.get_track(id, True)
	31	return super(BeetsPlaybackProvider, self).play(track)

+187

-0

mopidy_beets/client.py less more

	0	#!/usr/local/bin/python
	1	# -- coding: utf-8 --
	2	#
	3	from __future__ import unicode_literals
	4
	5	import logging
	6	import requests
	7	import time
	8
	9	from requests.exceptions import RequestException
	10	from mopidy.models import Track, Album, Artist
	11
	12	logger = logging.getLogger('mopidy.backends.beets.client')
	13
	14
	15	class cache(object):
	16	# TODO: merge this to util library
	17
	18	def __init__(self, ctl=8, ttl=3600):
	19	self.cache = {}
	20	self.ctl = ctl
	21	self.ttl = ttl
	22	self._call_count = 1
	23
	24	def __call__(self, func):
	25	def _memoized(*args):
	26	self.func = func
	27	now = time.time()
	28	try:
	29	value, last_update = self.cache[args]
	30	age = now - last_update
	31	if self._call_count >= self.ctl or \
	32	age > self.ttl:
	33	self._call_count = 1
	34	raise AttributeError
	35
	36	self._call_count += 1
	37	return value
	38
	39	except (KeyError, AttributeError):
	40	value = self.func(*args)
	41	self.cache[args] = (value, now)
	42	return value
	43
	44	except TypeError:
	45	return self.func(*args)
	46	return _memoized
	47
	48
	49	class BeetsRemoteClient(object):
	50
	51	def __init__(self, endpoint):
	52	super(BeetsRemoteClient, self).__init__()
	53	self.api = requests.Session()
	54	self.has_connection = False
	55	self.api_endpoint = endpoint
	56	logger.info('Connecting to Beets remote library %s', endpoint)
	57	try:
	58	self.api.get(self.api_endpoint)
	59	self.has_connection = True
	60	except RequestException as e:
	61	logger.error('Beets error: %s' % e)
	62
	63	@cache()
	64	def get_tracks(self):
	65	track_ids = self._get('/item/').get('item_ids')
	66	tracks = []
	67	for track_id in track_ids:
	68	tracks.append(self.get_track(track_id))
	69	return tracks
	70
	71	@cache(ctl=16)
	72	def get_track(self, id, remote_url=False):
	73	return self._convert_json_data(self._get('/item/%s' % id), remote_url)
	74
	75	@cache()
	76	def get_item_by(self, name):
	77	res = self._get('/item/query/%s' % name).get('results')
	78	try:
	79	return self._parse_query(res)
	80	except Exception:
	81	return False
	82
	83	@cache()
	84	def get_album_by(self, name):
	85	res = self._get('/album/query/%s' % name).get('results')
	86	try:
	87	return self._parse_query(res[0]['items'])
	88	except Exception:
	89	return False
	90
	91	def _get(self, url):
	92	try:
	93	url = self.api_endpoint + url
	94	logger.debug('Requesting %s' % url)
	95	req = self.api.get(url)
	96	if req.status_code != 200:
	97	raise logger.error('Request %s, failed with status code %s' % (
	98	url, req.status_code))
	99
	100	return req.json()
	101	except Exception as e:
	102	return False
	103	logger.error('Request %s, failed with error %s' % (
	104	url, e))
	105
	106	def _parse_query(self, res):
	107	if len(res) > 0:
	108	tracks = []
	109	for track in res:
	110	tracks.append(self._convert_json_data(track))
	111	return tracks
	112	return None
	113
	114	def _convert_json_data(self, data, remote_url=False):
	115	if not data:
	116	return
	117	# NOTE kwargs dict keys must be bytestrings to work on Python < 2.6.5
	118	# See https://github.com/mopidy/mopidy/issues/302 for details.
	119
	120	track_kwargs = {}
	121	album_kwargs = {}
	122	artist_kwargs = {}
	123	albumartist_kwargs = {}
	124
	125	if 'track' in data:
	126	track_kwargs[b'track_no'] = int(data['track'])
	127
	128	if 'tracktotal' in data:
	129	album_kwargs[b'num_tracks'] = int(data['tracktotal'])
	130
	131	if 'artist' in data:
	132	artist_kwargs[b'name'] = data['artist']
	133	albumartist_kwargs[b'name'] = data['artist']
	134
	135	if 'albumartist' in data:
	136	albumartist_kwargs[b'name'] = data['albumartist']
	137
	138	if 'album' in data:
	139	album_kwargs[b'name'] = data['album']
	140
	141	if 'title' in data:
	142	track_kwargs[b'name'] = data['title']
	143
	144	if 'date' in data:
	145	track_kwargs[b'date'] = data['date']
	146
	147	if 'mb_trackid' in data:
	148	track_kwargs[b'musicbrainz_id'] = data['mb_trackid']
	149
	150	if 'mb_albumid' in data:
	151	album_kwargs[b'musicbrainz_id'] = data['mb_albumid']
	152
	153	if 'mb_artistid' in data:
	154	artist_kwargs[b'musicbrainz_id'] = data['mb_artistid']
	155
	156	if 'mb_albumartistid' in data:
	157	albumartist_kwargs[b'musicbrainz_id'] = (
	158	data['mb_albumartistid'])
	159
	160	if 'album_id' in data:
	161	album_art_url = '%s/album/%s/art' % (
	162	self.api_endpoint, data['album_id'])
	163	album_kwargs[b'images'] = [album_art_url]
	164
	165	if artist_kwargs:
	166	artist = Artist(**artist_kwargs)
	167	track_kwargs[b'artists'] = [artist]
	168
	169	if albumartist_kwargs:
	170	albumartist = Artist(**albumartist_kwargs)
	171	album_kwargs[b'artists'] = [albumartist]
	172
	173	if album_kwargs:
	174	album = Album(**album_kwargs)
	175	track_kwargs[b'album'] = album
	176
	177	if remote_url:
	178	track_kwargs[b'uri'] = '%s/item/%s/file' % (
	179	self.api_endpoint, data['id'])
	180	else:
	181	track_kwargs[b'uri'] = 'beets:track;%s' % data['id']
	182	track_kwargs[b'length'] = int(data.get('length', 0)) * 1000
	183
	184	track = Track(**track_kwargs)
	185
	186	return track

-0

mopidy_beets/ext.conf less more

	0	[beets]
	1	enabled = True
	2	hostname =
	3

+64

-0

mopidy_beets/library.py less more

	0	from __future__ import unicode_literals
	1
	2	import logging
	3
	4	from mopidy.backends import base
	5	from mopidy.models import SearchResult
	6
	7	logger = logging.getLogger('mopidy.backends.beets')
	8
	9
	10	class BeetsLibraryProvider(base.BaseLibraryProvider):
	11	def __init__(self, args, *kwargs):
	12	super(BeetsLibraryProvider, self).__init__(args, *kwargs)
	13	self.remote = self.backend.beets_api
	14
	15	def find_exact(self, query=None, uris=None):
	16	return self.search(query=query, uris=uris)
	17
	18	def search(self, query=None, uris=None):
	19	if not self.remote.has_connection:
	20	return []
	21
	22	if not query:
	23	# Fetch all data(browse library)
	24	return SearchResult(
	25	uri='beets:search',
	26	tracks=self.remote.get_tracks())
	27
	28	self._validate_query(query)
	29
	30	for (field, val) in query.iteritems():
	31	if field == "album":
	32	return SearchResult(
	33	uri='beets:search',
	34	tracks=self.remote.get_album_by(val[0]) or [])
	35	elif field == "artist":
	36	return SearchResult(
	37	uri='beets:search',
	38	tracks=self.remote.get_item_by(val[0]) or [])
	39	elif field == "any":
	40	return SearchResult(
	41	uri='beets:search',
	42	tracks=self.remote.get_item_by(val[0]) or [])
	43	else:
	44	raise LookupError('Invalid lookup field: %s' % field)
	45
	46	return []
	47
	48	def lookup(self, uri):
	49	try:
	50	id = uri.split(";")[1]
	51	logger.debug(u'Beets track id for "%s": %s', id, uri)
	52	return [self.remote.get_track(id, True)]
	53	except Exception as error:
	54	logger.debug(u'Failed to lookup "%s": %s', uri, error)
	55	return []
	56
	57	def _validate_query(self, query):
	58	for (_, values) in query.iteritems():
	59	if not values:
	60	raise LookupError('Missing query')
	61	for value in values:
	62	if not value:
	63	raise LookupError('Missing query')

+42

-0

setup.py less more

	0	from __future__ import unicode_literals
	1
	2	import re
	3	from setuptools import setup, find_packages
	4
	5
	6	def get_version(filename):
	7	content = open(filename).read()
	8	metadata = dict(re.findall("__([a-z]+)__ = '([^']+)'", content))
	9	return metadata['version']
	10
	11	setup(
	12	name='Mopidy-Beets',
	13	version=get_version('mopidy_beets/__init__.py'),
	14	url='http://github.com/dz0ny/mopidy-beets/',
	15	license='MIT',
	16	author='dz0ny',
	17	author_email='dz0ny@shortmail.com',
	18	description='Beets extension for Mopidy',
	19	long_description=open('README.rst').read(),
	20	packages=find_packages(exclude=['tests', 'tests.*']),
	21	zip_safe=False,
	22	include_package_data=True,
	23	install_requires=[
	24	'setuptools',
	25	'Mopidy',
	26	'requests',
	27	],
	28	entry_points={
	29	b'mopidy.ext': [
	30	'beets = mopidy_beets:BeetsExtension',
	31	],
	32	},
	33	classifiers=[
	34	'Environment :: No Input/Output (Daemon)',
	35	'Intended Audience :: End Users/Desktop',
	36	'License :: OSI Approved :: MIT License',
	37	'Operating System :: OS Independent',
	38	'Programming Language :: Python :: 2',
	39	'Topic :: Multimedia :: Sound/Audio :: Players',
	40	],
	41	)