Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Fazendaaa/podsearch_bot
Telegram bot that searches Podcast in iTunes store.
https://github.com/Fazendaaa/podsearch_bot
bot internationalization itunes podcast tdd telegraf telegram telegram-bot test-runner travisci
Last synced: 3 months ago
JSON representation
Telegram bot that searches Podcast in iTunes store.
- Host: GitHub
- URL: https://github.com/Fazendaaa/podsearch_bot
- Owner: Fazendaaa
- License: mit
- Created: 2018-03-17T13:26:21.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-03-28T23:52:38.000Z (3 months ago)
- Last Synced: 2024-04-14T07:54:40.305Z (3 months ago)
- Topics: bot, internationalization, itunes, podcast, tdd, telegraf, telegram, telegram-bot, test-runner, travisci
- Language: TypeScript
- Homepage: https://telegram.me/podsearchbot
- Size: 4.12 MB
- Stars: 32
- Watchers: 3
- Forks: 0
- Open Issues: 42
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing/CONTRIBUTING.md
- License: LICENSE
- Support: docs/support/SUPPORT.md
Lists
- awesome-stars - Fazendaaa/podsearch_bot - Telegram bot that searches Podcast in iTunes store. (TypeScript)
README
# Podsearch
[](https://github.com/Fazendaaa/podsearch_bot/blob/master/README.md)
[](https://github.com/Fazendaaa/podsearch_bot/blob/master/docs/readme/README_PT.md)
[](https://www.bithound.io/github/Fazendaaa/podsearch_bot)
[](https://github.com/Fazendaaa/podsearch_bot/blob/master/package.json)
[](https://travis-ci.org/Fazendaaa/podsearch_bot)
[](https://coveralls.io/github/Fazendaaa/podsearch_bot?branch=master)
[](https://snyk.io/test/github/fazendaaa/podsearch_bot?targetFile=package.json)
[](https://github.com/Fazendaaa/podsearch_bot/issues)
[](https://github.com/Fazendaaa/podsearch_bot/network)
[](https://github.com/Fazendaaa/podsearch_bot/stargazers)
[](https://github.com/Fazendaaa/podsearch_bot/blob/master/LICENSE)
> The solution that you need to share with your friends your love for podcast :3
[Telegram](https://www.telegram.org/) bot that searches podcast info in [iTunes](https://www.apple.com/lae/itunes/) store.
## About
This is a bot made using [TypeScript](http://typescriptlang.org/)(TS) because I want something to test the my new coding skill. And, like so, also the [Test Driven Development](https://en.wikipedia.org/wiki/Test-driven_development)(TDD), the first time that I've done anything with TDD.
Two new things in one project? Yes, and a third one is [Continuos Integration](https://en.wikipedia.org/wiki/Continuous_integration)(CI) just to be able to push running code at a master branch to be running at the server. And, a fourth one, is making a bot that supports it multiple languages.
Like so, once I've "finished" this code I intend to write an article at [Medium](https://medium.com/) talking about it. All the knowledge that I've got it because some one laid a trail so that I can build my own on it.
## How to use it
First of all, talk to [@podsearchbot](https://telegram.me/podsearchbot).
### Disclaimer
By default all the commands are in English, but you can see if que same command is available in your language.
### Search
There're three ways of doing that:
#### Inline mode
The inline mode works both in the Podsearchbot chat or any other chat:
```
@podsearchbot podcast name
```
Example:
```
@podsearchbot B9
```
#### Button
Just press search button available, it will ask you for podcast name and then does the search.
#### ```/search```
Just open it a chat with Podsearchbot and then use it like this:
```
/search podcast name
```
Example:
```
/search The Mission
```
##### Help
If you have any other questions about it just use it the help command:
```
/help
```
# How does it work?
You can build yourself a bot just like this one, just follow the procedures listed in [BUILDING.md](https://github.com/Fazendaaa/podsearch_bot/blob/master/docs/building/BUILDING.md).
## Want know more?
If you want to understand the "whys" of I did what I did, you can read ALL THE CODE... Just joking, I've wrote some of the pros and cons of my approach on the macro vision of the code. If you want to know more, read:
* [DATABASE.md](https://github.com/Fazendaaa/podsearch_bot/blob/master/docs/database/DATABASE.md) -- How the data is stored, for subscription and "classes" of users;
* [RECOMMENDATION.md](https://github.com/Fazendaaa/podsearch_bot/blob/master/docs/recommendation/RECOMMENDATION.md) -- How it's handle the discovery option of new podcasts.
# Deployment
This bot is up and running at [Heroku](http://heroku.com/) through the Github integration, that means that each new push to the ```master``` branch means that is the code serving the bot. You can see more about how does it run at the server by looking at the [Procfile](https://github.com/Fazendaaa/podsearch_bot/blob/master/Procfile). You can also deploy yourself this bot into Heroku through:
[](https://heroku.com/deploy?template=https://github.com/Fazendaaa/podsearch_bot)
There's also a [Travis CI](http://travis-ci.org/) integration.
# Build with
* [App.json](https://www.npmjs.com/package/app.json) - Deploy config to Heroku through deploy button;
* [Wallaby.j](http://wallabyjs.com/) - Live [Visual Studio Code](https://code.visualstudio.com/) test runner plug-in;
* [Jest](https://facebook.github.io/jest/) - Test runner;
* [Telegraf.js](http://telegraf.js.org/) - Library that handles it the Telegram connection;
* [Telegraf-i18n](https://github.com/telegraf/telegraf-i18n) - Library that handles language integration;
* [moment.js](https://momentjs.com/) - Library that handles it the date and time formating;
* [i18n-yaml](https://github.com/martinheidegger/i18n-node-yaml) - Since Telegraf-i18n only handles Telegraf context, there's a need to parse other kinds of context;
* [dotenv](https://github.com/motdotla/dotenv) - Library that imports environment variables;
* [tinyurl](https://github.com/AlphaT3ch/TinyURL) - Library that handles it the URL shorten requests;
* [remove-accents](https://github.com/tyxla/remove-accents) - Some international content has accents and this library removes it -- makes de search more easy to perform given that even if the podcast name has accents not necessary it will be marked as having those in the iTunes store;
* [itunes-search](https://github.com/connor/itunes-node) - One of many libraries that does the fetching from iTunes API, but this one is the only one that does it right.
# Contributing
Please, I'm not a native/fluent english speaker, so whether you see a variable name wrote the wrong way or even some comment where I've wrote something with the wrong "past perfect way of life" or something like that, please let me know it. Not always is just about the code, but rather making it more clear to other people to learn from it.
So, whether is code or not you can help me out making this code more accessible by reading the [CONTRIBUTING.md](https://github.com/Fazendaaa/podsearch_bot/blob/master/docs/contributing/CONTRIBUTING.md).
# Versioning
I would love to say that [SemVer](https://semver.org/) or anything like that is used but, in my personal experience, this kind of approach doesn't work very well with me, the guy who could be committing in this project for two weeks in a roll and leave it for almost one year with no simple ```npm update```. So, no versioning system is used.
# TODO
Since I will be keeping this README up to date with any major change and I don't use any versioning system to log all the fixed bugs or previous projects updates, you can still have a taste of what comes next and what is being under analysis right in the [Projects](https://github.com/Fazendaaa/podsearch_bot/projects/) tab.
# Authors
* Only [me](https://github.com/Fazendaaa) for now.
Consider buy me a coffee:
[](https://www.buymeacoffee.com/Fazenda)
Or even becoming a patron:
[](https://www.patreon.com/Fazenda/overview)
You can understand more why I choose to accept donations and not sells adds in [SUPPORT.md](https://github.com/Fazendaaa/podsearch_bot/blob/master/docs/support/SUPPORT.md).
# License
Like many Open-Source Software (OSS) the MIT license is used, more about it in [LICENSE](https://github.com/Fazendaaa/podsearch_bot/blob/master/LICENSE).
# Acknowledgments
* Thanks to [PurpleBooth](https://gist.github.com/PurpleBooth) and this great [README](https://gist.github.com/PurpleBooth/109311bb0361f32d87a2) template and hers [CONTRIBUTING](https://gist.github.com/PurpleBooth/b24679402957c63ec426) template also;
* [Mattias Petter Johansson](https://twitter.com/mpjme) and his channel [FunFunFunction](https://www.youtube.com/channel/UCO1cgjhGzsSYb1rsB4bFe4Q), where I've learnt so many important coding best practices; please don't think that this is a channel that will give any kind of "lazy-intro-tutorial" or anything like that, this channel open your eyes to how you can improve your existing skills and learn some more new ones;
* Since Jest mocking documentation left me with a lot of doubts, [this](https://hackernoon.com/api-testing-with-jest-d1ab74005c0a) tutorial helped me out a little, still have some issues to understand how to correct mock data. I highly think that is because of my testing logic, once I figure out how to do it correctly I will rewrite all testing code; for now is "working" the best way I came up to; even being that horrible is not that much compared to having an API request all the time;
* I highly recommend checking it out my [**ytlofi**](https://github.com/Fazendaaa/ytlofi) project whether you ran through some issues trying to get any CI integration or even project badges.