telegram-scrum-bot 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b50013c70e528116d1d7320bb0334e99d3a9974216fa96379c85ebac7ce38fb
-  data.tar.gz: b52fbdcb2033cbe23d6fa3545747561fe988e3639a4a6972004bf766758029a0
+  metadata.gz: a4ae321299b4e891424d806292ab0ff5379f3d1049e0b1b924beacf81c66f684
+  data.tar.gz: 4ba69fc7910ba8e4c664f60e1559c4d7fd55e812ac8f308c7bf0227350181bd5
 SHA512:
-  metadata.gz: d50756eb900c94c9d5b6b31d6d65cef912e2706df12167c3a827f85861d0211454773eb026e9b3a8a521bdc6c2d1cda8b029b2810e718b8abe9fd05dad3fbaa1
-  data.tar.gz: 6b258df630a4f5332c89ae2b98c32323ff1c7b30b561cfd9819b4e4e8d2b2481342eda3f5fd6fa28ad81753537e39238af8940ab24e42610813da726d9885d57
+  metadata.gz: a9d6b5ce93a5b0aad3ad398bd268f85bfe5e3b3326bb95029cf0eb8520ff4c5311e044c09e171c57b0808fb5fd6e21a134f4691741415bb33195f767e81d7ef4
+  data.tar.gz: 832857d9617c601b6c48849ae32778cca8c042dd6539df04cfca39a81ab85d44337269276fd14d518776fe00c3402f7f057ebe48012cfaf8d4780aa63d14f7c8

data/README.md

@@ -0,0 +1,78 @@
+# Telegram Scrum Bot
+
+A friendship Telegram's bot that connect a Repository on GitHub with a Scrum board on Trello.
+
+## Setup
+
+### From the Github Repository:
+```bash
+git clone https://github.com/hackvan/telegram-bot.git
+```
+
+For development you must be create the file `secrets.yml` inside the `config` directory and put the Telegram and Trello tokens information on this structure:
+
+```yaml
+telegram:
+  token: 'TOKEN-INFO'
+trello:
+  key:   'KEY-INFO'
+  token: 'TOKEN-INFO'
+```
+
+to start the bot's server application:
+
+```bash
+$ bundle install
+$ bundle exec ruby lib/telegram-bot.rb
+```
+
+### From the [rubygems site](https://rubygems.org/gems/telegram-scrum-bot):
+
+>https://rubygems.org/gems/telegram-scrum-bot
+
+you must setup the required enviroment variables inside `.bashrc` or `.zshrc` depend of your terminal configuration:
+```bash
+# Enviroment variables from telegram-scrum-bot gem:
+export API_TELEGRAM_TOKEN="TOKEN-INFO"
+export API_TRELLO_KEY="KEY-INFO"
+export API_TRELLO_TOKEN="TOKEN-INFO"
+```
+
+To install and execute the application:
+```bash
+$ gem install telegram-scrum-bot
+$ telegram-scrum-bot
+```
+
+## Telegram Bot
+
+* name: `scrum_hackathon_bot`
+* username: `@scrum_hackathon_bot`
+* url: [https://t.me/scrum_hackathon_bot](https://t.me/scrum_hackathon_bot)
+
+
+**Telegram Bot Commands:**
+
+Initial Commands:
+```
+/start - bienvenida
+/setup - asistente de configuración del bot
+/help  - ayuda con los comandos del bot
+```
+
+Configuration Commands:
+```
+/setgithubuser - establece la configuración del usuario de github
+/setgithubrepository - establece la configuración del repositorio de github
+```
+
+```
+/getgithubuser - obtiene la configuración del usuario de github
+/getgithubrepository - obtiene la configuración del repositorio de github
+```
+
+Work Commands:
+```
+/issues - consultar el listado de Issues en el repositorio de Github
+/trello - sincroniza los issues del repositorio en un tablero de Trello
+```

data/bin/console

@@ -1,5 +1,4 @@
 #!/usr/bin/env ruby
-
 require "bundler/setup"
 require "telegram-scrum-bot"
 

data/lib/telegram-bot.rb

@@ -3,8 +3,30 @@ require_relative 'telegram-bot/bot'
 module TelegramBot
 end
 
-config = YAML.load_file("./config/secrets.yml")
-TelegramBot::TelegramScrumBot.set_token(config['telegram']['token'])
-TelegramBot::set_trello_tokens(config['trello']['key'], config['trello']['token'])
-bot = TelegramBot::TelegramScrumBot.new(username: 'hackvan', repository: 'telegram-bot')
-bot.run
+begin
+  # Search the config/secrets.yml used for development enviroment:
+  config = YAML.load_file("./config/secrets.yml")
+  API_TELEGRAM_TOKEN = config['telegram']['token']
+  API_TRELLO_KEY     = config['trello']['key']
+  API_TRELLO_TOKEN   = config['trello']['token']
+rescue Errno::ENOENT => exception
+  # Search enviroment variables used for production enviroment:
+  API_TELEGRAM_TOKEN = ENV['API_TELEGRAM_TOKEN']
+  API_TRELLO_KEY     = ENV['API_TRELLO_KEY']
+  API_TRELLO_TOKEN   = ENV['API_TRELLO_TOKEN']
+end
+
+if API_TELEGRAM_TOKEN
+  TelegramBot::TelegramScrumBot.set_token(API_TELEGRAM_TOKEN)
+  if API_TRELLO_KEY && API_TRELLO_TOKEN
+    TelegramBot::set_trello_tokens(API_TRELLO_KEY, API_TRELLO_TOKEN)
+    bot = TelegramBot::TelegramScrumBot.new(username: 'hackvan', repository: 'telegram-bot')
+    bot.run
+  else
+    puts "API_TRELLO_KEY and API_TRELLO_TOKEN is not defined."
+    exit 1
+  end
+else
+  puts "API_TELEGRAM_TOKEN is not defined."
+  exit 1
+end

data/lib/telegram-bot/version.rb

@@ -1,3 +1,3 @@
 module TelegramBot
-  VERSION = "0.1.0"
+  VERSION = "0.0.2"
 end

data/telegram-scrum-bot.gemspec

@@ -1,10 +1,11 @@
-# lib = File.expand_path("../lib", __FILE__)
-# $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "telegram-bot/version"
 
 Gem::Specification.new do |spec|
   spec.name        = 'telegram-scrum-bot'
   spec.date        = '2018-09-30'
-  spec.version     = '0.0.1'
+  spec.version     = TelegramBot::VERSION
   spec.authors     = ["Diego Camacho"]
   spec.email       = 'hackvan@gmail.com'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: telegram-scrum-bot
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Diego Camacho
@@ -91,6 +91,7 @@ files:
 - ".rspec"
 - Gemfile
 - Gemfile.lock
+- README.md
 - bin/console
 - bin/setup
 - exe/telegram-scrum-bot