Login: store token in session as array [Ref #15]

milo · milo · commit 69a2b835e9bf · 2015-09-16T20:18:54.000+02:00
When stored as a Token object, can be unserialized as an __PHP_Incomplete_Class when session starts before the library is loaded.
diff --git a/src/Github/OAuth/Login.php b/src/Github/OAuth/Login.php
@@ -122,7 +122,7 @@ public function obtainToken($code, $state)
 		}
 
 		$token = new Token($json->access_token, $json->token_type, strlen($json->scope) ? explode(',', $json->scope) : []);
-		$this->storage->set('auth.token', $token);
+		$this->storage->set('auth.token', $token->toArray());
 		$this->storage->remove('auth.state');
 
 		return $token;
@@ -148,9 +148,14 @@ public function getToken()
 		$token = $this->storage->get('auth.token');
 		if ($token === NULL) {
 			throw new Github\LogicException('Token has not been obtained yet.');
+
+		} elseif ($token instanceof Token) {
+			/** @deprecated */
+			$token = $token->toArray();
+			$this->storage->set('auth.token', $token);
 		}
 
-		return $token;
+		return Token::createFromArray($token);
 	}
 
 
diff --git a/src/Github/OAuth/Token.php b/src/Github/OAuth/Token.php
@@ -87,4 +87,22 @@ public function hasScope($scope)
 		return FALSE;
 	}
 
+
+	/** @internal */
+	public function toArray()
+	{
+		return [
+			'value' => $this->value,
+			'type' => $this->type,
+			'scopes' => $this->scopes,
+		];
+	}
+
+
+	/** @internal */
+	public static function createFromArray(array $data)
+	{
+		return new static($data['value'], $data['type'], $data['scopes']);
+	}
+
 }
diff --git a/tests/Github/OAuth/Login.phpt b/tests/Github/OAuth/Login.phpt
@@ -170,6 +170,21 @@ class LoginTestCase extends Tester\TestCase
 		Assert::null($e->getPrevious());
 	}
 
+
+	/** @deprecated */
+	public function testTokenObjectInSession()
+	{
+		$token = new Milo\Github\OAuth\Token('a', 'b', ['c', 'd']);
+		$this->storage->set('auth.token', $token);
+
+		Assert::type('Milo\Github\OAuth\Token', $this->login->getToken());
+		Assert::same([
+			'value' => 'a',
+			'type' => 'b',
+			'scopes' => ['c', 'd'],
+		], $this->storage->get('auth.token'));
+	}
+
 }
 
 (new LoginTestCase())->run();
diff --git a/tests/Github/OAuth/Token.phpt b/tests/Github/OAuth/Token.phpt
@@ -23,3 +23,13 @@ Assert::true($token->hasScope('user'));
 Assert::true($token->hasScope('user:email'));
 Assert::false($token->hasScope('user:foo'));
 Assert::false($token->hasScope('foo'));
+
+$asArray = [
+	'value' => 'hash2',
+	'type' => 'type',
+	'scopes' => ['user'],
+];
+Assert::same($asArray, $token->toArray());
+
+$fromArray = Milo\Github\OAuth\Token::createFromArray($asArray);
+Assert::equal($token, $fromArray);

Original file line number	Diff line number	Diff line change
`@@ -122,7 +122,7 @@ public function obtainToken($code, $state)`
`122`	`122`	`}`
`123`	`123`
`124`	`124`	`$token = new Token($json->access_token, $json->token_type, strlen($json->scope) ? explode(',', $json->scope) : []);`
`125`		`- $this->storage->set('auth.token', $token);`
	`125`	`+ $this->storage->set('auth.token', $token->toArray());`
`126`	`126`	`$this->storage->remove('auth.state');`
`127`	`127`
`128`	`128`	`return $token;`
`@@ -148,9 +148,14 @@ public function getToken()`
`148`	`148`	`$token = $this->storage->get('auth.token');`
`149`	`149`	`if ($token === NULL) {`
`150`	`150`	`throw new Github\LogicException('Token has not been obtained yet.');`
	`151`	`+`
	`152`	`+ } elseif ($token instanceof Token) {`
	`153`	`+ /** @deprecated */`
	`154`	`+ $token = $token->toArray();`
	`155`	`+ $this->storage->set('auth.token', $token);`
`151`	`156`	`}`
`152`	`157`
`153`		`- return $token;`
	`158`	`+ return Token::createFromArray($token);`
`154`	`159`	`}`
`155`	`160`
`156`	`161`