JGR-UChecker 🚀

JGR-UChecker (Java Github Releases Update Checker) é uma biblioteca Java simples e eficiente para verificar se há atualizações disponíveis em um repositório do GitHub. Com ela, você pode facilmente comparar a versão atual do seu projeto com a última versão publicada no repositório, ajudando a manter seus projetos sempre atualizados com as versões mais recentes. 🆙

✨ Funcionalidades

• Verifique a versão mais recente de um repositório no GitHub.
• Compare a versão do seu projeto com a última versão publicada.
• Determine se uma atualização está disponível, sem precisar abrir o GitHub manualmente.

⚡ Como Usar

1. Adicionando a dependência no seu projeto

Adicione o seguinte trecho no arquivo build.gradle (para Gradle) ou pom.xml (para Maven) para incluir a biblioteca JGR-UChecker no seu projeto:

Para projetos com Gradle:

repositories {
    maven {
        url "https://raw.githubusercontent.com/theprogmatheus/maven-repository/master/"
    }
}
dependencies {
    implementation 'com.github.theprogmatheus:jgr-uchecker:{version}'
}

Nota: Substitua {version} pela versão desejada do JGR-UChecker

Para projetos com Maven:

<repositories>
    <repository>
        <id>github-theprogmatheus-maven-repository</id>
        <url>https://raw.githubusercontent.com/theprogmatheus/maven-repository/master/</url>
    </repository>
</repositories>

<dependency>
    <groupId>com.github.theprogmatheus</groupId>
    <artifactId>jgr-uchecker</artifactId>
    <version>{version}</version>
</dependency>

Nota: Substitua {version} pela versão desejada do JGR-UChecker

2. Exemplo de Uso

Modo Síncrono:

Você pode verificar a última versão de um repositório de forma sincrona, ou seja, o código aguardará a resposta antes de continuar a execução.

import com.github.theprogmatheus.util.JGRUChecker;
import com.github.theprogmatheus.util.JGRUChecker.GithubRelease;

public class UpdateCheckerExample {
    public static void main(String[] args) {
        // Defina o nome de usuário do GitHub, repositório e a versão atual do seu projeto
        JGRUChecker checker = new JGRUChecker("theprogmatheus", "JGR-UChecker", "1.0.0-alpha");

        // Verifique se uma atualização está disponível
        boolean updateAvailable = checker.isUpdateAvailable();
        System.out.println("Há uma atualização disponível? " + (updateAvailable ? "Sim" : "Não"));

        // Caso haja uma atualização, obtenha os detalhes da última release
        if (updateAvailable) {
            GithubRelease lastRelease = checker.getLastRelease();
            System.out.println("Última versão: " + lastRelease.getVersion());
            System.out.println("Nome da versão: " + lastRelease.getName());
            System.out.println("Link para download: " + lastRelease.getDownloadPage());
        }
    }
}

Modo Assíncrono:

Para evitar bloquear o fluxo do seu código, você pode usar o modo assíncrono, que permite verificar as atualizações enquanto o código continua rodando.

import com.github.theprogmatheus.util.JGRUChecker;
import com.github.theprogmatheus.util.JGRUChecker.GithubRelease;

import java.util.concurrent.CompletableFuture;

public class AsyncUpdateCheckerExample {
    public static void main(String[] args) {
        // Defina o nome de usuário do GitHub, repositório e a versão atual do seu projeto
        JGRUChecker checker = new JGRUChecker("theprogmatheus", "JGR-UChecker", "1.0.0-alpha");

        // Verifique se há uma atualização disponível de forma assíncrona
        CompletableFuture<GithubRelease> lastReleaseFuture = checker.checkAsync();
        lastReleaseFuture.thenAccept(lastRelease -> {
            if (lastRelease != null) {
                System.out.println("Última versão: " + lastRelease.getVersion());
                System.out.println("Nome da versão: " + lastRelease.getName());
                System.out.println("Link para download: " + lastRelease.getDownloadPage());
            } else {
                System.out.println("Não foi possível buscar a última versão.");
            }
        });

        // Outros códigos podem continuar a execução enquanto aguardam a resposta
        System.out.println("Verificando se há atualizações...");
    }
}

🔧 Funcionalidades

• check(): Verifica a última versão de forma sincrona.
• checkAsync(): Verifica a última versão de forma assíncrona, retornando um CompletableFuture.
• getLastRelease(): Retorna a última versão como um objeto GithubRelease (sincronamente).
• isUpdateAvailable(): Verifica se uma atualização está disponível comparando a versão atual com a versão mais recente.

Detalhes da GithubRelease

A classe GithubRelease contém os seguintes campos:

• id: ID da release no GitHub.
• name: Nome da release (geralmente o título da versão).
• version: A versão da release.
• downloadPage: URL para a página de download da release.

🚀 Como Funciona

1. Você fornece o nome de usuário do GitHub, o repositório e a versão atual do seu projeto.
2. A biblioteca consulta a API pública do GitHub para buscar as informações da última release do repositório.
3. Ela compara a versão mais recente com a versão que você está utilizando e determina se há uma atualização disponível.
4. Se houver, você pode obter mais informações sobre a release, como o nome, a versão e o link para o download.

📦 Dependências

O JGR-UChecker depende de:

• json-simple: Para fazer o parse do JSON retornado pela API do GitHub.

🔗 Links Úteis

• GitHub do Projeto

📝 Licença

Este projeto está licenciado sob a MIT License.

---

Sinta-se à vontade para contribuir, reportar problemas ou sugerir melhorias! 😄