WuBookAuth::release_token() - Code Metrics - ilgala/laravel-wubook - Measure and Improve Code Quality continuously with Scrutinizer

WuBookAuth::release_token() B
last analyzed 2017-03-28 15:47 UTC

↳ Parent: WuBookAuth

Complexity

Conditions	3
Paths	6

Size

Total Lines	26
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	26
rs	8.8571
cc	3
eloc	13
nc	6
nop	1

<?php

/*
 * This file is part of Laravel WuBook.
 *
 * (c) Filippo Galante <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace IlGala\LaravelWubook\Api;

use fXmlRpc\Client;
use fXmlRpc\Exception\AbstractTransportException;
use IlGala\WuBook\Exceptions\WuBookException;
use Carbon\Carbon;

/**
 * This is the WuBook authentication class.
 *
 * @author Filippo Galante <[email protected]>
 */
class WuBookAuth
{

    /**
     * @var array
     */
    private $config;

    /**
     * @var Illuminate\Cache\Repository
     */
    private $cache;

    /**
     * @var fXmlRpc\Client
     */
    private $client;

    /**
     * Create a new WuBookAuth Instance.
     *
     * @param array $config
     * @param \Illuminate\Cache\Repository $cache
     * @param Client $client
     */
    public function __construct(array $config, Illuminate\Cache\Repository $cache, Client $client)
    {
        $this->config = $config;
        $this->client = $client;

        $this->cache = $cache;
    }

    /**
     * Acquire token. If cache_token option is set to true, the package will automatically save it into application cache
     *
     * http://tdocs.wubook.net/wired/auth.html#acquiring-and-releasing-a-token
     *
     *
     * @return string token
     */
    public function acquire_token()
    {
        // Setup request data
        $data = [
            $this->config['username'],
            $this->config['password'],
            $this->config['provider_key']
        ];

        try {
            // Retrieve response
            $response = $this->client->call('acquire_token', $data);

            // Check response
            if ($response[0] == 0) {
                // Success
                $token = $response[1];

                // Setup cache token expiration and max operations
                $expires_at = Carbon::now()->addSeconds(3600);

                // Setup cache
                if ($this->config['cache_token']) {
                    $this->cache->put('wubook.token', $token, $expires_at);
                    $this->cache->put('wubook.token.ops', 0, $expires_at);
                }

                return $token;
            } else {
                // Error
                throw new WuBookException($response[1], $response[0]);
            }
        } catch (AbstractTransportException $error) {
            throw new WuBookException($error->getMessage(), $error->getCode(), $error);
        }
    }

    /**
     * Token release.
     *
     * http://tdocs.wubook.net/wired/auth.html#acquiring-and-releasing-a-token
     *
     * @param string $token
     */
    public function release_token($token)
    {
        // Setup request data
        $data = [
            $token
        ];

        try {
            // Retrieve response
            $response = $this->client->call('release_token', $data);

            // Check response
            if ($response[0] == 0) {
                // Empty cache
                $this->cache->forget('wubook.token');
                $this->cache->forget('wubook.token.ops');

                return true;
            } else {
                // Error
                throw new WuBookException($response[1], $response[0]);
            }
        } catch (AbstractTransportException $error) {
            throw new WuBookException($error->getMessage(), $error->getCode(), $error);
        }
    }

    /**
     * The is_token_valid() function returns two information.
     * If (and only if) the ReturnCode is zero, it means that the token is valid.
     * In that case, the return value of the function is an integer and represents the number of times that this token has been used.
     *
     * The request_new param will not be considered if token is valid.
     *
     * http://tdocs.wubook.net/wired/auth.html#other-token-tools
     *
     * @param string $token
     * @param boolean $request_new
     * @return int|string
     * @throws IlGala\WuBook\Exceptions\WuBookException
     */
    public function is_token_valid($token, $request_new = false)
    {
        // Setup request data
        $data = [
            $token
        ];

        try {
            // Retrieve response
            $response = $this->client->call('is_token_valid', $data);

            if ($response[0] == 0) {
                return $response[1];
            } elseif ($request_new) {
                return $this->acquire_token();
            } else {
                return false;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
            }
        } catch (AbstractTransportException $error) {
            throw new WuBookException($error->getMessage(), $error->getCode(), $error);
        }
    }

    /**
     * The provider_info() function is used to return the information WuBook holds about you as Wired Provider.
     * In particular, you can check what email we have registered and associated with your Provider Key.
     * The return value of this function is a Complex Structure.
     *
     * http://tdocs.wubook.net/wired/auth.html#other-token-tools
     *
     * @param string $token
     * @return mixed
     * @throws IlGala\WuBook\Exceptions\WuBookException
     */
    public function provider_info($token = null)
    {
        // Check token
        if (empty($token)) {
            $token = $this->cache->get('wubook.token');

            if (empty($token)) {
                $token = $this->acquire_token();
            }
        }

        // Setup request data
        $data = [
            $token
        ];

        try {
            // Retrieve response
            $response = $this->client->call('provider_info', $data);

            if ($response[0] == 0) {
                return $response[1];
            } else {
                // Error
                throw new WuBookException($response[1], $response[0]);
            }
        } catch (AbstractTransportException $error) {
            throw new WuBookException($error->getMessage(), $error->getCode(), $error);
        }
    }
}


1			<?php
2
3			/*
4			* This file is part of Laravel WuBook.
5			*
6			* (c) Filippo Galante <[email protected]>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace IlGala\LaravelWubook\Api;
13
14			use fXmlRpc\Client;
15			use fXmlRpc\Exception\AbstractTransportException;
16			use IlGala\WuBook\Exceptions\WuBookException;
17			use Carbon\Carbon;
18
19			/**
20			* This is the WuBook authentication class.
21			*
22			* @author Filippo Galante <[email protected]>
23			*/
24			class WuBookAuth
25			{
26
27			/**
28			* @var array
29			*/
30			private $config;
31
32			/**
33			* @var Illuminate\Cache\Repository
34			*/
35			private $cache;
36
37			/**
38			* @var fXmlRpc\Client
39			*/
40			private $client;
41
42			/**
43			* Create a new WuBookAuth Instance.
44			*
45			* @param array $config
46			* @param \Illuminate\Cache\Repository $cache
47			* @param Client $client
48			*/
49			public function __construct(array $config, Illuminate\Cache\Repository $cache, Client $client)
50			{
51			$this->config = $config;
52			$this->client = $client;
			0 ignored issues – show Documentation Bug introduced 2017-03-28 15:28 UTC by Report Bug Copy Issue Report It seems like `$client` of type `object<fXmlRpc\Client>` is incompatible with the declared type `object<IlGala\LaravelWubook\Api\fXmlRpc\Client>` of property `$client`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
53			$this->cache = $cache;
54			}
55
56			/**
57			* Acquire token. If cache_token option is set to true, the package will automatically save it into application cache
58			*
59			* http://tdocs.wubook.net/wired/auth.html#acquiring-and-releasing-a-token
60			*
61			*
62			* @return string token
63			*/
64			public function acquire_token()
65			{
66			// Setup request data
67			$data = [
68			$this->config['username'],
69			$this->config['password'],
70			$this->config['provider_key']
71			];
72
73			try {
74			// Retrieve response
75			$response = $this->client->call('acquire_token', $data);
76
77			// Check response
78			if ($response[0] == 0) {
79			// Success
80			$token = $response[1];
81
82			// Setup cache token expiration and max operations
83			$expires_at = Carbon::now()->addSeconds(3600);
84
85			// Setup cache
86			if ($this->config['cache_token']) {
87			$this->cache->put('wubook.token', $token, $expires_at);
88			$this->cache->put('wubook.token.ops', 0, $expires_at);
89			}
90
91			return $token;
92			} else {
93			// Error
94			throw new WuBookException($response[1], $response[0]);
95			}
96			} catch (AbstractTransportException $error) {
97			throw new WuBookException($error->getMessage(), $error->getCode(), $error);
98			}
99			}
100
101			/**
102			* Token release.
103			*
104			* http://tdocs.wubook.net/wired/auth.html#acquiring-and-releasing-a-token
105			*
106			* @param string $token
107			*/
108			public function release_token($token)
109			{
110			// Setup request data
111			$data = [
112			$token
113			];
114
115			try {
116			// Retrieve response
117			$response = $this->client->call('release_token', $data);
118
119			// Check response
120			if ($response[0] == 0) {
121			// Empty cache
122			$this->cache->forget('wubook.token');
123			$this->cache->forget('wubook.token.ops');
124
125			return true;
126			} else {
127			// Error
128			throw new WuBookException($response[1], $response[0]);
129			}
130			} catch (AbstractTransportException $error) {
131			throw new WuBookException($error->getMessage(), $error->getCode(), $error);
132			}
133			}
134
135			/**
136			* The is_token_valid() function returns two information.
137			* If (and only if) the ReturnCode is zero, it means that the token is valid.
138			* In that case, the return value of the function is an integer and represents the number of times that this token has been used.
139			*
140			* The request_new param will not be considered if token is valid.
141			*
142			* http://tdocs.wubook.net/wired/auth.html#other-token-tools
143			*
144			* @param string $token
145			* @param boolean $request_new
146			* @return int\|string
147			* @throws IlGala\WuBook\Exceptions\WuBookException
148			*/
149			public function is_token_valid($token, $request_new = false)
150			{
151			// Setup request data
152			$data = [
153			$token
154			];
155
156			try {
157			// Retrieve response
158			$response = $this->client->call('is_token_valid', $data);
159
160			if ($response[0] == 0) {
161			return $response[1];
162			} elseif ($request_new) {
163			return $this->acquire_token();
164			} else {
165			return false;
			0 ignored issues – show Bug Best Practice introduced 2017-03-28 15:28 UTC by Report Bug Copy Issue Report The return type of `return false;` (`false`) is incompatible with the return type documented by `IlGala\LaravelWubook\Api...ookAuth::is_token_valid` of type `integer\|string`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
166			}
167			} catch (AbstractTransportException $error) {
168			throw new WuBookException($error->getMessage(), $error->getCode(), $error);
169			}
170			}
171
172			/**
173			* The provider_info() function is used to return the information WuBook holds about you as Wired Provider.
174			* In particular, you can check what email we have registered and associated with your Provider Key.
175			* The return value of this function is a Complex Structure.
176			*
177			* http://tdocs.wubook.net/wired/auth.html#other-token-tools
178			*
179			* @param string $token
180			* @return mixed
181			* @throws IlGala\WuBook\Exceptions\WuBookException
182			*/
183			public function provider_info($token = null)
184			{
185			// Check token
186			if (empty($token)) {
187			$token = $this->cache->get('wubook.token');
188
189			if (empty($token)) {
190			$token = $this->acquire_token();
191			}
192			}
193
194			// Setup request data
195			$data = [
196			$token
197			];
198
199			try {
200			// Retrieve response
201			$response = $this->client->call('provider_info', $data);
202
203			if ($response[0] == 0) {
204			return $response[1];
205			} else {
206			// Error
207			throw new WuBookException($response[1], $response[0]);
208			}
209			} catch (AbstractTransportException $error) {
210			throw new WuBookException($error->getMessage(), $error->getCode(), $error);
211			}
212			}
213			}
214

ilgala / laravel-wubook

WuBookAuth::release_token() B last analyzed 2017-03-28 15:47 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

WuBookAuth::release_token() B
last analyzed 2017-03-28 15:47 UTC