usman 0.2.11 → 0.3.0

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

@@ -0,0 +1,36 @@
+<%
+
+api_title = "Positive Case - 1 - should upload a profile picture in base64 format"
+
+api_input = <<-eos
+{}
+eos
+
+api_output = <<-eos
+{
+  "success": true,
+  "alert": {
+    "heading": "User/Profile Image was saved successfully",
+    "message": "You may now use the URL to download the image in future"
+  },
+  "data": {
+    "id": 8,
+    "created_at": "21-09-2017 13:02:45",
+    "profile_id": 6,
+    "image_large_path": "/uploads/profile_pictures/8/large_profile_picture.jpg",
+    "image_medium_path": "/uploads/profile_pictures/8/medium_profile_picture.jpg",
+    "image_small_path": "/uploads/profile_pictures/8/small_profile_picture.jpg",
+    "image_tiny_path": "/uploads/profile_pictures/8/tiny_profile_picture.jpg"
+  }
+}
+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/create_profile/_pos_case_1.html.erb

@@ -21,20 +21,21 @@ api_output = <<-eos
     "message": "You may access the profile API with API token to get the profile details in future"
   },
   "data": {
-    "user": {
-      "id": 8,
-      "name": "K P Varma",
-      "username": "4106947a",
-      "email": "kpv@kpvarma.com",
-      "phone": "",
-      "designation": "",
-      "super_admin": "",
-      "token_created_at": "",
-      "registration_id": "",
-      "gender": "male",
-      "date_of_birth": "1954-10-27"
-    }
-  }
+    "id": 9,
+    "name": "Nayan Tara",
+    "gender": "female",
+    "date_of_birth": "1984-10-27",
+    "username": "d0dca578",
+    "email": "nayan.tara@yopmail.com",
+    "phone": null
+    "profile_picture":
+      { 
+        "id": 1,
+        "created_at": "22-09-2017 07:32:51",
+        "user_id": 1,
+        "image_large_path": "/uploads/profile_pictures/1/large_test.jpeg",
+        "image_small_path": "/uploads/profile_pictures/1/small_test.jpeg"}}
+      }
 }
 eos
 

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

@@ -0,0 +1,27 @@
+<%
+
+api_title = "Negative Case - 1 - should set proper errors if no api token"
+
+api_input = <<-eos
+{}
+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/destroy_profile_picture/_neg_case_2.html.erb

@@ -0,0 +1,27 @@
+<%
+
+api_title = "Negative Case - 2 - should set proper errors if the profile doesn't exists"
+
+api_input = <<-eos
+{}
+eos
+
+api_output = <<-eos
+{
+  "success": false,
+  "errors": {
+    "heading": "Profile doesn't 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."
+  }
+}
+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/destroy_profile_picture/_pos_case_1.html.erb

@@ -0,0 +1,27 @@
+<%
+
+api_title = "Positive Case - 1 - should delete a profile picture for a user"
+
+api_input = <<-eos
+{}
+eos
+
+api_output = <<-eos
+{
+  "success": true,
+  "alert": {
+    "heading": "User/Profile Image was deleted successfully",
+    "message": "You may use Profile Picture Upload API to add one again"
+  }
+}
+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/profile/_neg_case_1.html.erb

@@ -0,0 +1,34 @@
+<%
+
+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"
+}
+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/profile/_neg_case_2.html.erb

@@ -0,0 +1,27 @@
+<%
+
+api_title = "Negative Case - 2 - should set proper errors if the profile didn't exist"
+
+api_input = <<-eos
+{}
+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/profile/_pos_case_1.html.erb

@@ -0,0 +1,39 @@
+<%
+
+api_title = "Positive Case - 1 - should return the profile details along with picture"
+
+api_input = <<-eos
+{}
+eos
+
+api_output = <<-eos
+{
+  "success": true,
+  "data": {
+    "id": 9,
+    "name": "Nayan Tara",
+    "gender": "female",
+    "date_of_birth": "1984-10-27",
+    "username": "d0dca578",
+    "email": "nayan.tara@yopmail.com",
+    "phone": null,
+    "profile_picture": {
+      "id": 8,
+      "profile_id": 9,
+      "created_at": "21-09-2017 13:02:45",
+      "image_large_path": "/uploads/profile_pictures/8/large_profile_picture.jpg",
+      "image_small_path": "/uploads/profile_pictures/8/small_profile_picture.jpg"
+    }
+  }
+}
+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/profile_picture/_neg_case_1.html.erb

@@ -0,0 +1,27 @@
+<%
+
+api_title = "Negative Case - 1 - should set proper errors if no api token"
+
+api_input = <<-eos
+{}
+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/profile_picture/_neg_case_2.html.erb

@@ -0,0 +1,28 @@
+<%
+
+api_title = "Negative Case - 1 - should respond with proper errors for invalid arguments"
+
+api_input = <<-eos
+{}
+eos
+
+api_output = <<-eos
+{
+  "success": false,
+  "errors": {
+    "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.",
+    "details": "Image can't be blank"
+  }
+}
+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/profile_picture/_neg_case_3.html.erb

@@ -0,0 +1,27 @@
+<%
+
+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>"}
+eos
+
+api_output = <<-eos
+{
+  "success": false,
+  "errors": {
+    "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."
+  }
+}
+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/profile_picture/_pos_case_1.html.erb

@@ -0,0 +1,36 @@
+<%
+
+api_title = "Positive Case - 1 - should upload a profile picture"
+
+api_input = <<-eos
+{}
+eos
+
+api_output = <<-eos
+{
+  "success": true,
+  "alert": {
+    "heading": "User/Profile Image was saved successfully",
+    "message": "You may now use the URL to download the image in future"
+  },
+  "data": {
+    "id": 8,
+    "created_at": "21-09-2017 13:02:45",
+    "profile_picture_id" :6,
+    "image_large_path": "/uploads/profile_pictures/8/large_profile_picture.jpg",
+    "image_medium_path": "/uploads/profile_pictures/8/medium_profile_picture.jpg",
+    "image_small_path": "/uploads/profile_pictures/8/small_profile_picture.jpg",
+    "image_tiny_path": "/uploads/profile_pictures/8/tiny_profile_picture.jpg"
+  }
+}
+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/update_profile/_neg_case_2.html.erb

@@ -1,23 +1,16 @@
 <%
 
-api_title = "Negative Case - 2 - should set proper errors if the profile already exists"
+api_title = "Negative Case - 2 - should set proper errors if the profile doesn't exist"
 
 api_input = <<-eos
-{
-  "name": "Name",
-  "gender": "male",
-  "date_of_birth": "10/10/1980",
-  "email": "name@domain.com",
-  "country_id": "1",
-  "city_id": "2"
-}
+{}
 eos
 
 api_output = <<-eos
 {
   "success": false,
   "errors": {
-    "heading": "A profile already exists for the mobile number you have provided",
+    "heading": "A profile doesn't 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."
   }
 }

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

@@ -10,7 +10,7 @@ api_output = <<-eos
 {
   "success": false,
   "errors": {
-      "heading": "Creating Profile Failed",
+      "heading": "Updating Profile Failed",
       "message": "Check if all mandatory details are passed. Refer the error details for technical information",
       "details": {
           "name": ["can't be blank", "is too short (minimum is 3 characters)"]

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

@@ -21,19 +21,13 @@ api_output = <<-eos
     "message": "You may access the profile API with API token to get the profile details in future"
   },
   "data": {
-    "user": {
-      "id": 8,
-      "name": "K P Varma",
-      "username": "4106947a",
-      "email": "kpv@kpvarma.com",
-      "phone": "",
-      "designation": "",
-      "super_admin": "",
-      "token_created_at": "",
-      "registration_id": "",
-      "gender": "male",
-      "date_of_birth": "1954-10-27"
-    }
+    "id": 9,
+    "name": "Nayan Tara",
+    "gender": "female",
+    "date_of_birth": "1984-10-27",
+    "username": "d0dca578",
+    "email": "nayan.tara@yopmail.com",
+    "phone": null
   }
 }
 eos