add in fireplace endpoint that is almost identical to apps, once client is updated we can move stuff over (bug 875547)

Andy McKay · Andy McKay · commit 815a3e1704d8 · 2013-06-21T09:34:30.000-07:00
diff --git a/docs/api/index.rst b/docs/api/index.rst
@@ -21,6 +21,7 @@ This documentation covers interacting with the `Firefox Marketplace`_.
    topics/apps.rst
    topics/comm.rst
    topics/export.rst
+   topics/fireplace.rst
    topics/payment.rst
    topics/ratings.rst
    topics/reviewers.rst
diff --git a/docs/api/topics/fireplace.rst b/docs/api/topics/fireplace.rst
@@ -0,0 +1,13 @@
+.. _fireplace:
+
+=========
+Fireplace
+=========
+
+Fireplace is the consumer client for the Marketplace. It has some special
+API's. These are *not recommended* for consumption by other clients and can
+change in conjunction with the Fireplace client.
+
+.. http:get:: /api/v1/fireplace/app/
+
+    A copy of :ref:`the app API <app-response-label>`.
diff --git a/mkt/api/tests/__init__.py b/mkt/api/tests/__init__.py
@@ -0,0 +1,31 @@
+import json
+from amo.tests import TestCase
+
+
+class BaseAPI(TestCase):
+    """
+    A base test case useful for API testing.
+    """
+
+    def _allowed_verbs(self, url, allowed):
+        """
+        Will run through all the verbs except the ones specified in allowed
+        and ensure that hitting those produces a 405. Otherwise the test will
+        fail.
+        """
+        verbs = ['get', 'post', 'put', 'patch', 'delete']
+        for verb in verbs:
+            if verb in allowed:
+                continue
+            try:
+                res = getattr(self.client, verb)(url)
+            except AttributeError:
+                # Not all clients have patch.
+                if verb != 'patch':
+                    raise
+            assert res.status_code in (401, 405), (
+                '%s: %s not 401 or 405' % (verb.upper(), res.status_code))
+
+    def get_error(self, response):
+        return json.loads(response.content)['error_message']
+
diff --git a/mkt/api/tests/nose.cfg b/mkt/api/tests/nose.cfg
@@ -15,6 +15,7 @@ tests=mkt.abuse.tests.test_resources,
       mkt.api.tests.test_throttle,
       mkt.developers.tests.test_api,
       mkt.developers.tests.test_api_payments,
+      mkt.fireplace.tests.test_api,
       mkt.ratings.tests.test_resources,
       mkt.receipts.tests.test_api,
       mkt.regions.tests.test_api,
diff --git a/mkt/api/tests/test_oauth.py b/mkt/api/tests/test_oauth.py
@@ -20,6 +20,7 @@
 from mkt.api import authentication
 from mkt.api.base import CORSResource, MarketplaceResource
 from mkt.api.models import Access, Token, generate, REQUEST_TOKEN, ACCESS_TOKEN
+from mkt.api.tests import BaseAPI
 from mkt.site.fixtures import fixture
 
 
@@ -126,7 +127,7 @@ def patch(self, url, data='', **kw):
         return response
 
 
-class BaseOAuth(TestCase):
+class BaseOAuth(BaseAPI):
     fixtures = fixture('user_2519', 'group_admin', 'group_editor',
                        'group_support')
 
@@ -140,23 +141,6 @@ def setUp(self, api_name='apps'):
         self.client = OAuthClient(self.access, api_name=api_name)
         self.anon = OAuthClient(None, api_name=api_name)
 
-    def _allowed_verbs(self, url, allowed):
-        """
-        Will run through all the verbs except the ones specified in allowed
-        and ensure that hitting those produces a 405. Otherwise the test will
-        fail.
-        """
-        verbs = ['get', 'post', 'put', 'patch', 'delete']
-        for verb in verbs:
-            if verb in allowed:
-                continue
-            res = getattr(self.client, verb)(url)
-            assert res.status_code in (401, 405), (
-                '%s: %s not 401 or 405' % (verb.upper(), res.status_code))
-
-    def get_error(self, response):
-        return json.loads(response.content)['error_message']
-
 
 class RestOAuthClient(OAuthClient):
 
diff --git a/mkt/fireplace/__init__.py b/mkt/fireplace/__init__.py
diff --git a/mkt/fireplace/api.py b/mkt/fireplace/api.py
@@ -0,0 +1,8 @@
+from mkt.api.resources import AppResource as BaseAppResource
+
+
+class AppResource(BaseAppResource):
+
+    class Meta(BaseAppResource.Meta):
+        list_allowed_methods = []
+        detail_allowed_methods = ['get']
diff --git a/mkt/fireplace/tests/__init__.py b/mkt/fireplace/tests/__init__.py
diff --git a/mkt/fireplace/tests/test_api.py b/mkt/fireplace/tests/test_api.py
@@ -0,0 +1,38 @@
+import json
+
+from nose.tools import eq_
+
+from mkt.api.base import get_url, list_url
+from mkt.api.tests import BaseAPI
+from mkt.api.tests.test_oauth import get_absolute_url
+from mkt.webapps.models import Webapp
+from mkt.site.fixtures import fixture
+
+
+class TestAppDetail(BaseAPI):
+    fixtures = fixture('webapp_337141')
+
+    def setUp(self):
+        super(TestAppDetail, self).setUp()
+        self.url = get_absolute_url(get_url('app', pk=337141),
+                                    api_name='fireplace')
+
+    def test_get(self):
+        res = self.client.get(self.url)
+        data = json.loads(res.content)
+        eq_(data['id'], '337141')
+
+    def test_get_slug(self):
+        Webapp.objects.get(pk=337141).update(app_slug='foo')
+        res = self.client.get(get_absolute_url(('api_dispatch_detail',
+            {'resource_name': 'app', 'app_slug': 'foo'}),
+            api_name='fireplace'))
+        data = json.loads(res.content)
+        eq_(data['id'], '337141')
+
+    def test_others(self):
+        print self.url
+        url = get_absolute_url(list_url('app'), api_name='fireplace')
+        print url
+        self._allowed_verbs(self.url, ['get'])
+        self._allowed_verbs(url, [])
diff --git a/mkt/fireplace/urls.py b/mkt/fireplace/urls.py
@@ -0,0 +1,11 @@
+from django.conf.urls import include, patterns, url
+
+from tastypie.api import Api
+from mkt.fireplace.api import AppResource
+
+fireplace = Api(api_name='fireplace')
+fireplace.register(AppResource())
+
+urlpatterns = patterns('',
+    url(r'', include(fireplace.urls)),
+)
diff --git a/mkt/urls.py b/mkt/urls.py
@@ -33,6 +33,7 @@
 handler500 = 'mkt.site.views.handler500'
 
 api_patterns = patterns('',
+    url('', include('mkt.fireplace.urls')),
     url('', include('mkt.api.urls')),
     url('', include(abuse_api_patterns)),
     url('', include(account_api_patterns)),
