Class: WeebSh::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/weeb/interfaces/client.rb

Overview

Wrapper class that ties all modules together

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(auth, user_agent = nil, api_url: 'https://api.weeb.sh') ⇒ Client

Groups all interfaces into one.

Parameters:

  • auth (String) —

    the authentication required to use weeb.sh.

  • user_agent (String, Hash) (defaults to: nil) —

    the user agent to use with requests.

  • api_url (String) (defaults to: 'https://api.weeb.sh') —

    the URL to use when using the weeb.sh API.

Raises:



41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/weeb/interfaces/client.rb', line 41

def initialize(auth, user_agent = nil, api_url: 'https://api.weeb.sh')
  @user_agent = WeebSh::API.format_user_agent(user_agent)
  @auth = auth
  @api_url = api_url

  raise WeebSh::Err::BadAuth, 'Authorization is empty!' if auth.empty?
  puts '[WeebSh::Client] Your User Agent is empty. Please consider adding a user agent to help identify issues easier.' if user_agent.nil?
  puts '[WeebSh::Client] Your User Agent is not ideal. Please consider adding a user agent to help identify issues easier.' if !user_agent.nil? && user_agent.split('/').count < 2

  @toph = WeebSh::Toph.new(auth, user_agent, api_url: api_url, client: self)
  @korra = WeebSh::Korra.new(auth, user_agent, api_url: api_url, client: self)
  @shimakaze = WeebSh::Shimakaze.new(auth, user_agent, api_url: api_url, client: self)
  @tama = WeebSh::Tama.new(auth, user_agent, api_url: api_url, client: self)
end

Instance Attribute Details

#api_url ⇒ String

Returns the URL being used for weeb.sh.

Returns:

  • (String) —

    the URL being used for weeb.sh.



16
17
18
 
# File 'lib/weeb/interfaces/client.rb', line 16

def api_url
  @api_url
end

#auth ⇒ String

Returns the authorization used in weeb.sh.

Returns:

  • (String) —

    the authorization used in weeb.sh.



10
11
12
 
# File 'lib/weeb/interfaces/client.rb', line 10

def auth
  @auth
end

#korra ⇒ String (readonly) Also known as: image_gen, auto_image

Returns the korra class tied with the client.

Returns:

  • (String) —

    the korra class tied with the client.



24
25
26
 
# File 'lib/weeb/interfaces/client.rb', line 24

def korra
  @korra
end

#shimakaze ⇒ String (readonly) Also known as: reputation, rep

Returns the shimakaze class tied with the client.

Returns:

  • (String) —

    the shimakaze class tied with the client.



29
30
31
 
# File 'lib/weeb/interfaces/client.rb', line 29

def shimakaze
  @shimakaze
end

#tama ⇒ String (readonly) Also known as: settings

Returns the tama class tied with the client.

Returns:

  • (String) —

    the tama class tied with the client.



34
35
36
 
# File 'lib/weeb/interfaces/client.rb', line 34

def tama
  @tama
end

#toph ⇒ Topc (readonly) Also known as: image, images

Returns the toph class tied with the client.

Returns:

  • (Topc) —

    the toph class tied with the client.



19
20
21
 
# File 'lib/weeb/interfaces/client.rb', line 19

def toph
  @toph
end

#user_agent ⇒ String

Returns the user agent used in weeb.sh.

Returns:

  • (String) —

    the user agent used in weeb.sh.



13
14
15
 
# File 'lib/weeb/interfaces/client.rb', line 13

def user_agent
  @user_agent
end

Instance Method Details

#inspect ⇒ Object 



80
81
82
 
# File 'lib/weeb/interfaces/client.rb', line 80

def inspect
  "#<WeebSh::Client @api_url=#{@api_url.inspect} @user_agent=#{@user_agent.inspect}>"
end