#1807: Fix typo in README.md and update class names to match GitHub API naming conventions.

Author: yegor256

README.md

@@ -18,7 +18,7 @@ we have a unique implemenation of GitHub server-side functionality,
 which you can use in your unit tests, eliminating the necessity to connect
 to GitHub during unit/integration testing.
 Please, read the blog post
-[_Object-Oriented Github API_][blog]
+[_Object-Oriented GitHub API_][blog]
 by [Yegor Bugayenko](https://www.yegor256.com), the creator of this library.
 
 Java 8 or higher is required.
@@ -31,15 +31,15 @@ The set of classes in the
 [`com.jcabi.github`][package]
 package is the object-oriented API. Use it like this:
 
-## Work with Github's API
+## Work with GitHub's API
 
-By default, the library works with Github's API (https://api.github.com)
+By default, the library works with GitHub's API (https://api.github.com)
 
 ```java
 import com.jcabi.github.*;
 public class Main {
   public static void main(String[] args) throws IOException {
-    Github github = new RtGithub(".. your OAuth token ..");
+    GitHub github = new RtGitHub(".. your OAuth token ..");
     Repo repo = github.repos().get(
         new Coordinates.Simple("octocat/Hello-World")
     );
@@ -49,56 +49,56 @@ public class Main {
 }
 ```
 
-## Work with Github Enterprise or other
+## Work with GitHub Enterprise or other
 
-If you want to work with Github's API through another domain,
+If you want to work with GitHub's API through another domain,
 you can use the URI-constructors
-of class `RtGithub`. For instance, if you have your own instance
-of Github deployed under the
+of class `RtGitHub`. For instance, if you have your own instance
+of GitHub deployed under the
 domain `https://github.mydomain.com`, do the following:
 
 ```java
-final Github github = new RtGithub(URI.create("https://github.mydomain.com"));
+final GitHub github = new RtGitHub(URI.create("https://github.mydomain.com"));
 
 //OR
 
-final Github github = new RtGithub(
+final GitHub github = new RtGitHub(
     "<<oauth2_token>>",
     URI.create("https://github.mydomain.com")
 );
 
 //OR
 
-final Github github = new RtGithub(
+final GitHub github = new RtGitHub(
     "username", "password",
     URI.create("https://github.mydomain.com")
 );
 ```
 
 **DO NOT** change or mask your URIs!
-Using Github under a different domain is fine but do not
+Using GitHub under a different domain is fine but do not
 change the URI **paths**. Changing the requests'
 paths is not possible since the whole architecture
-of this library relies on Github's URI paths.
+of this library relies on GitHub's URI paths.
 
 For more complex configurations, you can instantiate
-`RtGithub` with your own custom `Request`,
-by using the [RtGithub(Request)][RtGithub] constructor.
+`RtGitHub` with your own custom `Request`,
+by using the [RtGitHub(Request)][RtGitHub] constructor.
 Be sure to configure the `Request` properly.
 See how the [default Request][Request]
 is created -- you basically have to do the same thing.
 
 ## Mock Implementation Of The API
 
-We also provide [MkGithub],
+We also provide [MkGitHub],
 a mock version of the GitHub server, which
 you can use in your unit tests, for example:
 
 ```java
 import com.jcabi.github.*;
 public class FooTest {
-  public void submitsCommentToGithubIssue() {
-    final Repo repo = new MkGithub().repos().create(
+  public void submitsCommentToGitHubIssue() {
+    final Repo repo = new MkGitHub().repos().create(
       Json.createObjectBuilder().add("name", "test").build()
     );
     final Issue issue = repo.issues().create("how are you?", "");
@@ -124,8 +124,8 @@ mvn clean install -Pqulice
 ```
 
 There are many integration tests that check our classes against
-live Github accounts. In order to run them, you should create
-a new Github OAuth access tokens
+live GitHub accounts. In order to run them, you should create
+a new GitHub OAuth access tokens
 ([how?][pat),
 and provide them in command line, like this:
 
@@ -134,7 +134,7 @@ mvn clean install -Dit.test=RtGistITCase -Dfailsafe.github.key=<token> -Dfailsaf
 ```
 
 Replace `<token>` and `<second-token>` with the OAuth access tokens
-  of two different Github
+  of two different GitHub
 accounts. This test case will try to fork a gist from first account
 into second. Replace
 `<repo>` with the name of repository you create in your first account
@@ -172,7 +172,7 @@ mvn clean install -DskipTests -Dinvoker.skip=true -Pqulice
 [GitHub RESTful API]: https://developer.github.com/v3/
 [blog]: https://www.yegor256.com/2014/05/14/object-oriented-github-java-sdk.html
 [pat]: https://help.github.com/articles/creating-an-access-token-for-command-line-use
-[MkGithub]: https://static.javadoc.io/com.jcabi/jcabi-github/1.0/com/jcabi/github/mock/MkGithub.html
-[RtGithub]: https://github.com/jcabi/jcabi-github/blob/master/src/main/java/com/jcabi/github/RtGithub.java#L147
+[MkGitHub]: https://static.javadoc.io/com.jcabi/jcabi-github/1.0/com/jcabi/github/mock/MkGitHub.html
+[RtGitHub]: https://github.com/jcabi/jcabi-github/blob/master/src/main/java/com/jcabi/github/RtGitHub.java#L147
 [package]: https://static.javadoc.io/com.jcabi/jcabi-github/1.0/com/jcabi/github/package-frame.html
-[Request]: https://github.com/jcabi/jcabi-github/blob/master/src/main/java/com/jcabi/github/RtGithub.java#L82
+[Request]: https://github.com/jcabi/jcabi-github/blob/master/src/main/java/com/jcabi/github/RtGitHub.java#L82

examples/search-repos/README.md

@@ -1,5 +1,5 @@
 This micro Maven project shows how you can
-use this library in order to access Github API
+use this library in order to access GitHub API
 directly through RESTful requests.
 
 Just run it with:

examples/search-repos/src/main/java/com/jcabi/Main.java

@@ -4,8 +4,8 @@
  */
 package com.jcabi;
 
-import com.jcabi.github.Github;
-import com.jcabi.github.RtGithub;
+import com.jcabi.github.GitHub;
+import com.jcabi.github.RtGitHub;
 import com.jcabi.http.response.JsonResponse;
 import java.util.List;
 import javax.json.JsonObject;
@@ -22,7 +22,7 @@ public final class Main {
      * @param args Command line arguments
      */
     public static void main(final String[] args) throws Exception {
-        final Github github = new RtGithub();
+        final GitHub github = new RtGitHub();
         final JsonResponse resp = github.entry()
             .uri().path("/search/repositories")
             .queryParam("q", "java").back()

pom.xml

@@ -14,7 +14,7 @@
   <version>2.0-SNAPSHOT</version>
   <packaging>jar</packaging>
   <name>jcabi-github</name>
-  <description>Object Oriented Github API</description>
+  <description>Object Oriented GitHub API</description>
   <issueManagement>
     <system>github</system>
     <url>https://github.com/jcabi/jcabi-github/issues</url>

src/it/basic-usage/src/test/java/com/jcabi/foo/SampleTest.java

@@ -5,9 +5,9 @@
 package com.jcabi.foo;
 
 import com.jcabi.github.Coordinates;
-import com.jcabi.github.Github;
+import com.jcabi.github.GitHub;
 import com.jcabi.github.Repo;
-import com.jcabi.github.RtGithub;
+import com.jcabi.github.RtGitHub;
 import org.hamcrest.MatcherAssert;
 import org.hamcrest.Matchers;
 import org.junit.Test;
@@ -18,12 +18,12 @@
 public final class SampleTest {
 
     /**
-     * Fetches labels from Github.
+     * Fetches labels from GitHub.
      * @throws Exception If fails
      */
     @Test
-    public void fetchesLabelsFromGithub() throws Exception {
-        final Github github = new RtGithub();
+    public void fetchesLabelsFromGitHub() throws Exception {
+        final GitHub github = new RtGitHub();
         final Repo repo = github.repos().get(
             new Coordinates.Simple("jcabi/jcabi-github")
         );

src/it/fat-jar/pom.xml

@@ -24,12 +24,12 @@
               <!-- <classpathScope>compile</classpathScope> -->
               <source><![CDATA[
                 import com.jcabi.github.Coordinates
-                import com.jcabi.github.Github
+                import com.jcabi.github.GitHub
                 import com.jcabi.github.Label
                 import com.jcabi.github.Repo
-                import com.jcabi.github.RtGithub
+                import com.jcabi.github.RtGitHub
                 import java.io.IOException
-                final Github github = new RtGithub()
+                final GitHub github = new RtGitHub()
                 final Repo repo = github.repos().get(
                     new Coordinates.Simple("jcabi/jcabi-github")
                 )

src/main/java/com/jcabi/github/Blob.java

@@ -12,7 +12,7 @@
 import lombok.ToString;
 
 /**
- * Github Git blob.
+ * GitHub Git blob.
  *
  * @see <a href="https://developer.github.com/v3/git/blobs/">Blobs API</a>
  * @checkstyle MultipleStringLiterals (500 lines)

src/main/java/com/jcabi/github/Blobs.java

@@ -8,7 +8,7 @@
 import java.io.IOException;
 
 /**
- * Github Git Data Blobs.
+ * GitHub Git Data Blobs.
  *
  * @since 0.8
  * @see <a href="https://developer.github.com/v3/git/blobs/">Blobs API</a>

src/main/java/com/jcabi/github/Bulk.java

@@ -14,7 +14,7 @@
  * Bulk items, with pre-saved JSON.
  *
  * <p>This class should be used as a decorator for object obtained
- * from Github, when you want to keep their JSON values in memory. For
+ * from GitHub, when you want to keep their JSON values in memory. For
  * example:
  *
  * <pre> Iterable&lt;Issue&gt; issues = repo.issues().iterate(
@@ -24,8 +24,8 @@
  *   System.out.println(new Issue.Smart(issue).title());
  * }</pre>
  *
- * <p>Let's say, there are 50 issues in Github's repo. This code will
- * make 52 HTTP requests to Github. The first one will fetch the first
+ * <p>Let's say, there are 50 issues in GitHub's repo. This code will
+ * make 52 HTTP requests to GitHub. The first one will fetch the first
  * 30 issues in JSON array. Then, for every one of them, in order
  * to retrieve issue title a separate HTTP request will be made. Then,
  * one more page will be fetched, with 20 issues. And again, 20 new

src/main/java/com/jcabi/github/Check.java

@@ -9,7 +9,7 @@
 import java.util.Locale;
 
 /**
- * Github check.
+ * GitHub check.
  *
  * @see <a href="https://docs.github.com/en/rest/checks/runs?apiVersion=2022-11-28">Check Runs API</a>
  * @since 1.5.0
@@ -81,8 +81,8 @@ public String value() {
          * @param value String value.
          * @return Status.
          */
-        public static Status fromString(final String value) {
-            return Arrays.stream(Status.values())
+        public static Check.Status fromString(final String value) {
+            return Arrays.stream(Check.Status.values())
                 .filter(stat -> stat.same(value))
                 .findFirst()
                 .orElseThrow(
@@ -97,7 +97,7 @@ public static Status fromString(final String value) {
          * @return True if check is finished.
          */
         boolean finished() {
-            return this == Status.COMPLETED;
+            return this == Check.Status.COMPLETED;
         }
 
         /**
@@ -181,8 +181,8 @@ enum Conclusion {
          * @param value String value.
          * @return Conclusion.
          */
-        public static Conclusion fromString(final String value) {
-            return Arrays.stream(Conclusion.values())
+        public static Check.Conclusion fromString(final String value) {
+            return Arrays.stream(Check.Conclusion.values())
                 .filter(stat -> stat.same(value))
                 .findFirst()
                 .orElseThrow(
@@ -205,7 +205,7 @@ public String value() {
          * @return True if check is successful.
          */
         boolean successful() {
-            return this == Conclusion.SUCCESS;
+            return this == Check.Conclusion.SUCCESS;
         }
 
         /**