PeclMongoDbThirdPartyStorageRepository::getByAppUser() - Code Metrics - Inspection of "Feature/yahoo support" - tharangakothalawala/sso - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#2)

by Tharanga

created 2019-01-27 19:18 UTC

getByAppUser() A

↳ Parent: PeclMongoDbThirdPartyStorageRepository

Complexity

Conditions	2
Paths	2

Size

Total Lines	19
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	12
nc	2
nop	1
dl	0
loc	19
rs	9.8666
c	0
b	0
f	0

<?php
/**
 * @author Tharanga Kothalawala <[email protected]>
 * @date 27-01-2019
 */

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 MongoDB\BSON\ObjectID;
use MongoDB\Driver\BulkWrite;
use MongoDB\Driver\Exception\Exception;
use MongoDB\Driver\Exception\InvalidArgumentException;
use MongoDB\Driver\Manager as MongoManager;
use MongoDB\Driver\Query;

/**
 * @codeCoverageIgnore
 * @package TSK\SSO\Storage
 *
 * This will connect to a MongoDB database using the pecl/mongodb driver to persist vendor data.
 * The collection will be created on the fly.
 */
class PeclMongoDbThirdPartyStorageRepository implements ThirdPartyStorageRepository
{
    /**
     * @var MongoManager
     */
    private $mongoManager;

    /**
     * @var string name of the database in the MongoDB server
     */
    private $dbName;

    /**
     * @var string name of the collection in the application database
     */
    private $collection;

    /**
     * @param MongoManager $mongoManager
     * @param string $dbName
     * @param string $collection [optional] name of the collection in the MongoDB database
     */
    public function __construct(MongoManager $mongoManager, $dbName, $collection = 'thirdparty_connections')
    {
        $this->mongoManager = $mongoManager;
        $this->dbName = $dbName;
        $this->collection = $collection;
    }

    /**
     * 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)) {
            $cursor = $this->mongoManager->executeQuery(
                $this->collectionName(),
                new Query(array(
                    'vendor_email' => $emailAddress,
                ))
            );
        } else {
            $cursor = $this->mongoManager->executeQuery(
                $this->collectionName(),
                new Query(array(
                    'vendor_email' => $emailAddress,
                    'vendor_name' => $vendorName,
                ))
            );
        }

        foreach ($cursor as $mappedUserDoc) {
            return new MappedUser(
                $mappedUserDoc->app_user_id,
                $mappedUserDoc->vendor_name,
                $mappedUserDoc->vendor_email,
                $mappedUserDoc->vendor_access_token,
                $mappedUserDoc->vendor_data
            );
        }

        return null;
    }

    /**
     * Returns any vendor MappedUser list for a given Application user.
     *
     * @param AppUser $appUser
     * @return MappedUser[]
     * @throws InvalidArgumentException
     */
    public function getByAppUser(AppUser $appUser)
    {
        $cursor = $this->mongoManager->executeQuery(
            $this->collectionName(),
            new Query(array('app_user_id' => $appUser->id()))
        );

        $connections = array();
        foreach ($cursor as $mappedUserDoc) {
            $connections[] = new MappedUser(
                $mappedUserDoc->app_user_id,
                $mappedUserDoc->vendor_name,
                $mappedUserDoc->vendor_email,
                $mappedUserDoc->vendor_access_token,
                $mappedUserDoc->vendor_data
            );
        }

        return $connections;
    }

    /**
     * @param AppUser $appUser
     * @param ThirdPartyUser $thirdPartyUser
     * @param CommonAccessToken $accessToken
     * @throws DataCannotBeStoredException
     */
    public function save(
        AppUser $appUser,
        ThirdPartyUser $thirdPartyUser,
        CommonAccessToken $accessToken
    ) {
        $isUserHasConnection = $this->isUserHasConnection(
            $appUser->id(),
            $accessToken->vendor(),
            $thirdPartyUser->email()
        );

        $bulk = new BulkWrite();

        if ($isUserHasConnection) {
            $bulk->update(
                array(
                    'app_user_id' => $appUser->id(),
                    'vendor_name' => $thirdPartyUser->email(),
                    'vendor_email' => $accessToken->token(),
                ),
                array(
                    '$set' => array(
                        'vendor_access_token' => $accessToken->token(),
                        'vendor_data' => json_encode($thirdPartyUser->toArray()),
                    ),
                )
            );
        } else {
            $bulk->insert(array(
                '_id' => new ObjectID(),
                'app_user_id' => $appUser->id(),
                'vendor_name' => $accessToken->vendor(),
                'vendor_email' => $thirdPartyUser->email(),
                'vendor_access_token' => $accessToken->token(),
                'vendor_data' => json_encode($thirdPartyUser->toArray()),
                'created_at' => date('Y-m-d H:i:s'),
            ));
        }

        try {
            $this->mongoManager->executeBulkWrite($this->collectionName(), $bulk);
        } catch (Exception $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)
    {
        $bulk = new BulkWrite();
        $bulk->delete(array('vendor_email' => $emailAddress, 'vendor_name' => $vendorName));

        $writeResult = $this->mongoManager->executeBulkWrite($this->collectionName(), $bulk);

        return $writeResult->getDeletedCount() === 1;
    }

    /**
     * Check if the given user has a mapping to a requested vendor connection.
     *
     * @param string $appUserId
     * @param string $vendorName
     * @param string $vendorEmail
     * @return bool
     */
    private function isUserHasConnection($appUserId, $vendorName, $vendorEmail)
    {
        $cursor = $this->mongoManager->executeQuery(
            $this->collectionName(),
            new Query(array(
                'app_user_id' => $appUserId,
                'vendor_name' => $vendorName,
                'vendor_email' => $vendorEmail,
            ))
        );

        foreach ($cursor as $_) {
            return true;
        }

        return false;
    }

    /**
     * Returns a namespaced collection name.
     *
     * @return string
     */
    private function collectionName()
    {
        return sprintf('%s.%s', $this->dbName, $this->collection);
    }
}


1			<?php
2			/**
3			* @author Tharanga Kothalawala <[email protected]>
4			* @date 27-01-2019
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 MongoDB\BSON\ObjectID;
14			use MongoDB\Driver\BulkWrite;
15			use MongoDB\Driver\Exception\Exception;
16			use MongoDB\Driver\Exception\InvalidArgumentException;
17			use MongoDB\Driver\Manager as MongoManager;
18			use MongoDB\Driver\Query;
19
20			/**
21			* @codeCoverageIgnore
22			* @package TSK\SSO\Storage
23			*
24			* This will connect to a MongoDB database using the pecl/mongodb driver to persist vendor data.
25			* The collection will be created on the fly.
26			*/
27			class PeclMongoDbThirdPartyStorageRepository implements ThirdPartyStorageRepository
28			{
29			/**
30			* @var MongoManager
31			*/
32			private $mongoManager;
33
34			/**
35			* @var string name of the database in the MongoDB server
36			*/
37			private $dbName;
38
39			/**
40			* @var string name of the collection in the application database
41			*/
42			private $collection;
43
44			/**
45			* @param MongoManager $mongoManager
46			* @param string $dbName
47			* @param string $collection [optional] name of the collection in the MongoDB database
48			*/
49			public function __construct(MongoManager $mongoManager, $dbName, $collection = 'thirdparty_connections')
50			{
51			$this->mongoManager = $mongoManager;
52			$this->dbName = $dbName;
53			$this->collection = $collection;
54			}
55
56			/**
57			* Returns a mapped full user record for a given vendor email address or null.
58			*
59			* @param string $emailAddress email address used within the given vendor system
60			* @param string\|null $vendorName [optional] name of the third party vendor for vendor filtering
61			* @return MappedUser\|null
62			*/
63			public function getUser($emailAddress, $vendorName = null)
64			{
65			if (is_null($vendorName)) {
66			$cursor = $this->mongoManager->executeQuery(
67			$this->collectionName(),
68			new Query(array(
69			'vendor_email' => $emailAddress,
70			))
71			);
72			} else {
73			$cursor = $this->mongoManager->executeQuery(
74			$this->collectionName(),
75			new Query(array(
76			'vendor_email' => $emailAddress,
77			'vendor_name' => $vendorName,
78			))
79			);
80			}
81
82			foreach ($cursor as $mappedUserDoc) {
83			return new MappedUser(
84			$mappedUserDoc->app_user_id,
85			$mappedUserDoc->vendor_name,
86			$mappedUserDoc->vendor_email,
87			$mappedUserDoc->vendor_access_token,
88			$mappedUserDoc->vendor_data
89			);
90			}
91
92			return null;
93			}
94
95			/**
96			* Returns any vendor MappedUser list for a given Application user.
97			*
98			* @param AppUser $appUser
99			* @return MappedUser[]
100			* @throws InvalidArgumentException
101			*/
102			public function getByAppUser(AppUser $appUser)
103			{
104			$cursor = $this->mongoManager->executeQuery(
105			$this->collectionName(),
106			new Query(array('app_user_id' => $appUser->id()))
107			);
108
109			$connections = array();
110			foreach ($cursor as $mappedUserDoc) {
111			$connections[] = new MappedUser(
112			$mappedUserDoc->app_user_id,
113			$mappedUserDoc->vendor_name,
114			$mappedUserDoc->vendor_email,
115			$mappedUserDoc->vendor_access_token,
116			$mappedUserDoc->vendor_data
117			);
118			}
119
120			return $connections;
121			}
122
123			/**
124			* @param AppUser $appUser
125			* @param ThirdPartyUser $thirdPartyUser
126			* @param CommonAccessToken $accessToken
127			* @throws DataCannotBeStoredException
128			*/
129			public function save(
130			AppUser $appUser,
131			ThirdPartyUser $thirdPartyUser,
132			CommonAccessToken $accessToken
133			) {
134			$isUserHasConnection = $this->isUserHasConnection(
135			$appUser->id(),
136			$accessToken->vendor(),
137			$thirdPartyUser->email()
138			);
139
140			$bulk = new BulkWrite();
141
142			if ($isUserHasConnection) {
143			$bulk->update(
144			array(
145			'app_user_id' => $appUser->id(),
146			'vendor_name' => $thirdPartyUser->email(),
147			'vendor_email' => $accessToken->token(),
148			),
149			array(
150			'$set' => array(
151			'vendor_access_token' => $accessToken->token(),
152			'vendor_data' => json_encode($thirdPartyUser->toArray()),
153			),
154			)
155			);
156			} else {
157			$bulk->insert(array(
158			'_id' => new ObjectID(),
159			'app_user_id' => $appUser->id(),
160			'vendor_name' => $accessToken->vendor(),
161			'vendor_email' => $thirdPartyUser->email(),
162			'vendor_access_token' => $accessToken->token(),
163			'vendor_data' => json_encode($thirdPartyUser->toArray()),
164			'created_at' => date('Y-m-d H:i:s'),
165			));
166			}
167
168			try {
169			$this->mongoManager->executeBulkWrite($this->collectionName(), $bulk);
170			} catch (Exception $ex) {
171			throw new DataCannotBeStoredException(
172			sprintf("Couldn't save the third party user data. Error : %s", $ex->getMessage()),
173			$ex->getCode(),
174			$ex
175			);
176			}
177			}
178
179			/**
180			* Use this to clean the storage after revoking access to a third party for example.
181			*
182			* @param string $emailAddress email address used within the given vendor system
183			* @param string $vendorName name of the third party where the given email belongs to
184			* @return bool
185			*/
186			public function remove($emailAddress, $vendorName)
187			{
188			$bulk = new BulkWrite();
189			$bulk->delete(array('vendor_email' => $emailAddress, 'vendor_name' => $vendorName));
190
191			$writeResult = $this->mongoManager->executeBulkWrite($this->collectionName(), $bulk);
192
193			return $writeResult->getDeletedCount() === 1;
194			}
195
196			/**
197			* Check if the given user has a mapping to a requested vendor connection.
198			*
199			* @param string $appUserId
200			* @param string $vendorName
201			* @param string $vendorEmail
202			* @return bool
203			*/
204			private function isUserHasConnection($appUserId, $vendorName, $vendorEmail)
205			{
206			$cursor = $this->mongoManager->executeQuery(
207			$this->collectionName(),
208			new Query(array(
209			'app_user_id' => $appUserId,
210			'vendor_name' => $vendorName,
211			'vendor_email' => $vendorEmail,
212			))
213			);
214
215			foreach ($cursor as $_) {
216			return true;
217			}
218
219			return false;
220			}
221
222			/**
223			* Returns a namespaced collection name.
224			*
225			* @return string
226			*/
227			private function collectionName()
228			{
229			return sprintf('%s.%s', $this->dbName, $this->collection);
230			}
231			}
232

tharangakothalawala / sso

Pull Request — master (#2)

getByAppUser() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like