The adelite from teknologi-umum

Implement GiteaProvider as GitProvider to fetch repository releases

The GitProvider interface provides a function to call the Gitea API for getting a specific repository's release data. With undici installed and since we're not using any Gitea API SDK (because we only need this single endpoint), implement the getReleases function to do that.

adelite/src/git/GiteaProvider.ts

Lines 4 to 8 in dff5d23

    
           export class GiteaProvider implements BaseGitProvider { 
        
             getReleases(owner: string, repo: string): Promise<Release[]> { 
        
               // See https://docs.gitea.com/api/1.20/#tag/repository/operation/repoListReleases 
        
               throw new Error("Method not implemented."); 
        
             }

Implement TelegramProvider as NotificationProvider to send releases notification

The NotificationProvider interface provides a function abstraction to send a notification through a certain provider, for this issue, it's via Telegram. Using grammy, implement message sending to a specific chatId.

Since there is no constructor, you should create one that bridge the gap between the configuration (in which where we would store the botToken and chatId) and what's needed by grammy.

adelite/src/notification/TelegramProvider.ts

Lines 4 to 7 in dff5d23

    
           export class TelegramProvider implements BaseNotificationProvider { 
        
             notify(releases: Release[], abortSignal?: AbortSignal | undefined): Promise<void> { 
        
               throw new Error("Method not implemented."); 
        
             }

You can see the configuration for Telegram here:

adelite/src/config.ts

Lines 21 to 24 in dff5d23

    
           telegram: z.object({ 
        
             bot_token: z.string(), 
        
             chat_id: z.string() 
        
           }).optional(),

Implement GithubAdapter as GitProvider to fetch repository release

The GitProvider interface provides a function to call the Github API for getting a specific repository's release data. With undici installed and since we're not using any Github API SDK (because we only need this single endpoint), implement the getReleases function to do that.

adelite/src/git/GithubProvider.ts

Lines 4 to 9 in dff5d23

    
           export class GithubAdapter implements BaseGitProvider { 
        
             public getReleases(owner: string, repo: string): Promise<Release[]> { 
        
               // See https://docs.github.com/en/rest/releases/releases?apiVersion=2022-11-28#list-releases 
        
               throw new Error("unimplemented"); 
        
             } 
        
           }

Implement ForgejoProvider as GitProvider to fetch repository releases

The GitProvider interface provides a function to call the Forgejo API for getting a specific repository's release data. With undici installed and since we're not using any Forgejo API SDK (because we only need this single endpoint), implement the getReleases function to do that.

As a side note: Yes, I understand that Forgejo and Gitea has similar API. We might benefit from a code reuse, yet I'm seeing a pattern that Forgejo is going to a separate way from Gitea, resulting in a probable API incompatibilities between the two.

adelite/src/git/ForgejoProvider.ts

Lines 4 to 9 in dff5d23

    
           export class ForgejoProvider implements BaseGitProvider { 
        
             getReleases(owner: string, repo: string): Promise<Release[]> { 
        
               // See https://codeberg.org/api/swagger#/repository/repoListReleases 
        
               // Also see https://forgejo.org/docs/latest/user/api-usage/#authentication 
        
               throw new Error("Method not implemented."); 
        
             }

Implement GogsProvider as GitProvider to fetch repository releases

The GitProvider interface provides a function to call the Gogs API for getting a specific repository's release data. With undici installed and since we're not using any Gogs API SDK (because we only need this single endpoint), implement the getReleases function to do that.

adelite/src/git/GogsProvider.ts

Lines 4 to 8 in dff5d23

    
           export class GogsProvider implements BaseGitProvider { 
        
             getReleases(owner: string, repo: string): Promise<Release[]> { 
        
               // See https://github.com/gogs/docs-api/blob/master/Repositories/Releases.md 
        
               throw new Error("Method not implemented."); 
        
             }

Implement WebhookProvider as NotificationProvider to send releases notification

The NotificationProvider interface provides a function abstraction to send a notification through a certain provider, for this issue, it's via Webhook (you can learn about what is webhook here). Using undici, implement notification through webhook.

Since the class don't have a constructor yet, it's your opportunity to also create the constructor. An extra feature would be to implement a retry mechanism in case the receiving party (the server in which we're hitting on) didn't response with 2xx or 4xx status code. We should retry at most 5 times using exponential backoff -- but again, this retry feature is a nice to have one, it's not required from the start.

adelite/src/notification/WebhookProvider.ts

Lines 4 to 7 in dff5d23

    
           export class WebhookProvider implements BaseNotificationProvider { 
        
             notify(releases: Release[], abortSignal?: AbortSignal | undefined): Promise<void> { 
        
               throw new Error("Method not implemented."); 
        
             }

The configuration for webhook provider can be found here, you can add more configuration if you feel like this can be configured more.

adelite/src/config.ts

Lines 25 to 28 in dff5d23

    
           webhook: z.object({ 
        
             url: z.string(), 
        
             skip_tls_verify: z.boolean().default(false) 
        
           })

Implement GitlabProvider as GitProvider to fetch repository releases

The GitProvider interface provides a function to call the Gitlab API for getting a specific repository's release data. With undici installed and since we're not using any Gitlab API SDK (because we only need this single endpoint), implement the getReleases function to do that.

adelite/src/git/GitlabProvider.ts

Lines 4 to 8 in dff5d23

    
           export class GitlabProvider implements BaseGitProvider { 
        
             getReleases(owner: string, repo: string): Promise<Release[]> { 
        
               // See https://docs.gitlab.com/ee/api/releases/#list-releases 
        
               throw new Error("Method not implemented."); 
        
             }

Implement SMTPProvider as NotificationProvider to send releases notification

The NotificationProvider interface provides a function abstraction to send a notification through a certain provider, for this issue, it's via SMTP (email). Using emailjs, implement mail sending mechanism through SMTP.

If you're not sure about the message content, just send a normal text. I'm sure that we can address the correct and proper email message in a separate issue.

adelite/src/notification/SMTPProvider.ts

Lines 14 to 27 in dff5d23

    
           export class SMTPProvider implements BaseNotificationProvider { 
        
             private readonly client: SMTPClient; 
        
             constructor(config: SMTPConfig) { 
        
               this.client = new SMTPClient({ 
        
                 user: config.user, 
        
                 password: config.password, 
        
                 host: config.host, 
        
                 port: config.port, 
        
               }); 
        
             } 
        
             notify(releases: Release[], abortSignal?: AbortSignal | undefined): Promise<void> { 
        
               throw new Error("Method not implemented."); 
        
             }

teknologi-umum / adelite Goto Github PK

adelite's People

Contributors

Watchers

adelite's Issues

Implement GiteaProvider as GitProvider to fetch repository releases

Implement TelegramProvider as NotificationProvider to send releases notification

Implement GithubAdapter as GitProvider to fetch repository release

Implement ForgejoProvider as GitProvider to fetch repository releases

Implement GogsProvider as GitProvider to fetch repository releases

Implement WebhookProvider as NotificationProvider to send releases notification

Implement GitlabProvider as GitProvider to fetch repository releases

Implement SMTPProvider as NotificationProvider to send releases notification

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent

	export class GiteaProvider implements BaseGitProvider {
	getReleases(owner: string, repo: string): Promise<Release[]> {
	// See https://docs.gitea.com/api/1.20/#tag/repository/operation/repoListReleases
	throw new Error("Method not implemented.");
	}

	export class TelegramProvider implements BaseNotificationProvider {
	notify(releases: Release[], abortSignal?: AbortSignal \| undefined): Promise<void> {
	throw new Error("Method not implemented.");
	}

	telegram: z.object({
	bot_token: z.string(),
	chat_id: z.string()
	}).optional(),

	export class GithubAdapter implements BaseGitProvider {
	public getReleases(owner: string, repo: string): Promise<Release[]> {
	// See https://docs.github.com/en/rest/releases/releases?apiVersion=2022-11-28#list-releases
	throw new Error("unimplemented");
	}
	}

	export class ForgejoProvider implements BaseGitProvider {
	getReleases(owner: string, repo: string): Promise<Release[]> {
	// See https://codeberg.org/api/swagger#/repository/repoListReleases
	// Also see https://forgejo.org/docs/latest/user/api-usage/#authentication
	throw new Error("Method not implemented.");
	}

	export class GogsProvider implements BaseGitProvider {
	getReleases(owner: string, repo: string): Promise<Release[]> {
	// See https://github.com/gogs/docs-api/blob/master/Repositories/Releases.md
	throw new Error("Method not implemented.");
	}

	export class WebhookProvider implements BaseNotificationProvider {
	notify(releases: Release[], abortSignal?: AbortSignal \| undefined): Promise<void> {
	throw new Error("Method not implemented.");
	}

	webhook: z.object({
	url: z.string(),
	skip_tls_verify: z.boolean().default(false)
	})

	export class GitlabProvider implements BaseGitProvider {
	getReleases(owner: string, repo: string): Promise<Release[]> {
	// See https://docs.gitlab.com/ee/api/releases/#list-releases
	throw new Error("Method not implemented.");
	}

	export class SMTPProvider implements BaseNotificationProvider {
	private readonly client: SMTPClient;
	constructor(config: SMTPConfig) {
	this.client = new SMTPClient({
	user: config.user,
	password: config.password,
	host: config.host,
	port: config.port,
	});
	}

	notify(releases: Release[], abortSignal?: AbortSignal \| undefined): Promise<void> {
	throw new Error("Method not implemented.");
	}