Class: LabClient::UserKeys

Inherits:
Common
  • Object
show all
Includes:
ClassHelpers
Defined in:
lib/labclient/users/keys/list.rb,
lib/labclient/users/keys/show.rb,
lib/labclient/users/keys/client.rb,
lib/labclient/users/keys/create.rb,
lib/labclient/users/keys/delete.rb

Overview

Specifics

Constant Summary

Constants included from AccessLevel

AccessLevel::HUMAN_ACCESS_LEVELS, AccessLevel::MACHINE_ACCESS_LEVELS

Instance Attribute Summary

Attributes inherited from Common

#client

Instance Method Summary collapse

Methods included from ClassHelpers

#has?, #keys, #raw

Methods inherited from Common

#api_methods, #api_methods_help, #format_id, #format_query_id, #format_query_ids, #format_time?, #group_name, #help, #initialize, #inspect, #klass, #protected_query_access_level, #query_access_level, #query_format_time

Methods included from Docs

#demo, #desc, #doc, docs, #example, #group_name, #help, json, #markdown, #navigation, #option, #result, #subtitle, #title

Methods included from AccessLevel

#human_access_level, #human_protected_access_level, #machine_access_level, #machine_protected_access_level

Constructor Details

This class inherits a constructor from LabClient::Common

Instance Method Details

#create(query, user_id = nil) ⇒ Object 



33
34
35
36
37
38
39
40
 
# File 'lib/labclient/users/keys/create.rb', line 33

def create(query, user_id = nil)
  if user_id
    user_id = format_id(user_id)
    client.request(:post, "users/#{user_id}/keys", Key, query)
  else
    client.request(:post, 'user/keys', Key, query)
  end
end

#delete(key_id, user_id = nil) ⇒ Object 



23
24
25
26
27
28
29
30
31
 
# File 'lib/labclient/users/keys/delete.rb', line 23

def delete(key_id, user_id = nil)
  key_id = format_id(key_id)
  if user_id
    user_id = format_id(user_id)
    client.request(:delete, "users/#{user_id}/keys/#{key_id}")
  else
    client.request(:delete, "user/keys/#{key_id}")
  end
end

#list(user_id = nil) ⇒ Object 



24
25
26
27
28
29
30
31
 
# File 'lib/labclient/users/keys/list.rb', line 24

def list(user_id = nil)
  if user_id
    user_id = format_id(user_id)
    client.request(:get, "users/#{user_id}/keys", Key)
  else
    client.request(:get, 'user/keys', Key)
  end
end

#show(key_id) ⇒ Object 



11
12
13
14
15
 
# File 'lib/labclient/users/keys/show.rb', line 11

def show(key_id)
  key_id = format_id(key_id)

  client.request(:get, "user/keys/#{key_id}", Key)
end