Pinners::pins() - Code Metrics - Inspection of "Pagination refactoring" - seregazhuk/php-pinterest-bot - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#46)

by Sergey

created 2016-01-29 05:55 UTC

Pinners::pins() A

↳ Parent: Pinners

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	0	Features	0

Metric	Value
c	3
b	0
f	0
dl	0
loc	6
rs	9.4285
cc	1
eloc	3
nc	1
nop	2

<?php

namespace seregazhuk\PinterestBot\Api\Providers;

use Iterator;
use LogicException;
use seregazhuk\PinterestBot\Api\Request;
use seregazhuk\PinterestBot\Helpers\Pagination;
use seregazhuk\PinterestBot\Helpers\Providers\Traits\FollowersTrait;
use seregazhuk\PinterestBot\Helpers\UrlHelper;
use seregazhuk\PinterestBot\Helpers\Requests\PinnerHelper;
use seregazhuk\PinterestBot\Helpers\Providers\Traits\SearchTrait;
use seregazhuk\PinterestBot\Helpers\Providers\Traits\FollowTrait;

class Pinners extends Provider
{
    use SearchTrait, FollowTrait, FollowersTrait;

    /**
     * Get different user data, for example, followers, following, pins.
     * Collects data while paginating with bookmarks through pinterest results.
     * Return array. Key data - for results and key bookmarks - for pagination.
     *
     * @param string $username
     * @param string $url
     * @param string $sourceUrl
     * @param array $bookmarks
     * @return array
     */
    public function getUserData($username, $url, $sourceUrl, $bookmarks = [])
    {
        $data = ['options' => ['username' => $username]];
        $get = Request::createRequestData($data, $sourceUrl, $bookmarks);
        $getString = UrlHelper::buildRequestString($get);
        $response = $this->request->exec($url.'?'.$getString);

        return $this->response->getPaginationData($response);
    }

    /**
     * Get user info
     * If username param is not specified, will
     * return info for logged user
     *
     * @param string $username
     * @return null|array
     */
    public function info($username)
    {
        $res = $this->getUserData($username, UrlHelper::RESOURCE_USER_INFO, "/$username/");

        return isset($res['data']) ? $res['data'] : null;
    }

    /**
     * Get pinner followers
     *
     * @param string $username
     * @param int $batchesLimit
     * @return Iterator
     */
    public function followers($username, $batchesLimit = 0)
    {
        return $this->getPaginatedData(
            $username, UrlHelper::RESOURCE_USER_FOLLOWERS, "/$username/followers/", $batchesLimit
        );
    }

    /**
     * Get pinner following other pinners
     *
     * @param string $username
     * @param int $batchesLimit
     * @return Iterator
     */
    public function following($username, $batchesLimit = 0)
    {
        return $this->getPaginatedData(
            $username, UrlHelper::RESOURCE_USER_FOLLOWING, "/$username/following/", $batchesLimit
        );
    }

    /**
     * Get pinner pins
     *
     * @param string $username
     * @param int $batchesLimit
     * @return Iterator
     */
    public function pins($username, $batchesLimit = 0)
    {
        return $this->getPaginatedData(
            $username, UrlHelper::RESOURCE_USER_PINS, "/$username/$username/", $batchesLimit
        );
    }

    /**
     * Login as pinner
     *
     * @param string $username
     * @param string $password
     * @return bool
     */
    public function login($username, $password)
    {
        if ($this->request->isLoggedIn()) {
            return true;
        }

        $this->_checkCredentials($username, $password);

        $post = PinnerHelper::createLoginRequest($username, $password);
        $postString = UrlHelper::buildRequestString($post);
        $this->request->clearToken();
        $result = $this->response->checkErrorInResponse($this->request->exec(UrlHelper::RESOURCE_LOGIN, $postString));
        if ($result) {
            $this->request->setLoggedIn();
        }

        return $result;
    }

    /**
     * Validates password and login
     * @param string $username
     * @param string $password
     */
    protected function _checkCredentials($username, $password)
    {
        if ( ! $username || ! $password) {
            throw new LogicException('You must set username and password to login.');
        }
    }

    /**
     * Search scope
     *
     * @return string
     */
    protected function getScope()
    {
        return 'people';
    }

    protected function getEntityIdName()
    {
        return Request::PINNER_ENTITY_ID;
    }

    /**
     * Follow resource
     *
     * @return string
     */
    protected function getFollowUrl()
    {
        return UrlHelper::RESOURCE_FOLLOW_USER;
    }

    /**
     * UnFollow resource
     * @return string
     */
    protected function getUnfFollowUrl()
    {
        return UrlHelper::RESOURCE_UNFOLLOW_USER;
    }

    /**
     * @param string $username
     * @param string $url
     * @param string $sourceUrl
     * @param integer $batchesLimit
     * @return Iterator
     */
    protected function getPaginatedData($username, $url, $sourceUrl, $batchesLimit)
    {
        $data = [
            ['username' => $username],
            $url,
            $sourceUrl
        ];

        return Pagination::getPaginatedData([$this, 'getData'], $data, $batchesLimit);
    }
}


1			<?php
2
3			namespace seregazhuk\PinterestBot\Api\Providers;
4
5			use Iterator;
6			use LogicException;
7			use seregazhuk\PinterestBot\Api\Request;
8			use seregazhuk\PinterestBot\Helpers\Pagination;
9			use seregazhuk\PinterestBot\Helpers\Providers\Traits\FollowersTrait;
10			use seregazhuk\PinterestBot\Helpers\UrlHelper;
11			use seregazhuk\PinterestBot\Helpers\Requests\PinnerHelper;
12			use seregazhuk\PinterestBot\Helpers\Providers\Traits\SearchTrait;
13			use seregazhuk\PinterestBot\Helpers\Providers\Traits\FollowTrait;
14
15			class Pinners extends Provider
16			{
17			use SearchTrait, FollowTrait, FollowersTrait;
18
19			/**
20			* Get different user data, for example, followers, following, pins.
21			* Collects data while paginating with bookmarks through pinterest results.
22			* Return array. Key data - for results and key bookmarks - for pagination.
23			*
24			* @param string $username
25			* @param string $url
26			* @param string $sourceUrl
27			* @param array $bookmarks
28			* @return array
29			*/
30			public function getUserData($username, $url, $sourceUrl, $bookmarks = [])
31			{
32			$data = ['options' => ['username' => $username]];
33			$get = Request::createRequestData($data, $sourceUrl, $bookmarks);
34			$getString = UrlHelper::buildRequestString($get);
35			$response = $this->request->exec($url.'?'.$getString);
36
37			return $this->response->getPaginationData($response);
38			}
39
40			/**
41			* Get user info
42			* If username param is not specified, will
43			* return info for logged user
44			*
45			* @param string $username
46			* @return null\|array
47			*/
48			public function info($username)
49			{
50			$res = $this->getUserData($username, UrlHelper::RESOURCE_USER_INFO, "/$username/");
51
52			return isset($res['data']) ? $res['data'] : null;
53			}
54
55			/**
56			* Get pinner followers
57			*
58			* @param string $username
59			* @param int $batchesLimit
60			* @return Iterator
61			*/
62			public function followers($username, $batchesLimit = 0)
63			{
64			return $this->getPaginatedData(
65			$username, UrlHelper::RESOURCE_USER_FOLLOWERS, "/$username/followers/", $batchesLimit
66			);
67			}
68
69			/**
70			* Get pinner following other pinners
71			*
72			* @param string $username
73			* @param int $batchesLimit
74			* @return Iterator
75			*/
76			public function following($username, $batchesLimit = 0)
77			{
78			return $this->getPaginatedData(
79			$username, UrlHelper::RESOURCE_USER_FOLLOWING, "/$username/following/", $batchesLimit
80			);
81			}
82
83			/**
84			* Get pinner pins
85			*
86			* @param string $username
87			* @param int $batchesLimit
88			* @return Iterator
89			*/
90			public function pins($username, $batchesLimit = 0)
91			{
92			return $this->getPaginatedData(
93			$username, UrlHelper::RESOURCE_USER_PINS, "/$username/$username/", $batchesLimit
94			);
95			}
96
97			/**
98			* Login as pinner
99			*
100			* @param string $username
101			* @param string $password
102			* @return bool
103			*/
104			public function login($username, $password)
105			{
106			if ($this->request->isLoggedIn()) {
107			return true;
108			}
109
110			$this->_checkCredentials($username, $password);
111
112			$post = PinnerHelper::createLoginRequest($username, $password);
113			$postString = UrlHelper::buildRequestString($post);
114			$this->request->clearToken();
115			$result = $this->response->checkErrorInResponse($this->request->exec(UrlHelper::RESOURCE_LOGIN, $postString));
116			if ($result) {
117			$this->request->setLoggedIn();
118			}
119
120			return $result;
121			}
122
123			/**
124			* Validates password and login
125			* @param string $username
126			* @param string $password
127			*/
128			protected function _checkCredentials($username, $password)
129			{
130			if ( ! $username \|\| ! $password) {
131			throw new LogicException('You must set username and password to login.');
132			}
133			}
134
135			/**
136			* Search scope
137			*
138			* @return string
139			*/
140			protected function getScope()
141			{
142			return 'people';
143			}
144
145			protected function getEntityIdName()
146			{
147			return Request::PINNER_ENTITY_ID;
148			}
149
150			/**
151			* Follow resource
152			*
153			* @return string
154			*/
155			protected function getFollowUrl()
156			{
157			return UrlHelper::RESOURCE_FOLLOW_USER;
158			}
159
160			/**
161			* UnFollow resource
162			* @return string
163			*/
164			protected function getUnfFollowUrl()
165			{
166			return UrlHelper::RESOURCE_UNFOLLOW_USER;
167			}
168
169			/**
170			* @param string $username
171			* @param string $url
172			* @param string $sourceUrl
173			* @param integer $batchesLimit
174			* @return Iterator
175			*/
176			protected function getPaginatedData($username, $url, $sourceUrl, $batchesLimit)
177			{
178			$data = [
179			['username' => $username],
180			$url,
181			$sourceUrl
182			];
183
184			return Pagination::getPaginatedData([$this, 'getData'], $data, $batchesLimit);
185			}
186			}
187

seregazhuk / php-pinterest-bot

Pull Request — master (#46)

Pinners::pins() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like