Load castle.umd.js by default from /vendor/castle-js.

Author: bartes

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 ## [Unreleased][main]
 
-- Drop `cdn.castle.io`; configure the browser SDK from a host-imported module or a hosted UMD via `castle_javascript_tag(src:)`
+- Drop `cdn.castle.io`; load `castle.umd.js` from `/vendor/castle-js` via `castle_javascript_tag`
 - Seed `window.Castle` before a UMD script so 3.x (`name: @castleio/castle-js`) attaches to the same global
 - Support `@castleio/castle-js` 2.x (`injectTokenOnSubmit` / `createRequestToken`) and 3.x (`configure({ pk })` + `createRequestToken`)
 - Add `publishable_key` configuration and drop `app_id`

README.md

@@ -62,28 +62,18 @@ en:
 
 #### Browser SDK
 
-Install [`@castleio/castle-js`](https://docs.castle.io/docs/sdk-browser) (2.x or 3.x). Host it the same way you host the rest of your JavaScript.
-
-**Module import.** Configure the SDK in your pack and keep the instance on `window.__castleDevise`:
-
-```javascript
-import * as Castle from '@castleio/castle-js'
-
-window.__castleDevise = Castle.configure({ pk: YOUR_PUBLISHABLE_KEY })
-```
+Install [`@castleio/castle-js`](https://docs.castle.io/docs/sdk-browser) and serve the npm `dist` directory at `/vendor/castle-js` (keep `castle.umd.js` and the worker files together):
 
 ```ruby
 <%= castle_javascript_tag %>
 ```
 
-**Script tag** (UMD). Publish the npm `dist` directory with your static assets (for example `public/castle-js`, a CDN, or nginx). Keep `castle.umd.js` and the worker files in the same directory, then pass that URL:
+That loads `/vendor/castle-js/castle.umd.js` and seeds `window.Castle` before the script runs (3.x UMD is named `@castleio/castle-js`). Pass `src:` for a different UMD URL:
 
 ```ruby
-<%= castle_javascript_tag(src: "/castle-js/castle.umd.js") %>
+<%= castle_javascript_tag(src: "/assets/castle.umd.js") %>
 ```
 
-`src` seeds `window.Castle` before the script runs (3.x UMD is named `@castleio/castle-js`).
-
 Add the following tag to the the `<form>` tag in both `devise/registrations/new.html.erb` and `devise/sessions/new.html.erb` (if you haven't generated them yet, run `rails generate devise:views`):
 
 ```ruby

lib/castle_devise/helpers/castle_helper.rb

@@ -14,8 +14,10 @@ module CastleHelper
         }
       JS
 
-      # Configures the Castle browser SDK with { pk: }. Pass src: to also load a
-      # hosted UMD build; omit it when the host app already imported the npm module.
+      DEFAULT_UMD_SRC = "/vendor/castle-js/castle.umd.js"
+
+      # Loads castle.umd.js and configures it with { pk: }. Pass src: to use a
+      # different UMD URL, or src: nil when the host app already loaded the SDK.
       #
       # @param src [String, nil] URL or path of castle.umd.js (keep workers in the same directory)
       # @return [String]
@@ -29,7 +31,7 @@ module CastleHelper
       #   <title>Your app title</title>
       #
       #   <!-- the rest of your layout -->
-      def castle_javascript_tag(src: nil)
+      def castle_javascript_tag(src: DEFAULT_UMD_SRC)
         parts = []
         if src
           parts << javascript_tag(UMD_SHIM)

spec/castle_devise/helpers/castle_helper_spec.rb

@@ -10,25 +10,35 @@
       CastleDevise.configuration.publishable_key = "pk_spec"
     end
 
-    it "configures the SDK without loading a script when src is omitted" do
+    it "loads castle.umd.js from /vendor/castle-js" do
       html = helper.castle_javascript_tag
 
+      expect(html).to include("/vendor/castle-js/castle.umd.js")
+      expect(html).to include("window.module")
+      expect(html).to include("window.Castle")
+      expect(html).to include("@castleio/castle-js")
       expect(html).to include(".configure")
-      expect(html).to include("pk")
       expect(html).to include("pk_test")
       expect(html).to include("castleDeviseOnFormSubmit")
-      expect(html).not_to include("castle.umd.js")
       expect(html).not_to include("cdn.castle.io")
+      expect(html).not_to include("castle.browser.js")
     end
 
-    it "loads a hosted UMD build when src is given" do
-      html = helper.castle_javascript_tag(src: "/castle-js/castle.umd.js")
+    it "loads a custom UMD src when given" do
+      html = helper.castle_javascript_tag(src: "/assets/castle.umd.js")
 
-      expect(html).to include("/castle-js/castle.umd.js")
+      expect(html).to include("/assets/castle.umd.js")
+      expect(html).not_to include("/vendor/castle-js/castle.umd.js")
       expect(html).to include("window.module")
-      expect(html).to include("window.Castle")
-      expect(html).to include("@castleio/castle-js")
+      expect(html).not_to include("cdn.castle.io")
+    end
+
+    it "skips the script tag when src is nil" do
+      html = helper.castle_javascript_tag(src: nil)
+
+      expect(html).to include(".configure")
       expect(html).to include("pk_test")
+      expect(html).not_to include("castle.umd.js")
       expect(html).not_to include("cdn.castle.io")
     end
   end