Class: Antaeus::APIClient

Inherits:
Object
  • Object
show all
Defined in:
lib/antaeus-sdk/api_client.rb

Overview

This class is the actual API client, which is a smart wrapper around RestClient

Direct Known Subclasses

GuestAPIClient, UserAPIClient

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ APIClient

Returns a new instance of APIClient.



8
9
 
# File 'lib/antaeus-sdk/api_client.rb', line 8

def initialize
end

Class Method Details

.instance ⇒ Object 



4
5
6
 
# File 'lib/antaeus-sdk/api_client.rb', line 4

def self.instance
  new
end

Instance Method Details

#authenticate(login, pass) ⇒ Object

override this method



12
13
14
 
# File 'lib/antaeus-sdk/api_client.rb', line 12

def authenticate(, pass)
  false
end

#authenticated? ⇒ Boolean

override this method

Returns:

  • (Boolean) 


17
18
19
 
# File 'lib/antaeus-sdk/api_client.rb', line 17

def authenticated?
  false
end

#connect ⇒ Object

override this method



22
23
24
 
# File 'lib/antaeus-sdk/api_client.rb', line 22

def connect
  false
end

#connected? ⇒ Boolean

Returns:

  • (Boolean) 


26
27
28
 
# File 'lib/antaeus-sdk/api_client.rb', line 26

def connected?
  @rest_client ? true : false
end

#delete(uri) ⇒ Object 



30
31
32
33
34
 
# File 'lib/antaeus-sdk/api_client.rb', line 30

def delete(uri)
  client_action do
    raw[Addressable::URI.escape(uri)].delete
  end
end

#get(uri, data = nil) ⇒ Object 



36
37
38
39
40
41
42
43
44
 
# File 'lib/antaeus-sdk/api_client.rb', line 36

def get(uri, data = nil)
  client_action do
    if data
      JSON.load raw[Addressable::URI.escape(uri)].get(params: data)
    else
      JSON.load raw[Addressable::URI.escape(uri)].get
    end
  end
end

#patch(uri, data) ⇒ Object 



52
53
54
55
56
57
58
59
60
61
 
# File 'lib/antaeus-sdk/api_client.rb', line 52

def patch(uri, data)
  client_action do
    response = raw[Addressable::URI.escape(uri)].patch(json_escape(data.to_json))
    if response && !response.empty?
      JSON.load(response)
    else
      true
    end
  end
end

#post(uri, data) ⇒ Object 



46
47
48
49
50
 
# File 'lib/antaeus-sdk/api_client.rb', line 46

def post(uri, data)
  client_action do
    JSON.load raw[Addressable::URI.escape(uri)].post(json_escape(data.to_json))
  end
end

#put(uri, data) ⇒ Object 



63
64
65
66
67
 
# File 'lib/antaeus-sdk/api_client.rb', line 63

def put(uri, data)
  client_action do
    raw[Addressable::URI.escape(uri)].put(json_escape(data.to_json))
  end
end

#raw ⇒ Object 



69
70
71
 
# File 'lib/antaeus-sdk/api_client.rb', line 69

def raw
  @rest_client
end

#refresh_token ⇒ Object

This needs to be caught by whatever is using the SDK to get new user creds

Raises:



74
75
76
77
 
# File 'lib/antaeus-sdk/api_client.rb', line 74

def refresh_token
  @rest_client = nil
  raise Exceptions::LoginRequired
end