telegram_bot 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9a92c64ad73728e0f777bf7d403e6bb62f13d698
-  data.tar.gz: 96e0b8b4ca3d224c6c263ea9ad1b056e9c01c683
+  metadata.gz: b0e96a036eb8842252f8905e9686702b902578c7
+  data.tar.gz: a20ea036287e3f2b25a14dcf7ef9950230b6f765
 SHA512:
-  metadata.gz: 317077a37c2a9fbb4fe2fb7e8cddb0dcf4005563e4648b882b0f6e06f04756794b5fe480f0bed7540b4d2f665d26d8e6bdf17d402d3defa519c0b1ecd9656597
-  data.tar.gz: 24581019d494cfc0ac94754b77b6efc2d0bd910e749f16b0aacba6c09fedbaad8595aa17b7d897612599d4b86d33459f8d053eeebc8a9aec200893d7879a0306
+  metadata.gz: f61ea704d8c9586a4792f3f579c8da67e65366ed1462bde4c8b24909cf31ac2f4d5ae1042c84877caa79ddcc2d529503a4afcd2e714ea212012d517c49c4be67
+  data.tar.gz: d9df7f17c4a725fb8b7f7bf7cc4f7c3e8c23cacc1c6756026107d31b6eb8a2e415a24c4474954b1e2a300b028f3991619215c615d48a6af69512f4911faac5f4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, 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, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other 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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/README.md

@@ -1,11 +1,11 @@
 # TelegramBot
 
-A charismatic client for [Telegram's Bot API](https://core.telegram.org/bots).
+A charismatic ruby client for [Telegram's Bot API](https://core.telegram.org/bots).
 
-Write your own Telegram Bot!
+Write your own Telegram Bot using Ruby! Yay!
 
 Currently under heavy development.
-Contributions are always welcome.
+Please [collaborate](https://github.com/eljojo/telegram_bot/issues/new) with your questions, ideas or problems!
 
 ## Installation
 
@@ -19,40 +19,55 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
-
-    $ gem install telegram_bot
-
 ## Usage
 
 Here's an example:
 
 ```ruby
 require 'telegram_bot'
-require 'pp'
 
 bot = TelegramBot.new('[YOUR TELEGRAM BOT TOKEN GOES HERE]')
 bot.get_updates do |message|
-  pp(message)
+  puts "@#{message.from.username}: #{message.text}"
   command = message.get_command_for(bot)
 
   message.reply do |reply|
-    reply.text = "i think that #{command.inspect} is false"
-    pp(reply)
+    case command
+    when /greet/i
+      reply.text = "Hello, #{message.from.first_name}!"
+    else
+      reply.text = "#{message.from.first_name}, have no idea what #{command.inspect} means."
+    end
+    puts "sending #{reply.text.inspect} to @#{message.from.username}"
     reply.send_with(bot)
   end
 end
 ```
 
+Here's a sample output:
+
+```
+$ bundle exec ruby bot.rb
+@eljojo: greet
+sending "Hello, José!" to @eljojo
+@eljojo: heeeeeeeeya!
+sending "José, have no idea what \"heeeeeeeeya!\" means." to @eljojo
+```
+
+![Example](http://i.imgur.com/VF8X4CQ.png)
+
 ## How do I get a Bot Token
 
 Talk to the [@BotFather](https://telegram.me/botfather).
 You can find more info [here](https://core.telegram.org/bots).
 
+![How to get Token](http://i.imgur.com/90ya4Oe.png)
+
 ## Contributing
 
-1. Fork it ( https://github.com/eljojo/telegram_bot/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+Bug reports and pull requests are welcome on GitHub at https://github.com/eljojo/telegram_bot. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/example/Gemfile

@@ -0,0 +1,4 @@
+# A sample Gemfile
+source "https://rubygems.org"
+
+gem "telegram_bot", github: 'eljojo/telegram_bot'

data/example/README.md

@@ -0,0 +1,17 @@
+TelegramBot example
+==================
+
+To run this example type the following in a shell:
+
+```
+git clone https://github.com/eljojo/telegram_bot.git
+cd telegram_bot/example
+bundle install
+```
+
+Then, you can start the bot with:
+```
+bundle exec ruby bot.rb
+```
+
+You can close it with ``CTRL+C``

data/example/bot.rb

@@ -0,0 +1,24 @@
+require 'telegram_bot'
+require 'pp'
+require 'logger'
+
+logger = Logger.new(STDOUT, Logger::DEBUG)
+
+bot = TelegramBot.new('YOUR KEY GOES HERE')
+logger.debug "starting telegram bot"
+
+bot.get_updates do |message|
+  logger.info "@#{message.from.username}: #{message.text}"
+  command = message.get_command_for(bot)
+
+  message.reply do |reply|
+    case command
+    when /greet/i
+      reply.text = "Hello, #{message.from.first_name}!"
+    else
+      reply.text = "#{message.from.first_name}, have no idea what #{command.inspect} means."
+    end
+    logger.info "sending #{reply.text.inspect} to @#{message.from.username}"
+    reply.send_with(bot)
+  end
+end

data/lib/telegram_bot/bot.rb

@@ -2,45 +2,70 @@ module TelegramBot
   class Bot
     ENDPOINT = 'https://api.telegram.org/'
 
-    attr_reader :me
-    alias_method :identity, :me
+    def initialize(opts = {})
+      # compatibility with just passing a token
+      if opts.is_a?(String)
+        opts = { token: opts }
+      end
 
-    def initialize(token)
-      @token = token
-      @timeout = 50
-      @offset = 0
+      @token = opts.fetch(:token)
+      @timeout = opts[:timeout] || 50
+      @offset = opts[:offset] || 0
+      @logger = opts[:logger] || NullLoger.new
       @connection = Excon.new(ENDPOINT, persistent: true)
-      @me = get_me
     end
 
     def get_me
-      response = request(:getMe)
-      User.new(response.result)
+      @me ||= begin
+                response = request(:getMe)
+                User.new(response.result)
+              end
     end
+    alias_method :me, :get_me
+    alias_method :identity, :me
 
-    def get_updates(&block)
+    def get_updates(opts = {}, &block)
+      return get_last_messages(opts) unless block_given?
+
+      logger.info "starting get_updates loop"
       loop do
-        response = request(:getUpdates, offset: @offset, timeout: @timeout)
-        response.result.each do |raw_update|
-          update = Update.new(raw_update)
-          @offset = update.id + 1
-          yield update.message
+        messages = get_last_messages(opts)
+        messages.each do |message|
+          logger.info "message from @#{message.chat.friendly_name}: #{message.text.inspect}"
+          yield message
         end
       end
     end
 
     def send_message(out_message)
       response = request(:sendMessage, out_message.to_h)
+      logger.info "sending message: #{out_message.text.inspect} to #{out_message.chat_friendly_name}"
       Message.new(response.result)
     end
 
-
     private
     attr_reader :token
+    attr_reader :logger
+
     def request(action, query = {})
       path = "/bot#{@token}/#{action}"
       res = @connection.post(path: path, query: query)
       ApiResponse.new(res)
     end
+
+    def get_last_updates(opts = {})
+      response = request(:getUpdates, offset: opts[:offset] || @offset, timeout: opts[:timeout] || @timeout)
+      if opts[:fail_silently]
+        logger.warn "error when getting updates. ignoring due to fail_silently."
+        return [] if !response.ok? || !response.result
+      end
+      updates = response.result.map{|raw_update| Update.new(raw_update) }
+      @offset = updates.last.id + 1 if updates.any?
+      updates
+    end
+
+    def get_last_messages(opts = {})
+      get_last_updates(opts).map(&:message)
+    end
   end
 end

data/lib/telegram_bot/channel.rb

@@ -2,5 +2,11 @@ module TelegramBot
   class Channel
     include Virtus.model
     attribute :id, Integer
+    attribute :username, String
+    attribute :title, String
+
+    def friendly_name
+      username ? "@#{username}" : "channel #{title.inspect}"
+    end
   end
 end

data/lib/telegram_bot/message.rb

@@ -5,13 +5,14 @@ module TelegramBot
     alias_method :id, :message_id
     alias_method :to_i, :id
     attribute :from, User
+    alias_method :user, :from
     attribute :text, String
     attribute :date, DateTime
     attribute :chat, Channel
     attribute :reply_to_message, Message
 
     def reply(&block)
-      reply = OutMessage.new(chat_id: chat.id)
+      reply = OutMessage.new(chat: chat)
       yield reply if block_given?
       reply
     end

data/lib/telegram_bot/null_logger.rb

@@ -0,0 +1,11 @@
+require 'logger'
+
+module TelegramBot
+  class NullLoger < Logger
+    def initialize(*args)
+    end
+
+    def add(*args, &block)
+    end
+  end
+end

data/lib/telegram_bot/out_message.rb

@@ -1,11 +1,22 @@
 module TelegramBot
   class OutMessage
     include Virtus.model
-    attribute :chat_id, Integer
+    attribute :chat, Channel
     attribute :text, String
 
     def send_with(bot)
       bot.send_message(self)
     end
+
+    def chat_friendly_name
+      chat.friendly_name
+    end
+
+    def to_h
+      {
+        text: text,
+        chat_id: chat.id
+      }
+    end
   end
 end

data/lib/telegram_bot/version.rb

@@ -1,3 +1,3 @@
 module TelegramBot
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telegram_bot
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - José Tomás Albornoz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-24 00:00:00.000000000 Z
+date: 2015-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -74,16 +74,21 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- example/Gemfile
+- example/README.md
+- example/bot.rb
 - lib/telegram_bot.rb
 - lib/telegram_bot/api_response.rb
 - lib/telegram_bot/bot.rb
 - lib/telegram_bot/channel.rb
 - lib/telegram_bot/group_chat.rb
 - lib/telegram_bot/message.rb
+- lib/telegram_bot/null_logger.rb
 - lib/telegram_bot/out_message.rb
 - lib/telegram_bot/update.rb
 - lib/telegram_bot/user.rb