pax_global_header00006660000000000000000000000064122250726660014522gustar00rootroot0000000000000052 comment=903975fa32e19d55a28a69a3cf4ecd16170282bb mopidy-scrobbler-1.0.0/000077500000000000000000000000001222507266600147745ustar00rootroot00000000000000mopidy-scrobbler-1.0.0/.coveragerc000066400000000000000000000001161222507266600171130ustar00rootroot00000000000000[report] omit = */pyshared/* */python?.?/* */site-packages/nose/* mopidy-scrobbler-1.0.0/.gitignore000066400000000000000000000000661222507266600167660ustar00rootroot00000000000000*.egg-info *.pyc *.swp .coverage MANIFEST build/ dist/mopidy-scrobbler-1.0.0/.travis.yml000066400000000000000000000012611222507266600171050ustar00rootroot00000000000000language: python install: - "wget -O - http://apt.mopidy.com/mopidy.gpg | sudo apt-key add -" - "sudo wget -O /etc/apt/sources.list.d/mopidy.list http://apt.mopidy.com/mopidy.list" - "sudo apt-get update || true" - "sudo apt-get install mopidy" - "pip install coveralls flake8" before_script: - "rm $VIRTUAL_ENV/lib/python$TRAVIS_PYTHON_VERSION/no-global-site-packages.txt" script: - "flake8 $(find . -iname '*.py')" - "nosetests --with-coverage --cover-package=mopidy_scrobbler" after_success: - "coveralls" notifications: irc: channels: - "irc.freenode.org#mopidy" on_success: change on_failure: change use_notice: true skip_join: true mopidy-scrobbler-1.0.0/LICENSE000066400000000000000000000261351222507266600160100ustar00rootroot00000000000000 Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.mopidy-scrobbler-1.0.0/MANIFEST.in000066400000000000000000000001301222507266600165240ustar00rootroot00000000000000include LICENSE include MANIFEST.in include README.rst include mopidy_scrobbler/ext.confmopidy-scrobbler-1.0.0/README.rst000066400000000000000000000037211222507266600164660ustar00rootroot00000000000000**************** Mopidy-Scrobbler **************** .. image:: https://pypip.in/v/Mopidy-Scrobbler/badge.png :target: https://crate.io/packages/Mopidy-Scrobbler/ :alt: Latest PyPI version .. image:: https://pypip.in/d/Mopidy-Scrobbler/badge.png :target: https://crate.io/packages/Mopidy-Scrobbler/ :alt: Number of PyPI downloads .. image:: https://travis-ci.org/mopidy/mopidy-scrobbler.png?branch=master :target: https://travis-ci.org/mopidy/mopidy-scrobbler :alt: Travis CI build status .. image:: https://coveralls.io/repos/mopidy/mopidy-scrobbler/badge.png?branch=master :target: https://coveralls.io/r/mopidy/mopidy-scrobbler?branch=master :alt: Test coverage `Mopidy `_ extension for scrobbling played tracks to `Last.fm `_. This extension requires a free user account at Last.fm. Installation ============ Install by running:: pip install Mopidy-Scrobbler Or, if available, install the Debian/Ubuntu package from `apt.mopidy.com `_. Configuration ============= The extension is enabled by default when it is installed. You just need to add your Last.fm username and password to your Mopidy configuration file, typically found at ``~/.config/mopidy/mopidy.conf``:: [scrobbler] username = alice password = secret The following configuration values are available: - ``scrobbler/enabled``: If the scrobbler extension should be enabled or not. - ``scrobbler/username``: Your Last.fm username. - ``scrobbler/password``: Your Last.fm password. Project resources ================= - `Source code `_ - `Issue tracker `_ - `Download development snapshot `_ Changelog ========= v1.0.0 (2013-10-08) ------------------- - Moved extension out of the main Mopidy project. - Added test suite. mopidy-scrobbler-1.0.0/mopidy_scrobbler/000077500000000000000000000000001222507266600203325ustar00rootroot00000000000000mopidy-scrobbler-1.0.0/mopidy_scrobbler/__init__.py000066400000000000000000000012751222507266600224500ustar00rootroot00000000000000from __future__ import unicode_literals import os from mopidy import config, ext __version__ = '1.0.0' class Extension(ext.Extension): dist_name = 'Mopidy-Scrobbler' ext_name = 'scrobbler' version = __version__ def get_default_config(self): conf_file = os.path.join(os.path.dirname(__file__), 'ext.conf') return config.read(conf_file) def get_config_schema(self): schema = super(Extension, self).get_config_schema() schema['username'] = config.String() schema['password'] = config.Secret() return schema def get_frontend_classes(self): from .frontend import ScrobblerFrontend return [ScrobblerFrontend] mopidy-scrobbler-1.0.0/mopidy_scrobbler/ext.conf000066400000000000000000000000611222507266600217760ustar00rootroot00000000000000[scrobbler] enabled = true username = password = mopidy-scrobbler-1.0.0/mopidy_scrobbler/frontend.py000066400000000000000000000062051222507266600225260ustar00rootroot00000000000000from __future__ import unicode_literals import logging import time import pykka import pylast from mopidy.core import CoreListener logger = logging.getLogger('mopidy_scrobbler') API_KEY = '2236babefa8ebb3d93ea467560d00d04' API_SECRET = '94d9a09c0cd5be955c4afaeaffcaefcd' class ScrobblerFrontend(pykka.ThreadingActor, CoreListener): def __init__(self, config, core): super(ScrobblerFrontend, self).__init__() self.config = config self.lastfm = None self.last_start_time = None def on_start(self): try: self.lastfm = pylast.LastFMNetwork( api_key=API_KEY, api_secret=API_SECRET, username=self.config['scrobbler']['username'], password_hash=pylast.md5(self.config['scrobbler']['password'])) logger.info('Scrobbler connected to Last.fm') except (pylast.NetworkError, pylast.MalformedResponseError, pylast.WSError) as e: logger.error('Error during Last.fm setup: %s', e) self.stop() def track_playback_started(self, tl_track): track = tl_track.track artists = ', '.join([a.name for a in track.artists]) duration = track.length and track.length // 1000 or 0 self.last_start_time = int(time.time()) logger.debug('Now playing track: %s - %s', artists, track.name) try: self.lastfm.update_now_playing( artists, (track.name or ''), album=(track.album and track.album.name or ''), duration=str(duration), track_number=str(track.track_no), mbid=(track.musicbrainz_id or '')) except (pylast.ScrobblingError, pylast.NetworkError, pylast.MalformedResponseError, pylast.WSError) as e: logger.warning('Error submitting playing track to Last.fm: %s', e) def track_playback_ended(self, tl_track, time_position): track = tl_track.track artists = ', '.join([a.name for a in track.artists]) duration = track.length and track.length // 1000 or 0 time_position = time_position // 1000 if duration < 30: logger.debug('Track too short to scrobble. (30s)') return if time_position < duration // 2 and time_position < 240: logger.debug( 'Track not played long enough to scrobble. (50% or 240s)') return if self.last_start_time is None: self.last_start_time = int(time.time()) - duration logger.debug('Scrobbling track: %s - %s', artists, track.name) try: self.lastfm.scrobble( artists, (track.name or ''), str(self.last_start_time), album=(track.album and track.album.name or ''), track_number=str(track.track_no), duration=str(duration), mbid=(track.musicbrainz_id or '')) except (pylast.ScrobblingError, pylast.NetworkError, pylast.MalformedResponseError, pylast.WSError) as e: logger.warning('Error submitting played track to Last.fm: %s', e) mopidy-scrobbler-1.0.0/setup.py000066400000000000000000000026451222507266600165150ustar00rootroot00000000000000from __future__ import unicode_literals import re from setuptools import setup, find_packages def get_version(filename): content = open(filename).read() metadata = dict(re.findall("__([a-z]+)__ = '([^']+)'", content)) return metadata['version'] setup( name='Mopidy-Scrobbler', version=get_version('mopidy_scrobbler/__init__.py'), url='https://github.com/mopidy/mopidy-scrobbler', license='Apache License, Version 2.0', author='Stein Magnus Jodal', author_email='stein.magnus@jodal.no', description='Mopidy extension for scrobbling played tracks to Last.fm', long_description=open('README.rst').read(), packages=find_packages(exclude=['tests', 'tests.*']), zip_safe=False, include_package_data=True, install_requires=[ 'setuptools', 'Mopidy >= 0.16a0', 'Pykka >= 1.1', 'pylast >= 0.5.7', ], test_suite='nose.collector', tests_require=[ 'nose', 'mock >= 1.0', ], entry_points={ 'mopidy.ext': [ 'scrobbler = mopidy_scrobbler:Extension', ], }, classifiers=[ 'Environment :: No Input/Output (Daemon)', 'Intended Audience :: End Users/Desktop', 'License :: OSI Approved :: Apache Software License', 'Operating System :: OS Independent', 'Programming Language :: Python :: 2', 'Topic :: Multimedia :: Sound/Audio :: Players', ], ) mopidy-scrobbler-1.0.0/tests/000077500000000000000000000000001222507266600161365ustar00rootroot00000000000000mopidy-scrobbler-1.0.0/tests/__init__.py000066400000000000000000000000001222507266600202350ustar00rootroot00000000000000mopidy-scrobbler-1.0.0/tests/test_extension.py000066400000000000000000000014211222507266600215610ustar00rootroot00000000000000import unittest from mopidy_scrobbler import Extension, frontend as frontend_lib class ExtensionTest(unittest.TestCase): def test_get_default_config(self): ext = Extension() config = ext.get_default_config() self.assertIn('[scrobbler]', config) self.assertIn('enabled = true', config) self.assertIn('username =', config) self.assertIn('password =', config) def test_get_config_schema(self): ext = Extension() schema = ext.get_config_schema() self.assertIn('username', schema) self.assertIn('password', schema) def test_get_frontend_classes(self): ext = Extension() classes = ext.get_frontend_classes() self.assertIn(frontend_lib.ScrobblerFrontend, classes) mopidy-scrobbler-1.0.0/tests/test_frontend.py000066400000000000000000000125761222507266600214010ustar00rootroot00000000000000import mock import unittest import pylast from mopidy import models from mopidy_scrobbler import frontend as frontend_lib @mock.patch('mopidy_scrobbler.frontend.pylast', spec=pylast) class FrontendTest(unittest.TestCase): def setUp(self): self.config = { 'scrobbler': { 'username': 'alice', 'password': 'secret', } } self.frontend = frontend_lib.ScrobblerFrontend( self.config, mock.sentinel.core) def test_on_start_creates_lastfm_network(self, pylast_mock): pylast_mock.md5.return_value = mock.sentinel.password_hash self.frontend.on_start() pylast_mock.LastFMNetwork.assert_called_with( api_key=frontend_lib.API_KEY, api_secret=frontend_lib.API_SECRET, username='alice', password_hash=mock.sentinel.password_hash) def test_on_start_stops_actor_on_error(self, pylast_mock): pylast_mock.NetworkError = pylast.NetworkError pylast_mock.LastFMNetwork.side_effect = pylast.NetworkError( None, 'foo') self.frontend.stop = mock.Mock() self.frontend.on_start() self.frontend.stop.assert_called_with() def test_track_playback_started_updates_now_playing(self, pylast_mock): self.frontend.lastfm = mock.Mock(spec=pylast.LastFMNetwork) artists = [models.Artist(name='ABC'), models.Artist(name='XYZ')] album = models.Album(name='The Collection') track = models.Track( name='One Two Three', artists=artists, album=album, track_no=3, length=180432, musicbrainz_id='123-456') tl_track = models.TlTrack(track=track, tlid=17) self.frontend.track_playback_started(tl_track) self.frontend.lastfm.update_now_playing.assert_called_with( 'ABC, XYZ', 'One Two Three', duration='180', album='The Collection', track_number='3', mbid='123-456') def test_track_playback_started_has_default_values(self, pylast_mock): self.frontend.lastfm = mock.Mock(spec=pylast.LastFMNetwork) track = models.Track() tl_track = models.TlTrack(track=track, tlid=17) self.frontend.track_playback_started(tl_track) self.frontend.lastfm.update_now_playing.assert_called_with( '', '', duration='0', album='', track_number='0', mbid='') def test_track_playback_started_catches_pylast_error(self, pylast_mock): self.frontend.lastfm = mock.Mock(spec=pylast.LastFMNetwork) pylast_mock.ScrobblingError = pylast.ScrobblingError self.frontend.lastfm.update_now_playing.side_effect = ( pylast.ScrobblingError('foo')) track = models.Track() tl_track = models.TlTrack(track=track, tlid=17) self.frontend.track_playback_started(tl_track) def test_track_playback_ended_scrobbles_played_track(self, pylast_mock): self.frontend.last_start_time = 123 self.frontend.lastfm = mock.Mock(spec=pylast.LastFMNetwork) artists = [models.Artist(name='ABC'), models.Artist(name='XYZ')] album = models.Album(name='The Collection') track = models.Track( name='One Two Three', artists=artists, album=album, track_no=3, length=180432, musicbrainz_id='123-456') tl_track = models.TlTrack(track=track, tlid=17) self.frontend.track_playback_ended(tl_track, 150000) self.frontend.lastfm.scrobble.assert_called_with( 'ABC, XYZ', 'One Two Three', '123', duration='180', album='The Collection', track_number='3', mbid='123-456') def test_does_not_scrobble_tracks_shorter_than_30_sec(self, pylast_mock): self.frontend.lastfm = mock.Mock(spec=pylast.LastFMNetwork) track = models.Track(length=20432) tl_track = models.TlTrack(track=track, tlid=17) self.frontend.track_playback_ended(tl_track, 20432) self.assertEqual(self.frontend.lastfm.scrobble.call_count, 0) def test_does_not_scrobble_if_played_less_than_half(self, pylast_mock): self.frontend.lastfm = mock.Mock(spec=pylast.LastFMNetwork) track = models.Track(length=180432) tl_track = models.TlTrack(track=track, tlid=17) self.frontend.track_playback_ended(tl_track, 60432) self.assertEqual(self.frontend.lastfm.scrobble.call_count, 0) def test_does_scrobble_if_played_not_half_but_240_sec(self, pylast_mock): self.frontend.lastfm = mock.Mock(spec=pylast.LastFMNetwork) track = models.Track(length=880432) tl_track = models.TlTrack(track=track, tlid=17) self.frontend.track_playback_ended(tl_track, 241432) self.assertEqual(self.frontend.lastfm.scrobble.call_count, 1) def test_track_playback_ended_catches_pylast_error(self, pylast_mock): self.frontend.lastfm = mock.Mock(spec=pylast.LastFMNetwork) pylast_mock.ScrobblingError = pylast.ScrobblingError self.frontend.lastfm.scrobble.side_effect = ( pylast.ScrobblingError('foo')) track = models.Track(length=180432) tl_track = models.TlTrack(track=track, tlid=17) self.frontend.track_playback_ended(tl_track, 150000)