usman 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: be37dd5242c311e6541ccfb190c9aa54597526cb
-  data.tar.gz: 0d2bef201228c383b53ea972b213d416cf0851c4
+  metadata.gz: 6e90151fe766fe30d80afab167a73f3f19695575
+  data.tar.gz: f7c1661db459e54c6842955f13a5d33e5ab7177b
 SHA512:
-  metadata.gz: 31ccc69fc7604ce950a96d97615ac345b6197cf1c8a1c45d6433762410c80d47ca8a2fdec01ea7682dbc0d435815948b5b3a57e4e442518f71f011857ec44e66
-  data.tar.gz: 77dbcef014783e75b470eab8a572f5f88c8c5c98ea185a8bd0c6e23609e0e2400edb3636fcb94e9cb2f028fb281a503bbe0b4e48808447c7acb0181a66412b32
+  metadata.gz: aa84b62ff326217fa57b3bfccee3c92fd10e5596b1d89f03dc89f20ce2d6a09e5e1d59ffbd343aecaec434d6f1b9fef2dbba60899ee17dc00581eec4cda330a1
+  data.tar.gz: 36bc606482819a366c70ad7f7a99d325139ad030db3ae01aaac86b05cbfc9e0eaf51bef78f3410b9b13e661dcc5a6914fca30c2afb079fc1209c9d207b5926bc

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

@@ -7,7 +7,7 @@ module Usman
           set_title("Register API")
           @request_type = "POST"
           @end_point = "/api/v1/register"
-          @description = "This API will register the user and the devise and will send an OTP for verification"
+          @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."
 
           @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. " }
@@ -27,7 +27,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", "pos_case_2", "pos_case_3", "neg_case_1", "neg_case_2", "neg_case_3"]
 
           set_nav("docs/register")
 
@@ -53,7 +53,7 @@ module Usman
           }
 
           @example_path = "usman/api/v1/docs/"
-          @examples = ["pos_case_1", "neg_case_1"]
+          @examples = ["pos_case_1", "neg_case_1", "neg_case_2", "neg_case_3", "neg_case_4"]
 
           set_nav("docs/resend_otp")
 
@@ -78,7 +78,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", "pos_case_2", "neg_case_1", "neg_case_2", "neg_case_3", "neg_case_4"]
 
           set_nav("docs/verify_otp")
 
@@ -104,7 +104,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/accept_tac")
 

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

@@ -13,8 +13,8 @@ module Usman
             if @errors[:heading].blank?
               @success = true
               @alert = {
-                heading: I18n.translate("api.mobile_registration.otp_sent.heading"),
-                message: I18n.translate("api.mobile_registration.otp_sent.message")
+                heading: I18n.translate("api.register.otp_sent.heading"),
+                message: I18n.translate("api.register.otp_sent.message")
               }
               @data = {
                         registration: @reg_data.registration,
@@ -27,40 +27,52 @@ module Usman
 
         def resend_otp
           proc_code = Proc.new do
-            @device = Device.where("uuid = ?", params[:uuid]).first
-            if @device
-              if @device.blocked?
-                @success = false
-                @errors = {
-                  heading: I18n.translate("api.mobile_registration.device_blocked.heading"),
-                  message: I18n.translate("api.mobile_registration.device_blocked.message"),
-                  details: {}
-                }
-              else
-                valid, validation_errors = @device.resend_otp(params[:dialing_prefix], params[:mobile_number])
-                if valid
-                  @success = true
-                  @alert = {
-                    heading: I18n.translate("api.mobile_registration.new_otp_sent.heading"),
-                    message: I18n.translate("api.mobile_registration.new_otp_sent.message")
-                  }
-                  @data = {}
-                else
+            @registration = Registration.where("mobile_number = ?", params[:mobile_number]).first
+            if @registration
+              @device = @registration.devices.where("uuid = ?", params[:uuid]).first
+              if @device
+                if @device.blocked?
                   @success = false
                   @errors = {
-                    heading: I18n.translate("api.mobile_registration.otp_not_matching.heading"),
-                    message: I18n.translate("api.mobile_registration.otp_not_matching.message"),
-                    details: validation_errors
+                    heading: I18n.translate("api.resend_otp.device_blocked.heading"),
+                    message: I18n.translate("api.resend_otp.device_blocked.message"),
+                    details: {}
                   }
+                else
+                  valid, validation_errors = @device.resend_otp(params[:dialing_prefix], params[:mobile_number])
+                  if valid
+                    @success = true
+                    @alert = {
+                      heading: I18n.translate("api.resend_otp.new_otp_sent.heading"),
+                      message: I18n.translate("api.resend_otp.new_otp_sent.message")
+                    }
+                    @data = {}
+                  else
+                    @success = false
+                    @errors = {
+                      heading: I18n.translate("api.resend_otp.otp_not_matching.heading"),
+                      message: I18n.translate("api.resend_otp.otp_not_matching.message"),
+                      details: validation_errors
+                    }
+                  end
                 end
+              else
+                @success = false
+                @errors = {
+                  heading: I18n.translate("api.resend_otp.device_not_registered.heading"),
+                  message: I18n.translate("api.resend_otp.device_not_registered.message"),
+                  details: {
+                    uuid: "is invalid"
+                  }
+                }
               end
             else
               @success = false
               @errors = {
-                heading: I18n.translate("api.general.unexpected_failure.heading"),
-                message: I18n.translate("api.general.unexpected_failure.message"),
+                heading: I18n.translate("api.resend_otp.mobile_number_not_registered.heading"),
+                message: I18n.translate("api.resend_otp.mobile_number_not_registered.message"),
                 details: {
-                  uuid: "is invalid"
+                  mobile_number: "is invalid"
                 }
               }
             end
@@ -68,41 +80,116 @@ module Usman
           render_json_response(proc_code)
         end
 
-        def verify
+        def verify_otp
           proc_code = Proc.new do
-            @device = Device.where("uuid = ?", params[:uuid]).first
-            if @device
-              if @device.blocked?
+            @registration = Registration.where("mobile_number = ?", params[:mobile_number]).first
+            if @registration
+              @device = @registration.devices.where("uuid = ?", params[:uuid]).first
+              if @device
+                if @device.blocked?
+                  @success = false
+                  @errors = {
+                    heading: I18n.translate("api.verify_otp.device_blocked.heading"),
+                    message: I18n.translate("api.verify_otp.device_blocked.message"),
+                    details: {}
+                  }
+                else
+                  valid, validation_errors = @device.validate_otp(params[:otp], params[:dialing_prefix], params[:mobile_number])
+                  if valid
+                    @success = true
+                    @alert = {
+                      heading: I18n.translate("api.verify_otp.verification_success.heading"),
+                      message: I18n.translate("api.verify_otp.verification_success.message")
+                    }
+                    @data = { api_token: @device.api_token } if @device.verified? && @device.tac_accepted?
+                  else
+                    @success = false
+                    @errors = {
+                      heading: I18n.translate("api.verify_otp.otp_not_matching.heading"),
+                      message: I18n.translate("api.verify_otp.otp_not_matching.message"),
+                      details: validation_errors
+                    }
+                  end
+                end
+              else
                 @success = false
                 @errors = {
-                  heading: I18n.translate("api.mobile_registration.device_blocked.heading"),
-                  message: I18n.translate("api.mobile_registration.device_blocked.message"),
-                  details: {}
+                  heading: I18n.translate("api.verify_otp.device_not_registered.heading"),
+                  message: I18n.translate("api.verify_otp.device_not_registered.message"),
+                  details: {
+                    uuid: "is invalid"
+                  }
                 }
-              else
-                valid, validation_errors = @device.validate_otp(params[:otp], params[:dialing_prefix], params[:mobile_number])
-                if valid
-                  @success = true
-                  @alert = {
-                    heading: I18n.translate("api.mobile_registration.verification_success.heading"),
-                    message: I18n.translate("api.mobile_registration.verification_success.message")
+              end
+            else
+              @success = false
+              @errors = {
+                heading: I18n.translate("api.verify_otp.mobile_number_not_registered.heading"),
+                message: I18n.translate("api.verify_otp.mobile_number_not_registered.message"),
+                details: {
+                  mobile_number: "is invalid"
+                }
+              }
+            end
+          end
+          render_json_response(proc_code)
+        end
+
+        def accept_tac
+          proc_code = Proc.new do
+            @registration = Registration.where("mobile_number = ?", params[:mobile_number]).first
+            if @registration
+              @device = @registration.devices.where("uuid = ?", params[:uuid]).first
+              if @device
+                if @device.blocked?
+                  @success = false
+                  @errors = {
+                    heading: I18n.translate("api.accept_tac.device_blocked.heading"),
+                    message: I18n.translate("api.accept_tac.device_blocked.message"),
+                    details: {}
                   }
-                else
+                elsif @device.pending?
                   @success = false
                   @errors = {
-                    heading: I18n.translate("api.mobile_registration.otp_not_matching.heading"),
-                    message: I18n.translate("api.mobile_registration.otp_not_matching.message"),
-                    details: validation_errors
+                    heading: I18n.translate("api.accept_tac.device_pending.heading"),
+                    message: I18n.translate("api.accept_tac.device_pending.message"),
+                    details: {}
                   }
+                else
+                  valid, validation_errors = @device.accept_tac(params[:terms_and_conditions], params[:dialing_prefix], params[:mobile_number])
+                  if valid
+                    @success = true
+                    @alert = {
+                      heading: I18n.translate("api.accept_tac.tac_accepted.heading"),
+                      message: I18n.translate("api.accept_tac.tac_accepted.message")
+                    }
+                    @data = { api_token: @device.api_token } if @device.verified? && @device.tac_accepted?
+                  else
+                    @success = false
+                    @errors = {
+                      heading: I18n.translate("api.accept_tac.tac_not_accepted.heading"),
+                      message: I18n.translate("api.accept_tac.tac_not_accepted.message"),
+                      details: validation_errors
+                    }
+                  end
                 end
+              else
+                @success = false
+                @errors = {
+                  heading: I18n.translate("api.accept_tac.device_not_registered.heading"),
+                  message: I18n.translate("api.accept_tac.device_not_registered.message"),
+                  details: {
+                    uuid: "is invalid"
+                  }
+                }
               end
             else
               @success = false
               @errors = {
-                heading: I18n.translate("api.general.unexpected_failure.heading"),
-                message: I18n.translate("api.general.unexpected_failure.message"),
+                heading: I18n.translate("api.verify_otp.mobile_number_not_registered.heading"),
+                message: I18n.translate("api.verify_otp.mobile_number_not_registered.message"),
                 details: {
-                  uuid: "is invalid"
+                  mobile_number: "is invalid"
                 }
               }
             end
@@ -110,7 +197,7 @@ module Usman
           render_json_response(proc_code)
         end
 
-        def accept_tac
+        def accept_tac1
           proc_code = Proc.new do
             @device = Device.where("uuid = ?", params[:uuid]).first
             if @device

data/app/models/device.rb

@@ -1,7 +1,7 @@
 class Device < ApplicationRecord
   
   # Constants
-  EXCLUDED_JSON_ATTRIBUTES = [:last_accessed_at, :last_accessed_api, :otp, :otp_sent_at, :api_token, :token_created_at, :status, :tac_accepted_at, :created_at, :updated_at]
+  EXCLUDED_JSON_ATTRIBUTES = [:last_accessed_at, :last_accessed_api, :otp, :otp_sent_at, :api_token, :token_created_at, :tac_accepted_at, :created_at, :updated_at]
 
   PENDING = "pending"
   VERIFIED = "verified"
@@ -68,9 +68,8 @@ class Device < ApplicationRecord
   # Exclude some attributes info from json output.
   def as_json(options={})
     options[:except] ||= EXCLUDED_JSON_ATTRIBUTES
-    #options[:include] ||= []
     #options[:methods] = []
-    #options[:methods] << :profile_image
+    #options[:methods] << :api_token
     json = super(options)
     Hash[*json.map{|k, v| [k, v || ""]}.flatten]
   end
@@ -145,7 +144,9 @@ class Device < ApplicationRecord
 
   def generate_otp
     self.otp = rand(10000..99999)
-    self.otp_sent_at = Time.now
+    self.otp_sent_at = nil
+    self.otp_verified_at = nil
+    self.save
   end
 
   def validate_otp(otp, dialing_prefix, mobile_number)
@@ -153,12 +154,6 @@ class Device < ApplicationRecord
     # Validate OTP and other parameters
     validation_errors = {}
 
-    # Check if this OTP was already verified
-    if !self.otp_verified_at.blank?
-      validation_errors[:otp_verified_at] = "This OTP was already used"
-      return false, validation_errors
-    end
-
     # TODO - remove 11111 after implementing Twilio
     validation_errors[:otp] = "doesn't match with our database" unless (self.otp.to_s == otp.to_s or otp.to_s == "11111")
     validation_errors[:mobile_number] = "doesn't match with our database" unless self.registration.mobile_number.to_s == mobile_number.to_s
@@ -175,6 +170,10 @@ class Device < ApplicationRecord
     self.verify!
     self.registration.verify!
 
+    # Clearing the OTP so that next time if he uses the same, it shows error
+    self.otp = nil
+    self.save
+
     return true, {}
   end
 
@@ -194,7 +193,6 @@ class Device < ApplicationRecord
 
   def send_otp
     self.generate_otp
-    self.save
     return true
   end
 
@@ -204,8 +202,8 @@ class Device < ApplicationRecord
     validation_errors = {}
 
     # Check if terms and conditions was accepted
-    unless ["true", "yes", "t", "y"].include?(tac.to_s.downcase)
-      validation_errors[:terms_and_conditions] = "T&C should be true"
+    unless ["true", "yes", "t", "y", "1"].include?(tac.to_s.downcase)
+      validation_errors[:terms_and_conditions] = "must be true"
       return false, validation_errors
     end
 
@@ -218,12 +216,13 @@ class Device < ApplicationRecord
     self.tac_accepted_at = Time.now
     self.save
 
-    self.verify!
-    self.registration.verify!
-
     return true, {}
   end
 
+  def tac_accepted?
+    self.tac_accepted_at.present? && self.tac_accepted_at < Time.now
+  end
+
   # Other Methods
   # -------------
 

data/app/models/registration.rb

@@ -1,7 +1,7 @@
 class Registration < ApplicationRecord
   
   # Constants
-  EXCLUDED_JSON_ATTRIBUTES = [:status, :created_at, :updated_at]
+  EXCLUDED_JSON_ATTRIBUTES = [:created_at, :updated_at]
 
   PENDING = "pending"
   VERIFIED = "verified"

data/app/services/usman/mobile_registration_service.rb

@@ -44,7 +44,7 @@ module Usman
 
       if @registration.errors.any? or @device.errors.any?
         errors = @registration.errors.to_hash.merge(@device.errors.to_hash)
-        set_error("api.mobile_registration.invalid_inputs", errors)
+        set_error("api.register.invalid_inputs", errors)
       end
     end
 
@@ -55,12 +55,14 @@ module Usman
         @registration.city = @city
       end
       @device = Device.where("LOWER(uuid) = LOWER('#{@uuid}')").first if @registration
+
+      @device.generate_otp if @device
     end
 
     def register_new_device
       
       if @device && @device.blocked?
-        set_error("api.mobile_registration.device_blocked")
+        set_error("api.register.device_blocked")
         return
       end
 
@@ -102,7 +104,7 @@ module Usman
       if @device.send_otp
         @device.update_attribute(:otp_sent_at, Time.now)
       else
-        set_error("api.mobile_registration.otp_not_sent")
+        set_error("api.register.otp_not_sent")
       end
     end
 

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

@@ -0,0 +1,32 @@
+<%
+
+api_title = "Negative Case - 1 - should not accept the terms and conditions if the device is not verified"
+
+api_input = <<-eos
+{
+  "terms_and_conditions": 1,
+  "uuid": "<PENDING UUID>",
+  "mobile_number": "<PENDING MOBILE NUMBER>",
+  "dialing_prefix": "+91"
+}
+eos
+
+api_output = <<-eos
+{
+  "success": false,
+  "errors": {
+    "heading": "This device is not verified",
+    "message": "You need to verify this device before you can accept the terms and conditions"
+  }
+}
+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/accept_tac/_neg_case_2.html.erb

@@ -0,0 +1,30 @@
+<%
+
+api_title = "Negative Case - 2 - should respond with proper errors if no params are passed"
+
+api_input = <<-eos
+{}
+eos
+
+api_output = <<-eos
+{
+  "success": false,
+  "errors": {
+    "heading": "The mobile number is not registered",
+    "message": "Accepting T&C Failed. Check if the mobile number entered is valid",
+    "details": {
+        "mobile_number": "is invalid"
+    }
+  }
+}
+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/accept_tac/_neg_case_3.html.erb

@@ -0,0 +1,35 @@
+<%
+
+api_title = "Negative Case - 3 - should respond with proper errors if T&C is not accepted"
+
+api_input = <<-eos
+{
+  "terms_and_conditions": 0,
+  "uuid": "<VERIFIED UUID>",
+  "mobile_number": "<VERIFIED MOBILE NUMBER>",
+  "dialing_prefix": "+91"
+}
+eos
+
+api_output = <<-eos
+{
+  "success": false,
+  "errors": {
+      "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",
+      "details": {
+        "terms_and_conditions": "must be true"
+      }
+  }
+}
+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/accept_tac/_pos_case_1.html.erb

@@ -0,0 +1,35 @@
+<%
+
+api_title = "Positive Case - 1 - should accept the terms and conditions if the device is verified and all inputs are valid"
+
+api_input = <<-eos
+{
+  "terms_and_conditions": 1,
+  "uuid": "<VERIFIED UUID>",
+  "mobile_number": "<VERIFIED MOBILE NUMBER>",
+  "dialing_prefix": "+91"
+}
+eos
+
+api_output = <<-eos
+{
+  "success": true,
+  "alert": {
+      "heading": "You have successfully accepted the Terms & Conditions. Proceed with Registration process if any",
+      "message": "Store and use the API token for further communication"
+  },
+  "data": {
+    "api_token": "ajshdjkashdkjasdas"
+  }
+}
+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/register/_neg_case_4.html.erb

@@ -0,0 +1,35 @@
+<%
+
+api_title = "Negative Case - 4 - should set proper errors for device is blocked"
+
+api_input = <<-eos
+{
+  "uuid": "<BLOCKED DEVICE UUID>",
+  "device_token": "<BLOCKED DEVICE DEVICE TOKEN>",
+  "device_name": "Apple iPhone",
+  "device_type": "iPhone 7 Plus",
+  "operating_system": "iOS",
+  "software_version": "iOS 11.2.2"
+}
+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_3",
+                                        api_title: api_title,
+                                        api_input: api_input,
+                                        api_output: api_output 
+                                      } %>