ApiClient::getChampionMasteryApi() - Code Metrics - Inspection of "New champion mastery API" - Babacooll/lol-api - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#7)

by Michaël

created 2016-02-23 17:11 UTC

ApiClient::getChampionMasteryApi() A

↳ Parent: ApiClient

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

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

<?php

namespace LoLApi;

use Doctrine\Common\Cache\CacheProvider;
use Doctrine\Common\Cache\VoidCache;
use GuzzleHttp\Client;
use LoLApi\Api\ChampionApi;
use LoLApi\Api\ChampionMasteryApi;
use LoLApi\Api\CurrentGameApi;
use LoLApi\Api\FeaturedGamesApi;
use LoLApi\Api\GameApi;
use LoLApi\Api\LeagueApi;
use LoLApi\Api\MatchApi;
use LoLApi\Api\MatchListApi;
use LoLApi\Api\StaticDataApi;
use LoLApi\Api\StatsApi;
use LoLApi\Api\StatusApi;
use LoLApi\Api\SummonerApi;
use LoLApi\Api\TeamApi;
use LoLApi\Result\ApiResult;

/**
 * Class ApiClient
 *
 * @package LoLApi
 */
class ApiClient
{
    const REGION_BR = 'br';
    const REGION_EUNE = 'eune';
    const REGION_EUW = 'euw';
    const REGION_KR = 'kr';
    const REGION_LAN = 'lan';
    const REGION_LAS = 'las';
    const REGION_NA = 'na';
    const REGION_OCE = 'oce';
    const REGION_RU = 'ru';
    const REGION_TR = 'tr';

    /**
     * @var array
     */
    public static $availableRegions = [
        self::REGION_BR,
        self::REGION_EUNE,
        self::REGION_EUW,
        self::REGION_KR,
        self::REGION_LAN,
        self::REGION_LAS,
        self::REGION_NA,
        self::REGION_OCE,
        self::REGION_RU,
        self::REGION_TR
    ];

    /**
     * @var string
     */
    protected $region;

    /**
     * @var string
     */
    protected $apiKey;

    /**
     * @var Client
     */
    protected $httpClient;

    /**
     * @var CacheProvider
     */
    protected $cacheProvider;

    /**
     * @param string        $region
     * @param string        $apiKey
     * @param CacheProvider $cacheProvider
     * @param Client        $client
     *
     * @throws \Exception
     */
    public function __construct($region, $apiKey, CacheProvider $cacheProvider = null, Client $client = null)
    {
        if (!in_array($region, self::$availableRegions)) {
            throw new \Exception(sprintf('Invalid region %s', $region));
        }

        $this->region        = $region;
        $this->httpClient    = $client ? $client : new Client(['base_uri' => $this->getBaseUrlWithRegion()]);
        $this->apiKey        = $apiKey;
        $this->cacheProvider = $cacheProvider ? $cacheProvider : new VoidCache();
    }

    /**
     * @param CacheProvider $cacheProvider
     */
    public function setCacheProvider(CacheProvider $cacheProvider)
    {
        $this->cacheProvider = $cacheProvider;
    }

    /**
     * @return CacheProvider
     */
    public function getCacheProvider()
    {
        return $this->cacheProvider;
    }

    /**
     * @return Client
     */
    public function getHttpClient()
    {
        return $this->httpClient;
    }

    /**
     * @return string
     */
    public function getRegion()
    {
        return $this->region;
    }

    /**
     * @return string
     */
    public function getApiKey()
    {
        return $this->apiKey;
    }

    /**
     * @return MatchListApi
     */
    public function getMatchListApi()
    {
        return new MatchListApi($this);
    }

    /**
     * @return MatchApi
     */
    public function getMatchApi()
    {
        return new MatchApi($this);
    }

    /**
     * @return SummonerApi
     */
    public function getSummonerApi()
    {
        return new SummonerApi($this);
    }

    /**
     * @return ChampionApi
     */
    public function getChampionApi()
    {
        return new ChampionApi($this);
    }

    /**
     * @return FeaturedGamesApi
     */
    public function getFeaturedGamesApi()
    {
        return new FeaturedGamesApi($this);
    }

    /**
     * @return StatsApi
     */
    public function getStatsApi()
    {
        return new StatsApi($this);
    }

    /**
     * @return TeamApi
     */
    public function getTeamApi()
    {
        return new TeamApi($this);
    }

    /**
     * @return GameApi
     */
    public function getGameApi()
    {
        return new GameApi($this);
    }

    /**
     * @return CurrentGameApi
     */
    public function getCurrentGameApi()
    {
        return new CurrentGameApi($this);
    }

    /**
     * @return LeagueApi
     */
    public function getLeagueApi()
    {
        return new LeagueApi($this);
    }

    /**
     * @return StaticDataApi
     */
    public function getStaticDataApi()
    {
        return new StaticDataApi($this);
    }

    /**
     * @return StatusApi
     */
    public function getStatusApi()
    {
        return new StatusApi($this);
    }

    /**
     * @return ChampionMasteryApi
     */
    public function getChampionMasteryApi()
    {
        return new ChampionMasteryApi($this);
    }

    /**
     * @return string
     */
    public function getBaseUrlWithRegion()
    {
        return 'https://' . $this->region . '.api.pvp.net';
    }

    /**
     * @return string
     */
    public function getGlobalUrl()
    {
        return 'https://global.api.pvp.net';
    }

    /**
     * @return string
     */
    public function getStatusUrl()
    {
        return 'http://status.leagueoflegends.com';
    }

    /**
     * @param ApiResult $apiResult
     * @param int       $ttl
     */
    public function cacheApiResult(ApiResult $apiResult, $ttl = 60)
    {
        $this->cacheProvider->save($apiResult->getUrl(), json_encode($apiResult->getResult()), $ttl);
    }
}


1		<?php
2
3		namespace LoLApi;
4
5		use Doctrine\Common\Cache\CacheProvider;
6		use Doctrine\Common\Cache\VoidCache;
7		use GuzzleHttp\Client;
8		use LoLApi\Api\ChampionApi;
9		use LoLApi\Api\ChampionMasteryApi;
10		use LoLApi\Api\CurrentGameApi;
11		use LoLApi\Api\FeaturedGamesApi;
12		use LoLApi\Api\GameApi;
13		use LoLApi\Api\LeagueApi;
14		use LoLApi\Api\MatchApi;
15		use LoLApi\Api\MatchListApi;
16		use LoLApi\Api\StaticDataApi;
17		use LoLApi\Api\StatsApi;
18		use LoLApi\Api\StatusApi;
19		use LoLApi\Api\SummonerApi;
20		use LoLApi\Api\TeamApi;
21		use LoLApi\Result\ApiResult;
22
23		/**
24		* Class ApiClient
25		*
26		* @package LoLApi
27		*/
28		class ApiClient
29		{
30		const REGION_BR = 'br';
31		const REGION_EUNE = 'eune';
32		const REGION_EUW = 'euw';
33		const REGION_KR = 'kr';
34		const REGION_LAN = 'lan';
35		const REGION_LAS = 'las';
36		const REGION_NA = 'na';
37		const REGION_OCE = 'oce';
38		const REGION_RU = 'ru';
39		const REGION_TR = 'tr';
40
41		/**
42		* @var array
43		*/
44		public static $availableRegions = [
45		self::REGION_BR,
46		self::REGION_EUNE,
47		self::REGION_EUW,
48		self::REGION_KR,
49		self::REGION_LAN,
50		self::REGION_LAS,
51		self::REGION_NA,
52		self::REGION_OCE,
53		self::REGION_RU,
54		self::REGION_TR
55		];
56
57		/**
58		* @var string
59		*/
60		protected $region;
61
62		/**
63		* @var string
64		*/
65		protected $apiKey;
66
67		/**
68		* @var Client
69		*/
70		protected $httpClient;
71
72		/**
73		* @var CacheProvider
74		*/
75		protected $cacheProvider;
76
77		/**
78		* @param string $region
79		* @param string $apiKey
80		* @param CacheProvider $cacheProvider
81		* @param Client $client
82		*
83		* @throws \Exception
84		*/
85	3	public function __construct($region, $apiKey, CacheProvider $cacheProvider = null, Client $client = null)
86		{
87	3	if (!in_array($region, self::$availableRegions)) {
88	1	throw new \Exception(sprintf('Invalid region %s', $region));
89		}
90
91	2	$this->region = $region;
92	2	$this->httpClient = $client ? $client : new Client(['base_uri' => $this->getBaseUrlWithRegion()]);
93	2	$this->apiKey = $apiKey;
94	2	$this->cacheProvider = $cacheProvider ? $cacheProvider : new VoidCache();
95	2	}
96
97		/**
98		* @param CacheProvider $cacheProvider
99		*/
100	1	public function setCacheProvider(CacheProvider $cacheProvider)
101		{
102	1	$this->cacheProvider = $cacheProvider;
103	1	}
104
105		/**
106		* @return CacheProvider
107		*/
108	1	public function getCacheProvider()
109		{
110	1	return $this->cacheProvider;
111		}
112
113		/**
114		* @return Client
115		*/
116	1	public function getHttpClient()
117		{
118	1	return $this->httpClient;
119		}
120
121		/**
122		* @return string
123		*/
124	1	public function getRegion()
125		{
126	1	return $this->region;
127		}
128
129		/**
130		* @return string
131		*/
132	1	public function getApiKey()
133		{
134	1	return $this->apiKey;
135		}
136
137		/**
138		* @return MatchListApi
139		*/
140	1	public function getMatchListApi()
141		{
142	1	return new MatchListApi($this);
143		}
144
145		/**
146		* @return MatchApi
147		*/
148	1	public function getMatchApi()
149		{
150	1	return new MatchApi($this);
151		}
152
153		/**
154		* @return SummonerApi
155		*/
156	1	public function getSummonerApi()
157		{
158	1	return new SummonerApi($this);
159		}
160
161		/**
162		* @return ChampionApi
163		*/
164	1	public function getChampionApi()
165		{
166	1	return new ChampionApi($this);
167		}
168
169		/**
170		* @return FeaturedGamesApi
171		*/
172	1	public function getFeaturedGamesApi()
173		{
174	1	return new FeaturedGamesApi($this);
175		}
176
177		/**
178		* @return StatsApi
179		*/
180	1	public function getStatsApi()
181		{
182	1	return new StatsApi($this);
183		}
184
185		/**
186		* @return TeamApi
187		*/
188	1	public function getTeamApi()
189		{
190	1	return new TeamApi($this);
191		}
192
193		/**
194		* @return GameApi
195		*/
196	1	public function getGameApi()
197		{
198	1	return new GameApi($this);
199		}
200
201		/**
202		* @return CurrentGameApi
203		*/
204	1	public function getCurrentGameApi()
205		{
206	1	return new CurrentGameApi($this);
207		}
208
209		/**
210		* @return LeagueApi
211		*/
212	1	public function getLeagueApi()
213		{
214	1	return new LeagueApi($this);
215		}
216
217		/**
218		* @return StaticDataApi
219		*/
220	1	public function getStaticDataApi()
221		{
222	1	return new StaticDataApi($this);
223		}
224
225		/**
226		* @return StatusApi
227		*/
228	1	public function getStatusApi()
229		{
230	1	return new StatusApi($this);
231		}
232
233		/**
234		* @return ChampionMasteryApi
235		*/
236		public function getChampionMasteryApi()
237		{
238		return new ChampionMasteryApi($this);
239		}
240
241		/**
242		* @return string
243		*/
244	1	public function getBaseUrlWithRegion()
245		{
246	1	return 'https://' . $this->region . '.api.pvp.net';
247		}
248
249		/**
250		* @return string
251		*/
252	1	public function getGlobalUrl()
253		{
254	1	return 'https://global.api.pvp.net';
255		}
256
257		/**
258		* @return string
259		*/
260	1	public function getStatusUrl()
261		{
262	1	return 'http://status.leagueoflegends.com';
263		}
264
265		/**
266		* @param ApiResult $apiResult
267		* @param int $ttl
268		*/
269	1	public function cacheApiResult(ApiResult $apiResult, $ttl = 60)
270		{
271	1	$this->cacheProvider->save($apiResult->getUrl(), json_encode($apiResult->getResult()), $ttl);
272	1	}
273		}
274

Babacooll / lol-api

Pull Request — master (#7)

ApiClient::getChampionMasteryApi() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like