usman 0.3.26 → 0.3.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7af4414597edcc1c594ec129f781c08b1e065cf9
-  data.tar.gz: 3fc75080e583e8690c928c59dc9631bd2790b720
+  metadata.gz: f92a7c718aee50ad9013355ee1a2cc4893dd7f71
+  data.tar.gz: 73cbf7609e77b3069772e09614c00cb36abaee49
 SHA512:
-  metadata.gz: 6978436bb08a879e2083d2c6d942bbaffe3f6beb04139f6a9650beb7c32effbaa9ca9b691ac336a4c0c39aac99346216fed4d8a3bd9f652b9145d16c04b9b2db
-  data.tar.gz: 171ec6ec396622040719344ff329c983a56468cc916a50d4f480f1a5f58cdd048f0eb7170a6e3e0165e77e60424ec84aeea59c5849703947569e8e5281d714cf
+  metadata.gz: da3684674e7e8442ca3d7b4116c17c0f57d2a681d5e31b57c87964b035f2a30ac53fd5bdc6133fcfb2fe03097d6aac55362b2d5dc27c32c4abc869b994080bde
+  data.tar.gz: ae26db23e9f3eff5b5b3169a9e9a3533e586f366574648cc86cb93daf2fe2c340f7bc9c5a8e8648a21173959f1e34796f2b5458e19ebe19f807137952929e2d8

data/app/controllers/usman/api/v1/docs_controller.rb

@@ -207,7 +207,6 @@ module Usman
           render 'kuppayam/api/docs/show'
         end
 
-
         def contacts_sync
           set_title("Sync Contacts")
           @request_type = "POST"
@@ -278,8 +277,8 @@ module Usman
           render 'kuppayam/api/docs/show'
         end    
 
-        def single_contacts
-          set_title("Single Contacts")
+        def single_contact
+          set_title("Single Contact")
           @request_type = "GET"
           @end_point = "/api/v1/contacts/:id"
           @description = <<-eos
@@ -296,7 +295,7 @@ module Usman
           @example_path = "usman/api/v1/docs/"
           @examples = ["pos_case_1", "neg_case_1"]
 
-          set_nav("docs/usman/single_contacts")
+          set_nav("docs/usman/single_contact")
 
           render 'kuppayam/api/docs/show'
         end
@@ -375,6 +374,83 @@ module Usman
           render 'kuppayam/api/docs/show'
         end
 
+        def send_otp_to_change_number
+          set_title("Resend OTP API")
+          @request_type = "POST"
+          @end_point = "/api/v1/send_otp_to_change_number"
+          @description = <<-eos
+            This API will send the OTP as a confirmation to process the request to change the mobile number
+          eos
+
+          @input_headers = {
+            "Content-Type" => { value: "application/json", description: "The MIME media type for JSON text is application/json. This is to make sure that a valid json is returned. The default encoding is UTF-8. " }
+          }
+
+          @input_params = {
+            uuid: { mandatory: true, description: "Universal Unique Identifier. iOS or Android will give you this programatically.", example: "", default: "" }
+          }
+
+          @example_path = "usman/api/v1/docs/"
+          @examples = ["pos_case_1", "neg_case_1", "neg_case_2", "neg_case_3", "neg_case_4"]
+
+          set_nav("docs/usman/send_otp_to_change_number")
+
+          render 'kuppayam/api/docs/show'
+        end
+
+        def change_number
+          set_title("Change Number API")
+          @request_type = "POST"
+          @end_point = "/api/v1/change_number"
+          @description = <<-eos
+            This API along with the OTP will change the mobile number from old to new.
+          eos
+          
+          @input_headers = {
+            "Content-Type" => { value: "application/json", description: "The MIME media type for JSON text is application/json. This is to make sure that a valid json is returned. The default encoding is UTF-8. " }
+          }
+
+          @input_params = {
+            otp: { mandatory: true, description: "One Time Password you have received via SMS. (Five Digit)", example: "51234", default: "" },
+            uuid: { mandatory: true, description: "Universal Unique Identifier. iOS or Android will give you this programatically.", example: "", default: "" },
+            old_dialing_prefix: { mandatory: true, description: "International Dialing Prefix for countries", example: "+91", default: "" },
+            old_mobile_number: { mandatory: true, description: "Mobile Number without Dialing Prefix", example: "If your mobile number is +971 54 312 9876, pass '543129876' without spaces.", default: "" },
+            new_dialing_prefix: { mandatory: true, description: "International Dialing Prefix for countries", example: "+971", default: "" },
+            new_mobile_number: { mandatory: true, description: "Mobile Number without Dialing Prefix", example: "If your mobile number is +971 54 312 9876, pass '543129876' without spaces.", default: "" }
+          }
+
+          @example_path = "usman/api/v1/docs/"
+          @examples = ["pos_case_1", "neg_case_1", "neg_case_2", "neg_case_3", "neg_case_4", "neg_case_5", "neg_case_6", "neg_case_7"]
+
+          set_nav("docs/usman/change_number")
+
+          render 'kuppayam/api/docs/show'
+        end
+
+        def delete_account
+          set_title("DELETE ACCOUNT API")
+          @request_type = "DELETE"
+          @end_point = "/api/v1/delete_account"
+          @description = <<-eos
+          This API will delete the account from the system and the user will be logged out from all sessions.
+          eos
+
+          @warning = "This is an irreversible action and the user will not be able to login back to this account again"
+          
+          @input_headers = {
+            "Content-Type" => { value: "application/json", description: "The MIME media type for JSON text is application/json. This is to make sure that a valid json is returned. The default encoding is UTF-8. " }
+          }
+
+          @input_params = {}
+
+          @example_path = "usman/api/v1/docs/"
+          @examples = ["pos_case_1", "neg_case_1", "neg_case_2"]
+
+          set_nav("docs/usman/delete_account")
+
+          render 'kuppayam/api/docs/show'
+        end
+
         private
 
         def set_nav_items
@@ -388,10 +464,13 @@ module Usman
             get_profile_info: { nav_class: "docs/usman/get_profile_info", icon_class: "fa-user", url: usman.docs_api_v1_get_profile_info_path, text: "Get Profile Info API"},
             contacts_sync: { nav_class: "docs/usman/contacts_sync", icon_class: "fa-user", url: usman.docs_api_v1_contacts_sync_path, text: "Contact Syncing"},
             all_contacts: { nav_class: "docs/usman/all_contacts", icon_class: "fa-user", url: usman.docs_api_v1_all_contacts_path, text: "Get All Contacts"},
-            single_contacts: { nav_class: "docs/usman/single_contacts", icon_class: "fa-user", url: usman.docs_api_v1_single_contacts_path, text: "Single Contact"},
+            single_contact: { nav_class: "docs/usman/single_contact", icon_class: "fa-user", url: usman.docs_api_v1_single_contact_path, text: "Single Contact"},
             upload_profile_picture_base64: { nav_class: "docs/usman/upload_profile_picture_base64", icon_class: "fa-photo", url: usman.docs_api_v1_upload_profile_picture_base64_path, text: "Upload Profile Picture (Base64)"},
             upload_profile_picture: { nav_class: "docs/usman/upload_profile_picture", icon_class: "fa-photo", url: usman.docs_api_v1_upload_profile_picture_path, text: "Upload Profile Picture"},
-            delete_profile_picture: { nav_class: "docs/usman/delete_profile_picture", icon_class: "fa-photo", url: usman.docs_api_v1_delete_profile_picture_path, text: "Remove Profile Picture"}
+            delete_profile_picture: { nav_class: "docs/usman/delete_profile_picture", icon_class: "fa-photo", url: usman.docs_api_v1_delete_profile_picture_path, text: "Remove Profile Picture"},
+            send_otp_to_change_number: { nav_class: "docs/usman/send_otp_to_change_number", icon_class: "fa-phone", url: usman.docs_api_v1_send_otp_to_change_number_path, text: "Send OTP to Change Number"},
+            change_number: { nav_class: "docs/usman/change_number", icon_class: "fa-phone", url: usman.docs_api_v1_change_number_path, text: "Change Number"},
+            delete_account: { nav_class: "docs/usman/delete_account", icon_class: "fa-user", url: usman.docs_api_v1_delete_account_path, text: "Delete Account"},
           }
         end
 

data/app/controllers/usman/api/v1/profile_controller.rb

@@ -22,17 +22,13 @@ module Usman
                 @user.date_of_birth = permitted_params[:date_of_birth]
                 @user.email = permitted_params[:email]
                 
-                @country = Country.find_by_id(permitted_params[:country_id])
-                @city = City.find_by_id(permitted_params[:city_id])
+                @user.country = Country.find_by_id(permitted_params[:country_id])
+                @user.city = City.find_by_id(permitted_params[:city_id])
 
                 if @user.valid?
                   @user.save
                   @user.approve!
                   @current_registration.user = @user
-                  
-                  @user.country = @country if @country
-                  @user.city = @city if @city
-
                   @current_registration.save
 
                   # Saving the profile image if passed
@@ -107,13 +103,12 @@ module Usman
                 @country = Country.find_by_id(permitted_params[:country_id])
                 @city = City.find_by_id(permitted_params[:city_id])
 
+                @user.country = @country if @country
+                @user.city = @city if @city
+
                 if @user.valid?
                   @user.dummy = false
                   @user.save
-                  
-                  @user.country = @country if @country
-                  @user.city = @city if @city
-
                   @current_registration.save
 
                   # Saving the profile image if passed

data/app/controllers/usman/api/v1/registrations_controller.rb

@@ -3,7 +3,7 @@ module Usman
     module V1
       class RegistrationsController < Usman::Api::V1::BaseController
 
-        skip_before_action :require_api_token      
+        skip_before_action :require_api_token, except: [:send_otp_to_change_number, :change_number, :delete_account]
 
         def register
           proc_code = Proc.new do
@@ -34,8 +34,8 @@ module Usman
                 if @device.blocked?
                   @success = false
                   @errors = {
-                    heading: I18n.translate("api.resend_otp.device_blocked.heading"),
-                    message: I18n.translate("api.resend_otp.device_blocked.message"),
+                    heading: I18n.translate("api.general.device_blocked.heading"),
+                    message: I18n.translate("api.general.device_blocked.message"),
                     details: {}
                   }
                 else
@@ -59,8 +59,8 @@ module Usman
               else
                 @success = false
                 @errors = {
-                  heading: I18n.translate("api.resend_otp.device_not_registered.heading"),
-                  message: I18n.translate("api.resend_otp.device_not_registered.message"),
+                  heading: I18n.translate("api.general.device_not_registered.heading"),
+                  message: I18n.translate("api.general.device_not_registered.message"),
                   details: {
                     uuid: "is invalid"
                   }
@@ -69,8 +69,8 @@ module Usman
             else
               @success = false
               @errors = {
-                heading: I18n.translate("api.resend_otp.mobile_number_not_registered.heading"),
-                message: I18n.translate("api.resend_otp.mobile_number_not_registered.message"),
+                heading: I18n.translate("api.general.mobile_number_not_registered.heading"),
+                message: I18n.translate("api.general.mobile_number_not_registered.message"),
                 details: {
                   mobile_number: "is invalid"
                 }
@@ -89,8 +89,8 @@ module Usman
                 if @device.blocked?
                   @success = false
                   @errors = {
-                    heading: I18n.translate("api.verify_otp.device_blocked.heading"),
-                    message: I18n.translate("api.verify_otp.device_blocked.message"),
+                    heading: I18n.translate("api.general.device_blocked.heading"),
+                    message: I18n.translate("api.general.device_blocked.message"),
                     details: {}
                   }
                 else
@@ -120,8 +120,8 @@ module Usman
               else
                 @success = false
                 @errors = {
-                  heading: I18n.translate("api.verify_otp.device_not_registered.heading"),
-                  message: I18n.translate("api.verify_otp.device_not_registered.message"),
+                  heading: I18n.translate("api.general.device_not_registered.heading"),
+                  message: I18n.translate("api.general.device_not_registered.message"),
                   details: {
                     uuid: "is invalid"
                   }
@@ -130,8 +130,8 @@ module Usman
             else
               @success = false
               @errors = {
-                heading: I18n.translate("api.verify_otp.mobile_number_not_registered.heading"),
-                message: I18n.translate("api.verify_otp.mobile_number_not_registered.message"),
+                heading: I18n.translate("api.general.mobile_number_not_registered.heading"),
+                message: I18n.translate("api.general.mobile_number_not_registered.message"),
                 details: {
                   mobile_number: "is invalid"
                 }
@@ -150,8 +150,8 @@ module Usman
                 if @device.blocked?
                   @success = false
                   @errors = {
-                    heading: I18n.translate("api.accept_tac.device_blocked.heading"),
-                    message: I18n.translate("api.accept_tac.device_blocked.message"),
+                    heading: I18n.translate("api.general.device_blocked.heading"),
+                    message: I18n.translate("api.general.device_blocked.message"),
                     details: {}
                   }
                 elsif @device.pending?
@@ -186,8 +186,8 @@ module Usman
               else
                 @success = false
                 @errors = {
-                  heading: I18n.translate("api.accept_tac.device_not_registered.heading"),
-                  message: I18n.translate("api.accept_tac.device_not_registered.message"),
+                  heading: I18n.translate("api.general.device_not_registered.heading"),
+                  message: I18n.translate("api.general.device_not_registered.message"),
                   details: {
                     uuid: "is invalid"
                   }
@@ -196,8 +196,8 @@ module Usman
             else
               @success = false
               @errors = {
-                heading: I18n.translate("api.verify_otp.mobile_number_not_registered.heading"),
-                message: I18n.translate("api.verify_otp.mobile_number_not_registered.message"),
+                heading: I18n.translate("api.general.mobile_number_not_registered.heading"),
+                message: I18n.translate("api.general.mobile_number_not_registered.message"),
                 details: {
                   mobile_number: "is invalid"
                 }
@@ -207,31 +207,131 @@ module Usman
           render_json_response(proc_code)
         end
 
-        def accept_tac1
+        def send_otp_to_change_number
           proc_code = Proc.new do
-            @device = Device.where("uuid = ?", params[:uuid]).first
-            if @device
-              if @device.blocked?
+            if @current_registration
+              unless @current_user
                 @success = false
                 @errors = {
-                  heading: I18n.translate("api.mobile_registration.device_blocked.heading"),
-                  message: I18n.translate("api.mobile_registration.device_blocked.message"),
-                  details: {}
+                  heading: I18n.translate("api.profile.user_does_not_exists.heading"),
+                  message: I18n.translate("api.profile.user_does_not_exists.message")
                 }
               else
-                valid, validation_errors = @device.accept_tac(params[:terms_and_conditions], params[:dialing_prefix], params[:mobile_number])
-                if valid
+                @device = @current_registration.devices.where("uuid = ?", params[:uuid]).first
+                
+                if @device
+                  if @device.blocked?
+                    @success = false
+                    @errors = {
+                      heading: I18n.translate("api.general.device_blocked.heading"),
+                      message: I18n.translate("api.general.device_blocked.message"),
+                      details: {}
+                    }
+                  else
+                    @device.send_otp
+                    @success = true
+                    @alert = {
+                      heading: I18n.translate("api.send_otp_to_change_number.otp_send.heading"),
+                      message: I18n.translate("api.send_otp_to_change_number.otp_send.message")
+                    }
+                  end
+                else
+                  @success = false
+                  @errors = {
+                    heading: I18n.translate("api.general.device_not_registered.heading"),
+                    message: I18n.translate("api.general.device_not_registered.message"),
+                  }
+                end
+              end
+            else
+              @success = false
+              @errors = {
+                heading: I18n.translate("api.profile.registration_details_missing.heading"),
+                message: I18n.translate("api.profile.registration_details_missing.message")
+              }
+            end
+          end
+          render_json_response(proc_code)
+        end
+
+        def change_number
+          proc_code = Proc.new do
+            if @current_registration
+              unless @current_user
+                @success = false
+                @errors = {
+                  heading: I18n.translate("api.profile.user_does_not_exists.heading"),
+                  message: I18n.translate("api.profile.user_does_not_exists.message")
+                }
+              else
+                @device = @current_registration.devices.where("uuid = ?", params[:uuid]).first
+                
+                if @device
+                  if @device.blocked?
+                    @success = false
+                    @errors = {
+                      heading: I18n.translate("api.general.device_blocked.heading"),
+                      message: I18n.translate("api.general.device_blocked.message"),
+                      details: {}
+                    }
+                  else
+                    valid, validation_errors = @device.change_number(params[:otp], params[:old_dialing_prefix], params[:old_mobile_number], params[:new_dialing_prefix], params[:new_mobile_number])
+                    if valid
+                      @success = true
+                      @alert = {
+                        heading: I18n.translate("api.change_number.number_changed.heading"),
+                        message: I18n.translate("api.change_number.number_changed.message")
+                      }
+                    else
+                      @success = false
+                      @errors = {
+                        heading: I18n.translate("api.change_number.number_change_failed.heading"),
+                        message: I18n.translate("api.change_number.number_change_failed.message"),
+                        details: validation_errors
+                      }
+                    end
+                    
+                  end
+                else
+                  @success = false
+                  @errors = {
+                    heading: I18n.translate("api.general.device_not_registered.heading"),
+                    message: I18n.translate("api.general.device_not_registered.message"),
+                  }
+                end
+              end
+            else
+              @success = false
+              @errors = {
+                heading: I18n.translate("api.profile.registration_details_missing.heading"),
+                message: I18n.translate("api.profile.registration_details_missing.message")
+              }
+            end
+          end
+          render_json_response(proc_code)
+        end
+
+        def delete_account
+          proc_code = Proc.new do
+            if @current_registration
+              unless @current_user
+                @success = false
+                @errors = {
+                  heading: I18n.translate("api.profile.user_does_not_exists.heading"),
+                  message: I18n.translate("api.profile.user_does_not_exists.message")
+                }
+              else
+                if @current_registration.delete!
                   @success = true
                   @alert = {
-                    heading: I18n.translate("api.mobile_registration.tac_accepted.heading"),
-                    message: I18n.translate("api.mobile_registration.tac_accepted.message")
+                    heading: I18n.translate("api.delete_account.account_deleted.heading"),
+                    message: I18n.translate("api.delete_account.account_deleted.message")
                   }
-                  @data = { api_token: @device.api_token }
                 else
                   @success = false
                   @errors = {
-                    heading: I18n.translate("api.mobile_registration.tac_not_accepted.heading"),
-                    message: I18n.translate("api.mobile_registration.tac_not_accepted.message"),
+                    heading: I18n.translate("api.delete_account.account_deletion_failed.heading"),
+                    message: I18n.translate("api.delete_account.account_deletion_failed.message"),
                     details: validation_errors
                   }
                 end
@@ -239,16 +339,14 @@ module Usman
             else
               @success = false
               @errors = {
-                heading: I18n.translate("api.general.unexpected_failure.heading"),
-                message: I18n.translate("api.general.unexpected_failure.message"),
-                details: {
-                  uuid: "is invalid"
-                }
+                heading: I18n.translate("api.profile.registration_details_missing.heading"),
+                message: I18n.translate("api.profile.registration_details_missing.message")
               }
             end
           end
           render_json_response(proc_code)
         end
+
       end
     end
   end

data/app/models/device.rb

@@ -145,7 +145,7 @@ class Device < ApplicationRecord
 
   def generate_otp
     self.otp = rand(10000..99999)
-    self.otp_sent_at = nil
+    self.otp_sent_at = Time.now
     self.otp_verified_at = nil
     self.save
   end
@@ -155,7 +155,7 @@ class Device < ApplicationRecord
     # Validate OTP and other parameters
     validation_errors = {}
 
-    # TODO - remove 11111 after implementing Twilio
+    # TODO - remove 11111
     validation_errors[:otp] = "doesn't match with our database" unless (self.otp.to_s == otp.to_s or otp.to_s == "11111")
     validation_errors[:mobile_number] = "doesn't match with our database" unless self.registration.mobile_number.to_s == mobile_number.to_s
     validation_errors[:dialing_prefix] = "doesn't match with our database" unless self.registration.dialing_prefix.to_s == dialing_prefix.to_s
@@ -225,6 +225,40 @@ class Device < ApplicationRecord
     return true, {}
   end
 
+  def change_number(otp, dialing_prefix, mobile_number, new_dialing_prefix, new_mobile_number)
+    
+    # Validate OTP and other parameters
+    validation_errors = {}
+
+    # TODO - remove 11111 after implementing Twilio
+    validation_errors[:otp] = "can't be empty" if otp.blank?
+    
+    validation_errors[:otp] = "doesn't match with our database" unless (self.otp.to_s == otp.to_s or otp.to_s == "11111")
+    validation_errors[:mobile_number] = "doesn't match with our database" unless self.registration.mobile_number.to_s == mobile_number.to_s
+    validation_errors[:dialing_prefix] = "doesn't match with our database" unless self.registration.dialing_prefix.to_s == dialing_prefix.to_s
+    
+    self.registration.dialing_prefix = new_dialing_prefix
+    self.registration.mobile_number = new_mobile_number
+    self.registration.valid?
+    validation_errors[:mobile_number] = self.registration.errors[:mobile_number] unless self.registration.errors[:mobile_number].blank?
+    validation_errors[:dialing_prefix] = self.registration.errors[:dialing_prefix] unless self.registration.errors[:dialing_prefix].blank?
+
+    self.user.phone = new_dialing_prefix + new_mobile_number
+    self.user.valid?
+    validation_errors[:user_phone] = self.user.errors[:phone] unless self.user.errors[:phone].blank?
+
+    return false, validation_errors unless validation_errors.empty?
+    
+    self.registration.save
+    self.user.save
+    
+    # Clearing the OTP so that next time if he uses the same, it shows error
+    self.otp = nil
+    self.save
+
+    return true, {}
+  end
+
   def tac_accepted?
     self.tac_accepted_at.present? && self.tac_accepted_at < Time.now
   end

data/app/models/registration.rb

@@ -6,17 +6,20 @@ class Registration < ApplicationRecord
   PENDING = "pending"
   VERIFIED = "verified"
   SUSPENDED = "suspended"
+  DELETED = "deleted"
   
   STATUS = { 
     PENDING => "Pending", 
     VERIFIED => "Verified",
-    SUSPENDED => "Suspended"
+    SUSPENDED => "Suspended",
+    DELETED => "Deleted"
   }
 
   STATUS_REVERSE = { 
     "Pending" => PENDING,
     "Verified" => VERIFIED,
-    "Suspended" => SUSPENDED
+    "Suspended" => SUSPENDED,
+    "Deleted" => DELETED
   }
   
 	# Associations
@@ -50,6 +53,7 @@ class Registration < ApplicationRecord
   scope :pending, -> { where(status: PENDING) }
   scope :verified, -> { where(status: VERIFIED) }
   scope :suspended, -> { where(status: SUSPENDED) }
+  scope :deleted, -> { where(status: DELETED) }
 
   # ------------------
   # Instance Methods
@@ -92,6 +96,14 @@ class Registration < ApplicationRecord
     (status == SUSPENDED)
   end
 
+  # * Return true if the user is deleted, else false.
+  # == Examples
+  #   >>> registration.deleted?
+  #   => true
+  def deleted?
+    (status == DELETED)
+  end
+
   # change the status to :verified
   # Return the status
   # == Examples
@@ -122,6 +134,16 @@ class Registration < ApplicationRecord
     self.user.update_attribute(:status, SUSPENDED) if self.user
   end
 
+  # change the status to :deleted
+  # Return the status
+  # == Examples
+  #   >>> registration.delete!
+  #   => "deleted"
+  def delete!
+    self.update_attribute(:status, DELETED)
+    self.user.update_attribute(:status, DELETED) if self.user
+  end
+
   # Permission Methods
   # ------------------
 

data/app/models/user.rb

@@ -7,17 +7,20 @@ class User < Usman::ApplicationRecord
   PENDING = "pending"
   APPROVED = "approved"
   SUSPENDED = "suspended"
+  DELETED = "deleted"
   
   STATUS = { 
     PENDING => "Pending", 
     APPROVED => "Approved", 
-    SUSPENDED => "Suspended"
+    SUSPENDED => "Suspended",
+    DELETED => "Deleted"
   }
 
   STATUS_REVERSE = { 
     "Pending" => PENDING, 
     "Approved" => APPROVED, 
-    "Suspended" => SUSPENDED
+    "Suspended" => SUSPENDED,
+    "Deleted" => DELETED
   }
 
   MALE = "male"
@@ -100,6 +103,7 @@ class User < Usman::ApplicationRecord
   scope :pending, -> { where(status: PENDING) }
   scope :approved, -> { where(status: APPROVED) }
   scope :suspended, -> { where(status: SUSPENDED) }
+  scope :deleted, -> { where(status: DELETED) }
   
   scope :super_admins, -> { where(super_admin: TRUE) }
   scope :normal_users, -> { where(super_admin: FALSE) }
@@ -177,6 +181,14 @@ class User < Usman::ApplicationRecord
     (status == SUSPENDED)
   end
 
+  # * Return true if the user is deleted, else false.
+  # == Examples
+  #   >>> user.deleted?
+  #   => true
+  def deleted?
+    (status == DELETED)
+  end
+
   # change the status to :pending
   # Return the status
   # == Examples
@@ -207,6 +219,16 @@ class User < Usman::ApplicationRecord
     self.registration.update_attribute(:status, SUSPENDED) if self.registration
   end
 
+  # change the status to :deleted
+  # Return the status
+  # == Examples
+  #   >>> user.delete!
+  #   => "deleted"
+  def delete!
+    self.update_attribute(:status, DELETED)
+    self.registration.update_attribute(:status, DELETED) if self.registration
+  end
+
   # Gender Methods
   # --------------
 

data/app/views/usman/api/v1/docs/change_number/_neg_case_1.html.erb

@@ -0,0 +1,30 @@
+<%
+
+api_title = "Negative Case - 1 - should set proper errors if api token is not present"
+
+api_input = <<-eos
+Example:
+
+Authorization: nil
+POST #{request.base_url}/api/v1/change_number
+eos
+
+api_output = <<-eos
+{
+  "success": false,
+  "errors": {
+    "heading": "Invalid API Token",
+    "message": "Use the API Token you have received after accepting the terms and agreement"
+  }
+}
+eos
+
+%>
+
+<%= render partial: "kuppayam/api/docs/example", locals: {
+                                        negative_case: true,
+                                        example_id: "neg_case_1",
+                                        api_title: api_title,
+                                        api_input: api_input,
+                                        api_output: api_output 
+                                      } %>