usman 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da4ef048a641f75ac91c9ebcb697cd43c6f7fd9b
-  data.tar.gz: 53085820d81ef576b6b40b3a753d0d18fb40e039
+  metadata.gz: b328d5adedffe89ca1e6f3665b2ada43b96a3a9c
+  data.tar.gz: 1c712a7a5f0a5f3f730e8e42ac8e4cfd9838ebd2
 SHA512:
-  metadata.gz: 1df87664bbe20cc17acf9814461719b98b4d74a2748faa9f3a0b9f0cc7cc20af53970c84043642310a87f797a1fb17c678d7738f2c018476c76212b3796a6aec
-  data.tar.gz: 1bb119d7386e8429368050aef3cf5c2463bc79a4b593546fc451ed110da28ee32f8d4ced1fb59dd990973d5c718198377cb4f08ac24c1dfae516061026be7a9e
+  metadata.gz: b19106c8878d4b6455a8b540524134e75e472eb5f9960cc74ec8804580534ea57fbc7733b2ff93758f6d8baff57fb9fbca9daa2b105cc0a00e8ae28573fc9b5f
+  data.tar.gz: 29b01c733ecbd10d70204ca17c9b2975eb54eccc2a59db161c2f48242567b8a20f536e853598d6fa16bafd844c963325b07336de51b61910adc888c4e1522aa5

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

@@ -7,7 +7,11 @@ module Usman
           set_title("Register API")
           @request_type = "POST"
           @end_point = "/api/v1/register"
-          @description = "This API will register the user and the device and will send an OTP for verification. API will return the api_token if the device is already registered."
+          @description = <<-eos
+          This API will register the user and the device and will send an OTP for verification. <br>
+          This API can also be used for user login.  <br>
+          If the user is already registered, verifying the OTP will get the user logged in (return API token)
+          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. " }
@@ -38,7 +42,9 @@ module Usman
           set_title("Resend OTP API")
           @request_type = "POST"
           @end_point = "/api/v1/resend_otp"
-          @description = "This API will resend the OTP for verification"
+          @description = <<-eos
+          This API will resend the OTP for verification
+          eos
 
           @warning = "A maximum of 3 attempt is allowed for resending the OTP. 6th request will block the device."
           
@@ -64,7 +70,11 @@ module Usman
           set_title("Verify OTP API")
           @request_type = "POST"
           @end_point = "/api/v1/verify_otp"
-          @description = "This API verify the OTP and returns the API token for further communication"
+          @description = <<-eos
+          This API verify the OTP.  <br>
+          It will return the API token for further communication if the user & device has already been registered. <br>
+          If not, API token is returned in the positive response of Accpet T&C API
+          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. " }
@@ -89,7 +99,10 @@ module Usman
           set_title("Accept T&C API")
           @request_type = "POST"
           @end_point = "/api/v1/accept_tac"
-          @description = "This API record the acceptance of the terms and condition."
+          @description = <<-eos
+          This API record the acceptance of the terms and condition and will finish the registration of user & device. <br>
+          It will return API token which can be used for further communication.
+          eos
           
           @info = "The user will have to accept terms and conditions everytime he registers a new device"
           
@@ -115,7 +128,9 @@ module Usman
           set_title("Create Profile API")
           @request_type = "POST"
           @end_point = "/api/v1/create_profile"
-          @description = "This API will create a profile for a newly registered user"
+          @description = <<-eos
+          This API will create a profile for a newly registered user
+          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. " },
@@ -140,7 +155,10 @@ module Usman
           set_title("Update Profile API")
           @request_type = "POST"
           @end_point = "/api/v1/update_profile"
-          @description = "This API will update the profile details"
+          @description = <<-eos
+          This API will update the profile details. <br>
+          Note the the user id is not passed but the API token in header.
+          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. " },
@@ -161,11 +179,13 @@ module Usman
           render 'kuppayam/api/docs/show'
         end
 
-        def profile
-          set_title("Profile API")
+        def get_profile_info
+          set_title("Get Profile Info API")
           @request_type = "GET"
-          @end_point = "/api/v1/profile/base64_profile_picture"
-          @description = "This API will return the details of the profile requested including image urls."
+          @end_point = "/api/v1/profile_info"
+          @description = <<-eos
+          This API will return the details of the profile requested including profile picture urls
+          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. " },
@@ -177,16 +197,21 @@ module Usman
           @example_path = "usman/api/v1/docs/"
           @examples = ["pos_case_1", "neg_case_1", "neg_case_2"]
 
-          set_nav("docs/profile")
+          set_nav("docs/get_profile_info")
 
           render 'kuppayam/api/docs/show'
         end
 
-        def base64_profile_picture
+        def upload_profile_picture_base64
           set_title("Upload Profile Picture API (base64)")
           @request_type = "POST"
-          @end_point = "/api/v1/profile/base64_profile_picture"
-          @description = "This API will return the details of the profile requested including image urls."
+          @end_point = "/api/v1/profile/profile_picture_base64"
+          @description = <<-eos
+          This APi will upload an image to a profile and will set it as the profile picture. <br>
+          It accept an image embeded in a json with base64 encoding.
+          eos
+
+          @warning = "The image has to be base64 encoded."
 
           @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. " },
@@ -198,16 +223,19 @@ module Usman
           @example_path = "usman/api/v1/docs/"
           @examples = ["pos_case_1", "neg_case_1", "neg_case_2"]
 
-          set_nav("docs/base64_profile_picture")
+          set_nav("docs/upload_profile_picture_base64")
 
           render 'kuppayam/api/docs/show'
         end
 
-        def profile_picture
+        def upload_profile_picture
           set_title("Upload Profile Picture API")
           @request_type = "POST"
-          @end_point = "/api/v1/profile/profile_picture"
-          @description = "This API will return the details of the profile requested including image urls."
+          @end_point = "/api/v1/profile/upload_profile_picture"
+          @description = <<-eos
+          This APi will upload an image to a profile and will set it as the profile picture. <br>
+          It accept an image in binary format
+          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. " },
@@ -224,11 +252,13 @@ module Usman
           render 'kuppayam/api/docs/show'
         end
 
-        def destroy_profile_picture
+        def delete_profile_picture
           set_title("Delete Profile Picture API")
           @request_type = "DELETE"
-          @end_point = "/api/v1/profile"
-          @description = "This API will return the details of the profile requested including image urls."
+          @end_point = "/api/v1/profile/profile_picture"
+          @description = <<-eos
+          This API will delete the profile picture
+          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. " },
@@ -240,7 +270,7 @@ module Usman
           @example_path = "usman/api/v1/docs/"
           @examples = ["pos_case_1", "neg_case_1", "neg_case_2", "neg_case_3"]
 
-          set_nav("docs/destroy_profile_picture")
+          set_nav("docs/delete_profile_picture")
 
           render 'kuppayam/api/docs/show'
         end

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

@@ -112,7 +112,7 @@ module Usman
           render_json_response(proc_code)
         end
 
-        def profile
+        def profile_info
           proc_code = Proc.new do
             if @current_registration
               unless @current_user

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

@@ -5,7 +5,7 @@ module Usman
 
 				include ImageUploaderHelper
 
-				def base64_profile_picture
+				def profile_picture_base64
 					proc_code = Proc.new do
 						if @current_registration
               unless @current_user

data/app/views/kuppayam/api/docs/_navigation.html.erb

@@ -35,26 +35,26 @@
       <span class="hidden-xs">Update Profile</span>
     </a>
   </li>
-  <li class="<%= nav_active?('docs/profile') ? 'active' : ''  %>">
-    <a href="/docs/api/v1/profile">
+  <li class="<%= nav_active?('docs/get_profile_info') ? 'active' : ''  %>">
+    <a href="/docs/api/v1/get_profile_info">
       <i class="fa-globe visible-xs"></i>
-      <span class="hidden-xs">Profile</span>
+      <span class="hidden-xs">Get Profile Info</span>
     </a>
   </li>
-  <li class="<%= nav_active?('docs/base64_profile_picture') ? 'active' : ''  %>">
-    <a href="/docs/api/v1/base64_profile_picture">
+  <li class="<%= nav_active?('docs/upload_profile_picture_base64') ? 'active' : ''  %>">
+    <a href="/docs/api/v1/upload_profile_picture_base64">
       <i class="fa-globe visible-xs"></i>
       <span class="hidden-xs">Upload Profile Picture (Base64)</span>
     </a>
   </li>
-  <li class="<%= nav_active?('docs/profile_picture') ? 'active' : ''  %>">
-    <a href="/docs/api/v1/profile_picture">
+  <li class="<%= nav_active?('docs/upload_profile_picture') ? 'active' : ''  %>">
+    <a href="/docs/api/v1/upload_profile_picture">
       <i class="fa-globe visible-xs"></i>
       <span class="hidden-xs">Upload Profile Picture</span>
     </a>
   </li>
-  <li class="<%= nav_active?('docs/destroy_profile_picture') ? 'active' : ''  %>">
-    <a href="/docs/api/v1/destroy_profile_picture">
+  <li class="<%= nav_active?('docs/delete_profile_picture') ? 'active' : ''  %>">
+    <a href="/docs/api/v1/delete_profile_picture">
       <i class="fa-globe visible-xs"></i>
       <span class="hidden-xs">Delete Profile Picture</span>
     </a>

data/app/views/layouts/kuppayam/_sidebar.html.erb

@@ -96,6 +96,14 @@
 			</li>
 			<% end %>
 
+			<!-- Documentation -->
+			<li class="<%= nav_active?('docs/index') ? 'active' : ''  %>">
+				<a href="/docs/api/v1/register">
+		      <i class="fa-file-code-o"></i>
+		      <span class="title">Documentation</span>
+		    </a>
+			</li>
+
 		</ul>
 		
 	</div>

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

@@ -3,6 +3,12 @@
 api_title = "Negative Case - 1 - should not accept the terms and conditions if the device is not verified"
 
 api_input = <<-eos
+Example:
+
+POST #{request.base_url}/api/v1/accept_tac
+
+In the request body, pass the following as raw json:
+
 {
   "terms_and_conditions": 1,
   "uuid": "<PENDING UUID>",

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

@@ -3,6 +3,11 @@
 api_title = "Negative Case - 2 - should respond with proper errors if no params are passed"
 
 api_input = <<-eos
+Example:
+
+POST #{request.base_url}/api/v1/accept_tac
+
+In the request body, pass the following as raw json:
 {}
 eos
 

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

@@ -3,6 +3,11 @@
 api_title = "Negative Case - 3 - should respond with proper errors if T&C is not accepted"
 
 api_input = <<-eos
+Example:
+
+POST #{request.base_url}/api/v1/accept_tac
+
+In the request body, pass the following as raw json:
 {
   "terms_and_conditions": 0,
   "uuid": "<VERIFIED UUID>",

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

@@ -3,6 +3,12 @@
 api_title = "Positive Case - 1 - should accept the terms and conditions if the device is verified and all inputs are valid"
 
 api_input = <<-eos
+Example:
+
+POST #{request.base_url}/api/v1/accept_tac
+
+In the request body, pass the following as raw json:
+
 {
   "terms_and_conditions": 1,
   "uuid": "<VERIFIED UUID>",

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

@@ -3,6 +3,10 @@
 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/create_profile
 {
   "name": "Name",
   "gender": "male",

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

@@ -3,6 +3,10 @@
 api_title = "Negative Case - 2 - should set proper errors if the profile already exists"
 
 api_input = <<-eos
+Example:
+
+Authorization: Token token="87b01adbba90824b57add8cc06ad8738"
+POST #{request.base_url}/api/v1/create_profile
 {
   "name": "Name",
   "gender": "male",

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

@@ -3,6 +3,10 @@
 api_title = "Negative Case - 3 - should set proper errors if the inputs are not correct"
 
 api_input = <<-eos
+Example:
+
+Authorization: Token token="87b01adbba90824b57add8cc06ad8738"
+POST #{request.base_url}/api/v1/create_profile
 {}
 eos
 

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

@@ -3,6 +3,10 @@
 api_title = "Positive Case - 1 - should create the profile"
 
 api_input = <<-eos
+Example:
+
+Authorization: Token token="87b01adbba90824b57add8cc06ad8738"
+POST #{request.base_url}/api/v1/create_profile
 {
   "name": "Name",
   "gender": "male",

data/app/views/usman/api/v1/docs/{base64_profile_picture → delete_profile_picture}/_neg_case_1.html.erb

@@ -3,6 +3,10 @@
 api_title = "Negative Case - 1 - should set proper errors if no api token"
 
 api_input = <<-eos
+Example:
+
+Authorization: nil
+DELETE #{request.base_url}/api/v1/profile/profile_picture
 {}
 eos
 

data/app/views/usman/api/v1/docs/{destroy_profile_picture → delete_profile_picture}/_neg_case_2.html.erb

@@ -3,6 +3,10 @@
 api_title = "Negative Case - 2 - should set proper errors if the profile doesn't exists"
 
 api_input = <<-eos
+Example:
+
+Authorization: Token token="87b01adbba90824b57add8cc06ad8738"
+DELETE #{request.base_url}/api/v1/profile/profile_picture
 {}
 eos
 

data/app/views/usman/api/v1/docs/{destroy_profile_picture → delete_profile_picture}/_pos_case_1.html.erb

@@ -3,6 +3,10 @@
 api_title = "Positive Case - 1 - should delete a profile picture for a user"
 
 api_input = <<-eos
+Example:
+
+Authorization: Token token="87b01adbba90824b57add8cc06ad8738"
+DELETE #{request.base_url}/api/v1/profile/profile_picture
 {}
 eos
 

data/app/views/usman/api/v1/docs/{profile → get_profile_info}/_neg_case_1.html.erb

@@ -3,14 +3,10 @@
 api_title = "Negative Case - 1 - should set proper errors if api token is not present"
 
 api_input = <<-eos
-{
-  "name": "Name",
-  "gender": "male",
-  "date_of_birth": "10/10/1980",
-  "email": "name@domain.com",
-  "country_id": "1",
-  "city_id": "2"
-}
+Example:
+
+Authorization: nil
+GET #{request.base_url}/api/v1/profile/profile_picture
 eos
 
 api_output = <<-eos

data/app/views/usman/api/v1/docs/{profile → get_profile_info}/_neg_case_2.html.erb

@@ -3,7 +3,10 @@
 api_title = "Negative Case - 2 - should set proper errors if the profile didn't exist"
 
 api_input = <<-eos
-{}
+Example:
+
+Authorization: Token token="87b01adbba90824b57add8cc06ad8738"
+GET #{request.base_url}/api/v1/profile/profile_picture
 eos
 
 api_output = <<-eos

data/app/views/usman/api/v1/docs/{profile → get_profile_info}/_pos_case_1.html.erb

@@ -3,7 +3,10 @@
 api_title = "Positive Case - 1 - should return the profile details along with picture"
 
 api_input = <<-eos
-{}
+Example:
+
+Authorization: Token token="87b01adbba90824b57add8cc06ad8738"
+GET #{request.base_url}/api/v1/profile/profile_picture
 eos
 
 api_output = <<-eos

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

@@ -3,6 +3,9 @@
 api_title = "Negative Case - 1 - should set proper errors if no input is given"
 
 api_input = <<-eos
+Example:
+
+POST #{request.base_url}/api/v1/register
 {}
 eos
 

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

@@ -3,6 +3,9 @@
 api_title = "Negative Case - 2 - should set proper errors when device information is missing"
 
 api_input = <<-eos
+Example:
+
+POST #{request.base_url}/api/v1/register
 {
   "country_id": "1",
   "dialing_prefix": "+92",

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

@@ -3,6 +3,9 @@
 api_title = "Negative Case - 3 - should set proper errors when registration information is missing"
 
 api_input = <<-eos
+Example:
+
+POST #{request.base_url}/api/v1/register
 {
   "uuid": "jh01u2g01h301h21h23",
   "device_token": "0182y3b28107b31",

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

@@ -3,6 +3,9 @@
 api_title = "Negative Case - 4 - should set proper errors for device is blocked"
 
 api_input = <<-eos
+Example:
+
+POST #{request.base_url}/api/v1/register
 {
   "uuid": "<BLOCKED DEVICE UUID>",
   "device_token": "<BLOCKED DEVICE DEVICE TOKEN>",

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

@@ -3,6 +3,9 @@
 api_title = "Positive Case - 1 - should register and add a new device"
 
 api_input = <<-eos
+Example:
+
+POST #{request.base_url}/api/v1/register
 {
   "country_id": "1",
   "city_id": "2",

data/app/views/usman/api/v1/docs/register/_pos_case_2.html.erb

@@ -3,6 +3,9 @@
 api_title = "Positive Case - 2 - should register and reuse an existing registration information"
 
 api_input = <<-eos
+Example:
+
+POST #{request.base_url}/api/v1/register
 {
   "country_id": "1",
   "city_id": "2",

data/app/views/usman/api/v1/docs/register/_pos_case_3.html.erb

@@ -3,6 +3,9 @@
 api_title = "Positive Case - 3 - should register and reuse an existing registration & device information"
 
 api_input = <<-eos
+Example:
+
+POST #{request.base_url}/api/v1/register
 {
   "country_id": "1",
   "city_id": "2",

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

@@ -3,6 +3,9 @@
 api_title = "Negative Case - 1 - should respond with proper errors if no parameters are passed"
 
 api_input = <<-eos
+Example:
+
+POST #{request.base_url}/api/v1/resend_otp
 {}
 eos
 

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

@@ -3,6 +3,9 @@
 api_title = "Negative Case - 2 - should respond with proper errors if mobile number is not registered"
 
 api_input = <<-eos
+Example:
+
+POST #{request.base_url}/api/v1/resend_otp
 {
   "dialing_prefix": "+91",
   "mobile_number": "<NEW MOBILE NUMBER>",

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

@@ -3,6 +3,9 @@
 api_title = "Negative Case - 3 - should respond with proper errors if uuid is not registered"
 
 api_input = <<-eos
+Example:
+
+POST #{request.base_url}/api/v1/resend_otp
 {
   "dialing_prefix": "+91",
   "mobile_number": "<REGISTERED MOBILE NUMBER>",

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

@@ -3,6 +3,9 @@
 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/resend_otp
 {
   "dialing_prefix": "+91",
   "mobile_number": "<REGISTERED MOBILE NUMBER>",

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

@@ -3,6 +3,9 @@
 api_title = "Positive Case - 1 - should resend the otp for valid inputs"
 
 api_input = <<-eos
+Example:
+
+POST #{request.base_url}/api/v1/resend_otp
 {
   "uuid": "asd907asdba78sbda",
   "mobile_number": "292991230",

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

@@ -3,6 +3,10 @@
 api_title = "Negative Case - 1 - should set proper errors if api token is not present"
 
 api_input = <<-eos
+Example:
+
+Authorization: nil
+PUT #{request.base_url}/api/v1/update_profile
 {
   "name": "Name",
   "gender": "male",

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

@@ -3,6 +3,10 @@
 api_title = "Negative Case - 2 - should set proper errors if the profile doesn't exist"
 
 api_input = <<-eos
+Example:
+
+Authorization: Token token="87b01adbba90824b57add8cc06ad8738"
+PUT #{request.base_url}/api/v1/update_profile
 {}
 eos
 

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

@@ -3,6 +3,10 @@
 api_title = "Negative Case - 3 - should set proper errors if the inputs are not correct"
 
 api_input = <<-eos
+Example:
+
+Authorization: Token token="87b01adbba90824b57add8cc06ad8738"
+PUT #{request.base_url}/api/v1/update_profile
 {}
 eos
 

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

@@ -3,6 +3,10 @@
 api_title = "Positive Case - 1 - should create the profile"
 
 api_input = <<-eos
+Example:
+
+Authorization: Token token="87b01adbba90824b57add8cc06ad8738"
+PUT #{request.base_url}/api/v1/update_profile
 {
   "name": "Name",
   "gender": "male",

data/app/views/usman/api/v1/docs/{profile_picture → upload_profile_picture}/_neg_case_1.html.erb

@@ -3,7 +3,13 @@
 api_title = "Negative Case - 1 - should set proper errors if no api token"
 
 api_input = <<-eos
-{}
+Example:
+
+Authorization: nil
+POST #{request.base_url}/api/v1/profile/profile_picture
+{
+  "image": "<Uploaded File in Binary Format>"
+}
 eos
 
 api_output = <<-eos

data/app/views/usman/api/v1/docs/{base64_profile_picture → upload_profile_picture}/_neg_case_2.html.erb

@@ -3,6 +3,10 @@
 api_title = "Negative Case - 1 - should respond with proper errors for invalid arguments"
 
 api_input = <<-eos
+{}Example:
+
+Authorization: Token token="87b01adbba90824b57add8cc06ad8738"
+POST #{request.base_url}/api/v1/profile/profile_picture
 {}
 eos
 

data/app/views/usman/api/v1/docs/{profile_picture → upload_profile_picture}/_neg_case_3.html.erb

@@ -3,7 +3,12 @@
 api_title = "Negative Case - 2 - should set proper errors if invalid image data is passed"
 
 api_input = <<-eos
-  { "image": "<upload a file format which is not supported. e.g: csv>"}
+
+Authorization: Token token="87b01adbba90824b57add8cc06ad8738"
+POST #{request.base_url}/api/v1/profile/profile_picture
+{
+  "image": "<Uploaded File - Not Support. e.g: CSV>"
+}
 eos
 
 api_output = <<-eos

data/app/views/usman/api/v1/docs/{profile_picture → upload_profile_picture}/_pos_case_1.html.erb

@@ -3,7 +3,13 @@
 api_title = "Positive Case - 1 - should upload a profile picture"
 
 api_input = <<-eos
-{}
+Example:
+
+Authorization: Token token="87b01adbba90824b57add8cc06ad8738"
+POST #{request.base_url}/api/v1/profile/profile_picture
+{
+  "image": "<Uploaded File in Binary Format>"
+}
 eos
 
 api_output = <<-eos

data/app/views/usman/api/v1/docs/{destroy_profile_picture → upload_profile_picture_base64}/_neg_case_1.html.erb

@@ -3,7 +3,13 @@
 api_title = "Negative Case - 1 - should set proper errors if no api token"
 
 api_input = <<-eos
-{}
+Example:
+
+Authorization: nil
+POST #{request.base_url}/api/v1/profile/profile_picture_base64
+{
+  "image": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCYAAACNbyblAAAAHElEQVQI12P4//8w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg=="
+}
 eos
 
 api_output = <<-eos

data/app/views/usman/api/v1/docs/{profile_picture → upload_profile_picture_base64}/_neg_case_2.html.erb

@@ -3,6 +3,10 @@
 api_title = "Negative Case - 1 - should respond with proper errors for invalid arguments"
 
 api_input = <<-eos
+Example:
+
+Authorization: Token token="87b01adbba90824b57add8cc06ad8738"
+POST #{request.base_url}/api/v1/profile/profile_picture_base64
 {}
 eos
 

data/app/views/usman/api/v1/docs/{base64_profile_picture → upload_profile_picture_base64}/_pos_case_1.html.erb

@@ -3,7 +3,13 @@
 api_title = "Positive Case - 1 - should upload a profile picture in base64 format"
 
 api_input = <<-eos
-{}
+Example:
+
+Authorization: Token token="87b01adbba90824b57add8cc06ad8738"
+POST #{request.base_url}/api/v1/profile/profile_picture_base64
+{
+  "image": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCYAAACNbyblAAAAHElEQVQI12P4//8w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg=="
+}
 eos
 
 api_output = <<-eos

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

@@ -3,6 +3,9 @@
 api_title = "Negative Case - 1 - should respond with proper errors if no parameters are passed"
 
 api_input = <<-eos
+Example:
+
+POST #{request.base_url}/api/v1/verify_otp
 {}
 eos
 

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

@@ -3,6 +3,9 @@
 api_title = "Negative Case - 2 - should respond with proper errors if mobile number is not registered"
 
 api_input = <<-eos
+Example:
+
+POST #{request.base_url}/api/v1/verify_otp
 {
   "otp": "11111",
   "dialing_prefix": "+91",

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

@@ -3,6 +3,9 @@
 api_title = "Negative Case - 3 - should respond with proper errors if uuid is not registered"
 
 api_input = <<-eos
+Example:
+
+POST #{request.base_url}/api/v1/verify_otp
 {
   "otp": "11111",
   "dialing_prefix": "+91",

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

@@ -3,6 +3,9 @@
 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/verify_otp
 {
   "otp": "11111",
   "dialing_prefix": "+91",

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

@@ -3,6 +3,9 @@
 api_title = "Positive Case - 1 - should verify an otp verification request from a pending device"
 
 api_input = <<-eos
+Example:
+
+POST #{request.base_url}/api/v1/verify_otp
 {
   "otp": "11111",
   "uuid": "<PENDING UUID>",

data/app/views/usman/api/v1/docs/verify_otp/_pos_case_2.html.erb

@@ -3,6 +3,9 @@
 api_title = "Positive Case - 2 - should verify the otp if the device is verified, tac is accpted and return the api token"
 
 api_input = <<-eos
+Example:
+
+POST #{request.base_url}/api/v1/verify_otp
 {
   "otp": "11111",
   "uuid": "<REGISTERED UUID>",

data/config/routes.rb

@@ -54,11 +54,11 @@ Usman::Engine.routes.draw do
 
       # Profile
       post :create_profile, :controller => "profile"
-      post :update_profile, :controller => "profile"
-      get :profile, :controller => "profile"
+      put :update_profile, :controller => "profile"
+      get :profile_info, :controller => "profile"
 
       # Profile Picture
-      post 'profile/base64_profile_picture', :controller => "profile_picture", action: :base64_profile_picture
+      post 'profile/profile_picture_base64', :controller => "profile_picture", action: :profile_picture_base64
       post 'profile/profile_picture', :controller => "profile_picture", action: :profile_picture
       delete 'profile/profile_picture', :controller => "profile_picture", action: :destroy_profile_picture
     end
@@ -75,11 +75,11 @@ Usman::Engine.routes.draw do
         get 'create_profile', :controller => "docs"
         get 'update_profile', :controller => "docs"
         get 'update_profile', :controller => "docs"
-        get 'profile', :controller => "docs"
+        get 'get_profile_info', :controller => "docs"
 
-        get 'base64_profile_picture', :controller => "docs"
-        get 'profile_picture', :controller => "docs"
-        get 'destroy_profile_picture', :controller => "docs"
+        get 'upload_profile_picture_base64', :controller => "docs"
+        get 'upload_profile_picture', :controller => "docs"
+        get 'delete_profile_picture', :controller => "docs"
       end
     end
   end

data/lib/usman/version.rb

@@ -1,3 +1,3 @@
 module Usman
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: usman
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - kpvarma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-22 00:00:00.000000000 Z
+date: 2017-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -127,7 +127,7 @@ dependencies:
         version: '0.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.8
+        version: 0.1.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -137,7 +137,7 @@ dependencies:
         version: '0.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.8
+        version: 0.1.9
 - !ruby/object:Gem::Dependency
   name: bcrypt
   requirement: !ruby/object:Gem::Requirement
@@ -420,23 +420,16 @@ files:
 - app/views/usman/api/v1/docs/accept_tac/_neg_case_2.html.erb
 - app/views/usman/api/v1/docs/accept_tac/_neg_case_3.html.erb
 - app/views/usman/api/v1/docs/accept_tac/_pos_case_1.html.erb
-- app/views/usman/api/v1/docs/base64_profile_picture/_neg_case_1.html.erb
-- app/views/usman/api/v1/docs/base64_profile_picture/_neg_case_2.html.erb
-- app/views/usman/api/v1/docs/base64_profile_picture/_pos_case_1.html.erb
 - app/views/usman/api/v1/docs/create_profile/_neg_case_1.html.erb
 - app/views/usman/api/v1/docs/create_profile/_neg_case_2.html.erb
 - app/views/usman/api/v1/docs/create_profile/_neg_case_3.html.erb
 - app/views/usman/api/v1/docs/create_profile/_pos_case_1.html.erb
-- app/views/usman/api/v1/docs/destroy_profile_picture/_neg_case_1.html.erb
-- app/views/usman/api/v1/docs/destroy_profile_picture/_neg_case_2.html.erb
-- app/views/usman/api/v1/docs/destroy_profile_picture/_pos_case_1.html.erb
-- app/views/usman/api/v1/docs/profile/_neg_case_1.html.erb
-- app/views/usman/api/v1/docs/profile/_neg_case_2.html.erb
-- app/views/usman/api/v1/docs/profile/_pos_case_1.html.erb
-- app/views/usman/api/v1/docs/profile_picture/_neg_case_1.html.erb
-- app/views/usman/api/v1/docs/profile_picture/_neg_case_2.html.erb
-- app/views/usman/api/v1/docs/profile_picture/_neg_case_3.html.erb
-- app/views/usman/api/v1/docs/profile_picture/_pos_case_1.html.erb
+- app/views/usman/api/v1/docs/delete_profile_picture/_neg_case_1.html.erb
+- app/views/usman/api/v1/docs/delete_profile_picture/_neg_case_2.html.erb
+- app/views/usman/api/v1/docs/delete_profile_picture/_pos_case_1.html.erb
+- app/views/usman/api/v1/docs/get_profile_info/_neg_case_1.html.erb
+- app/views/usman/api/v1/docs/get_profile_info/_neg_case_2.html.erb
+- app/views/usman/api/v1/docs/get_profile_info/_pos_case_1.html.erb
 - app/views/usman/api/v1/docs/register/_neg_case_1.html.erb
 - app/views/usman/api/v1/docs/register/_neg_case_2.html.erb
 - app/views/usman/api/v1/docs/register/_neg_case_3.html.erb
@@ -453,6 +446,13 @@ files:
 - app/views/usman/api/v1/docs/update_profile/_neg_case_2.html.erb
 - app/views/usman/api/v1/docs/update_profile/_neg_case_3.html.erb
 - app/views/usman/api/v1/docs/update_profile/_pos_case_1.html.erb
+- app/views/usman/api/v1/docs/upload_profile_picture/_neg_case_1.html.erb
+- app/views/usman/api/v1/docs/upload_profile_picture/_neg_case_2.html.erb
+- app/views/usman/api/v1/docs/upload_profile_picture/_neg_case_3.html.erb
+- app/views/usman/api/v1/docs/upload_profile_picture/_pos_case_1.html.erb
+- app/views/usman/api/v1/docs/upload_profile_picture_base64/_neg_case_1.html.erb
+- app/views/usman/api/v1/docs/upload_profile_picture_base64/_neg_case_2.html.erb
+- app/views/usman/api/v1/docs/upload_profile_picture_base64/_pos_case_1.html.erb
 - app/views/usman/api/v1/docs/verify_otp/_neg_case_1.html.erb
 - app/views/usman/api/v1/docs/verify_otp/_neg_case_2.html.erb
 - app/views/usman/api/v1/docs/verify_otp/_neg_case_3.html.erb