Support new client credentials flow and deprecate the old api token flow.

Author: Carlo Smouter

.drone.yml

@@ -0,0 +1,18 @@
+pipeline:
+  build:
+    image: python:${PYTHON_VERSION}-alpine3.8
+    commands:
+      - find . -name "*.py[co]" -delete
+      - pip install --upgrade pip
+      - pip install -e .
+      - pip install -e .[tests]
+      - py.test
+      - find . -name "*.py[co]" -delete
+    when:
+      include: [ master, develop, feature/*, release/* ]
+matrix:
+  PYTHON_VERSION:
+    - "3.7"
+    - "3.6"
+    - "3.5"
+    - "2.7"

CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## 2.0 (In Development)
+
+* Deprecate 1.0 WowApi
+* Implement client credentials flow for OAuth authentication
+* Add dronefile for testing against multiple python versions
+* Add coverage to pytest
+* Add logging

LICENSE.txt

@@ -1,6 +1,6 @@
 python-wowapi
 -----------------
-Copyright (c) 2013 python-wowapi | Carlo Smouter
+Copyright (c) 2018 python-wowapi | Carlo Smouter
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

MANIFEST.in

@@ -1,4 +1,8 @@
-include setup.py README.rst Makefile MANIFEST.in
+include setup.py
+include README.md
+include CHANGELOG.md
+include Makefile
+include MANIFEST.in
 include LICENSE.txt
 include Makefile
 include pytest.ini

README.md

@@ -0,0 +1,44 @@
+# python-wowapi
+
+Python-wowapi is a client library for interacting with the World of Warcraft
+Community API.
+
+Documentation about installing and usage can be found at [python-wowapi.readthedocs.org](https://python-wowapi.readthedocs.org)
+
+## Installing
+
+```bash
+pip install python-wowapi
+```
+
+## Usage
+
+```python
+import os
+
+from wowapi import WowApi
+
+
+api = WowApi(os.environ['WOW_CLIENT_ID'], os.environ['WOW_CLIENT_SECRET'])
+data = api.get_auctions('eu', 'silvermoon', locale='de_DE')
+print(data)
+```
+
+## Development & Testing
+
+```bash
+pip install -e .
+pip install -e .[tests]
+py.test
+```
+
+## Drone test runner
+
+```
+PYTHON_VERSION=3.7 drone exec
+PYTHON_VERSION=3.6 drone exec
+PYTHON_VERSION=3.5 drone exec
+PYTHON_VERSION=2.7 drone exec
+```
+
+For more information about Drone, visit [Drone.io](https://drone.io/)

README.rst

@@ -44,16 +44,16 @@
 
 # General information about the project.
 project ='python-wowapi'
-copyright ='2013, Carlo Smouter'
+copyright ='2018, Carlo Smouter'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = '1.0'
+version = '2.0'
 # The full version, including alpha/beta/rc tags.
-release = '1.0'
+release = '2.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/conf.py

@@ -3,22 +3,22 @@ Python-wowapi
 
 Python-wowapi is a client library for interacting with the World of Warcraft Community API.
 
+This library requires a client-id and client secret for the Community API OAuth client credentials flow.
+
 For more information visit:
 
-- `Official API documentation <https://dev.battle.net/io-docs>`_
-- `Official API Forum <http://us.battle.net/forums/en/bnet/15051532/>`_
+- `Official API documentation <https://develop.battle.net/documentation>`_
+- `Official API Forum <https://us.battle.net/forums/en/bnet/15051532/>`_
 
 
 Usage
 -----
 
-.. warning::
-    `WOWAPI_APIKEY` has to be set as an environment variable before calling the api endpoints.
-
 ::
 
     >>> from wowapi import WowApi
-    >>> item = WowApi.get_item('eu', 9999)
+    >>> api = WowApi('client-id', 'client-secret')
+    >>> item = api.get_item('eu', 9999)
 
     {
         "id": 9999,
@@ -31,7 +31,7 @@ Usage
 
 ::
 
-    >>> item = WowApi.get_item('eu', 9999, locale='de_DE')
+    >>> item = api.get_item('eu', 9999, locale='de_DE')
 
     {
         "id": 9999,

docs/index.rst

@@ -0,0 +1,23 @@
+import logging
+import os
+from pprint import pprint
+
+from wowapi import WowApi
+
+
+logger = logging.getLogger('wowapi')
+logger.setLevel(logging.INFO)
+handler = logging.StreamHandler()
+handler.setLevel(logging.INFO)
+formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
+handler.setFormatter(formatter)
+logger.addHandler(handler)
+
+logger.info('WowApi example')
+
+api = WowApi(os.environ['WOW_CLIENT_ID'], os.environ['WOW_CLIENT_SECRET'])
+data = api.get_auctions('eu', 'silvermoon', locale='de_DE')
+pprint(data)
+
+data = api.get_realm_status('us')
+pprint(data)

examples/main.py

@@ -1,5 +1,5 @@
 [pytest]
-addopts = --tb=short --pep8 --flakes
+addopts = -vs --tb=short --pep8 --flakes --cov=wowapi --cov-config .coveragerc
 
 python_files =
     test_*.py

pytest.ini

@@ -3,7 +3,7 @@
 from setuptools import setup
 
 
-__version__ = '1.0'
+__version__ = '2.0'
 
 
 def read(*parts):
@@ -13,24 +13,20 @@ def read(*parts):
 
 
 install_requirements = [
-    'requests==2.11.1',
+    'requests==2.19.1',
 ]
 
 test_requirements = [
-    'tox==2.4.1',
-    'py==1.4.31',
-    'pyflakes==1.3.0',
-    'pytest==3.0.3',
-    'pytest-cache==1.0',
-    'pytest-flakes==1.0.1',
+    'pytest==3.8.2',
+    'pytest-flakes==4.0.0',
     'pytest-pep8==1.0.6',
-    'mock==1.0.1',
-    'pep8==1.7.0',
-    'pytest-mock==1.2',
+    'pytest-cov==2.6.0',
+    'mock==2.0.0',
+    'pytest-mock==1.10.0',
 ]
 
 docs_requirements = [
-    'Sphinx==1.4.8',
+    'Sphinx==1.8.1',
 ]
 
 setup(
@@ -55,7 +51,9 @@ def read(*parts):
         'Operating System :: OS Independent',
         'Programming Language :: Python',
         'Programming Language :: Python :: 2.7',
-        'Programming Language :: Python :: 3.4',
+        'Programming Language :: Python :: 3.5',
+        'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.7',
         'Topic :: Internet :: WWW/HTTP',
     ],
     packages=[

setup.py

@@ -1,38 +1,33 @@
 import pytest
 import requests
-from requests.exceptions import RequestException
-
-
-def response_mock():
-    mock = requests.models.Response()
-    mock.status_code = 200
-    mock._content = b'{}'
-    return mock
 
 
 @pytest.fixture
-def get_mock(mocker):
-    return mocker.patch('requests.get', return_value=response_mock())
+def session_get_mock(mocker):
+    return mocker.patch('requests.Session.get')
 
 
 @pytest.fixture
-def get_404_mock(mocker):
-    mock = response_mock()
-    mock.status_code = 404
-    mock._content = 'Not Found'
+def utc_mock(mocker):
+    return mocker.patch('wowapi.api.WowApi._utcnow')
 
-    return mocker.patch('requests.get', return_value=mock)
 
+def get_success_response():
+    mock = requests.models.Response()
+    mock.status_code = 200
+    mock._content = b'{}'
+    return mock
 
-@pytest.fixture
-def invalid_json_mock(mocker):
-    mock = response_mock()
-    mock._content = b'{"foo": "bar"},'
 
-    return mocker.patch('requests.get', return_value=mock)
+class ResponseMock(object):
 
+    def __call__(self, status_code, content):
+        mock = requests.models.Response()
+        mock.status_code = status_code
+        mock._content = content
+        return mock
 
-@pytest.fixture
-def request_exception_mock(mocker):
 
-    return mocker.patch('requests.get', side_effect=RequestException('Problem'))
+@pytest.fixture
+def response_mock(mocker):
+    return mocker.patch('requests.Session.get', return_value=get_success_response())