solidus_importer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3c368dcdb23d45c02c54cd01f247debce0e9083119bda2dc1f358a0718e3b7d8
+  data.tar.gz: 4336a3ad45dc07ba7e6aa5d0e12a953242439a8698c3b8c6a0b36a175e38384d
+SHA512:
+  metadata.gz: 0a3de867687407c132ffe9444a4a1e3b5913dcde1cedabc3b28353bac061f9822bd87ce66fba277904ca20a9c63cfeb8854edadcc37cbff3a9852b80092066c2
+  data.tar.gz: e32d1dc88ccc3db3a234223d0149514aa8173b163f940ada667e43e128a74802d4e2331ec41a7773694ba0cc744051390756c76f22eb2cad7c09504e3fc9c4cd

data/.circleci/config.yml

@@ -0,0 +1,35 @@
+version: 2.1
+
+orbs:
+  # Always take the latest version of the orb, this allows us to
+  # run specs against Solidus supported versions only without the need
+  # to change this configuration every time a Solidus version is released
+  # or goes EOL.
+  solidusio_extensions: solidusio/extensions@volatile
+
+jobs:
+  run-specs-with-postgres:
+    executor: solidusio_extensions/postgres
+    steps:
+      - solidusio_extensions/run-tests
+  run-specs-with-mysql:
+    executor: solidusio_extensions/mysql
+    steps:
+      - solidusio_extensions/run-tests
+
+workflows:
+  "Run specs on supported Solidus versions":
+    jobs:
+      - run-specs-with-postgres
+      - run-specs-with-mysql
+  "Weekly run specs against master":
+    triggers:
+      - schedule:
+          cron: "0 0 * * 4" # every Thursday
+          filters:
+            branches:
+              only:
+                - master
+    jobs:
+      - run-specs-with-postgres
+      - run-specs-with-mysql

data/.gem_release.yml

@@ -0,0 +1,5 @@
+bump:
+  recurse: false
+  file: 'lib/solidus_importer/version.rb'
+  message: Bump SolidusImporter to %{version}
+  tag: true

data/.github/stale.yml

@@ -0,0 +1,17 @@
+# Number of days of inactivity before an issue becomes stale
+daysUntilStale: 60
+# Number of days of inactivity before a stale issue is closed
+daysUntilClose: 7
+# Issues with these labels will never be considered stale
+exemptLabels:
+  - pinned
+  - security
+# Label to use when marking an issue as stale
+staleLabel: wontfix
+# Comment to post when marking an issue as stale. Set to `false` to disable
+markComment: >
+  This issue has been automatically marked as stale because it has not had
+  recent activity. It will be closed if no further activity occurs. Thank you
+  for your contributions.
+# Comment to post when closing a stale issue. Set to `false` to disable
+closeComment: false

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+\#*
+*~
+.#*
+.DS_Store
+.idea
+.project
+.sass-cache
+coverage
+Gemfile.lock
+tmp
+nbproject
+pkg
+*.swp
+spec/dummy
+spec/examples.txt
+/sandbox
+.rvmrc
+.ruby-version
+.ruby-gemset

data/.hound.yml

@@ -0,0 +1,8 @@
+fail_on_violations: true
+
+rubocop:
+  config_file: .rubocop.yml
+  version: 0.75.0
+
+scss:
+  enabled: false

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,2 @@
+require:
+  - solidus_dev_support/rubocop

data/Gemfile

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+branch = ENV.fetch('SOLIDUS_BRANCH', 'master')
+gem 'solidus', github: 'solidusio/solidus', branch: branch
+
+# Needed to help Bundler figure out how to resolve dependencies,
+# otherwise it takes forever to resolve them.
+# See https://github.com/bundler/bundler/issues/6677
+gem 'rails', '>0.a'
+
+# Provides basic authentication functionality for testing parts of your engine
+gem 'solidus_auth_devise'
+
+case ENV['DB']
+when 'mysql'
+  gem 'mysql2'
+when 'postgresql'
+  gem 'pg'
+else
+  gem 'sqlite3'
+end
+
+gemspec
+
+# Use a local Gemfile to include development dependencies that might not be
+# relevant for the project or for other contributors, e.g. pry-byebug.
+#
+# We use `send` instead of calling `eval_gemfile` to work around an issue with
+# how Dependabot parses projects: https://github.com/dependabot/dependabot-core/issues/1658.
+send(:eval_gemfile, 'Gemfile-local') if File.exist? 'Gemfile-local'

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2020 Nebulab SRLs and other contributors
+All rights reserved.
+
+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 Solidus 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,170 @@
+# Solidus Importer
+
+This extension aims to create a component to import data from other popular
+e-commerce solutions to Solidus.
+
+## Installation
+
+Add solidus_importer to your Gemfile:
+
+```ruby
+gem 'solidus_importer'
+```
+
+Bundle your dependencies and run the installation generator:
+
+```shell
+bundle
+bundle exec rails g solidus_importer:install
+```
+
+## Usage
+
+Sample code to import some products:
+
+```ruby
+SolidusImporter.import! 'some_path/sample_products.csv', type: :products
+```
+
+### Accepted Format
+
+The accepted format is the [Shopify CSV](https://help.shopify.com/en/manual/products/import-export/using-csv) for which is also relatively easy to find exporters for every major platform (e.g. [shopify_transporter](https://github.com/Shopify/shopify_transporter)).
+
+There are three supported CSV types:
+
+1. [Product](https://help.shopify.com/en/manual/migrating-to-shopify/transporter-app/csv-products)
+2. [Order](https://help.shopify.com/en/manual/migrating-to-shopify/transporter-app/csv-orders)
+3. [Customer](https://help.shopify.com/en/manual/migrating-to-shopify/transporter-app/csv-customers)
+
+### The Processors
+
+The importing is managed by a list of processors for each CSV type, the default processors are:
+
+```rb
+customers: {
+  importer: SolidusImporter::BaseImporter,
+  processors: [
+    SolidusImporter::Processors::Address,
+    SolidusImporter::Processors::Customer,
+    SolidusImporter::Processors::Log
+  ]
+},
+orders: {
+  importer: SolidusImporter::BaseImporter,
+  processors: [
+    SolidusImporter::Processors::Order,
+    SolidusImporter::Processors::Log
+  ]
+},
+products: {
+  importer: SolidusImporter::BaseImporter,
+  processors: [
+    SolidusImporter::Processors::Product,
+    SolidusImporter::Processors::Variant,
+    SolidusImporter::Processors::OptionTypes,
+    SolidusImporter::Processors::OptionValues,
+    SolidusImporter::Processors::ProductImages,
+    SolidusImporter::Processors::VariantImages,
+    SolidusImporter::Processors::Log
+  ]
+}
+```
+
+Each processor is a callable that will accept a context Hash. It will perform its function within the `#call(context)` method and will return an equally valid context Hash. The returned context can be augmented with additional data.
+
+Example:
+
+```rb
+CUSTOM_LOGGER = Logger.new(Rails.root.join('log/importer.log'))
+CustomLoggerProcessor = ->(context) {
+  context.merge(logger: CUSTOM_LOGGER)
+}
+# Replace the original Log processor with CustomLoggerProcessor
+SolidusImporter::Config.solidus_importer[:customers][:processors].map! do |processor|
+  if processor == 'SolidusImporter::Processors::Log'
+    'CustomLoggerProcessor'
+  else
+    processors
+  end
+end
+```
+
+Each list of processors can be configured to add, remove, or replace any of the default processors.
+
+### Advanced Configuration
+
+To define your own processors (in this example for products), add to the spree
+initializer:
+
+```ruby
+SolidusImporter::Config[:solidus_importer] = {
+  products: {
+    importer: SolidusImporter::Importers::Products,
+    processors: [
+      SolidusImporter::Processors::Product,
+      SolidusImporter::Processors::Variant,
+      SolidusImporter::Processors::Log
+    ]
+  }
+}
+```
+
+The `importer` class is responsible of the whole import process of a single
+source file. The `processors` classes are responsible of the import of a single
+row of the source file; every processor has a `call` method (with an input
+`context`) which makes a specific action and updates the context if needed.
+
+## Development
+
+### Testing the extension
+
+First bundle your dependencies, then run `bin/rake`. `bin/rake` will default to building the dummy
+app if it does not exist, then it will run specs. The dummy app can be regenerated by using
+`bin/rake extension:test_app`.
+
+```shell
+bin/setup
+bin/rake
+```
+
+To run [Rubocop](https://github.com/bbatsov/rubocop) static code analysis run
+
+```shell
+bundle exec rubocop
+```
+
+When testing your application's integration with this extension you may use its factories.
+Simply add this require statement to your spec_helper:
+
+```ruby
+require 'solidus_importer/factories'
+
+```
+
+### Running the sandbox
+
+To run this extension in a sandboxed Solidus application, you can run `bin/sandbox`. The path for
+the sandbox app is `./sandbox` and `bin/rails` will forward any Rails commands to
+`sandbox/bin/rails`.
+
+Here's an example:
+
+```shell
+$ bin/rails server
+=> Booting Puma
+=> Rails 6.0.2.1 application starting in development
+* Listening on tcp://127.0.0.1:3000
+Use Ctrl-C to stop
+```
+
+### Releasing new versions
+
+Your new extension version can be released using `gem-release` like this:
+
+```shell
+bundle exec gem bump -v VERSION --tag --push --remote upstream && gem release
+```
+
+## License
+
+Copyright (c) 2020 Nebulab SRLs, released under the New BSD License

data/Rakefile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'solidus_dev_support/rake_tasks'
+SolidusDevSupport::RakeTasks.install
+
+task default: 'extension:specs'

data/app/assets/javascripts/spree/backend/solidus_importer.js

@@ -0,0 +1,2 @@
+// Placeholder manifest file.
+// the installer will append this file to the app vendored assets here: vendor/assets/javascripts/spree/backend/all.js'

data/app/assets/javascripts/spree/frontend/solidus_importer.js

@@ -0,0 +1,2 @@
+// Placeholder manifest file.
+// the installer will append this file to the app vendored assets here: vendor/assets/javascripts/spree/frontend/all.js'

data/app/assets/stylesheets/spree/backend/solidus_importer.css

@@ -0,0 +1,16 @@
+/*
+Placeholder manifest file.
+the installer will append this file to the app vendored assets here: 'vendor/assets/stylesheets/spree/backend/all.css'
+*/
+
+.solidus_importer.state-failed {
+  color: #d00;
+}
+
+.solidus_importer.state-processing {
+  color: #fb1;
+}
+
+.solidus_importer.state-completed {
+  color: #0a0;
+}

data/app/assets/stylesheets/spree/frontend/solidus_importer.css

@@ -0,0 +1,4 @@
+/*
+Placeholder manifest file.
+the installer will append this file to the app vendored assets here: 'vendor/assets/stylesheets/spree/frontend/all.css'
+*/

data/app/controllers/spree/admin/solidus_importer/import_rows_controller.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Spree
+  module Admin
+    module SolidusImporter
+      class ImportRowsController < BaseController
+        before_action :load_data, only: %i[show]
+
+        def show; end
+
+        private
+
+        def load_data
+          @import_row = ::SolidusImporter::Row.find_by!(id: params[:id], import_id: params[:import_id])
+          return unless (@log_entry = ::Spree::LogEntry.find_by(source: @import_row))
+
+          @log_details = JSON.parse(@log_entry.details)
+          target_class = @log_details['class_name']&.constantize
+          @target_entity = target_class.find_by(id: @log_details['id']) if target_class
+        end
+      end
+    end
+  end
+end

data/app/controllers/spree/admin/solidus_importer/imports_controller.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Spree
+  module Admin
+    module SolidusImporter
+      class ImportsController < ResourceController
+        before_action :assigns_import_types
+        after_action :import!, if: -> { @import.valid? }, only: :create
+
+        def index
+          @search = ::SolidusImporter::Import.ransack(params[:q])
+          @imports = @search.result(distinct: true)
+                            .page(params[:page])
+                            .per(params[:per_page] || Spree::Config[:orders_per_page])
+                            .order(id: :desc)
+        end
+
+        def show
+          @import = ::SolidusImporter::Import.find(params[:id])
+          @search = @import.rows.ransack(params[:q])
+          @import_rows = @search.result(distinct: true).page(params[:page]).per(params[:per_page]).order(id: :desc)
+        end
+
+        private
+
+        def import!
+          ::SolidusImporter::ImportJob.perform_later(@import.id)
+        end
+
+        def model_class
+          ::SolidusImporter::Import
+        end
+
+        def permitted_resource_params
+          params.require(:solidus_importer_import).permit(:file, :import_type)
+        end
+
+        def assigns_import_types
+          @import_types = ::SolidusImporter::Config.available_types
+        end
+      end
+    end
+  end
+end