@bigbinary/neeto-custom-domains-frontend 1.1.0

package/README.md

@@ -0,0 +1,174 @@
+# neeto-custom-domains-engine
+
+The `neeto-custom-domains-engine` manages custom domains across neeto applications.
+
+## Contents
+  1. [Development with Host application](#development-with-host-application)
+      - [Engine](#engine)
+        - [Installation](#installation)
+        - [Usage](#usage)
+  2. [Instructions for publishing](#instructions-for-publishing)
+
+## Development with Host application
+
+### Engine
+
+The engine provides the backend setup for neetoCustomDomains.
+
+#### Installation
+
+1. Add this line to your application's Gemfile:
+
+```ruby
+source "NEETO_GEM_SERVER_URL" do
+  # ... existing gems
+
+  gem "neeto-custom-domains-engine"
+end
+```
+
+2. And then execute:
+
+```shell
+bundle install
+```
+
+3. Add this line to your application's `config/routes.rb` file:
+
+```ruby
+mount NeetoCustomDomainsEngine::Engine => "/custom_domains"
+```
+
+4. Run migrations
+
+```
+rails neeto-custom-domains-engine:install:migrations
+rails db:migrate
+```
+
+#### Usage
+
+The steps below depend on the association that we use. In some cases, we need to attach multiple custom domains to a model, while in other cases, we only need a single custom domain. We have to make necessary configurations depending on this.
+
+Let's say we have a "Site" model, and we want to publish our site on a custom domain.
+
+##### Configure `has_one` association
+
+The site only needs to be published in a single custom domain, so we chose `has_one` association.
+
+1. Add association
+
+```ruby
+class Site > ApplicationRecord
+  has_one :custom_domain, as: :custom_domainable, class_name:   "NeetoCustomDomainsEngine::Domain", dependent: :destroy
+end
+```
+
+2. Add controller
+
+All common controller logic is extracted to the engine. However, we still need to load some records depending on the association that we use.
+
+```ruby
+class Api::V1::Sites::CustomDomainsController < NeetoCustomDomainsEngine::DomainsController
+  private
+
+    def load_custom_domainable!
+      @custom_domainable = organization.sites.find(params[:site_id])
+    end
+
+    def load_custom_domain!
+      @custom_domain = @custom_domainable.custom_domain
+    end
+end
+```
+
+3. Add routes
+
+```ruby
+include NeetoCustomDomainsEngine::Routes::Draw
+
+scope module: :sites do
+  custom_domains_routes(route: :custom_domain)
+end
+```
+4. Add front-end component
+
+```js
+import { CustomDomain } from "@bigbinary/neeto-molecules/CustomDomain";
+```
+For more info related to front-end component: https://github.com/bigbinary/neeto-molecules/blob/main/docs/components.md#customdomain
+
+##### Configure `has_many` association
+
+The site needs to be published in multiple custom domains, so we chose `has_many` association.
+
+1. Add association
+
+```ruby
+class Site > ApplicationRecord
+  has_many :custom_domain, as: :custom_domainable, class_name: "NeetoCustomDomainsEngine::Domain", dependent: :destroy
+end
+```
+
+2. Add controller
+```ruby
+class Api::V1::Sites::CustomDomainsController < NeetoCustomDomainsEngine::DomainsController
+  private
+
+    def load_custom_domainable!
+      @custom_domainable = organization.sites.find(params[:site_id])
+    end
+
+    def load_custom_domain!
+      @custom_domain = @custom_domainable.custom_domains.find(params[:id])
+    end
+end
+```
+
+3. Add routes
+
+```ruby
+include NeetoCustomDomainsEngine::Routes::Draw
+
+scope module: :sites do
+  custom_domains_routes(route: :custom_domain)
+end
+```
+
+4. Add front-end component
+
+```js
+import { CustomDomainDashBoard } from "@bigbinary/neeto-molecules/CustomDomainDashboard";
+```
+For more info related to front-end component: https://github.com/bigbinary/neeto-molecules/blob/main/docs/components.md#customdomainDashboard
+
+##### Loading site from custom domain
+Let's say we have attached the custom domain `test.neeto.com` to a site. Now, when the user tries to access `test.neeto.com` in the browser, we should display the corresponding site in the front-end. In order to achieve this, we need to load the site from the custom domain.
+
+```ruby
+custom_domain = NeetoCustomDomainsEngine::Domain.find_by(hostname: params[:custom_domain])
+if custom_domain.present?
+  @published_site = custom_domain.custom_domainable.published_site
+else
+  site = Site.find_by! subdomain: params[:subdomain]
+  @published_site = site.published_site
+end
+```
+
+##### ENV variables
+
+For the working of this engine we need the following env variables.
+
+```
+LETS_ENCRYPT_PRIVATE_KEY: < For requesting SSL certificates >
+LETS_ENCRYPT_DIRECTORY_URL: < For requesting SSL certificates >
+LETS_ENCRYPT_VALIDATION_DOMAIN_ACCESS_TOKEN: < For domain authentication>
+LETS_ENCRYPT_VALIDATION_DOMAIN_ID: < For domain authentication>
+LETS_ENCRYPT_VALIDATION_DOMAIN_NAME: < For domain authentication>
+LETS_ENCRYPT_APP_NAME: < For pushing SSL certificate and custom domains >
+HEROKU_AUTH_TOKEN: < For pushing SSL certificate and custom domains >
+```
+
+## Instructions for Publishing
+
+Consult the [building and releasing packages](https://neeto-engineering.neetokb.com/articles/building-and-releasing-packages) guide for details on how to publish.

package/app/javascript/src/translations/en.json

@@ -0,0 +1,63 @@
+{
+  "neetoCustomDomains": {
+    "common": {
+      "record": "record",
+      "name": "name",
+      "value": "value",
+      "status": "status",
+      "success": "Success",
+      "pending": "Pending"
+    },
+    "actions": {
+      "cancel": "Cancel",
+      "delete": "Delete",
+      "edit": "Edit",
+      "continue": "Continue",
+      "done": "Done"
+    },
+    "customDomain_one": "Custom domain",
+    "customDomain_other": "Custom domains",
+    "customDomainWithCount_one": "{{count}} custom domain",
+    "customDomainWithCount_other": "{{count}} custom domains",
+    "settings": "Custom domain settings",
+    "yourDomain": "Your domain",
+    "addNew": "Add new custom domain",
+    "delete": "Delete custom domain?",
+    "search": "Search custom domains",
+    "notFound": "There are no custom domains to show.",
+    "placeholder": "help.neeto.com",
+    "cname": "CNAME",
+    "label": "Enter domain",
+    "domainValidation": "Domain validation",
+    "domainRedirection": "Domain redirection",
+    "cnameRecordInfo": "Go to your domain host's DNS settings to add the following CNAME record.{{proxyMessage, anyCase}}  <Link>View help article</Link> for more information.",
+    "proxyMessage": " Do not enable proxy for the record.",
+    "domainRedirectionInfo": "It can take up to 2-24 hours for your custom domain to start working. Please visit your site in 24 hours from now and if after 24 hours <strong>{{hostname}}</strong> is not working then please view <Link>help article</Link> for more information and contact us.",
+    "domainValidationInfo": "CNAME record not found, if you added CNAME record in last 24 hours then please wait sometime and try it again. Verifying your domain usually only takes a few hours, but in some cases can take up to 24-48 hours. View <Link>help article</Link> for more information.",
+    "learnMoreMessage": "Learn about <button>how to setup custom domains</button>",
+    "cnameAdded": "I have added redirection CNAME record",
+    "validation": {
+      "successMessage": "Custom domain successfully validated.",
+      "buttonLabel": {
+        "domain": "Validate"
+      }
+    },
+    "status": {
+      "domain": {
+        "active": "Domain validated",
+        "pendingCnameValidation": "Domain validated",
+        "pendingDomainValidation": "Domain validation pending"
+      },
+      "cname": {
+        "active": "Domain redirected",
+        "pendingCnameValidation": "Domain redirection pending"
+      },
+      "failed": "Failed"
+    },
+    "alertMessage": "You are permanently deleting the custom domain <strong>{{hostname}}</strong> and will no longer point to your default domain.  This can't be undone.",
+    "formikValidation": {
+      "required": "Domain is required",
+      "valid": "Please add valid domain or URL"
+    }
+  }
+}

package/app/javascript/src/translations/index.js

@@ -0,0 +1,3 @@
+import en from "./en.json";
+
+export { en };