Inoreader::streamContents() - Code Metrics - Inspection of "add new methods" - exileed/inoreader-api - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 84e281...f469f1 )

by Kuts
created 2018-04-14 12:44 UTC
Inoreader::streamContents() A

↳ Parent: Inoreader
Complexity

Conditions	1
Paths	1
Size

Total Lines	6
Code Lines	2
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	2
nc	1
nop	1
dl	0
loc	6
rs	9.4285
c	0
b	0
f	0
<?php declare(strict_types=1);


namespace ExileeD\Inoreader;


use ExileeD\Inoreader\Client\ClientInterface;
use ExileeD\Inoreader\Exception\InoreaderException;
use ExileeD\Inoreader\Objects\AddSubscription;
use ExileeD\Inoreader\Objects\StreamContents;
use ExileeD\Inoreader\Objects\Subscriptions;
use ExileeD\Inoreader\Objects\Tag;
use ExileeD\Inoreader\Objects\UnreadCount;
use ExileeD\Inoreader\Objects\UserInfo;

class Inoreader
{

    private const API_OAUTH = 'https://www.inoreader.com/oauth2/';

    /**
     * Access token
     *
     * @var string
     */
    protected $access_token;
    /**
     * Api key
     *
     * @var string
     */
    protected $api_key;
    /**
     * @var string
     */
    protected $api_secret;
    /**
     * @var Client
     */
    protected $client;

    public function __construct(int $api_key, string $api_secret, ClientInterface $client = null)
    {

        $this->api_key    = $api_key;
        $this->api_secret = $api_secret;

        $this->client = new Client($client);
    }

    /**
     * Create a Github\Client using a HttpClient.
     *
     * @param Inoreader $httpClient
     *
     * @todo
     *
     * @return Inoreader
     */
    public static function createWithPassword(string $login, string $password)
    public static function createWithPassword(string $login, /** @scrutinizer ignore-unused */ string $password)
    {
        return new self();
        return /** @scrutinizer ignore-call */ new self();
    }

    /**
     * @return string
     */
    public function getAccessToken(): string
    {
        return $this->access_token;
    }

    /**
     * @param string $access_token
     */
    public function setAccessToken(string $access_token): void
    {
        $this->access_token = $access_token;
    }

    /**
     * @param string $redirect_uri This is the address that the user will be redirected to when he authorizes your application from the consent page.
     * @param string $scope        You can pass read or read write
     * @param string $state        Up to 500 bytes of arbitrary data that will be passed back to your redirect URI.
     *
     * @see https://www.inoreader.com/developers/oauth
     * @return string
     */
    public function authUrl(string $redirect_uri, string $state, string $scope = ''): string
    {

        $query = [
            'client_id'     => $this->api_key,
            'redirect_uri'  => $redirect_uri,
            'response_type' => 'code',
            'scope'         => $scope,
            'state'         => $state,
        ];

        return self::API_OAUTH . 'auth' . '?' . http_build_query($query);
    }

    public function token(string $code, string $redirect_uri)
    {

        $params = [
            'code'          => $code,
            'redirect_uri'  => $redirect_uri,
            'client_id'     => $this->api_key,
            'client_secret' => $this->api_secret,
            'scope'         => '',
            'grant_type'    => 'authorization_code',
        ];

        $response = $this->getClient()->post(self::API_OAUTH . 'token', $params);

        var_dump($response);

    }

    /**
     * @access public
     * @return Client
     */
    public function getClient(): Client
    {
        return $this->client;
    }

    /**
     * @access public
     *
     * @param  Client $client
     *
     * @return $this
     */
    public function setClient(Client $client): self
    {
        $this->client = $client;

        return $this;
    }

    /**
     * Basic information about the logged in user.
     *
     * @see https://www.inoreader.com/developers/user-info
     * @throws InoreaderException
     * @return UserInfo
     */
    public function userInfo(): UserInfo
    {
        $response = $this->getClient()->get('user-info');

        return new UserInfo($response);
    }

    /**
     * This method is used to subscribe to feeds.
     *
     * @param string $url feedId to subscribe to
     *
     * @see https://www.inoreader.com/developers/add-subscription
     * @throws InoreaderException
     * @return AddSubscription
     */
    public function addSubscription(string $url): AddSubscription
    {
        $params   = [
            'quickadd' => $url,
        ];
        $response = $this->getClient()->post('subscription/quickadd', $params);

        return new AddSubscription($response);
    }

    /**
     * Fetch the unread counters for folders, tags and feeds.
     *
     * @see https://www.inoreader.com/developers/unread-counts
     * @throws InoreaderException
     * @return AddSubscription
     */
    public function unreadCount(): UnreadCount
    {
        $response = $this->getClient()->post('unread-count');

        return new UnreadCount($response);

    }


    /**
     * Fetches the current subscriptions for the logged user
     *
     * @see http://www.inoreader.com/developers/subscription-list
     * @throws InoreaderException
     * @return Subscriptions
     */
    public function subscriptionList(): Subscriptions
    {

        $response = $this->getClient()->get('active_search/create');

        return new Subscriptions($response);

    }


    /**
     * Folders and tags list
     *
     * @param int|string $types  Set to 1 to get the item type. Can be tag, folder or active_search
     * @param int        $counts Set to 1 to get unread counts for tags and active searches.
     *
     * @see http://www.inoreader.com/developers/tag-list
     * @throws InoreaderException
     * @return Tag[]
     */
    public function tagsList($types = 1, $counts = 1): array
    {

        $response = $this->getClient()->get('tag/list', ['types' => $types, 'counts' => $counts]);

        $result = [];

        foreach ($response->tags as $tag) {
            $result[] = new Tag($tag);
        }

        return $result;

    }

    /**
     * Returns the articles for a given collection.
     *
     * @param array $params
     *
     * @see http://www.inoreader.com/developers/stream-contents
     * @throws InoreaderException
     * @return StreamContents
     */
    public function streamContents(array $params = []): StreamContents
    {

        $response = $this->getClient()->get('stream/contents', $params);

        return new StreamContents($response);

    }

    /**
     * List of folders and the system.
     *
     *
     * @see http://www.inoreader.com/developers/preference-list
     * @throws InoreaderException
     * @return StreamContents
     */
    public function streamPreferenceList(): StreamContents
    {

        $response = $this->getClient()->get('preference/stream/list');

        return new StreamContents($response);

    }


    /**
     * List of folders and the system.
     *
     * @param string $stream_id Stream ID
     * @param string $key       Key Only accepted is subscription-ordering
     * @param string $value     Value.
     *
     * @see http://www.inoreader.com/developers/preference-set
     * @throws InoreaderException
     * @return bool
     */
    public function streamPreferenceSet(string $stream_id, $key = null, $value = null): bool
    {
        $this->getClient()->get('preference/stream/set',
            [
                's' => $stream_id,
                'k' => $key,
                'v' => $value,
            ]
        );

        return true;

    }


    /**
     * This method is used to rename tags and folders
     *
     * @param string $source Source name
     * @param string $target Target name
     *
     * @see http://www.inoreader.com/developers/rename-tag
     * @throws InoreaderException
     * @return bool
     */
    public function renameTag(string $source, string $target): bool
    {
        $this->getClient()->get('rename-tag',
            [
                's'    => $source,
                'dest' => $target,
            ]
        );

        return true;
    }


    /**
     * This method is used to delete tags and folders.
     *
     * @param string $source Full tag name
     *
     * @see http://www.inoreader.com/developers/delete-tag
     * @throws InoreaderException
     * @return bool
     */
    public function deleteTag(string $source): bool
    {
        $this->getClient()->get('disable-tag',
            [
                's' => $source,
            ]
        );

        return true;
    }

    /**
     * This method is used to mark articles as read, or to star them.
     *
     * @param array  $items  Item ID
     * @param string $add    Tag to add
     * @param string $remove Tag to remove
     *
     * @see http://www.inoreader.com/developers/edit-tag
     * @throws InoreaderException
     * @return bool
     */
    public function editTag(array $items, string $add = null, string $remove = null): bool
    {

        $i = http_build_query($items);

        $params = [
            'i' => $i,
            'a' => $add,
            'r' => $remove,
        ];

        $this->getClient()->get('edit-tag', $params);

        return true;
    }


    /**
     * This method marks all items in a given stream as read.
     *
     * @param int    $timestamp Unix Timestamp in seconds or microseconds.
     * @param string $stream_id Stream ID
     *
     * @see http://www.inoreader.com/developers/mark-all-as-read
     * @throws InoreaderException
     * @return bool
     */
    public function markAllAsRead(int $timestamp, string $stream_id): bool
    {

        $this->getClient()->get('mark-all-as-read', [
            'ts' => $timestamp,
            's'  => $stream_id,
        ]);

        return true;
    }


}
exileed / inoreader-api

Push — master ( 84e281...f469f1 )

Inoreader::streamContents() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
