Class: Authy::API
- Inherits:
-
Object
- Object
- Authy::API
- Extended by:
- HTTPClient::IncludeClient
- Includes:
- URL
- Defined in:
- lib/authy/api.rb
Overview
Direct Known Subclasses
Constant Summary collapse
- MIN_TOKEN_SIZE =
6
- MAX_TOKEN_SIZE =
12
Class Method Summary collapse
-
.delete_user(params) ⇒ Object
options: :id user id.
- .register_user(attributes) ⇒ Object
-
.request_phone_call(params) ⇒ Object
options: :id user id :force force phone_call.
-
.request_qr_code(params) ⇒ Object
options: :id user id :qr_size qr size :qr_label context for qr code.
-
.request_sms(params) ⇒ Object
options: :id user id :force force sms.
- .user_status(params) ⇒ Object
-
.verify(params) ⇒ Object
options: :id user id :token authy token entered by the user :force (true|false) force to check even if the cellphone is not confirmed.
Methods included from URL
Class Method Details
.delete_user(params) ⇒ Object
options: :id user id
96 97 98 99 100 |
# File 'lib/authy/api.rb', line 96 def self.delete_user(params) user_id = params.delete(:id) || params.delete('id') post_request("protected/json/users/delete/:user_id", params.merge({"user_id" =>user_id})) end |
.register_user(attributes) ⇒ Object
19 20 21 22 23 24 25 26 27 28 29 30 31 |
# File 'lib/authy/api.rb', line 19 def self.register_user(attributes) api_key = attributes.delete(:api_key) || Authy.api_key send_install_link_via_sms = attributes.delete(:send_install_link_via_sms) { true } params = { :user => attributes, :send_install_link_via_sms => send_install_link_via_sms } url = "#{Authy.api_uri}/protected/json/users/new" response = http_client.post(url, :body => escape_query(params), :header => default_header(api_key: api_key)) Authy::User.new(response) end |
.request_phone_call(params) ⇒ Object
options: :id user id :force force phone_call
88 89 90 91 92 |
# File 'lib/authy/api.rb', line 88 def self.request_phone_call(params) user_id = params.delete(:id) || params.delete('id') get_request("protected/json/call/:user_id", params.merge({"user_id" => user_id})) end |
.request_qr_code(params) ⇒ Object
options: :id user id :qr_size qr size :qr_label context for qr code
70 71 72 73 74 75 76 77 78 79 80 81 82 83 |
# File 'lib/authy/api.rb', line 70 def self.request_qr_code(params) user_id = params.delete(:id) || params.delete('id') qr_size = params.delete(:qr_size) || params.delete('qr_size') || 300 qr_label = params.delete(:qr_label) || params.delete('qr_label') || "" return invalid_response('User id is invalid') unless is_digit?(user_id) return invalid_response('Qr image size is invalid') unless is_digit?(qr_size) response = post_request("protected/json/users/:user_id/secret" ,params.merge({ "user_id" => user_id, "qr_size" => qr_size, "label" => qr_label })) end |
.request_sms(params) ⇒ Object
options: :id user id :force force sms
60 61 62 63 64 |
# File 'lib/authy/api.rb', line 60 def self.request_sms(params) user_id = params.delete(:id) || params.delete('id') get_request("protected/json/sms/:user_id", params.merge({"user_id" => user_id})) end |
.user_status(params) ⇒ Object
102 103 104 105 |
# File 'lib/authy/api.rb', line 102 def self.user_status(params) user_id = params.delete(:id) || params.delete("id") get_request("protected/json/users/:user_id/status", params.merge({"user_id" => user_id})) end |
.verify(params) ⇒ Object
options: :id user id :token authy token entered by the user :force (true|false) force to check even if the cellphone is not confirmed
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 |
# File 'lib/authy/api.rb', line 38 def self.verify(params) token = params.delete(:token) || params.delete('token') user_id = params.delete(:id) || params.delete('id') return invalid_response('Token format is invalid') unless token_is_safe?(token) return invalid_response('User id is invalid') unless is_digit?(user_id) params[:force] = true if params[:force].nil? && params['force'].nil? response = get_request("protected/json/verify/:token/:user_id", params.merge({ "token" => token, "user_id" => user_id }) ) return verify_response(response) if response.ok? return response end |