telegram_bot_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bbfe722f4229bb6884ad39ea06885094f6cdbbfa
+  data.tar.gz: 7b97cba693680760ab2531b861d8174e47906f59
+SHA512:
+  metadata.gz: cc5bd16901d7e50885d700d1262184d733bdd444d455035b7f265e11bbe50bc27744914a96e48bf58c6171a36ab960e6fbda40f81ae71518c08f20a042efa138
+  data.tar.gz: 5cc7cbd0d7e905f28d322fe3eb820f13641edf6dac8f6c1bcb7d1cf9e49d8527ab72da3c1c35d16241359fe68c4039ba8cdfbc3b435933884e6fea3134955098

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format=doc

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.4

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Bernat Rafales
+
+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,74 @@
+# TelegramBotApi [![Build Status](https://travis-ci.org/brafales/telegram_bot_api.svg?branch=master)](http://travis-ci.org/brafales/telegram_bot_api)
+
+Telegram Bot Api written in Ruby. Still in early stages, supports for now only a couple of methods.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'telegram_bot_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install telegram_bot_api
+
+## Usage
+
+Configure the gem using this snippet:
+
+```ruby
+TelegramBotApi.configure do |config|
+  config.auth_token = YOUR_BOT_AUTH_TOKEN
+end
+```
+
+Once the auth token has been setup, you can create request objects,
+configure them to your liking and execute them using the `Client` class.
+
+Here's how to create a `SendMessage` request:
+
+```ruby
+request = TelegramBotApi::Requests::SendMessage.new(
+  {
+    chat_id: 1234,
+    text: "This is a test message"
+  }
+)
+
+TelegramBotApi::Client.execute(request)
+```
+
+The gem also provides some simple validation of requests, so you can make sure all the mandatory parameters have been sent:
+
+```ruby
+request = TelegramBotApi::Requests::SendMessage.new(
+  {
+    text: "This is a test message"
+  }
+)
+
+request.valid? #false
+request.errors #[:chat_id]
+```
+
+## 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/brafales/telegram_bot_api.
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "telegram_bot_api"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/telegram_bot_api/client.rb

@@ -0,0 +1,24 @@
+module TelegramBotApi
+  class Client
+    TELEGRAM_API_ENDPOINT = "https://api.telegram.org"
+
+    def self.execute(request)
+      unless request.valid?
+        raise(ArgumentError, request.errors)
+      end
+      HttpClient.make_request(verb: request.verb, url: request_url(request), params: request.to_json)
+    end
+
+    private
+
+    def self.request_url(request)
+      "#{TELEGRAM_API_ENDPOINT}/#{bot_path}/#{request.endpoint_url}"
+
+    end
+
+    def self.bot_path
+      auth_token = TelegramBotApi.configuration.auth_token
+      "bot#{auth_token}"
+    end
+  end
+end

data/lib/telegram_bot_api/configuration.rb

@@ -0,0 +1,5 @@
+module TelegramBotApi
+  class Configuration
+      attr_accessor :auth_token
+  end
+end

data/lib/telegram_bot_api/http_client.rb

@@ -0,0 +1,31 @@
+require 'typhoeus'
+
+module TelegramBotApi
+  class HttpClient
+
+    def self.make_request(verb:, url:, params:)
+      method = case verb
+      when :get
+        :get
+      when :post
+        :post
+      end
+
+      unless method
+        raise(ArgumentError, "Invalid verb")
+      end
+
+      self.send(method, url: url, params: params)
+    end
+
+    private
+
+    def self.get(url:, params: {})
+      Typhoeus.get(url,  headers: {'Content-Type'=> "application/json"}, params: params)
+    end
+
+    def self.post(url:, params: {})
+      Typhoeus.post(url,  headers: {'Content-Type'=> "application/json"}, params: params)
+    end
+  end
+end

data/lib/telegram_bot_api/message.rb

@@ -0,0 +1,11 @@
+module TelegramBotApi
+  class Message
+
+    attr_reader :text, :chat
+
+    def initialize(payload)
+      @text = payload["text"]
+      @chat = payload["chat"]
+    end
+  end
+end

data/lib/telegram_bot_api/requests/base.rb

@@ -0,0 +1,55 @@
+module TelegramBotApi
+  module Requests
+    module Base
+
+      def self.included(base)
+        base.include InstanceMethods
+        base.extend  ClassMethods
+        base.class_eval { attr_accessor *self.all_arguments }
+      end
+
+      module InstanceMethods
+
+        def to_json
+          self.class.all_arguments.inject({}) do |memo, argument|
+            memo.merge!({ argument => self.public_send(argument) })
+          end
+        end
+
+        def valid?
+          errors.empty?
+        end
+
+        def errors
+          self.class.mandatory_arguments.select do |argument|
+            self.public_send(argument).nil?
+          end
+        end
+
+        #For convenience
+
+        def endpoint_url
+          self.class.endpoint_url
+        end
+
+        def verb
+          self.class.verb
+        end
+
+        private
+
+        def build_arguments(arguments)
+          self.class.all_arguments.each do |argument|
+            instance_variable_set("@#{argument}", arguments[argument])
+          end
+        end
+      end
+
+      module ClassMethods
+        def all_arguments
+          mandatory_arguments + optional_arguments
+        end
+      end
+    end
+  end
+end

data/lib/telegram_bot_api/requests/send_message.rb

@@ -0,0 +1,30 @@
+module TelegramBotApi
+  module Requests
+    class SendMessage
+
+      def initialize(arguments = {})
+        build_arguments(arguments)
+      end
+
+      class << self
+        def mandatory_arguments
+          %i(chat_id text)
+        end
+
+        def optional_arguments
+          %i(disable_web_page_preview reply_to_message_id reply_markup)
+        end
+
+        def endpoint_url
+          'sendMessage'
+        end
+
+        def verb
+          :post
+        end
+      end
+
+      include Base
+    end
+  end
+end

data/lib/telegram_bot_api/requests/set_webhook.rb

@@ -0,0 +1,30 @@
+module TelegramBotApi
+  module Requests
+    class SetWebhook
+
+      def initialize(arguments = {})
+        build_arguments(arguments)
+      end
+
+      class << self
+        def mandatory_arguments
+          []
+        end
+
+        def optional_arguments
+          %i(url)
+        end
+
+        def endpoint_url
+          'setWebhook'
+        end
+
+        def verb
+          :get
+        end
+      end
+
+      include Base
+    end
+  end
+end

data/lib/telegram_bot_api/requests.rb

@@ -0,0 +1,3 @@
+require_relative "requests/base"
+require_relative "requests/set_webhook"
+require_relative "requests/send_message"

data/lib/telegram_bot_api/version.rb

@@ -0,0 +1,3 @@
+module TelegramBotApi
+  VERSION = "0.1.0"
+end

data/lib/telegram_bot_api.rb

@@ -0,0 +1,19 @@
+require_relative "telegram_bot_api/version"
+require_relative "telegram_bot_api/configuration"
+require_relative "telegram_bot_api/http_client"
+require_relative "telegram_bot_api/client"
+require_relative "telegram_bot_api/message"
+require_relative "telegram_bot_api/requests"
+
+module TelegramBotApi
+
+  @configuration = Configuration.new
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/telegram_bot_api.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'telegram_bot_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "telegram_bot_api"
+  spec.version       = TelegramBotApi::VERSION
+  spec.authors       = ["Bernat Rafales"]
+  spec.email         = ["brafales@gmail.com"]
+
+  spec.summary       = %q{Ruby client for the Telegram Bot API}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/brafales/telegram_bot_api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3"
+
+  spec.add_dependency "typhoeus", "~> 0"
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: telegram_bot_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bernat Rafales
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  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'
+description: Ruby client for the Telegram Bot API
+email:
+- brafales@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/telegram_bot_api.rb
+- lib/telegram_bot_api/client.rb
+- lib/telegram_bot_api/configuration.rb
+- lib/telegram_bot_api/http_client.rb
+- lib/telegram_bot_api/message.rb
+- lib/telegram_bot_api/requests.rb
+- lib/telegram_bot_api/requests/base.rb
+- lib/telegram_bot_api/requests/send_message.rb
+- lib/telegram_bot_api/requests/set_webhook.rb
+- lib/telegram_bot_api/version.rb
+- telegram_bot_api.gemspec
+homepage: https://github.com/brafales/telegram_bot_api
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Ruby client for the Telegram Bot API
+test_files: []