Class: GAuthify

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_key) ⇒ GAuthify

Returns a new instance of GAuthify.



65
66
67
68
69
70
71
72
73
 
# File 'lib/gauthify.rb', line 65

def initialize(api_key)
  @access_points = [
      'https://alpha.gauthify.com/v1/',
      'https://beta.gauthify.com/v1/'
  ]
  @headers = {:authorization => "Basic #{Base64.encode64(":#{api_key}")}",
              :user_agent => 'GAuthify-Ruby/v2.0'}

end

Instance Attribute Details

#access_points ⇒ Object

Returns the value of attribute access_points.



63
64
65
 
# File 'lib/gauthify.rb', line 63

def access_points
  @access_points
end

#headers ⇒ Object

Returns the value of attribute headers.



63
64
65
 
# File 'lib/gauthify.rb', line 63

def headers
  @headers
end

Instance Method Details

#api_errors ⇒ Object 



259
260
261
262
263
264
265
 
# File 'lib/gauthify.rb', line 259

def api_errors()
  <<-DOC
      Returns hash containing api errors.
  DOC
  url_addon = "errors/"
  return requests_handler('get', url_addon)
end

#check_auth(unique_id, auth_code, safe_mode = false) ⇒ Object 



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/gauthify.rb', line 204

def check_auth(unique_id, auth_code, safe_mode = false)
  <<-DOC
      Checks OTP returns True/False depending on OTP correctness.
  DOC
  begin
    url_addon = "check/"
    params = {'unique_id' => unique_id, 'auth_code' => auth_code}
    response = requests_handler('post', url_addon, params=params)
    return response['authenticated']
  rescue GAuthifyError => e
    if safe_mode
      return True
    else
      raise e
    end
  end

end

#create_user(unique_id, display_name, email = nil, sms_number = nil, voice_number = nil, meta = nil) ⇒ Object 



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/gauthify.rb', line 122

def create_user(unique_id, display_name, email=nil, sms_number=nil, voice_number=nil, meta=nil)
  <<-DOC
      Creates new user
  DOC

  params = {'unique_id' => unique_id, 'display_name' => display_name}
  if email
    params['email'] = email
  end
  if sms_number
    params['sms_number'] = sms_number
  end
  if voice_number
    params['voice_number'] = voice_number
  end
  if meta
    params['meta'] = meta.to_json
  end
  url_addon = "users/"
  return requests_handler('post', url_addon, params=params)
end

#delete_user(unique_id) ⇒ Object 



170
171
172
173
174
175
176
177
 
# File 'lib/gauthify.rb', line 170

def delete_user(unique_id)
  <<-DOC
    Deletes user given by unique_id
  DOC
  url_addon = "users/#{unique_id}/"
  return requests_handler('delete', url_addon)

end

#get_all_users ⇒ Object 



179
180
181
182
183
184
 
# File 'lib/gauthify.rb', line 179

def get_all_users()
  <<-DOC
      Retrieves a list of all users
  DOC
  return requests_handler('get', 'users/')
end

#get_user(unique_id) ⇒ Object 



187
188
189
190
191
192
193
 
# File 'lib/gauthify.rb', line 187

def get_user(unique_id)
  <<-DOC
      Returns a single user
  DOC
  url_addon = "users/#{unique_id}/"
  return requests_handler('get', url_addon)
end

#get_user_by_token(token) ⇒ Object 



195
196
197
198
199
200
201
202
 
# File 'lib/gauthify.rb', line 195

def get_user_by_token(token)
  <<-DOC
      Returns a single user by ezGAuth token
  DOC
  params = {'token' => token}
  url_addon = "token/"
  return requests_handler('post', url_addon, params=params)
end

#quick_test(test_email = nil, test_sms_number = nil, test_voice_number = nil) ⇒ Object 



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/gauthify.rb', line 268

def quick_test(test_email = nil, test_sms_number = nil, test_voice_number = nil)
  <<-DOC
      Runs initial tests to make sure everything is working fine
  DOC
   = '[email protected]'
  begin
    delete_user()
  rescue NotFoundError => e
  end

  def success()
    print("Success \n")
  end

  puts("1) Testing Creating a User...")
  result = create_user(,
                       ,
                       email='[email protected]',
                       sms_number='9162627232',
                       voice_number='9162627233')
  if not result['unique_id'] == 
    raise Exception
  end
  if not result['display_name'] == 
    raise Exception
  end
  if not result['email'] == '[email protected]'
    raise Exception
  end
  if not result['sms_number'] == '+19162627232'
    raise Exception
  end
  if not result['voice_number'] == '+19162627233'
    raise Exception
  end
  puts(result)
  success()

  puts("2) Retrieving Created User...")
  user = get_user()
  if not user.class == Hash
    raise Exception
  end
  puts(user)
  success()

  puts("3) Retrieving All Users...")
  result = get_all_users()
  if not result.class == Array
    raise Exception
  end
  puts(result)
  success()

  puts("4) Bad Auth Code...")
  result = check_auth(, '112345')
  if result
    raise Exception
  end
  puts(result)
  success()

  puts("5) Testing one time pass (OTP)....")
  result = check_auth(, user['otp'])
  puts(result)
  if not result
    raise ParameterError('Server error. OTP not working. Contact ', '[email protected] for help.', 500, '500', '')
  end
  success()
  if test_email
    puts("5A) Testing email to #{test_email}")
    result = send_email(, test_email)
    puts(result)
    success()
  end
  if test_sms_number
    puts("5B) Testing SMS to #{test_sms_number}")
    send_sms(, test_sms_number)
    success()
  end
  if test_voice_number
    puts("5C) Calling #{test_voice_number}")
    send_voice(, test_voice_number)
    success()
  end

  puts("6) Testing updating email, phone, and meta")
  result = update_user(,
                       email='[email protected]',
                       sms_number='9162627235',
                       voice_number='9162627236',
                       meta={'a' => 'b'})
  if not result['email'] == '[email protected]'
    raise Exception
  end
  if not result['sms_number'] == '+19162627235'
    raise Exception
  end
  if not result['voice_number'] == '+19162627236'
    raise Exception
  end
  if not result['meta']['a'] == 'b'
    raise Exception
  end
  current_key = result['key']
  success()

  puts("7) Testing key/secret")
  result = update_user(, nil, nil, nil, nil, true)
  puts(current_key, result['key'])
  if not result['key'] != current_key
    raise Exception
  end
  success()

  puts("8) Deleting Created User...")
  result = delete_user()
  success()

  puts("9) Testing backup server...")
  current = @access_points[0]
  @access_points[0] = 'https://blah.gauthify.com/v1/'
  result = get_all_users()
  @access_points[0] = current
  puts(result)
  success()

end

#requests_handler(type, url_addon = '', params = {}) ⇒ Object 



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/gauthify.rb', line 75

def requests_handler(type, url_addon='', params={})
  type = type.downcase
  for each in @access_points
    begin
      req_url = each + url_addon
      req = RestClient::Request.execute(:method => type, :url => req_url, :timeout => 5, :headers => @headers, :payload => params)
      status_code = req.code
      begin
        json_resp = JSON.parse(req.to_str)
      rescue
        json_resp = false
      end
      if not json_resp.is_a? Hash or (status_code > 400 and not [401, 402, 406, 404, 409].include?(status_code))
        raise RestClient::Exception
      end
      break
    rescue Exception => e
      if e.is_a? RestClient::Exception
        case e.http_code
          when 401
            json_resp = JSON.parse(e.http_body)
            raise ApiKeyError.new(json_resp['error_message'], status_code, json_resp['error_code'], e.http_body), json_resp['error_message']
          when 402
            json_resp = JSON.parse(e.http_body)
            raise RateLimitError.new(json_resp['error_message'], status_code, json_resp['error_code'], e.http_body), json_resp['error_message']
          when 406
            json_resp = JSON.parse(e.http_body)
            raise ParameterError.new(json_resp['error_message'], status_code, json_resp['error_code'], e.http_body), json_resp['error_message']
          when 404
            json_resp = JSON.parse(e.http_body)
            raise NotFoundError.new(json_resp['error_message'], status_code, json_resp['error_code'], e.http_body), json_resp['error_message']
          when 409
            json_resp = JSON.parse(e.http_body)
            raise ConflictError.new(json_resp['error_message'], status_code, json_resp['error_code'], e.http_body), json_resp['error_message']
        end
      end
      if each == @access_points[-1]
        e_msg = "#{e.to_s}. Please contact [email protected] for help"
        raise ServerError.new(e_msg, 500, '500', ''), e_msg
      end
      next
    end
  end
  return json_resp['data']
end

#send_email(unique_id, email = nil) ⇒ Object 



223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/gauthify.rb', line 223

def send_email(unique_id, email = nil)
  <<-DOC
      Sends email with the one time auth_code
  DOC
  url_addon = "email/"
  params = {'unique_id' => unique_id}
  if email
    params['email'] = email
  end
  return requests_handler('post', url_addon, params=params)
end

#send_sms(unique_id, sms_number = nil) ⇒ Object 



235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/gauthify.rb', line 235

def send_sms(unique_id, sms_number = nil)
  <<-DOC
      Sends text message to phone number with the one time auth_code
  DOC
  url_addon = "sms/"
  params = {'unique_id' => unique_id}
  if sms_number
    params['sms_number'] = sms_number
  end
  return requests_handler('post', url_addon, params=params)
end

#send_voice(unique_id, voice_number = nil) ⇒ Object 



247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/gauthify.rb', line 247

def send_voice(unique_id, voice_number = nil)
  <<-DOC
     Makes a call to phone number with the one time auth_code
  DOC
  url_addon = "voice/"
  params = {'unique_id' => unique_id}
  if voice_number
    params['voice_number'] = voice_number
  end
  return requests_handler('post', url_addon, params=params)
end

#success ⇒ Object 



278
279
280
 
# File 'lib/gauthify.rb', line 278

def success()
  print("Success \n")
end

#update_user(unique_id, email = nil, sms_number = nil, voice_number = nil, meta = nil, reset_key = false) ⇒ Object 



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/gauthify.rb', line 144

def update_user(unique_id, email=nil, sms_number=nil, voice_number=nil, meta=nil, reset_key = false)
  <<-DOC
      Creates new user with a new secret key or resets if already exists
  DOC

  params = Hash.new
  if email
    params['email'] = email
  end
  if sms_number
    params['sms_number'] = sms_number
  end
  if voice_number
    params['voice_number'] = voice_number
  end
  if meta
    params['meta'] = meta.to_json
  end
  if reset_key
    params['reset_key'] = 'true'
  end
  url_addon = "users/#{unique_id}/"
  return requests_handler('put', url_addon, params=params)
end