Pins::likePinMethodCall() - Code Metrics - Inspection of "Edit profile avatar and pins from source" - seregazhuk/php-pinterest-bot - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#98)

by Sergey

created 2016-05-28 13:57 UTC

Pins::likePinMethodCall() A

↳ Parent: Pins

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	2	Features	1

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

<?php

namespace seregazhuk\PinterestBot\Api\Providers;

use Iterator;
use seregazhuk\PinterestBot\Api\Request;
use seregazhuk\PinterestBot\Helpers\UrlHelper;
use seregazhuk\PinterestBot\Helpers\Pagination;
use seregazhuk\PinterestBot\Helpers\Providers\Traits\Searchable;

class Pins extends Provider
{
    use Searchable;

    protected $loginRequired = [
        'like',
        'unLike',
        'comment',
        'deleteComment',
        'create',
        'repin',
        'delete',
    ];

    /**
     * Likes pin with current ID.
     *
     * @param int $pinId
     *
     * @return bool
     */
    public function like($pinId)
    {
        return $this->likePinMethodCall($pinId, UrlHelper::RESOURCE_LIKE_PIN);
    }

    /**
     * Removes your like from pin with current ID.
     *
     * @param int $pinId
     *
     * @return bool
     */
    public function unLike($pinId)
    {
        return $this->likePinMethodCall($pinId, UrlHelper::RESOURCE_UNLIKE_PIN);
    }

    /**
     * Calls Pinterest API to like or unlike Pin by ID.
     *
     * @param int    $pinId
     * @param string $resourceUrl
     *
     * @return bool
     */
    protected function likePinMethodCall($pinId, $resourceUrl)
    {
        return $this->execPostRequest(['pin_id' => $pinId], $resourceUrl);
    }

    /**
     * Write a comment for a pin with current id.
     *
     * @param int    $pinId
     * @param string $text  Comment
     *
     * @return array|bool
     */
    public function comment($pinId, $text)
    {
        $requestOptions = ['pin_id' => $pinId, 'test' => $text];

        return $this->execPostRequest($requestOptions, UrlHelper::RESOURCE_COMMENT_PIN, true);
    }

    /**
     * Delete a comment for a pin with current id.
     *
     * @param int $pinId
     * @param int $commentId
     *
     * @return bool
     */
    public function deleteComment($pinId, $commentId)
    {
        $requestOptions = ['pin_id' => $pinId, 'comment_id' => $commentId];

        return $this->execPostRequest($requestOptions, UrlHelper::RESOURCE_COMMENT_DELETE_PIN);
    }

    /**
     * Create a pin. Returns created pin ID.
     *
     * @param string $imageUrl
     * @param int    $boardId
     * @param string $description
     * @param string $link
     *
     * @return bool|int
     */
    public function create($imageUrl, $boardId, $description = '', $link = '')
    {
        $requestOptions = [
            'method'      => 'scraped',
            'description' => $description,
            'link'        => empty($link) ? $imageUrl : $link,
            'image_url'   => $imageUrl,
            'board_id'    => $boardId,
        ];

        return $this->execPostRequest($requestOptions, UrlHelper::RESOURCE_CREATE_PIN, true);
    }

    /**
     * Edit pin by ID. You can move pin to a new board by setting this board id.
     *
     * @param int $pindId
     * @param string $description
     * @param string $link
     * @param int|null $boardId
     * @return mixed
     */
    public function edit($pindId, $description = '', $link = '', $boardId = null)
    {
        $requestOptions = [
            'id'          => $pindId,
            'description' => $description,
            'link'        => $link,
            'board_id'    => $boardId,
        ];

        return $this->execPostRequest($requestOptions, UrlHelper::RESOURCE_UPDATE_PIN, true);
    }

    /**
     * Moves pin to a new board
     *
     * @param int $pindId
     * @param int $boardId
     * @return mixed
     */
    public function moveToBoard($pindId, $boardId)
    {
        return $this->edit($pindId, '', '', $boardId);
    }
    
    /**
     * Make a repin.
     *
     * @param int    $repinId
     * @param int    $boardId
     * @param string $description
     *
     * @return bool|int
     */
    public function repin($repinId, $boardId, $description = '')
    {
        $requestOptions = [
            'board_id'    => $boardId,
            'description' => stripslashes($description),
            'link'        => stripslashes($repinId),
            'is_video'    => null,
            'pin_id'      => $repinId,
        ];

        return $this->execPostRequest($requestOptions, UrlHelper::RESOURCE_REPIN, true);
    }

    /**
     * Delete a pin.
     *
     * @param int $pinId
     *
     * @return bool
     */
    public function delete($pinId)
    {
        return $this->execPostRequest(['id' => $pinId], UrlHelper::RESOURCE_DELETE_PIN);
    }

    /**
     * Get information of a pin by PinID.
     *
     * @param int $pinId
     *
     * @return array|bool
     */
    public function info($pinId)
    {
        $requestOptions = [
            'field_set_key' => 'detailed',
            'id'            => $pinId,
            'pin_id'        => $pinId,
            'allow_stale'   => true,
        ];

        $data = ['options' => $requestOptions];
        $url = UrlHelper::RESOURCE_PIN_INFO.'?'.Request::createQuery($data);
        $response = $this->request->exec($url);

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

    /**
     * Get pins from a specific url. For example: https://pinterest.com/source/flickr.com/ will return
     * recent Pins from flickr.com
     *
     * @param string $source
     * @param int $batchesLimit
     * @return Iterator
     */
    public function fromSource($source, $batchesLimit = 0)
    {
        return $this->getPaginatedData(
            $source, UrlHelper::RESOURCE_DOMAIN_FEED, "/source/$source/", $batchesLimit
        );
    }

    /**
     * Wrapper over Pagination::getPaginatedData for
     * high-level functions, such as 'following', 'pins' and others.
     *
     * @param string $domain
     * @param string $url
     * @param string $sourceUrl
     * @param int $batchesLimit
     * @return Iterator
     */
    protected function getPaginatedData($domain, $url, $sourceUrl, $batchesLimit)

    {
        $data = [
            ['domain' => $domain],
            $url,
            $sourceUrl,
        ];

        return Pagination::getPaginatedData([$this, 'execPaginatedRequest'], $data, $batchesLimit);
    }
    
    /**
     * @return string
     */
    protected function getScope()
    {
        return 'pins';
    }
}


1		<?php
2
3		namespace seregazhuk\PinterestBot\Api\Providers;
4
5		use Iterator;
6		use seregazhuk\PinterestBot\Api\Request;
7		use seregazhuk\PinterestBot\Helpers\UrlHelper;
8		use seregazhuk\PinterestBot\Helpers\Pagination;
9		use seregazhuk\PinterestBot\Helpers\Providers\Traits\Searchable;
10
11		class Pins extends Provider
12		{
13		use Searchable;
14
15		protected $loginRequired = [
16		'like',
17		'unLike',
18		'comment',
19		'deleteComment',
20		'create',
21		'repin',
22		'delete',
23		];
24
25		/**
26		* Likes pin with current ID.
27		*
28		* @param int $pinId
29		*
30		* @return bool
31		*/
32		public function like($pinId)
33		{
34		return $this->likePinMethodCall($pinId, UrlHelper::RESOURCE_LIKE_PIN);
35		}
36
37		/**
38		* Removes your like from pin with current ID.
39		*
40		* @param int $pinId
41		*
42		* @return bool
43		*/
44		public function unLike($pinId)
45		{
46		return $this->likePinMethodCall($pinId, UrlHelper::RESOURCE_UNLIKE_PIN);
47		}
48
49		/**
50		* Calls Pinterest API to like or unlike Pin by ID.
51		*
52		* @param int $pinId
53		* @param string $resourceUrl
54		*
55		* @return bool
56		*/
57		protected function likePinMethodCall($pinId, $resourceUrl)
58		{
59		return $this->execPostRequest(['pin_id' => $pinId], $resourceUrl);
60		}
61
62		/**
63		* Write a comment for a pin with current id.
64		*
65		* @param int $pinId
66		* @param string $text Comment
67		*
68		* @return array\|bool
69		*/
70		public function comment($pinId, $text)
71		{
72		$requestOptions = ['pin_id' => $pinId, 'test' => $text];
73
74		return $this->execPostRequest($requestOptions, UrlHelper::RESOURCE_COMMENT_PIN, true);
75		}
76
77		/**
78		* Delete a comment for a pin with current id.
79		*
80		* @param int $pinId
81		* @param int $commentId
82		*
83		* @return bool
84		*/
85		public function deleteComment($pinId, $commentId)
86		{
87		$requestOptions = ['pin_id' => $pinId, 'comment_id' => $commentId];
88
89		return $this->execPostRequest($requestOptions, UrlHelper::RESOURCE_COMMENT_DELETE_PIN);
90		}
91
92		/**
93		* Create a pin. Returns created pin ID.
94		*
95		* @param string $imageUrl
96		* @param int $boardId
97		* @param string $description
98		* @param string $link
99		*
100		* @return bool\|int
101		*/
102		public function create($imageUrl, $boardId, $description = '', $link = '')
103		{
104		$requestOptions = [
105		'method' => 'scraped',
106		'description' => $description,
107		'link' => empty($link) ? $imageUrl : $link,
108		'image_url' => $imageUrl,
109		'board_id' => $boardId,
110		];
111
112		return $this->execPostRequest($requestOptions, UrlHelper::RESOURCE_CREATE_PIN, true);
113		}
114
115		/**
116		* Edit pin by ID. You can move pin to a new board by setting this board id.
117		*
118		* @param int $pindId
119		* @param string $description
120		* @param string $link
121		* @param int\|null $boardId
122		* @return mixed
123		*/
124		public function edit($pindId, $description = '', $link = '', $boardId = null)
125		{
126		$requestOptions = [
127		'id' => $pindId,
128		'description' => $description,
129		'link' => $link,
130		'board_id' => $boardId,
131		];
132
133		return $this->execPostRequest($requestOptions, UrlHelper::RESOURCE_UPDATE_PIN, true);
134		}
135
136		/**
137		* Moves pin to a new board
138		*
139		* @param int $pindId
140		* @param int $boardId
141		* @return mixed
142		*/
143		public function moveToBoard($pindId, $boardId)
144		{
145		return $this->edit($pindId, '', '', $boardId);
146		}
147
148		/**
149		* Make a repin.
150		*
151		* @param int $repinId
152		* @param int $boardId
153		* @param string $description
154		*
155		* @return bool\|int
156		*/
157		public function repin($repinId, $boardId, $description = '')
158		{
159		$requestOptions = [
160		'board_id' => $boardId,
161		'description' => stripslashes($description),
162		'link' => stripslashes($repinId),
163		'is_video' => null,
164		'pin_id' => $repinId,
165		];
166
167		return $this->execPostRequest($requestOptions, UrlHelper::RESOURCE_REPIN, true);
168		}
169
170		/**
171		* Delete a pin.
172		*
173		* @param int $pinId
174		*
175		* @return bool
176		*/
177		public function delete($pinId)
178		{
179		return $this->execPostRequest(['id' => $pinId], UrlHelper::RESOURCE_DELETE_PIN);
180		}
181
182		/**
183		* Get information of a pin by PinID.
184		*
185		* @param int $pinId
186		*
187		* @return array\|bool
188		*/
189		public function info($pinId)
190		{
191		$requestOptions = [
192		'field_set_key' => 'detailed',
193		'id' => $pinId,
194		'pin_id' => $pinId,
195		'allow_stale' => true,
196		];
197
198		$data = ['options' => $requestOptions];
199		$url = UrlHelper::RESOURCE_PIN_INFO.'?'.Request::createQuery($data);
200		$response = $this->request->exec($url);
201
202		return $this->response->checkResponse($response);
203		}
204
205		/**
206		* Get pins from a specific url. For example: https://pinterest.com/source/flickr.com/ will return
207		* recent Pins from flickr.com
208		*
209		* @param string $source
210		* @param int $batchesLimit
211		* @return Iterator
212		*/
213		public function fromSource($source, $batchesLimit = 0)
214		{
215		return $this->getPaginatedData(
216		$source, UrlHelper::RESOURCE_DOMAIN_FEED, "/source/$source/", $batchesLimit
217		);
218		}
219
220		/**
221		* Wrapper over Pagination::getPaginatedData for
222		* high-level functions, such as 'following', 'pins' and others.
223		*
224		* @param string $domain
225		* @param string $url
226		* @param string $sourceUrl
227		* @param int $batchesLimit
228		* @return Iterator
229		*/
230	View Code Duplication	protected function getPaginatedData($domain, $url, $sourceUrl, $batchesLimit)
		0 ignored issues – show Duplication introduced 2016-05-28 13:59 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
231		{
232		$data = [
233		['domain' => $domain],
234		$url,
235		$sourceUrl,
236		];
237
238		return Pagination::getPaginatedData([$this, 'execPaginatedRequest'], $data, $batchesLimit);
239		}
240
241		/**
242		* @return string
243		*/
244		protected function getScope()
245		{
246		return 'pins';
247		}
248		}
249

seregazhuk / php-pinterest-bot

Pull Request — master (#98)

Pins::likePinMethodCall() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like