fantastic_robot 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 70e7924cf945c7d75a688d2e6ddd86b8e4214978
+  data.tar.gz: 6a2385d639bb2a72ab956396fa68a633b5465185
+SHA512:
+  metadata.gz: 99031d282478178e085e21cea7e3fb5551d536c140da3c5ea7a03e5efb29e68e1a4f7be42c199c83c9323d661c396b6d78e72d4e2e468e004ff12bc430007365
+  data.tar.gz: f353a05df9aa13c2646fa3ffa159427c9317040c24932e72e60b4b804490eeb8566a1a0b89025440bc09f4fe0ff0c43aa4108f5c32bbfbb3f35052ca65b3f957

data/.gitignore

@@ -0,0 +1,117 @@
+
+# Created by https://www.gitignore.io/api/windows,linux,osx,sublimetext,ruby
+
+### Windows ###
+# Windows image file caches
+Thumbs.db
+ehthumbs.db
+
+# Folder config file
+Desktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+
+### Linux ###
+*~
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+
+### OSX ###
+.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
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+
+### SublimeText ###
+# cache files for sublime text
+*.tmlanguage.cache
+*.tmPreferences.cache
+*.stTheme.cache
+
+# workspace files are user-specific
+*.sublime-workspace
+
+# project files should be checked into the repository, unless a significant
+# proportion of contributors will probably not be using SublimeText
+# *.sublime-project
+
+# sftp configuration file
+sftp-config.json
+
+
+### Ruby ###
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0

data/.travis.yml

@@ -0,0 +1,19 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.0
+  - 2.2.0
+  - 2.2.3
+
+before_install:
+  - gem update --system
+  - gem --version
+  - gem install bundler
+  - bundler --version
+
+script: bundle exec rake test
+
+branches:
+  only:
+    - master
+    - development

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at oscar.dearriba@the-cocktail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    fantastic_robot (0.1.1)
+      activemodel (>= 4.0.0, < 5.0.0)
+      faraday (~> 0.9.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.2.5)
+      activesupport (= 4.2.5)
+      builder (~> 3.1)
+    activesupport (4.2.5)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    builder (3.2.2)
+    factory_girl (4.5.0)
+      activesupport (>= 3.0.0)
+    faker (1.6.1)
+      i18n (~> 0.5)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    i18n (0.7.0)
+    json (1.8.3)
+    minitest (5.8.3)
+    multipart-post (2.0.0)
+    rake (10.4.2)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.10)
+  factory_girl (~> 4.0)
+  faker (~> 1.6)
+  fantastic_robot!
+  minitest (~> 5.0)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.11.2

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Óscar de Arriba
+
+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,147 @@
+# fantastic_robot
+[![Build Status](https://travis-ci.org/odarriba/fantastic_robot.svg)](https://travis-ci.org/odarriba/fantastic_robot)
+
+The aim of this gem is to provide a useful wrapper of Telegram's Bot API that makes use of Webhooks functionality.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fantastic_robot'
+```
+
+And then execute:
+```
+$ bundle
+```
+
+Or install it yourself as:
+```
+$ gem install fantastic_robot
+```
+
+## Configuration
+
+Gem configuration can be initialized by running a custom generator:
+
+```
+$ rails g fantastic_robot:install
+```
+
+Then, you can change the configuration by editing the file located at `config/initializers/fantastic_robot.rb`
+
+At least, you should include:
+* Your bot's token
+* Your web hook callback URL (in which you'll receive the updates sent to your bot).
+
+**Important:** your webhook we'll be registered only if the `delivery_method` is set to `:delivery_method`.
+
+## Usage
+
+This gem provides models to access easily to API updates, and to create responses and requests to send messages and attachments to Telegram.
+
+### Models
+
+Used to parse received data from Telegram.
+
+Available models are:
+* FantasticRobot::Model::Chat
+* FantasticRobot::Model::Message
+* FantasticRobot::Model::Update
+* FantasticRobot::Model::User
+* FantasticRobot::Model::Attachment::Audio
+* FantasticRobot::Model::Attachment::Contact
+* FantasticRobot::Model::Attachment::Document
+* FantasticRobot::Model::Attachment::Location
+* FantasticRobot::Model::Attachment::PhotoSize
+* FantasticRobot::Model::Attachment::Sticker
+* FantasticRobot::Model::Attachment::Video
+* FantasticRobot::Model::Attachment::Voice
+
+If you want to know the variables available in each one, you can check the [official docs](https://core.telegram.org/bots/api#available-types).
+
+And they can be instantiated like any other model. You will commonly receive an `Update` object:
+
+```ruby
+received_hash = JSON.parse(request.body.read)
+received_update = FantasticRobot::Model::Update.new(received_hash)
+```
+
+Associated models (like the `Message` included inside the `Update`) will be automatically converted when instantiating the `Update` object.
+
+### Requests
+
+Request are objects that can receive (and validate) the parameters that can be sent in a request to the API.
+
+The available requests are:
+* FantasticRobot::Request::ForwardMessage
+* FantasticRobot::Request::GetMe
+* FantasticRobot::Request::SendAudio
+* FantasticRobot::Request::SendChatAction
+* FantasticRobot::Request::SendDocument
+* FantasticRobot::Request::SendLocation
+* FantasticRobot::Request::SendMessage
+* FantasticRobot::Request::SendPhoto
+* FantasticRobot::Request::SendSticker
+* FantasticRobot::Request::SendVideo
+* FantasticRobot::Request::SendVoice
+* FantasticRobot::Request::SetWebhook
+
+If you want to know the variables available in each one, you can check the [official docs](https://core.telegram.org/bots/api#available-methods).
+
+#### Sending a request
+
+There are two ways of sending a request:
+
+* All of them can be send asynchronously to the API using the `#send_request` method available in all request classes:
+
+```ruby
+req = FantasticRobot::Request::GetMe.new()
+response = req.send_request
+```
+
+  *Note:* if the API returns an error, a `Faraday::Error` exception will be raised
+
+* Synchronously as the response to the updates reception in the webhook callback URL. For example:
+
+```ruby
+def receive
+  received = FantasticRobot::Model::Update.new(JSON.parse(request.body.read))
+
+  response = FantasticRobot::Request::SendMessage.new({
+    chat_id: received.message.chat.id,
+    text: "Okay! I've got it!",
+    reply_to_message_id: received.message.message_id
+  })
+
+  render json: response
+end
+```
+
+## Unit testing
+
+Several tests have been implemented to verify that model an requests behave as expected.
+
+So please, if you want to contribute to this gem, check that tests are maintained and all of them pass.
+
+## To-Do
+
+There are several thing to do on this project:
+* Receiving updates by polling.
+* Getting user profile photos from the API.
+* Create models of custom keyboard responses (actually they can be hardcoded as a Hash object, [check the documentation](https://core.telegram.org/bots/api#replykeyboardmarkup)).
+* Inline queries.
+
+If you want to check out the gem's source code and want to contribute, you are welcome!
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/odarriba/fantastic_robot](https://github.com/odarriba/fantastic_robot). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+Everyone's contributions are welcome, so if you want to contribute, just fork this repo, make the changes you want and create a descriptive pull request :)
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT) as can be seen in LICENSE file.

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 "telegram/bot"
+
+# 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/fantastic_robot.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fantastic_robot/version'
+
+Gem::Specification.new do |s|
+  s.name          = "fantastic_robot"
+  s.version       = FantasticRobot::VERSION
+  s.authors       = ["Óscar de Arriba"]
+  s.email         = ["odarriba@gmail.com"]
+
+  s.summary       = %q{Ruby wrapper of Telegram's Bot API with web hooks functionality}
+  s.description   = %q{Ruby wrapper of Telegram's Bot API to create applications using web hooks functionality.}
+  s.homepage      = "https://github.com/odarriba/fantastic_robot"
+  s.license       = "MIT"
+
+  s.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  s.bindir        = "exe"
+  s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.required_ruby_version = '>= 2.0.0'
+
+  s.add_dependency "activemodel", '>= 4.0.0', '< 5.0.0'
+  s.add_dependency "faraday", "~> 0.9.2"
+
+  s.add_development_dependency "bundler", "~> 1.10"
+  s.add_development_dependency "rake", "~> 10.0"
+  s.add_development_dependency "minitest", "~> 5.0"
+  s.add_development_dependency "factory_girl", "~> 4.0"
+  s.add_development_dependency "faker", "~> 1.6"
+end

data/lib/fantastic_robot/configuration.rb

@@ -0,0 +1,32 @@
+require 'uri'
+
+module FantasticRobot
+  class Configuration
+    attr_accessor :api_key
+    attr_accessor :delivery_method
+    attr_accessor :callback_url
+
+    VALID_DELIVERY_METHODS = [:polling, :webhook]
+
+    def initialize
+      @delivery_method = :polling
+    end
+
+    def delivery_method= value
+      if VALID_DELIVERY_METHODS.include?(value)
+        @delivery_method = value
+      else
+        raise ArgumentError, "No valid reception method. Options available: #{VALID_DELIVERY_METHODS}"
+      end
+      @delivery_method
+    end
+
+    def callback_url= value
+      unless (value =~ URI::regexp).nil?
+        @callback_url = value
+      else
+        raise ArgumentError, "Invalid callback URL"
+      end
+    end
+  end
+end

data/lib/fantastic_robot/connection.rb

@@ -0,0 +1,36 @@
+require "faraday"
+require "open-uri"
+
+module FantasticRobot
+  class Connection
+    attr_reader :conn
+
+    def initialize
+      # Create the connection object to make calls to the API
+      @conn = Faraday.new(:url => "https://api.telegram.org/bot#{FantasticRobot.configuration.api_key}/") do |faraday|
+        faraday.request :multipart
+        faraday.request :url_encoded
+        faraday.response :logger                  # log requests to STDOUT
+        faraday.adapter  :net_http  # make requests with Net::HTTP
+      end
+    end
+
+    # Function to call API passing a payload
+    def api_call method, payload
+      raise ArgumentError, "API method not specified." if method.blank?
+
+      payload ||= {}
+
+      res = @conn.post method.to_s, payload
+
+      raise Faraday::Error, "Wrong response: #{res.inspect}" if (res.status != 200)
+
+      return res
+    end
+
+    def get_by_path path
+      return open("https://api.telegram.org/bot#{FantasticRobot.configuration.api_key}/#{path}")
+      raise Faraday::Error, "Wrong response: #{res.inspect}" if (res.status != 200)
+    end
+  end
+end

data/lib/fantastic_robot/model/attachment/audio.rb

@@ -0,0 +1,12 @@
+module FantasticRobot
+  # This object represents an audio file to be treated as music by the Telegram clients.
+  class Model::Attachment::Audio < Model::Attachment::Base
+
+    attr_accessor :file_id, :file_size, :duration, :performer, :title, :mime_type
+
+    validates :file_id, :duration, presence: true
+    validates :duration, numericality: true
+    validates :file_size, numericality: true, unless: 'file_size.blank?'
+    
+  end
+end

data/lib/fantastic_robot/model/attachment/base.rb

@@ -0,0 +1,15 @@
+module FantasticRobot
+  module Model
+    module Attachment
+      class Model::Attachment::Base < Model::Base
+        # Function to get the file attached (if there is any)
+        def get_file
+          unless (self.file_id.blank?)
+            request = FantasticRobot::Request::GetFile(file_id: self.file_id)
+            response = FantasticRobot::Model::File.new(JSON.parse(request.api_call))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fantastic_robot/model/attachment/contact.rb

@@ -0,0 +1,11 @@
+module FantasticRobot
+  # This object represents a phone contact.
+  class Model::Attachment::Contact < Model::Attachment::Base
+    
+    attr_accessor :phone_number, :first_name, :last_name, :user_id
+
+    validates :phone_number, :first_name, presence: true
+    validates :user_id, numericality: true, unless: 'user_id.blank?'
+
+  end
+end

data/lib/fantastic_robot/model/attachment/document.rb

@@ -0,0 +1,16 @@
+module FantasticRobot
+  # This object represents a general file (as opposed to photos, voice messages and audio files).
+  class Model::Attachment::Document < Model::Attachment::Base
+
+    attr_accessor :file_id, :file_size, :thumb, :file_name, :mime_type
+
+    validates :file_id, presence: true
+    validates :file_size, numericality: true, unless: 'file_size.blank?'
+
+    # Field conversions of this model
+    FIELD_CONVERSIONS = {
+      thumb: FantasticRobot::Model::Attachment::PhotoSize
+    }
+    
+  end
+end

data/lib/fantastic_robot/model/attachment/location.rb

@@ -0,0 +1,10 @@
+module FantasticRobot
+  # This object represents a point on the map.
+  class Model::Attachment::Location < Model::Attachment::Base
+    attr_accessor :longitude, :latitude
+
+    validates :longitude, :latitude, presence: true
+    validates :longitude, :latitude, numericality: true
+    
+  end
+end

data/lib/fantastic_robot/model/attachment/photo_size.rb

@@ -0,0 +1,12 @@
+module FantasticRobot
+  # This object represents one size of a photo or a file / sticker thumbnail.
+  class Model::Attachment::PhotoSize < Model::Attachment::Base
+
+    attr_accessor :file_id, :file_size, :width, :height
+
+    validates :file_id, :width, :height, presence: true
+    validates :width, :height, numericality: true
+    validates :file_size, numericality: true, unless: 'file_size.blank?'
+    
+  end
+end

data/lib/fantastic_robot/model/attachment/sticker.rb

@@ -0,0 +1,17 @@
+module FantasticRobot
+  # This object represents a sticker.
+  class Model::Attachment::Sticker < Model::Attachment::Base
+
+    attr_accessor :file_id, :file_size, :width, :height, :thumb
+
+    validates :file_id, :width, :height, presence: true
+    validates :width, :height, numericality: true
+    validates :file_size, numericality: true, unless: 'file_size.blank?'
+
+    # Field conversions of this model
+    FIELD_CONVERSIONS = {
+      thumb: FantasticRobot::Model::Attachment::PhotoSize
+    }
+
+  end
+end

data/lib/fantastic_robot/model/attachment/video.rb

@@ -0,0 +1,17 @@
+module FantasticRobot
+  # This object represents a video file.
+  class Model::Attachment::Video < Model::Attachment::Base
+
+    attr_accessor :file_id, :file_size, :width, :height, :duration, :thumb, :mime_type
+
+    validates :file_id, :width, :height, :duration, presence: true
+    validates :width, :height, :duration, numericality: true
+    validates :file_size, numericality: true, unless: 'file_size.blank?'
+
+    # Field conversions of this model
+    FIELD_CONVERSIONS = {
+      thumb: FantasticRobot::Model::Attachment::PhotoSize
+    }
+    
+  end
+end