microverse-ruby-capstone-project

A Ruby developed Telegram bot to get the weather forecast based on the GPS location or searching for a location in Open Weather Map

MIT License

Stars

5

View Code on GitHub View on X

Ecosystems: Ruby

Telegram Bot

This is the capstone project for the Ruby module in Microverse 2.0 program

Built With

Ruby

Features

Get weather forecast given the user's GPS location
Get weather forecast for any given city within OpenWeather's API (>200.000 cities)
Search function to retrieve up to 10 cities matching the search criteria. (if more than 20 results are given, user will be asked to narrow the search criteria)
Echo function to test if the bot is active
Log file to save user, location required and time

Getting Started

Prerequisites

Telegram application installed in your cellphone or in your computer
Available internet connection
Join Weather Bot channel or
create a new bot sending a message to @BotFather and follow further instructions to create the bot and get the token
Get an API key from OpenWeatherMap to access their forecasts Instructions here

Note to TSEs: both Telegram and OW API key will be provided in Code Request

Permission for accessing GPS from within the app
Follow instructions

Setup

For TSEs: please fill in Telegram Token and API key in tokens.rb class
Clone the repository
Get into the repository's root folder
Run bundle install to install the needed gems
Execute the ./bin/main.rb file to start the bot (the tokens needed will be given in private)

Usage

Once the bot has been started, you may test it via the Telegram Bot's Channel.

Available commands

/start to start the bot
/stop to stop the bot
/echo to test if the bot is active
/weather to let the bot know the user will require a forecast
/mylocation to let the bot know the user will require a forecast based on GPS current location

(All commands are clickable from within the Telegram app)

Video with a presentation on how the bot works

Link to the video

Author

Miguel Gomez

GitHub: @MiguelArgentina
twitter - https://twitter.com/Qete_arg

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

📝 License

This project is MIT licensed.

Related Projects

messenger-bot-ruby

Ruby wrapper for Messenger's Platform Bot API

Chatterton

A Discord bot that tells jokes, provides Apex Legends player stats, Today In History facts, and j...

Decoding_Morse_Code

A message written in Morse code was found inside a bottle on the seashore. What does it say? who ...

telegram-bot

In this project, I built a telegram bot that tells you the COVID-19 statistics, today's word of b...

Own_Enumerable

This project implements a module in a Ruby class. The my_enumerable module implements part of the...

fitness-bot

A bot that pulls from the Telegram API. Uses prompts to share fitness guides. Built with Ruby

things-catalog

Things-catalog is a console based project written in Ruby langueage, Where users can store books,...

decode-morse-code

Decode morse code is a project with ruby programs to decode morse code messages.

tweetbot

Tweetbot makes writing twitter bots twivial!

capstone-4_ruby

RubyCapstoneBot

This is a Twitter Bot built with Ruby that tweets some information about the user and sends a ran...

bot-telegram

The main goal is create a Bot. It's a real-world-like project, built with business specifications.

telegram_bot

The telegram bot which can introduce itself when you say hi to it. This bot will send you inspira...

facebook-messenger

Definitely the best way to make Bots on Facebook Messenger with Ruby

15 Apr 2016 959

telebot

An interactive Telegram Chatbot built from scratch using TELEGRAM BOT API. It displays jokes and ...