UrlBuilder::fixEncoding() - Code Metrics - Inspection of "23259a702560f2051f1b3d21992f746f7461c288" - seregazhuk/php-pinterest-bot - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (23259a)

by Sergey

created 2018-02-23 16:11 UTC

UrlBuilder::fixEncoding() A

↳ Parent: UrlBuilder

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace seregazhuk\PinterestBot\Helpers;

/**
 * Class UrlHelper.
 */
class UrlBuilder
{
    /**
     * Login
     */
    const RESOURCE_LOGIN = 'resource/UserSessionResource/create/';

    /**
     * Password
     */
    const RESOURCE_RESET_PASSWORD_SEND_LINK = 'resource/UserResetPasswordResource/create/';
    const RESOURCE_RESET_PASSWORD_UPDATE = 'resource/ResetPasswordFromEmailResource/update/';

    /**
     * Boards
     */
    const RESOURCE_GET_BOARDS = 'resource/BoardsResource/get/';
    const RESOURCE_GET_BOARD = 'resource/BoardResource/get/';
    const RESOURCE_GET_BOARD_FEED = 'resource/BoardFeedResource/get/';
    const RESOURCE_PROFILE_BOARDS = 'resource/ProfileBoardsResource/get/';
    const RESOURCE_FOLLOW_BOARD = 'resource/BoardFollowResource/create/';
    const RESOURCE_UNFOLLOW_BOARD = 'resource/BoardFollowResource/delete/';
    const RESOURCE_DELETE_BOARD = 'resource/BoardResource/delete/';
    const RESOURCE_CREATE_BOARD = 'resource/BoardResource/create/';
    const RESOURCE_UPDATE_BOARD = 'resource/BoardResource/update/';
    const RESOURCE_BOARD_FOLLOWERS = 'resource/BoardFollowersResource/get/';
    const RESOURCE_FOLLOWING_BOARDS = 'resource/BoardFollowingResource/get/';
    const RESOURCE_TITLE_SUGGESTIONS = 'resource/BoardTitleSuggestionsResource/get';
    const RESOURCE_BOARDS_INVITES = 'resource/BoardInvitesResource/get/';
    const RESOURCE_CREATE_USER_ID_INVITE = 'resource/BoardInviteResource/create';
    const RESOURCE_CREATE_EMAIL_INVITE = 'resource/BoardEmailInviteResource/create/';
    const RESOURCE_ACCEPT_INVITE = 'resource/BoardInviteResource/update/';
    const RESOURCE_DELETE_INVITE = 'resource/BoardInviteResource/delete/';

    /**
     * Board section
     */
    const RESOURCE_GET_BOARD_SECTIONS = 'resource/BoardSectionsResource/get/';
    const RESOURCE_ADD_BOARD_SECTION = 'resource/BoardSectionResource/create/';
    const RESOURCE_EDIT_BOARD_SECTION = 'resource/BoardSectionEditResource/create/';
    const RESOURCE_DELETE_BOARD_SECTION = 'resource/BoardSectionEditResource/delete/';

    /**
     * Pins
     */
    const RESOURCE_CREATE_PIN = 'resource/PinResource/create/';
    const RESOURCE_UPDATE_PIN = 'resource/PinResource/update/';
    const RESOURCE_REPIN = 'resource/RepinResource/create/';
    const RESOURCE_USER_FOLLOWERS = 'resource/UserFollowersResource/get/';
    const RESOURCE_DELETE_PIN = 'resource/PinResource/delete/';
    const RESOURCE_LIKE_PIN = 'resource/PinLikeResource/create/';
    const RESOURCE_UNLIKE_PIN = 'resource/PinLikeResource/delete/';
    const RESOURCE_COMMENT_PIN = 'resource/PinCommentResource/create/';
    const RESOURCE_COMMENT_DELETE_PIN = 'resource/PinCommentResource/delete/';
    const RESOURCE_PIN_INFO = 'resource/PinResource/get/';
    const RESOURCE_DOMAIN_FEED = 'resource/DomainFeedResource/get/';
    const RESOURCE_ACTIVITY = 'resource/AggregatedActivityFeedResource/get/';
    const RESOURCE_USER_FEED = 'resource/UserHomefeedResource/get/';
    const RESOURCE_RELATED_PINS = 'resource/RelatedPinFeedResource/get/';
    const RESOURCE_VISUAL_SIMILAR_PINS = 'resource/VisualLiveSearchResource/get/';
    const RESOURCE_BULK_COPY = 'resource/BulkEditResource/create/';
    const RESOURCE_BULK_MOVE = 'resource/BulkEditResource/update/';
    const RESOURCE_BULK_DELETE = 'resource/BulkEditResource/delete/';
    const RESOURCE_EXPLORE_PINS = 'resource/ExploreSectionFeedResource/get/';
    const RESOURCE_PIN_ANALYTICS = 'resource/OnPinAnalyticsResource/get/';
    const RESOURCE_TRY_PIN_CREATE = 'resource/DidItActivityResource/create/';
    const RESOURCE_TRY_PIN_EDIT = 'resource/DidItActivityResource/update/';
    const RESOURCE_TRY_PIN_DELETE = 'resource/DidItActivityResource/delete/';
    const RESOURCE_TRY_PIN_IMAGE_UPLOAD = 'resource/DidItImageUploadResource/create/';
    const RESOURCE_SHARE_VIA_SOCIAL = 'resource/CreateExternalInviteResource/create/';

    /**
     * Pinners
     */
    const RESOURCE_FOLLOW_USER = 'resource/UserFollowResource/create/';
    const RESOURCE_UNFOLLOW_USER = 'resource/UserFollowResource/delete/';
    const RESOURCE_USER_INFO = 'resource/UserResource/get/';
    const RESOURCE_USER_FOLLOWING = 'resource/UserFollowingResource/get/';
    const RESOURCE_USER_PINS = 'resource/UserPinsResource/get/';
    const RESOURCE_USER_LIKES = 'resource/UserLikesResource/get/';
    const RESOURCE_USER_TRIED = 'resource/DidItUserFeedResource/get/';

    const RESOURCE_CONTACTS_REQUESTS = 'resource/ContactRequestsResource/get';
    const RESOURCE_CONTACT_REQUEST_ACCEPT = 'resource/ContactRequestAcceptResource/update/';
    const RESOURCE_CONTACT_REQUEST_IGNORE = 'resource/ContactRequestIgnoreResource/delete/';

    /**
     * Search
     */
    const RESOURCE_SEARCH = 'resource/BaseSearchResource/get/';
    const RESOURCE_SEARCH_WITH_PAGINATION = 'resource/SearchResource/get/';
    const RESOURCE_TYPE_AHEAD_SUGGESTIONS = 'resource/AdvancedTypeaheadResource/get';
    const RESOURCE_HASHTAG_TYPE_AHEAD_SUGGESTIONS = 'resource/HashtagTypeaheadResource/get';

    /**
     * Interests.
     */
    const RESOURCE_FOLLOW_INTEREST = 'resource/InterestFollowResource/create/';
    const RESOURCE_UNFOLLOW_INTEREST = 'resource/InterestFollowResource/delete/';
    const RESOURCE_FOLLOWING_INTERESTS = 'resource/InterestFollowingResource/get/';

    /**
     * Conversations.
     */
    const RESOURCE_SEND_MESSAGE = 'resource/ConversationsResource/create/';
    const RESOURCE_GET_CONVERSATION_MESSAGES = 'resource/ConversationMessagesResource/get/';
    const RESOURCE_GET_LAST_CONVERSATIONS = 'resource/ConversationsResource/get/';

    /**
     * UserSettings
     */
    const RESOURCE_UPDATE_USER_SETTINGS = 'resource/UserSettingsResource/update/';
    const RESOURCE_GET_USER_SETTINGS = 'resource/UserSettingsResource/get/';
    const RESOURCE_CHANGE_PASSWORD = 'resource/UserPasswordResource/update/';
    const RESOURCE_DEACTIVATE_ACCOUNT = 'resource/DeactivateAccountResource/create/';
    const RESOURCE_BLOCK_USER = 'resource/UserBlockResource/create/';
    const RESOURCE_CLEAR_SEARCH_HISTORY = 'resource/TypeaheadClearRecentResource/delete/';
    const RESOURCE_SESSIONS_HISTORY = 'resource/UserSessionStoreResource/get/';
    const RESOURCE_AVAILABLE_LOCALES = 'resource/LocalesResource/get/';
    const RESOURCE_AVAILABLE_COUNTRIES = 'resource/CountriesResource/get/';
    const RESOURCE_AVAILABLE_ACCOUNT_TYPES = 'resource/BusinessTypesResource/get/';

    /**
     * News
     */
    const RESOURCE_GET_LATEST_NEWS = 'resource/NetworkStoriesResource/get/';
    const RESOURCE_GET_NOTIFICATIONS = 'resource/NewsHubResource/get/';

    /**
     * Registration
     */
    const RESOURCE_CREATE_REGISTER = 'resource/UserRegisterResource/create/';
    const RESOURCE_CHECK_EMAIL = 'resource/EmailExistsResource/get/';
    const RESOURCE_SET_ORIENTATION = 'resource/OrientationContextResource/create/';
    const RESOURCE_UPDATE_REGISTRATION_TRACK = 'resource/UserRegisterTrackActionResource/update/';
    const RESOURCE_REGISTRATION_COMPLETE = 'resource/UserExperienceCompletedResource/update/';
    const RESOURCE_CONVERT_TO_BUSINESS = 'resource/PartnerResource/update/';

    /**
     * Uploads
     */
    const IMAGE_UPLOAD = 'upload-image/';

    /**
     * Categories
     */
    const RESOURCE_GET_CATEGORIES = 'resource/CategoriesResource/get/';
    const RESOURCE_GET_CATEGORY = 'resource/CategoryResource/get/';
    const RESOURCE_GET_CATEGORIES_RELATED = 'resource/RelatedInterestsResource/get/';
    const RESOURCE_GET_CATEGORY_FEED = 'resource/CategoryFeedResource/get/';

    /**
     * Topics
     */
    const RESOURCE_GET_TOPIC_FEED = 'resource/TopicFeedResource/get/';
    const RESOURCE_GET_TOPIC = 'resource/TopicResource/get/';
    const RESOURCE_EXPLORE_SECTIONS = 'resource/ExploreSectionsResource/get/';

    /**
     * Invite
     */
    const RESOURCE_INVITE = 'resource/EmailInviteSentResource/create/';

    const URL_BASE = 'https://uk.pinterest.com/';
    const HOST = 'uk.pinterest.com';

    const FOLLOWING_INTERESTS = 'interests';
    const FOLLOWING_PEOPLE = 'people';
    const FOLLOWING_BOARDS = 'boards';

    /**
     * @param array $request
     *
     * @return mixed
     */
    public static function buildRequestString($request)
    {
        return self::fixEncoding(http_build_query($request));
    }

    /**
     * Appends resource url to base pinterest url.
     *
     * @param string $resourceUrl
     *
     * @return string
     */
    public static function buildApiUrl($resourceUrl)
    {
        if (strpos($resourceUrl, 'http') !== false) {
            return $resourceUrl;
        }

        return self::URL_BASE . $resourceUrl;
    }

    /**
     * Fix URL-encoding for some characters.
     *
     * @param string $str
     *
     * @return string
     */
    public static function fixEncoding($str)
    {
        return str_replace(
            ['%28', '%29', '%7E'], ['(', ')', '~'], $str
        );
    }


    /**
     * @param string $type
     * @return string|null
     */
    public static function getFollowingUrlByType($type)
    {
        $urls = [
            self::FOLLOWING_INTERESTS => self::RESOURCE_FOLLOWING_INTERESTS,
            self::FOLLOWING_BOARDS    => self::RESOURCE_FOLLOWING_BOARDS,
            self::FOLLOWING_PEOPLE    => self::RESOURCE_USER_FOLLOWING,
        ];

        if (array_key_exists($type, $urls)) {
            return $urls[$type];
        }

        return null;
    }
}


1			<?php
2
3			namespace seregazhuk\PinterestBot\Helpers;
4
5			/**
6			* Class UrlHelper.
7			*/
8			class UrlBuilder
9			{
10			/**
11			* Login
12			*/
13			const RESOURCE_LOGIN = 'resource/UserSessionResource/create/';
14
15			/**
16			* Password
17			*/
18			const RESOURCE_RESET_PASSWORD_SEND_LINK = 'resource/UserResetPasswordResource/create/';
19			const RESOURCE_RESET_PASSWORD_UPDATE = 'resource/ResetPasswordFromEmailResource/update/';
20
21			/**
22			* Boards
23			*/
24			const RESOURCE_GET_BOARDS = 'resource/BoardsResource/get/';
25			const RESOURCE_GET_BOARD = 'resource/BoardResource/get/';
26			const RESOURCE_GET_BOARD_FEED = 'resource/BoardFeedResource/get/';
27			const RESOURCE_PROFILE_BOARDS = 'resource/ProfileBoardsResource/get/';
28			const RESOURCE_FOLLOW_BOARD = 'resource/BoardFollowResource/create/';
29			const RESOURCE_UNFOLLOW_BOARD = 'resource/BoardFollowResource/delete/';
30			const RESOURCE_DELETE_BOARD = 'resource/BoardResource/delete/';
31			const RESOURCE_CREATE_BOARD = 'resource/BoardResource/create/';
32			const RESOURCE_UPDATE_BOARD = 'resource/BoardResource/update/';
33			const RESOURCE_BOARD_FOLLOWERS = 'resource/BoardFollowersResource/get/';
34			const RESOURCE_FOLLOWING_BOARDS = 'resource/BoardFollowingResource/get/';
35			const RESOURCE_TITLE_SUGGESTIONS = 'resource/BoardTitleSuggestionsResource/get';
36			const RESOURCE_BOARDS_INVITES = 'resource/BoardInvitesResource/get/';
37			const RESOURCE_CREATE_USER_ID_INVITE = 'resource/BoardInviteResource/create';
38			const RESOURCE_CREATE_EMAIL_INVITE = 'resource/BoardEmailInviteResource/create/';
39			const RESOURCE_ACCEPT_INVITE = 'resource/BoardInviteResource/update/';
40			const RESOURCE_DELETE_INVITE = 'resource/BoardInviteResource/delete/';
41
42			/**
43			* Board section
44			*/
45			const RESOURCE_GET_BOARD_SECTIONS = 'resource/BoardSectionsResource/get/';
46			const RESOURCE_ADD_BOARD_SECTION = 'resource/BoardSectionResource/create/';
47			const RESOURCE_EDIT_BOARD_SECTION = 'resource/BoardSectionEditResource/create/';
48			const RESOURCE_DELETE_BOARD_SECTION = 'resource/BoardSectionEditResource/delete/';
49
50			/**
51			* Pins
52			*/
53			const RESOURCE_CREATE_PIN = 'resource/PinResource/create/';
54			const RESOURCE_UPDATE_PIN = 'resource/PinResource/update/';
55			const RESOURCE_REPIN = 'resource/RepinResource/create/';
56			const RESOURCE_USER_FOLLOWERS = 'resource/UserFollowersResource/get/';
57			const RESOURCE_DELETE_PIN = 'resource/PinResource/delete/';
58			const RESOURCE_LIKE_PIN = 'resource/PinLikeResource/create/';
59			const RESOURCE_UNLIKE_PIN = 'resource/PinLikeResource/delete/';
60			const RESOURCE_COMMENT_PIN = 'resource/PinCommentResource/create/';
61			const RESOURCE_COMMENT_DELETE_PIN = 'resource/PinCommentResource/delete/';
62			const RESOURCE_PIN_INFO = 'resource/PinResource/get/';
63			const RESOURCE_DOMAIN_FEED = 'resource/DomainFeedResource/get/';
64			const RESOURCE_ACTIVITY = 'resource/AggregatedActivityFeedResource/get/';
65			const RESOURCE_USER_FEED = 'resource/UserHomefeedResource/get/';
66			const RESOURCE_RELATED_PINS = 'resource/RelatedPinFeedResource/get/';
67			const RESOURCE_VISUAL_SIMILAR_PINS = 'resource/VisualLiveSearchResource/get/';
68			const RESOURCE_BULK_COPY = 'resource/BulkEditResource/create/';
69			const RESOURCE_BULK_MOVE = 'resource/BulkEditResource/update/';
70			const RESOURCE_BULK_DELETE = 'resource/BulkEditResource/delete/';
71			const RESOURCE_EXPLORE_PINS = 'resource/ExploreSectionFeedResource/get/';
72			const RESOURCE_PIN_ANALYTICS = 'resource/OnPinAnalyticsResource/get/';
73			const RESOURCE_TRY_PIN_CREATE = 'resource/DidItActivityResource/create/';
74			const RESOURCE_TRY_PIN_EDIT = 'resource/DidItActivityResource/update/';
75			const RESOURCE_TRY_PIN_DELETE = 'resource/DidItActivityResource/delete/';
76			const RESOURCE_TRY_PIN_IMAGE_UPLOAD = 'resource/DidItImageUploadResource/create/';
77			const RESOURCE_SHARE_VIA_SOCIAL = 'resource/CreateExternalInviteResource/create/';
78
79			/**
80			* Pinners
81			*/
82			const RESOURCE_FOLLOW_USER = 'resource/UserFollowResource/create/';
83			const RESOURCE_UNFOLLOW_USER = 'resource/UserFollowResource/delete/';
84			const RESOURCE_USER_INFO = 'resource/UserResource/get/';
85			const RESOURCE_USER_FOLLOWING = 'resource/UserFollowingResource/get/';
86			const RESOURCE_USER_PINS = 'resource/UserPinsResource/get/';
87			const RESOURCE_USER_LIKES = 'resource/UserLikesResource/get/';
88			const RESOURCE_USER_TRIED = 'resource/DidItUserFeedResource/get/';
89
90			const RESOURCE_CONTACTS_REQUESTS = 'resource/ContactRequestsResource/get';
91			const RESOURCE_CONTACT_REQUEST_ACCEPT = 'resource/ContactRequestAcceptResource/update/';
92			const RESOURCE_CONTACT_REQUEST_IGNORE = 'resource/ContactRequestIgnoreResource/delete/';
93
94			/**
95			* Search
96			*/
97			const RESOURCE_SEARCH = 'resource/BaseSearchResource/get/';
98			const RESOURCE_SEARCH_WITH_PAGINATION = 'resource/SearchResource/get/';
99			const RESOURCE_TYPE_AHEAD_SUGGESTIONS = 'resource/AdvancedTypeaheadResource/get';
100			const RESOURCE_HASHTAG_TYPE_AHEAD_SUGGESTIONS = 'resource/HashtagTypeaheadResource/get';
101
102			/**
103			* Interests.
104			*/
105			const RESOURCE_FOLLOW_INTEREST = 'resource/InterestFollowResource/create/';
106			const RESOURCE_UNFOLLOW_INTEREST = 'resource/InterestFollowResource/delete/';
107			const RESOURCE_FOLLOWING_INTERESTS = 'resource/InterestFollowingResource/get/';
108
109			/**
110			* Conversations.
111			*/
112			const RESOURCE_SEND_MESSAGE = 'resource/ConversationsResource/create/';
113			const RESOURCE_GET_CONVERSATION_MESSAGES = 'resource/ConversationMessagesResource/get/';
114			const RESOURCE_GET_LAST_CONVERSATIONS = 'resource/ConversationsResource/get/';
115
116			/**
117			* UserSettings
118			*/
119			const RESOURCE_UPDATE_USER_SETTINGS = 'resource/UserSettingsResource/update/';
120			const RESOURCE_GET_USER_SETTINGS = 'resource/UserSettingsResource/get/';
121			const RESOURCE_CHANGE_PASSWORD = 'resource/UserPasswordResource/update/';
122			const RESOURCE_DEACTIVATE_ACCOUNT = 'resource/DeactivateAccountResource/create/';
123			const RESOURCE_BLOCK_USER = 'resource/UserBlockResource/create/';
124			const RESOURCE_CLEAR_SEARCH_HISTORY = 'resource/TypeaheadClearRecentResource/delete/';
125			const RESOURCE_SESSIONS_HISTORY = 'resource/UserSessionStoreResource/get/';
126			const RESOURCE_AVAILABLE_LOCALES = 'resource/LocalesResource/get/';
127			const RESOURCE_AVAILABLE_COUNTRIES = 'resource/CountriesResource/get/';
128			const RESOURCE_AVAILABLE_ACCOUNT_TYPES = 'resource/BusinessTypesResource/get/';
129
130			/**
131			* News
132			*/
133			const RESOURCE_GET_LATEST_NEWS = 'resource/NetworkStoriesResource/get/';
134			const RESOURCE_GET_NOTIFICATIONS = 'resource/NewsHubResource/get/';
135
136			/**
137			* Registration
138			*/
139			const RESOURCE_CREATE_REGISTER = 'resource/UserRegisterResource/create/';
140			const RESOURCE_CHECK_EMAIL = 'resource/EmailExistsResource/get/';
141			const RESOURCE_SET_ORIENTATION = 'resource/OrientationContextResource/create/';
142			const RESOURCE_UPDATE_REGISTRATION_TRACK = 'resource/UserRegisterTrackActionResource/update/';
143			const RESOURCE_REGISTRATION_COMPLETE = 'resource/UserExperienceCompletedResource/update/';
144			const RESOURCE_CONVERT_TO_BUSINESS = 'resource/PartnerResource/update/';
145
146			/**
147			* Uploads
148			*/
149			const IMAGE_UPLOAD = 'upload-image/';
150
151			/**
152			* Categories
153			*/
154			const RESOURCE_GET_CATEGORIES = 'resource/CategoriesResource/get/';
155			const RESOURCE_GET_CATEGORY = 'resource/CategoryResource/get/';
156			const RESOURCE_GET_CATEGORIES_RELATED = 'resource/RelatedInterestsResource/get/';
157			const RESOURCE_GET_CATEGORY_FEED = 'resource/CategoryFeedResource/get/';
158
159			/**
160			* Topics
161			*/
162			const RESOURCE_GET_TOPIC_FEED = 'resource/TopicFeedResource/get/';
163			const RESOURCE_GET_TOPIC = 'resource/TopicResource/get/';
164			const RESOURCE_EXPLORE_SECTIONS = 'resource/ExploreSectionsResource/get/';
165
166			/**
167			* Invite
168			*/
169			const RESOURCE_INVITE = 'resource/EmailInviteSentResource/create/';
170
171			const URL_BASE = 'https://uk.pinterest.com/';
172			const HOST = 'uk.pinterest.com';
173
174			const FOLLOWING_INTERESTS = 'interests';
175			const FOLLOWING_PEOPLE = 'people';
176			const FOLLOWING_BOARDS = 'boards';
177
178			/**
179			* @param array $request
180			*
181			* @return mixed
182			*/
183			public static function buildRequestString($request)
184			{
185			return self::fixEncoding(http_build_query($request));
186			}
187
188			/**
189			* Appends resource url to base pinterest url.
190			*
191			* @param string $resourceUrl
192			*
193			* @return string
194			*/
195			public static function buildApiUrl($resourceUrl)
196			{
197			if (strpos($resourceUrl, 'http') !== false) {
198			return $resourceUrl;
199			}
200
201			return self::URL_BASE . $resourceUrl;
202			}
203
204			/**
205			* Fix URL-encoding for some characters.
206			*
207			* @param string $str
208			*
209			* @return string
210			*/
211			public static function fixEncoding($str)
212			{
213			return str_replace(
214			['%28', '%29', '%7E'], ['(', ')', '~'], $str
215			);
216			}
217
218
219			/**
220			* @param string $type
221			* @return string\|null
222			*/
223			public static function getFollowingUrlByType($type)
224			{
225			$urls = [
226			self::FOLLOWING_INTERESTS => self::RESOURCE_FOLLOWING_INTERESTS,
227			self::FOLLOWING_BOARDS => self::RESOURCE_FOLLOWING_BOARDS,
228			self::FOLLOWING_PEOPLE => self::RESOURCE_USER_FOLLOWING,
229			];
230
231			if (array_key_exists($type, $urls)) {
232			return $urls[$type];
233			}
234
235			return null;
236			}
237			}
238

seregazhuk / php-pinterest-bot

Branch — master (23259a)

UrlBuilder::fixEncoding() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like