Changed model namespacing, added lots of docs

protoncr · Jun 6, 2019 · e71ab3b · e71ab3b
1 parent 8d09d57
commit e71ab3b
Show file tree

Hide file tree

Showing 170 changed files with 66,230 additions and 3,261 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,3 @@
-/doc/
 /lib/
 /bin/
 /.shards/

diff --git a/README.md b/README.md
@@ -1,9 +1,11 @@
 ![Header Image](img/header.png)
 
-[![Travis](https://img.shields.io/travis/watzon/tourmaline.svg)](https://travis-ci.org/watzon/tourmaline) ![Github search hit counter](https://img.shields.io/github/search/watzon/tourmaline/goto.svg) ![license](https://img.shields.io/github/license/watzon/tourmaline.svg)
+![Github search hit counter](https://img.shields.io/github/search/watzon/tourmaline/goto.svg) ![license](https://img.shields.io/github/license/watzon/tourmaline.svg)
 
 Telegram Bot (and hopefully soon API) framework for Crystal. Based heavily off of [Telegraf](http://telegraf.js.org) this Crystal implementation allows your Telegram bot to be written in a language that's both beautiful and fast. Benchmarks coming soon.
 
+[Read the docs](https://watzon.github.io/tourmaline)
+
 ## Installation
 
 Add this to your application's `shard.yml`:
@@ -19,7 +21,7 @@ dependencies:
 ### Basic usage
 
 ```crystal
-require "tourmaline"
+require "tourmaline/bot"
 
 alias TGBot = Tourmaline::Bot
 
@@ -82,10 +84,10 @@ Update sub-types:
 - Invoice
 - SuccessfulPayment
 
-All of which are available through the enum `Tourmaline::Bot::UpdateAction`
+All of which are available through the enum `Tourmaline::Bot::UpdateAction`. To avoid having to use the full namespace you can just use a symbol.
 
 ```crystal
-bot.on(TGBot::UpdateAction::Text) do |update|
+bot.on(:text) do |update|
   text = update.message.not_nil!.text.not_nil!
   puts "TEXT: #{text}"
 end

diff --git a/docs/Tourmaline.html b/docs/Tourmaline.html
diff --git a/docs/Tourmaline/Bot.html b/docs/Tourmaline/Bot.html
diff --git a/docs/Tourmaline/Bot/ChatAction.html b/docs/Tourmaline/Bot/ChatAction.html
diff --git a/docs/Tourmaline/Bot/Client.html b/docs/Tourmaline/Bot/Client.html
diff --git a/docs/Tourmaline/Bot/CommandHandler.html b/docs/Tourmaline/Bot/CommandHandler.html
diff --git a/docs/Tourmaline/Bot/CommandMiddleware.html b/docs/Tourmaline/Bot/CommandMiddleware.html
diff --git a/docs/Tourmaline/Bot/EventHandler.html b/docs/Tourmaline/Bot/EventHandler.html
diff --git a/docs/Tourmaline/Bot/Middleware.html b/docs/Tourmaline/Bot/Middleware.html
diff --git a/docs/Tourmaline/Bot/MiddlewareHandler.html b/docs/Tourmaline/Bot/MiddlewareHandler.html
diff --git a/docs/Tourmaline/Bot/Model.html b/docs/Tourmaline/Bot/Model.html
diff --git a/docs/Tourmaline/Bot/Model/Animation.html b/docs/Tourmaline/Bot/Model/Animation.html
diff --git a/docs/Tourmaline/Bot/Model/Audio.html b/docs/Tourmaline/Bot/Model/Audio.html
diff --git a/docs/Tourmaline/Bot/Model/CallbackGame.html b/docs/Tourmaline/Bot/Model/CallbackGame.html
diff --git a/docs/Tourmaline/Bot/Model/CallbackQuery.html b/docs/Tourmaline/Bot/Model/CallbackQuery.html
diff --git a/docs/Tourmaline/Bot/Model/Chat.html b/docs/Tourmaline/Bot/Model/Chat.html
diff --git a/docs/Tourmaline/Bot/Model/ChatMember.html b/docs/Tourmaline/Bot/Model/ChatMember.html
diff --git a/docs/Tourmaline/Bot/Model/ChatPhoto.html b/docs/Tourmaline/Bot/Model/ChatPhoto.html
diff --git a/docs/Tourmaline/Bot/Model/ChosenInlineResult.html b/docs/Tourmaline/Bot/Model/ChosenInlineResult.html
diff --git a/docs/Tourmaline/Bot/Model/Contact.html b/docs/Tourmaline/Bot/Model/Contact.html
diff --git a/docs/Tourmaline/Bot/Model/Document.html b/docs/Tourmaline/Bot/Model/Document.html
diff --git a/docs/Tourmaline/Bot/Model/File.html b/docs/Tourmaline/Bot/Model/File.html
diff --git a/docs/Tourmaline/Bot/Model/ForceReply.html b/docs/Tourmaline/Bot/Model/ForceReply.html
diff --git a/docs/Tourmaline/Bot/Model/Game.html b/docs/Tourmaline/Bot/Model/Game.html
diff --git a/docs/Tourmaline/Bot/Model/GameHighScore.html b/docs/Tourmaline/Bot/Model/GameHighScore.html
diff --git a/docs/Tourmaline/Bot/Model/InlineKeyboardButton.html b/docs/Tourmaline/Bot/Model/InlineKeyboardButton.html
diff --git a/docs/Tourmaline/Bot/Model/InlineKeyboardMarkup.html b/docs/Tourmaline/Bot/Model/InlineKeyboardMarkup.html
diff --git a/docs/Tourmaline/Bot/Model/InlineQuery.html b/docs/Tourmaline/Bot/Model/InlineQuery.html
diff --git a/docs/Tourmaline/Bot/Model/InlineQueryResult.html b/docs/Tourmaline/Bot/Model/InlineQueryResult.html
diff --git a/docs/Tourmaline/Bot/Model/InlineQueryResultArticle.html b/docs/Tourmaline/Bot/Model/InlineQueryResultArticle.html
diff --git a/docs/Tourmaline/Bot/Model/InlineQueryResultAudio.html b/docs/Tourmaline/Bot/Model/InlineQueryResultAudio.html
diff --git a/docs/Tourmaline/Bot/Model/InlineQueryResultCachedAudio.html b/docs/Tourmaline/Bot/Model/InlineQueryResultCachedAudio.html
diff --git a/docs/Tourmaline/Bot/Model/InlineQueryResultCachedDocument.html b/docs/Tourmaline/Bot/Model/InlineQueryResultCachedDocument.html
diff --git a/docs/Tourmaline/Bot/Model/InlineQueryResultCachedGif.html b/docs/Tourmaline/Bot/Model/InlineQueryResultCachedGif.html
diff --git a/docs/Tourmaline/Bot/Model/InlineQueryResultCachedMpeg4Gif.html b/docs/Tourmaline/Bot/Model/InlineQueryResultCachedMpeg4Gif.html
diff --git a/docs/Tourmaline/Bot/Model/InlineQueryResultCachedPhoto.html b/docs/Tourmaline/Bot/Model/InlineQueryResultCachedPhoto.html
diff --git a/docs/Tourmaline/Bot/Model/InlineQueryResultCachedSticker.html b/docs/Tourmaline/Bot/Model/InlineQueryResultCachedSticker.html
diff --git a/docs/Tourmaline/Bot/Model/InlineQueryResultCachedVideo.html b/docs/Tourmaline/Bot/Model/InlineQueryResultCachedVideo.html
diff --git a/docs/Tourmaline/Bot/Model/InlineQueryResultCachedVoice.html b/docs/Tourmaline/Bot/Model/InlineQueryResultCachedVoice.html
diff --git a/docs/Tourmaline/Bot/Model/InlineQueryResultContact.html b/docs/Tourmaline/Bot/Model/InlineQueryResultContact.html
diff --git a/docs/Tourmaline/Bot/Model/InlineQueryResultDocument.html b/docs/Tourmaline/Bot/Model/InlineQueryResultDocument.html
diff --git a/docs/Tourmaline/Bot/Model/InlineQueryResultGif.html b/docs/Tourmaline/Bot/Model/InlineQueryResultGif.html
diff --git a/docs/Tourmaline/Bot/Model/InlineQueryResultLocation.html b/docs/Tourmaline/Bot/Model/InlineQueryResultLocation.html
diff --git a/docs/Tourmaline/Bot/Model/InlineQueryResultMpeg4Gif.html b/docs/Tourmaline/Bot/Model/InlineQueryResultMpeg4Gif.html
diff --git a/docs/Tourmaline/Bot/Model/InlineQueryResultPhoto.html b/docs/Tourmaline/Bot/Model/InlineQueryResultPhoto.html
diff --git a/docs/Tourmaline/Bot/Model/InlineQueryResultVenue.html b/docs/Tourmaline/Bot/Model/InlineQueryResultVenue.html
diff --git a/docs/Tourmaline/Bot/Model/InlineQueryResultVideo.html b/docs/Tourmaline/Bot/Model/InlineQueryResultVideo.html
diff --git a/docs/Tourmaline/Bot/Model/InlineQueryResultVoice.html b/docs/Tourmaline/Bot/Model/InlineQueryResultVoice.html
diff --git a/docs/Tourmaline/Bot/Model/InputContactMessageContent.html b/docs/Tourmaline/Bot/Model/InputContactMessageContent.html
diff --git a/docs/Tourmaline/Bot/Model/InputLocationMessageContent.html b/docs/Tourmaline/Bot/Model/InputLocationMessageContent.html
diff --git a/docs/Tourmaline/Bot/Model/InputMedia.html b/docs/Tourmaline/Bot/Model/InputMedia.html
diff --git a/docs/Tourmaline/Bot/Model/InputMediaVideo.html b/docs/Tourmaline/Bot/Model/InputMediaVideo.html
diff --git a/docs/Tourmaline/Bot/Model/InputMessageContent.html b/docs/Tourmaline/Bot/Model/InputMessageContent.html
diff --git a/docs/Tourmaline/Bot/Model/InputTextMessageContent.html b/docs/Tourmaline/Bot/Model/InputTextMessageContent.html
diff --git a/docs/Tourmaline/Bot/Model/InputVenueMessageContent.html b/docs/Tourmaline/Bot/Model/InputVenueMessageContent.html
diff --git a/docs/Tourmaline/Bot/Model/Invoice.html b/docs/Tourmaline/Bot/Model/Invoice.html
diff --git a/docs/Tourmaline/Bot/Model/KeyboardButton.html b/docs/Tourmaline/Bot/Model/KeyboardButton.html
diff --git a/docs/Tourmaline/Bot/Model/LabeledPrice.html b/docs/Tourmaline/Bot/Model/LabeledPrice.html
diff --git a/docs/Tourmaline/Bot/Model/Location.html b/docs/Tourmaline/Bot/Model/Location.html
diff --git a/docs/Tourmaline/Bot/Model/MaskPosition.html b/docs/Tourmaline/Bot/Model/MaskPosition.html
diff --git a/docs/Tourmaline/Bot/Model/Message.html b/docs/Tourmaline/Bot/Model/Message.html
diff --git a/docs/Tourmaline/Bot/Model/MessageEntity.html b/docs/Tourmaline/Bot/Model/MessageEntity.html
diff --git a/docs/Tourmaline/Bot/Model/OrderInfo.html b/docs/Tourmaline/Bot/Model/OrderInfo.html
diff --git a/docs/Tourmaline/Bot/Model/PhotoSize.html b/docs/Tourmaline/Bot/Model/PhotoSize.html
diff --git a/docs/Tourmaline/Bot/Model/PreCheckoutQuery.html b/docs/Tourmaline/Bot/Model/PreCheckoutQuery.html
diff --git a/docs/Tourmaline/Bot/Model/ReplyKeyboardMarkup.html b/docs/Tourmaline/Bot/Model/ReplyKeyboardMarkup.html
diff --git a/docs/Tourmaline/Bot/Model/ReplyKeyboardRemove.html b/docs/Tourmaline/Bot/Model/ReplyKeyboardRemove.html
diff --git a/docs/Tourmaline/Bot/Model/ShippingAddress.html b/docs/Tourmaline/Bot/Model/ShippingAddress.html
diff --git a/docs/Tourmaline/Bot/Model/ShippingOption.html b/docs/Tourmaline/Bot/Model/ShippingOption.html
diff --git a/docs/Tourmaline/Bot/Model/ShippingQuery.html b/docs/Tourmaline/Bot/Model/ShippingQuery.html
diff --git a/docs/Tourmaline/Bot/Model/Sticker.html b/docs/Tourmaline/Bot/Model/Sticker.html
diff --git a/docs/Tourmaline/Bot/Model/StickerSet.html b/docs/Tourmaline/Bot/Model/StickerSet.html
diff --git a/docs/Tourmaline/Bot/Model/SuccessfulPayment.html b/docs/Tourmaline/Bot/Model/SuccessfulPayment.html
diff --git a/docs/Tourmaline/Bot/Model/Update.html b/docs/Tourmaline/Bot/Model/Update.html
diff --git a/docs/Tourmaline/Bot/Model/User.html b/docs/Tourmaline/Bot/Model/User.html
diff --git a/docs/Tourmaline/Bot/Model/UserProfilePhotos.html b/docs/Tourmaline/Bot/Model/UserProfilePhotos.html
diff --git a/docs/Tourmaline/Bot/Model/Venue.html b/docs/Tourmaline/Bot/Model/Venue.html
diff --git a/docs/Tourmaline/Bot/Model/Video.html b/docs/Tourmaline/Bot/Model/Video.html
diff --git a/docs/Tourmaline/Bot/Model/VideoNote.html b/docs/Tourmaline/Bot/Model/VideoNote.html
diff --git a/docs/Tourmaline/Bot/Model/Voice.html b/docs/Tourmaline/Bot/Model/Voice.html
diff --git a/docs/Tourmaline/Bot/Model/WebhookInfo.html b/docs/Tourmaline/Bot/Model/WebhookInfo.html
diff --git a/docs/Tourmaline/Bot/ParseMode.html b/docs/Tourmaline/Bot/ParseMode.html
diff --git a/docs/Tourmaline/Bot/UpdateAction.html b/docs/Tourmaline/Bot/UpdateAction.html
diff --git a/docs/Tourmaline/User.html b/docs/Tourmaline/User.html
diff --git a/docs/Tourmaline/User/API.html b/docs/Tourmaline/User/API.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/index.json b/docs/index.json
diff --git a/docs/search-index.js b/docs/search-index.js
diff --git a/docs/toplevel.html b/docs/toplevel.html
diff --git a/examples/inline_query.cr b/examples/inline_query.cr
@@ -4,23 +4,23 @@ bot = Tourmaline::Bot::Client.new(ENV["API_KEY"])
 
 bot.on(Tourmaline::Bot::UpdateAction::InlineQuery) do |update|
   query = update.inline_query.not_nil!
-  results = [] of Tourmaline::Bot::InlineQueryResult
+  results = [] of Tourmaline::Bot::Model::InlineQueryResult
 
-  results << Tourmaline::Bot::InlineQueryResultArticle.new(
+  results << Tourmaline::Bot::Model::InlineQueryResultArticle.new(
     id: "query",
     title: "Inline title",
-    input_message_content: Tourmaline::Bot::InputTextMessageContent.new("Click!"),
+    input_message_content: Tourmaline::Bot::Model::InputTextMessageContent.new("Click!"),
     description: "Your query: #{query.query}",
   )
 
-  results << Tourmaline::Bot::InlineQueryResultPhoto.new(
+  results << Tourmaline::Bot::Model::InlineQueryResultPhoto.new(
     id: "photo",
     caption: "Telegram logo",
     photo_url: "https://telegram.org/img/t_logo.png",
     thumb_url: "https://telegram.org/img/t_logo.png"
   )
 
-  results << Tourmaline::Bot::InlineQueryResultGif.new(
+  results << Tourmaline::Bot::Model::InlineQueryResultGif.new(
     id: "gif",
     gif_url: "https://telegram.org/img/tl_card_wecandoit.gif",
     thumb_url: "https://telegram.org/img/tl_card_wecandoit.gif"

diff --git a/examples/kitty_bot.cr b/examples/kitty_bot.cr
@@ -2,7 +2,7 @@ require "../src/tourmaline"
 
 bot = Tourmaline::Bot::Client.new(ENV["API_KEY"])
 
-reply_markup = Tourmaline::Bot::ReplyKeyboardMarkup.new([
+reply_markup = Tourmaline::Bot::Model::ReplyKeyboardMarkup.new([
   ["/kitty"], ["/kittygif"],
 ])
 
@@ -24,10 +24,10 @@ bot.command(["kitty", "kittygif"]) do |message|
   cmd = message.text.not_nil!.split(" ")[0]
 
   if cmd == "/kitty"
-    bot.send_chat_action(message.chat.id, Tourmaline::Bot::ChatAction::UploadPhoto)
+    bot.send_chat_action(message.chat.id, :upload_photo)
     bot.send_photo(message.chat.id, api + "jpg")
   else
-    bot.send_chat_action(message.chat.id, Tourmaline::Bot::ChatAction::UploadDocument)
+    bot.send_chat_action(message.chat.id, :upload_document)
     bot.send_document(message.chat.id, api + "gif")
   end
 end

diff --git a/shard.yml b/shard.yml
@@ -1,10 +1,10 @@
 name: tourmaline
-version: 0.4.0
+version: 0.5.0
 
 authors:
   - Chris Watson <chris@watzon.me>
 
-crystal: 0.24.1
+crystal: 0.28.0
 
 dependencies:
   halite: