Examples with ShippingQuotePrePostProcessModule com.salesmanager.core.modules.integration.shipping.model.ShippingQuotePrePostProcessModule used on opensource projects

Example 1 with ShippingQuotePrePostProcessModule

use of com.salesmanager.core.modules.integration.shipping.model.ShippingQuotePrePostProcessModule in project shopizer by shopizer-ecommerce.

the class ShippingServiceImpl method getShippingQuote.

@Override
public ShippingQuote getShippingQuote(Long shoppingCartId, MerchantStore store, Delivery delivery, List<ShippingProduct> products, Language language) throws ServiceException {
    // ShippingConfiguration -> Global configuration of a given store
    // IntegrationConfiguration -> Configuration of a given module
    // IntegrationModule -> The concrete module as defined in integrationmodules.properties
    // delivery without postal code is accepted
    Validate.notNull(store, "MerchantStore must not be null");
    Validate.notNull(delivery, "Delivery must not be null");
    Validate.notEmpty(products, "products must not be empty");
    Validate.notNull(language, "Language must not be null");
    ShippingQuote shippingQuote = new ShippingQuote();
    ShippingQuoteModule shippingQuoteModule = null;
    try {
        if (StringUtils.isBlank(delivery.getPostalCode())) {
            shippingQuote.getWarnings().add("No postal code in delivery address");
            shippingQuote.setShippingReturnCode(ShippingQuote.NO_POSTAL_CODE);
        }
        // get configuration
        ShippingConfiguration shippingConfiguration = getShippingConfiguration(store);
        ShippingType shippingType = ShippingType.INTERNATIONAL;
        /**
         * get shipping origin *
         */
        ShippingOrigin shippingOrigin = shippingOriginService.getByStore(store);
        if (shippingOrigin == null || !shippingOrigin.isActive()) {
            shippingOrigin = new ShippingOrigin();
            shippingOrigin.setAddress(store.getStoreaddress());
            shippingOrigin.setCity(store.getStorecity());
            shippingOrigin.setCountry(store.getCountry());
            shippingOrigin.setPostalCode(store.getStorepostalcode());
            shippingOrigin.setState(store.getStorestateprovince());
            shippingOrigin.setZone(store.getZone());
        }
        if (shippingConfiguration == null) {
            shippingConfiguration = new ShippingConfiguration();
        }
        if (shippingConfiguration.getShippingType() != null) {
            shippingType = shippingConfiguration.getShippingType();
        }
        // look if customer country code excluded
        Country shipCountry = delivery.getCountry();
        // a ship to country is required
        Validate.notNull(shipCountry, "Ship to Country cannot be null");
        Validate.notNull(store.getCountry(), "Store Country canot be null");
        if (shippingType.name().equals(ShippingType.NATIONAL.name())) {
            // customer country must match store country
            if (!shipCountry.getIsoCode().equals(store.getCountry().getIsoCode())) {
                shippingQuote.setShippingReturnCode(ShippingQuote.NO_SHIPPING_TO_SELECTED_COUNTRY + " " + shipCountry.getIsoCode());
                return shippingQuote;
            }
        } else if (shippingType.name().equals(ShippingType.INTERNATIONAL.name())) {
            // customer shipping country code must be in accepted list
            List<String> supportedCountries = this.getSupportedCountries(store);
            if (!supportedCountries.contains(shipCountry.getIsoCode())) {
                shippingQuote.setShippingReturnCode(ShippingQuote.NO_SHIPPING_TO_SELECTED_COUNTRY + " " + shipCountry.getIsoCode());
                return shippingQuote;
            }
        }
        // must have a shipping module configured
        Map<String, IntegrationConfiguration> modules = this.getShippingModulesConfigured(store);
        if (modules == null) {
            shippingQuote.setShippingReturnCode(ShippingQuote.NO_SHIPPING_MODULE_CONFIGURED);
            return shippingQuote;
        }
        /**
         * uses this module name *
         */
        String moduleName = null;
        IntegrationConfiguration configuration = null;
        for (String module : modules.keySet()) {
            moduleName = module;
            configuration = modules.get(module);
            // use the first active module
            if (configuration.isActive()) {
                shippingQuoteModule = shippingModules.get(module);
                if (shippingQuoteModule instanceof ShippingQuotePrePostProcessModule) {
                    shippingQuoteModule = null;
                    continue;
                } else {
                    break;
                }
            }
        }
        if (shippingQuoteModule == null) {
            shippingQuote.setShippingReturnCode(ShippingQuote.NO_SHIPPING_MODULE_CONFIGURED);
            return shippingQuote;
        }
        /**
         * merchant module configs *
         */
        List<IntegrationModule> shippingMethods = this.getShippingMethods(store);
        IntegrationModule shippingModule = null;
        for (IntegrationModule mod : shippingMethods) {
            if (mod.getCode().equals(moduleName)) {
                shippingModule = mod;
                break;
            }
        }
        /**
         * general module configs *
         */
        if (shippingModule == null) {
            shippingQuote.setShippingReturnCode(ShippingQuote.NO_SHIPPING_MODULE_CONFIGURED);
            return shippingQuote;
        }
        // calculate order total
        BigDecimal orderTotal = calculateOrderTotal(products, store);
        List<PackageDetails> packages = getPackagesDetails(products, store);
        // free shipping ?
        boolean freeShipping = false;
        if (shippingConfiguration.isFreeShippingEnabled()) {
            BigDecimal freeShippingAmount = shippingConfiguration.getOrderTotalFreeShipping();
            if (freeShippingAmount != null) {
                if (orderTotal.doubleValue() > freeShippingAmount.doubleValue()) {
                    if (shippingConfiguration.getFreeShippingType() == ShippingType.NATIONAL) {
                        if (store.getCountry().getIsoCode().equals(shipCountry.getIsoCode())) {
                            freeShipping = true;
                            shippingQuote.setFreeShipping(true);
                            shippingQuote.setFreeShippingAmount(freeShippingAmount);
                            return shippingQuote;
                        }
                    } else {
                        // international all
                        freeShipping = true;
                        shippingQuote.setFreeShipping(true);
                        shippingQuote.setFreeShippingAmount(freeShippingAmount);
                        return shippingQuote;
                    }
                }
            }
        }
        // handling fees
        BigDecimal handlingFees = shippingConfiguration.getHandlingFees();
        if (handlingFees != null) {
            shippingQuote.setHandlingFees(handlingFees);
        }
        // tax basis
        shippingQuote.setApplyTaxOnShipping(shippingConfiguration.isTaxOnShipping());
        Locale locale = languageService.toLocale(language, store);
        // also available distance calculation
        if (!CollectionUtils.isEmpty(shippingModulePreProcessors)) {
            for (ShippingQuotePrePostProcessModule preProcessor : shippingModulePreProcessors) {
                // System.out.println("Using pre-processor " + preProcessor.getModuleCode());
                preProcessor.prePostProcessShippingQuotes(shippingQuote, packages, orderTotal, delivery, shippingOrigin, store, configuration, shippingModule, shippingConfiguration, shippingMethods, locale);
                // TODO switch module if required
                if (shippingQuote.getCurrentShippingModule() != null && !shippingQuote.getCurrentShippingModule().getCode().equals(shippingModule.getCode())) {
                    // determines the shipping module
                    shippingModule = shippingQuote.getCurrentShippingModule();
                    configuration = modules.get(shippingModule.getCode());
                    if (configuration != null) {
                        if (configuration.isActive()) {
                            moduleName = shippingModule.getCode();
                            shippingQuoteModule = this.shippingModules.get(shippingModule.getCode());
                            configuration = modules.get(shippingModule.getCode());
                        }
                    // TODO use default
                    }
                }
            }
        }
        // invoke module
        List<ShippingOption> shippingOptions = null;
        try {
            shippingOptions = shippingQuoteModule.getShippingQuotes(shippingQuote, packages, orderTotal, delivery, shippingOrigin, store, configuration, shippingModule, shippingConfiguration, locale);
        } catch (Exception e) {
            LOGGER.error("Error while calculating shipping : " + e.getMessage(), e);
        /*				merchantLogService.save(
						new MerchantLog(store,
								"Can't process " + shippingModule.getModule()
								+ " -> "
								+ e.getMessage()));
				shippingQuote.setQuoteError(e.getMessage());
				shippingQuote.setShippingReturnCode(ShippingQuote.ERROR);
				return shippingQuote;*/
        }
        if (shippingOptions == null && !StringUtils.isBlank(delivery.getPostalCode())) {
            // absolutely need to use in this case store pickup or other default shipping quote
            shippingQuote.setShippingReturnCode(ShippingQuote.NO_SHIPPING_TO_SELECTED_COUNTRY);
        }
        shippingQuote.setShippingModuleCode(moduleName);
        // filter shipping options
        ShippingOptionPriceType shippingOptionPriceType = shippingConfiguration.getShippingOptionPriceType();
        ShippingOption selectedOption = null;
        if (shippingOptions != null) {
            for (ShippingOption option : shippingOptions) {
                if (selectedOption == null) {
                    selectedOption = option;
                }
                // set price text
                String priceText = pricingService.getDisplayAmount(option.getOptionPrice(), store);
                option.setOptionPriceText(priceText);
                option.setShippingModuleCode(moduleName);
                if (StringUtils.isBlank(option.getOptionName())) {
                    String countryName = delivery.getCountry().getName();
                    if (countryName == null) {
                        Map<String, Country> deliveryCountries = countryService.getCountriesMap(language);
                        Country dCountry = deliveryCountries.get(delivery.getCountry().getIsoCode());
                        if (dCountry != null) {
                            countryName = dCountry.getName();
                        } else {
                            countryName = delivery.getCountry().getIsoCode();
                        }
                    }
                    option.setOptionName(countryName);
                }
                if (shippingOptionPriceType.name().equals(ShippingOptionPriceType.HIGHEST.name())) {
                    if (option.getOptionPrice().longValue() > selectedOption.getOptionPrice().longValue()) {
                        selectedOption = option;
                    }
                }
                if (shippingOptionPriceType.name().equals(ShippingOptionPriceType.LEAST.name())) {
                    if (option.getOptionPrice().longValue() < selectedOption.getOptionPrice().longValue()) {
                        selectedOption = option;
                    }
                }
                if (shippingOptionPriceType.name().equals(ShippingOptionPriceType.ALL.name())) {
                    if (option.getOptionPrice().longValue() < selectedOption.getOptionPrice().longValue()) {
                        selectedOption = option;
                    }
                }
            }
            shippingQuote.setSelectedShippingOption(selectedOption);
            if (selectedOption != null && !shippingOptionPriceType.name().equals(ShippingOptionPriceType.ALL.name())) {
                shippingOptions = new ArrayList<ShippingOption>();
                shippingOptions.add(selectedOption);
            }
        }
        /**
         * set final delivery address *
         */
        shippingQuote.setDeliveryAddress(delivery);
        shippingQuote.setShippingOptions(shippingOptions);
        // invoke pre processors
        if (!CollectionUtils.isEmpty(shippingModulePostProcessors)) {
            for (ShippingQuotePrePostProcessModule postProcessor : shippingModulePostProcessors) {
                // get module info
                // get module configuration
                IntegrationConfiguration integrationConfiguration = modules.get(postProcessor.getModuleCode());
                IntegrationModule postProcessModule = null;
                for (IntegrationModule mod : shippingMethods) {
                    if (mod.getCode().equals(postProcessor.getModuleCode())) {
                        postProcessModule = mod;
                        break;
                    }
                }
                IntegrationModule module = postProcessModule;
                if (integrationConfiguration != null) {
                    postProcessor.prePostProcessShippingQuotes(shippingQuote, packages, orderTotal, delivery, shippingOrigin, store, integrationConfiguration, module, shippingConfiguration, shippingMethods, locale);
                }
            }
        }
        String ipAddress = null;
        UserContext context = UserContext.getCurrentInstance();
        if (context != null) {
            ipAddress = context.getIpAddress();
        }
        if (shippingQuote != null && CollectionUtils.isNotEmpty(shippingQuote.getShippingOptions())) {
            // save SHIPPING OPTIONS
            List<ShippingOption> finalShippingOptions = shippingQuote.getShippingOptions();
            for (ShippingOption option : finalShippingOptions) {
                // transform to Quote
                Quote q = new Quote();
                q.setCartId(shoppingCartId);
                q.setDelivery(delivery);
                if (!StringUtils.isBlank(ipAddress)) {
                    q.setIpAddress(ipAddress);
                }
                if (!StringUtils.isBlank(option.getEstimatedNumberOfDays())) {
                    try {
                        q.setEstimatedNumberOfDays(Integer.valueOf(option.getEstimatedNumberOfDays()));
                    } catch (Exception e) {
                        LOGGER.error("Cannot cast to integer " + option.getEstimatedNumberOfDays());
                    }
                }
                if (freeShipping) {
                    q.setFreeShipping(true);
                    q.setPrice(new BigDecimal(0));
                    q.setModule("FREE");
                    q.setOptionCode("FREE");
                    q.setOptionName("FREE");
                } else {
                    q.setModule(option.getShippingModuleCode());
                    q.setOptionCode(option.getOptionCode());
                    if (!StringUtils.isBlank(option.getOptionDeliveryDate())) {
                        try {
                            q.setOptionDeliveryDate(DateUtil.formatDate(option.getOptionDeliveryDate()));
                        } catch (Exception e) {
                            LOGGER.error("Cannot transform to date " + option.getOptionDeliveryDate());
                        }
                    }
                    q.setOptionName(option.getOptionName());
                    q.setOptionShippingDate(new Date());
                    q.setPrice(option.getOptionPrice());
                }
                if (handlingFees != null) {
                    q.setHandling(handlingFees);
                }
                q.setQuoteDate(new Date());
                shippingQuoteService.save(q);
                option.setShippingQuoteOptionId(q.getId());
            }
        }
    } catch (Exception e) {
        LOGGER.error(e.getMessage(), e);
        throw new ServiceException(e);
    }
    return shippingQuote;
}

Example 2 with ShippingQuotePrePostProcessModule

use of com.salesmanager.core.modules.integration.shipping.model.ShippingQuotePrePostProcessModule in project shopizer by shopizer-ecommerce.

the class ShippingServiceImpl method getShippingMetaData.

@Override
public ShippingMetaData getShippingMetaData(MerchantStore store) throws ServiceException {
    try {
        ShippingMetaData metaData = new ShippingMetaData();
        // configured country
        List<Country> countries = getShipToCountryList(store, store.getDefaultLanguage());
        metaData.setShipToCountry(countries);
        // configured modules
        Map<String, IntegrationConfiguration> modules = Optional.ofNullable(getShippingModulesConfigured(store)).orElse(Collections.emptyMap());
        metaData.setModules(new ArrayList<>(modules.keySet()));
        // pre processors
        List<ShippingQuotePrePostProcessModule> preProcessors = this.shippingModulePreProcessors;
        List<String> preProcessorKeys = new ArrayList<String>();
        if (preProcessors != null) {
            for (ShippingQuotePrePostProcessModule processor : preProcessors) {
                preProcessorKeys.add(processor.getModuleCode());
                if (SHIPPING_DISTANCE.equals(processor.getModuleCode())) {
                    metaData.setUseDistanceModule(true);
                }
            }
        }
        metaData.setPreProcessors(preProcessorKeys);
        // post processors
        List<ShippingQuotePrePostProcessModule> postProcessors = this.shippingModulePostProcessors;
        List<String> postProcessorKeys = new ArrayList<String>();
        if (postProcessors != null) {
            for (ShippingQuotePrePostProcessModule processor : postProcessors) {
                postProcessorKeys.add(processor.getModuleCode());
            }
        }
        metaData.setPostProcessors(postProcessorKeys);
        return metaData;
    } catch (Exception e) {
        throw new ServiceException("Exception while getting shipping metadata ", e);
    }
}