spree_cm_commissioner 2.3.2 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f69009264c3f351003ddd4885f403db68bc0a589a9e28123188a26bdd382b3d6
-  data.tar.gz: fea37b83621c4eb39ee2936ae4d72c377ee6d0767fb240be01c2de82e63d4c83
+  metadata.gz: 5f63b4eb2a25d5dff782d61eb3df12b639c261a418213940ed12d8b9b483b9a1
+  data.tar.gz: 6682f9d70eb92effa0345aee38da3d483c8bf555a74da8c88fc52ddb7553a2e5
 SHA512:
-  metadata.gz: 8530a8855d325ffae9223d3ed705be0f445bd5ce01c2479ef809f783804af5d4b90cd716a5c10076cbad561f6d57c03becf4d8ccb2e7e33bd57144c29bd1ff5e
-  data.tar.gz: 9d2bada64c5ac4701bb9f18d233e8948e0e8b6b9cf6fd0e923157007bd06cde7ef79b13ffa0476aad2a3ec955a268e66249b3f49097fce93136a61dfa0856f4f
+  metadata.gz: 7abea09634def1e05f839d075bb5fcd1cdfac7bc13ed0392ac6c5aa60e5f9aef3a54600d69afa63778aca0ddf62e09ffc1f5c0200dd88f728b7a1bcd0272faea
+  data.tar.gz: f102b65bf2526916e47c728b0e50eebe7ce188b96bc0f206d92be0434499a734fe0c434f5d364554c20d5bcf0cec20f4b2bdb945d321c213ddb03c1678d9f135

data/Gemfile.lock

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

data/app/controllers/spree/api/v2/storefront/intercity_taxi/draft_orders_controller.rb

@@ -4,29 +4,70 @@ module Spree
       module Storefront
         module IntercityTaxi
           class DraftOrdersController < ::Spree::Api::V2::ResourceController
+            include Spree::Api::V2::Storefront::OrderConcern
+            include SpreeCmCommissioner::OrderConcern
+
+            before_action :ensure_order, only: :update
+
             def create
-              order = SpreeCmCommissioner::IntercityTaxiOrder::Create.call(
+              result = SpreeCmCommissioner::IntercityTaxiOrder::Create.call(
                 trip_id: params[:trip_id],
                 from_date: params[:from_date],
                 to_date: params[:to_date],
-                user_id: params[:user_id],
+                user: spree_current_user,
                 quantity: params[:quantity]
               )
 
-              render_serialized_payload { serialize_resource(order) }
-            rescue StandardError => e
-              render_error_payload(e.message)
+              if result.success?
+                render_serialized_payload { serialize_resource(result.value) }
+              else
+                render_error_payload(result.error)
+              end
             end
 
             def update
-              order = SpreeCmCommissioner::IntercityTaxiOrder::Update.call(
-                order_number: params[:id],
-                params: params
+              result = SpreeCmCommissioner::IntercityTaxiOrder::Update.call(
+                order: spree_current_order,
+                remark: params[:remark],
+                pickup_map_place_attributes: params.require(:pickup_map_place_attributes).permit(
+                  :place_name,
+                  :lat,
+                  :lng,
+                  :oob_confirmed
+                ),
+                dropoff_map_place_attributes: params.require(:dropoff_map_place_attributes).permit(
+                  :place_name,
+                  :lat,
+                  :lng,
+                  :oob_confirmed
+                ),
+                distance_attributes: params.require(:distance_attributes).permit(
+                  :distance_km,
+                  :ordered_points,
+                  :estimated_time_minutes,
+                  :base_km,
+                  :detour_pickup_km,
+                  :detour_dropoff_km,
+                  :extra_pickup_km,
+                  :extra_dropoff_km
+                )
               )
 
-              render_serialized_payload { serialize_resource(order) }
-            rescue StandardError => e
-              render_error_payload(e.message)
+              if result.success?
+                render_serialized_payload { serialize_resource(result.value) }
+              else
+                render_error_payload(result.error)
+              end
+            end
+
+            private
+
+            def required_schema
+              if action_name == 'create'
+                SpreeCmCommissioner::IntercityTaxiDraftOrderSchema
+              else
+                SpreeCmCommissioner::IntercityTaxiDraftOrderUpdateSchema
+              end
             end
 
             def resource_serializer

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

@@ -0,0 +1,63 @@
+# API endpoint for retrieving popular routes ordered by order metrics.
+#
+# GET /api/v2/storefront/popular_route_places
+#
+# Returns routes sorted by popularity (fulfilled_order_count, then order_count) with their
+# origin and destination places. Supports optional includes for vendors and nearby_places.
+#
+# Response: Collection of routes serialized with RouteSerializer
+#
+# @example
+#   GET /api/v2/storefront/popular_route_places
+module Spree
+  module Api
+    module V2
+      module Storefront
+        class PopularRoutePlacesController < ::Spree::Api::V2::ResourceController
+          private
+
+          # override
+          def collection
+            @collection ||= collection_finder.new.execute
+          end
+
+          # override
+          def default_resource_includes
+            %w[origin_place destination_place]
+          end
+
+          # override
+          def collection_finder
+            SpreeCmCommissioner::Routes::FindPopular
+          end
+
+          # override
+          def collection_serializer
+            resource_serializer
+          end
+
+          # override
+          def resource_serializer
+            SpreeCmCommissioner::V2::Storefront::RouteSerializer
+          end
+
+          # override
+          def serializer_params
+            super.merge(
+              include_vendors: include_vendors?,
+              include_nearby_places: include_nearby_places?
+            )
+          end
+
+          def include_vendors?
+            resource_includes.include?(:vendors) || false
+          end
+
+          def include_nearby_places?
+            resource_includes.include?(:nearby_places) || false
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,68 @@
+# API endpoint for searching places that are used in routes by keyword.
+#
+# GET /api/v2/storefront/route_places
+#
+# Searches for places (origins or destinations) that are used in existing routes,
+# filtered by keyword search on place names.
+#
+# Query Parameters:
+#   - query: [String] Required. Keyword to search in place names (case-insensitive)
+#   - place_type: [String] Required. Type of route place: 'origin' or 'destination'
+#   - include: Optional comma-separated list (e.g., 'vendors,nearby_places')
+#
+# Response: Collection of places serialized with PlaceSerializer
+#
+# Behavior:
+#   - Returns empty collection if query is blank or place_type is invalid
+#   - UI should only call this endpoint when user has input a search term
+#   - For initial/empty state, use GET /api/v2/storefront/popular_route_places instead
+#
+# @example
+#   GET /api/v2/storefront/route_places?query=Phnom&place_type=origin
+module Spree
+  module Api
+    module V2
+      module Storefront
+        class RoutePlacesController < ::Spree::Api::V2::ResourceController
+          private
+
+          # override
+          def collection
+            @collection ||= collection_finder.new(keyword: params[:query], place_type: params[:place_type]).execute
+          end
+
+          # override
+          def collection_finder
+            SpreeCmCommissioner::Places::FindWithRoute
+          end
+
+          # override
+          def collection_serializer
+            Spree::V2::Storefront::PlaceSerializer
+          end
+
+          # override
+          def required_schema
+            SpreeCmCommissioner::RoutePlacesRequestSchema
+          end
+
+          # override
+          def serializer_params
+            super.merge(
+              include_vendors: include_vendors?,
+              include_nearby_places: include_nearby_places?
+            )
+          end
+
+          def include_vendors?
+            resource_includes.include?(:vendors) || false
+          end
+
+          def include_nearby_places?
+            resource_includes.include?(:nearby_places) || false
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/spree/api/v2/tenant/intercity_taxi/draft_orders_controller.rb

@@ -0,0 +1,81 @@
+module Spree
+  module Api
+    module V2
+      module Tenant
+        module IntercityTaxi
+          class DraftOrdersController < BaseController
+            include Spree::Api::V2::Storefront::OrderConcern
+            include SpreeCmCommissioner::OrderConcern
+
+            before_action :ensure_order, only: :update
+
+            def create
+              result = SpreeCmCommissioner::IntercityTaxiOrder::Create.call(
+                trip_id: params[:trip_id],
+                from_date: params[:from_date],
+                to_date: params[:to_date],
+                quantity: params[:quantity],
+                user: spree_current_user
+              )
+
+              if result.success?
+                render_serialized_payload { serialize_resource(result.value) }
+              else
+                render_error_payload(result.error)
+              end
+            end
+
+            def update
+              result = SpreeCmCommissioner::IntercityTaxiOrder::Update.call(
+                order: spree_current_order,
+                remark: params[:remark],
+                pickup_map_place_attributes: params.require(:pickup_map_place_attributes).permit(
+                  :place_name,
+                  :lat,
+                  :lng,
+                  :oob_confirmed
+                ),
+                dropoff_map_place_attributes: params.require(:dropoff_map_place_attributes).permit(
+                  :place_name,
+                  :lat,
+                  :lng,
+                  :oob_confirmed
+                ),
+                distance_attributes: params.require(:distance_attributes).permit(
+                  :distance_km,
+                  :ordered_points,
+                  :estimated_time_minutes,
+                  :base_km,
+                  :detour_pickup_km,
+                  :detour_dropoff_km,
+                  :extra_pickup_km,
+                  :extra_dropoff_km
+                )
+              )
+
+              if result.success?
+                render_serialized_payload { serialize_resource(result.value) }
+              else
+                render_error_payload(result.error)
+              end
+            end
+
+            private
+
+            def required_schema
+              if action_name == 'create'
+                SpreeCmCommissioner::IntercityTaxiDraftOrderSchema
+              else
+                SpreeCmCommissioner::IntercityTaxiDraftOrderUpdateSchema
+              end
+            end
+
+            def resource_serializer
+              Spree::V2::Tenant::IntercityTaxiCartSerializer
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/spree/api/v2/tenant/trip_places_controller.rb

@@ -0,0 +1,42 @@
+module Spree
+  module Api
+    module V2
+      module Tenant
+        class TripPlacesController < BaseController
+          private
+
+          # override
+          def collection
+            @collection ||= begin
+              base_scope = scope
+
+              if params[:q].present?
+                @search = base_scope.ransack(params[:q])
+                @search.result
+              else
+                base_scope
+              end
+            end
+          end
+
+          # override
+          def scope
+            model_class.joins(:location_vendor_places)
+                       .where(location_vendor_places: { tenant_id: @tenant.id })
+                       .distinct
+          end
+
+          # override
+          def model_class
+            SpreeCmCommissioner::Place
+          end
+
+          # override
+          def collection_serializer
+            Spree::V2::Tenant::TripPlaceSerializer
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/spree/api/v2/tenant/trip_search_controller.rb

@@ -0,0 +1,103 @@
+module Spree
+  module Api
+    module V2
+      module Tenant
+        class TripSearchController < BaseController
+          CACHE_EXPIRES_IN = 5.minutes
+
+          def index
+            render_serialized_payload do
+              Rails.cache.fetch(collection_cache_key, collection_cache_opts) do
+                trips = SpreeCmCommissioner::TripQuery.new(
+                  origin_id: params[:origin_id],
+                  destination_id: params[:destination_id],
+                  date: params[:date],
+                  route_type: params[:route_type],
+                  number_of_guests: params[:number_of_guests],
+                  tenant_id: @tenant.id,
+                  params: params
+                ).call
+
+                serialize_collection(trips)
+              end
+            end
+          end
+
+          private
+
+          # override from ContentCacheable
+          def max_age
+            CACHE_EXPIRES_IN.to_i
+          end
+
+          # override
+          def collection_cache_key
+            cache_key_parts = [
+              'trip_search',
+              @tenant.id,
+              params[:origin_id],
+              params[:destination_id],
+              params[:date],
+              params[:route_type],
+              params[:number_of_guests],
+              resource_includes&.sort&.join(','),
+              sparse_fields&.sort&.join(','),
+              serializer_params.to_json,
+              params[:page]&.to_s&.strip,
+              params[:per_page]&.to_s&.strip
+            ].compact.join('-')
+
+            Digest::MD5.hexdigest(cache_key_parts)
+          end
+
+          # override
+          def collection_cache_opts
+            {
+              namespace: Spree::Api::Config[:api_v2_collection_cache_namespace],
+              expires_in: CACHE_EXPIRES_IN
+            }
+          end
+
+          # override
+          def default_resource_includes
+            [
+              'trips.vendor',
+              'trips.vendor.logo',
+              'trips.vehicle',
+              'trips.vehicle.vehicle_photos',
+              'trips.amenities'
+            ]
+          end
+
+          def serialize_collection(collection)
+            serialized_data = Spree::V2::Tenant::TripQueryResultSerializer.new(
+              collection,
+              include: default_resource_includes,
+              params: serializer_params
+            ).serializable_hash
+            serialized_data[:meta] = {
+              count: collection.size,
+              total_count: collection.respond_to?(:total_count) ? collection.total_count : collection.size,
+              current_page: collection.respond_to?(:current_page) ? collection.current_page : 1,
+              per_page: collection.respond_to?(:limit_value) ? collection.limit_value : collection.size,
+              pages: collection.respond_to?(:total_pages) ? collection.total_pages : 1,
+              next_page: collection.respond_to?(:next_page) ? collection.next_page : nil,
+              prev_page: collection.respond_to?(:prev_page) ? collection.prev_page : nil
+            }
+            serialized_data
+          end
+
+          # override
+          def serializer_params
+            params.permit(:include).to_hash
+          end
+
+          # override
+          def required_schema
+            SpreeCmCommissioner::TripSearchRequestSchema
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/spree/api/v2/tenant/trips_controller.rb

@@ -0,0 +1,32 @@
+module Spree
+  module Api
+    module V2
+      module Tenant
+        class TripsController < BaseController
+          private
+
+          # override
+          def resource
+            scope.find(params[:id])
+          end
+
+          # override
+          def scope
+            model_class.joins(:vendor)
+                       .where(spree_vendors: { tenant_id: @tenant.id })
+          end
+
+          # override
+          def model_class
+            SpreeCmCommissioner::Trip
+          end
+
+          # override
+          def resource_serializer
+            Spree::V2::Tenant::TripSerializer
+          end
+        end
+      end
+    end
+  end
+end

data/app/factory/spree_cm_commissioner/order_telegram_message_factory.rb

@@ -19,6 +19,7 @@
 # Name: Vaneath Awesome
 # Tel: <code>+85570760548</code>
 # Email: <code>admin_dev@cm.com</code>
+# Delivery Address: #123, St. 456, Phnom Penh
 
 module SpreeCmCommissioner
   class OrderTelegramMessageFactory < TelegramMessageFactory
@@ -79,6 +80,7 @@ module SpreeCmCommissioner
       text << "Name: #{order.name}"
       text << "Tel: #{inline_code(order.intel_phone_number || order.phone_number)}"
       text << "Email: #{inline_code(order.email)}" if order.email.present?
+      text << "Delivery Address: #{formatted_shipping_address.presence || 'N/A'}" if order.delivery_required?
 
       if show_details_link && order.guests.any?
         text << ''
@@ -89,6 +91,16 @@ module SpreeCmCommissioner
       text.compact.join("\n")
     end
 
+    def formatted_shipping_address
+      return 'N/A' if order.shipping_address.blank?
+
+      @formatted_shipping_address ||= [
+        order.shipping_address.address1,
+        order.shipping_address.address2,
+        order.shipping_address.state&.name
+      ].compact.compact_blank.join(', ')
+    end
+
     # Result:
     # | No. A24 | No. A24 |
     # | No. A24 | No. A24 |

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

@@ -0,0 +1,43 @@
+# Finds places that are used in routes (as origin or destination) by keyword search.
+#
+# @param keyword [String] Search term to match against place names (case-insensitive)
+# @param place_type [String] Type of route place: 'origin' or 'destination'
+#
+# @return [ActiveRecord::Relation<SpreeCmCommissioner::Place>] Places matching the keyword
+#   that are used as origins or destinations in existing routes. Returns empty relation if
+#   keyword is blank or place_type is invalid.
+#
+# @note For default/empty state display, use SpreeCmCommissioner::Routes::FindPopular instead
+#   to show popular routes to users before they enter a search term.
+#
+# @example
+#   finder = SpreeCmCommissioner::Places::FindWithRoute.new(keyword: 'Phnom', place_type: 'origin')
+#   finder.execute # => Returns places with "Phnom" in name that are used as route origins
+module SpreeCmCommissioner
+  module Places
+    class FindWithRoute
+      attr_reader :keyword, :place_type
+
+      def initialize(keyword:, place_type:)
+        @keyword = keyword
+        @place_type = place_type
+      end
+
+      def execute
+        return SpreeCmCommissioner::Place.none if keyword.blank? || place_type.blank?
+
+        scope.where('cm_places.name ILIKE ?', "%#{keyword}%")
+      end
+
+      private
+
+      def scope
+        if place_type == 'origin'
+          SpreeCmCommissioner::Place.with_routes_as_origin
+        else
+          SpreeCmCommissioner::Place.with_routes_as_destination
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# Finds routes ordered by popularity based on order metrics.
+#
+# Routes are sorted by:
+# 1. fulfilled_order_count (completed orders) - DESC
+# 2. order_count (total orders including incomplete) - DESC
+#
+# @return [ActiveRecord::Relation<SpreeCmCommissioner::Route>] Routes with origin and destination places loaded,
+#   ordered from most to least popular
+#
+# @example
+#   finder = SpreeCmCommissioner::Routes::FindPopular.new
+#   finder.execute # => Returns routes sorted by fulfillment and order counts
+
+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'))
+      end
+    end
+  end
+end

data/app/mailers/spree/order_mailer_decorator.rb

@@ -12,14 +12,20 @@ module Spree
       return false if @order.email.blank?
 
       setup_tenant_and_store
+      if @tenant.present?
+        @name = @order.tenant.name
+        @logo = @order.tenant.active_vendor&.logo&.original_url
+        @brand_color = @order.tenant.preferred_brand_primary_color
+      end
       @product_type = @order.products.first&.product_type || 'accommodation'
 
       subject = build_subject(resend)
 
       mail(to: @order.email,
-           from: from_email_address, subject: subject,
+           from: from_email_address,
+           subject: subject,
            store_url: store_url
-      ) do |format|
+          ) do |format|
         format.html { render layout: 'spree_cm_commissioner/layouts/order_mailer' }
         format.text
       end
@@ -38,10 +44,6 @@ module Spree
     def setup_tenant_and_store
       @tenant = @order.tenant
       @current_store = @order.store
-      return if @tenant.blank?
-
-      @brand_color = @tenant.preferences[:brand_primary_color]
-      @vendor_logo_url = @tenant.active_vendor&.logo&.original_url
     end
 
     def build_subject(resend)