Class: StandaloneDeliveriesController

Inherits:
CrmController show all
Defined in:
app/controllers/standalone_deliveries_controller.rb

Overview

== Schema Information

Table name: standalone_deliveries

id :integer not null, primary key
store_id :integer
origin_address_id :integer
destination_address_id :integer
service_code :string
shipping_rates :hstore is an Array
actual_shipping_cost :decimal(, )
state :string
shipping_account_number :string
billing_postal_code :string

Constant Summary

Constants included from Controllers::ReferenceFindable

Controllers::ReferenceFindable::ID_EMBEDDED_PATTERNS

Constants included from Controllers::AnalyticsEvents

Controllers::AnalyticsEvents::MAX_QUEUED_EVENTS, Controllers::AnalyticsEvents::SESSION_KEY

Constants included from Controllers::ErrorRendering

Controllers::ErrorRendering::NON_CONTENT_PATH_PREFIXES

Instance Method Summary collapse

Methods inherited from CrmController

#access_denied, #context_id, #context_object, #crm_home_path, #current_ability, #default_url_options, #download_temp, #get_tempfile_path_for_download, #init_status_job_collector, #initialize_crm_lazy_chunks, #persist_enqueued_status_jobs, #record_not_found, #redirect_to_job_or_fallback, #render_edit_action, #set_context, #set_download_path, #stash_file_for_temp_download, #sync_admin_presence_cookie, #touch_employee_last_seen

Methods inherited from ApplicationController

#account_impersonated?, #add_to_flash, #after_sign_in_path_for, #bypass_forgery_protection?, #chat_enabled?, #cloudflare_cleared?, #default_catalog, #default_url_options, #enable_turbo_frames, #find_publication, #fix_invalid_accept_header, #init_js_utils, #is_globals_call?, #layout_by_resource, #locale_store, #redirect_to, #require_employee_for_crm, #set_base_host, #set_real_ip, #set_report_errors_for, #should_render_layout?, #skip_layout_for_turbo_frame?, #stamp_impersonation_context, #tab_frame_breakout_request?, #warmlyyours_canada_ip?, #warmlyyours_ip?, #y

Methods included from Controllers::ReturnPathHandling

#check_for_return_path, #redirect_to_return_path_or_default

Methods included from Controllers::AnalyticsEvents

#consume_queued_analytics_events, #registration_lead_type, #track_event

Methods included from Controllers::DeviceDetection

#device_detector, #is_ie?

Methods included from Controllers::SubdomainDetection

#is_crm_request?, #is_www_request?, #json_request?

Methods included from Controllers::TurboSafeRedirect

#redirect_to

Methods included from Controllers::TrackingDetection

#bot_request?, #gdpr_country?, #gdpr_country_data, #prevent_bots, #set_tracking_cookie, #track_visitor?

Methods included from Controllers::AcceleratedFileSending

#send_file_accelerated, #send_upload_accelerated

Methods included from Controllers::ErrorRendering

#excp_string, #mail_to_for_error_reporting, #render_400, #render_404, #render_406, #render_410, #render_500, #render_invalid_authenticity_token, #render_ip_spoof_error, #render_unpermitted_parameters, #safe_referer_or_fallback

Methods included from Controllers::TurnstileVerification

#load_turnstile_script_tag, #turnstile_lazy_widget, #turnstile_script_tag, #turnstile_widget, #validate_turnstile!

Methods included from Controllers::CloudflareCaching

edge_cached, #edge_cached_action?, #reset_cloudflare_cache, #set_cloudflare_cache, #skip_edge_cache!, #skip_session

Methods included from Controllers::Webpackable

#preload_webpack_fonts, #webpack_css_include, #webpack_css_url, #webpack_js_include, #wpd_is_running?

Methods included from Controllers::Localizable

#cloudflare_country_locale, #determine_request_locale, #geocoder_locale, #guest_user_locale_check, #locale_optional_www_auth_path?, #param_locale, #set_locale, #set_request_locale, #skip_localization?, #warmlyyours_ip_locale

Methods included from Controllers::Authenticable

#access_denied, #authenticate_account, #authenticate_account!, #authenticate_account_from_login_token!, #check_is_a_manager, #check_is_a_sales_manager, #check_is_an_admin, #check_is_an_employee, #check_party, #clear_mismatched_guest_user, #create_guest_user, #credentials?, #current_or_guest_user, #current_or_guest_user_id_read_only, #current_user, #devise_mapping, #fully_logged_in?, #generate_bot_id, #guest_user, #identifiable?, #init_current_user, #initialize_guest, #load_context_user, #logging_in, #resource, #resource_name, #restrict_access_for_non_employees, #scrubbed_request_path, #user_object, #warn_on_session_guest_id_leak

Methods included from UrlsHelper

#catalog_breadcrumb_links, #catalog_link, #catalog_link_for_product_line, #catalog_link_for_sku, #cms_link, #delocalized_path, #path_to_sales_product_sku, #path_to_sales_product_sku_for_product_line, #path_to_sales_product_sku_for_product_line_slug, #product_line_from_catalog_link, #protocol_neutral_url, #sanitize_external_url, #valid_external_url?

Instance Method Details

#complete ⇒ void

This method returns an undefined value.

Completes the delivery, if ready.



280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'app/controllers/standalone_deliveries_controller.rb', line 280

def complete
  @standalone_delivery = StandaloneDelivery.find(params[:id])
  authorize! :edit, @standalone_delivery
  if @standalone_delivery.ready_to_complete?
    @standalone_delivery.complete_standalone_delivery!
    flash[:info] = 'Standalone delivery completed'
    redirect_to standalone_deliveries_path(store_id: @standalone_delivery.store&.id)
  else
    flash[:error] = "Standalone delivery can't be completed"
    redirect_to standalone_delivery_path(@standalone_delivery)
  end
end

#create ⇒ void

This method returns an undefined value.

Creates a standalone delivery for the given (or default) store.



59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'app/controllers/standalone_deliveries_controller.rb', line 59

def create
  store_id = params.dig(:store_id).presence || 1
  @store = Store.find(store_id)
  @addresses = [@store.warehouse_address]
  @standalone_delivery = StandaloneDelivery.new(store_id: @store.id)
  authorize! :create, @standalone_delivery
  if @standalone_delivery.save
    redirect_to edit_standalone_delivery_path(@standalone_delivery)
  else
    redirect_to standalone_deliveries_path, error: 'Unable to create standalone delivery'
  end
end

#create_ship_labels ⇒ void

This method returns an undefined value.

Generates ship labels for the delivery (Spee-Dee runs on a background
worker to stay under the request time budget; other carriers run inline).



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'app/controllers/standalone_deliveries_controller.rb', line 218

def create_ship_labels
  @standalone_delivery = StandaloneDelivery.find(params[:id])
  authorize! :edit, @standalone_delivery
  res = @standalone_delivery.update(params[:standalone_delivery])
  if res
    if @standalone_delivery.carrier.blank?
      flash[:error] = 'Cannot generate label: no carrier found for the selected shipping method. Please refresh shipping rates and try again.'
      redirect_to standalone_delivery_path(@standalone_delivery) and return
    end
    if @standalone_delivery.carrier == 'SpeedeeDelivery'
      # Spee-Dee's carrier-side barcode job can exceed the web request budget
      # (30s+ observed in production) — run label generation on the job page
      # (StandaloneLabelWorker) instead of inline, mirroring the delivery
      # flow's SpeedeeLabelWorker.
      job_id = StandaloneLabelWorker.perform_async({ standalone_delivery_id: @standalone_delivery.id }.deep_stringify_keys)
      redirect_to job_path(job_id) and return if job_id

      flash[:error] = 'Unable to schedule Spee-Dee label generation, please contact a member of the IT team for assistance'
      redirect_to standalone_delivery_path(@standalone_delivery) and return
    end
    result = @standalone_delivery.generate_labels
    if result[:status_code] == :ok
      # everything ok, print the label(s)
      # send the file to the browser
      if @standalone_delivery.all_labels_pdf
        session[:download_path] = upload_url(@standalone_delivery.all_labels_pdf.id)
        session[:download_disposition] = :inline
        @standalone_delivery.ship_label_standalone_delivery!
        flash[:info] = "#{@standalone_delivery.name} generated ship label(s)."
        redirect_to standalone_delivery_path(@standalone_delivery)
      else
        flash[:error] = 'Unable to print ship label(s), please contact a member of the IT team for assistance'
        redirect_to standalone_delivery_path(@standalone_delivery)
      end
    else
      flash[:error] = "Unable to print all ship label(s), please void if necessary, result: #{result[:status_message]}"
      redirect_to standalone_delivery_path(@standalone_delivery)
    end
  else
    flash[:error] = "Unable to set standalone delivery ship service: #{@standalone_delivery.errors_to_s}"
    redirect_to standalone_delivery_path(@standalone_delivery)
  end
end

#create_shipments ⇒ void

This method returns an undefined value.

Rebuilds the delivery's shipments/packages from the submitted package
rows, then recalculates ship rates once every shipment is valid.



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'app/controllers/standalone_deliveries_controller.rb', line 137

def create_shipments
  @standalone_delivery = StandaloneDelivery.find(params[:id])
  authorize! :edit, @standalone_delivery
  @shipments = []
  @packages = []
  all_shipments_validity = []
  weight = nil
  length = nil
  width = nil
  height = nil
  if params[:shipments].nil?
    flash[:error] = 'No packages to process'
  else
    @standalone_delivery.shipments.destroy_all
    params[:shipments].each_index do |i|
      number_of_these_shipments = params[:shipments][i][:number].to_i
      number_of_these_shipments = 1 if number_of_these_shipments <= 0
      flat_rate_package_type = nil
      weight = params[:shipments][i][:weight].to_f if params[:shipments][i][:weight].present?
      length = params[:shipments][i][:length].to_f if params[:shipments][i][:length].present?
      width = params[:shipments][i][:width].to_f if params[:shipments][i][:width].present?
      height = params[:shipments][i][:height].to_f if params[:shipments][i][:height].present?
      if params[:packages]&.dig(i, :id)
        wh_package = begin
          WarehousePackage.find(params[:packages][i][:id].to_i)
        rescue StandardError
          nil
        end
        if wh_package
          length = wh_package.length
          width = wh_package.width
          height = wh_package.height
          flat_rate_package_type = wh_package.flat_rate_package_type
        end
      end
      next unless weight || length || width || height

      options = { is_legacy: false, is_manual: false, state: 'awaiting_label', standalone_delivery_id: @standalone_delivery.id, weight: weight, length: length, width: width, height: height, flat_rate_package_type: flat_rate_package_type, order_id: 0 } # order_id must be not null
      number_of_these_shipments.times do
        shipment = Shipment.new(options)
        @packages << begin
          WarehousePackage.find(params[:packages][i][:id]).dup
        rescue StandardError
          WarehousePackage.new
        end
        all_shipments_validity << (shipment.valid? ? :valid : :invalid)
        @shipments << shipment
        @standalone_delivery.shipments << shipment
      end
    end
    if @shipments.any? && all_shipments_validity.all?(:valid) && @standalone_delivery.valid?
      flash[:info] = 'Packages created'
      @standalone_delivery.package_standalone_delivery! if @standalone_delivery.can_package_standalone_delivery?
      @standalone_delivery.calculate_ship_rates
    else
      flash[:error] =
        "Either weight, or dimensions missing: weight: #{weight || 'none'}, length: #{length || 'none'}, width: #{width || 'none'}, height: #{height || 'none'}, #{@shipments.map { |s| s.errors&.full_messages }.join(', ')}"
    end
  end
  redirect_to standalone_delivery_path(@standalone_delivery)
end

#destroy ⇒ void

This method returns an undefined value.

Deletes the delivery, if it's ok to delete.



312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'app/controllers/standalone_deliveries_controller.rb', line 312

def destroy
  @standalone_delivery = StandaloneDelivery.find(params[:id])
  authorize! :destroy, @standalone_delivery
  if @standalone_delivery.ok_to_delete?
    @standalone_delivery.destroy
    flash[:info] = 'Standalone delivery deleted'
    redirect_to standalone_deliveries_path(store_id: @standalone_delivery.store&.id)
  else
    flash[:error] = "Standalone delivery can't be deleted"
    redirect_to standalone_delivery_path(@standalone_delivery)
  end
end

#edit ⇒ void

This method returns an undefined value.

Loads a standalone delivery and its candidate addresses for editing.



50
51
52
53
54
 
# File 'app/controllers/standalone_deliveries_controller.rb', line 50

def edit
  @standalone_delivery = StandaloneDelivery.find(params[:id])
  authorize! :edit, @standalone_delivery
  @addresses = [@standalone_delivery.store.warehouse_address, @standalone_delivery.origin_address, @standalone_delivery.destination_address].uniq.compact
end

#find_ship_rates ⇒ void

This method returns an undefined value.

Requests fresh shipping rates for the delivery.



202
203
204
205
206
207
208
209
210
211
212
 
# File 'app/controllers/standalone_deliveries_controller.rb', line 202

def find_ship_rates
  @standalone_delivery = StandaloneDelivery.find(params[:id])
  authorize! :edit, @standalone_delivery
  res = @standalone_delivery.calculate_ship_rates
  if (res[:status_code] == :ok) && @standalone_delivery.shipping_rates.any?
    flash[:info] = "Postal rates found, #{@standalone_delivery.shipping_rates.pluck('service_name').join(', ')}"
  else
    flash[:error] = "No ship rates returned, error: #{res[:status_message]}"
  end
  redirect_to standalone_delivery_path(@standalone_delivery)
end

#index ⇒ void

This method returns an undefined value.

Lists standalone deliveries, optionally scoped to a store.



21
22
23
24
 
# File 'app/controllers/standalone_deliveries_controller.rb', line 21

def index
  @store = Store.find(params[:store_id]) if params[:store_id]
  @pagy, @standalone_deliveries = pagy(StandaloneDelivery.order(created_at: :desc))
end

#manually_complete ⇒ void

This method returns an undefined value.

Manually completes the delivery, if ready.



296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'app/controllers/standalone_deliveries_controller.rb', line 296

def manually_complete
  @standalone_delivery = StandaloneDelivery.find(params[:id])
  authorize! :edit, @standalone_delivery
  if @standalone_delivery.ready_to_manually_complete?
    @standalone_delivery.manually_complete_standalone_delivery!
    flash[:info] = 'Standalone delivery completed'
    redirect_to standalone_deliveries_path(store_id: @standalone_delivery.store&.id)
  else
    flash[:error] = "Standalone delivery can't be manually completed"
    redirect_to standalone_delivery_path(@standalone_delivery)
  end
end

#new_destination_address ⇒ void

This method returns an undefined value.

Renders the form for entering a new destination address.



99
100
101
102
103
 
# File 'app/controllers/standalone_deliveries_controller.rb', line 99

def new_destination_address
  @standalone_delivery = StandaloneDelivery.find(params[:id])
  authorize! :edit, @standalone_delivery
  @new_address = Address.new
end

#new_origin_address ⇒ void

This method returns an undefined value.

Renders the form for entering a new origin address.



75
76
77
78
79
 
# File 'app/controllers/standalone_deliveries_controller.rb', line 75

def new_origin_address
  @standalone_delivery = StandaloneDelivery.find(params[:id])
  authorize! :edit, @standalone_delivery
  @new_address = Address.new
end

#set_destination_address ⇒ void

This method returns an undefined value.

Saves the submitted destination address and attaches it to the delivery.



108
109
110
111
112
113
114
115
116
117
118
 
# File 'app/controllers/standalone_deliveries_controller.rb', line 108

def set_destination_address
  @standalone_delivery = StandaloneDelivery.find(params[:id])
  authorize! :edit, @standalone_delivery
  @new_address = Address.new(params[:address])
  if @new_address.save
    @standalone_delivery.update(destination_address_id: @new_address.id)
    redirect_to edit_standalone_delivery_path(@standalone_delivery)
  else
    render action: :new_destination_address, status: :unprocessable_content
  end
end

#set_origin_address ⇒ void

This method returns an undefined value.

Saves the submitted origin address and attaches it to the delivery.



84
85
86
87
88
89
90
91
92
93
94
 
# File 'app/controllers/standalone_deliveries_controller.rb', line 84

def set_origin_address
  @standalone_delivery = StandaloneDelivery.find(params[:id])
  authorize! :edit, @standalone_delivery
  @new_address = Address.new(params[:address])
  if @new_address.save
    @standalone_delivery.update(origin_address_id: @new_address.id)
    redirect_to edit_standalone_delivery_path(@standalone_delivery)
  else
    render action: :new_origin_address, status: :unprocessable_content
  end
end

#show ⇒ void

This method returns an undefined value.

Displays a standalone delivery and its suggested shipments/packages.



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'app/controllers/standalone_deliveries_controller.rb', line 29

def show
  @standalone_delivery = StandaloneDelivery.find(params[:id])
  @shipments = []
  @packages = []
  if @standalone_delivery.shipments.suggested.empty?
    @shipments << Shipment.new
    @packages << WarehousePackage.new
  else
    @shipments = @standalone_delivery.shipments.suggested.to_a
    @shipments.length.times do
      @packages << WarehousePackage.new
    end
  end
  respond_to do |format|
    format.html
  end
end

#update ⇒ void

This method returns an undefined value.

Updates a standalone delivery from submitted params.



123
124
125
126
127
128
129
130
131
 
# File 'app/controllers/standalone_deliveries_controller.rb', line 123

def update
  @standalone_delivery = StandaloneDelivery.find(params[:id])
  authorize! :edit, @standalone_delivery
  if @standalone_delivery.update(params[:standalone_delivery])
    redirect_to standalone_delivery_path(@standalone_delivery)
  else
    redirect_to edit_standalone_delivery_path(@standalone_delivery), error: 'Unable to update standalone delivery'
  end
end

#void_ship_labels ⇒ void

This method returns an undefined value.

Voids the delivery's ship labels.



265
266
267
268
269
270
271
272
273
274
275
 
# File 'app/controllers/standalone_deliveries_controller.rb', line 265

def void_ship_labels
  @standalone_delivery = StandaloneDelivery.find(params[:id])
  authorize! :edit, @standalone_delivery
  result = @standalone_delivery.void_shipments
  if result[:status_code] == :error
    flash[:error] = "Could not void ship label(s), error: #{result[:status_message]}"
  else
    flash[:info] = "#{@standalone_delivery.name} voided ship label(s)."
  end
  redirect_to standalone_delivery_path(@standalone_delivery)
end