Merge pull request #124 from agiuliano/master

Abstract routes for future formats

app/config/config.yml

@@ -40,8 +40,8 @@ pugx_badge:
         - { name: 'total', label: 'Total Downloads', route: "pugx_badge_download" }
         - { name: 'latest_unstable_version', label: 'Latest Unstable Version', route: "pugx_badge_version_latest", latest: 'unstable'}
         - { name: 'license', label: 'License', route: "pugx_badge_license"}
-        - { name: 'monthly', label: 'Monthly Downloads', route: "pugx_badge_download_type_png", type: 'monthly'}
-        - { name: 'daily', label: 'Daily Downloads', route: "pugx_badge_download_type_png", type: 'daily'}
+        - { name: 'monthly', label: 'Monthly Downloads', route: "pugx_badge_download_type", type: 'monthly'}
+        - { name: 'daily', label: 'Daily Downloads', route: "pugx_badge_download_type", type: 'daily'}
         - { name: 'version', label: 'Version', route: "pugx_badge_version" }
 
 

app/config/routing.yml

@@ -15,4 +15,10 @@ pugx_badge_shieldio:
     host: "img.shields.io"
     requirements:
       vendor: "[A-Za-z0-9_.-]+"
-      value:  "[A-Za-z0-9_.-]+"
+      value:  "[A-Za-z0-9_.-]+"
+
+redirects:
+    resource: "@PUGXBadgeBundle/Resources/config/routing/routing_redirects.yml"
+
+aliases:
+    resource: "@PUGXBadgeBundle/Resources/config/routing/routing_aliases.yml"

src/PUGX/BadgeBundle/Controller/BadgeController.php

@@ -29,6 +29,7 @@
  * @author Giulio De Donato <[email protected]>
  * @author Leonardo Proietti <[email protected]>
  * @author Simone Fumagalli <[email protected]>
+ * @author Andrea Giuliano <[email protected]>
  */
 class BadgeController extends Controller
 {
@@ -64,15 +65,15 @@ public function searchPackagistAction(Request $request)
      * @param string $repository repository
      * @param string $type       badge type
      *
-     * @Route("/{repository}/downloads.svg",
+     * @Route("/{repository}/downloads",
      *     name         = "pugx_badge_download",
+     *     defaults     = {"type" = "total"},
      *     requirements = {
      *          "repository" = "[A-Za-z0-9_.-]+/[A-Za-z0-9_.-]+?"
      *       }
      *     )
-     * @Route("/{repository}/d/{type}.svg",
+     * @Route("/{repository}/d/{type}",
      *     name         = "pugx_badge_download_type",
-     *     defaults     = {"type" = "total"},
      *     requirements = {
      *         "type"       = "total|daily|monthly",
      *         "repository" = "[A-Za-z0-9_.-]+/[A-Za-z0-9_.-]+?"
@@ -83,7 +84,7 @@ public function searchPackagistAction(Request $request)
      *
      * @return StreamedResponse
      */
-    public function downloadsAction($repository, $type = 'total')
+    public function downloadsAction($repository, $type)
     {
         $imageCreator = $this->getImageCreator();
         $status = 500;
@@ -125,15 +126,15 @@ public function downloadsAction($repository, $type = 'total')
      * @param string $repository repository
      * @param string $latest     latest
      *
-     * @Route("/{repository}/version.svg",
+     * @Route("/{repository}/version",
      *     name="pugx_badge_version",
+     *     defaults     = {"latest" = "stable"},
      *     requirements={"repository" = "[A-Za-z0-9_.-]+/[A-Za-z0-9_.-]+?"}
      *     )
-     * @Route("/{repository}/v/{latest}.svg",
+     * @Route("/{repository}/v/{latest}",
      *     name         = "pugx_badge_version_latest",
-     *     defaults     = {"latest" = "stable"},
      *     requirements = {
-     *         "type"       = "stable|unstable",
+     *         "latest"     = "stable|unstable",
      *         "repository" = "[A-Za-z0-9_.-]+/[A-Za-z0-9_.-]+?"
      *         }
      *     )
@@ -142,7 +143,7 @@ public function downloadsAction($repository, $type = 'total')
      *
      * @return StreamedResponse
      */
-    public function versionAction($repository, $latest = 'stable')
+    public function versionAction($repository, $latest)
     {
         $image = null;
         $error = self::ERROR_TEXT_GENERIC;
@@ -182,7 +183,7 @@ public function versionAction($repository, $latest = 'stable')
      *
      * @param string $repository repository
      *
-     * @Route("/{repository}/license.svg",
+     * @Route("/{repository}/license",
      *     name="pugx_badge_license",
      *     requirements={"repository" = "[A-Za-z0-9_.-]+/[A-Za-z0-9_.-]+?"}
      *     )

src/PUGX/BadgeBundle/Resources/config/routing/routing_aliases.yml

@@ -0,0 +1,45 @@
+download_svg_alias:
+    path: /{repository}/downloads.svg
+    defaults:
+        _controller: PUGXBadgeBundle:Badge:downloads
+        type: "total"
+    requirements:
+        repository: "[A-Za-z0-9_.-]+/[A-Za-z0-9_.-]+?"
+    methods:  [GET]
+
+download_type_svg_alias:
+    path: /{repository}/d/{type}.svg
+    defaults:
+        _controller: PUGXBadgeBundle:Badge:downloads
+        type: "total"
+    requirements:
+        repository: "[A-Za-z0-9_.-]+/[A-Za-z0-9_.-]+?"
+        type: "total|daily|monthly"
+    methods:  [GET]
+
+badge_version_svg_alias:
+    path: /{repository}/version.svg
+    defaults:
+        _controller: PUGXBadgeBundle:Badge:version
+        latest: "stable"
+    requirements:
+        repository: "[A-Za-z0-9_.-]+/[A-Za-z0-9_.-]+?"
+    methods:  [GET]
+
+version_latest_svg_alias:
+    path: /{repository}/v/{latest}.svg
+    defaults:
+        _controller: PUGXBadgeBundle:Badge:version
+        latest: "stable"
+    requirements:
+        repository: "[A-Za-z0-9_.-]+/[A-Za-z0-9_.-]+?"
+        latest: "stable|unstable"
+    methods:  [GET]
+
+badge_license_svg_alias:
+    path: /{repository}/license.svg
+    defaults:
+        _controller: PUGXBadgeBundle:Badge:license
+    requirements:
+        repository: "[A-Za-z0-9_.-]+/[A-Za-z0-9_.-]+?"
+    methods:  [GET]

src/PUGX/BadgeBundle/Resources/config/routing/routing_redirects.yml

@@ -0,0 +1,53 @@
+download_png_redirect:
+    path: /{repository}/downloads.png
+    defaults:
+        _controller: FrameworkBundle:Redirect:redirect
+        route: pugx_badge_download
+        permanent: true
+    requirements:
+        repository: "[A-Za-z0-9_.-]+/[A-Za-z0-9_.-]+?"
+    methods:  [GET]
+
+download_type_png_redirect:
+    path: /{repository}/d/{type}.png
+    defaults:
+        _controller: FrameworkBundle:Redirect:redirect
+        route: pugx_badge_download_type
+        permanent: true
+        type: "total"
+    requirements:
+        repository: "[A-Za-z0-9_.-]+/[A-Za-z0-9_.-]+?"
+        type: "total|daily|monthly"
+    methods:  [GET]
+
+badge_version_png_redirect:
+    path: /{repository}/version.png
+    defaults:
+        _controller: FrameworkBundle:Redirect:redirect
+        route: pugx_badge_version
+        permanent: true
+    requirements:
+        repository: "[A-Za-z0-9_.-]+/[A-Za-z0-9_.-]+?"
+    methods:  [GET]
+
+version_latest_png_redirect:
+    path: /{repository}/v/{latest}.png
+    defaults:
+        _controller: FrameworkBundle:Redirect:redirect
+        route: pugx_badge_version_latest
+        permanent: true
+        latest: "stable"
+    requirements:
+        repository: "[A-Za-z0-9_.-]+/[A-Za-z0-9_.-]+?"
+        type: "stable|unstable"
+    methods:  [GET]
+
+badge_license_png_redirect:
+    path: /{repository}/license.png
+    defaults:
+        _controller: FrameworkBundle:Redirect:redirect
+        route: pugx_badge_license
+        permanent: true
+    requirements:
+        repository: "[A-Za-z0-9_.-]+/[A-Za-z0-9_.-]+?"
+    methods:  [GET]

src/PUGX/BadgeBundle/Tests/Controller/BadgeControllerTest.php

@@ -34,23 +34,23 @@ public function testDownloadsAction()
         $client = static::createClient();
         static::$kernel->getContainer()->set('packagist_client', $this->packagistClient);
         static::$kernel->getContainer()->set('image_http_client', $this->imageHttpClient);
-        $client->request('GET', '/pugx/badge-poser/d/total.svg');
+        $client->request('GET', '/pugx/badge-poser/d/total');
         $this->assertTrue($client->getResponse()->isSuccessful());
     }
 
     public function testLatestStableAction()
     {
         $client = static::createClient();
         static::$kernel->getContainer()->set('packagist_client', $this->packagistClient);
-        $client->request('GET', '/pugx/badge-poser/version.svg');
+        $client->request('GET', '/pugx/badge-poser/version');
         $this->assertTrue($client->getResponse()->isSuccessful());
     }
 
     public function testLatestUnstableAction()
     {
         $client = static::createClient();
         static::$kernel->getContainer()->set('packagist_client', $this->packagistClient);
-        $client->request('GET', '/pugx/badge-poser/v/unstable.svg');
+        $client->request('GET', '/pugx/badge-poser/v/unstable');
 
         $this->assertTrue($client->getResponse()->isSuccessful());
         $response = $client->getResponse();
@@ -61,7 +61,7 @@ public function testLicenseAction()
     {
         $client = static::createClient();
         static::$kernel->getContainer()->set('packagist_client', $this->packagistClient);
-        $client->request('GET', '/pugx/badge-poser/license.svg');
+        $client->request('GET', '/pugx/badge-poser/license');
         $this->assertTrue($client->getResponse()->isSuccessful());
     }
 
@@ -74,7 +74,7 @@ public function testIfPackageDoesntExist()
         $client = static::createClient();
         static::$kernel->getContainer()->set('packagist_client', $packagistClient);
         static::$kernel->getContainer()->set('image_http_client', $this->imageHttpClient);
-        $client->request('GET', '/pugx/microsoft-lover/d/total.svg');
+        $client->request('GET', '/pugx/microsoft-lover/d/total');
         $this->assertTrue($client->getResponse()->isServerError());
     }