LetsShortBot

The Let's Short URL Bot is a simple Telegram bot to short your URLs.

You can choose between different providers like Tinyurl, Cuttly, IS.GD, V.GD, but you can also configure your own YOURLS URL shortener. When you're finished with the settings you can just send your long links and get back the shortened version.

YOURLS Setup

If you want to use the bot with your own YOURLS shortener I have some tips for you. Requirements for your own URL shortener with YOURLS are your own web server, a MySQL or MariaDB database and a (as short as possible) domain.

• Download the latest version of YOURLS on GitHub and unzip the data.
• Copy the file user/config-sample.php to user/config.php and insert your database settings.
• Further parameters to set can be found here.
• Upload the files to your webserver.
• Go to your-domain.com/admin and log in.
• Activate the plugin "RandomShortURLs" under "Plugins" and set the URL length.
• Go to "Tools" and copy your API link in format https://your-domain.com/yourls-api.php?signature=
• Go back to the bot, send /change and click on "YOURLS" at the keyboard and in the next step paste your copied link.

Documentation

Database structure

.
├── user
│   ├── <id>
│   │   ├── first_name: <value>
│   │   ├── lang: <value>
│   │   ├── last_name: <value>
│   │   ├── provider: <value>
│   │   ├── url_count: <value>
│   │   ├── urls
│   │   │   ├── 0
│   │   │   │   ├── url: value
│   │   │   ├── 1
│   │   │   │   ├── url: value
│   │   │   ├── ...
│   │   ├── username: <value>
│   │   ├── yourls: <value>
│   ├── ...
└──

Running the code

To run the code locally you need the following:

• JSON credentials and project url of Firebase project with Realtime database
• Telegram Bot token
• A Python (minimum 3.8) environment with the dependencies installed

The credentials have to exist as environmental variables e.g. in a .env file.

HD_FIREBASE_DB_URL
HD_FIREBASE_KEY
HD_TELEGRAM_BOT_TOKEN

# optional
HD_TELEGRAM_BOT_OWNER
HD_HERO_WEBHOOK_URL
HD_CUTTLY_API_TOKEN

Functions

get_user_step

This function is needed to get the current step of one specific user.

The default step is 0 but it can be changed to enable functions that require the user to enter data several times in a row.

listener

Outputs the input of the users into the console.

command_start

Sends a welcome message and a message with all available commands.

Then the user is asked for the desired language setting and it'll be saved to the database.

command_help

Returns a message with all available commands and some information about it.

change_shortener

Provides the ability to change the url shortener within multiple steps.

flowchart TB
    subgraph userStep 0
    a1[START] -->|user sends /change| a2(return shortener options)
    a2 --> a3(userStep = 5)
    end
    subgraph userStep 5
    a3 -->|user sends choice| b1{choice == yourls}
    b1 -->|no| b2(change shortener in\ndatabase to choice)
    b2 --> b3(send success message)
    b3 --> a1
    b1 -->|yes| b4(load yourls config\nfrom database)
    b4--> b5{yourls config == 0}
    
    b5 -->|yes| b6[ask the user to submit\ntheir yourls api url]
    b6 --> b61(userStep = 1)
    
    b5 -->|no| b7[change shortener in\ndatabase to yourls]
    b7 --> b8(check if the yourls config\nworks and return result)
    b8 --> b9(userStep = 0)
    b9 -->a1
    end
    subgraph userStep 1
    b61 -->|user submits url| c1
    c1(change shortener in\ndatabase to yourls) --> c3(userStep = 0)
    c3 --> a1
    end

Loading

Contributing

Feature suggestion? Bug to report?

Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.

Submitting an issue that is improperly or incompletely written is a waste of time for everybody.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue or assessing

Using the issue tracker

The issue tracker is the preferred channel for bug reports, feature requests and submitting pull requests, but please respect the following restrictions:

• Please do not use the issue tracker for personal support requests.
  Use discussions instead to ask the community for help.

• Please do not derail or troll issues.
  Keep the discussion on topic and respect the opinions of others.

Bug reports

A bug is a demonstrable problem that is caused by the code in the repository. Good bug reports are extremely helpful - thank you!

Guidelines for bug reports:

1. Use the GitHub issue search
   Check if the issue has already been reported. Reporting duplicates is a waste of time for everyone. Search in all issues, open and closed.

2. Check if the issue has been fixed
   Try to reproduce it using the latest master or development branch in the repository. Maybe it has been fixed since the last stable release.

3. Give details
   A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report. Give any information that is relevant to the bug:

   What is the expected output? What do you see instead? See the report example below.

4. Isolate the problem
   Isolate the problem as much as you can, reduce to the bare minimum required to reproduce the issue. Don't describe a general situation that doesn't work as expected and just count on us to pin point the problem.

Feature requests

Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the LetsShortBot developers of the merits of this feature. Please provide as much detail and context as possible.

Pull requests

Good pull requests - patches, improvements, new features - are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.

1. Please ask first
   Before embarking on any significant pull request (e.g. implementing features, refactoring code), otherwise you risk spending a lot of time working on something that the developers might not want to merge into the project.
2. Licensing
   By submitting a patch, you agree that your code will be licensed under the Creative Commons Attribution Share Alike 4.0 International License terms.
3. Coding Standards
   Please adhere to the coding conventions used throughout the project (indentation, comments, etc.). Make sure you've tested your patch under different scenarios (various browsers, non default installation path, etc.).

Adhering to the following this process is the best way to get your work merged:

1. Fork the repo, clone your fork, and configure the remotes.

   # Clone your fork of the repo into the current directory
   git clone https://github.com/<your-username>/<repo-name>
   # Navigate to the newly cloned directory
   cd <repo-name>
   # Assign the original repo to a remote called "upstream"
   git remote add upstream https://github.com/<upsteam-owner>/<repo-name>

2. If you cloned a while ago, get the latest changes from upstream.

   git checkout <dev-branch>
   git pull upstream <dev-branch>

3. Create a new topic branch (off the main project development branch) to contain your feature, change, or fix.

   git checkout -b <topic-branch-name>

4. Commit your changes in logical chunks. Please adhere to these git commit message guidelines or your code is unlikely be merged into the main project. Use Git's interactive rebase feature to tidy up your commits before making them public.

5. Locally merge (or rebase) the upstream development branch into your topic branch:

   git pull [--rebase] upstream <dev-branch>

6. Push your topic branch up to your fork:

   git push origin <topic-branch-name>

7. Open a Pull Request with a clear title and description.

Donating

If you like the project and want to help to keep it alive, please consider making a small donation.