shopify_transporter 1.0.0 → 2.0.0

data/lib/shopify_transporter/exporters/magento.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative 'magento/magento_exporter.rb'
+require_relative 'magento/soap.rb'
+require_relative 'magento/sql.rb'

data/lib/shopify_transporter/exporters.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+require_relative 'exporters/exporter'
+require_relative 'exporters/magento'

data/lib/shopify_transporter/generators/generate.rb

@@ -4,7 +4,7 @@ require_relative './base_group.rb'
 module ShopifyTransporter
   class Generate < BaseGroup
     class_option :object, type: :string, required: :true,
-      enum: %w(customer order), aliases: '-O',
+      enum: %w(customer order product), aliases: '-O',
       desc: 'The object to add to the pipeline stage'
 
     def object_type
@@ -13,7 +13,7 @@ module ShopifyTransporter
 
     def validate_config_exists
       unless File.exist?(config_filename)
-        say("Cannot find config.yml at project root", :red)
+        say('Cannot find config.yml at project root', :red)
         exit 1
       end
     end
@@ -34,7 +34,7 @@ module ShopifyTransporter
 
     def generate_stage
       template(
-        "templates/custom_stage.tt",
+        'templates/custom_stage.tt',
         "lib/custom_pipeline_stages/#{pipeline_snake_name}.rb"
       )
     end
@@ -42,7 +42,7 @@ module ShopifyTransporter
     def add_stage_to_config
       config_file = YAML.load_file(config_filename)
       unless class_included_in?(config_file)
-        pipeline_class_hash = { @pipeline_class.to_s => nil, "type" => "custom" }
+        pipeline_class_hash = { @pipeline_class.to_s => nil, 'type' => 'custom' }
         config_file['object_types'][@object_type.downcase]['pipeline_stages'] << pipeline_class_hash
         File.open(config_filename, 'w') { |f| f.write config_file.to_yaml }
         say('Updated config.yml with the new pipeline stage', :green)

data/lib/shopify_transporter/generators/new.rb

@@ -7,7 +7,7 @@ module ShopifyTransporter
     class_option :platform, type: :string, required: :true, enum: %w(magento)
 
     def snake_name
-      @snake_name ||= name_components.map(&:downcase).join("_")
+      @snake_name ||= name_components.map(&:downcase).join('_')
     end
 
     def platform
@@ -16,7 +16,7 @@ module ShopifyTransporter
 
     def generate_config
       template("templates/#{@platform}/config.tt", "#{@snake_name}/config.yml")
-      template("templates/gemfile.tt", "#{@snake_name}/Gemfile")
+      template('templates/gemfile.tt', "#{@snake_name}/Gemfile")
       empty_directory("#{@snake_name}/lib/custom_pipeline_stages")
     end
   end

data/lib/shopify_transporter/pipeline/magento/order/line_items.rb

@@ -42,11 +42,13 @@ module ShopifyTransporter
           end
 
           def tax_lines(item)
-            {
-              title: 'Tax',
-              price: item['tax_amount'],
-              rate: item['tax_percent'],
-            }.stringify_keys
+            [
+              {
+                title: 'Tax',
+                price: item['tax_amount'],
+                rate: item['tax_percent'],
+              }.stringify_keys,
+            ]
           end
         end
       end

data/lib/shopify_transporter/pipeline/magento/product/top_level_attributes.rb

@@ -8,25 +8,94 @@ module ShopifyTransporter
       module Product
         class TopLevelAttributes < Pipeline::Stage
           def convert(hash, record)
+            warn_if_too_many_options(hash)
             accumulator = TopLevelAttributesAccumulator.new(record)
             accumulator.accumulate(hash)
           end
 
+          private
+
+          MAX_OPTION_COUNT = 3
+
+          def too_many_options?(input)
+            input["option#{MAX_OPTION_COUNT + 1}_name"].present?
+          end
+
+          def warn_if_too_many_options(input)
+            if too_many_options?(input)
+              $stderr.puts "Warning: Product #{input['product_id']} has too many options."\
+              " Only the first #{MAX_OPTION_COUNT} options will be converted."
+            end
+          end
+
           class TopLevelAttributesAccumulator < Shopify::AttributesAccumulator
             COLUMN_MAPPING = {
-              'sku' => 'sku',
               'name' => 'title',
               'description' => 'body_html',
+              'url_key' => 'handle',
             }
 
             private
 
-            def input_applies?(_input)
-              true
+            def input_applies?(input)
+              true unless input['parent_id'].present?
             end
 
             def attributes_from(input)
-              map_from_key_to_val(COLUMN_MAPPING, input)
+              attributes = map_from_key_to_val(COLUMN_MAPPING, input)
+              attributes['published'] = published?(input)
+              attributes['published_scope'] = published?(input) ? 'global' : ''
+              attributes['published_at'] = published?(input) ? input['updated_at'] : ''
+              append_images_to_current_record!(input) if input['images'].present?
+              attributes['tags'] = product_tags(input) if input['tags'].present?
+              attributes['options'] = product_options(input) if input['option1_name'].present?
+              attributes
+            end
+
+            def published?(input)
+              input['visibility'].present? && input['visibility'].to_i != 1
+            end
+
+            def apply_image_column_mapping(input_image)
+              {
+                'src' => input_image['url'],
+                'position' => input_image['position'],
+                'alt' => image_alt_text(input_image['label']),
+              }
+            end
+
+            def construct_images(input)
+              return [apply_image_column_mapping(input['images'])] if input['images'].is_a?(Hash)
+              images = input['images'].map do |image|
+                apply_image_column_mapping(image).compact
+              end
+              images.sort_by { |image| image['position'] }
+            end
+
+            def append_images_to_current_record!(input)
+              images = construct_images(input)
+              if @output['images'].present?
+                @output['images'].concat(images)
+              else
+                @output['images'] = images
+              end
+            end
+
+            def product_options(input)
+              %w(option1_name option2_name option3_name).map do |option_name|
+                { 'name' => input[option_name] }
+              end
+            end
+
+            def image_alt_text(label)
+              if label.is_a? String
+                label
+              end
+            end
+
+            def product_tags(input)
+              return input['tags']['name'] if input['tags'].is_a?(Hash)
+              input['tags'].map { |tag| tag['name'] }.join(', ')
             end
           end
         end

data/lib/shopify_transporter/pipeline/magento/product/top_level_variant_attributes.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+require 'shopify_transporter/pipeline/stage'
+require 'shopify_transporter/shopify'
+
+module ShopifyTransporter
+  module Pipeline
+    module Magento
+      module Product
+        class TopLevelVariantAttributes < Pipeline::Stage
+          def convert(hash, record)
+            return unless input_applies?(hash)
+            simple_product_in_magento_format = record['variants'].select do |product|
+              product['product_id'] == hash['product_id']
+            end.first
+            accumulator = TopLevelVariantAttributesAccumulator.new(simple_product_in_magento_format)
+            accumulator.accumulate(hash)
+          end
+
+          def input_applies?(input)
+            true unless input['parent_id'].nil?
+          end
+
+          class TopLevelVariantAttributesAccumulator < Shopify::AttributesAccumulator
+            COLUMN_MAPPING = {
+              'sku' => 'sku',
+              'weight' => 'weight',
+              'price' => 'price',
+              'inventory_quantity' => 'inventory_qty',
+            }
+
+            def accumulate(input)
+              accumulate_attributes(map_from_key_to_val(COLUMN_MAPPING, input))
+              accumulate_attributes(variant_options(input))
+            end
+
+            private
+
+            def variant_options(input)
+              {
+                'option1' => input['option1_value'],
+                'option2' => input['option2_value'],
+                'option3' => input['option3_value'],
+              }.compact
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shopify_transporter/pipeline/magento/product/variant_attributes.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+require 'shopify_transporter/pipeline/stage'
+require 'shopify_transporter/shopify'
+
+module ShopifyTransporter
+  module Pipeline
+    module Magento
+      module Product
+        class VariantAttributes < Pipeline::Stage
+          def convert(hash, record)
+            accumulator = VariantAttributesAccumulator.new(record)
+            accumulator.accumulate(hash)
+          end
+
+          class VariantAttributesAccumulator < Shopify::AttributesAccumulator
+            def accumulate(current_product)
+              if current_product['parent_id'].present?
+                @output['variants'] ||= []
+                @output['variants'] << current_product
+                @output
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shopify_transporter/pipeline/magento/product/variant_image.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+require 'shopify_transporter/pipeline/stage'
+require 'shopify_transporter/shopify'
+
+module ShopifyTransporter
+  module Pipeline
+    module Magento
+      module Product
+        class VariantImage < Pipeline::Stage
+          def convert(hash, record)
+            return unless input_applied?(hash)
+            add_variant_image!(hash, record)
+            add_variant_image_to_parent_images!(hash, record)
+            record
+          end
+
+          def input_applied?(input)
+            input['images'].present? && input['parent_id'].present?
+          end
+
+          def current_variant(input, record)
+            record['variants'].select do |variant|
+              variant['product_id'] == input['product_id']
+            end.first
+          end
+
+          def add_variant_image!(input, record)
+            current_variant(input, record).merge!(
+              'variant_image' => {
+                'src' => variant_image_url(input),
+              }
+            )
+          end
+
+          def variant_image_url(input)
+            return input['images']['url'] if input['images'].is_a?(Hash)
+            input['images'].sort_by { |image| image['position'] }.first['url']
+          end
+
+          def add_variant_image_to_parent_images!(input, record)
+            record['images'] ||= []
+            record['images'] << {
+              'src' => variant_image_url(input),
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shopify_transporter/record_builder/product_record_builder.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+#
+module ShopifyTransporter
+  class ProductRecordBuilder < RecordBuilder
+    def initialize(key_name, key_required)
+      super(key_name, key_required)
+    end
+
+    def build(input)
+      validate_related(input)
+
+      if has_parent?(input)
+        yield parent_record(input)
+        return
+      end
+
+      yield record_from(input)
+    end
+
+    private
+
+    def has_parent?(product)
+      product['parent_id'].present?
+    end
+
+    def parent_record(product)
+      parent_id = product['parent_id']
+      record = @instances[parent_id] ||= {}
+      record['variants'] ||= []
+      @last_record = record
+    end
+  end
+end

data/lib/shopify_transporter/shopify/attributes_helpers.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require "active_support/core_ext/string"
+require 'active_support/core_ext/string'
 module ShopifyTransporter
   module Shopify
     module AttributesHelpers

data/lib/shopify_transporter/shopify/order.rb

@@ -61,7 +61,7 @@ module ShopifyTransporter
         company name phone first_name last_name address1 address2 city province province_code zip country country_code
       )
 
-      LINE_ITEM_PREFIX = "lineitem_"
+      LINE_ITEM_PREFIX = 'lineitem_'
 
       LINE_ITEM_ATTRIBUTES = %w(
         name quantity price discount compare_at_price sku requires_shipping taxable fulfillment_status

data/lib/shopify_transporter/shopify/product.rb

@@ -18,7 +18,7 @@ module ShopifyTransporter
       VARIANT_ATTRIBUTES = %w(
         sku grams inventory_tracker inventory_qty inventory_policy
         fulfillment_service price compare_at_price requires_shipping
-        taxable barcode weight_unit tax_code
+        taxable barcode weight weight_unit tax_code
       ).freeze
 
       class << self
@@ -33,7 +33,8 @@ module ShopifyTransporter
             'Metafield Value Type', 'Variant Grams', 'Variant Inventory Tracker', 'Variant Inventory Qty',
             'Variant Inventory Policy', 'Variant Fulfillment Service', 'Variant Price', 'Variant Compare At Price',
             'Variant Requires Shipping', 'Variant Taxable', 'Variant Barcode', 'Image Attachment', 'Image Src',
-            'Image Position', 'Image Alt Text', 'Variant Image', 'Variant Weight Unit', 'Variant Tax Code'
+            'Image Position', 'Image Alt Text', 'Variant Image', 'Variant Weight', 'Variant Weight Unit',
+            'Variant Tax Code'
           ].to_csv
         end
 
@@ -95,9 +96,9 @@ module ShopifyTransporter
 
       def image_row_values
         return [] if record_hash['images'].blank?
+
         record_hash['images'].map do |image_hash|
           image = {
-            'image_attachment' => image_hash['attachment'],
             'image_src' => image_hash['src'],
             'image_position' => image_hash['position'],
             'image_alt_text' => image_hash['alt'],

data/lib/shopify_transporter/shopify/record.rb

@@ -2,7 +2,7 @@
 module ShopifyTransporter
   module Shopify
     class Record
-      METAFIELD_PREFIX = "metafield_"
+      METAFIELD_PREFIX = 'metafield_'
 
       METAFIELD_ATTRIBUTES = %w(namespace key value value_type).freeze
 

data/lib/shopify_transporter/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module ShopifyTransporter
-  VERSION = "1.0.0"
+  VERSION = '2.0.0'
 end

data/lib/shopify_transporter.rb

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
 require 'thor'
+
 require_relative 'shopify_transporter/generators.rb'
+require_relative 'shopify_transporter/exporters.rb'
 require_relative 'shopify_transporter/pipeline.rb'
 require_relative 'shopify_transporter/shopify.rb'
-require_relative 'shopify_transporter/record_builder.rb'
+require_relative 'shopify_transporter/record_builder/record_builder.rb'
+require_relative 'shopify_transporter/record_builder/product_record_builder'
 Dir["#{Dir.pwd}/lib/custom_pipeline_stages/**/*.rb"].each { |f| require f }
 
 module ShopifyTransporter
@@ -149,11 +152,11 @@ class TransporterTool
   def stage_class_from(name, type)
     class_name = stage_classname(name, type)
     klass = begin
-      k = Object.const_get(class_name)
-      k.is_a?(Class) && k
-    rescue NameError
-      nil
-    end
+              k = Object.const_get(class_name)
+              k.is_a?(Class) && k
+            rescue NameError
+              nil
+            end
     raise StageNotFoundError, name unless class_exists?(klass)
     klass
   end
@@ -232,7 +235,12 @@ class TransporterTool
 
   def build_classes_based_on_config
     @record_class = Object.const_get("ShopifyTransporter::Shopify::#{@object_type.capitalize}")
-    @record_builder = ShopifyTransporter::RecordBuilder.new(
+    record_builder_class = if @object_type.capitalize == 'Product'
+      ShopifyTransporter::ProductRecordBuilder
+    else
+      ShopifyTransporter::RecordBuilder
+    end
+    @record_builder = record_builder_class.new(
       record_key_from_config, key_required_from_config
     )
   end