github-api.php: 1.3 vs 1.9 · Github Embed

← All changes | github-api.php +73 -59 1.9 → 1.3 View file →

		@@ -1,21 +1,21 @@
1		-<?php
	1	+<?php
2	2
3		-// 0 - none.
4		-define( 'GEDEBUG_NONE', 0 );
5	3
6		-// 1 - call logging only.
7		-define( 'GEDEBUG_CALL', 1 );
8	4
9		-// 2 - calls, and responses.
10		-define( 'GEDEBUG_RESP', 2 );
	5	+// 0 - none
	6	+define ( 'GEDEBUG_NONE', 0 );
11	7
12		-// Selected debug level.
13		-if ( ! defined( 'GITHUB_API_LEVEL' ) ) {
14		- define( 'GITHUB_API_LEVEL', GEDEBUG_NONE );
15		-}
	8	+// 1 - call logging only
	9	+define ( 'GEDEBUG_CALL', 1 );
16	10
	11	+// 2 - calls, and responses
	12	+define ( 'GEDEBUG_RESP', 2 );
17	13
	14	+// Selected debug level
	15	+define ( 'GITHUB_API_LEVEL', GEDEBUG_RESP );
	16	+
	17	+
18	18	/**
19	19	* This class contains all the functions that actually retrieve information from the GitHub API
20	20	*/
21	21	class github_api {
		@@ -30,10 +30,10 @@
30	30	* Allow the client ID / secret to be set, and used for subsequent calls
31	31	*/
32	32	function __construct() {
33	33
34		- add_action( 'plugins_loaded', array( $this, 'set_credentials' ) );
35		- add_filter( 'http_request_timeout', array( $this, 'http_request_timeout' ) );
	34	+ add_action ( 'plugins_loaded', array ( $this, 'set_credentials' ) );
	35	+ add_filter ( 'http_request_timeout', array ( $this, 'http_request_timeout' ) );
36	36
37	37	}
38	38
39	39
		@@ -42,9 +42,9 @@
42	42	* Extend the timeout since API calls can easily exceed 5 seconds
43	43	* @param int $seconds The current timeout setting
44	44	* @return int The revised timeout setting
45	45	*/
46		- function http_request_timeout( $seconds ) {
	46	+ function http_request_timeout ( $seconds ) {
47	47	return $seconds < 25 ? 25 : $seconds;
48	48	}
49	49
50	50
		@@ -50,43 +50,42 @@
50	50
51	51
52	52	/**
53	53	* If you find yourself hitting rate limits, then you can register an application
54		- * with GitHub(http://developer.github.com/v3/oauth/) use the filters here to
	54	+ * with GitHub (http://developer.github.com/v3/oauth/) use the filters here to
55	55	* provide the credentials.
56	56	*/
57		- public function set_credentials() {
58		- $this->client_id = apply_filters( 'github-embed-client-id', $this->client_id );
59		- $this->client_secret = apply_filters( 'github-embed-client-secret', $this->client_secret );
	57	+ public function set_credentials () {
	58	+
	59	+ $this->client_id = apply_filters ( 'github-embed-client-id', $this->client_id );
	60	+ $this->client_secret = apply_filters ( 'github-embed-client-secret', $this->client_id );
	61	+
60	62	}
61	63
62	64
63	65
64		- private function call_api( $url ) {
	66	+ private function call_api ( $url ) {
65	67
66	68	// Allow users to supply auth details to enable a higher rate limit
67		- if ( ! empty( $this->client_id ) && ! empty( $this->client_secret ) ) {
68		- $url = add_query_arg(
69		- array(
70		- 'client_id' => $this->client_id,
71		- 'client_secret' => $this->client_secret ),
72		- $url
73		- );
	69	+ if ( ! empty ( $this->client_id ) && ! empty ( $this->client_secret ) ) {
	70	+ $url = add_query_arg(array ( 'client_id' => $this->client_id,
	71	+ 'client_secret' => $this->client_secret),
	72	+ $url );
74	73	}
75	74
76		- $args = array( 'user-agent' => 'WordPress Github oEmbed plugin - https://github.com/leewillis77/wp-github-oembed');
	75	+ $args = array ( 'user-agent' => 'WordPress Github oEmbed plugin - https://github.com/leewillis77/wp-github-oembed');
	76	+
	77	+ $this->log ( __FUNCTION__." : $url", GEDEBUG_CALL );
77	78
78		- $this->log( __FUNCTION__." : $url", GEDEBUG_CALL );
	79	+ $results = wp_remote_get ( $url, $args );
79	80
80		- $results = wp_remote_get( $url, $args );
	81	+ $this->log ( __FUNCTION__." : ".print_r($results,1), GEDEBUG_RESP );
81	82
82		- $this->log( __FUNCTION__ . " : " . print_r( $results,1 ), GEDEBUG_RESP );
83		-
84		- if( is_wp_error( $results ) \|\|
85		- ! isset( $results['response']['code'] ) \|\|
	83	+ if ( is_wp_error( $results ) \|\|
	84	+ ! isset ( $results['response']['code'] ) \|\|
86	85	$results['response']['code'] != '200' ) {
87		- header( 'HTTP/1.0 404 Not Found' );
88		- die( 'Octocat is lost, and afraid' );
	86	+ header ( 'HTTP/1.0 404 Not Found' );
	87	+ die ( 'Octocat is lost, and afraid' );
89	88	}
90	89
91	90	return $results;
92	91
		@@ -99,16 +98,19 @@
99	98	* @param string $owner The repository's owner
100	99	* @param string $repository The respository name
101	100	* @return object The response from the GitHub API
102	101	*/
103		- public function get_repo( $owner, $repository ) {
	102	+ public function get_repo ( $owner, $repository ) {
104	103
105		- $this->log( "get_repo( $owner, $repository )", GEDEBUG_CALL );
	104	+ $this->log ( "get_repo ( $owner, $repository )", GEDEBUG_CALL );
106	105
107		- $results = $this->call_api( "https://api.github.com/repos/$owner/$repository" );
	106	+ $owner = trim ( $owner, '/' );
	107	+ $repository = trim ( $repository, '/' );
108	108
109		- return json_decode( $results['body'] );
	109	+ $results = $this->call_api ( "https://api.github.com/repos/$owner/$repository" );
110	110
	111	+ return json_decode ( $results['body'] );
	112	+
111	113	}
112	114
113	115
114	116
		@@ -117,16 +119,19 @@
117	119	* @param string $owner The repository's owner
118	120	* @param string $repository The respository name
119	121	* @return object The response from the GitHub API
120	122	*/
121		- public function get_repo_commits( $owner, $repository ) {
	123	+ public function get_repo_commits ( $owner, $repository ) {
122	124
123		- $this->log( "get_repo_commits( $owner, $repository )", GEDEBUG_CALL );
	125	+ $this->log ( "get_repo_commits ( $owner, $repository )", GEDEBUG_CALL );
124	126
125		- $results = $this->call_api( "https://api.github.com/repos/$owner/$repository/commits" );
	127	+ $owner = trim ( $owner, '/' );
	128	+ $repository = trim ( $repository, '/' );
126	129
127		- return json_decode( $results['body'] );
	130	+ $results = $this->call_api ( "https://api.github.com/repos/$owner/$repository/commits" );
128	131
	132	+ return json_decode ( $results['body'] );
	133	+
129	134	}
130	135
131	136
132	137
		@@ -136,28 +141,34 @@
136	141	* @param string $repository The respository name
137	142	* @param string $milestone The milestone ID
138	143	* @return object The response from the GitHub API
139	144	*/
140		- public function get_repo_milestone_summary( $owner, $repository, $milestone ) {
	145	+ public function get_repo_milestone_summary ( $owner, $repository, $milestone ) {
141	146
142		- $this->log( "get_repo_milestone_summary( $owner, $repository, $milestone )", GEDEBUG_CALL );
	147	+ $this->log ( "get_repo_milestone_summary ( $owner, $repository, $milestone )", GEDEBUG_CALL );
143	148
144		- $results = $this->call_api( "https://api.github.com/repos/$owner/$repository/milestones/$milestone" );
	149	+ $owner = trim ( $owner, '/' );
	150	+ $repo = trim ( $repo, '/' );
145	151
146		- return json_decode( $results['body'] );
	152	+ $results = $this->call_api ( "https://api.github.com/repos/$owner/$repository/milestones/$milestone" );
147	153
	154	+ return json_decode ( $results['body'] );
	155	+
148	156	}
149	157
150	158
151	159
152		- public function get_repo_contributors( $owner, $repository ) {
	160	+ public function get_repo_contributors ( $owner, $repository ) {
153	161
154		- $this->log( "get_repo_contributors( $owner, $repository )", GEDEBUG_CALL );
	162	+ $this->log ( "get_repo_contributors ( $owner, $repository )", GEDEBUG_CALL );
155	163
156		- $results = $this->call_api( "https://api.github.com/repos/$owner/$repository/stats/contributors" );
	164	+ $owner = trim ( $owner, '/' );
	165	+ $repo = trim ( $repo, '/' );
157	166
158		- return json_decode( $results['body'] );
	167	+ $results = $this->call_api( "https://api.github.com/repos/$owner/$repository/collaborators" );
159	168
	169	+ return json_decode ( $results['body'] );
	170	+
160	171	}
161	172
162	173
163	174
		@@ -165,25 +176,28 @@
165	176	* Get a user from the GitHub API
166	177	* @param string $user The username
167	178	* @return object The response from the GitHub API
168	179	*/
169		- public function get_user( $user ) {
	180	+ public function get_user ( $user ) {
170	181
171		- $this->log( "get_user( $user )", GEDEBUG_CALL );
	182	+ $this->log ( "get_user ( $user )", GEDEBUG_CALL );
172	183
173		- $results = $this->call_api( "https://api.github.com/users/$user" );
	184	+ $user = trim ( $user, '/' );
	185	+ $repository = trim ( $repository, '/' );
174	186
175		- return json_decode( $results['body'] );
	187	+ $results = $this->call_api ( "https://api.github.com/users/$user" );
176	188
	189	+ return json_decode ( $results['body'] );
	190	+
177	191	}
	192	+
178	193
179	194
180		-
181		- private function log( $msg, $level ) {
	195	+ private function log ( $msg, $level ) {
182	196	if ( GITHUB_API_LEVEL >= $level ) {
183		- error_log( "[GE$level]: ".$msg );
	197	+ error_log ( "[GE$level]: ".$msg );
184	198	}
185	199	}
186	200
187	201
188	202
189		-}
	203	+}