telegrammer 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6f66035f6ea3cd2d7f626c10b8463a1b9664d18
-  data.tar.gz: e7c72d53b04afd5f9e7fc00f68ccbed4ae3ab41f
+  metadata.gz: 93c3f40e3cac5da380be28df9f3e8764fb391c48
+  data.tar.gz: 6e3d816aa9669bc7efe93d773025f68fa4886e85
 SHA512:
-  metadata.gz: 3e4ca47906a59aae2806c82dec52710c8703540488890770db7b8c548e821e83f41a3be04088562eec255a988d72bcf9803c4b14ea4c0369dbe26193571d46a6
-  data.tar.gz: 86cb5e06a25dbecd827fee880c471fbe32611d3c5344087a72053d41eb2e0fbb0e94be95f5a9a6fa91ecb51afeb11fd874ee0123205ad6be1e8dbc281298ba5f
+  metadata.gz: 9e6543b008d751c428095168dade2d35696030dc1c3255145bfc66fd3c7ad69de63c83b39bbc5634998429b0fa268bb5ffa536f984e2c9ff60fe098c0c3cedb9
+  data.tar.gz: 1905d67b7f5454d079ae4188711d9d98a818cd0689b3debb364c686bd68573f895f3ab2de4f159ef85c3dcb08df837eebb6a316a04e08b5c97950036f4c0aba3

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+v0.5.0
+======
+
+* Option to fail silently on get_updates method. Thanks to TheZ3ro!
+
 v0.4.1
 ======
 

data/lib/telegrammer.rb

@@ -56,5 +56,12 @@ module Telegrammer
         super("Telegram API Service unavailable (HTTP error code #{status_code})")
       end
     end
+
+    # Error returned when HTTPClient raise a timeout (?)
+    class TimeoutError < StandardError
+      def initialize(message)
+        super("Timeout reached. Message: #{message}")
+      end
+    end
   end
 end

data/lib/telegrammer/api_response.rb

@@ -4,7 +4,7 @@ module Telegrammer
     attr_reader :result
     attr_reader :success
 
-    def initialize(response)
+    def initialize(response,fail_silently = false)
       if response.status < 500
         @body = response.body
 
@@ -14,10 +14,14 @@ module Telegrammer
         if @success
           @result = data['result']
         else
-          fail Telegrammer::Errors::BadRequestError, data['error_code'], data['description']
+          if !fail_silently
+            fail Telegrammer::Errors::BadRequestError, data['error_code'], data['description']
+          end
         end
       else
-        fail Telegrammer::Errors::ServiceUnavailableError, response.status
+        if !fail_silently
+          fail Telegrammer::Errors::ServiceUnavailableError, response.status
+        end
       end
     end
 

data/lib/telegrammer/bot.rb

@@ -18,6 +18,7 @@ module Telegrammer
       @api_token = api_token
       @offset = 0
       @timeout = 60
+      @fail_silently = false
       @connection = HTTPClient.new
 
       @me = get_me
@@ -25,6 +26,11 @@ module Telegrammer
 
     # Get incoming updates using long polling
     #
+    # @param [Hash] opts Options when getting updates
+    # @option params [Integer] :fail_silently Optional. Ignore every Connection Error. Default: false
+    # @option params [Integer] :offset Optional. Sequential number of the first photo to be returned. By default, all photos are returned.
+    # @option params [Integer] :timeout Optional. Timeout in minutes. 0 for short polling, Default: 60.
+    #
     # @example
     #     bot = Telegrammer::Bot.new('[YOUR TELEGRAM TOKEN]')
     #
@@ -36,11 +42,23 @@ module Telegrammer
     #       # To learn more about commands, see https://core.telegram.org/bots#commands
     #     end
     #
+    #     bot.get_updates({fail_silently:true, timeout:20}) do |message|
+    #       puts "In chat #{message.chat.id}, @#{message.from.username} said: #{message.text}"
+    #       bot.send_message(chat_id: message.chat.id, text: "You said: #{message.text}")
+    #
+    #       # Here you can also process message text to detect user commands
+    #       # To learn more about commands, see https://core.telegram.org/bots#commands
+    #     end
+    #
     # @raise [Telegrammer::Errors::BadRequestError] if something goes wrong in the Telegram API servers with the params received by the operation
     # @raise [Telegrammer::Errors::ServiceUnavailableError] if Telegram servers are down
-    def get_updates(&_block)
+    # @raise [Telegrammer::Errors::TimeoutError] if HTTPClient connection goes timeout
+    def get_updates(opts={}, &_block)
       loop do
-        response = api_request('getUpdates', { offset: @offset, timeout: @timeout }, nil)
+      	if opts[:fail_silently]
+      		@fail_silently = true
+      	end
+        response = api_request('getUpdates', { offset: opts[:offset] || @offset, timeout: opts[:timeout] || @timeout }, nil)
 
         response.result.each do |raw_update|
           update = Telegrammer::DataTypes::Update.new(raw_update)
@@ -440,14 +458,20 @@ module Telegrammer
         end
       end
 
-      response = @connection.post(
-        "#{API_ENDPOINT}/#{api_uri}",
-        validated_params,
-        'User-Agent' => "Telegrammer/#{Telegrammer::VERSION}",
-        'Accept' => 'application/json'
-      )
-
-      ApiResponse.new(response)
+      begin
+      	response = @connection.post(
+          "#{API_ENDPOINT}/#{api_uri}",
+          validated_params,
+          'User-Agent' => "Telegrammer/#{Telegrammer::VERSION}",
+          'Accept' => 'application/json'
+        )
+
+        ApiResponse.new(response,@fail_silently)
+      rescue HTTPClient::ReceiveTimeoutError => e
+      	if !@fail_silently
+          fail Telegrammer::Errors::TimeoutError, e.to_s
+        end
+      end
     end
 
     def send_something(object_kind, params, extra_params_validation = {})

data/lib/telegrammer/version.rb

@@ -1,3 +1,3 @@
 module Telegrammer
-  VERSION = '0.4.1'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telegrammer
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Luis Mayoral
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-16 00:00:00.000000000 Z
+date: 2015-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient