import_products 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2971bbecf8f07183d6d498c364e5b5adee68beb9
+  data.tar.gz: 6736b0073c7bfcfeead6b746ad905d6f393f12e8
+SHA512:
+  metadata.gz: 3ac5dcbffc1b9ad1d1d1dbfb1f4cedf9e0be9e75e5d65b12a12e855068c9bf5fc70e78594876ddcd9947b9b97543eaea0c7b597e93b47820daed9eefc53f5d7b
+  data.tar.gz: bfc16a001c3232d8fbd2fc710551cc1443dc97f3964cd5cb8c82e4526625c1207542d26017c93968991d8fc70c95a06c58fe640ef0e99b6ec8fbdfc58ada97d8

data/LICENSE

@@ -0,0 +1,23 @@
+Redistribution and use in source and binary forms, with or without modification, 
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice, 
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice, 
+      this list of conditions and the following disclaimer in the documentation 
+      and/or other materials provided with the distribution.
+    * Neither the name of the Rails Dog LLC nor the names of its 
+      contributors may be used to endorse or promote products derived from this 
+      software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,83 @@
+Spree Import Products
+==============
+
+This extension adds product import functionality to Spree, with a bunch of features that give it similar functionality to Shopify's importer.
+
+It's been built to be as simple as possible while still doing it's job, and almost the entire workflow of the script beyond creating products from a CSV file is configurable.
+
+This extension adds a tab to the administration area of Spree, allowing a logged-in user to select and upload a CSV file containing product information. The upload is then placed on queue for processing. Once it has been processed, the user who initiated the job is notified by email that their import has completed.
+
+
+FEATURES
+==============
+
+* A reasonably opinionated product import model should take the heavy lifting out of batch-importing products.
+* Using things like `class_eval`, it can be extended or changed to do more, less, or something differently.
+* Using delayed_job, the import is no longer processed when the user uploads the CSV file (**Note**: this requires the proper installation and configuration of delayed job). 
+* Columns are mapped dynamically by default. This means that if you have a SKU column in your CSV file, it will be automatically set as the `sku` attribute of the Product model.
+* Multiple taxonomies are supported (By default, the importer looks for Brand and Taxonomy). Multiple taxonomy nesting is also supported. (See the 'Taxonomies' area below)
+* Multiple images are supported (By default, the importer looks for Image Main, Image 2, Image 3 and Image 4). Images can be loaded either from disk, or from a publicly-accessible URL.
+* Automatically creating variants is supported out-of-the-box - the importer compares the imported data with already-created products (By default, on the Product's `permalink` attribute), and creates a variant of that product if it exists already. Custom fields are also supported if dynamic column mapping is enabled - simply having 'Color', 'Size', 'Material' columns in your CSV file for example, will automatically set the relevant custom fields on the variant to the values from the CSV.
+* It now uses the Ruby 1.9.2 standard CSV library (a.k.a FasterCSV).
+
+
+DELAYED JOB
+==============
+This gem will require (or will install for you), [delayed_job](https://www.github.com/tobi/delayed_job).
+Once the gem has installed and you have run migrations, you should also run `rails generator delayed_job` to create the tables that delayed_job requires.
+
+Delayed Job also requires that you run 'workers' in the background to pop jobs off the queue and process them.
+This setup may seem like extra work, but believe me, it pays off - with this method, users get an immediate confirmation that their import is on it's way, with a confirmation later on with full details - this is much better than the previous method where the actual processing was completed during the request, with no feedback reaching the user until after the import had finished.
+
+Run `rake jobs:work` to start Delayed Job, and `rake jobs:clear` to clear all queued jobs. Also see delayed_job's Github page for info on Capistrano support.
+
+For more information on Delayed Job, and for help getting a worker running, see the [Github Project Page](https://www.github.com/collectiveidea/delayed_job)
+
+TAXONOMIES
+==========
+
+The columns of the CSV that contain taxonomies is configurable. Each of these columns can contain a number of formats that represent different hierarchies of taxonomies.
+
+Examples
+--------
+* Basic taxonomy association for Category: `Furniture`
+* Multiple taxonomy association for Category: `Furniture & Clearance`
+* Hierarchy taxonomy association for Category: `Furniture > Dining Room > Tables`
+* Multiple hierarchy taxonomy association for Category: `Furniture > Dining Room > Tables & Clearance > Hot this week`
+
+CONFIGURATION
+=============
+
+All the configuration for this extension is inside the initializer generated when you run `rake import_products:install`. It's basically a big hash with manual column mappings (If you don't want to use dynamic column mapping), and a bunch of settings that control the workflow of the extension. Take a look at the initializer to see more details on each field.
+
+In most cases, it's unlikely you will need to change defaults, but it's there is you need it.
+
+
+TESTING
+=======
+
+```ruby
+rake test_app
+cd spec/dummy
+rake db:create
+rake db:migrate db:test:prepare
+rails generate delayed_job:active_record
+rails generate import_products:install
+```
+
+INSTALLATION
+==============
+1. Add the gem to your Gemfile, and run bundle install.
+    `gem 'import_products', :git => 'git://github.com/joshmcarthur/spree-import-products.git'` then `bundle install`
+
+2. rails generate import_products:install
+
+3. Configure the extension to suit your application by changing config variables in `config/initializers/import_product_settings.rb`
+
+4. Run application!
+
+ATTRIBUTION
+==============
+The product import script was based on a simple import script written by Brian Quinn [here](https://gist.github.com/31710). I've extended it quite a bit and tweaked it to fit my needs.
+
+Copyright (c) 2010 Josh McArthur, released under the MIT License

data/app/controllers/spree/admin/product_imports_controller.rb

@@ -0,0 +1,35 @@
+module Spree
+  module Admin
+    class ProductImportsController < BaseController
+
+      def index
+        @product_import = Spree::ProductImport.new
+      end
+
+      def show
+        @product_import = Spree::ProductImport.find(params[:id])
+        @products = @product_import.products
+      end
+
+      def create
+        @product_import = Spree::ProductImport.create(product_import_params)
+        ImportProductsJob.perform_later(@product_import)
+        flash[:notice] = t('product_import_processing')
+        redirect_to admin_product_imports_path
+      end
+
+      def destroy
+        @product_import = Spree::ProductImport.find(params[:id])
+        if @product_import.destroy
+          flash[:notice] = t('delete_product_import_successful')
+        end
+        redirect_to admin_product_imports_path
+      end
+
+      private
+        def product_import_params
+          params.require(:product_import).permit!
+        end
+    end
+  end
+end

data/app/jobs/import_products_job.rb

@@ -0,0 +1,22 @@
+class ImportProductsJob < ActiveJob::Base
+  queue_as :default
+
+  after_perform :notify_admin
+
+  rescue_from(StandardError) do |exception|
+    Spree::UserMailer.product_import_results(Spree::User.admin.first, exception.message).deliver_later
+  end
+
+  def perform(products)
+    products.import_data!(Spree::ProductImport.settings[:transaction])
+  end
+
+  def notify_admin
+    # Spree::UserMailer.product_import_results(Spree::User.admin.first).deliver_later
+    puts "*********************************************************"
+    puts "*********************************************************"
+    puts "==================== Import Complete ===================="
+    puts "*********************************************************"
+    puts "*********************************************************"
+  end
+end

data/app/models/spree/product_import.rb

@@ -0,0 +1,472 @@
+# This model is the master routine for uploading products
+# Requires Paperclip and CSV to upload the CSV file and read it nicely.
+
+# Original Author:: Josh McArthur
+# License:: MIT
+module Spree
+  class ProductError < StandardError; end;
+  class ImportError < StandardError; end;
+  class SkuError < StandardError; end;
+
+  class ProductImport < ActiveRecord::Base
+    #attr_accessible :data_file, :data_file_file_name, :data_file_content_type, :data_file_file_size, :data_file_updated_at, :product_ids, :state, :failed_at, :completed_at
+    has_attached_file :data_file, :path => ":rails_root/lib/etc/product_data/data-files/:basename.:extension"
+    validates_attachment_presence :data_file
+    validates_attachment :data_file, :presence => true, content_type: { content_type: "text/csv" }
+
+    # after_destroy :destroy_products
+
+    serialize :product_ids, Array
+    cattr_accessor :settings
+
+    def products
+      Product.where :id => product_ids
+    end
+
+    require 'csv'
+    require 'pp'
+    require 'open-uri'
+
+    # def destroy_products
+    #   products.destroy_all
+    # end
+
+    state_machine :initial => :created do
+
+      event :start do
+        transition :to => :started, :from => :created
+      end
+      event :complete do
+        transition :to => :completed, :from => :started
+      end
+      event :failure do
+        transition :to => :failed, :from => :started
+      end
+
+      before_transition :to => [:failed] do |import|
+        import.product_ids = []
+        import.failed_at = Time.now
+        import.completed_at = nil
+      end
+
+      before_transition :to => [:completed] do |import|
+        import.failed_at = nil
+        import.completed_at = Time.now
+      end
+    end
+
+    def state_datetime
+      if failed?
+        failed_at
+      elsif completed?
+        completed_at
+      else
+        Time.now
+      end
+    end
+
+    ## Data Importing:
+    # List Price maps to Master Price, Current MAP to Cost Price, Net 30 Cost unused
+    # Width, height, Depth all map directly to object
+    # Image main is created independtly, then each other image also created and associated with the product
+    # Meta keywords and description are created on the product model
+
+    def import_data!(_transaction=true)
+        start
+        if _transaction
+          transaction do
+            _import_data
+          end
+        else
+          _import_data
+        end
+    end
+
+    def _import_data
+      begin
+        @products_before_import = Spree::Product.all
+        @skus_of_products_before_import = @products_before_import.map(&:sku)
+
+        #rows = CSV.read(self.data_file.path, :encoding => 'windows-1251:utf-8')
+        rows = CSV.read(self.data_file.path, "r:ISO-8859-1")
+
+        if ProductImport.settings[:first_row_is_headings]
+          col = get_column_mappings(rows[0])
+        else
+          col = ProductImport.settings[:column_mappings]
+        end
+
+        rows[ProductImport.settings[:rows_to_skip]..-1].each do |row|
+          product_information = {}
+
+          #Automatically map 'mapped' fields to a collection of product information.
+          #NOTE: This code will deal better with the auto-mapping function - i.e. if there
+          #are named columns in the spreadsheet that correspond to product
+          # and variant field names.
+
+          col.each do |key, value|
+            #Trim whitespace off the beginning and end of row fields
+            row[value].try :strip!
+            product_information[key] = row[value]
+          end
+
+          #Manually set available_on if it is not already set
+          product_information[:available_on] = Date.today - 1.day if product_information[:available_on].nil?
+          #product_information[:price] = 0
+
+          sc = Spree::ShippingCategory.first
+          product_information[:shipping_category_id] = sc.id unless sc.nil?
+
+          log("#{pp product_information}")
+
+          variant_comparator_field = ProductImport.settings[:variant_comparator_field].try :to_sym
+          variant_comparator_column = col[variant_comparator_field]
+
+          if ProductImport.settings[:create_variants] and variant_comparator_column and
+            p = Product.where(variant_comparator_field => row[variant_comparator_column]).first
+
+            p.update_attribute(:deleted_at, nil) if p.deleted_at #Un-delete product if it is there
+            p.variants.each { |variant| variant.update_attribute(:deleted_at, nil) }
+            create_variant_for(p, :with => product_information)
+          else
+             next if @skus_of_products_before_import.include?(product_information[:sku])
+             next unless create_product_using(product_information)
+          end
+        end
+
+        if ProductImport.settings[:destroy_original_products]
+          @products_before_import.each { |p| p.destroy }
+        end
+
+      end
+
+      # Finished Importing!
+      complete
+      return [:notice, "Product data was successfully imported."]
+    end
+
+    private
+
+
+    # create_variant_for
+    # This method assumes that some form of checking has already been done to
+    # make sure that we do actually want to create a variant.
+    # It performs a similar task to a product, but it also must pick up on
+    # size/color options
+    def create_variant_for(product, options = {:with => {}})
+      return if options[:with].nil?
+
+      # Just update variant if exists
+      variant = Variant.find_by_sku(options[:with][:sku])
+      raise SkuError, "SKU #{variant.sku} should belongs to #{product.inspect} but was #{variant.product.inspect}" if variant && variant.product != product
+      if !variant
+        variant = product.variants.new
+        variant.id = options[:with][:id]
+      else
+        options[:with].delete(:id)
+      end
+
+      field = ProductImport.settings[:variant_comparator_field]
+      log "VARIANT:: #{variant.inspect}  /// #{options.inspect } /// #{options[:with][field]} /// #{field}"
+
+      #Remap the options - oddly enough, Spree's product model has master_price and cost_price, while
+      #variant has price and cost_price.
+
+      options[:with][:price] = options[:with].delete(:price)
+
+      #First, set the primitive fields on the object (prices, etc.)
+
+      options[:with].each do |field, value|
+        variant.send("#{field}=", value) if variant.respond_to?("#{field}=")
+        applicable_option_type = OptionType.where("lower(presentation) = ? OR lower(name) = ?",field.to_s, field.to_s).first
+        if applicable_option_type.is_a?(OptionType)
+          product.option_types << applicable_option_type unless product.option_types.include?(applicable_option_type)
+          opt_value = applicable_option_type.option_values.where(["presentation = ? OR name = ?", value, value]).first
+          opt_value = applicable_option_type.option_values.create(:presentation => value, :name => value) unless opt_value
+          variant.option_values << opt_value unless variant.option_values.include?(opt_value)
+        end
+      end
+
+      log "VARIANT PRICE #{variant.inspect} /// #{variant.price}"
+
+      if variant.valid?
+        variant.save
+
+        #Associate our new variant with any new taxonomies
+        ProductImport.settings[:taxonomy_fields].each do |field|
+          associate_product_with_taxon(variant.product, field.to_s, options[:with][field.to_sym])
+        end
+
+        #Associate our new variant with any stock item
+        source_location = Spree::StockLocation.find_by(default: true)
+        stock_item = variant.stock_items.where(stock_location_id: source_location.id).first
+
+        if options[:with][:on_hand].nil?
+          stock_item.set_count_on_hand(0)
+        else
+          stock_item.set_count_on_hand(options[:with][:on_hand])
+        end
+
+        #Finally, attach any images that have been specified
+        ProductImport.settings[:image_fields].each do |field|
+          find_and_attach_image_to(variant, options[:with][field.to_sym])
+        end
+
+        #Log a success message
+        log("Variant of SKU #{variant.sku} successfully imported.\n")
+      else
+        log("A variant could not be imported - here is the information we have:\n" +
+            "#{pp options[:with]}, #{variant.errors.full_messages.join(', ')}")
+        return false
+      end
+    end
+
+
+    # create_product_using
+    # This method performs the meaty bit of the import - taking the parameters for the
+    # product we have gathered, and creating the product and related objects.
+    # It also logs throughout the method to try and give some indication of process.
+    def create_product_using(params_hash)
+
+      product         = Product.new
+      properties_hash = Hash.new
+
+      # Array of special fields. Prevent adding them to properties.
+      special_fields  = ProductImport.settings.values_at(
+                          :image_fields,
+                          :taxonomy_fields,
+                          :store_field,
+                          :variant_comparator_field
+                        ).flatten.map(&:to_s)
+
+      #The product is inclined to complain if we just dump all params
+      # into the product (including images and taxonomies).
+      # What this does is only assigns values to products if the product accepts that field.
+      params_hash.each do |field, value|
+        if product.respond_to?("#{field}=")
+          product.send("#{field}=", value)
+        elsif not special_fields.include?(field.to_s) and property = Property.where("lower(name) = ?", field).first
+          properties_hash[property] = value
+        end
+      end
+
+      after_product_built(product, params_hash)
+
+      #We can't continue without a valid product here
+      unless product.valid?
+        log(msg = "A product could not be imported - here is the information we have:\n" +
+            "#{pp params_hash}, #{product.errors.full_messages.join(', ')}")
+        raise ProductError, msg
+      end
+
+      #Just log which product we're processing
+      log(product.name)
+
+      #This should be caught by code in the main import code that checks whether to create
+      #variants or not. Since that check can be turned off, however, we should double check.
+      p = Spree::Variant.find_by_sku(product.sku)
+      if @skus_of_products_before_import.include? product.sku and p.deleted_at.nil?
+        log("#{product.name} is already in the system and active.\n")
+      else
+        if !p.nil? && !p.deleted_at.nil?
+          p.destroy
+          log("#{product.name} was removed from the system and will be replaced.\n")
+        end
+
+        #Save the object before creating asssociated objects
+        product.save and product_ids << product.id
+        log("Saved object before creating associated objects for: #{product.name}")
+
+        #Associate properties with product
+        properties_hash.each do |property, value|
+          product_property = Spree::ProductProperty.where(:product_id => product.id, :property_id => property.id).first_or_initialize
+          product_property.value = value
+          product_property.save!
+        end
+
+        #Associate our new product with any taxonomies that we need to worry about
+        ProductImport.settings[:taxonomy_fields].each do |field|
+          associate_product_with_taxon(product, field.to_s, params_hash[field.to_sym])
+        end
+
+
+        #Finally, attach any images that have been specified
+        ProductImport.settings[:image_fields].each do |field|
+          find_and_attach_image_to(product, params_hash[field.to_sym])
+        end
+
+        if ProductImport.settings[:multi_domain_importing] && product.respond_to?(:stores)
+          begin
+            store = Store.find(
+              :first,
+              :conditions => ["id = ? OR code = ?",
+                params_hash[ProductImport.settings[:store_field]],
+                params_hash[ProductImport.settings[:store_field]]
+              ]
+            )
+
+            product.stores << store
+          rescue
+            log("#{product.name} could not be associated with a store. Ensure that Spree's multi_domain extension is installed and that fields are mapped to the CSV correctly.")
+          end
+        end
+
+        #Stock item
+        source_location = Spree::StockLocation.find_by(default: true)
+        stock_item = product.stock_items.where(stock_location_id: source_location.id).first
+
+        if params_hash[:on_hand].nil?
+          stock_item.set_count_on_hand(0)
+        else
+          stock_item.set_count_on_hand(params_hash[:on_hand])
+        end
+
+        log("#{product.name} successfully imported.\n")
+      end
+      return true
+    end
+
+    # get_column_mappings
+    # This method attempts to automatically map headings in the CSV files
+    # with fields in the product and variant models.
+    # If the headings of columns are going to be called something other than this,
+    # or if the files will not have headings, then the manual initializer
+    # mapping of columns must be used.
+    # Row is an array of headings for columns - SKU, Master Price, etc.)
+    # @return a hash of symbol heading => column index pairs
+    def get_column_mappings(row)
+      mappings = {}
+      row.each_with_index do |heading, index|
+        # Stop collecting headings, if heading is empty
+        if not heading.blank?
+          mappings[heading.downcase.gsub(/\A\s*/, '').chomp.gsub(/\s/, '_').to_sym] = index
+        else
+          break
+        end
+      end
+      mappings
+    end
+
+
+    ### MISC HELPERS ####
+
+    # Log a message to a file - logs in standard Rails format to logfile set up in the import_products initializer
+    # and console.
+    # Message is string, severity symbol - either :info, :warn or :error
+
+    def log(message, severity = :info)
+      @rake_log ||= ActiveSupport::Logger.new(ProductImport.settings[:log_to])
+      message = "[#{Time.now.to_s(:db)}] [#{severity.to_s.capitalize}] #{message}\n"
+      @rake_log.send severity, message
+      puts message
+    end
+
+
+    ### IMAGE HELPERS ###
+
+    # find_and_attach_image_to
+    # This method attaches images to products. The images may come
+    # from a local source (i.e. on disk), or they may be online (HTTP/HTTPS).
+    def find_and_attach_image_to(product_or_variant, filename)
+      return if filename.blank?
+
+      #The image can be fetched from an HTTP or local source - either method returns a Tempfile
+      file = filename =~ /\Ahttp[s]*:\/\// ? fetch_remote_image(filename) : fetch_local_image(filename)
+
+      #An image has an attachment (the image file) and some object which 'views' it
+      product_image = Spree::Image.new({:attachment => file,
+                                :viewable_id => product_or_variant.id,
+                                :viewable_type => "Spree::Variant",
+                                :position => product_or_variant.images.length+1
+                                })
+
+      log("#{product_image.viewable_id} : #{product_image.viewable_type} : #{product_image.position}")
+
+      product_or_variant.images << product_image if product_image.save
+    end
+
+    # This method is used when we have a set location on disk for
+    # images, and the file is accessible to the script.
+    # It is basically just a wrapper around basic File IO methods.
+    def fetch_local_image(filename)
+      filename = ProductImport.settings[:product_image_path] + filename
+      unless File.exists?(filename) && File.readable?(filename)
+        log("Image #{filename} was not found on the server, so this image was not imported.", :warn)
+        return nil
+      else
+        return File.open(filename, 'rb')
+      end
+    end
+
+
+    #This method can be used when the filename matches the format of a URL.
+    # It uses open-uri to fetch the file, returning a Tempfile object if it
+    # is successful.
+    # If it fails, it in the first instance logs the HTTP error (404, 500 etc)
+    # If it fails altogether, it logs it and exits the method.
+    def fetch_remote_image(filename)
+      begin
+        io = open(URI.parse(filename))
+        def io.original_filename; base_uri.path.split('/').last; end
+        return io
+      rescue OpenURI::HTTPError => error
+        log("Image #{filename} retrival returned #{error.message}, so this image was not imported")
+      rescue => error
+        log("Image #{filename} could not be downloaded, so was not imported. #{error.message}")
+      end
+    end
+
+    ### TAXON HELPERS ###
+
+    # associate_product_with_taxon
+    # This method accepts three formats of taxon hierarchy strings which will
+    # associate the given products with taxons:
+    # 1. A string on it's own will will just find or create the taxon and
+    # add the product to it. e.g. taxonomy = "Category", taxon_hierarchy = "Tools" will
+    # add the product to the 'Tools' category.
+    # 2. A item > item > item structured string will read this like a tree - allowing
+    # a particular taxon to be picked out
+    # 3. An item > item & item > item will work as above, but will associate multiple
+    # taxons with that product. This form should also work with format 1.
+    def associate_product_with_taxon(product, taxonomy, taxon_hierarchy)
+      return if product.nil? || taxonomy.nil? || taxon_hierarchy.nil?
+
+      #Using find_or_create_by_name is more elegant, but our magical params code automatically downcases
+      # the taxonomy name, so unless we are using MySQL, this isn't going to work.
+      # taxonomy_name = taxonomy
+      # taxonomy = Taxonomy.find(:first, :conditions => ["lower(name) = ?", taxonomy])
+      # taxonomy = Taxonomy.create(:name => taxonomy_name.capitalize) if taxonomy.nil? && ProductImport.settings[:create_missing_taxonomies]
+
+      taxon_hierarchy.split(/\s*\|\s*/).each do |hierarchy|
+        hierarchy = hierarchy.split(/\s*>\s*/)
+        taxonomy = Spree::Taxonomy.where("lower(name) = ?", hierarchy.first.downcase).first
+        taxonomy = Taxonomy.create(:name => hierarchy.first.capitalize) if taxonomy.nil? && ProductImport.settings[:create_missing_taxonomies]
+        last_taxon = taxonomy.root
+        product.taxons << last_taxon unless product.taxons.include?(last_taxon)
+
+        hierarchy.shift
+        hierarchy.each do |taxon|
+          taxon = taxon.titleize
+          #last_taxon = last_taxon.children.find_or_create_by_name_and_taxonomy_id(taxon, taxonomy.id)
+          last_taxon = last_taxon.children.find_or_create_by(name: taxon, taxonomy_id: taxonomy.id)
+          product.taxons << last_taxon unless product.taxons.include?(last_taxon)
+        end
+
+      end
+    end
+    ### END TAXON HELPERS ###
+
+    # May be implemented via decorator if useful:
+    #
+    #    Spree::ProductImport.class_eval do
+    #
+    #      private
+    #
+    #      def after_product_built(product, params_hash)
+    #        # so something with the product
+    #      end
+    #    end
+    def after_product_built(product, params_hash)
+    end
+  end
+end

data/app/overrides/add_import_to_admin_sidebar_menu.rb

@@ -0,0 +1,6 @@
+Deface::Override.new(
+  virtual_path: 'spree/layouts/admin',
+  name: 'product_import_admin_sidebar_menu',
+  insert_bottom: '#main-sidebar',
+  partial: 'spree/admin/shared/import_sidebar_menu'
+)

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

@@ -0,0 +1,55 @@
+<% 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') %>
+    <%= f.file_field :data_file %>
+    <%= f.error_message_on :data_file %>
+  <% end %>
+  <div data-hook="buttons" class="form-actions">
+    <%= button Spree.t('actions.create'), 'ok', 'submit', {class: 'btn-success'} %>
+  </div>
+  </fieldset>
+<% end %>
+</div>
+</div>
+
+<table class="table">
+  <colgroup>
+    <col style="width: 15%">
+    <col style="width: 40%">
+    <col style="width: 10%">
+    <col style="width: 15%">
+    <col style="width: 10%">
+    <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 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><%= time_ago_in_words import.created_at -%> ago</td>
+      <td><%= link_to import.data_file_file_name, admin_product_import_path(import) -%></td>
+      <td><span class="label label-<%= import.state.downcase %>"><%= t(import.state, :scope => "product_import.state") -%></span></td>
+      <td><%= time_ago_in_words import.state_datetime -%> ago</td>
+      <td><%= import.product_ids.size -%></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,5 @@
+<% if can? :admin, Spree::ProductImport %>
+    <ul class="nav nav-sidebar">
+    <%= tab Spree::ProductImport, url: spree.admin_product_imports_url, icon: 'import', label: plural_resource_name(Spree::ProductImport) %>
+  </ul>
+<% end %>

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

@@ -0,0 +1,21 @@
+Hello,
+
+<% if @error_message %>
+--
+  <%= @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.
+<% 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/import_products/install/install_generator.rb

@@ -0,0 +1,30 @@
+module ImportProducts
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      def self.source_paths
+        paths = self.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
+        run 'bundle exec rake railties:install:migrations FROM=import_products'
+      end
+
+      def add_files
+        template 'config/initializers/import_product_settings.rb', 'config/initializers/import_product_settings.rb'
+      end
+
+      def run_migrations
+         res = ask "Would you like to run the migrations now? [Y/n]"
+         if res == "" || res.downcase == "y"
+           run 'bundle exec rake db:migrate'
+         else
+           puts "Skiping rake db:migrate, don't forget to run it!"
+         end
+      end
+    end
+  end
+end

data/lib/generators/import_products/install/templates/config/initializers/import_product_settings.rb

@@ -0,0 +1,36 @@
+# This file is the thing you have to config to match your application
+
+# This file is the thing you have to config to match your application
+
+Spree::ProductImport.settings = {
+  :column_mappings => { #Change these for manual mapping of product fields to the CSV file
+    :sku => 0,
+    :name => 1,
+    :master_price => 2,
+    :cost_price => 3,
+    :weight => 4,
+    :height => 5,
+    :width => 6,
+    :depth => 7,
+    :image_main => 8,
+    :image_2 => 9,
+    :image_3 => 10,
+    :image_4 => 11,
+    :description => 12,
+    :category => 13
+  },
+  :create_missing_taxonomies => true,
+  :taxonomy_fields => [:category, :brand], #Fields that should automatically be parsed for taxons to associate
+  :image_fields => [:image_main, :image_2, :image_3, :image_4], #Image fields that should be parsed for image locations
+  :product_image_path => "#{Rails.root}/lib/etc/product_data/product-images/", #The location of images on disk
+  :rows_to_skip => 1, #If your CSV file will have headers, this field changes how many rows the reader will skip
+  :log_to => File.join(Rails.root, '/log/', "import_products_#{Rails.env}.log"), #Where to log to
+  :destroy_original_products => false, #Delete the products originally in the database after the import?
+  :first_row_is_headings => true, #Reads column names from first row if set to true.
+  :create_variants => true, #Compares products and creates a variant if that product already exists.
+  :variant_comparator_field => :permalink, #Which product field to detect duplicates on
+  :multi_domain_importing => true, #If Spree's multi_domain extension is installed, associates products with store
+  :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/import_products.rb

@@ -0,0 +1,3 @@
+require 'spree_core'
+require 'spree_auth_devise'
+require 'import_products/engine'

data/lib/import_products/engine.rb

@@ -0,0 +1,22 @@
+module ImportProducts
+  class Engine < Rails::Engine
+		engine_name 'import_products'
+
+    config.autoload_paths += %W(#{config.root}/lib)
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), "../app/**/*_decorator*.rb")) do |c|
+        Rails.env.production? ? require(c) : load(c)
+      end
+
+			Dir.glob(File.join(File.dirname(__FILE__), "../../app/overrides/*.rb")) do |c|
+        Rails.application.config.cache_classes ? require(c) : load(c)
+      end
+
+      Spree::UserMailer.send(:include, ImportProducts::UserMailerExt)
+
+    end
+
+    config.to_prepare &method(:activate).to_proc
+  end
+end

data/lib/import_products/user_mailer_ext.rb

@@ -0,0 +1,14 @@
+module ImportProducts
+  module UserMailerExt
+    def self.included(base)
+      base.class_eval do
+        def product_import_results(user, error_message = nil)
+          @user = user
+          @error_message = error_message
+          attachments["import_products.log"] = File.read(Spree::ProductImport.settings[:log_to]) if @error_message.nil?
+          mail(:to => @user.email, :from => 'fonemstr@gmail.com', :subject => "Spree: Import Products #{error_message.nil? ? "Success" : "Failure"}")
+        end
+      end
+    end
+  end
+end

data/lib/tasks/import_products.rake

@@ -0,0 +1 @@
+# add custom rake tasks here

metadata

@@ -0,0 +1,200 @@
+--- !ruby/object:Gem::Specification
+name: import_products
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Josh McArthur
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: spree_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: spree_auth_devise
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: spree_sample
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ffaker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.12.0
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-debug19
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: josh@3months.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- app/controllers/spree/admin/product_imports_controller.rb
+- app/jobs/import_products_job.rb
+- app/models/spree/product_import.rb
+- app/overrides/add_import_to_admin_sidebar_menu.rb
+- app/views/spree/admin/product_imports/index.html.erb
+- app/views/spree/admin/product_imports/show.html.erb
+- app/views/spree/admin/shared/_import_sidebar_menu.erb
+- app/views/spree/user_mailer/product_import_results.text.erb
+- lib/generators/import_products/install/install_generator.rb
+- lib/generators/import_products/install/templates/config/initializers/import_product_settings.rb
+- lib/import_products.rb
+- lib/import_products/engine.rb
+- lib/import_products/user_mailer_ext.rb
+- lib/tasks/import_products.rake
+homepage: http://www.3months.com
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- none
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: spree_import_products ... imports products. From a CSV file via Spree's Admin
+  interface
+test_files: []