Add encoder. Massive renaming.

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [0.3.0] - 2017-08-18
+### Changed
+- New names for all items. 
+
 ## [0.2.0] - 2017-08-18
 ### Changed
 - Renamed: JwtDecoderAdapterInterface -> JwtDecoderInterface

src/FreeElephants/Jwt/AbstractAdapterFactory.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace FreeElephants\Jwt;
+
+abstract class AbstractAdapterFactory
+{
+
+    abstract public function createDecoder(string $key, array $allowedAlgorithms): DecoderInterface;
+
+    abstract public function createEncoder($key): EncoderInterface;
+}

src/FreeElephants/Jwt/JwtDecoderInterface.php → src/FreeElephants/Jwt/DecoderInterface.php

@@ -4,7 +4,7 @@
 namespace FreeElephants\Jwt;
 
 
-interface JwtDecoderInterface
+interface DecoderInterface
 {
 
     public function getAlgorithms(): array;

src/FreeElephants/Jwt/EncoderInterface.php

@@ -0,0 +1,15 @@
+<?php
+
+
+namespace FreeElephants\Jwt;
+
+
+interface EncoderInterface
+{
+
+    /**
+     * @param array|object $token
+     * @return string
+     */
+    public function encode($token, string $algorithm): string;
+}

src/FreeElephants/Jwt/Firebase/FirebaseAdapterFactory.php

@@ -0,0 +1,23 @@
+<?php
+
+
+namespace FreeElephants\Jwt\Firebase;
+
+
+use FreeElephants\Jwt\AbstractAdapterFactory;
+use FreeElephants\Jwt\DecoderInterface;
+use FreeElephants\Jwt\EncoderInterface;
+
+class FirebaseAdapterFactory extends AbstractAdapterFactory
+{
+
+    public function createDecoder(string $key, array $allowedAlgorithms): DecoderInterface
+    {
+        return new FirebaseDecoderAdapter($key, $allowedAlgorithms);
+    }
+
+    public function createEncoder($key): EncoderInterface
+    {
+        return new FirebaseEncoderAdapter($key);
+    }
+}

src/FreeElephants/Jwt/FirebaseJwtDecoderAdapter.php → src/FreeElephants/Jwt/Firebase/FirebaseDecoderAdapter.php

@@ -1,14 +1,16 @@
 <?php
 
 
-namespace FreeElephants\Jwt;
+namespace FreeElephants\Jwt\Firebase;
 
 
 use Firebase\JWT\JWT;
 use FreeElephants\Jwt\Exception\InvalidArgumentException;
 use FreeElephants\Jwt\Exception\OutOfBoundsException;
+use FreeElephants\Jwt\DecoderInterface;
+use FreeElephants\Jwt\EncoderInterface;
 
-class FirebaseJwtDecoder implements JwtDecoderInterface
+class FirebaseDecoderAdapter implements DecoderInterface, EncoderInterface
 {
 
     private $algorithms;
@@ -55,4 +57,13 @@ public function getSupportedAlgorithms(): array
             'RS256'
         ];
     }
+
+    /**
+     * @param array|object $token
+     * @return string
+     */
+    public function encode($token, string $algorithm): string
+    {
+        return Jwt::encode($token, $this->key, $algorithm);
+    }
 }

src/FreeElephants/Jwt/Firebase/FirebaseEncoderAdapter.php

@@ -0,0 +1,29 @@
+<?php
+
+
+namespace FreeElephants\Jwt\Firebase;
+
+
+use Firebase\JWT\JWT;
+use FreeElephants\Jwt\EncoderInterface;
+
+class FirebaseEncoderAdapter implements EncoderInterface
+{
+
+    /** @var string|array*/
+    private $key;
+
+    public function __construct($key)
+    {
+        $this->key = $key;
+    }
+
+    /**
+     * @param array|object $token
+     * @return string
+     */
+    public function encode($token, string $algorithm): string
+    {
+        return Jwt::encode($token, $this->key, $algorithm);
+    }
+}

tests/FreeElephants/Jwt/FirebaseJwtAdapterTest.php → tests/FreeElephants/Jwt/Firebase/FirebaseDecoderAdapterTest.php

@@ -1,39 +1,41 @@
 <?php
 
 
-namespace FreeElephants\Jwt;
+namespace FreeElephants\Jwt\Firebase;
 
 
 use FreeElephants\Jwt\Exception\InvalidArgumentException;
 use FreeElephants\Jwt\Exception\OutOfBoundsException;
 use PHPUnit\Framework\TestCase;
 
-class FirebaseJwtAdapterTest extends TestCase
+class FirebaseDecoderAdapterTest extends TestCase
 {
 
+    const EXAMPLE_JWT = 'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoaWQiOiJqb2UiLCJhdXRocm9sZXMiOlsic3Vic2NyaWJlciJdfQ.Lxyy1H3gfs1FV5UJLGxfAYvS1TJeiJhVInu5GIlccg4';
+
     public function testDecode()
     {
-        $decoder = new FirebaseJwtDecoder('example_key', ['HS256', 'HS384']);
+        $decoder = new FirebaseDecoderAdapter('example_key', ['HS256', 'HS384']);
 
-        $signature = 'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoaWQiOiJqb2UiLCJhdXRocm9sZXMiOlsic3Vic2NyaWJlciJdfQ.Lxyy1H3gfs1FV5UJLGxfAYvS1TJeiJhVInu5GIlccg4';
         $expected = new \stdClass();
         $expected->authid = 'joe';
         $expected->authroles = [
             'subscriber'
         ];
 
-        $this->assertEquals($expected, $decoder->decode($signature));
+        $this->assertEquals($expected, $decoder->decode(self::EXAMPLE_JWT));
     }
 
     public function testUseEmptyAllowedAlgorithmsListInvalidArgumentException()
     {
         $this->expectException(InvalidArgumentException::class);
-        new FirebaseJwtDecoder('example_key', []);
+        new FirebaseDecoderAdapter('example_key', []);
     }
 
     public function testSetAllowedAlgorithmsOutOfBoundsException()
     {
         $this->expectException(OutOfBoundsException::class);
-        new FirebaseJwtDecoder('example_key', ['foo bar']);
+        new FirebaseDecoderAdapter('example_key', ['foo bar']);
     }
+
 }

tests/FreeElephants/Jwt/Firebase/FirebaseEncoderAdapterTest.php

@@ -0,0 +1,19 @@
+<?php
+
+
+namespace FreeElephants\Jwt\Firebase;
+
+
+use PHPUnit\Framework\TestCase;
+
+class FirebaseEncoderAdapterTest extends TestCase
+{
+
+    const EXAMPLE_JWT = 'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoaWQiOiJqb2UiLCJhdXRocm9sZXMiOlsic3Vic2NyaWJlciJdfQ.Lxyy1H3gfs1FV5UJLGxfAYvS1TJeiJhVInu5GIlccg4';
+
+    public function testEncode()
+    {
+        $encoder = new FirebaseEncoderAdapter('example_key', ['HS256', 'HS384']);
+        $this->assertSame(self::EXAMPLE_JWT, $encoder->encode(['authid' => 'joe', 'authroles' => ['subscriber']], 'HS256'));
+    }
+}