solidus_import_products 2.0.1

data/lib/solidus_import_products/engine.rb

@@ -0,0 +1,26 @@
+module SolidusImportProducts
+  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, SolidusImportProducts::UserMailerExt)
+
+      # TODO: replace the class_eval
+      Spree::User.class_eval do
+        has_many :product_imports, class_name: 'Spree::ProductImport', foreign_key: 'created_by'
+      end
+    end
+
+    config.to_prepare &method(:activate).to_proc
+  end
+end

data/lib/solidus_import_products/exception.rb

@@ -0,0 +1,19 @@
+module SolidusImportProducts
+  module Exception
+    class Base < StandardError; end
+
+    class ProductError < Base; end
+    class VariantError < Base; end
+    class ImportError < Base; end
+    class SkuError < Base; end
+    class InvalidPrice < Base; end
+
+    class AbstractMthodCall < Base
+      def initialize(msg = 'This methid should be implemented in the subclass')
+        super
+      end
+    end
+
+    class InvalidParseStrategy < Base; end
+  end
+end

data/lib/solidus_import_products/import_helper.rb

@@ -0,0 +1,118 @@
+require 'active_support/concern'
+
+module SolidusImportProducts
+  module ImportHelper
+    extend ActiveSupport::Concern
+
+    require 'open-uri'
+
+    included do
+      ### 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?
+
+        temp_file = fetch_image(filename)
+        return unless temp_file
+        product_image = Spree::Image.new(attachment: temp_file,
+                                         viewable_id: product_or_variant.id,
+                                         viewable_type: 'Spree::Variant',
+                                         alt: '',
+                                         position: product_or_variant.images.length)
+
+        logger.log("#{product_image.viewable_id} : #{product_image.viewable_type} : #{product_image.position}", :debug)
+
+        product_or_variant.images << product_image if product_image.save
+      end
+
+      def fetch_image(filename)
+        filename =~ /\Ahttp[s]*:\/\// ? fetch_remote_image(filename) : fetch_local_image(filename)
+      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 = Spree::ProductImport.settings[:product_image_path] + filename
+        unless File.exist?(filename) && File.readable?(filename)
+          logger.log("Image #{filename} was not found on the server, so this image was not imported.", :warn)
+          return nil
+        end
+        File.open(filename, 'rb')
+      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 logger.logs the HTTP error (404, 500 etc)
+      # If it fails altogether, it logger.logs it and exits the method.
+      def fetch_remote_image(filename)
+        io = open(URI.parse(filename))
+        def io.original_filename
+          base_uri.path.split('/').last
+        end
+        return io
+      rescue OpenURI::HTTPError => error
+        logger.log("Image #{filename} retrival returned #{error.message}, so this image was not imported")
+        return nil
+      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, taxon_hierarchy, putInTop)
+        return if product.nil? || taxon_hierarchy.nil?
+
+        taxon_hierarchy.split(/\s*\|\s*/).each do |hierarchy|
+          hierarchy = hierarchy.split(/\s*>\s*/)
+          taxonomy = Spree::Taxonomy.where('lower(spree_taxonomies.name) = ?', hierarchy.first.downcase).first
+
+          if taxonomy.nil? && Spree::ProductImport.settings[:create_missing_taxonomies]
+            taxonomy = Spree::Taxonomy.create(name: hierarchy.first.capitalize)
+          end
+
+          unless taxonomy.valid?
+            logger.log(msg = "A product could not be imported - here is the information we have:\n" \
+              "Product: #{product.inspect}, Taxonomy: #{taxon_hierarchy}, Errors: #{taxonomy.errors.full_messages.join(', ')} \n", :error)
+            raise ProductError, msg
+          end
+
+          last_taxon = taxonomy.root
+
+          hierarchy.shift
+          hierarchy.each do |taxon|
+            last_taxon = last_taxon.children.find_or_create_by(name: taxon, taxonomy_id: taxonomy.id)
+            next if last_taxon.valid?
+            logger.log(msg = "A product could not be imported - here is the information we have:\n" \
+              "Product: #{product.inspect}, Taxonomy: #{taxonomy.inspect}, Taxon: #{last_taxon.inspect}, #{last_taxon.errors.full_messages.join(', ')}", :error)
+            raise ProductError, msg
+          end
+          # Spree only needs to know the most detailed taxonomy item
+          product.taxons << last_taxon unless product.taxons.include?(last_taxon)
+        end
+
+        # TODO: Not sure what this does.
+        if putInTop && defined?(SolidusSortProductsTaxon)
+          if SolidusSortProductsTaxon::Config.activated
+            unless product.put_in_taxons_top(product.taxons)
+              logger.log(msg = "A product could not be imported - here is the information we have:\n" \
+                "Product: #{product.inspect}, Taxons: #{product.taxons}, #{product.errors.full_messages.join(', ')}", :error)
+              raise SolidusImportProducts::Exception::ProductError, msg
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/solidus_import_products/logger.rb

@@ -0,0 +1,15 @@
+module SolidusImportProducts
+  class Logger
+    include Singleton
+
+    attr_accessor :logger
+
+    def initialize
+      self.logger = ActiveSupport::Logger.new(Spree::ProductImport.settings[:log_to])
+    end
+
+    def log(message, severity = :info)
+      logger.send severity, "[#{Time.now.to_s(:db)}] [#{severity.to_s.capitalize}] #{message}\n"
+    end
+  end
+end

data/lib/solidus_import_products/user_mailer_ext.rb

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

data/lib/tasks/solidus_import_products.rake

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

metadata

@@ -0,0 +1,255 @@
+--- !ruby/object:Gem::Specification
+name: solidus_import_products
+version: !ruby/object:Gem::Version
+  version: 2.0.1
+platform: ruby
+authors:
+- ngelX
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: deface
+  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: solidus_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: solidus_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: solidus_support
+  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: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.17'
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+- !ruby/object:Gem::Dependency
+  name: ffaker
+  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: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.2
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: vcr
+  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: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.1
+description: 
+email: ngelx@protonmail.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/solidus_import_products/parser.rb
+- app/models/solidus_import_products/parser/base.rb
+- app/models/solidus_import_products/parser/csv.rb
+- app/models/spree/product_import.rb
+- app/overrides/add_import_to_admin_sidebar_menu.rb
+- app/services/solidus_import_products/create_variant.rb
+- app/services/solidus_import_products/import.rb
+- app/services/solidus_import_products/process_row.rb
+- app/services/solidus_import_products/save_product.rb
+- app/services/solidus_import_products/save_properties.rb
+- app/services/solidus_import_products/update_product.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/solidus_import_products/install/install_generator.rb
+- lib/generators/solidus_import_products/install/templates/config/initializers/solidus_import_product_settings.rb
+- lib/solidus_import_products.rb
+- lib/solidus_import_products/engine.rb
+- lib/solidus_import_products/exception.rb
+- lib/solidus_import_products/import_helper.rb
+- lib/solidus_import_products/logger.rb
+- lib/solidus_import_products/user_mailer_ext.rb
+- lib/tasks/solidus_import_products.rake
+homepage: https://github.com/ngelx/solidus_import_products
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- none
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: solidus_import_products ... imports products. From a CSV file via Solidus's
+  Admin interface
+test_files: []