chatbot_helper-telegram 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b33926914f85db219452360ab585b1273a7d20ae
+  data.tar.gz: dc4f9f80efcdb2c28054805e698b97326ba4577e
+SHA512:
+  metadata.gz: 9244d79ce09e99036455c4fd380c6ca8869df5876c3c2707ce7df8e18646725909489bcc9f667ec4e7402924c07db3ddb1a49380e482d9f53e61cf129f492317
+  data.tar.gz: 663e54f9c9ee8b19d988eeda2053fae94760d5d9f934cd683a3f75463b2846be6ca8cada7895e0277261b0bb12451fda8b5636c98091cba8cdc4a4c899c81d25

data/.gitignore

@@ -0,0 +1,129 @@
+/.bundle/
+/.yardoc
+# Don't check in Gemfile.lock for gems.
+# Explanation: http://yehudakatz.com/2010/12/16/clarifying-the-roles-of-the-gemspec-and-gemfile/
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# Created by https://www.gitignore.io/api/macos,windows,rubymine
+
+### macOS ###
+*.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### RubyMine ###
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff:
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/dictionaries
+
+# Sensitive or high-churn files:
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.xml
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+
+# Gradle:
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# CMake
+cmake-build-debug/
+
+# Mongo Explorer plugin:
+.idea/**/mongoSettings.xml
+
+## File-based project format:
+*.iws
+
+## Plugin-specific files:
+
+# IntelliJ
+/out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+### RubyMine Patch ###
+# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721
+
+# *.iml
+# modules.xml
+# .idea/misc.xml
+# *.ipr
+
+# Sonarlint plugin
+.idea/sonarlint
+
+### Windows ###
+# Windows thumbnail cache files
+Thumbs.db
+ehthumbs.db
+ehthumbs_vista.db
+
+# Folder config file
+Desktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+# End of https://www.gitignore.io/api/macos,windows,rubymine
+
+# Don't check in the .idea directory
+# This can be discussed but for now it doesn't make any sense to check it in
+.idea/

data/.travis.yml

@@ -0,0 +1,14 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.1.10
+  - 2.2.7
+  - 2.3.4
+  - 2.4.1
+before_install: gem install bundler -v 1.14.6
+# code climate plugin
+addons:
+  code_climate:
+    repo_token: 9e0693f87fb7a67ceb8b36f123dc70f6dd8a752d61faf47cfedad87932242193
+after_success:
+  - bundle exec codeclimate-test-reporter

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in chatbot_helper-telegram.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Ybrin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,128 @@
+# ChatbotHelper::Telegram [![Build Status](https://travis-ci.org/Ybrin/chatbot_helper-telegram.svg?branch=master)](https://travis-ci.org/Ybrin/chatbot_helper-telegram) [![Code Climate](https://codeclimate.com/github/Ybrin/chatbot_helper-telegram/badges/gpa.svg)](https://codeclimate.com/github/Ybrin/chatbot_helper-telegram) [![Test Coverage](https://codeclimate.com/github/Ybrin/chatbot_helper-telegram/badges/coverage.svg)](https://codeclimate.com/github/Ybrin/chatbot_helper-telegram/coverage)
+
+`ChatbotHelper::Telegram` helps you build awesome Telegram chatbots without bothering much about the documentation, the message structure or other details. It is a wrapper around the [Telegram Bot API](https://core.telegram.org/bots/api).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'chatbot_helper-telegram'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install chatbot_helper-telegram
+
+Then require it and you are good to go:
+
+```ruby
+require 'chatbot_helper/telegram'
+```
+
+## Usage
+
+As of now, you are responsible for getting messages or other objects from the Telegram Bot API with your favorite HTTP library. We consider adding all Bot API methods to this library in one of the next versions. Please open an [issue](https://github.com/Ybrin/chatbot_helper-telegram/issues) if you think that's a good idea.
+
+An example with [typhoeus](https://github.com/typhoeus/typhoeus):
+
+```ruby
+require 'typhoeus'
+require 'chatbot_helper/telegram'
+require 'json'
+
+# Your environment must have set the `TELEGRAM_TOKEN` key to your telegram api
+# token. See https://core.telegram.org/bots#3-how-do-i-create-a-bot for more
+# information.
+telegram_token = ENV['TELEGRAM_TOKEN']
+url = "https://api.telegram.org/bot#{telegram_token}/sendMessage"
+
+# We create a message
+message = {
+  chat_id: 123456,
+  text: "This is an example message sent by my telegram bot"
+}
+
+request = Typhoeus::Request.new(
+  url,
+  method: :post,
+  body: JSON.generate(message),
+  headers: { 'Content-Type' => 'application/json' }
+)
+request.run
+
+body = request.response.body
+
+# We create a Message object from the response body
+message = ChatbotHelper::Telegram::Message.new(string: body)
+
+# Now you can access all properties of the message object
+puts message.date
+puts message.from.first_name
+
+# Yay!
+```
+
+The real power of this library is the update and command parsing.    
+Say, for example, you have set up [webhooks](https://core.telegram.org/bots/api#setwebhook) and you want to parse the updates retrieved from these webhook requests. This is a [sinatra](http://www.sinatrarb.com/) example but you can easily convert it to Rails code.    
+
+```ruby
+require 'sinatra'
+require 'chatbot_helper/telegram'
+require 'json'
+
+post "/#{ENV['TELEGRAM_TOKEN']}/?" do
+  request.body.rewind
+  payload_body = request.body.read
+
+  # Create an instance of Update from the request body...
+  update = ChatbotHelper::Telegram::Update.new(string: payload_body)
+
+  # Return a message based on the given command
+  message = {}
+  if update.message
+    # Access the chat id through the given message
+    message[:chat_id] = update.message.chat.id
+
+    case update.message.text
+    when '/start'
+      text = "Hello and welcome to my awesome bot #{update.chat.first_name}!"
+      message[:text] = text
+    when '/saysomething'
+      text = "Why should I talk with you, #{update.chat.first_name}? Give me "\
+             "a reason!"
+      message[:text] = text
+    end
+
+    # Return the message which should be sent
+    return halt 200, { 'Content-Type' => 'application/json' }, JSON.generate(message)
+  end
+
+  # Fallback, return nothing
+  return halt 200, { 'Content-Type' => 'application/json' }, '{}'
+end
+```
+
+You can work with nearly all Telegram Bot API [available types](https://core.telegram.org/bots/api#available-types).    
+One exception are the `Inline mode` types which has currently just partial support and will be fully available in the next version.
+
+If you need help or have a feature request feel free and open an [issue](https://github.com/Ybrin/chatbot_helper-telegram/issues).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Ybrin/chatbot_helper-telegram.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "chatbot_helper/telegram"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/chatbot_helper-telegram.gemspec

@@ -0,0 +1,43 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'chatbot_helper/telegram/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'chatbot_helper-telegram'
+  spec.version       = ChatbotHelper::Telegram::VERSION
+  spec.authors       = ['Koray Koska']
+  spec.email         = ['koray@koska.at']
+
+  spec.summary       = %q{Easily handle Telegram chatbot messages in Ruby}
+  spec.description   = %q{This library tries to help working with messages from the Telegram chatbot API. Messages are parsed and useful methods provide all needed information about the message.}
+  spec.homepage      = 'https://github.com/Ybrin/chatbot_helper-telegram'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Development dependencies
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 1.0.0'
+
+  # Project dependencies
+  spec.add_dependency 'json', '~> 2.0'
+end

data/lib/chatbot_helper/exceptions.rb

@@ -0,0 +1,27 @@
+module ChatbotHelper
+  module Exceptions
+    # A default Error class which should not be used but instead subclassed
+    class Error < RuntimeError
+      attr_reader :errors
+
+      def initialize(*errors)
+        @errors = errors
+      end
+
+      class << self
+        def description
+          raise NotImplementedError, 'Description of subclass not implemented'
+        end
+      end
+    end
+
+    # An invalid resource error
+    class InvalidResource < Error
+      class << self
+        def description
+          'A resource is invalid or does not follow its specification'
+        end
+      end
+    end
+  end
+end

data/lib/chatbot_helper/telegram.rb

@@ -0,0 +1,47 @@
+require 'chatbot_helper/telegram/version'
+
+# BaseResource
+require 'chatbot_helper/telegram/base_resource'
+# Resources
+require 'chatbot_helper/telegram/animation'
+require 'chatbot_helper/telegram/audio'
+require 'chatbot_helper/telegram/callback_game'
+require 'chatbot_helper/telegram/callback_query'
+require 'chatbot_helper/telegram/chat'
+require 'chatbot_helper/telegram/chat_member'
+require 'chatbot_helper/telegram/chosen_inline_result'
+require 'chatbot_helper/telegram/collection_resource'
+require 'chatbot_helper/telegram/contact'
+require 'chatbot_helper/telegram/document'
+require 'chatbot_helper/telegram/file'
+require 'chatbot_helper/telegram/force_reply'
+require 'chatbot_helper/telegram/game'
+require 'chatbot_helper/telegram/inline_keyboard_button'
+require 'chatbot_helper/telegram/inline_keyboard_markup'
+require 'chatbot_helper/telegram/inline_query'
+require 'chatbot_helper/telegram/keyboard_button'
+require 'chatbot_helper/telegram/location'
+require 'chatbot_helper/telegram/message'
+require 'chatbot_helper/telegram/message_entity'
+require 'chatbot_helper/telegram/photo_size'
+require 'chatbot_helper/telegram/reply_keyboard_markup'
+require 'chatbot_helper/telegram/reply_keyboard_remove'
+require 'chatbot_helper/telegram/response_parameters'
+require 'chatbot_helper/telegram/sticker'
+require 'chatbot_helper/telegram/update'
+require 'chatbot_helper/telegram/user'
+require 'chatbot_helper/telegram/user_profile_photos'
+require 'chatbot_helper/telegram/venue'
+require 'chatbot_helper/telegram/video'
+require 'chatbot_helper/telegram/voice'
+
+require 'chatbot_helper/telegram/toolbox'
+
+# Exceptions
+require 'chatbot_helper/exceptions'
+
+module ChatbotHelper
+  module Telegram
+    # Your code goes here...
+  end
+end