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

Constants included from Www::SeoHelper

Www::SeoHelper::AWARDS, Www::SeoHelper::CA_ADDRESS, Www::SeoHelper::CA_BUSINESS_HOURS, Www::SeoHelper::CA_CONTACT_POINT, Www::SeoHelper::CA_CURRENCIES, Www::SeoHelper::CA_DESCRIPTION, Www::SeoHelper::CA_FOUNDING_DATE, Www::SeoHelper::CA_GLOBAL_LOCATION_NUMBER, Www::SeoHelper::CA_LEGAL_NAME, Www::SeoHelper::CA_LOCAL_BUSINESS, Www::SeoHelper::CA_ONLINE_STORE, Www::SeoHelper::CA_RETURN_POLICY, Www::SeoHelper::CA_SALES_DEPARTMENT, Www::SeoHelper::CA_SERVICE_AREA, Www::SeoHelper::CA_URL, Www::SeoHelper::CA_VAT_ID, Www::SeoHelper::CA_WAREHOUSE_DEPARTMENT, Www::SeoHelper::CA_WAREHOUSE_HOURS, Www::SeoHelper::COMPANY_EMAIL, Www::SeoHelper::COMPANY_LOGO, Www::SeoHelper::COMPANY_NAME, Www::SeoHelper::COMPANY_SLOGAN, Www::SeoHelper::EXPERTISE, Www::SeoHelper::FAX_NUMBER, Www::SeoHelper::GS1_COMPANY_PREFIX, Www::SeoHelper::ISO6523_CODE, Www::SeoHelper::PAYMENT_METHODS, Www::SeoHelper::PHONE_NUMBER, Www::SeoHelper::PRIMARY_NAICS, Www::SeoHelper::REFUND_TYPE, Www::SeoHelper::RETURN_FEES, Www::SeoHelper::RETURN_METHOD, Www::SeoHelper::RETURN_POLICY_CATEGORY, Www::SeoHelper::SECONDARY_NAICS, Www::SeoHelper::SOCIAL_PROFILES, Www::SeoHelper::US_ADDRESS, Www::SeoHelper::US_BUSINESS_HOURS, Www::SeoHelper::US_CONTACT_POINT, Www::SeoHelper::US_CURRENCIES, Www::SeoHelper::US_DESCRIPTION, Www::SeoHelper::US_FOUNDING_DATE, Www::SeoHelper::US_GLOBAL_LOCATION_NUMBER, Www::SeoHelper::US_IMAGE, Www::SeoHelper::US_LEGAL_NAME, Www::SeoHelper::US_LOCAL_BUSINESS, Www::SeoHelper::US_ONLINE_STORE, Www::SeoHelper::US_RETURN_POLICY, Www::SeoHelper::US_SALES_DEPARTMENT, Www::SeoHelper::US_SERVICE_AREA, Www::SeoHelper::US_TAX_ID, Www::SeoHelper::US_URL, Www::SeoHelper::US_WAREHOUSE_DEPARTMENT, Www::SeoHelper::US_WAREHOUSE_HOURS

Constants included from IconHelper

IconHelper::CUSTOM_ICON_MAP, IconHelper::CUSTOM_SVG_DIR, IconHelper::DEFAULT_FAMILY

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

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?, #stamp_impersonation_context, #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, #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 ApplicationHelper

#better_number_to_currency, #check_force_logout, #check_or_cross, #check_or_times, #embedded_tab_frame_id, #error_messages, #general_disclaimer_on_product_installation_and_local_codes, #gridjs_from_html_table, #gridjs_table, #is_wy_ip, #line_break, #parent_layout, #pass_or_fail, #render_error_messages_list, #render_video_card, #resolved_auth_form_turbo_frame, #return_path_or, #safe_css_color, #set_return_path_if_present, #set_section_if_present, #tab_frame_id, #to_underscore, #track_page?, #turbo_section_wrapper, #turbo_tabs_request?, #url_on_same_domain_as_request, #widget_index_daily_focus_index_path, #working_hours?, #yes_or_no, #yes_or_no_highlighted, #yes_or_no_with_check_or_cross, #youtube_video

Methods included from UppyUploaderHelper

#file_uploader, #image_uploader, #large_file_uploader_s3, #lead_sketch_uploader, #rma_image_uploader, #rma_image_uploader_s3, #uppy_uploader, #video_uploader

Methods included from Www::ImagesHelper

#image_asset_tag, #image_asset_url

Methods included from Www::SeoHelper

#add_page_schema, #add_webpage_schema, #canada?, #company_social_links, #ensure_context_json, #json_ld_script_tag, #local_business_schema, #online_store_id, #online_store_schema, #page_main_entity, #page_main_entity_json, #render_auto_collection_page_schema, #render_collection_page_schema, #render_local_business_schema, #render_online_store_schema, #render_page_schemas, #render_page_video_schemas, #render_webpage_schema, #render_webpage_schema_with_collections, #usa?

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?

Methods included from IconHelper

#account_nav_icon, #fa_icon, #star_rating_html

Instance Method Details

#completeObject



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

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_labelsObject



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
# File 'app/controllers/mail_activities_controller.rb', line 107

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_shipmentsObject



37
38
39
40
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
# File 'app/controllers/mail_activities_controller.rb', line 37

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

#destroyObject



172
173
174
175
176
177
178
179
180
181
182
183
# File 'app/controllers/mail_activities_controller.rb', line 172

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_ratesObject



96
97
98
99
100
101
102
103
104
105
# File 'app/controllers/mail_activities_controller.rb', line 96

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_completeObject



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

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

#showObject



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

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_labelsObject



135
136
137
138
139
140
141
142
143
144
# File 'app/controllers/mail_activities_controller.rb', line 135

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