Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Methods for Checks API #182

Merged
merged 4 commits into from
Apr 16, 2020
Merged

Methods for Checks API #182

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
119f402
Implement Check Runs methods
axel-op Oct 17, 2019
d77611f
Implement Check Suites methods
axel-op Mar 9, 2020
bf6d317
Make public the class EnumWithValue
axel-op Apr 12, 2020
e418f23
Format json.dart
axel-op Apr 12, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions lib/src/common.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,15 @@
/// Contains the Models and other GitHub stuff.
export 'package:github/src/common/activity_service.dart';
export 'package:github/src/common/authorizations_service.dart';
export 'package:github/src/common/checks_service.dart';
export 'package:github/src/common/gists_service.dart';
export 'package:github/src/common/git_service.dart';
export 'package:github/src/common/github.dart';
export 'package:github/src/common/issues_service.dart';
export 'package:github/src/common/misc_service.dart';
export 'package:github/src/common/model/activity.dart';
export 'package:github/src/common/model/authorizations.dart';
export 'package:github/src/common/model/checks.dart';
export 'package:github/src/common/model/gists.dart';
export 'package:github/src/common/model/git.dart';
export 'package:github/src/common/model/issues.dart';
Expand Down
353 changes: 353 additions & 0 deletions lib/src/common/checks_service.dart
View file
Open in desktop

Large diffs are not rendered by default.

98 changes: 45 additions & 53 deletions lib/src/common/github.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ class GitHub {
SearchService _search;
UrlShortenerService _urlShortener;
UsersService _users;
ChecksService _checks;

/// The maximum number of requests that the consumer is permitted to make per
/// hour.
Expand Down Expand Up @@ -79,67 +80,53 @@ class GitHub {
int _rateLimitReset, _rateLimitLimit, _rateLimitRemaining;

/// Service for activity related methods of the GitHub API.
ActivityService get activity {
return _activity ??= ActivityService(this);
}
ActivityService get activity => _activity ??= ActivityService(this);

/// Service for autorizations related methods of the GitHub API.
///
/// Note: You can only access this API via Basic Authentication using your
/// username and password, not tokens.
AuthorizationsService get authorizations {
return _authorizations ??= AuthorizationsService(this);
}
AuthorizationsService get authorizations =>
_authorizations ??= AuthorizationsService(this);

/// Service for gist related methods of the GitHub API.
GistsService get gists {
return _gists ??= GistsService(this);
}
GistsService get gists => _gists ??= GistsService(this);

/// Service for git data related methods of the GitHub API.
GitService get git {
return _git ??= GitService(this);
}
GitService get git => _git ??= GitService(this);

/// Service for issues related methods of the GitHub API.
IssuesService get issues {
return _issues ??= IssuesService(this);
}
IssuesService get issues => _issues ??= IssuesService(this);

/// Service for misc related methods of the GitHub API.
MiscService get misc {
return _misc ??= MiscService(this);
}
MiscService get misc => _misc ??= MiscService(this);

/// Service for organization related methods of the GitHub API.
OrganizationsService get organizations {
return _organizations ??= OrganizationsService(this);
}
OrganizationsService get organizations =>
_organizations ??= OrganizationsService(this);

/// Service for pull requests related methods of the GitHub API.
PullRequestsService get pullRequests {
return _pullRequests ??= PullRequestsService(this);
}
PullRequestsService get pullRequests =>
_pullRequests ??= PullRequestsService(this);

/// Service for repository related methods of the GitHub API.
RepositoriesService get repositories {
return _repositories ??= RepositoriesService(this);
}
RepositoriesService get repositories =>
_repositories ??= RepositoriesService(this);

/// Service for search related methods of the GitHub API.
SearchService get search {
return _search ??= SearchService(this);
}
SearchService get search => _search ??= SearchService(this);

/// Service to provide a handy method to access GitHub's url shortener.
UrlShortenerService get urlShortener {
return _urlShortener ??= UrlShortenerService(this);
}
UrlShortenerService get urlShortener =>
_urlShortener ??= UrlShortenerService(this);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for shortening up this code and above.


/// Service for user related methods of the GitHub API.
UsersService get users {
return _users ??= UsersService(this);
}
UsersService get users => _users ??= UsersService(this);

/// Service containing methods to interact with the Checks API.
///
/// See https://developer.github.com/v3/checks/
ChecksService get checks => _checks ??= ChecksService(this);

/// Handles Get Requests that respond with JSON
/// [path] can either be a path like '/repos' or a full url.
Expand All @@ -154,20 +141,25 @@ class GitHub {
/// [convert] is a simple function that is passed this [GitHub] instance and a JSON object.
/// The future will pass the object returned from this function to the then method.
/// The default [convert] function returns the input object.
Future<T> getJSON<S, T>(String path,
{int statusCode,
void Function(http.Response response) fail,
Map<String, String> headers,
Map<String, dynamic> params,
JSONConverter<S, T> convert,
String preview}) =>
_requestJson('GET', path,
statusCode: statusCode,
fail: fail,
headers: headers,
params: params,
convert: convert,
preview: preview);
Future<T> getJSON<S, T>(
String path, {
int statusCode,
void Function(http.Response response) fail,
Map<String, String> headers,
Map<String, String> params,
JSONConverter<S, T> convert,
String preview,
}) =>
requestJson(
'GET',
path,
statusCode: statusCode,
fail: fail,
headers: headers,
params: params,
convert: convert,
preview: preview,
);

/// Handles Post Requests that respond with JSON
///
Expand Down Expand Up @@ -199,7 +191,7 @@ class GitHub {
dynamic body,
String preview,
}) =>
_requestJson(
requestJson(
'POST',
path,
statusCode: statusCode,
Expand Down Expand Up @@ -241,7 +233,7 @@ class GitHub {
dynamic body,
String preview,
}) =>
_requestJson(
requestJson(
'PUT',
path,
statusCode: statusCode,
Expand All @@ -253,7 +245,7 @@ class GitHub {
preview: preview,
);

Future<T> _requestJson<S, T>(
Future<T> requestJson<S, T>(
String method,
String path, {
int statusCode,
Expand Down
Loading