usman 0.2.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6e90151fe766fe30d80afab167a73f3f19695575
-  data.tar.gz: f7c1661db459e54c6842955f13a5d33e5ab7177b
+  metadata.gz: e94f0975fd0fa28f10f87c0c643e54dc3015967d
+  data.tar.gz: 1fd689c72b2e93164649248a4d6147f2a60fe2f2
 SHA512:
-  metadata.gz: aa84b62ff326217fa57b3bfccee3c92fd10e5596b1d89f03dc89f20ce2d6a09e5e1d59ffbd343aecaec434d6f1b9fef2dbba60899ee17dc00581eec4cda330a1
-  data.tar.gz: 36bc606482819a366c70ad7f7a99d325139ad030db3ae01aaac86b05cbfc9e0eaf51bef78f3410b9b13e661dcc5a6914fca30c2afb079fc1209c9d207b5926bc
+  metadata.gz: c6f2a9c9de37d681ce5cfb3c88a7b2ebc14446a3c70fac683ee79a27d9e6821bb7d2285d1a67b211cd401003a5c70692bd816973e7aa9d8685e2b65599d01e06
+  data.tar.gz: 4b34bc3cc5e41ecd998da6ff9d897c8b1424bbbb55752415541e0f6cff04744fa6de5c3257715e1c3cf83e29d103c74c33bdd5c8b8ffa446d3ac20faa7e28b63

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

@@ -114,11 +114,12 @@ module Usman
         def create_profile
           set_title("Create Profile API")
           @request_type = "POST"
-          @end_point = "/api/v1/accept_tac"
-          @description = "This API will return so and so and create blah blah blah"
+          @end_point = "/api/v1/create_profile"
+          @description = "This API will create a profile for a newly registered user"
           
           @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. " }
+            "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. " },
+            "Authorization" => { value: "Token token=\"87b01adbba90824b57add8cc06ad8738\"", description: "Put the API Token here. This is must for creating a profile. You need to register with your mobile number and verify the otp before you could create a profile" }
           }
 
           @input_params = {
@@ -128,7 +129,7 @@ module Usman
           }
 
           @example_path = "usman/api/v1/docs/"# 
-          # @examples = ["pos_case_1", "neg_case_1", "neg_case_2", "neg_case_3"]
+          @examples = ["pos_case_1", "neg_case_1", "neg_case_2", "neg_case_3"]
 
           set_nav("docs/create_profile")
 
@@ -138,11 +139,12 @@ module Usman
         def update_profile
           set_title("Update Profile API")
           @request_type = "POST"
-          @end_point = "/api/v1/accept_tac"
-          @description = "This API will return so and so and create blah blah blah"
+          @end_point = "/api/v1/update_profile"
+          @description = "This API will update the profile details"
           
           @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. " }
+            "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. " },
+            "Authorization" => { value: "Token token=\"87b01adbba90824b57add8cc06ad8738\"", description: "Put the API Token here. This is must for creating a profile. You need to register with your mobile number and verify the otp before you could create a profile" }
           }
 
           @input_params = {
@@ -152,7 +154,7 @@ module Usman
           }
 
           @example_path = "usman/api/v1/docs/"# 
-          # @examples = ["pos_case_1", "neg_case_1", "neg_case_2", "neg_case_3"]
+          @examples = ["pos_case_1", "neg_case_1", "neg_case_2", "neg_case_3"]
 
           set_nav("docs/update_profile")
 

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

@@ -4,8 +4,8 @@ module Usman
       class ProfileController < Usman::Api::V1::BaseController
 
         def create_profile
-          proc_code = Proc.new do
-            
+          #proc_code = Proc.new do
+            #binding.pry
             if @current_registration
               if @current_user
                 @success = false
@@ -20,20 +20,87 @@ module Usman
                 @user.gender = permitted_params[:gender]
                 @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])
+
                 if @user.valid?
+                  @user.save
                   @current_registration.user = @user
+                  
+                  @current_registration.country = @country if @country
+                  @current_registration.city = @city if @city
+
+                  @current_registration.save
+
+                  @current_user = @user
                   @success = true
                   @alert = {
                     heading: I18n.translate("api.profile.profile_created.heading"),
                     message: I18n.translate("api.profile.profile_created.message")
                   }
-                  @data = {
-                            registration: @reg_data.registration,
-                            device: @reg_data.device
-                          }
+                  @data = { user: @user }
                 else
-                  @errors = @user.errors
                   @success = false
+                  @errors = {
+                    heading: I18n.translate("api.profile.invalid_inputs.heading"),
+                    message: I18n.translate("api.profile.invalid_inputs.message"),
+                    details: @user.errors
+                  }
+                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
+          proc_code = Proc.new do
+          end
+          render_json_response(proc_code)
+        end
+
+        def update_profile
+          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
+                @user = @current_user
+                @user.name = permitted_params[:name]
+                @user.gender = permitted_params[:gender]
+                @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])
+
+                if @user.valid?
+                  @user.save
+                  
+                  @current_registration.country = @country if @country
+                  @current_registration.city = @city if @city
+
+                  @current_registration.save
+
+                  @success = true
+                  @alert = {
+                    heading: I18n.translate("api.profile.profile_created.heading"),
+                    message: I18n.translate("api.profile.profile_created.message")
+                  }
+                  @data = { user: @user }
+                else
+                  @success = false
+                  @errors = {
+                    heading: I18n.translate("api.profile.invalid_inputs.heading"),
+                    message: I18n.translate("api.profile.invalid_inputs.message"),
+                    details: @user.errors
+                  }
                 end
               end
             else
@@ -50,7 +117,7 @@ module Usman
         private
 
         def permitted_params
-          params.require(:profile).permit(:name, :gender, :date_of_birth, :email, :country_id, :city_id)
+          params.permit(:name, :gender, :date_of_birth, :email, :country_id, :city_id)
         end
 
       end

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

@@ -27,7 +27,7 @@ module Usman
 
         def resend_otp
           proc_code = Proc.new do
-            @registration = Registration.where("mobile_number = ?", params[:mobile_number]).first
+            @registration = Registration.where("mobile_number = ? AND dialing_prefix = ?", params[:mobile_number], params[:dialing_prefix]).first
             if @registration
               @device = @registration.devices.where("uuid = ?", params[:uuid]).first
               if @device
@@ -82,7 +82,7 @@ module Usman
 
         def verify_otp
           proc_code = Proc.new do
-            @registration = Registration.where("mobile_number = ?", params[:mobile_number]).first
+            @registration = Registration.where("mobile_number = ? AND dialing_prefix = ?", params[:mobile_number], params[:dialing_prefix]).first
             if @registration
               @device = @registration.devices.where("uuid = ?", params[:uuid]).first
               if @device
@@ -137,7 +137,7 @@ module Usman
 
         def accept_tac
           proc_code = Proc.new do
-            @registration = Registration.where("mobile_number = ?", params[:mobile_number]).first
+            @registration = Registration.where("mobile_number = ? AND dialing_prefix = ?", params[:mobile_number], params[:dialing_prefix]).first
             if @registration
               @device = @registration.devices.where("uuid = ?", params[:uuid]).first
               if @device

data/app/helpers/usman/api_helper.rb

@@ -28,8 +28,11 @@ module Usman
       current_device
       unless @current_device
         proc_code = Proc.new do
-          set_notification_messages("authentication.permission_denied", :error)
-          raise AuthenticationError
+          @success = false
+          @errors = {
+            heading: I18n.translate("api.general.permission_denied.heading"),
+            message: I18n.translate("api.general.permission_denied.message")
+          }
         end
         render_json_response(proc_code)
         return

data/app/models/user.rb

@@ -36,7 +36,7 @@ class User < Usman::ApplicationRecord
     "No Gender" => NOGENDER
   }
 
-  EXCLUDED_JSON_ATTRIBUTES = [:confirmation_token, :password_digest, :reset_password_token, :unlock_token, :status, :reset_password_sent_at, :remember_created_at, :sign_in_count, :current_sign_in_at, :last_sign_in_at, :current_sign_in_ip, :last_sign_in_ip, :confirmed_at, :confirmation_sent_at, :unconfirmed_email, :failed_attempts, :locked_at, :created_at, :updated_at]
+  EXCLUDED_JSON_ATTRIBUTES = [:confirmation_token, :password_digest, :reset_password_token, :auth_token, :unlock_token, :status, :reset_password_sent_at, :remember_created_at, :sign_in_count, :current_sign_in_at, :last_sign_in_at, :current_sign_in_ip, :last_sign_in_ip, :confirmed_at, :confirmation_sent_at, :unconfirmed_email, :failed_attempts, :locked_at, :created_at, :updated_at]
   DEFAULT_PASSWORD = "Password@1"
   SESSION_TIME_OUT = 120.minutes
 

data/app/views/usman/api/v1/docs/create_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/create_profile/_neg_case_2.html.erb

@@ -0,0 +1,34 @@
+<%
+
+api_title = "Negative Case - 2 - should set proper errors if the profile already exists"
+
+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",
+    "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/create_profile/_neg_case_3.html.erb

@@ -0,0 +1,31 @@
+<%
+
+api_title = "Negative Case - 3 - should set proper errors if the inputs are not correct"
+
+api_input = <<-eos
+{}
+eos
+
+api_output = <<-eos
+{
+  "success": false,
+  "errors": {
+      "heading": "Creating 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)"]
+          "email": ["can't be blank", "is too short (minimum is 3 characters)"]
+      }
+  }
+}
+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/create_profile/_pos_case_1.html.erb

@@ -0,0 +1,49 @@
+<%
+
+api_title = "Positive Case - 1 - should create the profile"
+
+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": true,
+  "alert": {
+    "heading": "The Profile has been created successfully",
+    "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"
+    }
+  }
+}
+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_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/update_profile/_neg_case_2.html.erb

@@ -0,0 +1,34 @@
+<%
+
+api_title = "Negative Case - 2 - should set proper errors if the profile already exists"
+
+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",
+    "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/update_profile/_neg_case_3.html.erb

@@ -0,0 +1,31 @@
+<%
+
+api_title = "Negative Case - 3 - should set proper errors if the inputs are not correct"
+
+api_input = <<-eos
+{}
+eos
+
+api_output = <<-eos
+{
+  "success": false,
+  "errors": {
+      "heading": "Creating 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)"]
+          "email": ["can't be blank", "is too short (minimum is 3 characters)"]
+      }
+  }
+}
+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/update_profile/_pos_case_1.html.erb

@@ -0,0 +1,49 @@
+<%
+
+api_title = "Positive Case - 1 - should create the profile"
+
+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": true,
+  "alert": {
+    "heading": "The Profile has been updated successfully",
+    "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"
+    }
+  }
+}
+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,8 +1,9 @@
 en:
   api:
     general:
-      heading: "Invalid API Token"
-      message: "Use the API Token you have received after accepting the terms and agreement"
+      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"
@@ -80,6 +81,12 @@ en:
       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."
+      user_does_not_exists:
+        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."
       profile_created: 
-        heading: "The Profile has been created successfully"
-        message: "You may access the profile API with API token to get the profile details in future"
+        heading: "The Profile has been saved successfully"
+        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"

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

@@ -1,8 +1,9 @@
 en:
   api:
     general:
-      heading: "Invalid API Token"
-      message: "Use the API Token you have received after accepting the terms and agreement"
+      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"
@@ -80,6 +81,12 @@ en:
       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."
+      user_does_not_exists:
+        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."
       profile_created: 
-        heading: "The Profile has been created successfully"
-        message: "You may access the profile API with API token to get the profile details in future"
+        heading: "The Profile has been saved successfully"
+        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"

data/lib/usman/version.rb

@@ -1,3 +1,3 @@
 module Usman
-  VERSION = '0.2.6'
+  VERSION = '0.2.7'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: usman
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
 platform: ruby
 authors:
 - kpvarma
@@ -392,6 +392,10 @@ 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/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/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
@@ -404,6 +408,10 @@ files:
 - app/views/usman/api/v1/docs/resend_otp/_neg_case_3.html.erb
 - app/views/usman/api/v1/docs/resend_otp/_neg_case_4.html.erb
 - app/views/usman/api/v1/docs/resend_otp/_pos_case_1.html.erb
+- app/views/usman/api/v1/docs/update_profile/_neg_case_1.html.erb
+- 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/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