Feature: Add bit.ly as a shortening link - 545

[pritam1322]

What kind of change does this PR introduce?

Feature: Add bit.ly as a shortening link #545

Why was this change needed?

#545 Please link to related issues when possible, and explain WHY you changed things, not WHAT you changed.

Other information:

eg: Did you discuss this change with anybody before working on it (not required, but can be a good idea for bigger changes). Any plans for the future, etc?

Checklist:

Put a "X" in the boxes below to indicate you have followed the checklist;

• [x] I have read the CONTRIBUTING guide.
• [x] I checked that there were not similar issues or PRs already open for this.
• [x] This PR fixes just ONE issue (do not include multiple issues or types of change in the same PR) For example, don't try and fix a UI issue and include new dependencies in the same PR.

Summary by CodeRabbit

• New Features
  • Integrated Bitly as an option for URL shortening with enhanced analytics.
  • When configured with the appropriate API token, users can generate short links, retrieve the original URLs from short links, and access detailed click statistics.
  • The new Bitly option complements existing providers, ensuring a seamless experience regardless of the selected shortening service.

[vercel[bot]]

@pritam1322 is attempting to deploy a commit to the Listinai Team on Vercel.

A member of the Team first needs to authorize it.

[coderabbitai[bot]]

Walkthrough

This PR introduces a new Bitly provider in the NestJS URL shortening library. A new file implements the Bitly class adhering to the ShortLinking interface with methods to create, convert, and retrieve short links along with their statistics via the Bitly API. Additionally, the ShortLinkService is updated to include a provider check for the BITLY_TOKEN, enabling Bitly integration alongside existing providers. The implementation also covers recursive pagination for aggregating link statistics.

Changes

File(s)	Change Summary
libraries/nestjs-libraries/.../providers/bitly.ts	Added new Bitly class implementing the ShortLinking interface with methods: linksStatistics, convertLinkToShortLink, convertShortLinkToLink, getAllLinksStatistics for Bitly API interaction.
libraries/nestjs-libraries/.../short.link.service.ts	Updated getProvider function to return an instance of Bitly when BITLY_TOKEN is set, while retaining existing provider handling.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant ShortLinkService
    participant Bitly

    Client->>+ShortLinkService: Request URL shortening or stats
    ShortLinkService->>ShortLinkService: Check BITLY_TOKEN environment variable
    alt BITLY_TOKEN is set
        ShortLinkService->>+Bitly: Invoke relevant Bitly method
        Bitly-->>-ShortLinkService: Return short link / statistics
    else BITLY_TOKEN not set
        ShortLinkService->>ShortLinkService: Fallback to other providers
    end
    ShortLinkService-->>-Client: Deliver result

Possibly related issues

• gitroomhq/postiz-app#545 – Implements the Bitly shortening link feature as described in the issue, adding Bitly as a provider for URL shortening.

Possibly related PRs

• gitroomhq/postiz-app#564 – Integrates a new provider similar to ShortIo, establishing a common interface for URL shortening.
• gitroomhq/postiz-app#543 – Modifies ShortLinkService to support additional providers, aligning with the Bitly provider integration.

Suggested reviewers

• nevo-david

Poem

In a field of code under skies so blue,
I hopped and found Bitly, shiny and new.
Short links dance with each graceful click,
A rabbit's delight, both smooth and quick.
Hop on, dear coder, let these links stick!

✨ Finishing Touches

• [ ] 📝 Generate Docstrings (Beta)

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[egelhaus]

@Azadbangladeshi-com ? What do you mean by that?

[nevo-david]

@Azadbangladeshi-com ? What do you mean by that?

it's spam

[egelhaus]

can't you ban him from commenting?

[github-actions[bot]]

Your PR's base branch was set to main, PRs should be set to target dev. The base branch of this PR has been automatically changed to development, please check that there are no merge conflicts