JCFirebase::get() - Code Metrics - Inspection of "Merge remote-tracking branch 'origin/master'" - jaredchu/JC-Firebase-PHP - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( df19ab...5f95fa )

by Jared

created 2017-01-14 05:55 UTC

JCFirebase::get() A

↳ Parent: JCFirebase

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

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

<?php
/**
 * Created by PhpStorm.
 * User: jaredchu
 * Date: 11/29/16
 * Time: 3:47 PM
 */

namespace JCFirebase;

use Requests;

/**
 * Class JCFirebase
 * @package JCFirebase
 * reference https://www.firebase.com/docs/rest/api/
 */
class JCFirebase {
	public $firebaseURI;
	public $firebaseDefaultPath;
	public $requestHeader = array(
		'accept'      => 'application/json',
		'contentType' => 'application/json; charset=utf-8',
		'dataType'    => 'json'
	);
	public $requestOptions = array();
	/**
	 * @var OAuth
	 */
	protected $auth;

	public function __construct( $firebaseURI, $firebaseSerivceAccount = '', $firebaseDefaultPath = '/' ) {
		$this->firebaseURI         = $firebaseURI;
		$this->firebaseDefaultPath = $firebaseDefaultPath;
		$this->setAuth( $firebaseSerivceAccount );
	}

	public static function fromKeyFile( $firebaseURI, $keyFile, $firebaseDefaultPath = '/' ) {
		$keyData = null;
		try {
			$keyData = json_decode( file_get_contents( $keyFile ) );
		} catch ( \Exception $exception ) {
			$keyData = json_decode( Requests::get( $keyFile ) );
		}

		if ( $keyData ) {
			$serviceAccount = $keyData->client_email;
			$privateKey     = $keyData->private_key;

			return new self( $firebaseURI, array(
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
				'key' => $privateKey,
				'iss' => $serviceAccount
			), $firebaseDefaultPath );
		} else {
			throw new \Exception( "can't get data from key file" );
		}
	}

	public function setAuth( $firebaseServiceAccount ) {
		if ( isset( $firebaseServiceAccount['key'] ) && isset( $firebaseServiceAccount['iss'] ) ) {
			$this->auth = new OAuth( $firebaseServiceAccount['key'], $firebaseServiceAccount['iss'] );
		}
	}

	public function getPathURI( $path = '', $print = '' ) {
		//remove last slash from firebaseURI
		$template          = '/';
		$this->firebaseURI = rtrim( $this->firebaseURI, $template );
		$path              = rtrim( $path, $template );
		$path              = ltrim( $path, $template );

		//check https
		if ( strpos( $this->firebaseURI, 'http://' ) !== false ) {
			throw new \Exception( "https is required." );
		}

		//check firebaseURI
		if ( empty( $this->firebaseURI ) ) {
			throw new \Exception( "firebase URI is required" );
		}

		if ( strpos( $this->firebaseDefaultPath, "/" ) !== 0 ) {
			throw new \Exception( "firebase default path must contain /" );
		}

		$pathURI = $this->firebaseURI . $this->firebaseDefaultPath . $path . ".json";

		//set query data
		$queryData = array();
		if ( ! empty( $print ) ) {
			$queryData[ JCFirebaseOption::OPTION_PRINT ] = $print;
		}
		if ( ! empty( $queryData ) ) {
			$pathURI = $pathURI . '?' . http_build_query( $queryData );
		}

		$this->refreshToken();

		return $pathURI;
	}

	public function getShallow( $path = '', $options = array() ) {
		return Requests::get(
			$this->getPathURI( $path ) . '?' . http_build_query( array(
				JCFirebaseOption::OPTION_SHALLOW => JCFirebaseOption::SHALLOW_TRUE
			) ),
			$this->requestHeader,
			$this->addDataToRequest( $options )

		);
	}

	/**
	 * @param string $path
	 * @param array $options
	 *
	 * @return \Requests_Response
	 */
	public function get( $path = '', $options = array() ) {
		return Requests::get(
			$this->addDataToPathURI( $path, $options ), $this->requestHeader,
			$this->addDataToRequest( $options )

		);
	}

	/**
	 * @param string $path
	 * @param array $options
	 *
	 * @return \Requests_Response
	 */
	public function put( $path = '', $options = array() ) {
		return Requests::put( $this->getPathURI( $path ), $this->requestHeader,
			$this->addDataToRequest( $options, true ) );

	}

	/**
	 * @param string $path
	 * @param array $options
	 *
	 * @return \Requests_Response
	 */
	public function post( $path = '', $options = array() ) {
		return Requests::post( $this->getPathURI( $path ), $this->requestHeader,
			$this->addDataToRequest( $options, true ) );

	}

	/**
	 * @param string $path
	 * @param array $options
	 *
	 * @return \Requests_Response
	 */
	public function patch( $path = '', $options = array() ) {
		return Requests::patch( $this->getPathURI( $path ), $this->requestHeader,
			$this->addDataToRequest( $options, true ) );

	}

	/**
	 * @param string $path
	 * @param array $options
	 *
	 * @return \Requests_Response
	 */
	public function delete( $path = '', $options = array() ) {
		return Requests::delete( $this->getPathURI( $path ), $this->requestHeader,
			$this->addDataToRequest( $options ) );

	}

	protected function refreshToken() {
		$this->requestHeader['Authorization'] = 'Bearer ' . $this->auth->getAccessToken();
	}

	protected function addDataToPathURI( $path = '', $options = array(), $reqType = JCFirebaseOption::REQ_TYPE_GET ) {
		$print = '';
		if ( isset( $options['print'] ) ) {
			if ( JCFirebaseOption::isAllowPrint( $reqType, $options['print'] ) ) {
				$print = $options['print'];
			}
		}

		return $this->getPathURI( $path, $print );
	}

	protected function addDataToRequest( $options = array(), $jsonEncode = false ) {
		$requestOptions = array();

		if ( isset( $options['data'] ) ) {
			$requestOptions = array_merge( $options['data'], $requestOptions );
		}

		if ( $jsonEncode ) {
			$requestOptions = json_encode( $requestOptions );
		}

		return $requestOptions;
	}
}

1			<?php
2			/**
3			* Created by PhpStorm.
4			* User: jaredchu
5			* Date: 11/29/16
6			* Time: 3:47 PM
7			*/
8
9			namespace JCFirebase;
10
11			use Requests;
12
13			/**
14			* Class JCFirebase
15			* @package JCFirebase
16			* reference https://www.firebase.com/docs/rest/api/
17			*/
18			class JCFirebase {
19			public $firebaseURI;
20			public $firebaseDefaultPath;
21			public $requestHeader = array(
22			'accept' => 'application/json',
23			'contentType' => 'application/json; charset=utf-8',
24			'dataType' => 'json'
25			);
26			public $requestOptions = array();
27			/**
28			* @var OAuth
29			*/
30			protected $auth;
31
32			public function __construct( $firebaseURI, $firebaseSerivceAccount = '', $firebaseDefaultPath = '/' ) {
33			$this->firebaseURI = $firebaseURI;
34			$this->firebaseDefaultPath = $firebaseDefaultPath;
35			$this->setAuth( $firebaseSerivceAccount );
36			}
37
38			public static function fromKeyFile( $firebaseURI, $keyFile, $firebaseDefaultPath = '/' ) {
39			$keyData = null;
40			try {
41			$keyData = json_decode( file_get_contents( $keyFile ) );
42			} catch ( \Exception $exception ) {
43			$keyData = json_decode( Requests::get( $keyFile ) );
44			}
45
46			if ( $keyData ) {
47			$serviceAccount = $keyData->client_email;
48			$privateKey = $keyData->private_key;
49
50			return new self( $firebaseURI, array(
			0 ignored issues – show Documentation introduced 2017-01-14 05:58 UTC by Report Bug Copy Issue Report `array('key' => $privateK...ss' => $serviceAccount)` is of type `array<string,?,{"key":"?","iss":"?"}>`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
51			'key' => $privateKey,
52			'iss' => $serviceAccount
53			), $firebaseDefaultPath );
54			} else {
55			throw new \Exception( "can't get data from key file" );
56			}
57			}
58
59			public function setAuth( $firebaseServiceAccount ) {
60			if ( isset( $firebaseServiceAccount['key'] ) && isset( $firebaseServiceAccount['iss'] ) ) {
61			$this->auth = new OAuth( $firebaseServiceAccount['key'], $firebaseServiceAccount['iss'] );
62			}
63			}
64
65			public function getPathURI( $path = '', $print = '' ) {
66			//remove last slash from firebaseURI
67			$template = '/';
68			$this->firebaseURI = rtrim( $this->firebaseURI, $template );
69			$path = rtrim( $path, $template );
70			$path = ltrim( $path, $template );
71
72			//check https
73			if ( strpos( $this->firebaseURI, 'http://' ) !== false ) {
74			throw new \Exception( "https is required." );
75			}
76
77			//check firebaseURI
78			if ( empty( $this->firebaseURI ) ) {
79			throw new \Exception( "firebase URI is required" );
80			}
81
82			if ( strpos( $this->firebaseDefaultPath, "/" ) !== 0 ) {
83			throw new \Exception( "firebase default path must contain /" );
84			}
85
86			$pathURI = $this->firebaseURI . $this->firebaseDefaultPath . $path . ".json";
87
88			//set query data
89			$queryData = array();
90			if ( ! empty( $print ) ) {
91			$queryData[ JCFirebaseOption::OPTION_PRINT ] = $print;
92			}
93			if ( ! empty( $queryData ) ) {
94			$pathURI = $pathURI . '?' . http_build_query( $queryData );
95			}
96
97			$this->refreshToken();
98
99			return $pathURI;
100			}
101
102			public function getShallow( $path = '', $options = array() ) {
103			return Requests::get(
104			$this->getPathURI( $path ) . '?' . http_build_query( array(
105			JCFirebaseOption::OPTION_SHALLOW => JCFirebaseOption::SHALLOW_TRUE
106			) ),
107			$this->requestHeader,
108			$this->addDataToRequest( $options )
			0 ignored issues – show Bug introduced 2016-12-14 09:10 UTC by Report Bug Copy Issue Report It seems like `$this->addDataToRequest($options)` targeting `JCFirebase\JCFirebase::addDataToRequest()` can also be of type `string`; however, `Requests::get()` does only seem to accept `array`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
109			);
110			}
111
112			/**
113			* @param string $path
114			* @param array $options
115			*
116			* @return \Requests_Response
117			*/
118			public function get( $path = '', $options = array() ) {
119			return Requests::get(
120			$this->addDataToPathURI( $path, $options ), $this->requestHeader,
121			$this->addDataToRequest( $options )
			0 ignored issues – show Bug introduced 2016-12-14 09:10 UTC by Report Bug Copy Issue Report It seems like `$this->addDataToRequest($options)` targeting `JCFirebase\JCFirebase::addDataToRequest()` can also be of type `string`; however, `Requests::get()` does only seem to accept `array`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
122			);
123			}
124
125			/**
126			* @param string $path
127			* @param array $options
128			*
129			* @return \Requests_Response
130			*/
131			public function put( $path = '', $options = array() ) {
132			return Requests::put( $this->getPathURI( $path ), $this->requestHeader,
133			$this->addDataToRequest( $options, true ) );
			0 ignored issues – show Bug introduced 2016-12-14 09:10 UTC by Report Bug Copy Issue Report It seems like `$this->addDataToRequest($options, true)` targeting `JCFirebase\JCFirebase::addDataToRequest()` can also be of type `string`; however, `Requests::put()` does only seem to accept `array`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
134			}
135
136			/**
137			* @param string $path
138			* @param array $options
139			*
140			* @return \Requests_Response
141			*/
142			public function post( $path = '', $options = array() ) {
143			return Requests::post( $this->getPathURI( $path ), $this->requestHeader,
144			$this->addDataToRequest( $options, true ) );
			0 ignored issues – show Bug introduced 2016-12-14 09:10 UTC by Report Bug Copy Issue Report It seems like `$this->addDataToRequest($options, true)` targeting `JCFirebase\JCFirebase::addDataToRequest()` can also be of type `string`; however, `Requests::post()` does only seem to accept `array`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
145			}
146
147			/**
148			* @param string $path
149			* @param array $options
150			*
151			* @return \Requests_Response
152			*/
153			public function patch( $path = '', $options = array() ) {
154			return Requests::patch( $this->getPathURI( $path ), $this->requestHeader,
155			$this->addDataToRequest( $options, true ) );
			0 ignored issues – show Bug introduced 2016-12-14 09:10 UTC by Report Bug Copy Issue Report It seems like `$this->addDataToRequest($options, true)` targeting `JCFirebase\JCFirebase::addDataToRequest()` can also be of type `string`; however, `Requests::patch()` does only seem to accept `array`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
156			}
157
158			/**
159			* @param string $path
160			* @param array $options
161			*
162			* @return \Requests_Response
163			*/
164			public function delete( $path = '', $options = array() ) {
165			return Requests::delete( $this->getPathURI( $path ), $this->requestHeader,
166			$this->addDataToRequest( $options ) );
			0 ignored issues – show Bug introduced 2016-12-14 09:10 UTC by Report Bug Copy Issue Report It seems like `$this->addDataToRequest($options)` targeting `JCFirebase\JCFirebase::addDataToRequest()` can also be of type `string`; however, `Requests::delete()` does only seem to accept `array`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
167			}
168
169			protected function refreshToken() {
170			$this->requestHeader['Authorization'] = 'Bearer ' . $this->auth->getAccessToken();
171			}
172
173			protected function addDataToPathURI( $path = '', $options = array(), $reqType = JCFirebaseOption::REQ_TYPE_GET ) {
174			$print = '';
175			if ( isset( $options['print'] ) ) {
176			if ( JCFirebaseOption::isAllowPrint( $reqType, $options['print'] ) ) {
177			$print = $options['print'];
178			}
179			}
180
181			return $this->getPathURI( $path, $print );
182			}
183
184			protected function addDataToRequest( $options = array(), $jsonEncode = false ) {
185			$requestOptions = array();
186
187			if ( isset( $options['data'] ) ) {
188			$requestOptions = array_merge( $options['data'], $requestOptions );
189			}
190
191			if ( $jsonEncode ) {
192			$requestOptions = json_encode( $requestOptions );
193			}
194
195			return $requestOptions;
196			}
197			}

jaredchu / JC-Firebase-PHP

GitHub Access Token became invalid

Push — master ( df19ab...5f95fa )

JCFirebase::get() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like