Class: UserApi

Inherits:
Object
  • Object
show all
Includes:
Validation
Defined in:
lib/tacklebox/apis/user_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Validation

#is_valid_data, #is_valid_event_data, #is_valid_id, #is_valid_name, #is_valid_subscription_data

Constructor Details

#initialize(config) ⇒ UserApi

Returns a new instance of UserApi.



10
11
12
13
 
# File 'lib/tacklebox/apis/user_api.rb', line 10

def initialize(config)
  self.base_url = config[:base_url]
  self.http_client = HttpClient.new(config[:api_key])
end

Instance Attribute Details

#base_url ⇒ Object

Returns the value of attribute base_url.



8
9
10
 
# File 'lib/tacklebox/apis/user_api.rb', line 8

def base_url
  @base_url
end

#http_client ⇒ Object

Returns the value of attribute http_client.



8
9
10
 
# File 'lib/tacklebox/apis/user_api.rb', line 8

def http_client
  @http_client
end

Instance Method Details

#create_user(service_id, user_data) ⇒ Object 



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/tacklebox/apis/user_api.rb', line 15

def create_user(service_id, user_data)
  if !self.is_valid_id(service_id)
    return new_error(
      ERROR_TYPES['missing_parameter'],
      "The create_user method must be invoked with a non-empty string service_id argument."
    )
  end

  if !self.is_valid_data(user_data)
    return new_error(
      ERROR_TYPES['missing_parameter'],
      "The create_user method must be invoked with a non-empty string name argument."
    )
  end

  path = "services/#{service_id}/users"
  request = HttpRequest.new("POST", @base_url, path, user_data)
  @http_client.send(request)
end

#delete_user(service_id, user_id) ⇒ Object 



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/tacklebox/apis/user_api.rb', line 55

def delete_user(service_id, user_id)
  if !self.is_valid_id(service_id)
    return new_error(
      ERROR_TYPES['missing_parameter'],
      "The delete_user method must be invoked with a non-empty string service_id argument."
    )
  end

  if !self.is_valid_id(user_id)
    return new_error(
      ERROR_TYPES['missing_parameter'],
      "The delete_user method must be invoked with a non-empty string user_id argument."
    )
  end

  path = "services/#{service_id}/users/#{user_id}"
  request = HttpRequest.new("DELETE", @base_url, path)
  @http_client.send(request)
end

#get_user(service_id, user_id) ⇒ Object 



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/tacklebox/apis/user_api.rb', line 35

def get_user(service_id, user_id)
  if !self.is_valid_id(service_id)
    return new_error(
      ERROR_TYPES['missing_parameter'],
      "The get_user method must be invoked with a non-empty string service_id argument."
    )
  end

  if !self.is_valid_id(user_id)
    return new_error(
      ERROR_TYPES['missing_parameter'],
      "The get_user method must be invoked with a non-empty string user_id argument."
    )
  end

  path = "services/#{service_id}/users/#{user_id}"
  request = HttpRequest.new("GET", @base_url, path)
  @http_client.send(request)
end

#list_users(service_id) ⇒ Object 



75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/tacklebox/apis/user_api.rb', line 75

def list_users(service_id)
  if !self.is_valid_id(service_id)
    return new_error(
      ERROR_TYPES['missing_parameter'],
      "The list_users method must be invoked with a non-empty string service_id argument."
    )
  end

  path = "services/#{service_id}/users"
  request = HttpRequest.new("GET", @base_url, path)
  @http_client.send(request)
end