solidus_import_products 2.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7cbe547a1f35bff8d13c359e012af39a7d6280bf
+  data.tar.gz: 5ce9aa54661c7b0069b68648350aeba1c5dabdd7
+SHA512:
+  metadata.gz: 0506cd0571e1348fe37dfb2633b97fd537dd7c9e11f36cc007f446916f1cc2fa26e2f612ed16654993b77e8c3f196a0df1fcf0c634a163a7b8e5c13934ae1fe7
+  data.tar.gz: b68387bf007c5b6a616c9f335a1ad56a2a86e8ed78911e12dd81376d9e484f1ecf655b6db1f146eeb731a337077a40c641163874f4ef6480628510df43c72b4a

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2018 Angel Arancibia
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,71 @@
+[![Gem Version](https://badge.fury.io/rb/solidus_import_products.svg)](https://badge.fury.io/rb/solidus_import_products)
+[![Build Status](https://travis-ci.org/ngelx/solidus_import_products.svg?branch=master)](https://travis-ci.org/ngelx/solidus_import_products) 
+[![Maintainability](https://api.codeclimate.com/v1/badges/132ebaa254502b25d886/maintainability)](https://codeclimate.com/github/ngelx/solidus_import_products/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/132ebaa254502b25d886/test_coverage)](https://codeclimate.com/github/ngelx/solidus_import_products/test_coverage)
+[![Dependency Status](https://beta.gemnasium.com/badges/github.com/ngelx/solidus_import_products.svg)](https://beta.gemnasium.com/projects/github.com/ngelx/solidus_import_products)
+
+This extension adds product import functionality to Solidus, with a bunch of features that give it similar functionality to Shopify's importer.
+
+This extension adds a tab to the administration area of Solidus, allowing a logged-in user to select and upload a file in any of the [supported formats](https://github.com/ngelx/solidus_import_products#Formats-supported) 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
+==============
+
+Products
+-------------
+* Create if they do not exists, otherwise update them.
+* Set Properties.
+* Attach/import multiple local or remote images.
+* Create/Associate to many taxonomies.
+
+Variations
+------------
+* Create if they do not exists, otherwise update them.
+* Create Options types as needed.
+* Create Options values as needed.
+
+Formats supported
+-----------
+* CSV. [examples](spec/fixtures/)
+
+ActiveJob
+----------
+This gem relies on ActiveJob for scheduling imports greater than 20 products/variantions. For more information about activeJob see [ActiveJob Rails Guide](http://guides.rubyonrails.org/active_job_basics.html)
+
+
+Installation
+==============
+1. Add the gem to your Gemfile, and run bundle install.
+    `gem 'solidus_import_products', :git => 'git://github.com/ngelx/solidus_import_products.git'` then `bundle install`
+
+2. rails generate solidus_import_products:install
+
+3. Configure the extension to suit your application by changing config variables in `config/initializers/solidus_import_product_settings.rb`
+
+4. Run application!
+
+Sample files and documentation
+==============
+
+Some basic samples files could be find in [spec/fixtures](spec/fixtures/)
+
+For documentation refer to the [wiki](https://github.com/ngelx/solidus_import_products/wiki)
+
+Contributing
+=======
+
+* Fork the project
+* Make your changes, including tests that exercise the code. The first steps to setup the env is something like:
+
+```ruby
+rake test_app
+rake spec
+```
+
+* Summarize your changes in CHANGELOG.md
+* Make a pull request
+
+History and attribution
+==============
+The product import script was based on a simple import script written by Brian Quinn [here](https://gist.github.com/31710). Then it was extended by Josh McArthur (2010). After that by [2beDigital team](https://github.com/2beDigital/solidus_import_products). 
+Finaly after all that, I've made some big estructural changes and here we are.

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_imports = spree_current_user.product_imports.create(product_import_params)
+        ImportProductsJob.perform_later(@product_imports)
+        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[:success] = 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,14 @@
+class ImportProductsJob < ApplicationJob
+  queue_as :default
+
+  def perform(product_imports)
+    user = product_imports.user
+    begin
+      SolidusImportProducts::Import.call(product_imports: product_imports)
+      Spree::UserMailer.product_import_results(user).deliver_later
+    rescue StandardError => exception
+      Rails.logger.error("[ActiveJob] [ImportProductsJob] [#{job_id}] ID: #{product_imports} #{exception}")
+      Spree::UserMailer.product_import_results(user, "#{exception.message}  #{exception.backtrace.join('\n')}").deliver_later
+    end
+  end
+end

data/app/models/solidus_import_products/parser.rb

@@ -0,0 +1,15 @@
+module SolidusImportProducts
+  module Parser
+    def parse(strategy, data_file, options)
+      if strategy == :csv
+        Parser::Csv.new(data_file, options)
+      else
+        raise SolidusImportProducts::Exception::InvalidParseStrategy
+      end
+    end
+
+    module_function :parse
+
+    # Seguir arreglando esto apra arriba. PAra abajo aprece estar aunque un poco ams de test no vendiran mal
+  end
+end

data/app/models/solidus_import_products/parser/base.rb

@@ -0,0 +1,24 @@
+module SolidusImportProducts
+  module Parser
+    class Base
+      attr_accessor :rows, :data_file, :image_fields, :variant_image_fields, :property_fields
+
+      # column_mappings
+      # This method attempts to automatically map headings in the CSV files
+      # with fields in the product and variant models.
+      # Rows[0] is an array of headings for columns - SKU, Master Price, etc.)
+      # @return a hash of symbol heading => column index pairs
+      def column_mappings
+        raise SolidusImportProducts::AbstractMthodCall
+      end
+
+      def data_rows
+        raise SolidusImportProducts::AbstractMthodCall
+      end
+
+      def products_count
+        raise SolidusImportProducts::AbstractMthodCall
+      end
+    end
+  end
+end

data/app/models/solidus_import_products/parser/csv.rb

@@ -0,0 +1,98 @@
+require 'csv'
+
+module SolidusImportProducts
+  module Parser
+    class Csv < Base
+      DEFAULT_CSV_ENCODING = 'utf-8'.freeze
+      DEFAULT_CSV_SEPARATOR = ','.freeze
+
+      attr_accessor :variant_option_fields, :mappings
+
+      def initialize(data_file, options)
+        self.data_file = data_file
+        self.mappings = {}
+        self.variant_option_fields = []
+        self.image_fields = []
+        self.variant_image_fields = []
+        self.property_fields = []
+        encoding_csv = (options[:encoding_csv] if options) || DEFAULT_CSV_ENCODING
+        separator_char = (options[:separator_char] if options) || DEFAULT_CSV_SEPARATOR
+        csv_string = open(data_file, "r:#{encoding_csv}").read.encode('utf-8')
+        self.rows = CSV.parse(csv_string, col_sep: separator_char)
+        extract_column_mappings
+      end
+
+      # column_mappings
+      # This method attempts to automatically map headings in the CSV files
+      # with fields in the product and variant models.
+      # Rows[0] is an array of headings for columns - SKU, Master Price, etc.)
+      # @return a hash of symbol heading => column index pairs
+      def column_mappings
+        mappings
+      end
+
+      # variant_option_field?
+      # Class method that check if a field is a variant option field
+      # @return true or false
+      def variant_option_field?(field)
+        variant_option_fields.include?(field.to_s)
+      end
+
+      # property_field?
+      # Class method that check if a field is a product property field
+      # @return true or false
+      def property_field?(field)
+        property_fields.include?(field.to_s)
+      end
+
+      # image_field?
+      # Class method that check if a field is an image field
+      # @return true or false
+      def image_field?(field)
+        image_fields.include?(field.to_s)
+      end
+
+      # variant_image_field?
+      # Class method that check if a field is a variant image field
+      # @return true or false
+      def variant_image_field?(field)
+        variant_image_fields.include?(field.to_s)
+      end
+
+      # data_rows
+      # This method fetch the product rows.
+      # @return a array of columns with product information
+      def data_rows
+        rows[1..-1]
+      end
+
+      # products_count
+      # This method count the product rows.
+      # @return a integer
+      def products_count
+        data_rows.count
+      end
+
+      protected
+
+      def extract_column_mappings
+        rows[0].each_with_index do |heading, index|
+          break if heading.blank?
+          field_name = heading.downcase.gsub(/\A\s*/, '').chomp.gsub(/\s/, '_')
+          if field_name.include?('[opt]')
+            field_name.gsub!('[opt]', '')
+            variant_option_fields.push(field_name)
+          elsif field_name.include?('[prop]')
+            field_name.gsub!('[prop]', '')
+            property_fields.push(field_name)
+          elsif field_name.include?('image_product')
+            image_fields.push(field_name)
+          elsif field_name.include?('image_variant')
+            variant_image_fields.push(field_name)
+          end
+          mappings[field_name.to_sym] = index
+        end
+      end
+    end
+  end
+end

data/app/models/spree/product_import.rb

@@ -0,0 +1,82 @@
+# 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 ProductImport < ActiveRecord::Base
+    ENCODINGS = %w[UTF-8 iso-8859-1].freeze
+
+    has_attached_file :data_file,
+                      path: ':rails_root/tmp/product_data/data-files/:basename_:timestamp.:extension',
+                      url: ':rails_root/tmp/product_data/data-files/:basename_:timestamp.:extension'
+
+    belongs_to :user, class_name: 'Spree::User', foreign_key: 'created_by', inverse_of: :product_imports
+
+    validates_attachment_presence :data_file
+    # Content type of csv vary in different browsers.
+    validates_attachment :data_file, presence: true, content_type: { content_type: ['text/csv', 'text/plain', 'text/comma-separated-values', 'application/octet-stream', 'application/vnd.ms-excel', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'] }
+
+    after_destroy :destroy_products
+
+    serialize :product_ids, Array
+    cattr_accessor :settings
+
+    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: %i[created started]
+      end
+
+      before_transition to: [:failed] do |import|
+        import.product_ids = []
+        import.failed_at = Time.current
+        import.completed_at = nil
+      end
+
+      before_transition to: [:completed] do |import|
+        import.failed_at = nil
+        import.completed_at = Time.current
+      end
+    end
+
+    def parse
+      @_parse ||= SolidusImportProducts::Parser.parse(:csv, data_file.url(:default, timestamp: false), { encoding_csv: encoding_csv, separator_char: separatorChar })
+    end
+
+    def products
+      Product.where(id: product_ids)
+    end
+
+    def add_product(product)
+      product_ids << product.id unless product?(product)
+    end
+
+    def product?(product)
+      product.id && product_ids.include?(product.id)
+    end
+
+    def products_count
+      parse.product_count
+    end
+
+    def destroy_products
+      products.destroy_all
+    end
+
+    def state_datetime
+      if failed?
+        failed_at
+      elsif completed?
+        completed_at
+      else
+        updated_at
+      end
+    end
+  end
+end

data/app/overrides/add_import_to_admin_sidebar_menu.rb

@@ -0,0 +1,6 @@
+Deface::Override.new(
+  virtual_path: 'spree/admin/shared/_settings_sub_menu',
+  name: 'product_import_admin_sidebar_menu',
+  insert_bottom: "[data-hook='admin_settings_sub_tabs']",
+  partial: 'spree/admin/shared/import_sidebar_menu'
+)

data/app/services/solidus_import_products/create_variant.rb

@@ -0,0 +1,109 @@
+module SolidusImportProducts
+  # CreateVariant
+  # 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
+  class CreateVariant
+    attr_accessor :product, :variant, :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]
+      return if product_information.nil?
+
+      load_or_initialize_variant
+
+      product_information.each do |field, value|
+        if field == :variant_options
+          value.each { |variant_field, variant_value| options(variant_field, variant_value) }
+        elsif field == :attributes
+          value.each { |attr_field, attr_value| variant.send("#{attr_field}=", attr_value) if variant.respond_to?("#{attr_field}=") }
+        end
+      end
+
+      begin
+        variant.save
+
+        product_information[:variant_images].each do |filename|
+          find_and_attach_image_to(variant, filename)
+        end
+
+        stock_items
+        logger.log("Variant of SKU #{variant.sku} successfully imported.\n", :debug)
+      rescue StandardError => e
+        message = "A variant could not be imported - here is the information we have:\n"
+        message += "#{product_information}, #{variant.errors.full_messages.join(', ')}\n"
+        message += e.message.to_s
+        logger.log(message, :error)
+        raise SolidusImportProducts::Exception::VariantError, message
+      end
+      variant
+    end
+
+    private
+
+    def load_or_initialize_variant
+      self.variant = Spree::Variant.find_by(sku: product_information[:attributes][:sku])
+
+      if variant
+        if variant.product != product
+          raise SolidusImportProducts::Exception::SkuError,
+                "SKU #{product_information[:attributes][:sku]} should belongs to #{product.inspect} but was #{variant.product.inspect}"
+        end
+        product_information[:attributes].delete(:id)
+      else
+        self.variant = product.variants.new(sku: product_information[:attributes][:sku], id: product_information[:attributes][:id])
+      end
+    end
+
+    def options(field, value)
+      return unless value
+
+      option_type = get_or_create_option_type(field)
+      option_value = get_or_create_option_value(option_type, value)
+
+      product.option_types << option_type unless product.option_types.include?(option_type)
+
+      variant.option_values << option_value unless variant.option_values.include?(option_value)
+    end
+
+    def get_or_create_option_type(field)
+      Spree::OptionType.where('name = :field or presentation = :field', field: field.to_s).first ||
+        Spree::OptionType.create(name: field, presentation: field)
+    end
+
+    def get_or_create_option_value(option_type, value)
+      option_type.option_values.where('name = :value or presentation = :value', value: value).first ||
+        option_type.option_values.create(presentation: value, name: value)
+    end
+
+    def attach_image
+      Spree::ProductImport.settings[:image_fields_variants].each do |field|
+
+      end
+    end
+
+    def stock_items
+      source_location = Spree::StockLocation.find_by(default: true)
+      unless source_location
+        logger.log('Seems that there are no SourceLocation set right?, so stock will not set.', :warn) if product_information[:attributes][:stock] || product_information[:attributes][:backorderable]
+        return
+      end
+      logger.log("SourceLocation: #{source_location.inspect}", :debug)
+
+      stock_item = variant.stock_items.where(stock_location_id: source_location.id).first_or_initialize
+
+      stock_item.send('backorderable=', product_information[:attributes][:backorderable]) if product_information[:attributes].key?(:backorderable) && stock_item.respond_to?('backorderable=')
+
+      stock_item.set_count_on_hand(product_information[:attributes][:stock]) if product_information[:attributes][:stock]
+    end
+  end
+end