Merge pull request #8 from bdbch/2-repository-hooks

2 repository hooks

Author: bdbch

README.md

@@ -61,3 +61,43 @@ function MyComponent() {
   // your component
 }
 ```
+
+### Get latest release from repo
+
+```js
+import { useLatestRelease } from "@d2k/react-github";
+
+function MyComponent() {
+  const { release, loading, error } = useLatestRelease("facebook", "react");
+
+  // your component
+}
+```
+
+### Get release by tag from repo
+
+```js
+import { useTaggedRelease } from "@d2k/react-github";
+
+function MyComponent() {
+  const { release, loading, error } = useTaggedRelease(
+    "facebook",
+    "react",
+    "v16.8.4"
+  );
+
+  // your component
+}
+```
+
+### List forks from repo
+
+```js
+import { useForks } from "@d2k/react-github";
+
+function MyComponent() {
+  const { forks, loading, error } = useForks("facebook", "react");
+
+  // your component
+}
+```

docs/components/Collaborators.jsx

@@ -0,0 +1,26 @@
+import React from "react";
+import { useCollaborators } from "../../src";
+
+const Forks = () => {
+  const { collaborators, loading, error } = useCollaborators(
+    "facebook",
+    "react"
+  );
+
+  return (
+    <div>
+      <h1>Collaborators by repo</h1>
+      {loading && <div>Loading collaborators from Github</div>}
+      {error && <div>{error}</div>}
+      {collaborators &&
+        collaborators.length > 0 &&
+        collaborators.map(collaborator => (
+          <div key={collaborator.id}>
+            <h4>{collaborator.login}</h4>
+          </div>
+        ))}
+    </div>
+  );
+};
+
+export default Forks;

docs/components/Forks.jsx

@@ -0,0 +1,23 @@
+import React from "react";
+import { useForks } from "../../src";
+
+const Forks = () => {
+  const { forks, loading, error } = useForks("facebook", "react");
+
+  return (
+    <div>
+      <h1>Forks by repo</h1>
+      {loading && <div>Loading forks from Github</div>}
+      {error && <div>{error}</div>}
+      {forks &&
+        forks.length > 0 &&
+        forks.map(fork => (
+          <div key={fork.id}>
+            <h4>{fork.full_name}</h4>
+          </div>
+        ))}
+    </div>
+  );
+};
+
+export default Forks;

docs/components/LatestRelease.jsx

@@ -0,0 +1,30 @@
+import React from "react";
+import { useLatestRelease } from "../../src";
+
+const LatestRelease = () => {
+  const { release, loading, error } = useLatestRelease("facebook", "react");
+
+  return (
+    <div>
+      <h1>Latest release by repo</h1>
+      {loading && <div>Loading release from Github</div>}
+      {error && <div>{error}</div>}
+      {release && (
+        <div>
+          <h4>
+            <a
+              href={release.html_url}
+              target="_blank"
+              rel="nofollow noreferrer"
+            >
+              {release.name}
+            </a>
+          </h4>
+          <div>{release.body}</div>
+        </div>
+      )}
+    </div>
+  );
+};
+
+export default LatestRelease;

docs/components/TaggedRelease.jsx

@@ -0,0 +1,34 @@
+import React from "react";
+import { useTaggedRelease } from "../../src";
+
+const TaggedRelease = () => {
+  const { release, loading, error } = useTaggedRelease(
+    "facebook",
+    "react",
+    "v16.8.4"
+  );
+
+  return (
+    <div>
+      <h1>Tagged release by repo</h1>
+      {loading && <div>Loading release from Github</div>}
+      {error && <div>{error}</div>}
+      {release && (
+        <div>
+          <h4>
+            <a
+              href={release.html_url}
+              target="_blank"
+              rel="nofollow noreferrer"
+            >
+              {release.tag_name}
+            </a>
+          </h4>
+          <div>{release.body}</div>
+        </div>
+      )}
+    </div>
+  );
+};
+
+export default TaggedRelease;

docs/example.js

@@ -4,6 +4,10 @@ import Repos from "./components/Repos";
 import User from "./components/User";
 import Branches from "./components/Branches";
 import Branch from "./components/Branch";
+import LatestRelease from "./components/LatestRelease";
+import TaggedRelease from "./components/TaggedRelease";
+import Forks from "./components/Forks";
+import Collaborators from "./components/Collaborators";
 
 function App() {
   return (
@@ -16,6 +20,12 @@ function App() {
       <hr />
       <Branch />
       <hr />
+      <LatestRelease />
+      <hr />
+      <TaggedRelease />
+      <hr />
+      <Forks />
+      <hr />
     </div>
   );
 }

src/index.js

@@ -1,22 +1,30 @@
 import useRepos from './lib/useRepos'
 import useUser from './lib/useUser'
-import {
-  useBranches,
-} from './lib/branch/useBranches'
-import {
-  useBranch
-} from './lib/branch/useBranch'
+import useBranches from './lib/branch/useBranches'
+import useBranch from './lib/branch/useBranch'
+import useLatestRelease from './lib/release/useLatestRelease'
+import useTaggedRelease from './lib/release/useTaggedRelease'
+import useForks from './lib/repository/useForks'
+import useCollaborators from './lib/repository/useCollaborators'
 
 export {
   useRepos,
   useUser,
   useBranches,
   useBranch,
+  useLatestRelease,
+  useTaggedRelease,
+  useForks,
+  useCollaborators,
 }
 
 export default {
   useRepos,
   useUser,
   useBranches,
   useBranch,
+  useLatestRelease,
+  useTaggedRelease,
+  useForks,
+  useCollaborators,
 }

src/lib/branch/useBranch.js

@@ -3,7 +3,7 @@ import {
   useEffect
 } from 'react'
 
-export const useBranch = (owner, repo, branchName) => {
+export default function useBranch(owner, repo, branchName) {
   const [branch, setBranch] = useState(null)
   const [loading, setLoading] = useState(false)
   const [error, setError] = useState(null)

src/lib/branch/useBranches.js

@@ -3,7 +3,7 @@ import {
   useEffect
 } from 'react'
 
-export const useBranches = (owner, repo) => {
+export default function useBranches(owner, repo) {
   const [branches, setBranches] = useState([])
   const [loading, setLoading] = useState(false)
   const [error, setError] = useState(null)

src/lib/release/useLatestRelease.js

@@ -0,0 +1,35 @@
+import {
+  useState,
+  useEffect
+} from 'react'
+
+export default function useLatestRelease(owner, repo) {
+  const [release, setRelease] = useState(null)
+  const [loading, setLoading] = useState(false)
+  const [error, setError] = useState(null)
+
+  useEffect(() => {
+    if (owner && owner.length > 0 && repo && repo.length > 0) {
+      setError(null)
+      setLoading(true)
+
+      fetch(`https://api.github.com/repos/${owner}/${repo}/releases/latest`)
+        .then(res => res.json())
+        .then(data => {
+          setLoading(false)
+          setRelease(data)
+        })
+        .catch(e => {
+          setLoading(false)
+          setRelease(null)
+          setError(e)
+        })
+    }
+  }, [owner, repo])
+
+  return {
+    release,
+    loading,
+    error
+  }
+}