product_tours 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5493d4177a606096eb7c630c0dd4fbab70a5b68ec013e3033b58217ec7de5c02
-  data.tar.gz: f150d164554a4d4a710214b2924fb191aa28e8aee6f87f813cb5c3418e6c9efc
+  metadata.gz: 7c62b8b42042732f293443f7cdfc154b1679fd7b0ba0c6774aca4ade157a54fa
+  data.tar.gz: 88dc14f258d8e5bd14260fe40dbf77c0c58e8adc7816f26a6bb31c4cbd4122b2
 SHA512:
-  metadata.gz: 137467ccfedd59ff4abaa2b4a8f35735b8b02bcde9a9439901905191036d419b221f810f92d57ae66737d45ed492b7b5583e0043006ec68eb7c193bac8fa60d5
-  data.tar.gz: 91993e998b3d5fa607b35d38d20c58c3dfe6963d9a3860df6dc2dd9c8f872f496d7bc501e3ae26301bf843987fd53a532fe2eaacd1785c9b6dc7fe093df3776f
+  metadata.gz: 705534e0de88c34651aa56751e663f4a2d31830b935d09e65a0d8a3c86bc56026630e55e009c5ad82489a6684c693a6395a5f7b9c855c263bee33295fd6510ab
+  data.tar.gz: 4804cc836bac346588ccbab6c547b205fb6e17d45163b02d34cab395d6c272cabce2870793abaaca128691973845ff1ab19b0565f32cfe978ddd4e7a875a124c

data/AGENTS.md

@@ -75,7 +75,7 @@ What a tutorial carries: a `key`, a title, an optional rich description, an opti
 
 ### Video providers
 
-YouTube, Vimeo, Loom, Tella, Voomly, a direct MP4/WebM URL, or an uploaded file (needs Active Storage). Uploaded videos stream through the engine at `/product_tours/media/:id` — not a public blob URL. Do not build your own blob links.
+YouTube, Vimeo, Loom, Tella, Voomly, a direct MP4/WebM URL, or an uploaded file (needs Active Storage). A direct or uploaded video can also take a poster and a WebVTT captions file in the tutorial's language (`poster_url`, `captions_url`); provider embeds keep their own. An app installed before 1.2 lacks those columns until it runs `bin/rails generate product_tours:upgrade` and migrates — the model's `poster_supported?`/`captions_supported?` say whether they exist. Uploaded videos stream through the engine at `/product_tours/media/:id` — not a public blob URL. Do not build your own blob links.
 
 **The engine edits the app's Content Security Policy.** It appends the providers' embed hosts to `frame-src` (or to `default-src` when `frame-src` is unset) in an initializer that runs after the host's own. That is deliberate — an embed silently blocked by CSP is a bad first five minutes — but know it happens, and do not hand-add those `frame-src` entries yourself. If the app sets its CSP somewhere unusual (a middleware, a per-controller override), that is where a blocked embed will come from.
 
@@ -164,7 +164,7 @@ bundle exec rubocop              # must be clean
 BUNDLE_GEMFILE=gemfiles/rails_7.1.gemfile bundle exec rake test   # 7.1, 7.2, 8.0, 8.1 in gemfiles/
 ```
 
-Layout: `app/` controllers, `Tour`, dashboard views · `lib/product_tours/` config, widget JS, seeds, engine, CSP patch · `lib/generators/product_tours/install/` the one generator · `config/locales/` 26 locales · `test/` minitest with `test/dummy` as the host app.
+Layout: `app/` controllers, `Tour`, dashboard views · `lib/product_tours/` config, widget JS, seeds, engine, CSP patch · `lib/generators/product_tours/` the install generator and the idempotent upgrade generator · `config/locales/` 26 locales · `test/` minitest with `test/dummy` as the host app.
 
 Conventions this codebase holds to — follow them rather than the first thing that works:
 

data/CHANGELOG.md

@@ -2,6 +2,38 @@
 
 ## [Unreleased]
 
+## [1.3.0] - 2026-11-09
+
+- **A direct video can be a path on the host app**, such as
+  `/tutorials/billing.en.mp4`, like the poster and captions already could. The
+  tour then plays from whichever environment holds the record, rather than
+  pointing a copied staging or development database at production media.
+  Protocol-relative (`//host/…`) and bare relative paths are still rejected.
+- The dashboard's video field is now a text field, since the browser's URL
+  field refuses a path. It costs the browser's own URL check; the model's
+  validation still decides.
+
+## [1.2.0] - 2026-11-03
+
+- **Direct and uploaded videos can carry a poster and captions.** A tutorial
+  takes a `poster_url` and a WebVTT `captions_url` in its own language; the
+  widget sets the poster and adds a captions track labeled with the language's
+  own name, from a new `captions_label` key in all 26 locales. Without a
+  poster, the player still seeks to an early frame. Provider embeds are
+  unchanged, and a poster or captions on one is a validation error rather than
+  a silently ignored field. The modal's video also gains an accessible name.
+- Both fields accept a relative path or an HTTPS URL, nothing else. A `.vtt`
+  on another origin needs CORS, and the gem does not touch `media-src` or
+  `img-src`: the host's policy decides what loads.
+- A new translation copies the poster and drops the captions, since the
+  source's captions are in the wrong language.
+- **Costs an upgrade step for existing installs.** Fresh installs get both
+  columns. Installs from 1.0 or 1.1 run `bin/rails generate
+  product_tours:upgrade` and migrate; until they do, the model reports
+  `captions_supported?`/`poster_supported?` as false, the dashboard hides both
+  fields and everything else works as before. The upgrade migration checks
+  each column first and is reversible.
+
 ## [1.1.0] - 2026-10-18
 
 - Add Rails edge CI and experimental Ruby 4.0+ Ractor request support. The host
@@ -221,7 +253,10 @@
 - Removed generic tutorial duplication now that translations provide the only
   intentional content-copying workflow.
 
-[Unreleased]: https://github.com/yshmarov/product_tours/compare/v1.0.0...HEAD
+[Unreleased]: https://github.com/yshmarov/product_tours/compare/v1.3.0...HEAD
+[1.3.0]: https://github.com/yshmarov/product_tours/compare/v1.2.0...v1.3.0
+[1.2.0]: https://github.com/yshmarov/product_tours/compare/v1.1.0...v1.2.0
+[1.1.0]: https://github.com/yshmarov/product_tours/compare/v1.0.0...v1.1.0
 [1.0.0]: https://github.com/yshmarov/product_tours/compare/v0.3.3...v1.0.0
 [0.3.3]: https://github.com/yshmarov/product_tours/compare/v0.3.2...v0.3.3
 [0.3.2]: https://github.com/yshmarov/product_tours/compare/v0.3.1...v0.3.2

data/README.md

@@ -144,14 +144,21 @@ Paste any supported HTTPS URL:
 | Loom | Share and embed links |
 | Tella | Video links |
 | Voomly | Share, video, and embed links |
-| Direct | URLs ending in `.mp4` or `.webm` |
+| Direct | HTTPS URLs or paths on your app (`/videos/intro.mp4`) ending in `.mp4` or `.webm` |
 
 YouTube, Vimeo, and Loom metadata comes from their oEmbed endpoints. Metadata is
 best-effort: a timeout never prevents you from saving a valid URL. YouTube uses
 `youtube-nocookie.com`; unsupported hosts and lookalike URLs fail closed.
 
-Direct videos seek to an early frame for a useful preview instead of showing an
-empty player.
+Direct and uploaded videos play in the gem's own player, so they can carry a
+**poster** and **captions**: a WebVTT file in the tutorial's language, labeled
+with that language's own name in the player's captions menu. Both take a path in
+your app or an HTTPS URL. Serve the `.vtt` from your app's origin; a file on
+another origin needs CORS, and your `media-src`/`img-src` policy must allow
+whatever origin you use. Without a poster, the player seeks to an early frame
+instead of showing an empty box. Provider embeds keep their own poster and
+captions. A new translation starts without captions, because the source's file
+is in the wrong language.
 
 <details>
 <summary><b>Upload videos or add rich descriptions</b></summary>
@@ -344,10 +351,11 @@ The following are the model and integration contracts that 1.x will keep
 stable under semantic versioning:
 
 - `ProductTours::Tour`, including `key`, `locale`, `status`, `title`,
-  `video_url`, `video_metadata`, `action_label`, `action_url`,
-  `action_tour_key`, timestamps, `STATUSES`, status methods/scopes,
-  `newest_first`, `action_tour`, `description_supported?`,
-  `video_upload_supported?`, and optional rich-description/video behavior.
+  `video_url`, `video_metadata`, `poster_url`, `captions_url`, `action_label`,
+  `action_url`, `action_tour_key`, timestamps, `STATUSES`, status
+  methods/scopes, `newest_first`, `action_tour`, `description_supported?`,
+  `video_upload_supported?`, `poster_supported?`, `captions_supported?`, and
+  optional rich-description/video behavior.
 - `ProductTours.configure` and the documented configuration options.
 - `mount_product_tours`, `product_tours_tag`, and `data-product-tour="key"`.
 - The tutorial key grammar and per-locale uniqueness contract.
@@ -363,6 +371,19 @@ Dashboard controllers, view partials, CSS classes, generated HTML, and widget
 implementation objects are private. Incompatible changes to the public list
 above wait for a new major version; a deprecation normally ships first.
 
+### Upgrading from 1.0 or 1.1
+
+Posters and captions (1.2) need two new columns. Until you add them, the
+dashboard simply does not offer those fields:
+
+```bash
+bin/rails generate product_tours:upgrade
+bin/rails db:migrate
+```
+
+The upgrade migration checks each column before adding it, so it is safe on an
+install that already has them.
+
 ### Upgrading from 0.3.x
 
 Version 1.0.0 is the deliberate terminology break from the pre-1.0 API.

data/SECURITY.md

@@ -25,8 +25,8 @@ which defaults to everyone because showing tutorials in production is the gem's
 purpose. The dashboard is separately protected by `authorize_admin` and fails
 closed outside development until the host explicitly grants access.
 
-A tour can store its key, locale, status, title, video URL and metadata, primary
-action label/destination, timestamps, optional Action Text description, and an
+A tour can store its key, locale, status, title, video URL and metadata, poster and
+captions URLs, primary action label/destination, timestamps, optional Action Text description, and an
 optional Active Storage video. Uploaded videos stream through the engine's
 authorization gate with private, non-stored responses; the route never redirects
 to a reusable signed blob URL. Hosts still own the storage service, bucket

data/app/controllers/product_tours/interactions_controller.rb

@@ -47,8 +47,7 @@ module ProductTours
     end
 
     def tour_payload(tour)
-      video = tour.resolved_video
-      video[:url] = media_path(tour) if video&.dig(:kind) == 'upload'
+      video = player_video(tour)
       {
         key: tour.key,
         locale: tour.locale,
@@ -63,6 +62,25 @@ module ProductTours
       }
     end
 
+    def player_video(tour)
+      video = tour.resolved_video
+      return if video.nil?
+
+      video[:url] = media_path(tour) if video[:kind] == 'upload'
+      video[:poster] = video.delete(:poster_url)
+      if (captions_url = video.delete(:captions_url))
+        video[:captions] = { url: captions_url, srclang: tour.locale, label: captions_label(tour.locale) }
+      end
+      video.compact
+    end
+
+    # Named in its own language, as a player's captions menu lists them.
+    def captions_label(locale)
+      I18n.t(:captions_label, scope: :product_tours, locale: locale, default: locale.to_s)
+    rescue I18n::InvalidLocale
+      locale.to_s
+    end
+
     def default_action_label(tour)
       key = tour.action_tour_key.present? ? :next : :done
       I18n.t(key, scope: :product_tours, default: key.to_s.humanize)

data/app/controllers/product_tours/tours_controller.rb

@@ -89,6 +89,7 @@ module ProductTours
       translation = source.dup
       translation.locale = locale
       translation.status = 'draft'
+      translation.captions_url = nil if Tour.captions_supported?
       if translation.action_tour_key.present? &&
          !Tour.exists?(locale: locale, key: translation.action_tour_key)
         translation.action_tour_key = nil
@@ -160,6 +161,8 @@ module ProductTours
       permitted = %i[key status title video_url action_label action_url action_tour_key]
       permitted << :description if Tour.description_supported?
       permitted << :video if Tour.video_upload_supported?
+      permitted << :poster_url if Tour.poster_supported?
+      permitted << :captions_url if Tour.captions_supported?
       params.require(:tour).permit(*permitted)
     end
 

data/app/models/product_tours/tour.rb

@@ -30,6 +30,8 @@ module ProductTours
     validate :action_url_is_safe
     validate :video_url_is_supported
     validate :uploaded_file_is_video
+    validate :player_media_urls_are_safe
+    validate :player_media_has_a_player
 
     before_validation :set_default_locale
     before_validation :derive_video_metadata, if: :will_save_change_to_video_url?
@@ -50,12 +52,26 @@ module ProductTours
       false
     end
 
+    # Added in 1.2. An install from an earlier version has neither column until
+    # it runs `bin/rails generate product_tours:upgrade`, and works as before.
+    def self.captions_supported?
+      column_names.include?('captions_url')
+    rescue ActiveRecord::NoDatabaseError, ActiveRecord::StatementInvalid
+      false
+    end
+
+    def self.poster_supported?
+      column_names.include?('poster_url')
+    rescue ActiveRecord::NoDatabaseError, ActiveRecord::StatementInvalid
+      false
+    end
+
     def uploaded_video?
       self.class.video_upload_supported? && video.attached?
     end
 
     def resolved_video
-      return { kind: 'upload', provider: 'upload', url: nil } if uploaded_video?
+      return { kind: 'upload', provider: 'upload', url: nil, **player_media } if uploaded_video?
 
       resolved = VideoResolver.resolve(video_url)
       return if resolved.nil?
@@ -64,10 +80,16 @@ module ProductTours
         kind: resolved.kind,
         provider: resolved.provider,
         url: resolved.url,
-        thumbnail_url: video_metadata.to_h['thumbnail_url']
+        thumbnail_url: video_metadata.to_h['thumbnail_url'],
+        **(resolved.direct? ? player_media : {})
       }.compact
     end
 
+    # The tour's own video player can show a poster and a captions track.
+    # Provider iframes cannot: their poster and captions are the provider's.
+    def captions_url = (self[:captions_url] if self.class.captions_supported?)
+    def poster_url = (self[:poster_url] if self.class.poster_supported?)
+
     def action_tour
       return if action_tour_key.blank?
 
@@ -88,7 +110,8 @@ module ProductTours
     def video_url_is_supported
       return if video_url.blank? || VideoResolver.resolve(video_url)
 
-      errors.add(:video_url, 'must be an HTTPS YouTube, Vimeo, Loom, Tella, Voomly, MP4, or WebM URL')
+      errors.add(:video_url,
+                 'must be an HTTPS YouTube, Vimeo, Loom, Tella, Voomly, MP4, or WebM URL, or an MP4 or WebM path')
     end
 
     def action_url_is_safe
@@ -125,6 +148,34 @@ module ProductTours
       errors.add(:action_tour_key, 'must identify an existing tour in the same locale')
     end
 
+    def player_media
+      { poster_url: poster_url.presence, captions_url: captions_url.presence }.compact
+    end
+
+    def player_media_urls_are_safe
+      { captions_url: captions_url, poster_url: poster_url }.each do |attribute, value|
+        next if value.blank? || safe_media_url?(value)
+
+        errors.add(attribute, 'must be a relative path or an HTTPS URL')
+      end
+    end
+
+    def player_media_has_a_player
+      return if captions_url.blank? && poster_url.blank?
+      return if uploaded_video? || VideoResolver.resolve(video_url)&.direct?
+
+      errors.add(:base, 'A poster and captions need a direct MP4/WebM URL or an uploaded video')
+    end
+
+    def safe_media_url?(value)
+      return !value.start_with?('//') if value.start_with?('/')
+
+      uri = URI.parse(value)
+      uri.is_a?(URI::HTTPS) && uri.host.present? && uri.userinfo.nil?
+    rescue URI::InvalidURIError
+      false
+    end
+
     def uploaded_file_is_video
       return unless uploaded_video?
       return if video.blob.content_type.to_s.start_with?('video/')

data/app/views/product_tours/tours/_form.html.erb

@@ -89,9 +89,9 @@
     <div data-video-source-fields="url" <%= "hidden" unless video_source == "url" %>>
       <div class="field">
         <%= form.label :video_url, t("product_tours.dashboard.video_url", default: "Video URL") %>
-        <%= form.url_field :video_url, placeholder: "https://www.loom.com/share/...",
-                           disabled: video_source != "url", data: { video_preview_input: true } %>
-        <small><%= t("product_tours.dashboard.video_hint", default: "YouTube, Vimeo, Loom, Tella, Voomly, or a direct MP4/WebM URL.") %></small>
+        <%= form.text_field :video_url, placeholder: "https://www.loom.com/share/...",
+                            disabled: video_source != "url", data: { video_preview_input: true } %>
+        <small><%= t("product_tours.dashboard.video_hint", default: "YouTube, Vimeo, Loom, Tella, Voomly, or a direct MP4/WebM URL or path.") %></small>
       </div>
       <div class="form-video-preview" data-video-preview
            data-endpoint="<%= video_preview_tours_path %>"
@@ -115,6 +115,21 @@
         </div>
       </div>
     <% end %>
+
+    <% if ProductTours::Tour.poster_supported? %>
+      <div class="field">
+        <%= form.label :poster_url, t("product_tours.dashboard.poster_url", default: "Poster image URL") %>
+        <%= form.text_field :poster_url, placeholder: "/tutorials/billing-poster.webp" %>
+        <small><%= t("product_tours.dashboard.poster_hint", default: "Shown before playback. For direct and uploaded videos; providers show their own. A path in this app or an HTTPS URL.") %></small>
+      </div>
+    <% end %>
+    <% if ProductTours::Tour.captions_supported? %>
+      <div class="field">
+        <%= form.label :captions_url, t("product_tours.dashboard.captions_url", default: "Captions file URL (WebVTT)") %>
+        <%= form.text_field :captions_url, placeholder: "/tutorials/billing.en.vtt" %>
+        <small><%= t("product_tours.dashboard.captions_hint", default: "Captions in this tutorial's language, for direct and uploaded videos. Serve the .vtt from this app: a file on another origin needs CORS. A new translation starts without captions.") %></small>
+      </div>
+    <% end %>
   </section>
 
   <section class="form-section">

data/app/views/product_tours/tours/_tour_panel.html.erb

@@ -34,6 +34,12 @@
         <dt><%= t("product_tours.dashboard.publication_status", default: "Publication status") %></dt>
         <dd><span class="badge status-<%= tour.status %>"><%= tour.status.humanize %></span></dd>
         <dt><%= t("product_tours.dashboard.video_url", default: "Video URL") %></dt><dd><%= tour.video_url.presence || "—" %></dd>
+        <% if ProductTours::Tour.poster_supported? %>
+          <dt><%= t("product_tours.dashboard.poster_url", default: "Poster image URL") %></dt><dd><%= tour.poster_url.presence || "—" %></dd>
+        <% end %>
+        <% if ProductTours::Tour.captions_supported? %>
+          <dt><%= t("product_tours.dashboard.captions_url", default: "Captions file URL (WebVTT)") %></dt><dd><%= tour.captions_url.presence || "—" %></dd>
+        <% end %>
         <dt><%= t("product_tours.dashboard.action_label", default: "Action label") %></dt><dd><%= tour.action_label.presence || default_label %></dd>
         <dt><%= t("product_tours.dashboard.action_url", default: "Action URL") %></dt><dd><%= tour.action_url.presence || "—" %></dd>
         <dt><%= t("product_tours.dashboard.next_tour", default: "Next tutorial") %></dt>

data/config/locales/product_tours.ar.yml

@@ -6,6 +6,7 @@ ar:
     done: "تم"
     dialog: "دليل المنتج"
     video: "فيديو تعليمي"
+    captions_label: "العربية"
     unavailable: "هذا الدليل غير متاح."
     dashboard:
       title: "جولات المنتج"

data/config/locales/product_tours.bg.yml

@@ -6,6 +6,7 @@ bg:
     done: "Готово"
     dialog: "Урок за продукта"
     video: "Видео урок"
+    captions_label: "Български"
     unavailable: "Този урок не е наличен."
     dashboard:
       title: "Продуктови обиколки"

data/config/locales/product_tours.bn.yml

@@ -6,6 +6,7 @@ bn:
     done: "সম্পন্ন"
     dialog: "পণ্য টিউটোরিয়াল"
     video: "টিউটোরিয়াল ভিডিও"
+    captions_label: "বাংলা"
     unavailable: "এই টিউটোরিয়ালটি উপলভ্য নয়।"
     dashboard:
       title: "পণ্য পরিচিতি"

data/config/locales/product_tours.de.yml

@@ -6,6 +6,7 @@ de:
     done: "Fertig"
     dialog: "Produkttutorial"
     video: "Tutorialvideo"
+    captions_label: "Deutsch"
     unavailable: "Dieses Tutorial ist nicht verfügbar."
     dashboard:
       title: "Produkttouren"

data/config/locales/product_tours.el.yml

@@ -6,6 +6,7 @@ el:
     done: "Τέλος"
     dialog: "Οδηγός προϊόντος"
     video: "Βίντεο οδηγός"
+    captions_label: "Ελληνικά"
     unavailable: "Αυτός ο οδηγός δεν είναι διαθέσιμος."
     dashboard:
       title: "Περιηγήσεις προϊόντος"

data/config/locales/product_tours.en.yml

@@ -6,6 +6,7 @@ en:
     done: "Done"
     dialog: "Product tutorial"
     video: "Tutorial video"
+    captions_label: "English"
     unavailable: "This tutorial is unavailable."
     dashboard:
       title: "Product tours"

data/config/locales/product_tours.es.yml

@@ -6,6 +6,7 @@ es:
     done: "Listo"
     dialog: "Tutorial del producto"
     video: "Video tutorial"
+    captions_label: "Español"
     unavailable: "Este tutorial no está disponible."
     dashboard:
       title: "Recorridos del producto"

data/config/locales/product_tours.fr.yml

@@ -6,6 +6,7 @@ fr:
     done: "Terminé"
     dialog: "Tutoriel produit"
     video: "Vidéo du tutoriel"
+    captions_label: "Français"
     unavailable: "Ce tutoriel n’est pas disponible."
     dashboard:
       title: "Visites guidées"

data/config/locales/product_tours.hi.yml

@@ -6,6 +6,7 @@ hi:
     done: "पूरा हुआ"
     dialog: "उत्पाद ट्यूटोरियल"
     video: "ट्यूटोरियल वीडियो"
+    captions_label: "हिन्दी"
     unavailable: "यह ट्यूटोरियल उपलब्ध नहीं है।"
     dashboard:
       title: "उत्पाद परिचय"

data/config/locales/product_tours.hr.yml

@@ -6,6 +6,7 @@ hr:
     done: "Gotovo"
     dialog: "Vodič kroz proizvod"
     video: "Video vodič"
+    captions_label: "Hrvatski"
     unavailable: "Ovaj vodič nije dostupan."
     dashboard:
       title: "Vodiči kroz proizvod"

data/config/locales/product_tours.id.yml

@@ -6,6 +6,7 @@ id:
     done: "Selesai"
     dialog: "Tutorial produk"
     video: "Video tutorial"
+    captions_label: "Bahasa Indonesia"
     unavailable: "Tutorial ini tidak tersedia."
     dashboard:
       title: "Tur produk"

data/config/locales/product_tours.it.yml

@@ -6,6 +6,7 @@ it:
     done: "Fatto"
     dialog: "Tutorial del prodotto"
     video: "Video tutorial"
+    captions_label: "Italiano"
     unavailable: "Questo tutorial non è disponibile."
     dashboard:
       title: "Tour del prodotto"

data/config/locales/product_tours.ja.yml

@@ -6,6 +6,7 @@ ja:
     done: "完了"
     dialog: "製品チュートリアル"
     video: "チュートリアル動画"
+    captions_label: "日本語"
     unavailable: "このチュートリアルは利用できません。"
     dashboard:
       title: "製品ツアー"

data/config/locales/product_tours.ko.yml

@@ -6,6 +6,7 @@ ko:
     done: "완료"
     dialog: "제품 튜토리얼"
     video: "튜토리얼 동영상"
+    captions_label: "한국어"
     unavailable: "이 튜토리얼을 사용할 수 없습니다."
     dashboard:
       title: "제품 둘러보기"

data/config/locales/product_tours.lb.yml

@@ -6,6 +6,7 @@ lb:
     done: "Fäerdeg"
     dialog: "Produktutorial"
     video: "Tutorialvideo"
+    captions_label: "Lëtzebuergesch"
     unavailable: "Dësen Tutorial ass net verfügbar."
     dashboard:
       title: "Produkttouren"

data/config/locales/product_tours.nl.yml

@@ -6,6 +6,7 @@ nl:
     done: "Klaar"
     dialog: "Producttutorial"
     video: "Tutorialvideo"
+    captions_label: "Nederlands"
     unavailable: "Deze tutorial is niet beschikbaar."
     dashboard:
       title: "Productrondleidingen"

data/config/locales/product_tours.pl.yml

@@ -6,6 +6,7 @@ pl:
     done: "Gotowe"
     dialog: "Samouczek produktu"
     video: "Film instruktażowy"
+    captions_label: "Polski"
     unavailable: "Ten samouczek jest niedostępny."
     dashboard:
       title: "Prezentacje produktu"

data/config/locales/product_tours.pt.yml

@@ -6,6 +6,7 @@ pt:
     done: "Concluir"
     dialog: "Tutorial do produto"
     video: "Vídeo tutorial"
+    captions_label: "Português"
     unavailable: "Este tutorial não está disponível."
     dashboard:
       title: "Tours do produto"

data/config/locales/product_tours.ro.yml

@@ -6,6 +6,7 @@ ro:
     done: "Gata"
     dialog: "Tutorial de produs"
     video: "Videoclip tutorial"
+    captions_label: "Română"
     unavailable: "Acest tutorial nu este disponibil."
     dashboard:
       title: "Tururi de produs"

data/config/locales/product_tours.ru.yml

@@ -6,6 +6,7 @@ ru:
     done: "Готово"
     dialog: "Руководство по продукту"
     video: "Обучающее видео"
+    captions_label: "Русский"
     unavailable: "Это руководство недоступно."
     dashboard:
       title: "Обзоры продукта"

data/config/locales/product_tours.th.yml

@@ -6,6 +6,7 @@ th:
     done: "เสร็จสิ้น"
     dialog: "บทแนะนำผลิตภัณฑ์"
     video: "วิดีโอบทแนะนำ"
+    captions_label: "ไทย"
     unavailable: "บทแนะนำนี้ไม่พร้อมใช้งาน"
     dashboard:
       title: "ทัวร์ผลิตภัณฑ์"

data/config/locales/product_tours.tr.yml

@@ -6,6 +6,7 @@ tr:
     done: "Bitti"
     dialog: "Ürün eğitimi"
     video: "Eğitim videosu"
+    captions_label: "Türkçe"
     unavailable: "Bu eğitim kullanılamıyor."
     dashboard:
       title: "Ürün turları"

data/config/locales/product_tours.uk.yml

@@ -6,6 +6,7 @@ uk:
     done: "Готово"
     dialog: "Посібник із продукту"
     video: "Навчальне відео"
+    captions_label: "Українська"
     unavailable: "Цей посібник недоступний."
     dashboard:
       title: "Огляди продукту"

data/config/locales/product_tours.ur.yml

@@ -6,6 +6,7 @@ ur:
     done: "مکمل"
     dialog: "پروڈکٹ ٹیوٹوریل"
     video: "ٹیوٹوریل ویڈیو"
+    captions_label: "اردو"
     unavailable: "یہ ٹیوٹوریل دستیاب نہیں ہے۔"
     dashboard:
       title: "پروڈکٹ ٹورز"

data/config/locales/product_tours.vi.yml

@@ -6,6 +6,7 @@ vi:
     done: "Xong"
     dialog: "Hướng dẫn sản phẩm"
     video: "Video hướng dẫn"
+    captions_label: "Tiếng Việt"
     unavailable: "Hướng dẫn này không khả dụng."
     dashboard:
       title: "Chuyến tham quan sản phẩm"

data/config/locales/product_tours.zh-CN.yml

@@ -6,6 +6,7 @@
     done: "完成"
     dialog: "产品教程"
     video: "教程视频"
+    captions_label: "简体中文"
     unavailable: "此教程不可用。"
     dashboard:
       title: "产品导览"

data/lib/generators/product_tours/install/templates/create_product_tours_tours.rb.tt

@@ -9,6 +9,8 @@ class CreateProductToursTours < ActiveRecord::Migration<%= migration_version %>
       t.string :title, null: false
       t.text :video_url
       t.json :video_metadata, null: false, default: {}
+      t.text :poster_url
+      t.text :captions_url
       t.string :action_label
       t.text :action_url
       t.string :action_tour_key

data/lib/generators/product_tours/upgrade/templates/add_player_media_to_product_tours_tours.rb.tt

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class AddPlayerMediaToProductToursTours < ActiveRecord::Migration<%= migration_version %>
+  COLUMNS = %i[poster_url captions_url].freeze
+
+  def up
+    COLUMNS.each do |column|
+      add_column :product_tours_tours, column, :text unless column_exists?(:product_tours_tours, column)
+    end
+  end
+
+  def down
+    COLUMNS.each do |column|
+      remove_column :product_tours_tours, column if column_exists?(:product_tours_tours, column)
+    end
+  end
+end

data/lib/generators/product_tours/upgrade/upgrade_generator.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require 'rails/generators/active_record'
+require_relative '../migration_helpers'
+
+module ProductTours
+  module Generators
+    # Brings an install created by an earlier version up to the current schema.
+    # Every migration it writes checks before it changes anything, so running it
+    # on an app that is already current is harmless.
+    class UpgradeGenerator < Rails::Generators::Base
+      include ActiveRecord::Generators::Migration
+      include MigrationHelpers
+
+      source_root File.expand_path('templates', __dir__)
+      desc 'Adds the columns newer product_tours versions use to an existing install.'
+
+      def create_player_media_migration
+        migration_template 'add_player_media_to_product_tours_tours.rb.tt',
+                           'db/migrate/add_player_media_to_product_tours_tours.rb', skip: true
+      end
+
+      def post_upgrade
+        say "\nRun `bin/rails db:migrate` to finish the product_tours upgrade.", :green
+      end
+    end
+  end
+end

data/lib/product_tours/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ProductTours
-  VERSION = '1.1.0'
+  VERSION = '1.3.0'
 end

data/lib/product_tours/video_resolver.rb

@@ -33,6 +33,8 @@ module ProductTours
     end
 
     def resolve
+      return relative if @url.start_with?('/') && !@url.start_with?('//')
+
       uri = URI.parse(@url)
       return unless uri.is_a?(URI::HTTPS) && uri.host.present? && uri.userinfo.nil?
 
@@ -110,6 +112,14 @@ module ProductTours
       Result.new(kind: 'iframe', provider: 'voomly', provider_id: id, url: embed)
     end
 
+    # A path on the host app's own origin, so a tour plays from whichever environment holds the record.
+    def relative
+      uri = URI.parse(@url)
+      direct(uri) if uri.host.nil? && uri.scheme.nil?
+    rescue URI::InvalidURIError
+      nil
+    end
+
     def direct(uri)
       return unless uri.path.match?(/\.(?:mp4|webm)\z/i)
 

data/lib/product_tours/widget.js

@@ -193,12 +193,24 @@
       player.controls = true;
       player.playsInline = true;
       player.preload = "metadata";
-      showFirstVideoFrame(player);
+      player.setAttribute("aria-label", title || config.labels.video);
+      if (video.poster) player.poster = video.poster;
+      else showFirstVideoFrame(player);
+      if (video.captions) player.appendChild(captionsTrack(video.captions));
       frame.appendChild(player);
     }
     return frame;
   }
 
+  function captionsTrack(captions) {
+    var track = document.createElement("track");
+    track.kind = "captions";
+    track.src = captions.url;
+    track.srclang = captions.srclang;
+    track.label = captions.label;
+    return track;
+  }
+
   function showFirstVideoFrame(player) {
     function seek() {
       if (!Number.isFinite(player.duration) || player.duration <= 0 || player.currentTime > 0) return;

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: product_tours
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Yaroslav Shmarov
@@ -101,6 +101,8 @@ files:
 - lib/generators/product_tours/install/templates/create_product_tours_tours.rb.tt
 - lib/generators/product_tours/install/templates/initializer.rb
 - lib/generators/product_tours/migration_helpers.rb
+- lib/generators/product_tours/upgrade/templates/add_player_media_to_product_tours_tours.rb.tt
+- lib/generators/product_tours/upgrade/upgrade_generator.rb
 - lib/product_tours.rb
 - lib/product_tours/configuration.rb
 - lib/product_tours/content_security_policy.rb