solidus_import_products 2.0.1

data/app/services/solidus_import_products/import.rb

@@ -0,0 +1,38 @@
+module SolidusImportProducts
+  class Import
+    attr_accessor :product_imports, :logger
+
+    def initialize(args = { product_imports: nil })
+      self.product_imports = args[:product_imports]
+      self.logger = SolidusImportProducts::Logger.instance
+    end
+
+    def self.call(options = {})
+      new(options).call
+    end
+
+    def call
+      skus_of_products_before_import = Spree::Product.all.map(&:sku)
+      parser = product_imports.parse
+      col = parser.column_mappings
+
+      product_imports.start
+      ActiveRecord::Base.transaction do
+        parser.data_rows.each do |row|
+          SolidusImportProducts::ProcessRow.call(
+            parser: parser,
+            product_imports: product_imports,
+            row: row,
+            col: col,
+            skus_of_products_before_import: skus_of_products_before_import
+          )
+        end
+      end
+
+      product_imports.complete
+    rescue SolidusImportProducts::Exception::Base => e
+      product_imports.failure!
+      raise e
+    end
+  end
+end

data/app/services/solidus_import_products/process_row.rb

@@ -0,0 +1,93 @@
+module SolidusImportProducts
+  class ProcessRow
+    attr_accessor :parser, :product_imports, :logger, :row, :col, :product_information, :variant_field, :skus_of_products_before_import
+
+    VARIANT_FIELD_NAME = :name
+
+    def initialize(args = { parser: nil, product_imports: nil, row: nil, col: nil, skus_of_products_before_import: nil })
+      self.parser = args[:parser]
+      self.product_imports = args[:product_imports]
+      self.row = args[:row]
+      self.col = args[:col]
+      self.variant_field = VARIANT_FIELD_NAME
+      self.skus_of_products_before_import = args[:skus_of_products_before_import]
+      self.logger = SolidusImportProducts::Logger.instance
+      self.product_information = { variant_options: {}, images: [], variant_images: [], product_properties: {}, attributes: {} }
+    end
+
+    def self.call(options = {})
+      new(options).call
+    end
+
+    def call
+      extract_product_information
+      product_information_default_values
+      logger.log(product_information.to_s, :debug)
+
+      variant_column = col[variant_field]
+      product = Spree::Product.find_by(variant_field.to_s => row[variant_column])
+
+      unless product
+        if skus_of_products_before_import.include?(product_information[:attributes][:sku])
+          raise SolidusImportProducts::Exception::ProductError, "SKU #{product_information[:attributes][:sku]} exists, but #{variant_field}: #{row[variant_column]} not exists!! "
+        end
+        product = Spree::Product.new
+      end
+
+      unless product_imports.product?(product)
+        create_or_update_product(product)
+        product_imports.add_product(product)
+      end
+
+      SolidusImportProducts::CreateVariant.call(product: product, product_information: product_information)
+    end
+
+    private
+
+    def create_or_update_product(product)
+      properties_hash = SolidusImportProducts::UpdateProduct.call(product: product, product_information: product_information)
+      SolidusImportProducts::SaveProduct.call(product: product, product_information: product_information)
+      SolidusImportProducts::SaveProperties.call(product: product, properties_hash: properties_hash)
+    end
+
+    def extract_product_information
+      col.each do |key, value|
+        row[value].try :strip!
+        if parser.variant_option_field?(key)
+          product_information[:variant_options][key] = row[value]
+        elsif parser.property_field?(key)
+          product_information[:product_properties][key] = row[value]
+        elsif parser.image_field?(key)
+          product_information[:images].push(row[value])
+        elsif parser.variant_image_field?(key)
+          product_information[:variant_images].push(row[value])
+        else
+          product_information[:attributes][key] = key.to_s.eql?('price') ? convert_to_price(row[value]) : row[value]
+        end
+      end
+    end
+
+    def product_information_default_values
+      product_information[:attributes][:available_on] = Time.zone.today - 1.day if product_information[:attributes][:available_on].nil?
+
+      if product_information[:attributes][:shipping_category_id].nil?
+        sc = Spree::ShippingCategory.first
+        product_information[:attributes][:shipping_category_id] = sc.id if sc
+      end
+
+      product_information[:attributes][:retail_only] = 0 if product_information[:attributes][:retail_only].nil?
+    end
+
+    # Special process of prices because of locales and different decimal separator characters.
+    # We want to get a format with dot as decimal separator and without thousand separator
+    def convert_to_price(price_str)
+      raise SolidusImportProducts::Exception::InvalidPrice unless price_str
+      punt = price_str.index('.')
+      coma = price_str.index(',')
+      if !coma.nil? && !punt.nil?
+        price_str.gsub!(punt < coma ? '.' : ',', '')
+      end
+      price_str.tr(',', '.').to_f
+    end
+  end
+end

data/app/services/solidus_import_products/save_product.rb

@@ -0,0 +1,41 @@
+module SolidusImportProducts
+  class SaveProduct
+    attr_accessor :product, :product_information, :logger
+
+    include SolidusImportProducts::ImportHelper
+
+    def self.call(options = {})
+      new.call(options)
+    end
+
+    def call(args = { product: nil, product_information: nil })
+      self.logger = SolidusImportProducts::Logger.instance
+      self.product_information = args[:product_information]
+      self.product = args[:product]
+
+      logger.log("SAVE PRODUCT: #{product.inspect}", :debug)
+
+      unless product.valid?
+        msg = "A product could not be imported - here is the information we have:\n" \
+              "#{product_information}, #{product.inspect} #{product.errors.full_messages.join(', ')}"
+        logger.log(msg, :error)
+        raise SolidusImportProducts::Exception::ProductError, msg
+      end
+
+      product.save
+
+      # Associate our new product with any taxonomies that we need to worry about
+      if product_information[:attributes].key?(:taxonomies) && product_information[:attributes][:taxonomies]
+        associate_product_with_taxon(product, product_information[:attributes][:taxonomies], true)
+      end
+
+      # Finally, attach any images that have been specified
+      product_information[:images].each do |filename|
+        find_and_attach_image_to(product, filename)
+      end
+
+      logger.log("#{product.name} successfully imported.\n")
+      true
+    end
+  end
+end

data/app/services/solidus_import_products/save_properties.rb

@@ -0,0 +1,23 @@
+module SolidusImportProducts
+  class SaveProperties
+    attr_accessor :product, :properties_hash, :logger
+
+    def self.call(options = {})
+      new.call(options)
+    end
+
+    def call(args = { product: nil, properties_hash: nil })
+      self.logger = SolidusImportProducts::Logger.instance
+      self.properties_hash = args[:properties_hash]
+      self.product = args[:product]
+
+      properties_hash.each do |field, value|
+        property = Spree::Property.where('lower(name) = ?', field).first
+        next unless property
+        product_property = Spree::ProductProperty.where(product_id: product.id, property_id: property.id).first_or_initialize
+        product_property.value = value
+        product_property.save!
+      end
+    end
+  end
+end

data/app/services/solidus_import_products/update_product.rb

@@ -0,0 +1,45 @@
+module SolidusImportProducts
+  class UpdateProduct
+    attr_accessor :product, :product_information, :logger
+
+    include SolidusImportProducts::ImportHelper
+
+    def self.call(options = {})
+      new.call(options)
+    end
+
+    def call(args = { product: nil, product_information: nil })
+      self.logger = SolidusImportProducts::Logger.instance
+      self.product_information = args[:product_information]
+      self.product = args[:product]
+
+      logger.log("UPDATE PRODUCT: #{product.inspect} #{product_information.inspect}", :debug)
+
+      product.update_attribute(:deleted_at, nil) if product.deleted_at
+      product.variants.each { |variant| variant.update_attribute(:deleted_at, nil) }
+
+      properties_hash = {}
+
+      product_information.each do |field, value|
+        if field == :product_properties
+          value.each { |prop_field, prop_value| properties_hash[prop_field] = prop_value }
+        elsif field == :attributes
+          value.each { |attr_field, attr_value| product.send("#{attr_field}=", attr_value) if product.respond_to?("#{attr_field}=") }
+        end
+      end
+
+      setup_shipping_category(product) unless product.shipping_category
+
+      properties_hash
+    end
+
+    private
+
+    def setup_shipping_category(product)
+      unless Spree::ShippingCategory.first
+        Spree::ShippingCategory.find_or_create_by(name: 'Default')
+      end
+      product.shipping_category = Spree::ShippingCategory.first
+    end
+  end
+end

data/app/views/spree/admin/product_imports/index.html.erb

@@ -0,0 +1,71 @@
+<% content_for :page_title do %>
+  <%= t('form.product_import.heading') %>
+<% end %>
+
+<div class="row">
+<div class="col-sm-6">
+<%= form_for([:admin, @product_import], :method => :post, :html => { :multipart => true }) do |f| %>
+  <fieldset class="no-border-top">
+  <%= f.field_container :data_file, class: ['form-group'] do  %>
+    <%= f.label :data_file, t('form.product_import.new.data_file') %><br />
+    <%= f.file_field :data_file %>
+    <%= f.error_message_on :data_file %>
+  <% end %>
+  <div class="field">
+    <%= f.label :separatorChar, t('form.product_import.separator_char') %><br />
+    <%= f.text_field :separatorChar, class: 'form-control required',:id =>  "separatorChar",:value => ";" ,:size => 1, :maxlength => 1 %>
+  </div>
+  <div class="field">
+    <%= f.label :encoding_csv, t('form.product_import.encoding') %><br />
+    <%= f.select(:encoding_csv,
+                   options_from_collection_for_select(Spree::ProductImport::ENCODINGS, :to_s, :to_s, 'UTF-8'),
+                   {:class => 'select2', :prompt => false}) %>
+  </div>
+  <div data-hook="buttons" class="form-actions">
+    <%= button Spree.t('actions.import'), 'ok', 'submit', {class: 'btn-success'} %>
+  </div>
+  </fieldset>
+
+<% end %>
+</div>
+</div>
+<table class="table">
+  <colgroup>
+    <col style="width: 15%">
+    <col style="width: 20%">
+    <col style="width: 10%">
+    <col style="width: 15%">
+    <col style="width: 10%">
+    <col style="width: 20%">
+    <col style="width: 5%">
+  </colgroup>
+  <thead>
+  <tr>
+    <th>Date creation</th>
+    <th>CSV Name</th>
+    <th>Status</th>
+    <th>Date Status</th>
+    <th>Imported</th>
+    <th>Error Message</th>
+    <th class="actions">Actions</th>
+  </tr>
+  </thead>
+  <tbody>
+  <% Spree::ProductImport.order("created_at DESC").all.each do |import| %>
+    <tr class="<%= cycle('odd', 'even') %>" id="<%= dom_id import %>">
+      <td><%= I18n.l(import.created_at.to_datetime,format: :short)%></td>
+      <td><%= link_to import.data_file_file_name, import.data_file.url -%></td>
+      <td><span class="label-<%= import.state.downcase %>"><%= t(import.state, :scope => "product_import.state")%></span></td>
+      <td><%= I18n.l(import.state_datetime.to_datetime,format: :short) %></td>
+      <td><%= import.product_ids.size -%></td>
+      <td><%= import.error_message%></td>
+      <td class="actions text-center">
+        <%= link_to_edit import, :url => admin_product_import_path(import), :no_text => true -%>
+      </td>
+      <td class="actions text-center">
+        <%= link_to_delete import, :url => admin_product_import_path(import), :no_text => true -%>
+      </td>
+    </tr>
+  <% end %>
+  </tbody>
+</table>

data/app/views/spree/admin/product_imports/show.html.erb

@@ -0,0 +1,37 @@
+<% content_for :page_title do %>
+  <%= t(:show_product_import) %>
+<% end %>
+
+<% content_for :page_actions do %>
+    <%= button_link_to t(:back_to_product_imports), admin_product_imports_path, :icon => 'icon-arrow-left' %>
+    <%= button_link_to t(:delete_product_import), admin_product_import_path(@product_import), {:icon => 'icon-remove', :method => :delete, :confirm => t("confirm_delete_product_import")} %>
+<% end %>
+
+<table class="table" id="listing_products">
+  <colgroup>
+    <col style="width: 20%">
+    <col style="width: 50%">
+    <col style="width: 20%">
+    <col style="width: 10%">
+  </colgroup>
+  <thead>
+    <tr data-hook="admin_products_index_headers">
+      <th><%= t(:sku) %></th>
+      <th><%= t(:name) %></th>
+      <th><%= t(:master_price) %></th>
+      <th class="actions" data-hook="admin_products_index_header_actions"></th>
+    </tr>
+ </thead>
+ <tbody>
+ <% @products.each do |product| %>
+  <tr class="<%= cycle('odd', 'even') %>" <%= "style='color: red;'" if product.deleted? %> id="<%= dom_id product %>" data-hook="admin_products_index_rows">
+    <td><%= product.sku rescue '' %></td>
+    <td><%= product.name rescue '' %></td>
+    <td><%= number_to_currency product.price rescue '' %></td>
+    <td class="actions" data-hook="admin_products_index_row_actions">
+      <%= link_to_edit_url edit_admin_product_path(product), :no_text => true unless product.deleted? %>
+    </td>
+  </tr>
+  <% end %>
+  </tbody>
+</table>

data/app/views/spree/admin/shared/_import_sidebar_menu.erb

@@ -0,0 +1,3 @@
+<% if can? :admin, Spree::ProductImport %>
+  <%= tab :product_imports, url: spree.admin_product_imports_url %>
+<% end %>

data/app/views/spree/user_mailer/product_import_results.text.erb

@@ -0,0 +1,23 @@
+Hello,
+
+<% if @error_message %>
+  Something went wrong during the product import.
+  Common causes for this include:
+  - Badly formatted CSV
+  - Special characters within the file
+  - Incorrect data
+  - Application or database error
+ 
+  Please check your file and try again.
+  To help diagnose the problem, we have attached the log file for the imports.
+
+	--
+	
+  <%= @error_message %>
+	
+<% else %>
+  This is a quick email to let you know that the product import you submitted has been completed.
+  You can now see the products you added visible in your store.
+<% end %>
+
+

data/lib/generators/solidus_import_products/install/install_generator.rb

@@ -0,0 +1,41 @@
+module SolidusImportProducts
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      class_option :auto_run_migrations, type: :boolean, default: false
+      class_option :auto_skip_migrations, type: :boolean, default: false
+
+      def self.source_paths
+        paths = superclass.source_paths
+        paths << File.expand_path('../templates', "../../#{__FILE__}")
+        paths << File.expand_path('../templates', "../#{__FILE__}")
+        paths << File.expand_path('../templates', __FILE__)
+        paths.flatten
+      end
+
+      def add_migrations
+        if !options[:auto_skip_migrations]
+          run 'bundle exec rake solidus_import_products:install:migrations'
+        else
+          puts 'Skipping rake solidus_import_products:install:migrations, don\'t forget to run it!'
+        end
+
+      end
+
+      def add_files
+        template 'config/initializers/solidus_import_product_settings.rb', 'config/initializers/solidus_import_product_settings.rb'
+      end
+
+      def run_migrations
+        run_migrations =  options[:auto_skip_migrations] ||
+                          options[:auto_run_migrations] ||
+                          ['', 'y', 'Y'].include?(ask('Would you like to run the migrations now? [Y/n]'))
+
+        if run_migrations && !options[:auto_skip_migrations]
+          run 'bundle exec rake db:migrate'
+        else
+          puts 'Skipping rake db:migrate, don\'t forget to run it!'
+        end
+      end
+    end
+  end
+end

data/lib/generators/solidus_import_products/install/templates/config/initializers/solidus_import_product_settings.rb

@@ -0,0 +1,10 @@
+Spree::ProductImport.settings = {
+  num_prods_for_delayed: 20, # From this number of products, the process is executed in delayed_job. Under it is processed immediately.
+  create_missing_taxonomies: true,
+  product_image_path: "#{Rails.root}/lib/etc/product_data/product-images/", # The location of images on disk
+  log_to: File.join(Rails.root, '/log/', "import_products_#{Rails.env}.log"), # Where to log to
+  destroy_original_products: false, # Disabled #Delete the products originally in the database after the import?
+  create_variants: true, # Compares products and creates a variant if that product already exists.
+  store_field: :store_code, # Which field of the column mappings contains either the store id or store code?
+  transaction: true # import product in a sql transaction so we can rollback when an exception is raised
+}

data/lib/solidus_import_products.rb

@@ -0,0 +1,8 @@
+require 'solidus_core'
+require 'solidus_support'
+require 'solidus_auth_devise'
+require 'deface'
+require 'solidus_import_products/exception'
+require 'solidus_import_products/logger'
+require 'solidus_import_products/import_helper'
+require 'solidus_import_products/engine'