class DogapiDemo::V1::UserService

Constants

API_VERSION

Public Instance Methods

create_user(description = {}) click to toggle source

Create a user

:description => Hash: user description containing 'handle' and 'name' properties

   # File lib/dogapi-demo/v1/user.rb
33 def create_user(description = {})
34   begin
35     params = {
36       :api_key => @api_key,
37       :application_key => @application_key
38     }
39 
40     request(Net::HTTP::Post, "/api/#{API_VERSION}/user", params, description, true)
41   rescue Exception => e
42     suppress_error_if_silent e
43   end
44 end
disable_user(handle) click to toggle source

Disable a user

:handle => String: user handle

    # File lib/dogapi-demo/v1/user.rb
 97 def disable_user(handle)
 98   begin
 99     params = {
100       :api_key => @api_key,
101       :application_key => @application_key
102     }
103 
104     request(Net::HTTP::Delete, "/api/#{API_VERSION}/user/#{handle}", params, nil, false)
105   rescue Exception => e
106     suppress_error_if_silent e
107   end
108 end
get_all_users() click to toggle source

Retrieve all users

   # File lib/dogapi-demo/v1/user.rb
63 def get_all_users()
64   begin
65     params = {
66       :api_key => @api_key,
67       :application_key => @application_key
68     }
69 
70     request(Net::HTTP::Get, "/api/#{API_VERSION}/user", params, nil, false)
71   rescue Exception => e
72     suppress_error_if_silent e
73   end
74 end
get_user(handle) click to toggle source

Retrieve user information

:handle => String: user handle

   # File lib/dogapi-demo/v1/user.rb
49 def get_user(handle)
50   begin
51     params = {
52       :api_key => @api_key,
53       :application_key => @application_key
54     }
55 
56     request(Net::HTTP::Get, "/api/#{API_VERSION}/user/#{handle}", params, nil, false)
57   rescue Exception => e
58     suppress_error_if_silent e
59   end
60 end
invite(emails, options = {}) click to toggle source

DEPRECATED: Going forward, we're using a new and more restful API, the new methods are get_user, create_user, update_user, disable_user

   # File lib/dogapi-demo/v1/user.rb
12 def invite(emails, options = {})
13   warn "[DEPRECATION] DogapiDemo::V1::UserService::invite has been deprecated in favor of DogapiDemo::V1::UserService::create_user"
14   begin
15     params = {
16       :api_key => @api_key,
17       :application_key => @application_key
18     }
19 
20     body = {
21       'emails' => emails,
22     }.merge options
23 
24     request(Net::HTTP::Post, "/api/#{API_VERSION}/invite_users", params, body, true)
25   rescue Exception => e
26     suppress_error_if_silent e
27   end
28 end
update_user(handle, description = {}) click to toggle source

Update a user

:handle => String: user handle :description => Hash: user description optionally containing 'name', 'email', 'is_admin', 'disabled' properties

   # File lib/dogapi-demo/v1/user.rb
81 def update_user(handle, description = {})
82   begin
83     params = {
84       :api_key => @api_key,
85       :application_key => @application_key
86     }
87 
88     request(Net::HTTP::Put, "/api/#{API_VERSION}/user/#{handle}", params, description, true)
89   rescue Exception => e
90     suppress_error_if_silent e
91   end
92 end