Class: Telegram::Bot::Client

Inherits:
Object
  • Object
show all
Includes:
Async, ApiHelper, DebugClient
Defined in:
lib/telegram/bot/client.rb,
lib/telegram/bot/client/api_helper.rb,
lib/telegram/bot/client/typed_response.rb,
lib/telegram/bot/client/request_body_formatter.rb

Direct Known Subclasses

ClientStub

Defined Under Namespace

Modules: ApiHelper, RequestBodyFormatter, TypedResponse

Constant Summary collapse

SERVER = 
'https://api.telegram.org'
URL_TEMPLATE = 
'%<server>s/bot%<token>s/'

Constants included from ApiHelper

ApiHelper::METHODS_LIST_FILE

Constants included from Async

Async::MISSING_VALUE

Instance Attribute Summary collapse

Attributes included from Async

#id

Class Method Summary collapse

Instance Method Summary collapse

Methods included from ApiHelper

define_helpers, methods_list

Methods included from DebugClient

#debug!, #debug_off!

Methods included from Async

#async, #async=, prepare_hash, prepended, thread_store

Constructor Details

#initialize(token = nil, username = nil, server: SERVER, **options) ⇒ Client

Returns a new instance of Client.



60
61
62
63
64
65
 
# File 'lib/telegram/bot/client.rb', line 60

def initialize(token = nil, username = nil, server: SERVER, **options)
  @client = HTTPClient.new
  @token = token || options[:token]
  @username = username || options[:username]
  @base_uri = format(URL_TEMPLATE, server: server, token: self.token)
end

Instance Attribute Details

#base_uri ⇒ Object (readonly)

Returns the value of attribute base_uri.



58
59
60
 
# File 'lib/telegram/bot/client.rb', line 58

def base_uri
  @base_uri
end

#client ⇒ Object (readonly)

Returns the value of attribute client.



58
59
60
 
# File 'lib/telegram/bot/client.rb', line 58

def client
  @client
end

#token ⇒ Object (readonly)

Returns the value of attribute token.



58
59
60
 
# File 'lib/telegram/bot/client.rb', line 58

def token
  @token
end

#username ⇒ Object (readonly)

Returns the value of attribute username.



58
59
60
 
# File 'lib/telegram/bot/client.rb', line 58

def username
  @username
end

Class Method Details

.by_id(id) ⇒ Object 



32
33
34
 
# File 'lib/telegram/bot/client.rb', line 32

def by_id(id)
  Telegram.bots[id]
end

.error_for_response(response) ⇒ Object 



45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/telegram/bot/client.rb', line 45

def error_for_response(response)
  result = JSON.parse(response.body) rescue nil # rubocop:disable Style/RescueModifier
  return Error.new(response.reason) unless result
  message = result['description'] || '-'
  # This errors are raised only for valid responses from Telegram
  case response.status
  when 403 then Forbidden.new(message)
  when 404 then NotFound.new(message)
  else Error.new("#{response.reason}: #{message}")
  end
end

.prepare_async_args(action, body = {}) ⇒ Object 



41
42
43
 
# File 'lib/telegram/bot/client.rb', line 41

def prepare_async_args(action, body = {})
  [action.to_s, Async.prepare_hash(RequestBodyFormatter.format(body, action))]
end

.typed_response! ⇒ Object

Prepend TypedResponse module.



37
38
39
 
# File 'lib/telegram/bot/client.rb', line 37

def typed_response!
  prepend TypedResponse
end

.wrap(input, **options) ⇒ Object

Accepts different options to initialize bot.



23
24
25
26
27
28
29
30
 
# File 'lib/telegram/bot/client.rb', line 23

def wrap(input, **options)
  case input
  when Symbol then by_id(input) or raise "#{name} #{input.inspect} not configured"
  when self   then input
  when Hash   then new(**input.symbolize_keys, **options)
  else        new(input, **options)
  end
end

Instance Method Details

#http_request(uri, body) ⇒ Object

Endpoint for low-level request. For easy host highjacking & instrumentation. Params are not used directly but kept for instrumentation purpose. You probably don’t want to use this method directly.



76
77
78
 
# File 'lib/telegram/bot/client.rb', line 76

def http_request(uri, body)
  client.post(uri, body)
end

#inspect ⇒ Object 



80
81
82
 
# File 'lib/telegram/bot/client.rb', line 80

def inspect
  "#<#{self.class.name}##{object_id}(#{@username})>"
end

#request(action, body = {}) ⇒ Object 



67
68
69
70
71
 
# File 'lib/telegram/bot/client.rb', line 67

def request(action, body = {})
  response = http_request("#{base_uri}#{action}", RequestBodyFormatter.format(body, action))
  raise self.class.error_for_response(response) if response.status >= 300
  JSON.parse(response.body)
end