Merge pull request #131 from pylast/develop

Merge develop to master

.editorconfig

@@ -0,0 +1,13 @@
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+charset = utf-8
+
+# 4 space indentation
+[*.py]
+indent_size = 4
+indent_style = space

.travis.yml

@@ -10,12 +10,12 @@ env:
   - secure: CQYL7MH6tSVrCcluIfWfDSTo4E/p+9pF0eI7Vtf0oaZBzyulODHK8h/mzJp4HwezyfOu0RCedq6sloGQr1/29CvWWESaYyoGoGz9Mz2ZS+MpIcjGISfZa+x4vSp6QPFvd4i/1Z/1j2gJVVyswkrIVUwZIDJtfAKzZI5iHx2gH8Y=
   - secure: SsKJoJwtDVWrL5xxl9C/gTRy6FhfRQQNNAFOogl9mTs/WeI2t9QTYoKsxLPXOdoRdu4MvT3h/B2sjwggt7zP81fBVxQRTkg4nq0zSHlj0NqclbFa6I5lUYdGwH9gPk/HWJJwXhKRDsqn/iRw2v+qBDs/j3kIgPQ0yjM58LEPXic=
   matrix:
+  - TOXENV=lint
   - TOXENV=py27
   - TOXENV=py33
   - TOXENV=py34
   - TOXENV=pypy
   - TOXENV=pypy3
-  - TOXENV=lint
 sudo: false
 install:
 - travis_retry pip install tox

LICENSE.txt

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

README.md

@@ -1,7 +1,7 @@
 pyLast
 ======
 
-[![Build Status](https://travis-ci.org/pylast/pylast.png?branch=master)](https://travis-ci.org/pylast/pylast) [![PyPI version](https://pypip.in/version/pylast/badge.svg)](https://pypi.python.org/pypi/pylast/) [![PyPI downloads](https://pypip.in/download/pylast/badge.svg)](https://pypi.python.org/pypi/pylast/) [![Coverage Status](https://coveralls.io/repos/pylast/pylast/badge.png?branch=master)](https://coveralls.io/r/pylast/pylast?branch=master) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/hugovk/pylast/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/hugovk/pylast/?branch=master) [![Code Health](https://landscape.io/github/hugovk/pylast/master/landscape.svg)](https://landscape.io/github/hugovk/pylast/master)
+[![Build Status](https://travis-ci.org/pylast/pylast.svg?branch=develop)](https://travis-ci.org/pylast/pylast) [![PyPI version](https://pypip.in/version/pylast/badge.svg)](https://pypi.python.org/pypi/pylast/) [![PyPI downloads](https://pypip.in/download/pylast/badge.svg)](https://pypi.python.org/pypi/pylast/) [![Coverage Status](https://coveralls.io/repos/pylast/pylast/badge.png?branch=develop)](https://coveralls.io/r/pylast/pylast?branch=develop) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/pylast/pylast/badges/quality-score.png?b=develop)](https://scrutinizer-ci.com/g/pylast/pylast/?branch=develop) [![Code Health](https://landscape.io/github/pylast/pylast/develop/landscape.svg)](https://landscape.io/github/hugovk/pylast/develop)
 
 
 A Python interface to [Last.fm](http://www.last.fm/) and other api-compatible websites such as [Libre.fm](http://libre.fm/).
@@ -80,7 +80,7 @@ export PYLAST_API_SECRET=TODO_ENTER_YOURS_HERE
 
 To run all unit and integration tests:
 ```sh
-pip install pytest
+pip install pytest flaky
 py.test
 ```
 

RELEASING.md

@@ -0,0 +1,26 @@
+# Release Checklist
+
+* [ ] Get master to the appropriate code release state. [Travis CI](https://travis-ci.org/pylast/pylast) should be running cleanly for all merges to master.
+* [ ] Update version in `pylast/__init__.py` and `setup.py` and commit:
+```bash
+git add pylast/__init__.py setup.py
+git commit -m "Release 1.1.0"
+```
+* [ ] Tag the last commit with the version number:
+```bash
+git tag -a 1.1.0
+```
+* [ ] Release on PyPI:
+```bash
+python setup.py register
+python setup.py sdist --format=gztar upload
+```
+* [ ] Push: `git push`
+* [ ] Push tags: `git push --tags`
+* [ ] Create new GitHub release: https://github.com/pylast/pylast/releases/new
+* [ ] Update develop branch from master:
+```bash
+git checkout develop
+git merge master --ff-only
+git push
+```

pylast/__init__.py

@@ -4,7 +4,7 @@
 #     A Python interface to Last.fm (and other API compatible social networks)
 #
 # Copyright 2008-2010 Amr Hassan
-# Copyright 2013-2014 hugovk
+# Copyright 2013-2015 hugovk
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -20,12 +20,6 @@
 #
 # http://code.google.com/p/pylast/
 
-__version__ = '1.1.0'
-__author__ = 'Amr Hassan, hugovk'
-__copyright__ = "Copyright (C) 2008-2010  Amr Hassan, 2013-2014 hugovk"
-__license__ = "apache2"
-__email__ = 'amr.hassan@gmail.com'
-
 import hashlib
 from xml.dom import minidom
 import xml.dom
@@ -36,9 +30,14 @@ import sys
 import collections
 import warnings
 import re
-
 import six
 
+__version__ = '1.1.0'
+__author__ = 'Amr Hassan, hugovk'
+__copyright__ = "Copyright (C) 2008-2010 Amr Hassan, 2013-2015 hugovk"
+__license__ = "apache2"
+__email__ = 'amr.hassan@gmail.com'
+
 
 def _deprecation_warning(message):
     warnings.warn(message, DeprecationWarning)
@@ -193,19 +192,6 @@ class _Network(object):
             self.session_key = sk_gen.get_session_key(
                 self.username, self.password_hash)
 
-    """def __repr__(self):
-        attributes = ("name", "homepage", "ws_server", "api_key", "api_secret",
-            "session_key", "submission_server", "username", "password_hash",
-            "domain_names", "urls")
-
-        text = "pylast._Network(%s)"
-        args = []
-        for attr in attributes:
-            args.append("=".join((attr, repr(getattr(self, attr)))))
-
-        return text % ", ".join(args)
-    """
-
     def __str__(self):
         return "%s Network" % self.name
 
@@ -397,7 +383,7 @@ class _Network(object):
 
         seq = []
         for node in doc.getElementsByTagName("tag"):
-            if len(seq) >= limit:
+            if limit and len(seq) >= limit:
                 break
             tag = Tag(_extract(node, "name"), self)
             weight = _number(_extract(node, "count"))
@@ -834,13 +820,13 @@ class LastFMNetwork(_Network):
             name="Last.fm",
             homepage="http://last.fm",
             ws_server=("ws.audioscrobbler.com", "/2.0/"),
-            api_key = api_key,
+            api_key=api_key,
-            api_secret = api_secret,
+            api_secret=api_secret,
-            session_key = session_key,
+            session_key=session_key,
-            submission_server = "http://post.audioscrobbler.com:80/",
+            submission_server="http://post.audioscrobbler.com:80/",
-            username = username,
+            username=username,
-            password_hash = password_hash,
+            password_hash=password_hash,
-            domain_names = {
+            domain_names={
                 DOMAIN_ENGLISH: 'www.last.fm',
                 DOMAIN_GERMAN: 'www.lastfm.de',
                 DOMAIN_SPANISH: 'www.lastfm.es',
@@ -854,7 +840,7 @@ class LastFMNetwork(_Network):
                 DOMAIN_JAPANESE: 'www.lastfm.jp',
                 DOMAIN_CHINESE: 'cn.last.fm',
             },
-            urls = {
+            urls={
                 "album": "music/%(artist)s/%(album)s",
                 "artist": "music/%(artist)s",
                 "event": "event/%(id)s",
@@ -930,13 +916,13 @@ class LibreFMNetwork(_Network):
             name="Libre.fm",
             homepage="http://alpha.libre.fm",
             ws_server=("alpha.libre.fm", "/2.0/"),
-            api_key = api_key,
+            api_key=api_key,
-            api_secret = api_secret,
+            api_secret=api_secret,
-            session_key = session_key,
+            session_key=session_key,
-            submission_server = "http://turtle.libre.fm:80/",
+            submission_server="http://turtle.libre.fm:80/",
-            username = username,
+            username=username,
-            password_hash = password_hash,
+            password_hash=password_hash,
-            domain_names = {
+            domain_names={
                 DOMAIN_ENGLISH: "alpha.libre.fm",
                 DOMAIN_GERMAN: "alpha.libre.fm",
                 DOMAIN_SPANISH: "alpha.libre.fm",
@@ -950,7 +936,7 @@ class LibreFMNetwork(_Network):
                 DOMAIN_JAPANESE: "alpha.libre.fm",
                 DOMAIN_CHINESE: "alpha.libre.fm",
             },
-            urls = {
+            urls={
                 "album": "artist/%(artist)s/album/%(album)s",
                 "artist": "artist/%(artist)s",
                 "event": "event/%(id)s",
@@ -2091,14 +2077,6 @@ class Artist(_BaseObject, _Taggable):
         return self.network._get_url(
             domain_name, "artist") % {'artist': artist}
 
-    def get_images(self, order=IMAGES_ORDER_POPULARITY, limit=None):
-        """
-        The artist.getImages method has been deprecated by Last.fm.
-        """
-        raise WSError(
-            self.network, "27",
-            "The artist.getImages method has been deprecated by Last.fm.")
-
     def shout(self, message):
         """
             Post a shout
@@ -4039,7 +4017,7 @@ def _extract(node, name, index=0):
         return None
 
 
-def _extract_element_tree(node, index=0):
+def _extract_element_tree(node):
     """Extract an element tree into a multi-level dictionary
 
     NB: If any elements have text nodes as well as nested
@@ -4198,13 +4176,13 @@ class BadSessionError(ScrobblingError):
 
 class _ScrobblerRequest(object):
 
-    def __init__(self, url, params, network, type="POST"):
+    def __init__(self, url, params, network, request_type="POST"):
 
         for key in params:
             params[key] = str(params[key])
 
         self.params = params
-        self.type = type
+        self.type = request_type
         (self.hostname, self.subdir) = url_split_host(url[len("http:"):])
         self.network = network
 

setup.py

@@ -1,6 +1,4 @@
 #!/usr/bin/env python
-import os
-
 from setuptools import setup, find_packages
 
 

tests/test_pylast.py

@@ -2,10 +2,10 @@
 """
 Integration (not unit) tests for pylast.py
 """
+from flaky import flaky
 import os
 import pytest
 from random import choice
-import sys
 import time
 import unittest
 
@@ -30,15 +30,11 @@ def load_secrets():
     return doc
 
 
+@flaky(max_runs=5, min_passes=1)
 class TestPyLast(unittest.TestCase):
 
     secrets = None
 
-    # To remove Python 3's
-    # "DeprecationWarning: Please use assertRaisesRegex instead"
-    if sys.version_info[0] == 2:
-        assertRaisesRegex = unittest.TestCase.assertRaisesRegexp
-
     def unix_timestamp(self):
         return int(time.time())
 
@@ -760,14 +756,6 @@ class TestPyLast(unittest.TestCase):
         # Assert
         self.assertEqual(name, "Last.fm Network")
 
-    def test_artist_get_images_deprecated(self):
-        # Arrange
-        artist = self.network.get_artist("Test Artist")
-
-        # Act/Assert
-        with self.assertRaisesRegex(pylast.WSError, 'deprecated'):
-            artist.get_images()
-
     def helper_validate_results(self, a, b, c):
         # Assert
         self.assertIsNotNone(a)
@@ -1099,6 +1087,14 @@ class TestPyLast(unittest.TestCase):
         # Assert
         self.helper_only_one_thing_in_top_list(tags, pylast.Tag)
 
+    def test_network_get_top_tags_with_no_limit(self):
+        # Arrange
+        # Act
+        tags = self.network.get_top_tags()
+
+        # Assert
+        self.helper_at_least_one_thing_in_top_list(tags, pylast.Tag)
+
     def test_network_get_top_tracks_with_limit(self):
         # Arrange
         # Act
@@ -1226,7 +1222,7 @@ class TestPyLast(unittest.TestCase):
         self.helper_dates_valid(dates)
 
         # Act/Assert
-        self.helper_get_assert_charts(lastfm_user, dates[1])
+        self.helper_get_assert_charts(lastfm_user, dates[0])
 
     def test_track_top_fans(self):
         # Arrange

tox.ini

@@ -10,6 +10,7 @@ deps =
      mock
      ipdb
      pytest-cov
+     flaky
 commands = py.test -v --cov pylast --cov-report term-missing {posargs}
 
 [testenv:venv]