Merge pull request #40 from alister/feature/profiles

Gravatar Profile URL support
henrikbjorn · Oct 2, 2015 · 735c520 · 735c520
2 parents 4e3bd27 + 30cfffd
commit 735c520
Show file tree

Hide file tree

Showing 7 changed files with 129 additions and 0 deletions.
diff --git a/GravatarApi.php b/GravatarApi.php
@@ -76,6 +76,36 @@ public function getUrlForHash($hash, $size = null, $rating = null, $default = nu
         return ($secure ? 'https://secure' : 'http://www').'.gravatar.com/avatar/'.$hash.'?'.http_build_query(array_filter($map));
     }
 
+    /**
+     * Returns a url for a gravatar profile.
+     *
+     * @param string  $email
+     * @param Boolean $secure
+     *
+     * @return string
+     */
+    public function getProfileUrl($email, $secure = null)
+    {
+        $hash = md5(strtolower(trim($email)));
+
+        return $this->getProfileUrlForHash($hash, $secure);
+    }
+
+    /**
+     * Returns a url for a gravatar profile for the given hash.
+     *
+     * @param string  $hash
+     * @param Boolean $secure
+     *
+     * @return string
+     */
+    public function getProfileUrlForHash($hash, $secure = null)
+    {
+        $secure = $secure ?: $this->defaults['secure'];
+
+        return ($secure ? 'https://secure' : 'http://www').'.gravatar.com/'.$hash;
+    }
+
     /**
      * Checks if a gravatar exists for the email. It does this by checking for the presence of 404 in the header
      * returned. Will return null if fsockopen fails, for example when the hostname cannot be resolved.

diff --git a/Templating/Helper/GravatarHelper.php b/Templating/Helper/GravatarHelper.php
@@ -51,6 +51,22 @@ public function getUrlForHash($hash, $size = null, $rating = null, $default = nu
         return $this->api->getUrlForHash($hash, $size, $rating, $default, $this->isSecure($secure));
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function getProfileUrl($email, $secure = null)
+    {
+        return $this->api->getProfileUrl($email, $this->isSecure($secure));
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getProfileUrlForHash($hash, $secure = null)
+    {
+        return $this->api->getProfileUrlForHash($hash, $this->isSecure($secure));
+    }
+
     public function render($email, array $options = array())
     {
         $size = isset($options['size']) ? $options['size'] : null;

diff --git a/Templating/Helper/GravatarHelperInterface.php b/Templating/Helper/GravatarHelperInterface.php
@@ -30,6 +30,26 @@ public function getUrl($email, $size = null, $rating = null, $default = null, $s
      */
     public function getUrlForHash($hash, $size = null, $rating = null, $default = null, $secure = null);
 
+    /**
+     * Returns a url for a gravatar profile.
+     *
+     * @param string  $email
+     * @param Boolean $secure
+     *
+     * @return string
+     */
+    public function getProfileUrl($email, $secure = null);
+
+    /**
+     * Returns a url for a gravatar profile, for the given hash.
+     *
+     * @param string  $hash
+     * @param Boolean $secure
+     *
+     * @return string
+     */
+    public function getProfileUrlForHash($hash, $secure = null);
+
     /**
      * Returns true if a avatar could be found for the email.
      *

diff --git a/Tests/GravatarApiTest.php b/Tests/GravatarApiTest.php
@@ -24,6 +24,18 @@ public function testGravatarUrlWithDefaultImage()
         $this->assertEquals('http://www.gravatar.com/avatar/0aa61df8e35327ac3b3bc666525e0bee?s=80&r=g&d=mm', $api->getUrl('[email protected]', 80, 'g', 'mm'));
     }
 
+    public function testGravatarSecureProfileUrlWithDefaultOptions()
+    {
+        $api = new GravatarApi();
+        $this->assertEquals('https://secure.gravatar.com/0aa61df8e35327ac3b3bc666525e0bee', $api->getProfileUrl('[email protected]', true));
+    }
+
+    public function testGravatarProfileUrlWithDefaultImage()
+    {
+        $api = new GravatarApi();
+        $this->assertEquals('http://www.gravatar.com/0aa61df8e35327ac3b3bc666525e0bee', $api->getProfileUrl('[email protected]'));
+    }
+
     public function testGravatarInitializedWithOptions()
     {
         $api = new GravatarApi(array(

diff --git a/Tests/Templating/Helper/GravatarHelperTest.php b/Tests/Templating/Helper/GravatarHelperTest.php
@@ -27,6 +27,35 @@ public function testGetUrlReturnsTheCorrectSecureUrl()
         );
     }
 
+    public function testGetProfileUrlReturnsTheCorrectUrl()
+    {
+        $this->assertEquals('http://www.gravatar.com/0aa61df8e35327ac3b3bc666525e0bee', $this->helper->getProfileUrl('[email protected]'));
+    }
+
+    public function testGetProfileUrlReturnsTheCorrectSecureUrl()
+    {
+        $this->assertEquals(
+            'https://secure.gravatar.com/0aa61df8e35327ac3b3bc666525e0bee',
+            $this->helper->getProfileUrl('[email protected]', true)
+        );
+    }
+
+    public function testGetProfileUrlForHashReturnsTheCorrectUrl()
+    {
+        $this->assertEquals(
+            'http://www.gravatar.com/0aa61df8e35327ac3b3bc666525e0bee',
+            $this->helper->getProfileUrlForHash('0aa61df8e35327ac3b3bc666525e0bee')
+        );
+    }
+
+    public function testGetProfileUrlForHashReturnsTheCorrectSecureUrl()
+    {
+        $this->assertEquals(
+            'https://secure.gravatar.com/0aa61df8e35327ac3b3bc666525e0bee',
+            $this->helper->getProfileUrlForHash('0aa61df8e35327ac3b3bc666525e0bee', true)
+        );
+    }
+
     public function testCheckForAvatarExistance()
     {
         $this->assertTrue($this->helper->exists('[email protected]'));

diff --git a/Tests/Twig/GravatarExtensionTest.php b/Tests/Twig/GravatarExtensionTest.php
@@ -36,6 +36,8 @@ public function testProxyMethods()
         $this->extension->getUrl('[email protected]');
         $this->extension->exists('[email protected]');
         $this->extension->getUrlForHash(md5('[email protected]'));
+        $this->extension->getProfileUrl('[email protected]');
+        $this->extension->getProfileUrlForHash(md5('[email protected]'));
     }
 
     public function testName()
@@ -50,6 +52,8 @@ public function testFunctions()
         $expectedNames = array(
             'gravatar',
             'gravatar_hash',
+            'gravatar_profile',
+            'gravatar_profile_hash',
             'gravatar_exists',
         );
 

diff --git a/Twig/GravatarExtension.php b/Twig/GravatarExtension.php
@@ -28,6 +28,8 @@ public function getFunctions()
         return array(
             new \Twig_SimpleFunction('gravatar', array($this, 'getUrl')),
             new \Twig_SimpleFunction('gravatar_hash', array($this, 'getUrlForHash')),
+            new \Twig_SimpleFunction('gravatar_profile', array($this, 'getProfileUrl')),
+            new \Twig_SimpleFunction('gravatar_profile_hash', array($this, 'getProfileUrlForHash')),
             new \Twig_SimpleFunction('gravatar_exists', array($this, 'exists')),
         );
     }
@@ -48,6 +50,22 @@ public function getUrlForHash($hash, $size = null, $rating = null, $default = nu
         return $this->baseHelper->getUrlForHash($hash, $size, $rating, $default, $secure);
     }
 
+    /*
+     * {@inheritdoc}
+     */
+    public function getProfileUrl($email, $secure = null)
+    {
+        return $this->baseHelper->getProfileUrl($email, $secure);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getProfileUrlForHash($hash, $secure = null)
+    {
+        return $this->baseHelper->getProfileUrlForHash($hash, $secure);
+    }
+
     /**
      * {@inheritdoc}
      */