NeetoCommonsBackend
NeetoCommonsBackend gem is responsible for handling common business logic that are used across the neeto applications and also store the common files like that are widely used in all neeto applications. NeetoCommonsBackend, together with neetoCompliance gem handles the standardisation of configuration stucture and code standard.
All the controllers, concerns, services, helpers, views defined in neeto-commons-backend gem are as follows:
| File name | Category |
|---|---|
| - [NeetoCommonsBackend::Api::BaseController](./docs/controllers/README.md#neetocommonsbackendapibasecontroller) - [NeetoCommonsBackend::Api::DirectUploadsController](./docs/controllers/README.md#neetocommonsbackendapidirectuploadscontroller) - [NeetoCommonsBackend::AppVersionsController](./docs/controllers/README.md#neetocommonsbackendappversionscontroller) - [NeetoCommonsBackend::FailuresController](./docs/controllers/README.md#neetocommonsbackendfailurescontroller) - [NeetoCommonsBackend::HealthCheckController](./docs/controllers/README.md#neetocommonsbackendhealthcheckcontroller) - [NeetoCommonsBackend::WellKnownsController](./docs/controllers/README.md#neetocommonsbackendwellknownscontroller) | [Controllers](./docs/controllers/README.md) |
| - [NeetoCommonsBackend::ApplicationMailer](./docs/mailers/README.md#neetocommonsbackendapplicationmailer) | [Mailers](./docs/mailers/README.md) |
| - [NeetoCommonsBackend::Sluggable](./docs/model_concerns/README.md#neetocommonsbackendsluggable) - [NeetoCommonsBackend::SoftDeletable](./docs/model_concerns/README.md#neetocommonsbackendsoftdeletable) - [NeetoCommonsBackend::DeviseValidator](./docs/model_concerns/README.md#neetocommonsbackenddevisevalidator) | [Model Concerns](./docs/model_concerns/README.md) |
| - [NeetoCommonsBackend::ApiHelpers](./docs/controller_concerns/README.md#neetocommonsbackendapihelpers) - [NeetoCommonsBackend::ApiExceptions](./docs/controller_concerns/README.md#neetocommonsbackendapiexceptions) - [NeetoCommonsBackend::ApiResponders](./docs/controller_concerns/README.md#neetocommonsbackendapiresponders) - [NeetoCommonsBackend::HoneybadgerContext](./docs/controller_concerns/README.md#neetocommonsbackendhoneybadgercontext) - [NeetoCommonsBackend::Authenticatable](./docs/controller_concerns/README.md#neetocommonsbackendauthenticatable) - [NeetoCommonsBackend::StoreUserLocation](./docs/controller_concerns/README.md#neetocommonsbackendstoreuserlocation) | [Controller Concerns](./docs/controller_concerns/README.md) |
| - [NeetoCommonsBackend::BaseWorkers::Base](./docs/workers/README.md#neetocommonsbackendbaseworkersbase) - [NeetoCommonsBackend::BaseWorkers::Auth](./docs/workers/README.md#neetocommonsbackendbaseworkersauth) - [NeetoCommonsBackend::BaseWorkers::Default](./docs/workers/README.md#neetocommonsbackendbaseworkersdefault) - [NeetoCommonsBackend::BaseWorkers::Low](./docs/workers/README.md#neetocommonsbackendbaseworkerslow) - [NeetoCommonsBackend::BaseWorkers::Urgent](./docs/workers/README.md#neetocommonsbackendbaseworkersurgent) | [Workers](./docs/workers/README.md) |
| - [NeetoCommonsBackend::AppUrlCarrier](./docs/carriers/README.md#neetocommonsbackendappurlcarrier) | [Carriers](./docs/carriers/README.md) |
| - [auto_update_prs_with_latest_master](./docs/workflows/README.md#auto_update_prs_with_latest_master) - [bump_version](./docs/workflows/README.md#bump_version) | [Workflows](./docs/workflows/README.md) |
| - [Gemfile.common.rb](./docs/gemfiles/README.md#gemfilecommonrb) | [gemfiles](./docs/gemfiles/README.md) |
| - [NeetoCommonsBackend::Helpers::AuthServerApi](./docs/helpers/README.md#neetocommonsbackendhelpersauthserverapi) - [NeetoCommonsBackend::Helpers.favicon](./docs/helpers/README.md#neetocommonsbackendhelpersfavicon) - [NeetoCommonsBackend::Helpers.common_client_props](./docs/helpers/README.md#neetocommonsbackendhelperscommon_client_props) - [NeetoCommonsBackend::Helpers.build_neeto_widget_script_url](./docs/helpers/README.md#neetocommonsbackendhelpersbuild_neeto_widget_script_url) - [NeetoCommonsBackend::TestHelper.setup](./docs/helpers/README.md#neetocommonsbackendtesthelpersetup) | [Helpers](./docs/helpers/README.md) |
| - [NeetoCommonsBackend::Initializers::EnableExtensionHerokuMonkeypatch](https://github.com/bigbinary/neeto-commons-backend/blob/main/lib/neeto_commons_backend/initializers/_enable_extension_hack.rb) - [NeetoCommonsBackend::Initializers.cache_store](https://github.com/bigbinary/neeto-commons-backend/blob/main/lib/neeto_commons_backend/initializers/cache_store.rb) - [NeetoCommonsBackend::Initializers.session_store](https://github.com/bigbinary/neeto-commons-backend/blob/main/lib/neeto_commons_backend/initializers/session_store.rb) - [NeetoCommonsBackend::Initializers.assets](https://github.com/bigbinary/neeto-commons-backend/blob/main/lib/neeto_commons_backend/initializers/assets.rb) - [NeetoCommonsBackend::Initializers.remove_backtrace_silencers](https://github.com/bigbinary/neeto-commons-backend/blob/main/lib/neeto_commons_backend/initializers/remove_backtrace_silencers.rb) - [NeetoCommonsBackend::Initializers.bullet](https://github.com/bigbinary/neeto-commons-backend/blob/main/lib/neeto_commons_backend/initializers/bullet.rb) - [NeetoCommonsBackend::Initializers.cookies_serializer](https://github.com/bigbinary/neeto-commons-backend/blob/main/lib/neeto_commons_backend/initializers/cookies_serializer.rb) - [NeetoCommonsBackend::Initializers.cors](https://github.com/bigbinary/neeto-commons-backend/blob/main/lib/neeto_commons_backend/initializers/cors.rb) - [NeetoCommonsBackend::Initializers.database_cleaner](https://github.com/bigbinary/neeto-commons-backend/blob/main/lib/neeto_commons_backend/initializers/database_cleaner.rb) - [NeetoCommonsBackend::Initializers.datetime](https://github.com/bigbinary/neeto-commons-backend/blob/main/lib/neeto_commons_backend/initializers/datetime.rb) - [NeetoCommonsBackend::Initializers.email_setup](https://github.com/bigbinary/neeto-commons-backend/blob/main/lib/neeto_commons_backend/initializers/email_setup.rb) - [NeetoCommonsBackend::Initializers.neeto_email_prefixer](https://github.com/bigbinary/neeto-commons-backend/blob/main/lib/neeto_commons_backend/initializers/neeto_email_prefixer.rb) - [NeetoCommonsBackend::Initializers.filter_parameter_logging](https://github.com/bigbinary/neeto-commons-backend/blob/main/lib/neeto_commons_backend/initializers/filter_parameter_logging.rb) - [NeetoCommonsBackend::Initializers.honeybadger](https://github.com/bigbinary/neeto-commons-backend/blob/main/lib/neeto_commons_backend/initializers/honeybadger.rb) - [NeetoCommonsBackend::Initializers.kaminari_config](https://github.com/bigbinary/neeto-commons-backend/blob/main/lib/neeto_commons_backend/initializers/kaminari_config.rb) - [NeetoCommonsBackend::Initializers.neeto_mail_interceptor](https://github.com/bigbinary/neeto-commons-backend/blob/main/lib/neeto_commons_backend/initializers/neeto_mail_interceptor.rb) - [NeetoCommonsBackend::Initializers.mime_types](https://github.com/bigbinary/neeto-commons-backend/blob/main/lib/neeto_commons_backend/initializers/mime_types.rb) - [NeetoCommonsBackend::Initializers.mini_profiler](https://github.com/bigbinary/neeto-commons-backend/blob/main/lib/neeto_commons_backend/initializers/mini_profiler.rb) - [NeetoCommonsBackend::Initializers.rack_attack](https://github.com/bigbinary/neeto-commons-backend/blob/main/lib/neeto_commons_backend/initializers/rack_attack.rb) - [NeetoCommonsBackend::Initializers.rack_deflater](https://github.com/bigbinary/neeto-commons-backend/blob/main/lib/neeto_commons_backend/initializers/rack_deflater.rb) - [NeetoCommonsBackend::Initializers.rack_timeout](https://github.com/bigbinary/neeto-commons-backend/blob/main/lib/neeto_commons_backend/initializers/rack_timeout.rb) - [NeetoCommonsBackend::Initializers.rails_email_preview](https://github.com/bigbinary/neeto-commons-backend/blob/main/lib/neeto_commons_backend/initializers/rails_email_preview.rb) - [NeetoCommonsBackend::Initializers.sidekiq](https://github.com/bigbinary/neeto-commons-backend/blob/main/lib/neeto_commons_backend/initializers/sidekiq.rb) - [NeetoCommonsBackend::Initializers.wrap_parameters](https://github.com/bigbinary/neeto-commons-backend/blob/main/lib/neeto_commons_backend/initializers/wrap_parameters.rb) - [NeetoCommonsBackend::Initializers.strong_migrations](https://github.com/bigbinary/neeto-commons-backend/blob/main/lib/neeto_commons_backend/initializers/strong_migrations.rb) - [NeetoCommonsBackend::Initializers::PostCompilation](https://github.com/bigbinary/neeto-commons-backend/blob/main/lib/neeto_commons_backend/initializers/post_compilation.rb) - [NeetoCommonsBackend::SharedRedis](https://github.com/bigbinary/neeto-commons-backend/blob/main/lib/neeto_commons_backend/initializers/shared_redis.rb) | [Initializers](https://github.com/bigbinary/neeto-commons-backend/tree/main/lib/neeto_commons_backend/initializers) |
| - [catch_all.rb](./docs/routes/README.md#catch_allrb) - [devise.rb](./docs/routes/README.md#deviserb) - [direct_uploads.rb](./docs/routes/README.md#direct_uploadsrb) - [draw.rb](./docs/routes/README.md#drawrb) - [email_previews.rb](./docs/routes/README.md#email_previewsrb) - [errors.rb](./docs/routes/README.md#errorsrb) - [health.rb](./docs/routes/README.md#healthrb) - [letter_opener.rb](./docs/routes/README.md#letter_openerrb) - [sidekiq.rb](./docs/routes/README.md#sidekiqrb) - [well_knowns.rb](./docs/routes/README.md#well_knownsrb) | [Routes](./docs/routes/README.md) |
| - [sync_with_wheel.sh](./docs/scripts/README.md#sync_with_wheelsh) | [Scripts](./docs/scripts/README.md) |
| - [sample_data](./docs/services/README.md#sample_data) - [NeetoCommonsBackend::SourceMapPublishService](./docs/services/README.md#neetocommonsbackendsourcemappublishservice) - [NeetoCommonsBackend::Services::CustomDomain](./docs/services/README.md#neetocommonsbackendservicescustomdomain) | [Services](./docs/services/README.md) |
Installation
Add this line to your application's Gemfile:
gem "neeto-commons-backend", git: "https://github.com/bigbinary/neeto-commons-backend"And then execute:
$ bundle install
Development
- Add this line to your application's Gemfile (replace the path to the local copy of neetoCommonsBackend gem):
gem 'neeto-commons-backend', path: '../neeto-commons-backend'
And then execute:
$ bundle install