housing_misc 0.5.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d14aaaac7217beda43bfc468aa10e03f5147b6931dcba22b4de9c16612b59e03
+  data.tar.gz: '08c758b5e30e795abc3cba9c575fcf3f43e7a8bfe8e648fd399e05fca2471591'
+SHA512:
+  metadata.gz: 20c039487a4e67d5f64a9e888023f6beb65fe5e822380f081d997629f319a88f14e41aecfc688a01f8b5c72fa842c8b47b2dc69c2499810acc57fe950a662f39
+  data.tar.gz: 9607cd387341a8786d11ea4bd88ec821e1f8c8d27dc84326f3811acb262a1ef362285c3463ca3dc373437d87be0e92ac22ec327e69255c6bd0f22e337e61830d

data/README.md

@@ -0,0 +1,125 @@
+# housing.misc.gem
+
+## Installation
+```ruby
+gem 'housing_misc'
+```
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install housing_misc
+
+## Functions Provided
+
+```ruby
+get_request_attribute_value(headers, params, key)
+```
+> Parameters:
+>
+1. headers (data_type: ActionDispatch::Http::Headers)
+2. params (data_type: ActionController::Parameters)
+3. key (data_type: String, description: Name of the attribute whose value is needed)
+
+> Description: Returns value against the key present in headers or params, first checks in headers if it's not there then checks in params
+
+ 
+
+```ruby
+is_request_internal?(request)
+```
+> Parameters:
+>
+1. request (data_type: ActionDispatch::Request)
+
+> Description: Checks if the request passes internal host validation or not based on Rails environment and request's host and returns bool value
+
+ 
+
+```ruby
+is_request_from_mobile?(request, params, velocity_salt)
+```
+> Parameters:
+>
+1. request (data_type: ActionDispatch::Request)
+2. params (data_type: ActionController::Parameters)
+3. velocity_salt (data_type: String, description: Salt to verify signed param with time stamp)
+
+> Description: Checks if the request is from mobile or not based on source, time stamp, signed param and salt and returns bool value
+
+ 
+
+```ruby
+is_request_csrf_valid?(request, cookies, params, csrf_encryption_key, velocity_salt)
+```
+> Parameters:
+>
+1. request (data_type: ActionDispatch::Request)
+2. cookies (data_type: ActionDispatch::Cookies::CookieJar)
+3. params (data_type: ActionController::Parameters)
+4. csrf_encryption_key (data_type: String, length: 64 characters (0-9, a-f) i.e. 32 bytes, description: Encryption key to generate csrf token. This key should be kept secret between servers.)
+5. velocity_salt (data_type: String, description: Salt to verify signed param with time stamp)
+
+> Description: Checks if the request passes csrf validation or not and returns bool value
+
+ 
+
+```ruby
+internal_host_check
+```
+> Description: Checks if the request passes internal host validation or not. If the validation fails then logs information in /log/unauthorized_api_requests.log and renders :json => {:message => "You are not authorized to make this call"}, status: 401
+
+> Note: It can only be called from controller as it uses request (ActionDispatch::Request)
+
+> Usage: In your controller:
+```ruby
+include HousingMisc
+before_action :internal_host_check, :only => [:method_1, :method_2, ...]
+```
+
+ 
+
+```ruby
+send_generic_mail(template_slug, template_version, users, base_vars, merge_vars, high_priority=false, attachments=[], deferred=false, send_time=nil, google_analytics_campaign=nil)
+```
+> Parameters:
+>
+1. template_slug (data_type:string, descriptinon:contains name of the template)
+2. template_version (data_type: string, description:version of mail_template e.g. "1")
+3. users (data_type: [{"email" => "xyz", "name" => "m"}], description: array of email ids)
+4. base_vars (data_type: Hash, desciption: contains subject and callback_url)
+5. merge_vars (data_type: Hash, description: includes vars that are embedded in mail)
+6. high_priority (data_type : boolean, description:decides the priority of mail)
+7. attachments (:data_type : [], deacription: contains attachments to mail)
+8. deferred (data_type : boolean, description:decides if mail is to be sent later)
+9. send_time (data_tpe: Time, desciption: e.g. 2018-04-06 15:55:33 +0530, nil=send_now)
+10. google_analytics_campaign(data_type: string, description: Name of campaign)
+
+
+> Description: Sends mail for a given template and its version to mentioned users.
+
+ 
+
+```ruby
+csrf_check(csrf_encryption_key, velocity_salt)
+```
+> Parameters:
+>
+1. csrf_encryption_key (data_type: String, length: 64 characters (0-9, a-f) i.e. 32 bytes, description: Encryption key to generate csrf token. This key should be kept secret between servers.)
+
+2. velocity_salt (data_type: String, description: Salt to verify signed param with time stamp)
+
+> Description: Checks if the request passes csrf validation or not. If the validation fails then logs information in /log/unauthorized_api_requests.log and renders :json => {:message => "You are not authorized to make this call"}, status: 401
+
+> Note: It can only be called from controller as it uses request (ActionDispatch::Request), cookies (ActionDispatch::Cookies::CookieJar) and params (ActionController::Parameters)
+
+> Usage: In your controller:
+```ruby
+include HousingMisc
+before_action :only => [:method_1, :method_2, ...] do
+    csrf_check(Housing.csrf_encryption_key)
+end
+```
+

data/app/controllers/housing_misc/application_controller.rb

@@ -0,0 +1,11 @@
+module HousingMisc
+  class ApplicationController < ::ActionController::Base
+    before_action :new_relic_custom_params
+
+    def new_relic_custom_params
+      ::NewRelic::Agent.add_custom_attributes(:http_referer =>  request.referer)
+      ::NewRelic::Agent.add_custom_attributes(:referring_app =>  request.headers["app-name"])
+      ::NewRelic::Agent.add_custom_attributes(:global_request_id =>  Thread.current[:global_request_id])
+    end
+  end
+end

data/app/controllers/housing_misc/cache_controller.rb

@@ -0,0 +1,11 @@
+module HousingMisc
+  class CacheController < ApplicationController
+    def show 
+      render json: {data: {}, message: "cache key misisng", status: 404}, status: 404 if params['cache_key'].blank?
+      data = Rails.cache.read(params['cache_key'])
+      success_message, error_message = ["success", "not found"]
+      data, message, status = data.present? ? [JSON.parse(data), success_message, 200] : [{}, error_message, 404]
+      render json: {message: message, status: status, data: data }, status: status
+    end
+  end
+end

data/app/controllers/housing_misc/logs_controller.rb

@@ -0,0 +1,25 @@
+module HousingMisc
+  class LogsController < ApplicationController
+    include ApiHelper
+    before_action :validate_params
+
+    def push_logs
+      file_name = params[:file_name]
+      begin
+        file_path = "#{Rails.root}/log/#{file_name}"
+        response = upload_log_to_s3(file_path)
+        render json: {message: "Your file has been uploaded in bucket: #{HousingMisc.bucket}"}
+      rescue => e
+        render json: {message: e.message }, status: 422
+      end
+    end
+
+
+    private
+
+    def validate_params
+      render json: {message: "file name is mandatory"}, status: 422 and return if params[:file_name].blank?
+    end
+
+  end
+end

data/app/controllers/housing_misc/model_reflections_controller.rb

@@ -0,0 +1,172 @@
+module HousingMisc
+  class ModelReflectionsController < ApplicationController
+    include ModelsReflectionsHelper
+    include HousingMisc::ApiHelper
+    before_action :validate_params
+    before_action :internal_host_check
+
+  def check_permission
+    return false
+  end
+
+=begin
+  *Author*  Prabal Partap
+  <b>Date</b>5 March, 2019
+  <b>Short Description</b> Api to get reflections(associations) of the given models and also the models associated with those models(found in reflections of those models) 
+  <b>Endpoints</b> Database Prunning Service
+  <b>Request Type</b> GET
+  <b>Route </b> /model_reflections
+  <b>Authentication Required</b> its an internal API hence no authentication
+  <b>Request Format</b>
+  {
+    "models" : "WhatsappPermission,SmsRequest"
+  }
+  <b>unsuccesful Response</b>
+  {
+    "message" : "Bad request",
+    "error" : "incorrect model names, don't give spaces after model names"
+  }
+  <b>succesful Response</b>
+  {
+    "message": "succesful",
+    "error": "",
+    {
+      "whatsapp_permissions": {
+        "subscriptions": {
+          "table_name": "subscriptions",
+          "macros": [
+              "belongs_to"
+          ],
+          "throughs": [
+             "FALSE"
+          ],
+          "foreign_keys": [
+            "number"
+          ],
+          "primary_keys": [
+            "number"
+          ],
+          "model_name": "Subscription"
+        }
+      },
+      "sms_requests": {
+        "statuses": {
+          "table_name": "statuses",
+          "macros": [
+            "belongs_to"
+          ],
+          "throughs": [
+            "FALSE"
+          ],
+          "foreign_keys": [
+            "status_id"
+          ],
+          "primary_keys": [
+            "id"
+          ],
+          "model_name": "::Status"
+        },
+        "sms_templates": {
+          "table_name": "sms_templates",
+          "macros": [
+            "belongs_to"
+          ],
+          "throughs": [
+            "FALSE"
+          ],
+          "foreign_keys": [
+            "template_id"
+          ],
+          "primary_keys": [
+            "id"
+          ],
+          "model_name": "::SmsTemplate"
+        }
+      },
+      "subscriptions": {
+        "whatsapp_permissions": {
+          "table_name": "whatsapp_permissions",
+          "macros": [
+            "has_many"
+          ],
+          "throughs": [
+            "FALSE"
+          ],
+          "foreign_keys": [
+            "number"
+          ],
+          "primary_keys": [
+            "number"
+          ],
+          "model_name": "WhatsappPermission"
+        }
+      },
+      "statuses": {},
+      "sms_templates": {
+        "gateway_types": {
+          "table_name": "gateway_types",
+          "macros": [
+            "belongs_to"
+          ],
+          "throughs": [
+            "FALSE"
+          ],
+          "foreign_keys": [
+            "gateway_type_id"
+          ],
+          "primary_keys": [
+            "id"
+          ],
+          "model_name": "GatewayType"
+        }
+      },
+      "gateway_types": {
+        "sms_templates": {
+          "table_name": "sms_templates",
+          "macros": [
+            "has_many"
+          ],
+          "throughs": [
+            "FALSE"
+          ],
+          "foreign_keys": [
+            "gateway_type_id"
+          ],
+          "primary_keys": [
+            "id"
+          ],
+          "model_name": "SmsTemplate"
+        }
+      }
+    }
+  }
+=end
+
+    def models_reflections_generator
+      base_models = filter_params['models'].split(',')
+      base_tables = []
+      table_name = ""
+      base_models.each do |model|
+        table_name = model.constantize.table_name rescue "Invalid_Table"
+        break if table_name == "Invalid_Table" 
+        base_tables.push(table_name)
+      end
+      if table_name == 'Invalid_Table'
+        render json: {message: "incorrect model names, don't give spaces after model names"},status: :bad_request
+      else
+        tables_reflections_hash = tables_reflections_hash_generator(base_models)
+        render json: tables_reflections_hash, status: :ok 
+      end
+    end
+
+    private
+    def filter_params
+      params.permit(:models)
+    end
+
+    def validate_params
+      render json: {message: "model name is mandatory"}, status: :bad_request if params[:models].blank?
+    end
+  end
+end
+

data/app/controllers/housing_misc/sidekiq_queue_check_controller.rb

@@ -0,0 +1,62 @@
+module HousingMisc
+  class SidekiqQueueCheckController < ApplicationController 
+    include HousingMisc::ApiHelper
+    before_action :internal_host_check
+    DEFAULT_QUEUE_SIZE = 100
+    DEFAULT_TOTAL_SIZE = 1000
+
+    def check_permission
+      return false
+    end
+
+    def check
+      return unless check_sidekiq_presence
+      require "sidekiq/api"
+
+      jobs_info = get_above_threshold_queue_list 
+      alert_slack(HousingMisc.sidekiq_message_url, get_message(jobs_info)) unless jobs_info.empty?
+      jobs_info = {"message" => "no sidekiq queue above threshold"} if jobs_info.empty?
+      render json: jobs_info
+    end
+
+    def get_above_threshold_queue_list
+      jobs_info = {}
+      stats = Sidekiq::Stats.new
+      total_threshold = HousingMisc.sidekiq_custom_threshold["total"] || DEFAULT_TOTAL_SIZE
+      if stats.enqueued > total_threshold
+        jobs_info["total"] = {"jobs" => stats.enqueued, "threshold" => total_threshold } 
+      end
+      stats.queues.each do |key, value|
+        queue_threshold = HousingMisc.sidekiq_custom_threshold[key] || DEFAULT_QUEUE_SIZE
+        if value > queue_threshold
+          jobs_info[key] = {"jobs" => value, "threshold" => queue_threshold } 
+        end
+      end
+      jobs_info
+    end
+
+    def get_message(jobs_info)
+      message = "#{Time.now.to_s} :: Queues with jobs exceeding threshold in #{Rails.application.class.parent_name} service => "
+      jobs_info.each do |key, value|
+        message += " #{key} : #{value["jobs"]} jobs (Threshold : #{value["threshold"]}), "
+      end
+      message
+    end
+
+    def check_sidekiq_presence
+      return true if Gem.loaded_specs["sidekiq"].present?
+      render json: {"message" => "no sidekiq in this service"}
+      return false
+    end
+
+    def alert_slack(url, message)
+      url = URI(url)
+      req = Net::HTTP::Post.new url.path
+      req.body = {:text => message}.to_json
+      res = Net::HTTP.start(url.host, url.port, :use_ssl => true) do |http|
+        http.request req
+      end
+    end
+
+  end
+end

data/app/middleware/request_tracer.rb

@@ -0,0 +1,19 @@
+=begin
+  *Author* Azitabh Ajit
+
+  This is a middleware to expose request id set by 
+  This capability is added in rails 5 by default and is available by Current.request_id https://github.com/rails/rails/commit/24a864437e845febe91e3646ca008e8dc7f76b56
+  This usage threadlocal to make the request id available to the whole app just the way it's managed in later versions of rails :https://github.com/rails/rails/commit/24a864437e845febe91e3646ca008e8dc7f76b56#diff-3c3c0f647bc4702f9453c173a707aa06R90
+  This won't be required once we migrate to rails 5 or beyond
+=end
+class RequestTracer
+  def initialize app
+    @app = app
+  end
+
+  def call env
+    Thread.current[:global_request_id] =  env["action_dispatch.request_id"]
+    @status, @headers, @response = @app.call env
+    [@status, @headers, @response]
+  end
+end

data/config/routes.rb

@@ -0,0 +1,6 @@
+HousingMisc::Engine.routes.draw do
+  post "/push_logs" => "logs#push_logs"
+  get "/cache/:cache_key" => "cache#show"
+  get "/model_reflections" => "model_reflections#models_reflections_generator"
+  get "/sidekiq_threshold" => "sidekiq_queue_check#check"
+end