Class: Passage::UserAPI

Inherits:
Object
  • Object
show all
Defined in:
lib/passageidentity/user_api.rb

Instance Method Summary collapse

Constructor Details

#initialize(connection, app_id, api_key) ⇒ UserAPI

This class will require an API key



6
7
8
9
10
 
# File 'lib/passageidentity/user_api.rb', line 6

def initialize(connection, app_id, api_key)
  @connection = connection
  @app_id = app_id
  @api_key = api_key
end

Instance Method Details

#activate(user_id:) ⇒ Object 



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/passageidentity/user_api.rb', line 54

def activate(user_id:)
  user_exists?(user_id)

  begin
    response =
      @connection.patch("/v1/apps/#{@app_id}/users/#{user_id}/activate")
    user = response.body["user"]
    return(
      Passage::User.new(
        id: user["id"],
        status: user["status"],
        email: user["email"],
        phone: user["phone"],
        email_verified: user["email_verified"],
        phone_verified: user["phone_verified"],
        created_at: user["created_at"],
        updated_at: user["updated_at"],
        last_login_at: user["last_login_at"],
        login_count: user["login_count"],
        webauthn: user["webauthn"],
        webauthn_devices: user["webauthn_devices"],
        recent_events: user["recent_events"],
        user_metadata: user["user_metadata"]
      )
    )
  rescue Faraday::Error => e
    if e.is_a? Faraday::ResourceNotFound
      raise PassageError.new(
              message: "Passage User with ID \"#{user_id}\" does not exist",
              status_code: e.response[:status],
              body: e.response[:body]
            )
    else
      raise PassageError.new(
              message: "failed to activate Passage User.",
              status_code: e.response[:status],
              body: e.response[:body]
            )
    end
  end
end

#create(email: "", phone: "", user_metadata: {}) ⇒ Object 



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/passageidentity/user_api.rb', line 184

def create(email: "", phone: "", user_metadata: {})
  create = {}
  create["email"] = email unless email.empty?
  create["phone"] = phone unless phone.empty?
  create["user_metadata"] = user_metadata unless user_metadata.empty?
  begin
    response = @connection.post("/v1/apps/#{@app_id}/users", create)
    user = response.body["user"]
    return(
      Passage::User.new(
        id: user["id"],
        status: user["status"],
        email: user["email"],
        phone: user["phone"],
        email_verified: user["email_verified"],
        phone_verified: user["phone_verified"],
        created_at: user["created_at"],
        updated_at: user["updated_at"],
        last_login_at: user["last_login_at"],
        login_count: user["login_count"],
        webauthn: user["webauthn"],
        webauthn_devices: user["webauthn_devices"],
        recent_events: user["recent_events"],
        user_metadata: user["user_metadata"]
      )
    )
  rescue Faraday::Error => e
    raise PassageError.new(
            "failed to create Passage User",
            status_code: e.response[:status],
            body: e.response[:body]
          )
  end
end

#deactivate(user_id:) ⇒ Object 



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/passageidentity/user_api.rb', line 96

def deactivate(user_id:)
  user_exists?(user_id)

  begin
    response =
      @connection.patch("/v1/apps/#{@app_id}/users/#{user_id}/deactivate")
    user = response.body["user"]
    return(
      Passage::User.new(
        id: user["id"],
        status: user["status"],
        email: user["email"],
        phone: user["phone"],
        email_verified: user["email_verified"],
        phone_verified: user["phone_verified"],
        created_at: user["created_at"],
        updated_at: user["updated_at"],
        last_login_at: user["last_login_at"],
        login_count: user["login_count"],
        webauthn: user["webauthn"],
        webauthn_devices: user["webauthn_devices"],
        recent_events: user["recent_events"],
        user_metadata: user["user_metadata"]
      )
    )
  rescue Faraday::Error => e
    if e.is_a? Faraday::ResourceNotFound
      raise PassageError.new(
              message: "Passage User with ID \"#{user_id}\" does not exist",
              status_code: e.response[:status],
              body: e.response[:body]
            )
    else
      raise PassageError.new(
              message: "failed to deactivate Passage User.",
              status_code: e.response[:status],
              body: e.response[:body]
            )
    end
  end
end

#delete(user_id:) ⇒ Object 



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/passageidentity/user_api.rb', line 219

def delete(user_id:)
  user_exists?(user_id)

  begin
    response = @connection.delete("/v1/apps/#{@app_id}/users/#{user_id}")
    return true
  rescue Faraday::Error => e
    if e.is_a? Faraday::ResourceNotFound
      raise PassageError.new(
              "passage User with ID \"#{user_id}\" does not exist",
              status_code: e.response[:status],
              body: e.response[:body]
            )
    else
      raise PassageError.new(
              "failed to delete Passage User",
              status_code: e.response[:status],
              body: e.response[:body]
            )
    end
  end
end

#delete_device(user_id:, device_id:) ⇒ Object 



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/passageidentity/user_api.rb', line 242

def delete_device(user_id:, device_id:)
  user_exists?(user_id)
  device_exists?(device_id)

  begin
    response =
      @connection.delete(
        "/v1/apps/#{@app_id}/users/#{user_id}/devices/#{device_id}"
      )
    return true
  rescue Faraday::Error => e
    raise PassageError.new(
            "failed to delete Passage User Device",
            status_code: e.response[:status],
            body: e.response[:body]
          )
  end
end

#get(user_id:) ⇒ Object 



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/passageidentity/user_api.rb', line 12

def get(user_id:)
  user_exists?(user_id)

  begin
    response = @connection.get("/v1/apps/#{@app_id}/users/#{user_id}")
    user = response.body["user"]
    user.transform_keys(&:to_sym)
    return(
      Passage::User.new(
        id: user["id"],
        status: user["status"],
        email: user["email"],
        phone: user["phone"],
        email_verified: user["email_verified"],
        phone_verified: user["phone_verified"],
        created_at: user["created_at"],
        updated_at: user["updated_at"],
        last_login_at: user["last_login_at"],
        login_count: user["login_count"],
        webauthn: user["webauthn"],
        webauthn_devices: user["webauthn_devices"],
        recent_events: user["recent_events"],
        user_metadata: user["user_metadata"]
      )
    )
  rescue Faraday::Error => e
    if e.is_a? Faraday::ResourceNotFound
      raise PassageError.new(
              message: "Passage User with ID \"#{user_id}\" does not exist",
              status_code: e.response[:status],
              body: e.response[:body]
            )
    else
      raise PassageError.new(
              message: "failed to get Passage User.",
              status_code: e.response[:status],
              body: e.response[:body]
            )
    end
  end
end

#list_devices(user_id:) ⇒ Object 



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/passageidentity/user_api.rb', line 261

def list_devices(user_id:)
  user_exists?(user_id)

  begin
    response =
      @connection.get("/v1/apps/#{@app_id}/users/#{user_id}/devices")
    devicesResp = response.body["devices"]
    devices = Array.new
    devicesResp.each do |device|
      devices.append(
        Passage::Device.new(
          id: device["id"],
          cred_id: device["cred_id"],
          friendly_name: device["friendly_name"],
          usage_count: device["usage_count"],
          updated_at: device["updated_at"],
          created_at: device["created_at"],
          last_login_at: device["last_login_at"]
        )
      )
    end
    return devices
  rescue Faraday::Error => e
    raise PassageError.new(
            "failed to delete Passage User Device",
            status_code: e.response[:status],
            body: e.response[:body]
          )
  end
end

#signout(user_id:) ⇒ Object 



292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/passageidentity/user_api.rb', line 292

def signout(user_id:)
  user_exists?(user_id)
  begin
    response =
      @connection.delete("/v1/apps/#{@app_id}/users/#{user_id}/tokens/")
    return true
  rescue Faraday::Error => e
    raise PassageError.new(
            "failed to revoke user's refresh tokens",
            status_code: e.response[:status],
            body: e.response[:body]
          )
  end
end

#update(user_id:, email: "", phone: "", user_metadata: {}) ⇒ Object 



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/passageidentity/user_api.rb', line 138

def update(user_id:, email: "", phone: "", user_metadata: {})
  user_exists?(user_id)

  updates = {}
  updates["email"] = email unless email.empty?
  updates["phone"] = phone unless phone.empty?
  updates["user_metadata"] = user_metadata unless user_metadata.empty?
  begin
    response =
      @connection.patch("/v1/apps/#{@app_id}/users/#{user_id}", updates)
    user = response.body["user"]
    return(
      Passage::User.new(
        id: user["id"],
        status: user["status"],
        email: user["email"],
        phone: user["phone"],
        email_verified: user["email_verified"],
        phone_verified: user["phone_verified"],
        created_at: user["created_at"],
        updated_at: user["updated_at"],
        last_login_at: user["last_login_at"],
        login_count: user["login_count"],
        webauthn: user["webauthn"],
        webauthn_devices: user["webauthn_devices"],
        recent_events: user["recent_events"],
        user_metadata: user["user_metadata"]
      )
    )
  rescue Faraday::Error => e
    if e.is_a? Faraday::ResourceNotFound
      raise PassageError.new(
              message: "Passage User with ID \"#{user_id}\" does not exist",
              status_code: e.response[:status],
              body: e.response[:body]
            )
    else
      raise PassageError.new(
              "failed to update Passage User",
              status_code: e.response[:status],
              body: e.response[:body]
            )
    end
  end
end