usman 0.2.3 → 0.2.5

data/app/helpers/usman/api_helper.rb

@@ -1,11 +1,17 @@
 module Usman
   module ApiHelper
-
     def current_user
       # Return if @current_user is already initialized else check if the user exists with the auth token present in request header
       @current_user ||= authenticate_with_http_token { |token, options| User.find_by(auth_token: token)}
     end
 
+    def current_device
+      # Return if @current_device is already initialized else check if the device exists with the api token present in request header
+      @current_device ||= authenticate_with_http_token { |token, options| Device.find_by(api_token: token)}
+      @current_registration = @current_device.registration if @current_device
+      @current_user = @current_registration.user if @current_registration
+    end
+
     def require_auth_token
       current_user
       unless @current_user
@@ -18,6 +24,20 @@ module Usman
       end
     end
 
+    def require_api_token
+      current_device
+      unless @current_device
+        proc_code = Proc.new do
+          set_notification_messages("authentication.permission_denied", :error)
+          raise AuthenticationError
+        end
+        render_json_response(proc_code)
+        return
+      else
+        @current_user = @current_device.try(:registration).try(:user)
+      end
+    end
+
     def require_super_admin_auth_token
       current_user
       unless @current_user && @current_user.is_super_admin?
@@ -41,40 +61,5 @@ module Usman
         return
       end
     end
-
-    def embed_stack_in_json_response?
-      return true if Rails.env.development?
-      Rails.env.production? && ["true", "t", "1", "yes"].include?(params[:debug].to_s.downcase.strip)
-    end
-
-    ## This method will accept a proc, execute it and render the json
-    def render_json_response(proc_code)
-
-      begin
-        proc_code.call
-        @success = @success == false ? (false) : (true)
-      rescue Exception => e
-        @success = false
-        @errors = { 
-                    heading: I18n.translate("general.unexpected_failure.heading"),
-                    message: I18n.translate("general.unexpected_failure.message"),
-                    details: e.message,
-                    stacktrace: (embed_stack_in_json_response? ? e.backtrace : nil)
-                  }
-      end
-      @status ||= 200
-
-      response_hash = {success: @success}
-      response_hash[:alert] = @alert unless @alert.blank?
-      response_hash[:data] = @data unless @data.blank?
-      response_hash[:errors] = @errors unless @errors.blank?
-      
-      response_hash[:total_data] = @total_data unless @total_data.blank?
-      response_hash[:per_page] = @per_page unless @per_page.blank?
-      response_hash[:current_page] = @current_page unless @current_page.blank?
-
-      render status: @status, json: response_hash
-      return
-    end
   end
 end

data/app/helpers/usman/authentication_helper.rb

@@ -7,7 +7,7 @@ module Usman
       # Return if @current_user is already initialized else check if the user exists with the auth token present in request header
       @current_user ||= authenticate_with_http_token { |token, options| User.find_by(auth_token: token)}
     end
-    
+
     # Returns the default URL to which the system should redirect the user after successful authentication
     def default_redirect_url_after_sign_in
       main_app.user_landing_url

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, :created_at, :updated_at]
+  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]
 
   PENDING = "pending"
   VERIFIED = "verified"
@@ -71,7 +71,8 @@ class Device < ApplicationRecord
     #options[:include] ||= []
     #options[:methods] = []
     #options[:methods] << :profile_image
-    super(options)
+    json = super(options)
+    Hash[*json.map{|k, v| [k, v || ""]}.flatten]
   end
   
   # Status Methods
@@ -154,7 +155,7 @@ class Device < ApplicationRecord
 
     # Check if this OTP was already verified
     if !self.otp_verified_at.blank?
-      validation_errors[:otp_verified_at] = "This OTP was already used."
+      validation_errors[:otp_verified_at] = "This OTP was already used"
       return false, validation_errors
     end
 
@@ -197,6 +198,32 @@ class Device < ApplicationRecord
     return true
   end
 
+  def accept_tac(tac, dialing_prefix, mobile_number)
+
+    # Validate OTP and other parameters
+    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"
+      return false, validation_errors
+    end
+
+    validation_errors[:mobile_number] = "doesn't match with our database" unless self.registration.mobile_number.to_s == mobile_number.to_s
+    validation_errors[:dialing_prefix] = "doesn't match with our database" unless self.registration.dialing_prefix.to_s == dialing_prefix.to_s
+    
+    return false, validation_errors unless validation_errors.empty?
+    
+    # Create API Token if OTP is verified
+    self.tac_accepted_at = Time.now
+    self.save
+
+    self.verify!
+    self.registration.verify!
+
+    return true, {}
+  end
+
   # Other Methods
   # -------------
 

data/app/models/registration.rb

@@ -36,8 +36,8 @@ class Registration < ApplicationRecord
   # == Examples
   #   >>> registration.search(query)
   #   => ActiveRecord::Relation object
-  scope :search, lambda {|query| joins("INNER JOIN users on users.id = registrations.user_id").
-                                where("LOWER(mobile_number) LIKE LOWER('%#{query}%') OR 
+  scope :search, lambda {|query| joins("LEFT JOIN users on users.id = registrations.user_id").
+                                where("LOWER(registrations.mobile_number) LIKE LOWER('%#{query}%') OR 
                                        LOWER(users.name) LIKE LOWER('%#{query}%')")}
   scope :status, lambda { |status| where("LOWER(status)='#{status}'") }
 
@@ -54,7 +54,8 @@ class Registration < ApplicationRecord
     #options[:include] ||= []
     #options[:methods] = []
     #options[:methods] << :profile_image
-    super(options)
+    json = super(options)
+    Hash[*json.map{|k, v| [k, v || ""]}.flatten]
   end
 
   # Status Methods
@@ -115,5 +116,13 @@ class Registration < ApplicationRecord
   def display_name
     "#{self.dialing_prefix} #{self.mobile_number}"
   end
+
+  # * Return city, country or just country if there is no city
+  # == Examples
+  #   >>> registration.display_location
+  #   => "Dubai, United Arab Emirates"
+  def display_location
+    [self.city.try(:name), self.country.try(:name)].compact.join(",")
+  end
 	
 end

data/app/models/user.rb

@@ -4,9 +4,6 @@ class User < Usman::ApplicationRecord
   has_secure_password
 
   # Constants
-
-  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]
-  
   PENDING = "pending"
   APPROVED = "approved"
   SUSPENDED = "suspended"
@@ -23,6 +20,22 @@ class User < Usman::ApplicationRecord
     "Suspended" => SUSPENDED
   }
 
+  MALE = "male"
+  FEMALE = "female"
+  NOGENDER = "nogender"
+
+  GENDER = { 
+    MALE => "Male", 
+    FEMALE => "Female", 
+    NOGENDER => "No Gender"
+  }
+
+  GENDER_REVERSE = { 
+    "Male" => MALE, 
+    "Female" => FEMALE, 
+    "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]
   DEFAULT_PASSWORD = "Password@1"
   SESSION_TIME_OUT = 120.minutes
@@ -34,6 +47,7 @@ class User < Usman::ApplicationRecord
   validate_password :password, condition_method: :should_validate_password?
 
   validates :status, :presence => true, :inclusion => {:in => STATUS.keys, :presence_of => :status, :message => "%{value} is not a valid status" }
+  validates :gender, :inclusion => {:in => GENDER.keys, :presence_of => :status, :message => "%{value} is not a valid gender" }, :allow_nil => true
 
   # Callbacks
   before_validation :generate_auth_token
@@ -57,7 +71,8 @@ class User < Usman::ApplicationRecord
     #options[:include] ||= []
     #options[:methods] = []
     #options[:methods] << :profile_image
-    super(options)
+    json = super(options)
+    Hash[*json.map{|k, v| [k, v || ""]}.flatten]
   end
   
   # Scopes Methods
@@ -178,6 +193,33 @@ class User < Usman::ApplicationRecord
     self.update_attribute(:status, SUSPENDED)
   end
 
+  # Gender Methods
+  # --------------
+
+  # * Return true if the user is male, else false.
+  # == Examples
+  #   >>> user.male?
+  #   => true
+  def male?
+    (gender == MALE)
+  end
+
+  # * Return true if the user is female, else false.
+  # == Examples
+  #   >>> user.female?
+  #   => true
+  def female?
+    (gender == FEMALE)
+  end
+
+  # * Return true if the user is nogender, else false.
+  # == Examples
+  #   >>> user.nogender?
+  #   => true
+  def nogender?
+    (gender == NOGENDER)
+  end
+
   # Authentication Methods
   # ----------------------
 
@@ -320,6 +362,14 @@ class User < Usman::ApplicationRecord
     "/assets/kuppayam/defaults/user-#{size}.png"
   end
 
+  def generate_username_and_password
+    self.username = SecureRandom.hex(4) unless self.username
+    # Password should contain at least one special character, integer and one upper case character
+    passwd = SecureRandom.hex(8) + "A@1" unless self.password
+    self.password = passwd
+    self.password_confirmation = passwd
+  end
+
   private
 
   def should_validate_password?

data/app/services/usman/mobile_registration_service.rb

@@ -44,9 +44,8 @@ module Usman
 
       if @registration.errors.any? or @device.errors.any?
         errors = @registration.errors.to_hash.merge(@device.errors.to_hash)
-        set_error("mobile_registration.invalid_inputs", errors)
+        set_error("api.mobile_registration.invalid_inputs", errors)
       end
-
     end
 
     def check_if_device_is_already_registered
@@ -61,7 +60,7 @@ module Usman
     def register_new_device
       
       if @device && @device.blocked?
-        set_error("mobile_registration.device_blocked")
+        set_error("api.mobile_registration.device_blocked")
         return
       end
 
@@ -96,7 +95,6 @@ module Usman
           raise ActiveRecord::Rollback 
         end
       end
-
     end
 
     def generate_new_otp
@@ -104,7 +102,7 @@ module Usman
       if @device.send_otp
         @device.update_attribute(:otp_sent_at, Time.now)
       else
-        set_error("mobile_registration.otp_not_sent")
+        set_error("api.mobile_registration.otp_not_sent")
       end
     end
 

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

@@ -0,0 +1,43 @@
+<ul class="nav tabs-vertical">
+  <li class="<%= nav_active?('docs/register') ? 'active' : ''  %>">
+    <a href="/docs/api/v1/register">
+      <i class="fa-globe visible-xs"></i>
+      <span class="hidden-xs">Register</span>
+    </a>
+  </li>
+  <li class="<%= nav_active?('docs/resend_otp') ? 'active' : ''  %>">
+    <a href="/docs/api/v1/resend_otp">
+      <i class="fa-globe visible-xs"></i>
+      <span class="hidden-xs">Resend OTP</span>
+    </a>
+  </li>
+  <li class="<%= nav_active?('docs/verify_otp') ? 'active' : ''  %>">
+    <a href="/docs/api/v1/verify_otp">
+      <i class="fa-globe visible-xs"></i>
+      <span class="hidden-xs">Verify OTP</span>
+    </a>
+  </li>
+  <li class="<%= nav_active?('docs/accept_tac') ? 'active' : ''  %>">
+    <a href="/docs/api/v1/accept_tac">
+      <i class="fa-globe visible-xs"></i>
+      <span class="hidden-xs">Terms & Conditions</span>
+    </a>
+  </li>
+  <li class="<%= nav_active?('docs/create_profile') ? 'active' : ''  %>">
+    <a href="/docs/api/v1/create_profile">
+      <i class="fa-globe visible-xs"></i>
+      <span class="hidden-xs">Create Profile</span>
+    </a>
+  </li>
+  <li class="<%= nav_active?('docs/update_profile') ? 'active' : ''  %>">
+    <a href="/docs/api/v1/update_profile">
+      <i class="fa-globe visible-xs"></i>
+      <span class="hidden-xs">Update Profile</span>
+    </a>
+  </li>
+</ul>
+
+<style type="text/css">
+  .panel-positive h4.panel-title a { color: #68b828 !important; }
+  .panel-negative h4.panel-title a { color: #cc3f44 !important; }
+</style>

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

@@ -0,0 +1,46 @@
+<%
+
+api_title = "Negative Case - 1 - should set proper errors if no input is given"
+
+api_input = <<-eos
+{}
+eos
+
+api_output = <<-eos
+{
+  "success": false,
+  "errors": {
+      "heading": "Registring new mobile number FAILED",
+      "message": "Check if all mandatory details are passed. Refer the error details for technical information",
+      "details": {
+          "country": [
+              "must exist"
+          ],
+          "dialing_prefix": [
+              "can't be blank",
+              "is too short (minimum is 2 characters)"
+          ],
+          "mobile_number": [
+              "can't be blank",
+              "is too short (minimum is 9 characters)"
+          ],
+          "uuid": [
+              "can't be blank"
+          ],
+          "device_token": [
+              "can't be blank"
+          ]
+      }
+  }
+}
+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/register/_neg_case_2.html.erb

@@ -0,0 +1,39 @@
+<%
+
+api_title = "Negative Case - 2 - should set proper errors when device information is missing"
+
+api_input = <<-eos
+{
+  "country_id": "1",
+  "dialing_prefix": "+92",
+  "mobile_number": "501370323"
+}
+eos
+
+api_output = <<-eos
+{
+  "success": false,
+  "errors": {
+      "heading": "Registring new mobile number FAILED",
+      "message": "Check if all mandatory details are passed. Refer the error details for technical information",
+      "details": {
+          "uuid": [
+              "can't be blank"
+          ],
+          "device_token": [
+              "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/register/_neg_case_3.html.erb

@@ -0,0 +1,47 @@
+<%
+
+api_title = "Negative Case - 3 - should set proper errors when registration information is missing"
+
+api_input = <<-eos
+{
+  "uuid": "jh01u2g01h301h21h23",
+  "device_token": "0182y3b28107b31",
+  "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": "Registring new mobile number FAILED",
+      "message": "Check if all mandatory details are passed. Refer the error details for technical information",
+      "details": {
+          "country": [
+              "must exist"
+          ],
+          "dialing_prefix": [
+              "can't be blank",
+              "is too short (minimum is 2 characters)"
+          ],
+          "mobile_number": [
+              "can't be blank",
+              "is too short (minimum is 9 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/register/_pos_case_1.html.erb

@@ -0,0 +1,65 @@
+<%
+
+api_title = "Positive Case - 1 - should register and add a new device"
+
+api_input = <<-eos
+{
+  "country_id": "1",
+  "city_id": "2",
+  "dialing_prefix": "+91",
+  "mobile_number": "501370321",
+  "uuid": "jh01u2g01h301h21h232",
+  "device_token": "0182y3b28107b31",
+  "device_name": "Apple iPhone",
+  "device_type": "iPhone 7 Plus",
+  "operating_system": "iOS",
+  "software_version": "iOS 11.2.2"
+}
+eos
+
+api_output = <<-eos
+{
+  "success": true,
+  "alert": {
+      "heading": "An OTP has been sent to you",
+      "message": "Check your mobile for new message from us."
+  },
+  "data": {
+      "registration": {
+          "id": 5,
+          "user_id": null,
+          "country_id": 1,
+          "city_id": null,
+          "dialing_prefix": "+91",
+          "mobile_number": "501370321"
+      },
+      "device": {
+          "id": 6,
+          "user_id": null,
+          "registration_id": 5,
+          "uuid": "jh01u2g01h301h21h232",
+          "device_token": "0182y3b28107b31",
+          "device_name": "Apple iPhone",
+          "device_type": "iPhone 7 Plus",
+          "operating_system": "iOS",
+          "software_version": "iOS 11.2.2",
+          "otp_verified_at": null
+      }
+  },
+  "errors": {
+      "heading": null,
+      "message": null,
+      "details": {}
+  }
+}
+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/resend_otp/_neg_case_1.html.erb

@@ -0,0 +1,30 @@
+<%
+
+api_title = "Negative Case - 1 - should set proper errors if no input is given"
+
+api_input = <<-eos
+{}
+eos
+
+api_output = <<-eos
+{
+  "success": false,
+  "errors": {
+      "heading": "Unexpected Failure",
+      "message": "We're sorry, but something went wrong (500)",
+      "details": {
+          "uuid": "is invalid"
+      }
+  }
+}
+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/resend_otp/_pos_case_1.html.erb

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

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

@@ -0,0 +1,34 @@
+<%
+
+api_title = "Negative Case - 1 - should set proper errors if no input is given"
+
+api_input = <<-eos
+{
+  "uuid": "asd907asdba78sbda",
+  "mobile_number": "292991230",
+  "dialing_prefix": "+91"
+}
+eos
+
+api_output = <<-eos
+{
+  "success": false,
+  "errors": {
+      "heading": "OTP verification was failed",
+      "message": "Make sure that you enter the OTP correctly.",
+      "details": {
+          "otp": "doesn't match with our database"
+      }
+  }
+}
+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 
+                                      } %>