telegram-bot-response_builder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d51260d0a87b1d48d757bdb1e4adea77778f20b6
+  data.tar.gz: abf595fb9371e6fa286ca78022e6c7c9a80923bc
+SHA512:
+  metadata.gz: 77544c0e09731350ba15b3a10d41134d6c7795371b3fed03d46211846e53e476363cfb01c7aa770dde25d079f0a588b2e7d337076cbf246863a9d17481014230
+  data.tar.gz: 9a855791ad8e58e8be7b6f8bfd266a49dca7208d99e0d0d2d65ffa5cd175dbfacf5b2bac3a4d788df1335409512d5e620a26301c2c288233a51613871eb98f73

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# Ruby environment
+.ruby-version
+.ruby-gemset

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop

@@ -0,0 +1 @@
+--display-cop-names

data/.rubocop.yml

@@ -0,0 +1,18 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
+# Style
+
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*.rb'
+
+# Metrics
+
+Metrics/BlockLength:
+  Exclude:
+    - 'telegram-bot-response_builder.gemspec'
+    - 'spec/**/*'
+
+Metrics/LineLength:
+  Max: 100

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.15.4

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 smaximov
+
+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,67 @@
+# Telegram::Bot::ResponseBuilder
+
+This gem extends [telegram-bot-ruby](https://github.com/atipugin/telegram-bot-ruby) by
+enabling responding to Telegram webhook requests directly in the response body. It
+introduces a `Telegram::Bot::Api` subclass which builds response hash from
+parameters and the method name instead of performing an HTTP request.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'telegram-bot-response_builder'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install telegram-bot-response_builder
+
+## Usage
+
+Create new instance of `Telegram::Bot::ResponseBuilder` and invoke any API method
+on it:
+
+``` ruby
+# ...
+response_builder = Telegram::Bot::ResponseBuilder.new
+response_builder.deleteMessage(chat_id: chat_id, message_id: message_id)
+# {:method=>"deleteMessage", :chat_id=>chat_id, :message_id=>message_id}
+```
+
+Example — webhook-based "echo" bot, built on top of Sinatra:
+
+``` ruby
+require 'sinatra'
+require 'sinatra/json'
+
+class TelegramWebhookBot < Sinatra::Base
+  use Rack::PostBodyContentTypeParser
+  register Sinatra::JSON
+
+  post '/webhooks/tg' do
+    message = Telegram::Bot::Types::Update.new(params).message
+    response_builder = Telegram::Bot::ResponseBuilder.new
+    json response_builder.send_message(chat_id: message.chat.id, text: message.text)
+    # response: {"chat_id":9001,"text":"Hello, World!","method":"sendMessage"}
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/smaximov/telegram-bot-response_builder.
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'telegram/bot/response_builder'
+require 'pry'
+
+Pry.start(__FILE__)

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/lib/telegram/bot/response_builder.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'telegram/bot'
+
+module Telegram
+  module Bot
+    # {Telegram::Bot::Api} subclass that builds response hashes
+    # instead of making Telegram API requests.
+    #
+    # @example
+    #   response_builder = Telegram::Bot::ResponseBuilder.new
+    #   response_builder.send_message(chat_id: 42, text: 'Look, Ma! No requests!')
+    #   # {:chat_id=>42, :text=>"Look, Ma! No requests!", :method=>"sendMessage"}
+    class ResponseBuilder < Api
+      VERSION = '0.1.0'
+
+      def initialize; end
+
+      def call(endpoint, raw_params = {})
+        build_params(raw_params.merge(method: endpoint))
+      end
+    end
+  end
+end

data/telegram-bot-response_builder.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'telegram/bot/response_builder'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'telegram-bot-response_builder'
+  spec.version       = Telegram::Bot::ResponseBuilder::VERSION
+  spec.authors       = ['Sergei Maximov']
+  spec.email         = ['s.b.maximov@gmail.com']
+
+  spec.summary       = 'Response builder for the telegram-bot-ruby gem'
+  spec.description   = <<-DESCRIPTION
+    An extention to the telegram-bot-ruby gem that enables responding to Telegram
+    webhook requests directly in the response body.
+  DESCRIPTION
+  spec.homepage      = 'https://github.com/smaximov/telegram-bot-response_builder'
+  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.required_ruby_version = '>= 2.3.0'
+
+  spec.add_dependency 'telegram-bot-ruby'
+
+  spec.metadata['yard.run'] = 'yri'
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'pry', '~> 0.11.3'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.51.0'
+  spec.add_development_dependency 'yard', '~> 0.9.12'
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: telegram-bot-response_builder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sergei Maximov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: telegram-bot-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.51.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.51.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+description: |2
+      An extention to the telegram-bot-ruby gem that enables responding to Telegram
+      webhook requests directly in the response body.
+email:
+- s.b.maximov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/telegram/bot/response_builder.rb
+- telegram-bot-response_builder.gemspec
+homepage: https://github.com/smaximov/telegram-bot-response_builder
+licenses:
+- MIT
+metadata:
+  yard.run: yri
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Response builder for the telegram-bot-ruby gem
+test_files: []