authy 2.7.4 → 3.0.1

data/lib/authy/api.rb

@@ -1,21 +1,14 @@
-require 'logger'
+require "logger"
 
 module Authy
-
-  AUTHY_LOGGER = Logger.new(STDOUT)
-  #
-  #  Authy.api_key = 'foo'
-  #  Authy.api_uri = 'http://test-authy-api.heroku.com/'
-  #
   class API
-    USER_AGENT = "AuthyRuby/#{Authy::VERSION} (#{RUBY_PLATFORM}, Ruby #{RUBY_VERSION})"
     MIN_TOKEN_SIZE = 6
     MAX_TOKEN_SIZE = 12
 
     include Authy::URL
 
     extend HTTPClient::IncludeClient
-    include_http_client(agent_name: USER_AGENT)
+    include_http_client
 
     def self.register_user(attributes)
       api_key = attributes.delete(:api_key) || Authy.api_key
@@ -26,7 +19,7 @@ module Authy
       }
 
       url = "#{Authy.api_uri}/protected/json/users/new"
-      response = http_client.post(url, :body => escape_query(params), :header => default_header(api_key: api_key))
+      response = http_client.post(url, :body => escape_query(params), :header => default_header(params: { api_key: api_key }))
 
       Authy::User.new(response)
     end
@@ -37,19 +30,18 @@ module Authy
     # :force (true|false) force to check even if the cellphone is not confirmed
     #
     def self.verify(params)
-      token = params.delete(:token) || params.delete('token')
-      user_id = params.delete(:id) || params.delete('id')
+      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)
+      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?
+      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
-        })
-      )
+        "token" => token,
+        "user_id" => user_id
+      }))
 
       return verify_response(response) if response.ok?
       return response
@@ -59,7 +51,7 @@ module Authy
     # :id user id
     # :force force sms
     def self.request_sms(params)
-      user_id = params.delete(:id) || params.delete('id')
+      user_id = params.delete(:id) || params.delete("id")
 
       get_request("protected/json/sms/:user_id", params.merge({"user_id" => user_id}))
     end
@@ -69,14 +61,14 @@ module Authy
     # :qr_size qr size
     # :qr_label context for qr code
     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') || ""
+      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)
+      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({
+      response = post_request("protected/json/users/:user_id/secret", params.merge({
         "user_id" => user_id,
         "qr_size" => qr_size,
         "label" => qr_label
@@ -87,19 +79,38 @@ module Authy
     # :id user id
     # :force force phone_call
     def self.request_phone_call(params)
-      user_id = params.delete(:id) || params.delete('id')
+      user_id = params.delete(:id) || params.delete("id")
 
       get_request("protected/json/call/:user_id", params.merge({"user_id" => user_id}))
     end
 
     # options:
     # :id user id
-    def self.delete_user(params)
+    def self.request_email(params)
+      user_id = params.delete(:id) || params.delete('id')
+
+      post_request("protected/json/email/:user_id", params.merge({"user_id" => user_id}))
+    end
+
+    # options:
+    # :id user id
+    # :email user's new email
+    def self.update_user(params)
       user_id = params.delete(:id) || params.delete('id')
 
-      post_request("protected/json/users/delete/:user_id", params.merge({"user_id" =>user_id}))
+      post_request("protected/json/users/:user_id/update", params.merge({"user_id" => user_id}))
     end
 
+    # options:
+    # :id user id
+    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
+
+    # options:
+    # :id user id
     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}))
@@ -114,12 +125,12 @@ module Authy
       state, error = validate_for_url(uri_params, params)
 
       response = if state
-                   url = "#{Authy.api_uri}/#{eval_uri(uri, params)}"
-                   params = clean_uri_params(uri_params, params)
-                   http_client.post(url, :body => escape_query(params), header: header_)
-                 else
-                   build_error_response(error)
-                 end
+          url = "#{Authy.api_uri}/#{eval_uri(uri, params)}"
+          params = clean_uri_params(uri_params, params)
+          http_client.post(url, :body => escape_query(params), header: header_)
+        else
+          build_error_response(error)
+        end
       Authy::Response.new(response)
     end
 
@@ -129,24 +140,24 @@ module Authy
       uri_params = keys_to_verify(uri, params)
       state, error = validate_for_url(uri_params, params)
       response = if state
-                   url = "#{Authy.api_uri}/#{eval_uri(uri, params)}"
-                   params = clean_uri_params(uri_params, params)
-                   http_client.get(url, params, header_)
-                 else
-                   build_error_response(error)
-                 end
+          url = "#{Authy.api_uri}/#{eval_uri(uri, params)}"
+          params = clean_uri_params(uri_params, params)
+          http_client.get(url, params, header_)
+        else
+          build_error_response(error)
+        end
       Authy::Response.new(response)
     end
 
     def self.build_error_response(error = "blank uri param found")
       OpenStruct.new({
-        'status' => 400,
-        'body' => {
-          'success' => false,
-          'message' => error,
-          'errors' => {
-            'message' => error
-          }
+        "status" => 400,
+        "body" => {
+          "success" => false,
+          "message" => error,
+          "errors" => {
+            "message" => error,
+          },
         }.to_json
       })
     end
@@ -159,31 +170,26 @@ module Authy
       !!(/^\d+$/.match str.to_s)
     end
 
-    def self.invalid_response(str="Invalid resonse")
+    def self.invalid_response(str = "Invalid resonse")
       response = build_error_response(str)
       return Authy::Response.new(response)
     end
 
     def self.verify_response(response)
-      return response if response['token'] == 'is valid'
-      response = build_error_response('Token is invalid')
+      return response if response["token"] == "is valid"
+      response = build_error_response("Token is invalid")
       return Authy::Response.new(response)
     end
 
-    def self.default_header(api_key: nil, params: {})
+    def self.default_header(params: {})
+      api_key = params.delete(:api_key) || params.delete("api_key")
+
       header = {
-        "X-Authy-API-Key" => api_key || Authy.api_key
+        "X-Authy-API-Key" => api_key || Authy.api_key,
+        "User-Agent" => Authy.user_agent
       }
 
-      api_key_ = params.delete(:api_key) || params.delete("api_key")
-
-      if api_key_ && api_key_.strip != ""
-        AUTHY_LOGGER.warn("[DEPRECATED]: The Authy API key should not be sent as a parameter. Please send the HTTP header 'X-Authy-API-Key' instead.")
-        header["X-Authy-API-Key"] = api_key_
-      end
-
       return header
     end
-
   end
 end

data/lib/authy/config.rb

@@ -17,5 +17,13 @@ module Authy
       @api_uri || "https://api.authy.com"
     end
     alias :api_url :api_uri
+
+    def user_agent
+      @user_agent || "AuthyRuby/#{Authy::VERSION} (#{RUBY_PLATFORM}, Ruby #{RUBY_VERSION})"
+    end
+
+    def user_agent=(user_agent)
+      @user_agent = user_agent
+    end
   end
 end

data/lib/authy/onetouch.rb

@@ -23,7 +23,7 @@ module Authy
       begin
         self.clean_hash!(details)
         self.clean_hash!(hidden_details)
-        self.clean_logos!(logos)
+        logos = self.clean_logos!(logos)
       rescue => e
         return invalid_response("Invalid parameters: #{e.message}")
       end

data/lib/authy/phone_verification.rb

@@ -6,8 +6,11 @@ module Authy
     #   :phone_number The persons phone number.
     #   :custom_code Pass along any generated custom code.
     #   :custom_message Custom Message.
+    #   :code_length Length of code to be sent(4-10).
+    #   :locale The language of the message received by user.
     def self.start(params)
-      params[:via] = "sms" unless %w(sms, call).include?(params[:via])
+      warn "Authy Phone Verification has been superseded by the Twilio Verify API. Check https://twil.io/verify-start-ruby to see how to start a verification with the Twilio Verify API."
+      params[:via] = "sms" unless %w(sms call).include?(params[:via])
 
       post_request("protected/json/phones/verification/start", params)
     end
@@ -17,8 +20,8 @@ module Authy
     #   :phone_number The persons phone number.
     #   :verification_code The verification code entered by the user.
     def self.check(params)
+      warn "Authy Phone Verification has been superseded by the Twilio Verify API. Check https://twil.io/verify-check-ruby to see how to check a verification the Twilio Verify API."
       get_request("protected/json/phones/verification/check", params)
     end
-
   end
 end

data/lib/authy/url_helpers.rb

@@ -30,10 +30,6 @@ module Authy
         [ true, ""]
       end
 
-      def escape_for_url(field)
-        URI.escape(field.to_s.strip, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
-      end
-
       def to_param(left, right)
         HTTP::Message.escape(left) + '=' +  HTTP::Message.escape(right.to_s)
       end

data/lib/authy/version.rb

@@ -1,3 +1,3 @@
 module Authy
-  VERSION = "2.7.4"
+  VERSION = "3.0.1"
 end

data/lib/authy.rb

@@ -6,11 +6,11 @@ require 'json'
 
 require 'authy/version'
 require 'authy/url_helpers'
-require 'authy/core_ext'
 require 'authy/response'
 require 'authy/models/user'
 require 'authy/config'
 require 'authy/api'
-require 'authy/phone_intelligence'
 require 'authy/phone_verification'
 require 'authy/onetouch'
+
+warn "DEPRECATION WARNING: The authy-ruby library is no longer actively maintained. The Authy API is being replaced by the Twilio Verify API. Please see the README for more details."