neeto-commons-backend 1.0.89

data/lib/neeto_commons_backend/cypress/webpack.config.js

@@ -0,0 +1,21 @@
+const resolve = require("./resolve");
+
+module.exports = {
+  resolve,
+  module: {
+    rules: [
+      {
+        test: /\.(js|jsx)$/,
+        exclude: [/node_modules/],
+        use: [
+          {
+            loader: "babel-loader",
+            options: {
+              presets: ["@babel/preset-env"],
+            },
+          },
+        ],
+      },
+    ],
+  },
+};

data/lib/neeto_commons_backend/engine.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module NeetoCommonsBackend
+  class Engine < Rails::Engine
+  end
+end

data/lib/neeto_commons_backend/environments/application.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module NeetoCommonsBackend
+  module Environments
+    class << self
+      def application(config, routes = nil)
+        config.load_defaults 7.0
+        config.serve_static_assets = true
+        config.action_controller.raise_on_open_redirects = false
+        config.active_storage.variant_processor = :mini_magick
+        config.active_storage.service_urls_expire_in = 1.hour
+        config.exceptions_app = routes unless routes.nil?
+
+        config.active_record.encryption.primary_key = Rails.application.secrets.encryption[:primary_key]
+        config.active_record.encryption.deterministic_key = Rails.application.secrets.encryption[:deterministic_key]
+        config.active_record.encryption.key_derivation_salt = Rails.application.secrets.encryption[:key_derivation_salt]
+
+        config.active_job.queue_adapter = :sidekiq
+        config.active_job.default_queue_name = :default
+        config.action_mailer.deliver_later_queue_name = :default
+        config.active_storage.queues.analysis = :low
+        config.active_storage.queues.purge = :low
+        config.action_mailbox.queues.routing = :default
+        config.action_mailbox.queues.incineration = :low
+
+        NeetoCommonsBackend::Initializers.cache_store(config)
+        config.generators do |generator|
+          generator.orm :active_record, primary_key_type: :uuid
+        end
+      end
+    end
+  end
+end

data/lib/neeto_commons_backend/environments/development.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module NeetoCommonsBackend
+  module Environments
+    class << self
+      def development(config)
+        config.cache_classes = false
+        config.eager_load = false
+        config.consider_all_requests_local = true
+        config.active_storage.service = :local
+
+        url_options = {
+          host: "http://app.#{ENV["LOCALHOST_DOMAIN"]}",
+          port: Rails.application.secrets.server_port
+        }
+        Rails.application.routes.default_url_options = url_options
+        config.action_mailer.default_url_options = url_options
+        config.action_mailer.delivery_method = :letter_opener
+        config.action_mailer.perform_deliveries = true
+        config.action_mailer.raise_delivery_errors = false
+        config.action_mailer.perform_caching = false
+        config.active_support.deprecation = :log
+        config.active_support.disallowed_deprecation = :raise
+        config.active_support.disallowed_deprecation_warnings = []
+        config.active_record.migration_error = :page_load
+        config.active_record.verbose_query_logs = true
+        config.assets.quiet = true
+        config.server_timing = true
+        config.i18n.raise_on_missing_translations = true
+        config.webpacker.check_yarn_integrity = true
+        config.hosts << /\A[*a-zA-Z0-9\-_]+\.*.*\z|\A*.*\z/
+        if Rails.root.join("tmp/caching-dev.txt").exist?
+          config.action_controller.perform_caching = true
+          config.action_controller.enable_fragment_cache_logging = true
+          config.cache_store = :memory_store
+          config.public_file_server.headers = {
+            "Cache-Control" => "public, max-age=#{2.days.to_i}"
+          }
+        else
+          config.action_controller.perform_caching = false
+          config.cache_store = :null_store
+        end
+      end
+    end
+  end
+end

data/lib/neeto_commons_backend/environments/heroku.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module NeetoCommonsBackend
+  module Environments
+    class << self
+      def heroku(config)
+        config.cache_classes = true
+        config.eager_load = true
+        config.consider_all_requests_local = false
+        config.action_mailer.delivery_method = :letter_opener_web
+        config.action_mailer.perform_deliveries = true
+        config.action_mailer.perform_caching = false
+        config.action_controller.perform_caching = true
+        config.action_controller.forgery_protection_origin_check = false
+        config.public_file_server.enabled = true
+        config.assets.js_compressor = Uglifier.new(harmony: true)
+        config.assets.compile = false
+        config.active_storage.service = ENV["AWS_BUCKET_NAME"].present? ? :amazon : :local
+        config.log_level = :debug
+        config.log_tags = [:request_id]
+        config.log_formatter = ::Logger::Formatter.new
+        config.i18n.fallbacks = true
+        config.active_support.deprecation = :notify
+        config.active_record.dump_schema_after_migration = false
+        if Rails.application.secrets.asset_host.present?
+          config.action_controller.asset_host = Rails.application.secrets.asset_host
+        end
+        if Rails.application.secrets.web_socket_server_url.present?
+          config.web_socket_server_url = Rails.application.secrets.web_socket_server_url
+        end
+        config.action_cable.disable_request_forgery_protection = true
+      end
+    end
+  end
+end

data/lib/neeto_commons_backend/environments/production.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module NeetoCommonsBackend
+  module Environments
+    class << self
+      def production(config)
+        config.cache_classes = true
+        config.eager_load = true
+        config.consider_all_requests_local = false
+        config.action_mailer.delivery_method = :smtp
+        config.action_mailer.perform_deliveries = true
+        config.action_controller.perform_caching = true
+        config.assets.js_compressor = Uglifier.new(harmony: true)
+        config.public_file_server.enabled = ENV["RAILS_SERVE_STATIC_FILES"].present?
+        config.assets.compile = false
+        if Rails.application.secrets.asset_host.present?
+          config.action_controller.asset_host = Rails.application.secrets.asset_host
+        end
+
+        config.active_storage.service = ENV["AWS_BUCKET_NAME"].present? ? :amazon : :local
+        config.force_ssl = true
+        config.log_level = Rails.application.secrets.log_level
+        config.log_tags = [:request_id]
+        config.action_mailer.perform_caching = false
+        config.i18n.fallbacks = true
+        config.active_support.report_deprecations = false
+        config.log_formatter = ::Logger::Formatter.new
+        config.active_record.dump_schema_after_migration = false
+        config.action_controller.forgery_protection_origin_check = false
+
+        config.action_cable.disable_request_forgery_protection = true
+        if Rails.application.secrets.web_socket_server_url.present?
+          config.web_socket_server_url = Rails.application.secrets.web_socket_server_url
+          config.action_cable.url = Rails.application.secrets.web_socket_server_url
+        end
+
+        config.public_file_server.enabled = true
+        config.public_file_server.headers = {
+          "Access-Control-Allow-Origin" => "*",
+          "Cache-Control" => "public, max-age=31536000"
+        }
+      end
+    end
+  end
+end

data/lib/neeto_commons_backend/environments/staging.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module NeetoCommonsBackend
+  module Environments
+    class << self
+      def staging(config)
+        config.cache_classes = true
+        config.eager_load = true
+        config.consider_all_requests_local = false
+        config.action_mailer.delivery_method = :smtp
+        config.action_mailer.perform_deliveries = true
+        config.action_controller.perform_caching = true
+        config.assets.js_compressor = Uglifier.new(harmony: true)
+        config.assets.compile = false
+        config.assets.digest = true
+        config.force_ssl = true
+        config.log_level = :debug
+        config.active_storage.service = ENV["AWS_BUCKET_NAME"].present? ? :amazon : :local
+        config.log_tags = [:request_id]
+        config.i18n.fallbacks = true
+        config.active_support.report_deprecations = false
+        config.log_formatter = ::Logger::Formatter.new
+        config.active_record.dump_schema_after_migration = false
+        config.action_controller.forgery_protection_origin_check = false
+        if Rails.application.secrets.asset_host.present?
+          config.action_controller.asset_host = Rails.application.secrets.asset_host
+        end
+
+        config.action_cable.disable_request_forgery_protection = true
+        if Rails.application.secrets.web_socket_server_url.present?
+          config.web_socket_server_url = Rails.application.secrets.web_socket_server_url
+          config.action_cable.url = Rails.application.secrets.web_socket_server_url
+        end
+
+        config.public_file_server.enabled = true
+        config.public_file_server.headers = {
+          "Access-Control-Allow-Origin" => "*",
+          "Cache-Control" => "public, max-age=31536000"
+        }
+      end
+    end
+  end
+end

data/lib/neeto_commons_backend/environments/test.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module NeetoCommonsBackend
+  module Environments
+    class << self
+      def test(config)
+        config.consider_all_requests_local = true
+        config.cache_classes = true
+        config.cache_store = :memory_store
+        config.eager_load = false
+        config.action_controller.perform_caching = false
+        config.action_mailer.perform_caching = false
+        config.action_mailer.delivery_method = :test
+        config.action_mailer.perform_deliveries = true
+        config.public_file_server.enabled = true
+        config.public_file_server.headers = {
+          "Cache-Control" => "public, max-age=#{1.hour.to_i}"
+        }
+        config.action_dispatch.show_exceptions = false
+        config.action_controller.allow_forgery_protection = false
+        config.active_storage.service = :test
+        config.active_support.deprecation = :stderr
+        config.active_support.disallowed_deprecation = :raise
+        config.active_support.disallowed_deprecation_warnings = []
+        config.i18n.raise_on_missing_translations = true
+      end
+    end
+  end
+end

data/lib/neeto_commons_backend/gemfiles/Gemfile.common.rb

@@ -0,0 +1,240 @@
+# frozen_string_literal: true
+
+require "base64"
+
+source "https://rubygems.org"
+
+ruby "3.2.2"
+
+source "https://O6Ts9-SVDaUZpHMRs2CpJp22RwbETDE@gems.neeto.com" do
+  # Permanent deletion of organization and all its related models
+  gem "neeto-org-incineration-engine"
+
+  # Adds prefix to subject in emails
+  gem "neeto-email-prefixer"
+
+  # Configure SSO with neetoAuth
+  gem "neeto-sso"
+
+  # neeto_emails gem for email templating
+  gem "neeto-emails"
+
+  # neeto_commons_backend gem for methods and modules that are used across all neeto products.
+  gem "neeto-commons-backend"
+
+  # A light gem for superadmin interface
+  gem "neeto-area51-engine"
+
+  # Rails engine that serves team-members module for all Neeto apps
+  gem "neeto-team-members-engine"
+
+  # Rails engine that serves payments module for all Neeto apps
+  gem "neeto-payments-engine"
+
+  # For notifications
+  gem "neeto-notifications-engine"
+
+  # Rails engine that generates migrations, provide models and helpers for adding tags
+  gem "neeto-tags-engine"
+
+  # Rails engine that provides helpers to filter records.
+  gem "neeto-filters-engine"
+
+  # Rails engine that generates migrations, provide models and helpers for managing custom domains
+  gem "neeto-custom-domains-engine"
+
+  # Intercepts outgoing emails in non-production environment
+  gem "neeto-mail-interceptor"
+
+end
+
+gem "autoprefixer-rails"
+
+gem "rails", "7.0.4"
+
+gem "dotenv-rails"
+
+# Related to AssetPipeline
+gem "uglifier"
+
+gem "shakapacker", "6.5.2"
+
+# To use AWS S3 as backend for ActiveStorage
+gem "aws-sdk-s3", require: false
+
+# database
+gem "pg"
+
+# JSON builder
+gem "jbuilder"
+
+# Authentication
+gem "devise"
+
+# Google Authentication
+gem "omniauth-google-oauth2", "0.8.1"
+
+# Background jobs
+gem "sidekiq", "7.0.8"
+
+# For periodic jobs on sidekiq
+gem "sidekiq-cron"
+
+# For seeing failed jobs in sidekiq
+gem "sidekiq-failures"
+
+# Error tracking
+gem "honeybadger"
+
+# Application server
+gem "puma"
+
+# Authorization
+gem "pundit"
+
+# convert email css to inline
+gem "premailer-rails"
+
+# Rails request timeout, needed if running on Heroku-
+# https://devcenter.heroku.com/articles/request-timeout
+gem "rack-timeout", require: "rack/timeout/base"
+
+# Rack attack gem for DDOS attacks
+gem "rack-attack"
+
+# Faster env load times
+gem "bootsnap"
+
+# For cache store
+# Upgrade once Sidekiq has been upgraded from 6.5.5 and deprecation warnings are gone. https://snipboard.io/PuDU4G.jpg
+gem "redis", "4.7.1"
+
+# Memcached store adapter
+gem "dalli"
+
+# Generate fake data
+gem "faker"
+
+# I18n Internationalization
+gem "rails-i18n"
+
+# To inject React components in views and pass props from server
+gem "react-rails"
+
+# To add soft delete option to ActiveRecord
+gem "paranoia"
+
+# Pagination
+gem "kaminari", "~> 1.2"
+
+# Application Perfomance Monitoring
+gem "newrelic_rpm"
+
+# Image processing
+gem "mini_magick"
+
+# Email previews for Actionmailer
+gem "rails_email_preview"
+
+# Cross-Origin Resource Sharing (CORS) for Rack compatible web applications
+# Locked to this version to fix the double headers issue. Ref: https://github.com/bigbinary/neeto-auth-web/pull/2759
+gem "rack-cors", "1.1.1", require: "rack/cors"
+
+# ActiveRecord Session Store
+gem "activerecord-session_store"
+
+# To fix uninitialized constant Mail::TestMailer with ruby 3.1.2
+gem "net-smtp" # to send email
+gem "net-imap" # for rspec
+gem "net-pop" # for rspec
+
+# Catch unsafe migrations in development
+gem "strong_migrations"
+
+group :development do
+  # Access an IRB console on exception pages or by using <%= console %> anywhere in the code.
+  gem "web-console"
+
+  # A Ruby static code analyzer, based on the community Ruby style guide
+  gem "rubocop", require: false
+
+  gem "rubocop-minitest"
+
+  # A RuboCop extension focused on enforcing Rails best practices and coding conventions.
+  gem "rubocop-rails", require: false
+
+  # For linting ERB files
+  gem "erb_lint", require: false, git: "https://github.com/Shopify/erb-lint.git", branch: "main"
+
+  # Patch-level verification for Bundler.
+  gem "bundler-audit", require: false
+
+  # vulnerabity checker for Ruby itself.
+  gem "ruby_audit", require: false
+
+  gem "rack-mini-profiler"
+
+  # For checkking security vulnerabilities
+  gem "brakeman"
+end
+
+group :development, :heroku do
+  # For testing the mail locally
+  gem "letter_opener"
+
+  # For testing the emails in the browser, works with `letter_opener`
+  gem "letter_opener_web", "~> 2.0"
+end
+
+group :development, :test do
+  # To replace using fixures
+  gem "factory_bot_rails"
+
+  # reports N+1 queries
+  gem "bullet"
+
+  gem "awesome_print"
+
+  # Adds step-by-step debugging and stack navigation capabilities to pry using byebug.
+  # supports both syntax - pry and byebug
+  gem "pry-byebug"
+
+  source "https://O6Ts9-SVDaUZpHMRs2CpJp22RwbETDE@gems.neeto.com" do
+    gem "neeto-compliance"
+  end
+
+  gem "wkhtmltopdf-binary"
+
+  # Complete suite of testing facilities
+  gem "minitest"
+end
+
+group :test do
+  # Test coverage
+  gem "simplecov", require: false
+
+  # for stubbing and setting expectations on HTTP requests
+  gem "webmock"
+
+  # To mock and stub objects in tests
+  gem "mocha"
+
+  gem "minitest-reporters"
+
+  # Records test results and generates XML files.
+  gem "minitest-ci"
+
+  # helps you isolate and debug random test failures.
+  gem "minitest-bisect"
+end
+
+group :development, :staging, :heroku, :test do
+  gem "database_cleaner"
+end
+
+group :production do
+  # This gem works together with the Judoscale Heroku add-on
+  # to automatically scale web and worker dynos
+  gem "judoscale-rails", "1.3.1"
+  gem "judoscale-sidekiq"
+end

data/lib/neeto_commons_backend/helpers/auth_server_api.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require "net/http"
+
+class NeetoCommonsBackend::Helpers::AuthServerApi
+  MAX_RETRIES = 5
+  REQUEST_CLASSES = {
+    get: Net::HTTP::Get,
+    post: Net::HTTP::Post,
+    put: Net::HTTP::Put,
+    delete: Net::HTTP::Delete
+  }
+  attr_reader :endpoint, :request_body, :request_class, :request_params, :custom_headers
+
+  def initialize(custom_headers: {})
+    @custom_headers = custom_headers
+  end
+
+  def get(**args)
+    request(type: :get, **args)
+  end
+
+  def put(**args)
+    request(type: :put, **args)
+  end
+
+  def post(**args)
+    request(type: :post, **args)
+  end
+
+  def delete(**args)
+    request(type: :delete, **args)
+  end
+
+  def request(type:, **args)
+    return if Rails.env.heroku?
+
+    @request_class = REQUEST_CLASSES[type]
+    process(**args)
+  end
+
+  private
+
+    def process(endpoint:, params: nil, body: nil)
+      @endpoint = endpoint
+      @request_params = params
+      @request_body = body
+      begin
+        retry_count ||= 0
+        send_request
+      rescue StandardError => exception
+        if retry_count < MAX_RETRIES
+          retry_count += 1
+          Rails.logger.warn "Error: #{exception.message}. Retrying in #{2**retry_count} seconds."
+          sleep 2**retry_count
+          retry
+        else
+          Rails.logger.error "Retries exhausted"
+          raise exception
+        end
+      end
+    end
+
+    def send_request
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true if uri.scheme == "https"
+
+      request = request_class.new(uri.request_uri, headers)
+      if request_body.present?
+        request.body = request_body.to_json
+      end
+      response = http.request(request)
+      response.body
+    end
+
+    def uri
+      return @uri if @uri.present?
+
+      @uri = URI.parse("#{Rails.application.secrets.auth_app[:url]}/api/v1/server/#{endpoint}")
+      if request_params.present?
+        @uri.query = URI.encode_www_form(request_params)
+      end
+      @uri
+    end
+
+    def headers
+      {
+        "Content-Type" => "application/json",
+        "AUTHORIZATION" => "Token token=#{Rails.application.secrets.server_authorization_token}"
+      }.merge(custom_headers)
+    end
+end

data/lib/neeto_commons_backend/helpers/favicon.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module NeetoCommonsBackend
+  module Helpers
+    class << self
+      include ActionView::Helpers::AssetUrlHelper
+      include ActionView::Helpers::AssetTagHelper
+
+      def favicon(organization)
+        if organization&.favicon_url&.present?
+          favicon_link_tag organization.favicon_url
+        else
+          favicon_link_tag "/favicon.ico"
+        end
+      end
+    end
+  end
+end

data/lib/neeto_commons_backend/helpers/global_props.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module NeetoCommonsBackend
+  module Helpers
+    class << self
+      attr_reader :current_user, :organization
+
+      def common_client_props(organization, current_user)
+        @organization = organization
+        @current_user = current_user
+        @neeto_data = neeto_data if current_user.present?
+
+        global_props = {
+          rails_env: Rails.env,
+          honeybadger_api_key: ENV["HONEYBADGER_JS_API_KEY"] || ENV["HONEYBADGER_API_KEY"],
+          honeybadger_revision: ENV["HEROKU_SLUG_COMMIT"],
+          organization: organization&.as_json(only: %i[name subdomain favicon_url]),
+          authenticated: current_user.present?,
+          app_name: build_app_name
+        }
+
+        user_props = if current_user.present?
+          {
+            user: current_user.as_json.merge(
+              authentication_token: current_user.authentication_token,
+              date_format: current_user.date_format ? current_user.date_format_before_type_cast.upcase : "DD/MM/YYYY"
+            ),
+            neeto_apps: user_data(:neeto_apps),
+            is_owner: user_data(:is_owner),
+            permissions: user_permissions
+          }
+                     else
+                       {}
+        end
+
+        global_props.merge(user_props)
+      end
+
+      private
+
+        def user_permissions
+          current_user_role = current_user.organization_role
+          return [] if current_user_role.nil?
+
+          Rails.cache.fetch("#{organization.cache_key}/#{current_user_role.cache_key_with_version}/permissions") do
+            current_user_role.permissions.pluck(:name) || []
+          end
+        end
+
+        def user_data(entity)
+          @neeto_data.with_indifferent_access[entity]
+        end
+
+        def neeto_data
+          if Rails.env.test? || Rails.env.heroku? || Rails.env.development?
+            { neeto_apps: [], is_owner: true }
+                       else
+                         Organizations::NeetoAppsService.new(current_user).process || {
+                           neeto_apps: [],
+                           is_owner: false
+                         }
+          end
+        end
+
+        def build_app_name
+          client_app_name = Rails.application.secrets.client_app_name
+
+          unless client_app_name
+            raise "client_app_name not found. Please add client_app_name field in secrets.yml file."
+          end
+
+          "neeto" + client_app_name
+        end
+    end
+  end
+end