ayanami 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b728f2a264d75fc29b0ae00a1fb06eea1653d5ab
+  data.tar.gz: c1343ed07ac528214b86d6c3c560deb83b4c13f0
+SHA512:
+  metadata.gz: 17152efc7eecd7737dc6c30e6e783d20958e690a6b88337e3d1a3f1f7c9304bb39d0f7eea759b2b5fd365aa59d9513be3a7519164b045e98359f529ce17412f0
+  data.tar.gz: ea6f02385f60326b7794036fd46e287169b2042ac80219189166b5afc58cdbb8b20a5916d4218481bb459403cc3a161af0e3ca733068e70de9996a644e16695e

data/.coafile

@@ -0,0 +1,18 @@
+[default]
+bears = FilenameBear, coalaBear, KeywordBear, SpaceConsistencyBear
+files = **.txt, **.md
+ignore = vendor/**
+cs_keywords = FIXME
+ci_keywords = FIXME
+max_line_length = 100
+use_spaces = True
+
+[text]
+bears = LineLengthBear
+files = **.txt, **.md
+
+[ruby]
+bears = CPDBear, RuboCopBear, RubySyntaxBear
+files = lib/**.rb
+too_many_methods = False
+language = Ruby

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rest-client'
+gem 'codecov', require: false, group: :test

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Patiwan Organization and Ayanami Contributors
+
+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,81 @@
+[![codecov](https://codecov.io/gh/patiwan/Ayanami/branch/master/graph/badge.svg)]
+(https://codecov.io/gh/patiOne/Ayanami)
+[![CircleCI](https://circleci.com/gh/patiwan/Ayanami.svg?style=svg)]
+(https://circleci.com/gh/patiOne/Ayanami)
+[![Gitter](https://badges.gitter.im/patiwan/Ayanami.svg)]
+(https://gitter.im/patiwan/Ayanami?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
+
+# Ayanami
+
+> "If I die, I can be replaced" - Rei Ayanami
+
+A Telegram Bot API for Ruby that focuses on simplicity. Ayanami is meant to be a simple
+interface to Telegram's Bot API.
+
+The Goal of Ayanami is to keeping it simple and barebone, so other people can use it
+for their own purposes/needs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'Ayanami'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ayanami
+
+## Usage
+
+You can start by creating a Bot object.
+
+```ruby
+b = Ayanami::Bot.new('YOUR_BOT_TOKEN_GOES_HERE')
+```
+
+To confirm the connection, You can invoke the `get_me` function to see your bot identity.
+
+```ruby
+puts b.get_me
+```
+
+To get received messages or other updates, You can invoke the `get_updates` function to
+receive updates.
+
+```ruby
+puts b.get_updates()
+```
+
+You can also send a simple message to a group/user by invoking the `send_message` function.
+
+```ruby
+puts b.send_message(chat_id: USER_OR_CHAT_ID_GOES_HERE, text: 'Hello :)')
+```
+
+For more information about the included functions,
+Please consult [Telegram's Bot API documentation](https://core.telegram.org/bots/api)
+
+## 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`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/patiOne/Ayanami.
+
+
+## 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/ayanami.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ayanami/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ayanami'
+  spec.version       = Ayanami::VERSION
+  spec.authors       = ['Kaisar Arkhan']
+  spec.email         = ['ykno@protonmail.com']
+
+  spec.summary       = 'A Telegram Bot API that focuses on simplicity'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/patiwan/Ayanami'
+  spec.license       = 'MIT'
+
+  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']
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ayanami"
+
+# 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/circle.yml

@@ -0,0 +1,15 @@
+machine:
+  services:
+    - docker
+
+dependencies:
+  post:
+    - docker pull coala/base
+
+test:
+  post:
+    - docker run --volume=$(pwd):/app --workdir=/app coala/base coala-ci
+
+notify:
+  webhooks:
+    - url: https://webhooks.gitter.im/e/808949c372657ad460a6

data/lib/ayanami.rb

@@ -0,0 +1,7 @@
+require 'ayanami/version'
+require 'ayanami/bot'
+require 'ayanami/generators'
+
+# Ayanami is a Telegram Bot API that focuses on simplicity
+module Ayanami
+end

data/lib/ayanami/bot.rb

@@ -0,0 +1,198 @@
+require 'rest_client'
+require 'json'
+require 'ayanami/hacks'
+
+module Ayanami
+  # Bot is an interface for a Telegram Bot
+  # rubocop:disable Metrics/ClassLength
+  class Bot
+    def initialize(token)
+      @token = token
+    end
+
+    def verify_arguments(**args)
+      args.each do |k, v|
+        raise ArgumentError, "#{k} can't be nil. nil values aren't allowed"\
+          if v.nil?
+      end
+    end
+
+    def request(method, **args)
+      verify_arguments(args)
+      res = RestClient.post("https://api.telegram.org/bot#{@token}/#{method}",
+                            args)
+      return JSON.parse(res)
+    rescue RestClient::ExceptionWithResponse => err
+      err.response
+    end
+
+    # Returns basic information about the bot
+    # rubocop:disable Style/AccessorMethodName
+    def get_me
+      request('getMe')
+    end
+
+    # Receives incoming updates.
+    def get_updates(**args)
+      request('getUpdates', args)
+    end
+
+    # Sends a Message. On success, the sent Message is returned.
+    def send_message(chat_id: nil, text: nil, **args)
+      request('sendMessage', __grab_parameters(__method__, binding))
+    end
+
+    # Forwards a message. On success, the sent Message is returned.
+    def forward_message(chat_id: nil, from_chat_id: nil, message_id: nil,
+                        **args)
+      request('forwardMessage', __grab_parameters(__method__, binding))
+    end
+
+    # Sends photos. On success, the sent Message is returned.
+    def send_photo(chat_id: nil, photo: nil, **args)
+      request('sendPhoto', __grab_parameters(__method__, binding))
+    end
+
+    # Sends audio. On success, the sent Message is returned.
+    def send_audio(chat_id: nil, audio: nil, **args)
+      request('sendAudio', __grab_parameters(__method__, binding))
+    end
+
+    # Sends documents. On success, the sent Message is returned.
+    # Bots can currently send files of any type of up to 50 MB in size.
+    def send_document(chat_id: nil, document: nil, **args)
+      request('sendDocument', __grab_parameters(__method__, binding))
+    end
+
+    # Sends stickers. On success, the sent Message is returned.
+    def send_sticker(chat_id: nil, sticker: nil, **args)
+      request('sendSticker', __grab_parameters(__method__, binding))
+    end
+
+    # Sends videos. Telegram clients support mp4 videos (other formats may be
+    # sent as Document). On success, the sent Message is returned.
+    # Bots can currently send video files of up to 50 MB in size.
+    def send_video(chat_id: nil, video: nil, **args)
+      request('sendVideo', __grab_parameters(__method__, binding))
+    end
+
+    # Sends voice messages. The audio format must be in an .ogg file encoded
+    # with OPUS (other formats may be sent as Audio or Document).
+    # On success, the sent Message is returned.
+    # Bots can currently send voice messages of up to 50 MB in size.
+    def send_voice(chat_id: nil, voice: nil, **args)
+      request('sendVoice', __grab_parameters(__method__, binding))
+    end
+
+    # Sends point on the map. On success, the sent Message is returned.
+    def send_location(chat_id: nil, latitude: nil, longitude: nil, **args)
+      request('sendLocation', __grab_parameters(__method__, binding))
+    end
+
+    # Sends information about a venue. On success, the sent Message is returned.
+    # rubocop:disable Metrics/ParameterLists
+    def send_venue(chat_id: nil, latitude: nil, longitude: nil, title: nil,
+                   address: nil, **args)
+      request('sendVenue', __grab_parameters(__method__, binding))
+    end
+
+    # Sends phone contacts. On success, the sent Message is returned.
+    def send_contact(chat_id: nil, phone_number: nil, first_name: nil,
+                     last_name: nil, **args)
+      request('sendContact', __grab_parameters(__method__, binding))
+    end
+
+    # Sends a status that tells something is happening. The status is set for
+    # 5 seconds or less. Returns True on success.
+    def send_chat_action(chat_id: nil, action: nil)
+      request('sendChatAction', __grab_parameters(__method__, binding))
+    end
+
+    # Returns a list of profile pictures for a user.
+    def get_user_profile_photos(user_id: nil, **args)
+      request('getUserProfilePhotos', __grab_parameters(__method__, binding))
+    end
+
+    # Returns a basic info about a file and prepare it for downloading.
+    # Bots can download files up to 20 MB in size.
+    def get_file(file_id: nil)
+      request('getFile', __grab_parameters(__method__, binding))
+    end
+
+    # Kicks a chat member from a group/supergroup.
+    def kick_chat_member(chat_id: nil, user_id: nil)
+      request('kickChatMember', __grab_parameters(__method__, binding))
+    end
+
+    # Leaves the group, supergroup, or channel.
+    def leave_chat(chat_id: nil)
+      request('leaveChat', __grab_parameters(__method__, binding))
+    end
+
+    # Unbans previously kicked user in a supergroup.
+    def unban_chat_member(chat_id: nil, user_id: nil)
+      request('unbanChatMember', __grab_parameters(__method__, binding))
+    end
+
+    # Returns information about the chat.
+    def get_chat(chat_id: nil)
+      request('getChat', __grab_parameters(__method__, binding))
+    end
+
+    # Returns a list of administratos in a chat.
+    def get_chat_administrators(chat_id: nil)
+      request('getChatAdministrators', __grab_parameters(__method__, binding))
+    end
+
+    # Returns the number of members in a chat.
+    def get_chat_members_count(chat_id: nil)
+      request('getChatMembersCount', __grab_parameters(__method__, binding))
+    end
+
+    # Returns an information about a member of a chat.
+    def get_chat_member(chat_id: nil, user_id: nil)
+      request('getChatMember', __grab_parameters(__method__, binding))
+    end
+
+    # Sends answers to callback queries sent from inline keyboards.
+    def answer_callback_query(callback_query_id: nil, **args)
+      request('answerCallbackQuery', __grab_parameters(__method__, binding))
+    end
+
+    # Changes text and game messages sent by the bot or via the bot (for
+    # inline bots).
+    def edit_message_text(text: nil, **args)
+      request('editMessageText', __grab_parameters(__method__, binding))
+    end
+
+    # Changes captions of messages sent by the bot or via the bot (for
+    # inline bots).
+    def edit_message_caption(**args)
+      request('editMessageCaption', args)
+    end
+
+    # Changes the markup of messages sent by the bot or via the bot (for
+    # inline bots).
+    def edit_message_reply_markup(**args)
+      request('editMessageReplyMarkup', args)
+    end
+
+    # Answers to an inline query. On success, True is returned.
+    def answer_inline_query(inline_query_id: nil, results: nil, **args)
+      request('answerInlineQuery', __grab_parameters(__method__, binding))
+    end
+
+    # Sends a game. On success, the sent Message is returned.
+    def send_game(chat_id: nil, game_short_name: nil, **args)
+      request('sendGame', __grab_parameters(__method__, binding))
+    end
+
+    # Sets the score of the specified user in a game.
+    # On success, if the message was sent by the bot, returns the edited
+    # Message, otherwise returns True. Returns an error, if the new score is
+    # not greater than the user's current score in the chat.
+    def set_game_score(used_id: nil, score: nil, **args)
+      request('setGameScore', __grab_parameters(__method__, binding))
+    end
+  end
+end

data/lib/ayanami/generators.rb

@@ -0,0 +1,48 @@
+require 'ayanami/hacks'
+
+module Ayanami
+  # Generator contains Telegram objects that are used as arguments
+  module Generator
+    def self.inline_keyboard_markup(inline_keyboard: [])
+      __grab_parameters(__method__, binding)
+    end
+
+    def self.reply_keyboard_markup(keyboard: [[]], **args)
+      __grab_parameters(__method__, binding)
+    end
+
+    def self.reply_keyboard_hide(hide_keyboard: true, **args)
+      __grab_parameters(__method__, binding)
+    end
+
+    def self.force_reply(force_reply: true, **args)
+      __grab_parameters(__method__, binding)
+    end
+
+    def self.input_text_message_content(message_text: nil, **args)
+      __grab_parameters(__method__, binding)
+    end
+
+    def self.input_location_message_content(latitude: nil, longitude: nil)
+      __grab_parameters(__method__, binding)
+    end
+
+    def self.input_venue_message_content(latitude: nil, longitude: nil,
+                                         title: nil, address: nil, **args)
+      __grab_parameters(__method__, binding)
+    end
+
+    def self.input_contact_message_content(phone_number: nil, first_name: nil,
+                                           **args)
+      __grab_parameters(__method__, binding)
+    end
+
+    def self.inline_keyboard_button(text: nil, **args)
+      __grab_parameters(__method__, binding)
+    end
+
+    def self.keyboard_button(text: nil, **args)
+      __grab_parameters(__method__, binding)
+    end
+  end
+end

data/lib/ayanami/hacks.rb

@@ -0,0 +1,18 @@
+# This file contains the 'hacks' which are written to prevent
+# repeating the same code all over the place.
+
+def __grab_parameters(method, bind)
+  hash = {}
+
+  method(method).parameters.each do |_, n|
+    v = bind.local_variable_get(n)
+
+    if v.is_a? Hash
+      hash.merge! v
+    else
+      hash.merge! [[n, v]].to_h
+    end
+  end
+
+  hash
+end

data/lib/ayanami/version.rb

@@ -0,0 +1,3 @@
+module Ayanami
+  VERSION = '0.1.1'.freeze
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: ayanami
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Kaisar Arkhan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: A Telegram Bot API that focuses on simplicity
+email:
+- ykno@protonmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coafile"
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ayanami.gemspec
+- bin/console
+- bin/setup
+- circle.yml
+- lib/ayanami.rb
+- lib/ayanami/bot.rb
+- lib/ayanami/generators.rb
+- lib/ayanami/hacks.rb
+- lib/ayanami/version.rb
+homepage: https://github.com/patiwan/Ayanami
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A Telegram Bot API that focuses on simplicity
+test_files: []