chatbot_helper-telegram 0.1.0

data/lib/chatbot_helper/telegram/contact.rb

@@ -0,0 +1,16 @@
+module ChatbotHelper
+  module Telegram
+    # The contact resource which represents a Telegram bot API contact
+    class Contact < ChatbotHelper::Telegram::BaseResource
+      class << self
+        def required_fields
+          %w[phone_number first_name]
+        end
+
+        def optional_fields
+          %w[last_name user_id]
+        end
+      end
+    end
+  end
+end

data/lib/chatbot_helper/telegram/document.rb

@@ -0,0 +1,22 @@
+module ChatbotHelper
+  module Telegram
+    # The document resource which represents a Telegram bot API document
+    class Document < ChatbotHelper::Telegram::BaseResource
+      class << self
+        def required_fields
+          %w[file_id]
+        end
+
+        def optional_fields
+          %w[file_name mime_type file_size]
+        end
+
+        def optional_objects
+          [
+            { name: 'thumb', type: ChatbotHelper::Telegram::PhotoSize }
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/chatbot_helper/telegram/file.rb

@@ -0,0 +1,16 @@
+module ChatbotHelper
+  module Telegram
+    # The file resource which represents a Telegram bot API file
+    class File < ChatbotHelper::Telegram::BaseResource
+      class << self
+        def required_fields
+          %w[file_id]
+        end
+
+        def optional_fields
+          %w[file_size file_path]
+        end
+      end
+    end
+  end
+end

data/lib/chatbot_helper/telegram/force_reply.rb

@@ -0,0 +1,16 @@
+module ChatbotHelper
+  module Telegram
+    # The force_reply resource which represents a Telegram bot API force_reply
+    class ForceReply < ChatbotHelper::Telegram::BaseResource
+      class << self
+        def required_fields
+          %w[force_reply]
+        end
+
+        def optional_fields
+          %w[selective]
+        end
+      end
+    end
+  end
+end

data/lib/chatbot_helper/telegram/game.rb

@@ -0,0 +1,35 @@
+module ChatbotHelper
+  module Telegram
+    # The game resource which represents a Telegram bot API game
+    class Game < ChatbotHelper::Telegram::BaseResource
+      class << self
+        def required_fields
+          %w[title description]
+        end
+
+        def optional_fields
+          %w[text]
+        end
+
+        def optional_objects
+          [
+            { name: 'animation', type: ChatbotHelper::Telegram::Animation }
+          ]
+        end
+
+        def required_arrays
+          [
+            { name: 'photo', type: ChatbotHelper::Telegram::PhotoSize }
+          ]
+        end
+
+        def optional_arrays
+          [
+            { name: 'text_entities',
+              type: ChatbotHelper::Telegram::MessageEntity }
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/chatbot_helper/telegram/inline_keyboard_button.rb

@@ -0,0 +1,36 @@
+module ChatbotHelper
+  module Telegram
+    # The inline_keyboard_button resource which represents a Telegram bot API
+    # inline_keyboard_button
+    class InlineKeyboardButton < ChatbotHelper::Telegram::BaseResource
+      class << self
+        def required_fields
+          %w[text]
+        end
+
+        def optional_fields
+          %w[url callback_data switch_inline_query
+             switch_inline_query_current_chat]
+        end
+
+        def optional_objects
+          [
+            { name: 'callback_game',
+              type: ChatbotHelper::Telegram::CallbackGame }
+          ]
+        end
+      end
+    end
+
+    # A inline_keyboard_button collection which represents an array of
+    # inline_keyboard_button resources
+    class InlineKeyboardButtonCollection <
+      ChatbotHelper::Telegram::CollectionResource
+      class << self
+        def collection_type
+          ChatbotHelper::Telegram::InlineKeyboardButton
+        end
+      end
+    end
+  end
+end

data/lib/chatbot_helper/telegram/inline_keyboard_markup.rb

@@ -0,0 +1,16 @@
+module ChatbotHelper
+  module Telegram
+    # The inline_keyboard_markup resource which represents a Telegram bot API
+    # inline_keyboard_markup
+    class InlineKeyboardMarkup < ChatbotHelper::Telegram::BaseResource
+      class << self
+        def required_arrays
+          [
+            { name: 'inline_keyboard',
+              type: ChatbotHelper::Telegram::InlineKeyboardButtonCollection }
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/chatbot_helper/telegram/inline_query.rb

@@ -0,0 +1,24 @@
+module ChatbotHelper
+  module Telegram
+    # The inline_query resource which represents a Telegram bot API inline_query
+    class InlineQuery < ChatbotHelper::Telegram::BaseResource
+      class << self
+        def required_fields
+          %w[id query offset]
+        end
+
+        def required_objects
+          [
+            { name: 'from', type: ChatbotHelper::Telegram::User }
+          ]
+        end
+
+        def optional_objects
+          [
+            { name: 'location', type: ChatbotHelper::Telegram::Location },
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/chatbot_helper/telegram/keyboard_button.rb

@@ -0,0 +1,69 @@
+module ChatbotHelper
+  module Telegram
+    # The keyboard_button resource which represents a Telegram bot API
+    # keyboard_button
+    class KeyboardButton < ChatbotHelper::Telegram::BaseResource
+      class << self
+        def required_fields
+          %w[text]
+        end
+
+        def optional_fields
+          %w[request_contact request_location]
+        end
+
+        def valid_resource?(resource)
+          return false if resource.nil?
+
+          # A KeyboardButton can be a simple String.
+          # So if it is string like, return true because it
+          # is valid.
+          return true if resource.respond_to?(:to_str)
+
+          # TODO: This is duplicate code. Maybe this can be avoided...
+
+          # Test resource as always
+          required_fields.each do |f|
+            return false if resource[f].nil?
+          end
+
+          required_objects.each do |o|
+            return false unless o[:type].valid_resource?(resource[o[:name]])
+          end
+
+          required_arrays.each do |a|
+            arr = resource[a[:name]]
+            return false unless arr.respond_to?('each')
+            arr.each do |el|
+              return false unless a[:type].valid_resource?(el)
+            end
+          end
+
+          # All tests passed. Return true...
+          true
+        end
+      end
+
+      def implement_field_accessors
+        if @hash.respond_to?(:to_str)
+          define_singleton_method('text') do
+            # TODO: Should we return @hash.to_str so it is always a `String`?
+            return @hash
+          end
+        else
+          super
+        end
+      end
+    end
+
+    # A keyboard_button collection which represents an array of keyboard_button
+    # resources
+    class KeyboardButtonCollection < ChatbotHelper::Telegram::CollectionResource
+      class << self
+        def collection_type
+          ChatbotHelper::Telegram::KeyboardButton
+        end
+      end
+    end
+  end
+end

data/lib/chatbot_helper/telegram/location.rb

@@ -0,0 +1,12 @@
+module ChatbotHelper
+  module Telegram
+    # The location resource which represents a Telegram bot API location
+    class Location < ChatbotHelper::Telegram::BaseResource
+      class << self
+        def required_fields
+          %w[longitude latitude]
+        end
+      end
+    end
+  end
+end

data/lib/chatbot_helper/telegram/message.rb

@@ -0,0 +1,55 @@
+module ChatbotHelper
+  module Telegram
+    # The message resource which represents a Telegram bot API message
+    class Message < ChatbotHelper::Telegram::BaseResource
+      class << self
+        def required_fields
+          %w[message_id date]
+        end
+
+        def optional_fields
+          %w[forward_from_message_id forward_date edit_date text caption
+             new_chat_title delete_chat_photo group_chat_created
+             supergroup_chat_created channel_chat_created migrate_to_chat_id
+             migrate_from_chat_id]
+        end
+
+        def required_objects
+          [
+            { name: 'chat', type: ChatbotHelper::Telegram::Chat }
+          ]
+        end
+
+        def optional_objects
+          [
+            { name: 'from', type: ChatbotHelper::Telegram::User },
+            { name: 'forward_from', type: ChatbotHelper::Telegram::User },
+            { name: 'forward_from_chat', type: ChatbotHelper::Telegram::Chat },
+            { name: 'reply_to_message',
+              type: ChatbotHelper::Telegram::Message },
+            { name: 'audio', type: ChatbotHelper::Telegram::Audio },
+            { name: 'document', type: ChatbotHelper::Telegram::Document },
+            { name: 'game', type: ChatbotHelper::Telegram::Game },
+            { name: 'sticker', type: ChatbotHelper::Telegram::Sticker },
+            { name: 'video', type: ChatbotHelper::Telegram::Video },
+            { name: 'voice', type: ChatbotHelper::Telegram::Voice },
+            { name: 'contact', type: ChatbotHelper::Telegram::Contact },
+            { name: 'location', type: ChatbotHelper::Telegram::Location },
+            { name: 'venue', type: ChatbotHelper::Telegram::Venue },
+            { name: 'new_chat_member', type: ChatbotHelper::Telegram::User },
+            { name: 'left_chat_member', type: ChatbotHelper::Telegram::User },
+            { name: 'pinned_message', type: ChatbotHelper::Telegram::Message }
+          ]
+        end
+
+        def optional_arrays
+          [
+            { name: 'entities', type: ChatbotHelper::Telegram::MessageEntity },
+            { name: 'photo', type: ChatbotHelper::Telegram::PhotoSize },
+            { name: 'new_chat_photo', type: ChatbotHelper::Telegram::PhotoSize }
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/chatbot_helper/telegram/message_entity.rb

@@ -0,0 +1,23 @@
+module ChatbotHelper
+  module Telegram
+    # The message_entity resource which represents a Telegram bot API
+    # message_entity
+    class MessageEntity < ChatbotHelper::Telegram::BaseResource
+      class << self
+        def required_fields
+          %w[type offset length]
+        end
+
+        def optional_fields
+          %w[url]
+        end
+
+        def optional_objects
+          [
+            { name: 'user', type: ChatbotHelper::Telegram::User }
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/chatbot_helper/telegram/photo_size.rb

@@ -0,0 +1,25 @@
+module ChatbotHelper
+  module Telegram
+    # The photo_size resource which represents a Telegram bot API photo_size
+    class PhotoSize < ChatbotHelper::Telegram::BaseResource
+      class << self
+        def required_fields
+          %w[file_id width height]
+        end
+
+        def optional_fields
+          %w[file_size]
+        end
+      end
+    end
+
+    # A photo_size collection which represents an array of photo_size resources
+    class PhotoSizeCollection < ChatbotHelper::Telegram::CollectionResource
+      class << self
+        def collection_type
+          ChatbotHelper::Telegram::PhotoSize
+        end
+      end
+    end
+  end
+end

data/lib/chatbot_helper/telegram/reply_keyboard_markup.rb

@@ -0,0 +1,20 @@
+module ChatbotHelper
+  module Telegram
+    # The reply_keyboard_markup resource which represents a Telegram bot API
+    # reply_keyboard_markup
+    class ReplyKeyboardMarkup < ChatbotHelper::Telegram::BaseResource
+      class << self
+        def optional_fields
+          %w[resize_keyboard one_time_keyboard selective]
+        end
+
+        def required_arrays
+          [
+            { name: 'keyboard',
+              type: ChatbotHelper::Telegram::KeyboardButtonCollection }
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/chatbot_helper/telegram/reply_keyboard_remove.rb

@@ -0,0 +1,17 @@
+module ChatbotHelper
+  module Telegram
+    # The reply_keyboard_remove resource which represents a Telegram bot API
+    # reply_keyboard_remove
+    class ReplyKeyboardRemove < ChatbotHelper::Telegram::BaseResource
+      class << self
+        def required_fields
+          %w[remove_keyboard]
+        end
+
+        def optional_fields
+          %w[selective]
+        end
+      end
+    end
+  end
+end

data/lib/chatbot_helper/telegram/response_parameters.rb

@@ -0,0 +1,13 @@
+module ChatbotHelper
+  module Telegram
+    # The response_parameters resource which represents a Telegram bot API
+    # response_parameters
+    class ResponseParameters < ChatbotHelper::Telegram::BaseResource
+      class << self
+        def optional_fields
+          %w[migrate_to_chat_id retry_after]
+        end
+      end
+    end
+  end
+end

data/lib/chatbot_helper/telegram/sticker.rb

@@ -0,0 +1,22 @@
+module ChatbotHelper
+  module Telegram
+    # The sticker resource which represents a Telegram bot API sticker
+    class Sticker < ChatbotHelper::Telegram::BaseResource
+      class << self
+        def required_fields
+          %w[file_id width height]
+        end
+
+        def optional_fields
+          %w[emoji file_size]
+        end
+
+        def optional_objects
+          [
+            { name: 'thumb', type: ChatbotHelper::Telegram::PhotoSize }
+          ]
+        end
+      end
+    end
+  end
+end