usman 0.2.3 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d15538692688eced6623bc7a704c298dfa89d783
-  data.tar.gz: ecf244d046e8c804049dedd9a2ad28afe8bc4084
+  metadata.gz: be37dd5242c311e6541ccfb190c9aa54597526cb
+  data.tar.gz: 0d2bef201228c383b53ea972b213d416cf0851c4
 SHA512:
-  metadata.gz: b72c15eb8d09f6fea21e023f8fdd43f66c0cb5044361b8af94ddda70d7968aa5dfa0950ef22bd75055bea01e51e2dcb9c0e65a46e959627e615bcd35e21493ce
-  data.tar.gz: 22d49bd7fed9f246b29583489abbd59ad40458a65f24e5551ec9d3bc304158b57977a1951fdc2496f4a5861999b63826b36a3ea3fb952d548d81d603b741a7b8
+  metadata.gz: 31ccc69fc7604ce950a96d97615ac345b6197cf1c8a1c45d6433762410c80d47ca8a2fdec01ea7682dbc0d435815948b5b3a57e4e442518f71f011857ec44e66
+  data.tar.gz: 77dbcef014783e75b470eab8a572f5f88c8c5c98ea185a8bd0c6e23609e0e2400edb3636fcb94e9cb2f028fb281a503bbe0b4e48808447c7acb0181a66412b32

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

@@ -0,0 +1,15 @@
+module Usman
+  module Api
+    module V1
+      class BaseController < ActionController::API
+
+        include ActionController::HttpAuthentication::Token::ControllerMethods
+        include RenderApiHelper
+        include Usman::ApiHelper
+        
+        before_action :require_api_token
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+module Usman
+  module Api
+    module V1
+      class DocsBaseController < Kuppayam::BaseController
+
+        include Usman::AuthenticationHelper
+        
+        layout 'kuppayam/docs'
+
+        before_action :current_user
+
+        private
+
+        def breadcrumbs_configuration
+          {
+            heading: "Usman - API Documentation",
+            description: "A brief documentation of all APIs implemented in the gem Usman with input and output details and examples",
+            links: []
+          }
+        end
+        
+      end
+    end
+  end
+end

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

@@ -0,0 +1,165 @@
+module Usman
+  module Api
+    module V1
+      class DocsController < DocsBaseController
+
+        def register
+          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"
+
+          @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. " }
+          }
+
+          @input_params = {
+            country_id: { mandatory: true, description: "Country ID is an integer. You may get it from Countries API", example: "100", default: "" },
+            city_id: { mandatory: false, description: "City ID is an integer. You may get it from Cities API", example: "1030", default: "" },
+            dialing_prefix: { mandatory: true, description: "International Dialing Prefix for countries", example: "+971", default: "" },
+            mobile_number: { mandatory: true, description: "Mobile Number without Dialing Prefix", example: "If your mobile number is +971 54 312 9876, pass '543129876' without spaces.", default: "" },
+            uuid: { mandatory: true, description: "Universal Unique Identifier. iOS or Android will give you this programatically.", example: "", default: "" },
+            device_token: { mandatory: true, description: "Device Token is a unique token for your device", example: "", default: "" },
+            device_name: { mandatory: false, description: "The name of your Device", example: "Apple iPhone", default: "" },
+            device_type: { mandatory: false, description: "", example: "The kind of device you have", default: "iPhone 7 plus" },
+            operating_system: { mandatory: false, description: "Operating System Name", example: "", default: "" },
+            software_version: { mandatory: false, description: "Software / OS Version", example: "", default: "" }
+          }
+
+          @example_path = "usman/api/v1/docs/"
+          @examples = ["pos_case_1", "neg_case_1", "neg_case_2", "neg_case_3"]
+
+          set_nav("docs/register")
+
+          render 'kuppayam/api/docs/show'
+        end
+
+        def resend_otp
+          set_title("Resend OTP API")
+          @request_type = "POST"
+          @end_point = "/api/v1/resend_otp"
+          @description = "This API will resend the OTP for verification"
+
+          @warning = "A maximum of 3 attempt is allowed for resending the OTP. 6th request will block the device."
+          
+          @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. " }
+          }
+
+          @input_params = {
+            uuid: { mandatory: true, description: "Universal Unique Identifier. iOS or Android will give you this programatically.", example: "", default: "" },
+            dialing_prefix: { mandatory: true, description: "International Dialing Prefix for countries", example: "+971", default: "" },
+            mobile_number: { mandatory: true, description: "Mobile Number without Dialing Prefix", example: "If your mobile number is +971 54 312 9876, pass '543129876' without spaces.", default: "" }
+          }
+
+          @example_path = "usman/api/v1/docs/"
+          @examples = ["pos_case_1", "neg_case_1"]
+
+          set_nav("docs/resend_otp")
+
+          render 'kuppayam/api/docs/show'
+        end
+
+        def verify_otp
+          set_title("Verify OTP API")
+          @request_type = "POST"
+          @end_point = "/api/v1/verify_otp"
+          @description = "This API verify the OTP and returns the API token for further communication"
+          
+          @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. " }
+          }
+
+          @input_params = {
+            otp: { mandatory: true, description: "One Time Password you have received via SMS. (Five Digit)", example: "", default: "" },
+            uuid: { mandatory: true, description: "Universal Unique Identifier. iOS or Android will give you this programatically.", example: "", default: "" },
+            dialing_prefix: { mandatory: true, description: "International Dialing Prefix for countries", example: "+971", default: "" },
+            mobile_number: { mandatory: true, description: "Mobile Number without Dialing Prefix", example: "If your mobile number is +971 54 312 9876, pass '543129876' without spaces.", default: "" }
+          }
+
+          @example_path = "usman/api/v1/docs/"
+          @examples = ["pos_case_1", "neg_case_1", "neg_case_2", "neg_case_3"]
+
+          set_nav("docs/verify_otp")
+
+          render 'kuppayam/api/docs/show'
+        end
+
+        def accept_tac
+          set_title("Accept T&C API")
+          @request_type = "POST"
+          @end_point = "/api/v1/accept_tac"
+          @description = "This API record the acceptance of the terms and condition."
+          
+          @info = "The user will have to accept terms and conditions everytime he registers a new device"
+          
+          @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. " }
+          }
+
+          @input_params = {
+            uuid: { mandatory: true, description: "Universal Unique Identifier. iOS or Android will give you this programatically.", example: "", default: "" },
+            dialing_prefix: { mandatory: true, description: "International Dialing Prefix for countries", example: "+971", default: "" },
+            mobile_number: { mandatory: true, description: "Mobile Number without Dialing Prefix", example: "If your mobile number is +971 54 312 9876, pass '543129876' without spaces.", default: "" }
+          }
+
+          @example_path = "usman/api/v1/docs/"# 
+          # @examples = ["pos_case_1", "neg_case_1", "neg_case_2", "neg_case_3"]
+
+          set_nav("docs/accept_tac")
+
+          render 'kuppayam/api/docs/show'
+        end
+
+        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"
+          
+          @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. " }
+          }
+
+          @input_params = {
+            uuid: { mandatory: true, description: "Universal Unique Identifier. iOS or Android will give you this programatically.", example: "", default: "" },
+            dialing_prefix: { mandatory: true, description: "International Dialing Prefix for countries", example: "+971", default: "" },
+            mobile_number: { mandatory: true, description: "Mobile Number without Dialing Prefix", example: "If your mobile number is +971 54 312 9876, pass '543129876' without spaces.", default: "" }
+          }
+
+          @example_path = "usman/api/v1/docs/"# 
+          # @examples = ["pos_case_1", "neg_case_1", "neg_case_2", "neg_case_3"]
+
+          set_nav("docs/create_profile")
+
+          render 'kuppayam/api/docs/show'
+        end
+
+        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"
+          
+          @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. " }
+          }
+
+          @input_params = {
+            uuid: { mandatory: true, description: "Universal Unique Identifier. iOS or Android will give you this programatically.", example: "", default: "" },
+            dialing_prefix: { mandatory: true, description: "International Dialing Prefix for countries", example: "+971", default: "" },
+            mobile_number: { mandatory: true, description: "Mobile Number without Dialing Prefix", example: "If your mobile number is +971 54 312 9876, pass '543129876' without spaces.", default: "" }
+          }
+
+          @example_path = "usman/api/v1/docs/"# 
+          # @examples = ["pos_case_1", "neg_case_1", "neg_case_2", "neg_case_3"]
+
+          set_nav("docs/update_profile")
+
+          render 'kuppayam/api/docs/show'
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+module Usman
+  module Api
+    module V1
+      class ProfileController < Usman::Api::V1::BaseController
+
+        def create_profile
+          proc_code = Proc.new do
+            
+            if @current_registration
+              if @current_user
+                @success = false
+                @errors = {
+                  heading: I18n.translate("api.profile.user_already_exists.heading"),
+                  message: I18n.translate("api.profile.user_already_exists.message")
+                }
+              else
+                @user = User.new
+                @user.name = permitted_params[:name]
+                @user.generate_username_and_password
+                @user.gender = permitted_params[:gender]
+                @user.date_of_birth = permitted_params[:date_of_birth]
+                @user.email = permitted_params[:email]
+                if @user.valid?
+                  @current_registration.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
+                          }
+                else
+                  @errors = @user.errors
+                  @success = false
+                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
+          end
+          render_json_response(proc_code)
+        end
+
+        private
+
+        def permitted_params
+          params.require(:profile).permit(:name, :gender, :date_of_birth, :email, :country_id, :city_id)
+        end
+
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,159 @@
+module Usman
+  module Api
+    module V1
+      class RegistrationsController < Usman::Api::V1::BaseController
+
+        skip_before_action :require_api_token      
+
+        def register
+          proc_code = Proc.new do
+            @reg_data = Usman::MobileRegistrationService.new(params)
+            @errors = @reg_data.errors
+            @success = false
+            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")
+              }
+              @data = {
+                        registration: @reg_data.registration,
+                        device: @reg_data.device
+                      }
+            end
+          end
+          render_json_response(proc_code)
+        end
+
+        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
+                  @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
+                  }
+                end
+              end
+            else
+              @success = false
+              @errors = {
+                heading: I18n.translate("api.general.unexpected_failure.heading"),
+                message: I18n.translate("api.general.unexpected_failure.message"),
+                details: {
+                  uuid: "is invalid"
+                }
+              }
+            end
+          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("api.mobile_registration.device_blocked.heading"),
+                  message: I18n.translate("api.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("api.mobile_registration.verification_success.heading"),
+                    message: I18n.translate("api.mobile_registration.verification_success.message")
+                  }
+                else
+                  @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
+                  }
+                end
+              end
+            else
+              @success = false
+              @errors = {
+                heading: I18n.translate("api.general.unexpected_failure.heading"),
+                message: I18n.translate("api.general.unexpected_failure.message"),
+                details: {
+                  uuid: "is invalid"
+                }
+              }
+            end
+          end
+          render_json_response(proc_code)
+        end
+
+        def accept_tac
+          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.accept_tac(params[:terms_and_conditions], params[:dialing_prefix], params[:mobile_number])
+                if valid
+                  @success = true
+                  @alert = {
+                    heading: I18n.translate("api.mobile_registration.tac_accepted.heading"),
+                    message: I18n.translate("api.mobile_registration.tac_accepted.message")
+                  }
+                  @data = { api_token: @device.api_token }
+                else
+                  @success = false
+                  @errors = {
+                    heading: I18n.translate("api.mobile_registration.tac_not_accepted.heading"),
+                    message: I18n.translate("api.mobile_registration.tac_not_accepted.message"),
+                    details: validation_errors
+                  }
+                end
+              end
+            else
+              @success = false
+              @errors = {
+                heading: I18n.translate("api.general.unexpected_failure.heading"),
+                message: I18n.translate("api.general.unexpected_failure.message"),
+                details: {
+                  uuid: "is invalid"
+                }
+              }
+            end
+          end
+          render_json_response(proc_code)
+        end
+      end
+    end
+  end
+end
+

data/app/controllers/usman/registration_devices_controller.rb

@@ -0,0 +1,141 @@
+module Usman
+  class RegistrationDevicesController < ResourceController
+
+    before_action :require_site_admin
+    before_action :get_registration
+    
+    def index
+      get_collections
+      respond_to do |format|
+        format.html {}
+        format.js  { 
+          js_view_path = @resource_options && @resource_options[:js_view_path] ? "#{@resource_options[:js_view_path]}/index" : :index 
+          render js_view_path
+        }
+      end
+    end
+
+    def show
+      @device = @r_object = @resource_options[:class].find_by_id(params[:id])
+      set_notification(false, I18n.t('status.error'), I18n.t('status.not_found', item: default_item_name.titleize)) unless @r_object
+      render_accordingly
+    end
+
+    def new
+      @device = Device.new
+      render_accordingly
+    end
+
+    def create
+      @device = @r_object = Device.find_by_id(permitted_params[:id])
+      if @device.add_registration(@registration)
+        set_notification(true, I18n.t('status.success'), "Registration '#{@registration.name}' has been assigned to the device '#{@device.name}'")
+      else
+        set_notification(false, I18n.t('status.success'), "Failed to assign the Registration '#{@registration.name}'")
+      end
+      action_name = params[:action].to_s == "create" ? "new" : "edit"
+      render_or_redirect(false, resource_url(@r_object), action_name)
+    end
+
+    def destroy
+      @device = @r_object = Device.find_by_id(params[:id])
+      if @device
+        if @device.remove_registration(@registration)
+          get_collections
+          set_flash_message(I18n.t('success.deleted'), :success)
+          set_notification(true, I18n.t('status.success'), "Registration '#{@registration.name}' has been removed for the device '#{@device.name}'")
+          @destroyed = true
+        else
+          message = I18n.t('errors.failed_to_delete', item: default_item_name.titleize)
+          set_flash_message(message, :failure)
+          set_notification(false, I18n.t('status.success'), "Failed to remove the Registration '#{@registration.name}'")
+          @destroyed = false
+        end
+      else
+        set_notification(false, I18n.t('status.error'), I18n.t('status.not_found', item: default_item_name.titleize))
+      end
+
+      respond_to do |format|
+        format.html {}
+        format.js  { 
+          js_view_path = @resource_options && @resource_options[:js_view_path] ? "#{@resource_options[:js_view_path]}/destroy" : :destroy 
+          render js_view_path
+        }
+      end
+
+    end
+
+    private
+
+    def get_registration
+      @registration = Registration.find_by_id(params[:registration_id])
+    end
+
+    def get_collections
+      @relation = @registration.devices.where("")
+
+      parse_filters
+      apply_filters
+      
+      @devices = @r_objects = @relation.page(@current_page).per(@per_page)
+      
+      return true
+    end
+
+    def apply_filters
+      @relation = @relation.search(@query) if @query
+      
+      @order_by = "devices.created_at DESC" unless @order_by
+      @relation = @relation.order(@order_by)
+    end
+
+    def configure_filter_settings
+      @filter_settings = {
+        string_filters: [
+          { filter_name: :query }
+        ],
+        boolean_filters: [],
+        reference_filters: [],
+        variable_filters: [],
+      }
+    end
+
+    def configure_filter_ui_settings
+      @filter_ui_settings = {}
+    end
+
+    def resource_url(obj)
+      url_for([@registration, obj])
+    end
+
+    def resource_controller_configuration
+      {
+        collection_name: :devices,
+        item_name: :device,
+        class: Device,
+        show_modal_after_create: false,
+        show_modal_after_update: false,
+        page_title: "Manage Device Registrations",
+        js_view_path: "/kuppayam/workflows/parrot",
+        view_path: "/usman/registration_devices"
+      }
+    end
+
+    def breadcrumbs_configuration
+      {
+        heading: "Manage Device Registrations",
+        description: "Listing all Device Registrations",
+        links: [{name: "Home", link: dashboard_path, icon: 'fa-home'}]
+      }
+    end
+
+    def permitted_params
+      params.require(:device).permit(:id)
+    end
+
+    def set_navs
+      set_nav("admin/registrations")
+    end
+
+  end
+end

data/app/controllers/usman/registrations_controller.rb

@@ -0,0 +1,68 @@
+module Usman
+  class RegistrationsController < ResourceController
+
+    before_action :require_site_admin
+    
+    private
+
+    def get_collections
+      @relation = Registration.where("")
+
+      parse_filters
+      apply_filters
+      
+      @registrations = @r_objects = @relation.page(@current_page).per(@per_page)
+
+      return true
+    end
+
+    def apply_filters
+      @relation = @relation.search(@query) if @query
+      
+      @order_by = "created_at DESC" unless @order_by
+      @relation = @relation.order(@order_by)
+    end
+
+    def configure_filter_settings
+      @filter_settings = {
+        string_filters: [
+          { filter_name: :query }
+        ],
+        boolean_filters: [],
+        reference_filters: [],
+        variable_filters: [],
+      }
+    end
+
+    def configure_filter_ui_settings
+      @filter_ui_settings = {}
+    end
+
+    def resource_controller_configuration
+      {
+        page_title: "Registrations",
+        js_view_path: "/kuppayam/workflows/peacock",
+        view_path: "/usman/registrations"
+      }
+    end
+
+    def breadcrumbs_configuration
+      {
+        heading: "Manage Registrations",
+        icon: "fa-lock",
+        description: "Listing all Registrations",
+        links: [{name: "Home", link: dashboard_path, icon: 'fa-home'}, 
+                  {name: "Manage Registrations", link: registrations_path, icon: 'fa-calendar', active: true}]
+      }
+    end
+
+    def permitted_params
+      params.require(:registration).permit(:mobile_number, :dialing_prefix, :country_id, :city_id)
+    end
+
+    def set_navs
+      set_nav("admin/registrations")
+    end
+
+  end
+end