usman 0.3.26 → 0.3.27

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

@@ -0,0 +1,30 @@
+<%
+
+api_title = "Negative Case - 2 - should set proper errors if the profile didn't exist"
+
+api_input = <<-eos
+Example:
+
+Authorization: Token token="87b01adbba90824b57add8cc06ad8738"
+POST #{request.base_url}/api/v1/change_number
+eos
+
+api_output = <<-eos
+{
+  "success": false,
+  "errors": {
+    "heading": "A profile doesn't exists for the mobile number you have provided",
+    "message": "You are trying to u a profile once again when you already have a profile. Use Profile API with your API Token, to get your profile details and use them instead of creating a new one."
+  }
+}
+eos
+
+%>
+
+<%= render partial: "kuppayam/api/docs/example", locals: {
+                                        negative_case: true,
+                                        example_id: "neg_case_2",
+                                        api_title: api_title,
+                                        api_input: api_input,
+                                        api_output: api_output 
+                                      } %>

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

@@ -0,0 +1,40 @@
+<%
+
+api_title = "Negative Case - 3 - should respond with proper errors if OTP is invalid"
+
+api_input = <<-eos
+Example:
+
+POST #{request.base_url}/api/v1/change_number
+{
+  "otp": "<INVALID OTP>",
+  "uuid": "asd907asdba78sbda",
+  "old_dialing_prefix": "<OLD DIALING PREFIX>",
+  "old_mobile_number": "<OLD MOBILE NUMBER>",
+  "new_dialing_prefix": "<NEW DIALING PREFIX>",
+  "new_mobile_number": "<NEW MOBILE NUMBER>"
+}
+eos
+
+api_output = <<-eos
+{
+  "success": false,
+  "errors": {
+      "heading": "The device is not registered",
+      "message": "Check if the UUID entered is valid",
+      "details": {
+        "uuid": "is invalid"
+      }
+  }
+}
+eos
+
+%>
+
+<%= render partial: "kuppayam/api/docs/example", locals: {
+                                        negative_case: true,
+                                        example_id: "neg_case_3",
+                                        api_title: api_title,
+                                        api_input: api_input,
+                                        api_output: api_output 
+                                      } %>

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

@@ -0,0 +1,42 @@
+<%
+
+api_title = "Negative Case - 4 - should respond with proper errors if invalid UUID is passed"
+
+api_input = <<-eos
+Invalid UUID means, the device you are using to send request is not registered.
+
+Example:
+
+POST #{request.base_url}/api/v1/change_number
+{
+  "otp": "81242",
+  "uuid": "<INVALID UUID>",
+  "old_dialing_prefix": "<OLD DIALING PREFIX>",
+  "old_mobile_number": "<OLD MOBILE NUMBER>",
+  "new_dialing_prefix": "<NEW DIALING PREFIX>",
+  "new_mobile_number": "<NEW MOBILE NUMBER>"
+}
+eos
+
+api_output = <<-eos
+{
+  "success": false,
+  "errors": {
+      "heading": "The device is not registered",
+      "message": "Check if the UUID entered is valid",
+      "details": {
+        "uuid": "is invalid"
+      }
+  }
+}
+eos
+
+%>
+
+<%= render partial: "kuppayam/api/docs/example", locals: {
+                                        negative_case: true,
+                                        example_id: "neg_case_4",
+                                        api_title: api_title,
+                                        api_input: api_input,
+                                        api_output: api_output 
+                                      } %>

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

@@ -0,0 +1,40 @@
+<%
+
+api_title = "Negative Case - 5 - should respond with proper errors if old dialing prefix and mobile number doesn't match with that in the system"
+
+api_input = <<-eos
+Example:
+
+POST #{request.base_url}/api/v1/change_number
+{
+  "otp": "81242",
+  "uuid": "asd907asdba78sbda",
+  "old_dialing_prefix": "<INVALID OLD DIALING PREFIX>",
+  "old_mobile_number": "<INVALID OLD MOBILE NUMBER>",
+  "new_dialing_prefix": "<NEW DIALING PREFIX>",
+  "new_mobile_number": "<NEW MOBILE NUMBER>"
+}
+eos
+
+api_output = <<-eos
+{
+  "success": false,
+  "errors": {
+      "heading": "Mobile number change failed",
+      "message": "Check if all the inputs are valid",
+      "details": {
+        "uuid": "is invalid"
+      }
+  }
+}
+eos
+
+%>
+
+<%= render partial: "kuppayam/api/docs/example", locals: {
+                                        negative_case: true,
+                                        example_id: "neg_case_5",
+                                        api_title: api_title,
+                                        api_input: api_input,
+                                        api_output: api_output 
+                                      } %>

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

@@ -0,0 +1,40 @@
+<%
+
+api_title = "Negative Case - 6 - should respond with proper errors if new dialign prefix and mobile number are missing"
+
+api_input = <<-eos
+Example:
+
+POST #{request.base_url}/api/v1/change_number
+{
+  "otp": "81242",
+  "uuid": "asd907asdba78sbda",
+  "old_dialing_prefix": "<OLD DIALING PREFIX>",
+  "old_mobile_number": "<OLD MOBILE NUMBER>",
+  "new_dialing_prefix": "<INVALID NEW DIALING PREFIX>",
+  "new_mobile_number": "<INVALID NEW MOBILE NUMBER>"
+}
+eos
+
+api_output = <<-eos
+{
+  "success": false,
+  "errors": {
+      "heading": "Mobile number change failed",
+      "message": "Check if all the inputs are valid",
+      "details": {
+        "uuid": "is invalid"
+      }
+  }
+}
+eos
+
+%>
+
+<%= render partial: "kuppayam/api/docs/example", locals: {
+                                        negative_case: true,
+                                        example_id: "neg_case_6",
+                                        api_title: api_title,
+                                        api_input: api_input,
+                                        api_output: api_output 
+                                      } %>

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

@@ -0,0 +1,38 @@
+<%
+
+api_title = "Negative Case - 7 - should respond with proper errors if the device is blocked"
+
+api_input = <<-eos
+Example:
+
+POST #{request.base_url}/api/v1/change_number
+{
+  "otp": "81242",
+  "uuid": "<BLOCKED DEVICE UUID>",
+  "old_dialing_prefix": "<OLD DIALING PREFIX>",
+  "old_mobile_number": "<OLD MOBILE NUMBER>",
+  "new_dialing_prefix": "<INVALID NEW DIALING PREFIX>",
+  "new_mobile_number": "<INVALID NEW MOBILE NUMBER>"
+}
+eos
+
+api_output = <<-eos
+{
+  "success": false,
+  "errors": {
+      "heading": "This device is blocked",
+      "message": "You must have done some mal-practices",
+      "details": {}
+  }
+}
+eos
+
+%>
+
+<%= render partial: "kuppayam/api/docs/example", locals: {
+                                        negative_case: true,
+                                        example_id: "neg_case_7",
+                                        api_title: api_title,
+                                        api_input: api_input,
+                                        api_output: api_output 
+                                      } %>

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

@@ -0,0 +1,37 @@
+<%
+
+api_title = "Positive Case - 1 - should change the number"
+
+api_input = <<-eos
+Example:
+
+POST #{request.base_url}/api/v1/change_number
+{
+  "otp": "81242",
+  "uuid": "asd907asdba78sbda",
+  "old_dialing_prefix": "<OLD DIALING PREFIX>",
+  "old_mobile_number": "<OLD MOBILE NUMBER>",
+  "new_dialing_prefix": "<NEW DIALING PREFIX>",
+  "new_mobile_number": "<NEW MOBILE NUMBER>"
+}
+eos
+
+api_output = <<-eos
+{
+  "success": true,
+  "alert": {
+      "heading": "Your mobile number has been changed successfully",
+      "message": "Use the new number to login next time"
+  }
+}
+eos
+
+%>
+
+<%= render partial: "kuppayam/api/docs/example", locals: {
+                                        negative_case: false,
+                                        example_id: "pos_case_1",
+                                        api_title: api_title,
+                                        api_input: api_input,
+                                        api_output: api_output 
+                                      } %>

data/app/views/usman/api/v1/docs/delete_account/_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
+DELETE #{request.base_url}/api/v1/delete_account
+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 
+                                      } %>

data/app/views/usman/api/v1/docs/delete_account/_neg_case_2.html.erb

@@ -0,0 +1,30 @@
+<%
+
+api_title = "Negative Case - 2 - should set proper errors if the profile didn't exist"
+
+api_input = <<-eos
+Example:
+
+Authorization: Token token="87b01adbba90824b57add8cc06ad8738"
+DELETE #{request.base_url}/api/v1/delete_account
+eos
+
+api_output = <<-eos
+{
+  "success": false,
+  "errors": {
+    "heading": "A profile doesn't exists for the mobile number you have provided",
+    "message": "You are trying to u a profile once again when you already have a profile. Use Profile API with your API Token, to get your profile details and use them instead of creating a new one."
+  }
+}
+eos
+
+%>
+
+<%= render partial: "kuppayam/api/docs/example", locals: {
+                                        negative_case: true,
+                                        example_id: "neg_case_2",
+                                        api_title: api_title,
+                                        api_input: api_input,
+                                        api_output: api_output 
+                                      } %>

data/app/views/usman/api/v1/docs/delete_account/_pos_case_1.html.erb

@@ -0,0 +1,29 @@
+<%
+
+api_title = "Positive Case - 1 - delete the account"
+
+api_input = <<-eos
+Example:
+
+DELETE #{request.base_url}/api/v1/delete_account
+eos
+
+api_output = <<-eos
+{
+  "success": true,
+  "alert": {
+      "heading": "Your account has been deleted successfully",
+      "message": "You will be logged out from all sessions"
+  }
+}
+eos
+
+%>
+
+<%= render partial: "kuppayam/api/docs/example", locals: {
+                                        negative_case: false,
+                                        example_id: "pos_case_1",
+                                        api_title: api_title,
+                                        api_input: api_input,
+                                        api_output: api_output 
+                                      } %>

data/app/views/usman/api/v1/docs/send_otp_to_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/send_otp_to_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 
+                                      } %>

data/app/views/usman/api/v1/docs/send_otp_to_change_number/_neg_case_2.html.erb

@@ -0,0 +1,30 @@
+<%
+
+api_title = "Negative Case - 2 - should set proper errors if the profile didn't exist"
+
+api_input = <<-eos
+Example:
+
+Authorization: Token token="87b01adbba90824b57add8cc06ad8738"
+POST #{request.base_url}/api/v1/send_otp_to_change_number
+eos
+
+api_output = <<-eos
+{
+  "success": false,
+  "errors": {
+    "heading": "A profile doesn't exists for the mobile number you have provided",
+    "message": "You are trying to u a profile once again when you already have a profile. Use Profile API with your API Token, to get your profile details and use them instead of creating a new one."
+  }
+}
+eos
+
+%>
+
+<%= render partial: "kuppayam/api/docs/example", locals: {
+                                        negative_case: true,
+                                        example_id: "neg_case_2",
+                                        api_title: api_title,
+                                        api_input: api_input,
+                                        api_output: api_output 
+                                      } %>

data/app/views/usman/api/v1/docs/send_otp_to_change_number/_neg_case_3.html.erb

@@ -0,0 +1,35 @@
+<%
+
+api_title = "Negative Case - 3 - should respond with proper errors if no parameters are passed"
+
+api_input = <<-eos
+Example:
+
+POST #{request.base_url}/api/v1/send_otp_to_change_number
+{
+  "uuid": ""
+}
+eos
+
+api_output = <<-eos
+{
+  "success": false,
+  "errors": {
+      "heading": "The device is not registered",
+      "message": "Check if the UUID entered is valid",
+      "details": {
+        "uuid": "is invalid"
+      }
+  }
+}
+eos
+
+%>
+
+<%= render partial: "kuppayam/api/docs/example", locals: {
+                                        negative_case: true,
+                                        example_id: "neg_case_3",
+                                        api_title: api_title,
+                                        api_input: api_input,
+                                        api_output: api_output 
+                                      } %>

data/app/views/usman/api/v1/docs/send_otp_to_change_number/_neg_case_4.html.erb

@@ -0,0 +1,33 @@
+<%
+
+api_title = "Negative Case - 4 - should respond with proper errors if the device is blocked"
+
+api_input = <<-eos
+Example:
+
+POST #{request.base_url}/api/v1/send_otp_to_change_number
+{
+  "uuid": "<BLOCKED DEVICE UUID>"
+}
+eos
+
+api_output = <<-eos
+{
+  "success": false,
+  "errors": {
+      "heading": "This device is blocked",
+      "message": "You must have done some mal-practices",
+      "details": {}
+  }
+}
+eos
+
+%>
+
+<%= render partial: "kuppayam/api/docs/example", locals: {
+                                        negative_case: true,
+                                        example_id: "neg_case_4",
+                                        api_title: api_title,
+                                        api_input: api_input,
+                                        api_output: api_output 
+                                      } %>

data/app/views/usman/api/v1/docs/send_otp_to_change_number/_pos_case_1.html.erb

@@ -0,0 +1,32 @@
+<%
+
+api_title = "Positive Case - 1 - should resend the otp for valid inputs"
+
+api_input = <<-eos
+Example:
+
+POST #{request.base_url}/api/v1/send_otp_to_change_number
+{
+  "uuid": "asd907asdba78sbda"
+}
+eos
+
+api_output = <<-eos
+{
+  "success": true,
+  "alert": {
+      "heading": "An OTP has been sent to you",
+      "message": "Check your mobile for new message from us"
+  }
+}
+eos
+
+%>
+
+<%= render partial: "kuppayam/api/docs/example", locals: {
+                                        negative_case: false,
+                                        example_id: "pos_case_1",
+                                        api_title: api_title,
+                                        api_input: api_input,
+                                        api_output: api_output 
+                                      } %>

data/config/locales/usman/api.ar.yml

@@ -1,13 +1,22 @@
 en:
   api:
     general:
+      unexpected_error:
+        heading: "Unexpected Error"
+        message: "Please try after sometime. If the problem persist, please contact our technical support."
       permission_denied:
         heading: "Invalid API Token"
         message: "Use the API Token you have received after accepting the terms and agreement"
-    register:
       device_blocked:
         heading: "This device is blocked"
         message: "You must have done some mal-practices"
+      mobile_number_not_registered:
+        heading: "The mobile number is not registered"
+        message: "Check if the mobile number entered is valid"
+      device_not_registered:
+        heading: "The device is not registered"
+        message: "Check if the UUID entered is valid"
+    register:
       otp_sent:
         heading: "An OTP has been sent to you"
         message: "Check your mobile for new message from us"
@@ -18,9 +27,6 @@ en:
         heading: "Registring new mobile number FAILED"
         message: "Check if all mandatory details are passed. Refer the error details for technical information"
     resend_otp:
-      device_blocked:
-        heading: "This device is blocked"
-        message: "You must have done some mal-practices"
       new_otp_sent:
         heading: "An new OTP has been sent to you"
         message: "Check your mobile for new message from us"
@@ -30,28 +36,13 @@ en:
       otp_not_matching:
         heading: "OTP verification was failed"
         message: "Make sure that you enter the OTP correctly"
-      mobile_number_not_registered:
-        heading: "The mobile number is not registered"
-        message: "Resending OTP Failed. Check if the mobile number entered is valid"
-      device_not_registered:
-        heading: "The device is not registered"
-        message: "Resending OTP Failed. Check if the UUID entered is valid"
     verify_otp:
-      device_blocked:
-        heading: "This device is blocked"
-        message: "You must have done some mal-practices"
       device_verified:
         heading: "OTP sent failed"
         message: "This device may be already verified"
       otp_not_matching:
         heading: "OTP verification was failed"
         message: "Make sure that you enter the OTP correctly"
-      mobile_number_not_registered:
-        heading: "The mobile number is not registered"
-        message: "Verifying OTP Failed. Check if the mobile number entered is valid"
-      device_not_registered:
-        heading: "The device is not registered"
-        message: "Verifying OTP Failed. Check if the UUID entered is valid"
       verification_failed:
         heading: "OTP verification was failed"
         message: "Check if you have properly given the OTP along with dialing prefix, mobile number & UUID"
@@ -65,19 +56,34 @@ en:
       tac_not_accepted:
         heading: "You have not accepted the Terms & Conditions. Registration is complete only if you accept the T&C"
         message: "Accept the T&C to finish the Registration. Pass true"
-      device_blocked:
-        heading: "This device is blocked"
-        message: "You must have done some mal-practices"
       device_pending:
         heading: "This device is not verified"
         message: "You need to verify this device before you can accept the terms and conditions"
-      mobile_number_not_registered:
-        heading: "The mobile number is not registered"
-        message: "Accepting T&C Failed. Check if the mobile number entered is valid"
-      device_not_registered:
-        heading: "The device is not registered"
-        message: "Accepting T&C Failed. Check if the UUID entered is valid"
+    send_otp_to_change_number:
+      otp_send:
+        heading: "An OTP has been sent to you"
+        message: "Check your mobile for new message from us"
+      otp_send_failed:
+        heading: "OTP sent failed"
+        message: "Check if all the inputs are valid"
+    change_number:
+      number_changed:
+        heading: "Your mobile number has been changed successfully"
+        message: "Use the new number to login next time"
+      number_change_failed:
+        heading: "Mobile number change failed"
+        message: "Check if all the inputs are valid"
+    delete_account:
+      account_deleted:
+        heading: "Your account has been deleted successfully"
+        message: "You will be logged out from all sessions"
+      account_deletion_failed:
+        heading: "Mobile number change failed"
+        message: "Check if all the inputs are valid"
     profile:
+      registration_details_missing:
+        heading: "A profile already exists for the mobile number you have provided"
+        message: "You are trying to create a profile once again when you already have a profile. Use Profile API with your API Token, to get your profile details and use them instead of creating a new one."
       user_already_exists:
         heading: "A profile already exists for the mobile number you have provided"
         message: "You are trying to create a profile once again when you already have a profile. Use Profile API with your API Token, to get your profile details and use them instead of creating a new one."
@@ -89,4 +95,27 @@ en:
         message: "You may access the profile API with API token to get the profile details in future"
       invalid_inputs:
         heading: "Saving Profile Failed"
-        message: "Check if all mandatory details are passed. Refer the error details for technical information"
+        message: "Check if all mandatory details are passed. Refer the error details for technical information"
+    profile_picture:
+      not_found:
+        heading: "Invalid User/Profile ID"
+        message: "Pass a vaild User/Profile ID to get the details. Get Profile Details along with their IDs from Profile API or from Registration APIs"
+      image_save_failed:
+        heading: "Saving user/profile image was failed"
+        message: "Make sure that the arguments are passed according to the API documentation. Please check the API Documentation for more details."
+      image_delete_failed:
+        heading: "Deleting user/profile image was failed"
+        message: "Make sure that the arguments are passed according to the API documentation. Please check the API Documentation for more details."
+      image_saved:
+        heading: "User/Profile Image was saved successfully"
+        message: "You may now use the URL to download the image in future"
+      image_deleted:
+        heading: "User/Profile Image was deleted successfully"
+        message: "You may use Profile Picture Upload API to add one again"
+      profile_picture_does_not_exists:
+        heading: "Profile Picture doesn't exists"
+        message: "You are trying to destroy a profile picture when it doesn't exist"
+    contacts:
+      synced_successfully:
+        heading: "The Contacts has been synced successfully"
+        message: "You may now store the done deal user id of these contacts returned in this response"