Class: Wowapi

Inherits:
Object
  • Object
show all
Includes:
Modules::Character, Modules::Guild
Defined in:
lib/wowapi/region.rb,
lib/wowapi/wowapi.rb,
lib/wowapi/modules.rb,
lib/wowapi/version.rb,
lib/wowapi/fail_silently.rb,
lib/wowapi/modules/guild.rb,
lib/wowapi/response_data.rb,
lib/wowapi/modules/character.rb,
lib/wowapi/exceptions/api_exception.rb,
lib/wowapi/exceptions/auth_exception.rb,
lib/wowapi/exceptions/region_exception.rb,
lib/wowapi/exceptions/no_credentials_exception.rb

Defined Under Namespace

Modules: Modules Classes: ApiException, AuthException, NoCredentialsException, RegionException, ResponseData

Constant Summary collapse

VERSION = 
'0.1.7'

Class Attribute Summary collapse

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Modules::Guild

#guild

Methods included from Modules::Character

#character

Constructor Details

#initialize {|_self| ... } ⇒ Wowapi

Creating an instance of Wowapi class

Yields:

  • (_self)

Yield Parameters:

  • _self (Wowapi) —

    the object that the method was called on



16
17
18
 
# File 'lib/wowapi/wowapi.rb', line 16

def initialize
  yield self if block_given?
end

Class Attribute Details

.fail_silently ⇒ Object

Raise exceptions on error responses from API endpoint?



5
6
7
 
# File 'lib/wowapi/fail_silently.rb', line 5

def fail_silently
  @fail_silently
end

.region ⇒ Object

Wowapi.region class variable that holds customer region (:eu, :us, …) DEFAULTS TO :eu



6
7
8
 
# File 'lib/wowapi/region.rb', line 6

def region
  @region
end

Instance Attribute Details

#public_key ⇒ Object

Instance variables we keep public_key and secret_key in



13
14
15
 
# File 'lib/wowapi/wowapi.rb', line 13

def public_key
  @public_key
end

#secret_key ⇒ Object

Instance variables we keep public_key and secret_key in



13
14
15
 
# File 'lib/wowapi/wowapi.rb', line 13

def secret_key
  @secret_key
end

Instance Method Details

#get(path, params = {}) ⇒ Object

Method to handle all requests, properly interpreting HTTP answer & returning it’s response



22
23
24
25
26
27
28
 
# File 'lib/wowapi/wowapi.rb', line 22

def get(path, params = {})
  res = make_request(path, params)
  if !(res.status.include?('200') or res.status.include?(200)) && ! Wowapi.fail_silently
    raise Wowapi::ApiException.new, "Did not receive status 200, but #{res.try(:status).try(:first)} (#{res.class})."
  end
  res.read
end

#region ⇒ Object 



14
15
16
 
# File 'lib/wowapi/region.rb', line 14

def region
  Wowapi.region
end

#region=(region) ⇒ Object 



10
11
12
 
# File 'lib/wowapi/region.rb', line 10

def region=(region)
  Wowapi.region = region if region.is_a?(Symbol)
end