usman 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dcf66615fd081189a376eedeb39266e06d8a2126
-  data.tar.gz: 311251208365a4a012a4c84ce59b776ef6d70a87
+  metadata.gz: 335b7ba4af0e58280de99aa7211b1d91d992de85
+  data.tar.gz: ea3bd4266a24ce29aa0b0602f3e7f4f89e820dda
 SHA512:
-  metadata.gz: 2d6df82e6a200bf4f973eda91c40888b828c1fe7ec9a4dfdb353e2b4c3665ae9debfd58e462a363530377e3797218f7d431578e5b50a4968cd97096d9e8cef86
-  data.tar.gz: d059b684edf4e98ff8936483186df1748b87d87e38a4c42a1f288522c516a0523efa8b1708a5d4751f0e53ff9e74fddc7f85aa899c78d089e22d045e3b643255
+  metadata.gz: 1f269b5fc47555878826becdcdc0499a56f199ae04e46e016fb3847add390e23e74aab6aec88f9a170bacd9860b4b96acf05329c40e4cd5a49bd5c570bce4325
+  data.tar.gz: 3d49ae90104d363911ff1ae39a0ea017020e47b4a8abc504b0cc6ec5522c243a1eae75bb85c27e890893cf866269c8cd2deec66671102883d00f6522795d4010

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

@@ -26,12 +26,50 @@ module Api
 
       def resend_otp
         proc_code = Proc.new do
+
         end
         render_json_response(proc_code)
       end
 
       def verify
         proc_code = Proc.new do
+          @device = Device.where("uuid = ?", params[:uuid]).first
+          if @device
+            if @device.blocked?
+              @success = false
+              @errors = {
+                heading: I18n.translate("mobile_registration.device_blocked.heading"),
+                message: I18n.translate("mobile_registration.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("mobile_registration.verification_success.heading"),
+                  message: I18n.translate("mobile_registration.verification_success.message")
+                }
+                @data = { api_token: @device.api_token }
+              else
+                @success = false
+                @errors = {
+                  heading: I18n.translate("mobile_registration.otp_not_matching.heading"),
+                  message: I18n.translate("mobile_registration.otp_not_matching.message"),
+                  details: validation_errors
+                }
+              end
+            end
+          else
+            @success = false
+            @errors = {
+              heading: I18n.translate("general.unexpected_failure.heading"),
+              message: I18n.translate("general.unexpected_failure.message"),
+              details: {
+                uuid: "is invalid"
+              }
+            }
+          end
         end
         render_json_response(proc_code)
       end

data/app/helpers/usman/api_helper.rb

@@ -43,7 +43,8 @@ module Usman
     end
 
     def embed_stack_in_json_response?
-      ["true", "t", "1", "yes"].include?(params[:debug].to_s.downcase.strip) # || Rails.env == "development"
+      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
@@ -55,9 +56,9 @@ module Usman
       rescue Exception => e
         @success = false
         @errors = { 
-                    heading: I18n.translate("response.unexpected_failure.heading"),
-                    message: e.message.underscore,
-                    details: I18n.translate("response.#{e.message.underscore}.details"),
+                    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

data/app/models/device.rb

@@ -1,6 +1,8 @@
 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]
+
   PENDING = "pending"
   VERIFIED = "verified"
   BLOCKED = "blocked"
@@ -63,6 +65,15 @@ class Device < ApplicationRecord
   # Instance Methods
   # ------------------
 
+  # Exclude some attributes info from json output.
+  def as_json(options={})
+    options[:except] ||= EXCLUDED_JSON_ATTRIBUTES
+    #options[:include] ||= []
+    #options[:methods] = []
+    #options[:methods] << :profile_image
+    super(options)
+  end
+  
   # Status Methods
   # --------------
 
@@ -135,6 +146,41 @@ class Device < ApplicationRecord
     self.otp = rand(10000..99999)
   end
 
+  def validate_otp(otp, dialing_prefix, mobile_number)
+
+    # Validate OTP and other parameters
+    validation_errors = {}
+
+    # TODO - remove 11111 after implementing Twilio
+    validation_errors[:otp] = "doesn't match with our database" unless (self.otp.to_s == otp.to_s || self.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
+    validation_errors[:dialing_prefix] = "doesn't match with our database" unless self.registration.dialing_prefix.to_s == dialing_prefix.to_s
+    
+    if validation_errors.empty?
+      if self.otp_verified_at.blank?
+
+        # Create API Token if OTP is verified
+        self.otp_verified_at = Time.now
+        self.api_token = SecureRandom.hex
+        self.token_created_at = Time.now
+        self.save
+
+        self.verify!
+        self.registration.verify!
+
+        return true, {}
+      else
+
+        # Check if this OTP was already verified
+        validation_errors[:otp_verified_at] = "This OTP was already used."
+
+        return false, validation_errors
+      end
+    else
+      return false, validation_errors
+    end
+  end
+
   # Other Methods
   # -------------
 

data/app/models/registration.rb

@@ -1,6 +1,8 @@
 class Registration < ApplicationRecord
   
   # Constants
+  EXCLUDED_JSON_ATTRIBUTES = [:status, :created_at, :updated_at]
+
   PENDING = "pending"
   VERIFIED = "verified"
   
@@ -15,7 +17,7 @@ class Registration < ApplicationRecord
   }
   
 	# Associations
-  has_one :user
+  belongs_to :user, optional: true
   belongs_to :country
   belongs_to :city, optional: true
   has_many :devices
@@ -46,6 +48,15 @@ class Registration < ApplicationRecord
   # Instance Methods
   # ------------------
 
+  # Exclude some attributes info from json output.
+  def as_json(options={})
+    options[:except] ||= EXCLUDED_JSON_ATTRIBUTES
+    #options[:include] ||= []
+    #options[:methods] = []
+    #options[:methods] << :profile_image
+    super(options)
+  end
+
   # Status Methods
   # --------------
 

data/app/models/user.rb

@@ -4,6 +4,9 @@ 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"
@@ -48,6 +51,15 @@ class User < Usman::ApplicationRecord
   # Class Methods
   # ------------------
 
+  # Exclude some attributes info from json output.
+  def as_json(options={})
+    options[:except] ||= EXCLUDED_JSON_ATTRIBUTES
+    #options[:include] ||= []
+    #options[:methods] = []
+    #options[:methods] << :profile_image
+    super(options)
+  end
+  
   # Scopes Methods
 
   # return an active record relation object with the search query in its where clause

data/app/services/usman/mobile_registration_service.rb

@@ -13,6 +13,8 @@ module Usman
       @dialing_prefix = params[:dialing_prefix]
       @mobile_number = params[:mobile_number]
       
+      @country = nil
+      @city = nil
       @country = Country.find_by_id(params[:country_id])
       @city = City.find_by_id(params[:city_id])
 
@@ -50,8 +52,8 @@ module Usman
     def check_if_device_is_already_registered
       @registration = Registration.where("LOWER(mobile_number) = LOWER('#{@mobile_number}')").first
       if @registration
-        @country = @registration.country unless @country
-        @city = @registration.city unless @city
+        @registration.country = @country
+        @registration.city = @city
       end
       @device = Device.where("LOWER(uuid) = LOWER('#{@uuid}')").first if @registration
     end

data/config/locales/usman/general.ar.yml

@@ -0,0 +1,5 @@
+en:
+  general:
+    unexpected_failure:
+      heading: "Unexpected Failure"
+      message: "We're sorry, but something went wrong (500)"

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

@@ -0,0 +1,5 @@
+en:
+  general:
+    unexpected_failure:
+      heading: "Unexpected Failure"
+      message: "We're sorry, but something went wrong (500)"

data/config/locales/usman/mobile_registration.ar.yml

@@ -11,4 +11,13 @@ en:
       message: "Check your mobile for new message from us."
     otp_not_sent:
       heading: "OTP was not sent"
-      message: "There was some technical glitch and OTP was not sent. Try after some time."  
+      message: "There was some technical glitch and OTP was not sent. Try after some time."
+    otp_not_matching:
+      heading: "OTP verification was failed"
+      message: "Make sure that you enter the OTP correctly."  
+    verification_failed:
+      heading: "OTP verification was failed"
+      message: "Check if you have properly given the OTP along with dialing prefix, mobile number & UUID"
+    verification_success:
+      heading: "OTP was verified succesfully"
+      message: "Store and use the API token for further communication"

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

@@ -11,4 +11,13 @@ en:
       message: "Check your mobile for new message from us."
     otp_not_sent:
       heading: "OTP was not sent"
-      message: "There was some technical glitch and OTP was not sent. Try after some time."  
+      message: "There was some technical glitch and OTP was not sent. Try after some time."
+    otp_not_matching:
+      heading: "OTP verification was failed"
+      message: "Make sure that you enter the OTP correctly."  
+    verification_failed:
+      heading: "OTP verification was failed"
+      message: "Check if you have properly given the OTP along with dialing prefix, mobile number & UUID"
+    verification_success:
+      heading: "OTP was verified succesfully"
+      message: "Store and use the API token for further communication"

data/config/routes.rb

@@ -38,8 +38,8 @@ Usman::Engine.routes.draw do
   namespace :api do
     namespace :v1 do
       post :register, :controller => "/api/v1/registrations"
-      #post :resend_otp, :controller => "/api/v1/registrations"
-      #post :verify, :controller => "/api/v1/registrations"
+      post :resend_otp, :controller => "/api/v1/registrations"
+      post :verify, :controller => "/api/v1/registrations"
     end
   end
 

data/db/migrate/20170825020624_add_otp_verified_at_to_devices.rb

@@ -0,0 +1,5 @@
+class AddOtpVerifiedAtToDevices < ActiveRecord::Migration[5.1]
+  def change
+    add_column :devices, :otp_verified_at, :datetime
+  end
+end

data/lib/usman/version.rb

@@ -1,3 +1,3 @@
 module Usman
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: usman
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - kpvarma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-24 00:00:00.000000000 Z
+date: 2017-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -413,6 +413,8 @@ files:
 - app/views/usman/users/index.html.erb
 - config/locales/usman/authentication.ar.yml
 - config/locales/usman/authentication.en.yml
+- config/locales/usman/general.ar.yml
+- config/locales/usman/general.en.yml
 - config/locales/usman/mobile_registration.ar.yml
 - config/locales/usman/mobile_registration.en.yml
 - config/routes.rb
@@ -431,6 +433,7 @@ files:
 - db/migrate/20170819113217_create_registrations.rb
 - db/migrate/20170819113218_add_registration_id_to_users.rb
 - db/migrate/20170819113219_create_devices.rb
+- db/migrate/20170825020624_add_otp_verified_at_to_devices.rb
 - lib/tasks/usman/data.rake
 - lib/tasks/usman/master_data.rake
 - lib/temp/features.rake