github-embed / github-api.php

github-api.php in Github Embed 1.8, at github-api.php

204 lines 5.0 KB

Raw Download Zip

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