spree_cm_commissioner 2.4.1 → 2.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e32e4116a234b679abcfe3a9d7005bd61890d80936839c32330ecf2b421dadf
-  data.tar.gz: a7759f377e09d49281150257a496e44af61e4cabb67a8bec0bacb20a73ea439d
+  metadata.gz: 5f580394367847906251ac52666c73ae79bb1a117948805217616c0a83f9300a
+  data.tar.gz: e8b7ae961151a074aab2084e7600b55da2969405143cf1b9e4cd1b95fcd7040b
 SHA512:
-  metadata.gz: 5119cedb570e77e3417bf723ea84926231e4d72000686312a194c1cfb4764061b5df9801923a5db629d8b8adccfd8a70378a238a0c099af46abe8f5c6a2da1d0
-  data.tar.gz: adeee4909603c0294be64345ea3de5b310e2dcaa174669137794b56dd23b800ddd9a1f429da636df23953d80154a3b96835cb19a81274fc0908edaae1ebd13d9
+  metadata.gz: 35e303df725eb93bb52a3eceb55672668cea800d77dd7c4e4d938b9caf0585477044e20fe646f2a2a7da5209a4ceff6c78ccf8e6adb862378373a66bd1525d19
+  data.tar.gz: f91afe8506292cf778cfb3b8bfdc87f5d2545c2e079abdf5f5d881441c3ae758f218bcbb6798756f860734b5c3af82be30250c2c0a2f5a9e2aea96782d7623ed

data/Gemfile.lock

@@ -34,7 +34,7 @@ GIT
 PATH
   remote: .
   specs:
-    spree_cm_commissioner (2.4.1)
+    spree_cm_commissioner (2.4.3)
       activerecord-multi-tenant
       activerecord_json_validator (~> 2.1, >= 2.1.3)
       aws-sdk-cloudfront

data/README.md

@@ -525,3 +525,35 @@ def wrap_with_multitenant_without(&block)
   MultiTenant.without(&block)
 end
 ```
+
+# Tenant Configuration
+
+
+This gem provides a flexible multi-tenant system. Each tenant can be configured through an admin interface and accessed via API endpoints.
+
+### Admin Tenant Form Structure
+
+The tenant configuration form is organized into several logical sections:
+
+- **Basic Information**: General details such as `name`, `slug`, `description`, `host`, and `status`.
+- **Branding & App Links**: Custom branding options, `Android asset links`, and `Apple app site association` data.
+- **Payment Icons**: Upload and manage icons for different payment statuses (`checkout`, `failed`, `success`, `loader`).
+- **Redirect Settings**: Configure `redirect targets` and `excluded paths` for host-based redirection.
+
+All sections are visually separated for clarity and improved user experience.
+
+### API: Retrieve Tenant by Host
+
+With your `Client-Side` you can retrieve tenant configuration by host using a RESTful API endpoint:
+
+```http
+GET /api/v2/storefront/tenants/:host
+```
+
+Example request:
+
+```
+GET /api/v2/storefront/tenants/example.host.com
+```
+
+The response returns the tenant's configuration in JSON format, including preferences and branding information.

data/app/controllers/spree/api/v2/storefront/popular_route_places_controller.rb

@@ -18,7 +18,9 @@ module Spree
 
           # override
           def collection
-            @collection ||= collection_finder.new.execute
+            @collection ||= collection_finder.new.execute(
+              route_type: params[:route_type]
+            )
           end
 
           # override

data/app/controllers/spree/api/v2/storefront/route_places_controller.rb

@@ -3,7 +3,7 @@
 # GET /api/v2/storefront/route_places
 #
 # Finds places (origins or destinations) that are connected to a given place through existing routes.
-# Optionally filters results by keyword. Supports two modes:
+# Optionally filters results by keyword or route_type. Supports two modes:
 #
 # Usage 1: Connected places (requires place_id)
 #   - Finds places connected to a specific place via routes
@@ -27,7 +27,7 @@
 #   - Returns empty collection if place_type is invalid
 #   - If place_id provided: returns places connected to that place
 #   - If place_id blank: returns all origins/destinations
-#   - Filters results by keyword if provided
+#   - Filters results by keyword or route_type if provided
 #
 # @example Mode 1: Find destinations connected to origin place ID 123
 #   GET /api/v2/storefront/route_places?place_id=123&place_type=destination
@@ -49,7 +49,8 @@ module Spree
             @collection ||= collection_finder.new(
               place_type: params[:place_type],
               place_id: params[:place_id],
-              keyword: params[:query]
+              keyword: params[:query],
+              route_type: params[:route_type]
             ).execute
           end
 

data/app/controllers/spree/api/v2/storefront/tenants_controller.rb

@@ -0,0 +1,30 @@
+module Spree
+  module Api
+    module V2
+      module Storefront
+        class TenantsController < ::Spree::Api::V2::BaseController
+          def show
+            render_serialized_payload { serialize_resource(resource) }
+          end
+
+          private
+
+          # override
+          def resource
+            model_class.find_by(host: params[:id])
+          end
+
+          # override
+          def model_class
+            SpreeCmCommissioner::Tenant
+          end
+
+          # override
+          def resource_serializer
+            Spree::V2::Storefront::TenantSerializer
+          end
+        end
+      end
+    end
+  end
+end

data/app/finders/spree_cm_commissioner/places/find_with_route.rb

@@ -3,48 +3,78 @@
 # @param place_type [String] Required. 'origin' or 'destination'
 # @param place_id [Integer] Optional. Filter by connected place ID
 # @param keyword [String] Optional. Filter by place name (case-insensitive)
+# @param route_type [Symbol, String] Optional. Filter by route type from associated trips (e.g., :ferry, :bus)
 #
 # @return [ActiveRecord::Relation<SpreeCmCommissioner::Place>]
 #
 # Modes:
 #   - place_id only: returns connected places (origins TO or destinations FROM given place)
 #   - keyword only: filters by name
-#   - both: connected places filtered by name
+#   - route_type only: filters by trip route types on those routes
+#   - combinations: connected places filtered by name and/or route type
 #   - neither: all origins/destinations in routes
 #
-# @example Origins with routes to place 123
-#   FindWithRoute.new(place_type: 'origin', place_id: 123).execute
+# @example Origins with ferry trips to place 123
+#   FindWithRoute.new(place_type: 'origin', place_id: 123, route_type: :ferry).execute
 #
-# @example Destinations filtered by keyword
-#   FindWithRoute.new(place_type: 'destination', keyword: 'Phnom').execute
+# @example Destinations filtered by keyword and route type
+#   FindWithRoute.new(place_type: 'destination', keyword: 'Phnom', route_type: :bus).execute
 module SpreeCmCommissioner
   module Places
     class FindWithRoute
-      attr_reader :place_type, :place_id, :keyword
+      attr_reader :place_type, :place_id, :keyword, :route_type
 
-      def initialize(place_type:, place_id: nil, keyword: nil)
+      def initialize(place_type:, place_id: nil, keyword: nil, route_type: nil)
         @place_type = place_type
         @place_id = place_id
         @keyword = keyword
+        @route_type = route_type
       end
 
       def execute
         return SpreeCmCommissioner::Place.none if place_type.blank?
-
-        result = if place_type == 'origin'
-                   scope = SpreeCmCommissioner::Place.with_routes_as_origin
-                   place_id.present? ? scope.where(cm_routes: { destination_place_id: place_id }) : scope
-                 else
-                   scope = SpreeCmCommissioner::Place.with_routes_as_destination
-                   place_id.present? ? scope.where(cm_routes: { origin_place_id: place_id }) : scope
-                 end
-
         return SpreeCmCommissioner::Place.none if place_id.present? && !SpreeCmCommissioner::Place.exists?(place_id)
 
-        # Apply keyword filter if provided
-        result = result.where('cm_places.name ILIKE ?', "%#{keyword}%") if keyword.present?
+        result = scope
+        result = apply_keyword_filter(result) if keyword.present?
+        result = apply_route_type_filter(result) if route_type.present?
         result
       end
+
+      private
+
+      def scope
+        return SpreeCmCommissioner::Place.none unless valid_place_type?
+
+        base_scope = origin? ? SpreeCmCommissioner::Place.with_routes_as_origin : SpreeCmCommissioner::Place.with_routes_as_destination
+
+        return base_scope if place_id.blank?
+
+        if origin?
+          base_scope.where(routes_as_origin: { destination_place_id: place_id })
+        else
+          base_scope.where(routes_as_destination: { origin_place_id: place_id })
+        end
+      end
+
+      def apply_keyword_filter(result)
+        result.where('cm_places.name ILIKE ?', "%#{keyword}%")
+      end
+
+      def apply_route_type_filter(result)
+        trips_association = origin? ? :trips_as_origin : :trips_as_destination
+        result.joins(trips_association)
+              .where(cm_trips: { route_type: route_type.to_sym })
+              .distinct
+      end
+
+      def origin?
+        place_type == 'origin'
+      end
+
+      def valid_place_type?
+        %w[origin destination].include?(place_type)
+      end
     end
   end
 end

data/app/finders/spree_cm_commissioner/routes/find_popular.rb

@@ -4,21 +4,46 @@
 # 1. fulfilled_order_count (completed orders) - DESC
 # 2. order_count (total orders including incomplete) - DESC
 #
+# @param route_type [Symbol, String] Optional. Filter by route type from associated trips (e.g., :ferry, :bus)
+#
 # @return [ActiveRecord::Relation<SpreeCmCommissioner::Route>] Routes with origin and destination places loaded,
 #   ordered from most to least popular
 #
-# @example
+# @example Get all popular routes
+#   finder = SpreeCmCommissioner::Routes::FindPopular.new
+#   finder.execute # => Returns all routes sorted by fulfillment and order counts
+#
+# @example Get popular ferry routes
+#   finder = SpreeCmCommissioner::Routes::FindPopular.new
+#   finder.execute(route_type: :ferry) # => Returns ferry routes sorted by popularity
+#
+# @example Get popular bus routes
 #   finder = SpreeCmCommissioner::Routes::FindPopular.new
-#   finder.execute # => Returns routes sorted by fulfillment and order counts
+#   finder.execute(route_type: :bus) # => Returns bus routes sorted by popularity
 
 module SpreeCmCommissioner
   module Routes
     class FindPopular
-      def execute
-        SpreeCmCommissioner::Route
-          .includes(:origin_place, :destination_place)
-          .order(Arel.sql('COALESCE(fulfilled_order_count, 0) DESC'))
-          .order(Arel.sql('COALESCE(order_count, 0) DESC'))
+      def execute(route_type: nil)
+        scope(route_type: route_type)
+      end
+
+      private
+
+      def scope(route_type: nil)
+        result = SpreeCmCommissioner::Route
+                 .includes(:origin_place, :destination_place)
+
+        if route_type.present?
+          # Filter routes that have trips with the specified route_type
+          route_scope = SpreeCmCommissioner::Route
+                        .joins(:trips)
+                        .where(cm_trips: { route_type: route_type.to_sym })
+          result = result.where(id: route_scope.select(:id))
+        end
+
+        result.order(Arel.sql('COALESCE(fulfilled_order_count, 0) DESC'))
+              .order(Arel.sql('COALESCE(order_count, 0) DESC'))
       end
     end
   end

data/app/models/concerns/spree_cm_commissioner/tenant_preference.rb

@@ -10,6 +10,8 @@ module SpreeCmCommissioner
       preference :payment_success_image, :string, default: ''
       preference :payment_loader, :string, default: ''
       preference :brand_primary_color, :string, default: ''
+      preference :redirect_target_host, :string, default: ''
+      preference :redirect_excluded_paths, :string, default: ''
     end
   end
 end

data/app/models/concerns/spree_cm_commissioner/vehicle_type.rb

@@ -2,7 +2,7 @@ module SpreeCmCommissioner
   module VehicleType
     extend ActiveSupport::Concern
 
-    VEHICLE_TYPES = %i[suv sedan minivan van sleeping_bus luxury_van air_bus bus].freeze
+    VEHICLE_TYPES = %i[suv sedan minivan van sleeping_bus luxury_van air_bus bus ferry].freeze
 
     included do
       enum vehicle_type: VEHICLE_TYPES if table_exists? && column_names.include?('vehicle_type')

data/app/models/spree_cm_commissioner/place.rb

@@ -24,6 +24,9 @@ module SpreeCmCommissioner
     has_many :routes_as_origin, class_name: 'SpreeCmCommissioner::Route', foreign_key: :origin_place_id
     has_many :routes_as_destination, class_name: 'SpreeCmCommissioner::Route', foreign_key: :destination_place_id
 
+    has_many :trips_as_origin, through: :routes_as_origin, source: :trips
+    has_many :trips_as_destination, through: :routes_as_destination, source: :trips
+
     # Scopes for route-based filtering
     scope :with_routes_as_origin, -> { joins(:routes_as_origin).distinct }
     scope :with_routes_as_destination, -> { joins(:routes_as_destination).distinct }

data/app/request_schemas/spree_cm_commissioner/route_places_request_schema.rb

@@ -4,6 +4,7 @@ module SpreeCmCommissioner
       required(:place_type).filled(:string)
       optional(:query).maybe(:string)
       optional(:place_id).maybe(:integer)
+      optional(:route_type).maybe(:string)
     end
 
     rule(:place_type) do

data/app/serializers/spree/v2/storefront/tenant_serializer.rb

@@ -0,0 +1,14 @@
+module Spree
+  module V2
+    module Storefront
+      class TenantSerializer < BaseSerializer
+        set_type :tenant
+
+        attributes :name, :slug, :host, :state
+
+        attribute :redirect_target_host, &:preferred_redirect_target_host
+        attribute :redirect_excluded_paths, &:preferred_redirect_excluded_paths
+      end
+    end
+  end
+end

data/app/views/spree/admin/tenants/_form.html.erb

@@ -1,5 +1,12 @@
-<div data-hook="admin_tenant_form_fields" class="row">
-  <!-- Name Field -->
+
+<!-- ======================== Tenant Basic Info ======================== -->
+<div class="card mb-4">
+  <div class="card-body">
+    <div data-hook="admin_tenant_form_fields" class="row">
+  <!-- Basic Info Section -->
+  <div class="col-12 mb-4">
+    <h4>Basic Information <span class="text-muted" style="font-size: 1rem; font-weight: normal;">(General details about the tenant)</span></h4>
+  </div>
   <div class="col-6">
     <%= f.field_container :name do %>
       <%= f.label :name, raw(Spree.t(:name) + required_span_tag) %>
@@ -9,8 +16,6 @@
       <% end %>
     <% end %>
   </div>
-
-  <!-- Slug Field -->
   <div class="col-6">
     <%= f.field_container :slug do %>
       <%= f.label :slug, raw(Spree.t(:slug)) %>
@@ -20,8 +25,6 @@
       <% end %>
     <% end %>
   </div>
-
-  <!-- Description Field -->
   <div class="col-12">
     <%= f.field_container :description do %>
       <%= f.label :description, raw(Spree.t(:description)) %>
@@ -31,8 +34,6 @@
       <% end %>
     <% end %>
   </div>
-
-  <!-- Host Field -->
   <div class="col-12">
     <%= f.field_container :host do %>
       <%= f.label :host, raw(Spree.t(:host) + required_span_tag) %>
@@ -42,8 +43,37 @@
       <% end %>
     <% end %>
   </div>
+  <div class="col-6">
+    <%= f.field_container :state do %>
+      <%= f.label :state, raw(Spree.t(:state)) %>
+      <%= f.select :state,
+            options_for_select([["Enabled", "enabled"], ["Disabled", "disabled"]], f.object&.state),
+            { required: true },
+            class: 'select2 form-control' %>
+      <% if f.object.errors[:state].any? %>
+        <div class="error text-danger"><%= f.object.errors[:state].join(', ') %></div>
+      <% end %>
+    <% end %>
+  </div>
+    </div>
+  </div>
+</div>
 
-  <!-- Assetlinks Field -->
+<!-- ======================== Branding & App Links ======================== -->
+<div class="card mb-4">
+  <div class="card-body">
+    <div data-hook="admin_tenant_form_fields" class="row mt-4">
+  <!-- Branding Section -->
+  <div class="col-12 mb-4">
+    <h4>Branding & App Links <span class="text-muted" style="font-size: 1rem; font-weight: normal;">(Brand colors and mobile app association settings)</span></h4>
+  </div>
+  <div class="col-md-6">
+    <%= f.label :preferred_brand_primary_color, Spree.t(:brand_primary_color), class: 'form-label' %>
+    <%= f.text_field :preferred_brand_primary_color, class: 'form-control color-picker', placeholder: '#FF5733', value: @object.preferred_brand_primary_color %>
+    <div class="color-preview" style="margin-top: 10px;">
+      <%= content_tag :div, nil, style: "background-color: #{@object.preferred_brand_primary_color}; width: 60px; height: 60px; border: 1px solid #ccc; box-sizing: border-box; display: block;" %>
+    </div>
+  </div>
   <div class="col-12">
     <%= f.field_container :preferred_assetlinks do %>
       <%= f.label :preferred_assetlinks, raw(Spree.t(:assetlinks)) %>
@@ -69,8 +99,6 @@
       <% end %>
     <% end %>
   </div>
-
-  <!-- Apple App Site Association Field -->
   <div class="col-12">
     <%= f.field_container :preferred_apple_app_site_association do %>
       <%= f.label :preferred_apple_app_site_association, raw(Spree.t(:apple_app_site_association)) %>
@@ -100,32 +128,18 @@
       <% end %>
     <% end %>
   </div>
-
-  <!-- Brand Primary Color Field -->
-  <div class="col-md-6">
-    <%= f.label :preferred_brand_primary_color, Spree.t(:brand_primary_color), class: 'form-label' %>
-    <%= f.text_field :preferred_brand_primary_color, class: 'form-control color-picker', placeholder: '#FF5733', value: @object.preferred_brand_primary_color %>
-    <div class="color-preview" style="margin-top: 10px;">
-      <%= content_tag :div, nil, style: "background-color: #{@object.preferred_brand_primary_color}; width: 60px; height: 60px; border: 1px solid #ccc; box-sizing: border-box; display: block;" %>
     </div>
   </div>
-
-  <!-- State Field -->
-  <div class="col-6">
-    <%= f.field_container :state do %>
-      <%= f.label :state, raw(Spree.t(:state)) %>
-      <%= f.select :state,
-            options_for_select([['Enabled', 'enabled'], ['Disabled', 'disabled']], f.object&.state),
-            { required: true },
-            class: 'select2 form-control' %>
-      <% if f.object.errors[:state].any? %>
-        <div class="error text-danger"><%= f.object.errors[:state].join(', ') %></div>
-      <% end %>
-    <% end %>
-  </div>
 </div>
 
-<div data-hook="admin_tenant_form_fields" class="row">
+<!-- ======================== Payment Icons ======================== -->
+<div class="card mb-4">
+  <div class="card-body">
+    <div data-hook="admin_tenant_form_fields" class="row mt-4">
+  <!-- Payment Icons Section -->
+  <div class="col-12 mb-4">
+    <h4>Payment Icons <span class="text-muted" style="font-size: 1rem; font-weight: normal;">(Customize payment status icons for tenant checkout experience)</span></h4>
+  </div>
   <div class="col-12">
     <div class="row gy-4">
       <% payment_icon_fields = [
@@ -134,7 +148,6 @@
           { field: :preferred_payment_success_image, label: Spree.t(:payment_success_image), target: 'success' },
           { field: :preferred_payment_loader, label: Spree.t(:payment_loader), target: 'loader' }
         ] %>
-
       <% payment_icon_fields.each do |icon| %>
         <div class="col-md-3">
           <%= f.field_container icon[:field] do %>
@@ -142,7 +155,6 @@
               <label class="form-label fw-bold mb-2" for="tenant_<%= icon[:field] %>">
                 <%= icon[:label] %>
               </label>
-
               <div class="icon-preview-container mb-2" id="icon-preview-container-<%= icon[:field] %>">
                 <span class="payment-icon-preview" id="icon-preview-<%= icon[:field] %>">
                   <% if f.object.send(icon[:field]).present? %>
@@ -154,7 +166,6 @@
                 <span class="remove-icon-btn <%= 'hidden' unless f.object.send(icon[:field]).present? %>" data-target="<%= icon[:field] %>">&times;</span>
               </div>
             </div>
-
             <%= f.collection_select icon[:field],
                   @vector_icons, :path, :path,
                   { include_blank: 'None' },
@@ -167,4 +178,36 @@
       <% end %>
     </div>
   </div>
+    </div>
+  </div>
+</div>
+
+<!-- ======================== Redirect Settings ======================== -->
+<div class="card mb-4">
+  <div class="card-body">
+    <div data-hook="admin_tenant_form_fields" class="row mt-4">
+  <!-- Redirect Settings Section -->
+  <div class="col-12 mb-4">
+    <h4>Redirect Settings <span class="text-muted" style="font-size: 1rem; font-weight: normal;">(Configure host redirection and excluded paths for this tenant)</span></h4>
+  </div>
+  <div class="col-6">
+    <%= f.field_container :preferred_redirect_target_host do %>
+      <%= f.label :preferred_redirect_target_host, raw(Spree.t(:redirect_target_host)) %>
+      <%= f.text_field :preferred_redirect_target_host, class: 'form-control', placeholder: 'target.example.com' %>
+      <% if f.object.errors[:preferred_redirect_target_host].any? %>
+        <div class="error text-danger"><%= f.object.errors[:preferred_redirect_target_host].join(', ') %></div>
+      <% end %>
+    <% end %>
+  </div>
+  <div class="col-12">
+    <%= f.field_container :preferred_redirect_excluded_paths do %>
+      <%= f.label :preferred_redirect_excluded_paths, raw(Spree.t(:redirect_excluded_paths)) %>
+      <%= f.text_area :preferred_redirect_excluded_paths, class: 'form-control', placeholder: 'eg. /vpago_payments,/.well-known' %>
+      <% if f.object.errors[:preferred_redirect_excluded_paths].any? %>
+        <div class="error text-danger"><%= f.object.errors[:preferred_redirect_excluded_paths].join(', ') %></div>
+      <% end %>
+    <% end %>
+  </div>
+    </div>
+  </div>
 </div>

data/config/routes.rb

@@ -579,7 +579,7 @@ Spree::Core::Engine.add_routes do
         resource :cart, controller: :cart, only: %i[show create destroy] do
           patch :restart_checkout_flow
         end
-
+        resources :tenants, only: %i[show], constraints: { id: /.+/ }
         resources :trip_places
         resources :trip_search, only: [:index]
         resources :trips, only: %i[show]

data/lib/spree_cm_commissioner/version.rb

@@ -1,5 +1,5 @@
 module SpreeCmCommissioner
-  VERSION = '2.4.1'.freeze
+  VERSION = '2.4.3'.freeze
 
   module_function
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spree_cm_commissioner
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 2.4.3
 platform: ruby
 authors:
 - You
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-12-08 00:00:00.000000000 Z
+date: 2025-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: spree
@@ -979,6 +979,7 @@ files:
 - app/controllers/spree/api/v2/storefront/s3_signed_urls_controller.rb
 - app/controllers/spree/api/v2/storefront/seat_layouts_controller.rb
 - app/controllers/spree/api/v2/storefront/self_check_in_controller.rb
+- app/controllers/spree/api/v2/storefront/tenants_controller.rb
 - app/controllers/spree/api/v2/storefront/transit/draft_orders_controller.rb
 - app/controllers/spree/api/v2/storefront/trip_places_controller.rb
 - app/controllers/spree/api/v2/storefront/trip_search_controller.rb
@@ -1816,6 +1817,7 @@ files:
 - app/serializers/spree/v2/storefront/stock_location_serializer_decorator.rb
 - app/serializers/spree/v2/storefront/store_promotion_serializer.rb
 - app/serializers/spree/v2/storefront/taxon_serializer_decorator.rb
+- app/serializers/spree/v2/storefront/tenant_serializer.rb
 - app/serializers/spree/v2/storefront/user_deletion_reason_serializer.rb
 - app/serializers/spree/v2/storefront/user_device_token_serializer.rb
 - app/serializers/spree/v2/storefront/user_profile_serializer.rb