telegram-bot-ruby 0.2.6 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b0f238cefd205500522307dccb130ef0993bfd8a
-  data.tar.gz: 115bc4c3bb59e94f67842810ab95ed1f7d21aae5
+  metadata.gz: ef037a3e5735ef90b436b1ef4929273ae596cf14
+  data.tar.gz: 5f1c00b66ae94a56bcf6b55de44030ea5abf34e9
 SHA512:
-  metadata.gz: 7419c4a6c6ca6fec3c8132f7734307ccf10640ffb2d6e58b3e019ad11577b29485c5a02a3b9cf6ed603daae39fd0fbccb573e7fcf5ec70c53800639041c11032
-  data.tar.gz: 66fdc42963a0e8847b187eaaab4307383cf9b378ae470d2bb59dc8c403b1adbda21a4c7229e668212b8cd9d890d2a07d27265514429808a8bb3a6b8f4e9ffd25
+  metadata.gz: 4f6242809b6c31ab7ff030ebb2d76a10165416d996a523a409f737511d33c42de0c597d9a57725b20816dd31f973ba3a5f85c02971c668814ec4ce085fa064c7
+  data.tar.gz: cb4aa63e3eb65406959405f914dc09912449273adc9fd6131d06340e705e3d01d548f88247a8346efe3c94812dc745f281793aac165c28d73932e0ddcba9b2c6

data/README.md

@@ -85,6 +85,46 @@ bot.listen do |message|
 end
 ```
 
+## Logging
+
+By default, bot doesn't log anything (uses `NullLoger`). You can change this behavior and provide your own logger class. See example below:
+
+```ruby
+Telegram::Bot::Client.run(token, logger: Logger.new($stdout)) do |bot|
+  bot.logger.info('Bot has been started')
+  bot.listen do |message|
+    # ...
+  end
+end
+```
+
+## Botan.io support
+
+Gem provides support of [Botan.io](http://botan.io/) analytics out of box. All you need is to obtain a token (follow the instructions from http://botan.io/). To track events you're interested in just call `#track` method. See example below:
+
+```ruby
+require 'telegram/bot'
+require 'telegram/bot/botan' # Botan.io extension isn't loaded by default, so make sure you required it.
+
+token = 'YOUR_TELEGRAM_BOT_API_TOKEN'
+
+Telegram::Bot::Client.run(token) do |bot|
+  bot.enable_botan!('YOUR_BOTAN_TOKEN')
+  bot.listen do |message|
+    case message.text
+    when '/start'
+      bot.track('Started', message.from.id, type_of_chat: message.chat.class.name)
+      # ...
+    end
+  end
+end
+```
+
+`#track` method accepts 3 arguments:
+- name of event (required)
+- Telegram's user id (required)
+- hash of additional properties (optional)
+
 ## Contributing
 
 1. Fork it

data/lib/telegram/bot.rb

@@ -5,5 +5,6 @@ require 'virtus'
 require 'telegram/bot/types'
 require 'telegram/bot/exceptions'
 require 'telegram/bot/api'
+require 'telegram/bot/null_logger'
 require 'telegram/bot/client'
 require 'telegram/bot/version'

data/lib/telegram/bot/botan.rb

@@ -0,0 +1,21 @@
+require 'telegram/bot/botan/api'
+
+module Telegram
+  module Bot
+    module Botan
+      attr_reader :botan
+
+      def enable_botan!(token)
+        @botan ||= Botan::Api.new(token)
+      end
+
+      def track(*args)
+        botan.track(*args) if defined?(botan)
+      end
+    end
+  end
+end
+
+if defined?(Telegram::Bot::Client)
+  Telegram::Bot::Client.send(:include, Telegram::Bot::Botan)
+end

data/lib/telegram/bot/botan/api.rb

@@ -0,0 +1,23 @@
+module Telegram
+  module Bot
+    module Botan
+      class Api
+        include HTTParty
+
+        attr_reader :token
+
+        base_uri 'https://api.botan.io'
+
+        def initialize(token)
+          @token = token
+        end
+
+        def track(event, uid, properties = {})
+          self.class.post('/track',
+                          query: { token: token, name: event, uid: uid },
+                          body: properties.to_json)
+        end
+      end
+    end
+  end
+end

data/lib/telegram/bot/client.rb

@@ -1,16 +1,18 @@
 module Telegram
   module Bot
     class Client
-      attr_reader :api, :offset, :timeout
+      attr_reader :api, :offset, :timeout, :logger
 
       def self.run(*args, &block)
         new(*args).run(&block)
       end
 
-      def initialize(token, timeout = 20)
+      def initialize(token, h = {})
+        options = default_options.merge(h)
         @api = Api.new(token)
-        @offset = 0
-        @timeout = timeout
+        @offset = options[:offset]
+        @timeout = options[:timeout]
+        @logger = options[:logger]
       end
 
       def run
@@ -25,12 +27,29 @@ module Telegram
           response['result'].each do |data|
             update = Types::Update.new(data)
             @offset = update.update_id.next
+            log_incoming_message(update.message)
             yield update.message
           end
         end
       rescue Net::ReadTimeout
         retry
       end
+
+      private
+
+      def default_options
+        { offset: 0, timeout: 20, logger: NullLogger.new }
+      end
+
+      def log_incoming_message(message)
+        logger.info(
+          format(
+            'Incoming message: text="%s" uid=%i',
+            message.text,
+            message.from.id
+          )
+        )
+      end
     end
   end
 end

data/lib/telegram/bot/null_logger.rb

@@ -0,0 +1,11 @@
+module Telegram
+  module Bot
+    class NullLogger < Logger
+      def initialize(*)
+      end
+
+      def add(*)
+      end
+    end
+  end
+end

data/lib/telegram/bot/version.rb

@@ -1,5 +1,5 @@
 module Telegram
   module Bot
-    VERSION = '0.2.6'
+    VERSION = '0.3.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telegram-bot-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.3.0
 platform: ruby
 authors:
 - Alexander Tipugin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-31 00:00:00.000000000 Z
+date: 2015-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httmultiparty
@@ -126,10 +126,13 @@ files:
 - examples/bot.rb
 - lib/telegram/bot.rb
 - lib/telegram/bot/api.rb
+- lib/telegram/bot/botan.rb
+- lib/telegram/bot/botan/api.rb
 - lib/telegram/bot/client.rb
 - lib/telegram/bot/exceptions.rb
 - lib/telegram/bot/exceptions/base.rb
 - lib/telegram/bot/exceptions/response_error.rb
+- lib/telegram/bot/null_logger.rb
 - lib/telegram/bot/types.rb
 - lib/telegram/bot/types/audio.rb
 - lib/telegram/bot/types/base.rb