Class: MailActivitiesController

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

Overview

== Schema Information

Table name: mail_activities

mailing_id :integer
activity_id :integer
id :integer not null, primary key
address_id :integer
service_code :string
postage_rates :hstore is an Array
actual_shipping_cost :decimal(, )
state :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.

Marks the mail activity complete when allowed, then redirects to its mailing.



159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'app/controllers/mail_activities_controller.rb', line 159

def complete
  @mail_activity = MailActivity.find(params[:id])
  mailing = @mail_activity.mailing
  if @mail_activity.can_complete_mail_activity?
    @mail_activity.complete_mail_activity!
    flash[:info] = 'Mail activity completed'
    redirect_to mailing_path(mailing)
  else
    flash[:error] = "Mail activity can't be completed"
    redirect_to mail_activity_path(@mail_activity)
  end
end

#create_postal_labels ⇒ void

This method returns an undefined value.

Updates the mail activity's postal service, generates the label PDF, and marks the
activity as labeled, queueing the label download. Redirects with a flash message.



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'app/controllers/mail_activities_controller.rb', line 116

def create_postal_labels
  @mail_activity = MailActivity.find(params[:id])
  res = @mail_activity.update(params[:mail_activity])
  if res
    result = @mail_activity.generate_labels if res
    if result[:status_code] == :ok
      # everything ok, print the label(s)
      # send the file to the browser
      if @mail_activity.all_labels_pdf
        session[:download_path] = upload_url(@mail_activity.all_labels_pdf.id)
        session[:download_disposition] = :inline
        @mail_activity.postage_label_mail_activity!
        flash[:info] = "#{@mail_activity.name} generated postal label(s)."
        redirect_to mailing_path(@mail_activity.mailing)
      else
        flash[:error] = 'Unable to print postal label(s), please contact a member of the IT team for assistance'
        redirect_to mail_activity_path(@mail_activity)
      end
    else
      flash[:error] = "Unable to print all postal label(s), please void if necessary, result: #{result[:status_message]}"
      redirect_to mail_activity_path(@mail_activity)
    end
  else
    flash[:error] = "Unable to set mail activity postal service: #{@mail_activity.errors_to_s}"
    redirect_to mail_activity_path(@mail_activity)
  end
end

#create_shipments ⇒ void

This method returns an undefined value.

Rebuilds the mail activity's shipments from the submitted package rows, then packages
the activity and calculates postage rates. Redirects back with a flash message.



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'app/controllers/mail_activities_controller.rb', line 41

def create_shipments
  @mail_activity = MailActivity.find(params[:id])
  @shipments = []
  @packages = []
  weight = nil
  length = nil
  width = nil
  height = nil
  if params[:shipments].nil?
    flash[:error] = 'No packages to process'
  else
    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][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 = { carrier: @mail_activity.carrier, is_legacy: false, is_manual: false, state: 'awaiting_label', mail_activity_id: @mail_activity.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
      @mail_activity.shipments.destroy_all
      number_of_these_shipments.times do
        shipment = Shipment.new(options)
        @packages << begin
          WarehousePackage.find(params[:packages][i][:id]).dup
        rescue StandardError
          WarehousePackage.new
        end
        @shipments << shipment
        @mail_activity.shipments << shipment
      end
    end
    if @shipments.any? && @shipments.all?(&:valid?) && @mail_activity.valid?
      flash[:info] = 'Packages created'
      @mail_activity.package_mail_activity!
      @mail_activity.calculate_postage_rates
    else
      flash[:error] =
        "Either weight, or dimensions missing: weight: #{weight || 'none'}, length: #{length || 'none'}, width: #{width || 'none'}, height: #{height || 'none'}"
    end
  end
  redirect_to mail_activity_path(@mail_activity)
end

#destroy ⇒ void

This method returns an undefined value.

Deletes the mail activity when allowed, then redirects to its mailing.



190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'app/controllers/mail_activities_controller.rb', line 190

def destroy
  @mail_activity = MailActivity.find(params[:id])
  mailing = @mail_activity.mailing
  if @mail_activity.ok_to_delete?
    @mail_activity.destroy
    flash[:info] = 'Mail activity deleted'
    redirect_to mailing_path(mailing)
  else
    flash[:error] = "Mail activity can't be deleted"
    redirect_to mail_activity_path(@mail_activity)
  end
end

#find_postal_rates ⇒ void

This method returns an undefined value.

Recalculates postal rates for the mail activity and redirects back with the result.



102
103
104
105
106
107
108
109
110
111
 
# File 'app/controllers/mail_activities_controller.rb', line 102

def find_postal_rates
  @mail_activity = MailActivity.find(params[:id])
  res = @mail_activity.calculate_postage_rates
  if (res[:status_code] == :ok) && @mail_activity.postage_rates.any?
    flash[:info] = "Postal rates found: #{@mail_activity.postage_rates.map { |r| r['service_name'] || r['service_code'] }.join(', ')}"
  else
    flash[:error] = "No postal rates returned, error: #{res[:status_message]}"
  end
  redirect_to mail_activity_path(@mail_activity)
end

#manually_complete ⇒ void

This method returns an undefined value.

Manually marks the mail activity complete (bypassing the normal completion preconditions)
when allowed, then redirects to its mailing.



175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'app/controllers/mail_activities_controller.rb', line 175

def manually_complete
  @mail_activity = MailActivity.find(params[:id])
  mailing = @mail_activity.mailing
  if @mail_activity.ready_to_manually_complete?
    @mail_activity.manually_complete_mail_activity!
    flash[:info] = 'Mail activity completed'
    redirect_to mailing_path(mailing)
  else
    flash[:error] = "Mail activity can't be manually completed"
    redirect_to mail_activity_path(@mail_activity)
  end
end

#show ⇒ void

This method returns an undefined value.

Shows a mail activity with its suggested shipments (or a blank one) and warehouse packages.



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'app/controllers/mail_activities_controller.rb', line 18

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

#void_postal_labels ⇒ void

This method returns an undefined value.

Voids the mail activity's postal labels and redirects back with the result.



146
147
148
149
150
151
152
153
154
155
 
# File 'app/controllers/mail_activities_controller.rb', line 146

def void_postal_labels
  @mail_activity = MailActivity.find(params[:id])
  result = @mail_activity.void_shipments
  if result[:status_code] == :error
    flash[:error] = "Could not void postal label(s), error: #{result[:status_message]}"
  else
    flash[:info] = "#{@mail_activity.name} voided postal label(s)."
  end
  redirect_to mail_activity_path(@mail_activity)
end