PdoThirdPartyStorageRepository::save() - Code Metrics - tharangakothalawala/sso - Measure and Improve Code Quality continuously with Scrutinizer

PdoThirdPartyStorageRepository::save() A
last analyzed 2021-02-15 23:10 UTC

↳ Parent: PdoThirdPartyStorageRepository

Complexity

Conditions	2
Paths	15

Size

Total Lines	53
Code Lines	23

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	2
eloc	23
c	1
b	0
f	0
nc	15
nop	3
dl	0
loc	53
rs	9.552

How to fix Long Method

<?php
/**
 * @author Tharanga Kothalawala <[email protected]>
 * @date 30-12-2018
 */

namespace TSK\SSO\Storage;

use TSK\SSO\AppUser\AppUser;
use TSK\SSO\Storage\Exception\DataCannotBeStoredException;
use TSK\SSO\ThirdParty\CommonAccessToken;
use TSK\SSO\ThirdParty\ThirdPartyUser;
use PDOException;
use PDO;

/**
 * @codeCoverageIgnore
 * @package TSK\SSO\Storage
 *
 * This will connect to a MySQL database using the php-pdo driver to persist vendor data.
 */
class PdoThirdPartyStorageRepository implements ThirdPartyStorageRepository
{
    /**
     * @var PDO
     */
    private $dbConnection;

    /**
     * @var string
     */
    private $table;

    /**
     * @param PDO $dbConnection
     * @param string $table name of the table in the MySQL database
     */
    public function __construct(PDO $dbConnection, $table = 'thirdparty_connections')
    {
        $this->dbConnection = $dbConnection;
        $this->table = $table;
    }

    /**
     * Returns a mapped full user record for a given vendor email address or null.
     *
     * @param string $emailAddress email address used within the given vendor system
     * @param string|null $vendorName [optional] name of the third party vendor for vendor filtering
     * @return MappedUser|null
     */
    public function getUser($emailAddress, $vendorName = null)
    {
        if (is_null($vendorName)) {
            $sql = "SELECT * FROM `{$this->table}` WHERE `vendor_email` = :email LIMIT 1";
            $stmt = $this->dbConnection->prepare($sql);
        } else {
            $sql = "SELECT * FROM `{$this->table}` WHERE `vendor_email` = :email AND `vendor_name` = :vendor LIMIT 1";
            $stmt = $this->dbConnection->prepare($sql);
            $stmt->bindParam(':vendor', $vendorName, PDO::PARAM_STR);
        }

        $stmt->bindParam(':email', $emailAddress, PDO::PARAM_STR);
        $stmt->execute();

        $userMap = $stmt->fetch(PDO::FETCH_ASSOC);
        if (empty($userMap)) {
            return null;
        }

        return new MappedUser(
            $userMap['app_user_id'],
            $userMap['vendor_name'],
            $userMap['vendor_email'],
            $userMap['vendor_access_token'],
            $userMap['vendor_data']
        );
    }

    /**
     * Returns any vendor MappedUser list for a given Application user.
     *
     * @param AppUser $appUser
     * @return MappedUser[]
     */
    public function getByAppUser(AppUser $appUser)
    {
        $stmt = $this->dbConnection->prepare("SELECT * FROM `{$this->table}` WHERE `app_user_id` = :appUserId");
        $appUserId = $appUser->id();
        $stmt->bindParam(':appUserId', $appUserId, is_numeric($appUserId) ? PDO::PARAM_STR : PDO::PARAM_INT);
        $stmt->execute();

        $connections = array();
        while ($mappedUser = $stmt->fetch(PDO::FETCH_ASSOC)) {
            $connections[] = new MappedUser(
                $mappedUser['app_user_id'],
                $mappedUser['vendor_name'],
                $mappedUser['vendor_email'],
                $mappedUser['vendor_access_token'],
                $mappedUser['vendor_data']
            );
        }

        return $connections;
    }

    /**
     * @param AppUser $appUser
     * @param ThirdPartyUser $thirdPartyUser
     * @param CommonAccessToken $accessToken
     * @throws DataCannotBeStoredException
     */
    public function save(
        AppUser $appUser,
        ThirdPartyUser $thirdPartyUser,
        CommonAccessToken $accessToken
    ) {
        $sql = <<<SQL
            INSERT INTO `{$this->table}`
            (
                `app_user_id`,
                `vendor_name`,
                `vendor_email`,
                `vendor_access_token`,
                `vendor_refresh_token`,
                `vendor_data`,
                `created_at`
            )
            VALUES
            (
                :appUserId,
                :vendorName,
                :vendorEmail,
                :vendorToken,
                :vendorRefreshToken,
                :vendorData,
                NOW()
            )
            ON DUPLICATE KEY UPDATE
                `vendor_access_token` = VALUES(`vendor_access_token`),
                `vendor_refresh_token` = VALUES(`vendor_refresh_token`),
                `vendor_data` = VALUES(`vendor_data`),
                `updated_at` = NOW()
SQL;
        try {
            $vendorData = json_encode($thirdPartyUser->toArray());
            $appUserId = $appUser->id();
            $vendorName = $accessToken->vendor();
            $vendorEmail = $thirdPartyUser->email();
            $vendorToken = $accessToken->token();
            $vendorRefreshToken = $accessToken->getRefreshToken();

            $stmt = $this->dbConnection->prepare($sql);
            $stmt->bindParam(':appUserId', $appUserId, PDO::PARAM_STR);
            $stmt->bindParam(':vendorName', $vendorName, PDO::PARAM_STR);
            $stmt->bindParam(':vendorEmail', $vendorEmail, PDO::PARAM_STR);
            $stmt->bindParam(':vendorToken', $vendorToken, PDO::PARAM_STR);
            $stmt->bindParam(':vendorRefreshToken', $vendorRefreshToken, PDO::PARAM_STR);
            $stmt->bindParam(':vendorData', $vendorData, PDO::PARAM_STR);
            $stmt->execute();
        } catch (PDOException $ex) {
            throw new DataCannotBeStoredException(
                sprintf("Couldn't save the third party user data. Error : %s", $ex->getMessage()),
                $ex->getCode(),
                $ex
            );
        }
    }

    /**
     * Use this to clean the storage after revoking access to a third party for example.
     *
     * @param string $emailAddress email address used within the given vendor system
     * @param string $vendorName name of the third party where the given email belongs to
     * @return bool
     */
    public function remove($emailAddress, $vendorName)
    {
        $sql = "DELETE FROM `{$this->table}` WHERE `vendor_email` = :email AND `vendor_name` = :vendor LIMIT 1";
        $stmt = $this->dbConnection->prepare($sql);
        $stmt->bindParam(':email', $emailAddress, PDO::PARAM_STR);
        $stmt->bindParam(':vendor', $vendorName, PDO::PARAM_STR);
        return $stmt->execute();
    }
}


1			<?php
2			/**
3			* @author Tharanga Kothalawala <[email protected]>
4			* @date 30-12-2018
5			*/
6
7			namespace TSK\SSO\Storage;
8
9			use TSK\SSO\AppUser\AppUser;
10			use TSK\SSO\Storage\Exception\DataCannotBeStoredException;
11			use TSK\SSO\ThirdParty\CommonAccessToken;
12			use TSK\SSO\ThirdParty\ThirdPartyUser;
13			use PDOException;
14			use PDO;
15
16			/**
17			* @codeCoverageIgnore
18			* @package TSK\SSO\Storage
19			*
20			* This will connect to a MySQL database using the php-pdo driver to persist vendor data.
21			*/
22			class PdoThirdPartyStorageRepository implements ThirdPartyStorageRepository
23			{
24			/**
25			* @var PDO
26			*/
27			private $dbConnection;
28
29			/**
30			* @var string
31			*/
32			private $table;
33
34			/**
35			* @param PDO $dbConnection
36			* @param string $table name of the table in the MySQL database
37			*/
38			public function __construct(PDO $dbConnection, $table = 'thirdparty_connections')
39			{
40			$this->dbConnection = $dbConnection;
41			$this->table = $table;
42			}
43
44			/**
45			* Returns a mapped full user record for a given vendor email address or null.
46			*
47			* @param string $emailAddress email address used within the given vendor system
48			* @param string\|null $vendorName [optional] name of the third party vendor for vendor filtering
49			* @return MappedUser\|null
50			*/
51			public function getUser($emailAddress, $vendorName = null)
52			{
53			if (is_null($vendorName)) {
54			$sql = "SELECT * FROM `{$this->table}` WHERE `vendor_email` = :email LIMIT 1";
55			$stmt = $this->dbConnection->prepare($sql);
56			} else {
57			$sql = "SELECT * FROM `{$this->table}` WHERE `vendor_email` = :email AND `vendor_name` = :vendor LIMIT 1";
58			$stmt = $this->dbConnection->prepare($sql);
59			$stmt->bindParam(':vendor', $vendorName, PDO::PARAM_STR);
60			}
61
62			$stmt->bindParam(':email', $emailAddress, PDO::PARAM_STR);
63			$stmt->execute();
64
65			$userMap = $stmt->fetch(PDO::FETCH_ASSOC);
66			if (empty($userMap)) {
67			return null;
68			}
69
70			return new MappedUser(
71			$userMap['app_user_id'],
72			$userMap['vendor_name'],
73			$userMap['vendor_email'],
74			$userMap['vendor_access_token'],
75			$userMap['vendor_data']
76			);
77			}
78
79			/**
80			* Returns any vendor MappedUser list for a given Application user.
81			*
82			* @param AppUser $appUser
83			* @return MappedUser[]
84			*/
85			public function getByAppUser(AppUser $appUser)
86			{
87			$stmt = $this->dbConnection->prepare("SELECT * FROM `{$this->table}` WHERE `app_user_id` = :appUserId");
88			$appUserId = $appUser->id();
89			$stmt->bindParam(':appUserId', $appUserId, is_numeric($appUserId) ? PDO::PARAM_STR : PDO::PARAM_INT);
90			$stmt->execute();
91
92			$connections = array();
93			while ($mappedUser = $stmt->fetch(PDO::FETCH_ASSOC)) {
94			$connections[] = new MappedUser(
95			$mappedUser['app_user_id'],
96			$mappedUser['vendor_name'],
97			$mappedUser['vendor_email'],
98			$mappedUser['vendor_access_token'],
99			$mappedUser['vendor_data']
100			);
101			}
102
103			return $connections;
104			}
105
106			/**
107			* @param AppUser $appUser
108			* @param ThirdPartyUser $thirdPartyUser
109			* @param CommonAccessToken $accessToken
110			* @throws DataCannotBeStoredException
111			*/
112			public function save(
113			AppUser $appUser,
114			ThirdPartyUser $thirdPartyUser,
115			CommonAccessToken $accessToken
116			) {
117			$sql = <<<SQL
118			INSERT INTO `{$this->table}`
119			(
120			`app_user_id`,
121			`vendor_name`,
122			`vendor_email`,
123			`vendor_access_token`,
124			`vendor_refresh_token`,
125			`vendor_data`,
126			`created_at`
127			)
128			VALUES
129			(
130			:appUserId,
131			:vendorName,
132			:vendorEmail,
133			:vendorToken,
134			:vendorRefreshToken,
135			:vendorData,
136			NOW()
137			)
138			ON DUPLICATE KEY UPDATE
139			`vendor_access_token` = VALUES(`vendor_access_token`),
140			`vendor_refresh_token` = VALUES(`vendor_refresh_token`),
141			`vendor_data` = VALUES(`vendor_data`),
142			`updated_at` = NOW()
143			SQL;
144			try {
145			$vendorData = json_encode($thirdPartyUser->toArray());
146			$appUserId = $appUser->id();
147			$vendorName = $accessToken->vendor();
148			$vendorEmail = $thirdPartyUser->email();
149			$vendorToken = $accessToken->token();
150			$vendorRefreshToken = $accessToken->getRefreshToken();
151
152			$stmt = $this->dbConnection->prepare($sql);
153			$stmt->bindParam(':appUserId', $appUserId, PDO::PARAM_STR);
154			$stmt->bindParam(':vendorName', $vendorName, PDO::PARAM_STR);
155			$stmt->bindParam(':vendorEmail', $vendorEmail, PDO::PARAM_STR);
156			$stmt->bindParam(':vendorToken', $vendorToken, PDO::PARAM_STR);
157			$stmt->bindParam(':vendorRefreshToken', $vendorRefreshToken, PDO::PARAM_STR);
158			$stmt->bindParam(':vendorData', $vendorData, PDO::PARAM_STR);
159			$stmt->execute();
160			} catch (PDOException $ex) {
161			throw new DataCannotBeStoredException(
162			sprintf("Couldn't save the third party user data. Error : %s", $ex->getMessage()),
163			$ex->getCode(),
164			$ex
165			);
166			}
167			}
168
169			/**
170			* Use this to clean the storage after revoking access to a third party for example.
171			*
172			* @param string $emailAddress email address used within the given vendor system
173			* @param string $vendorName name of the third party where the given email belongs to
174			* @return bool
175			*/
176			public function remove($emailAddress, $vendorName)
177			{
178			$sql = "DELETE FROM `{$this->table}` WHERE `vendor_email` = :email AND `vendor_name` = :vendor LIMIT 1";
179			$stmt = $this->dbConnection->prepare($sql);
180			$stmt->bindParam(':email', $emailAddress, PDO::PARAM_STR);
181			$stmt->bindParam(':vendor', $vendorName, PDO::PARAM_STR);
182			return $stmt->execute();
183			}
184			}
185

tharangakothalawala / sso

PdoThirdPartyStorageRepository::save() A last analyzed 2021-02-15 23:10 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like

PdoThirdPartyStorageRepository::save() A
last analyzed 2021-02-15 23:10 UTC