Add license endpoints and type (#177)

* Add license endpoints and type

Author: SaschaMann

README.md

@@ -237,6 +237,13 @@ GitHub.jl implements a bunch of methods that make REST requests to GitHub's API.
 | `update_check_run(repo, id::Int; params=...)` | `CheckRun`  | [Update the check run with the given `id`](https://developer.github.com/v3/checks/runs/#update-a-check-run) |
 
 
+#### Licenses
+| method                            | return type       | documentation                                                                                                                                 |
+| --------------------------------- | ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
+| `licenses(; params=...)`          | `Vector{License}` | [Get all commonly used licenses](https://docs.github.com/en/free-pro-team@latest/rest/reference/licenses#get-all-commonly-used-licenses)      |
+| `license(license_id; params=...)` | `License`         | [Get a license](https://docs.github.com/en/free-pro-team@latest/rest/reference/licenses#get-a-license)                                        |
+| `repo_license(repo; params=...)`  | `Content`         | [Get the license for a respository](https://docs.github.com/en/free-pro-team@latest/rest/reference/licenses#get-the-license-for-a-repository) |
+
 #### Miscellaneous
 
 | method                | return type | documentation                                                                                                |

src/GitHub.jl

@@ -79,6 +79,22 @@ export # teams.jl
        Team,
        members
 
+############
+# Licenses #
+############
+
+# include -------
+
+include("licenses/license.jl")
+
+# export -------
+
+export # license.jl
+    License,    
+    licenses,
+    license,
+    repo_license
+
 ################
 # Repositories #
 ################

src/licenses/license.jl

@@ -0,0 +1,41 @@
+################
+# License Type #
+################
+
+@ghdef mutable struct License
+    key::Union{String, Nothing}
+    name::Union{String, Nothing}
+    spdx_id::Union{String, Nothing}
+    url::Union{HTTP.URI, Nothing}
+    html_url::Union{HTTP.URI, Nothing}
+    description::Union{String, Nothing}
+    permissions::Union{Vector{String}, Nothing}
+    conditions::Union{Vector{String}, Nothing}
+    limitations::Union{Vector{String}, Nothing}
+    body::Union{String, Nothing}
+    featured::Union{Bool, Nothing}
+end
+
+License(spdx_id::AbstractString) = License(Dict("spdx_id" => spdx_id))
+
+namefield(license::License) = license.spdx_id
+
+###############
+# API Methods #
+###############
+
+@api_default function licenses(api::GitHubAPI; options...)
+    results, page_data = gh_get_paged_json(api, "/licenses"; options...)
+    results = [License(result) for result in results]
+    return results, page_data
+end
+
+@api_default function license(api::GitHubAPI, license_id; options...)
+    result = gh_get_json(api, "/licenses/$license_id"; options...)
+    return License(result)
+end
+
+@api_default function repo_license(api::GitHubAPI, repo_obj; options...)
+    result = gh_get_json(api, "/repos/$(name(repo_obj))/license"; options...)
+    return Content(result)
+end

src/repositories/contents.jl

@@ -16,6 +16,7 @@
     html_url::Union{HTTP.URI, Nothing}
     download_url::Union{HTTP.URI, Nothing}
     size::Union{Int, Nothing}
+    license::Union{License, Nothing}
 end
 
 Content(path::AbstractString) = Content(Dict("path" => path))

src/repositories/repositories.jl

@@ -30,6 +30,7 @@
     has_wiki::Union{Bool, Nothing}
     has_downloads::Union{Bool, Nothing}
     has_pages::Union{Bool, Nothing}
+    license::Union{License, Nothing}
     private::Union{Bool, Nothing}
     fork::Union{Bool, Nothing}
     permissions::Union{Dict, Nothing}

test/ghtype_tests.jl

@@ -129,6 +129,7 @@ end
         nothing,
         nothing,
         nothing,
+        nothing,
         Bool(repo_json["private"]),
         nothing,
         repo_json["permissions"]
@@ -330,7 +331,8 @@ end
         nothing,
         nothing,
         nothing,
-        content_json["size"]
+        content_json["size"],
+        nothing
     )
 
     @test Content(content_json) == content_result
@@ -1300,3 +1302,52 @@ end
 
 
 end
+
+@testset "License" begin
+    license_json = JSON.parse(
+    """
+    {
+      "key": "mit",
+      "name": "MIT License",
+      "spdx_id": "MIT",
+      "url": "https://api.github.com/licenses/mit",
+      "node_id": "MDc6TGljZW5zZW1pdA==",
+      "html_url": "http://choosealicense.com/licenses/mit/",
+      "description": "A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty.",
+      "implementation": "Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders.",
+      "permissions": [
+        "commercial-use",
+        "modifications",
+        "distribution",
+        "sublicense",
+        "private-use"
+      ],
+      "conditions": [
+        "include-copyright"
+      ],
+      "limitations": [
+        "no-liability"
+      ],
+      "body": "\\n\\nThe MIT License (MIT)\\n\\nCopyright (c) [year] [fullname]\\n\\nPermission is hereby granted, free of charge, to any person obtaining a copy\\nof this software and associated documentation files (the \\"Software\\"), to deal\\nin the Software without restriction, including without limitation the rights\\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\\ncopies of the Software, and to permit persons to whom the Software is\\nfurnished to do so, subject to the following conditions:\\n\\nThe above copyright notice and this permission notice shall be included in all\\ncopies or substantial portions of the Software.\\n\\nTHE SOFTWARE IS PROVIDED \\"AS IS\\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\\nSOFTWARE.\\n",
+      "featured": true
+    }
+    """
+    )
+
+    license_result = License(
+        license_json["key"],
+        license_json["name"],
+        license_json["spdx_id"],
+        HTTP.URI(license_json["url"]),
+        HTTP.URI(license_json["html_url"]),
+        license_json["description"],
+        license_json["permissions"],
+        license_json["conditions"],
+        license_json["limitations"],
+        license_json["body"],
+        license_json["featured"]
+    )
+
+    @test License(license_json) == license_result
+    @test name(License(license_json["spdx_id"])) == name(license_result)
+end

test/read_only_api_tests.jl

@@ -56,7 +56,10 @@ end
 
 @testset "Repositories" begin
     # test GitHub.repo
-    @test name(repo(ghjl; auth = auth)) == name(ghjl)
+    repo_obj = repo(ghjl; auth = auth)
+    @test name(repo_obj) == name(ghjl)
+    @test typeof(repo_obj.license) == License
+    @test name(repo_obj.license) == "MIT"
 
     # test GitHub.forks
     @test length(first(forks(ghjl; auth = auth))) > 0
@@ -221,3 +224,25 @@ end
     @test  GitHub.api_uri(public_gh, "/rate_limit") == HTTP.URI("https://api.github.com/rate_limit")
     @test  GitHub.api_uri(enterprise_gh, "/rate_limit") == HTTP.URI("https://git.company.com/api/v3/rate_limit")
 end
+
+@testset "Licenses" begin
+    # test GitHub.licenses
+    licenses_obj, page_data = licenses(; page_limit = 1, auth = auth)
+    @test typeof(licenses_obj) == Vector{License}
+    @test length(licenses_obj) != 0
+
+    # test GitHub.license
+    license_obj = license("MIT"; auth = auth)
+    @test typeof(license_obj) == License
+    @test name(license_obj) == "MIT"
+    @test license_obj.name == "MIT License"
+    @test startswith(license_obj.body, "MIT License\n\nCopyright (c) [year] [fullname]\n\nPermission is hereby granted,")
+
+    # test GitHub.repo_license
+    repo_license_obj = repo_license(ghjl; auth = auth)
+    @test typeof(repo_license_obj) == Content
+    @test name(repo_license_obj.license) == "MIT"
+    @test name(repo_license_obj) == "LICENSE.md"
+    @test repo_license_obj.path == "LICENSE.md"
+    @test repo_license_obj.typ == "file"
+end