shopify_transporter 2.2.0 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6eda8c759a40e474719373d41d3554e10d43f5bf
-  data.tar.gz: baca1185566a388a56a725e80e641066b91a8b05
+  metadata.gz: 29372540546b779b2d3a248f7dd2c2079d9a22a2
+  data.tar.gz: b1729a6eea756fceb2871d3a7393170269bc2806
 SHA512:
-  metadata.gz: 6589791c84651519d8b184ff6bb1dd077d08711fab9abd522884c8a74a677d57b034d7b23d9f809bc782142e3845825eefcd3f20e6d362669e166dcd6374ac00
-  data.tar.gz: db735a4ed6eba567b4e4a3ec65f8d2182a34bbe8371ec901ccd56252b3b84485bc6ddf5606d249e6577545cdcc1d5bbc8533e2cade66f59167cd1d8b603b24ef
+  metadata.gz: 2ed229bfda72b6f2a0bd1173b7c4dfdbd8cb33527b14da1e38e0482c51325f328778bf454942caf3972c8613626e794ffa2979de45070a851ceb64955f9765f2
+  data.tar.gz: 9cc15dd97c160becb4200f49259399f7a879a07b8ca396d4984dc370b1014c4cc10caed7976453fce0e321e16c5190901ca0e9f525c38abdd564c4b57517f097

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

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+require 'shopify_transporter/pipeline/stage'
+require 'shopify_transporter/shopify'
+
+module ShopifyTransporter
+  module Pipeline
+    module Magento
+      module Order
+        class Discounts < Pipeline::Stage
+          def convert(input, record)
+            record.merge!(
+              {
+                discounts: discounts(input),
+              }.stringify_keys
+            )
+          end
+
+          private
+
+          def discounts(hash)
+            [
+              shipping_discount(hash),
+              fixed_amount_discount(hash),
+              percentage_discount(hash),
+            ].compact
+          end
+
+          def shipping_discount(hash)
+            shipping_discount_amount = value_as_float(hash, 'shipping_discount_amount')
+            shipping_amount = value_as_float(hash, 'shipping_amount')
+            return unless shipping_discount_amount > shipping_amount
+
+            {
+              code: discount_code(hash),
+              amount: shipping_discount_amount,
+              type: 'shipping',
+            }.stringify_keys
+          end
+
+          def fixed_amount_discount(hash)
+            return unless fixed_amount_discount?(hash)
+
+            {
+              code: discount_code(hash),
+              amount: discount_amount(hash),
+              type: 'fixed_amount',
+            }.stringify_keys
+          end
+
+          def percentage_discount(hash)
+            return unless percentage_discount?(hash)
+
+            {
+              code: discount_code(hash),
+              amount: discount_percentage(hash),
+              type: 'percentage',
+            }.stringify_keys
+          end
+
+          def discount_percentage(hash)
+            if qualifies_for_percentage_discount?(hash)
+              if line_items(hash).is_a?(Hash)
+                value_as_float(line_items(hash), 'discount_percent')
+              elsif line_items(hash).is_a?(Array)
+                all_discount_percentages(hash).first
+              end
+            end
+          end
+
+          def discount_code(hash)
+            hash['discount_description'].present? ? hash['discount_description'] : 'Magento'
+          end
+
+          def discount_amount(hash)
+            hash['discount_amount'].present? ? hash['discount_amount'].to_f.abs : 0
+          end
+
+          def value_as_float(hash, key)
+            hash[key].present? ? hash[key].to_f : 0
+          end
+
+          def qualifies_for_percentage_discount?(hash)
+            return false unless line_items?(hash)
+
+            return true if line_items(hash).is_a?(Hash) && value_as_float(line_items(hash), 'discount_percent') > 0
+
+            all_discount_percentages(hash).length == 1 && all_discount_percentages(hash).first > 0
+          end
+
+          def line_items?(hash)
+            hash.dig('items', 'result', 'items', 'item').present?
+          end
+
+          def line_items(hash)
+            hash['items']['result']['items']['item']
+          end
+
+          def all_discount_percentages(hash)
+            line_items(hash).map do |line_item|
+              value_as_float(line_item, 'discount_percent')
+            end.uniq
+          end
+
+          def fixed_amount_discount?(hash)
+            discount_amount(hash) > 0 && !qualifies_for_percentage_discount?(hash)
+          end
+
+          def percentage_discount?(hash)
+            discount_amount(hash) > 0 && qualifies_for_percentage_discount?(hash)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -36,7 +36,10 @@ module ShopifyTransporter
               quantity: item['qty_ordered'],
               sku: item['sku'],
               name: item['name'],
+              requires_shipping: requires_shipping?(item),
               price: item['price'],
+              taxable: taxable?(item),
+              fulfillment_status: fulfillment_status(item),
               tax_lines: tax_lines(item),
             }.stringify_keys
           end
@@ -47,11 +50,47 @@ module ShopifyTransporter
               {
                 title: 'Tax',
                 price: item['tax_amount'],
-                rate: item['tax_percent'],
+                rate: tax_percentage(item),
               }.stringify_keys,
             ]
           end
 
+          def tax_percentage(item)
+            item['tax_percent'].to_f / 100
+          end
+
+          def fulfillment_status(item)
+            qty_ordered = qty_by_status(item, 'ordered')
+            qty_shipped = qty_by_status(item, 'shipped')
+            qty_refunded = qty_by_status(item, 'refunded')
+            if fully_fulfilled?(qty_ordered, qty_shipped, qty_refunded)
+              'fulfilled'
+            elsif partially_fulfilled?(qty_shipped, qty_ordered)
+              'partial'
+            end
+          end
+
+          def fully_fulfilled?(qty_ordered, qty_shipped, qty_refunded)
+            qty_ordered == qty_shipped && qty_refunded == 0 && qty_shipped > 0
+          end
+
+          def partially_fulfilled?(qty_shipped, qty_ordered)
+            qty_shipped > 0 && qty_shipped < qty_ordered
+          end
+
+          def requires_shipping?(item)
+            item['is_virtual'].to_i == 0
+          end
+
+          def taxable?(item)
+            item['tax_amount'].to_f > 0
+          end
+
+          def qty_by_status(item, status)
+            key = "qty_#{status}"
+            item[key].present? ? item[key].to_i : 0
+          end
+
           def tax_applied?(item)
             item['tax_percent'].to_f > 0 && item['tax_amount'].to_f > 0
           end

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

@@ -43,21 +43,17 @@ module ShopifyTransporter
           end
 
           def financial_status(hash)
-            order_state = hash['state']
-            status = nil
-
-            if order_state == 'Pending Payment'
-              status = 'pending'
-            elsif paid?(hash)
-              status = 'paid'
+            if paid?(hash)
+              'paid'
             elsif partially_paid?(hash)
-              status = 'partially_paid'
+              'partially_paid'
             elsif partially_refunded?(hash)
-              status = 'partially_refunded'
+              'partially_refunded'
             elsif refunded?(hash)
-              status = 'refunded'
+              'refunded'
+            else
+              'pending'
             end
-            status
           end
 
           def fulfillment_status(hash)
@@ -104,7 +100,7 @@ module ShopifyTransporter
           end
 
           def paid?(hash)
-            total_price(hash) == total_paid(hash) && total_refunded(hash) == 0
+            total_price(hash) == total_paid(hash) && total_paid(hash) > 0 && total_refunded(hash) == 0
           end
 
           def partially_paid?(hash)

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

@@ -38,7 +38,7 @@ module ShopifyTransporter
             private
 
             def input_applies?(input)
-              true unless input['parent_id'].present?
+              input['parent_id'].blank?
             end
 
             def attributes_from(input)

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

@@ -8,18 +8,15 @@ module ShopifyTransporter
       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|
+            return {} unless record.key?('variants')
+            simple_product_in_magento_format = record['variants'].find do |product|
               product['product_id'] == hash['product_id']
-            end.first
+            end
+            return {} unless simple_product_in_magento_format.present?
             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',
@@ -35,6 +32,10 @@ module ShopifyTransporter
 
             private
 
+            def input_applies?(input)
+              input.present? && input['type'] == 'simple'
+            end
+
             def variant_options(input)
               {
                 'option1' => input['option1_value'],

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

@@ -14,11 +14,16 @@ module ShopifyTransporter
 
           class VariantAttributesAccumulator < Shopify::AttributesAccumulator
             def accumulate(current_product)
-              if current_product['parent_id'].present?
-                @output['variants'] ||= []
-                @output['variants'] << current_product
-                @output
-              end
+              return @output unless input_applies?(current_product)
+              @output['variants'] ||= []
+              @output['variants'] << current_product
+              @output
+            end
+
+            private
+
+            def input_applies?(current_product)
+              current_product['type'] == 'simple'
             end
           end
         end

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

@@ -8,16 +8,12 @@ module ShopifyTransporter
       module Product
         class VariantImage < Pipeline::Stage
           def convert(hash, record)
-            return unless input_applied?(hash)
+            return {} unless hash['images'].present? && hash['parent_id'].present?
             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']

data/lib/shopify_transporter/shopify/order.rb

@@ -14,7 +14,7 @@ module ShopifyTransporter
           [
             'Name', 'Email', 'Financial Status', 'Fulfillment Status', 'Currency',
             'Buyer Accepts Marketing', 'Cancel Reason', 'Cancelled At', 'Closed At', 'Tags', 'Note',
-            'Phone', 'Referring Site', 'Processed At', 'Source name', 'Total discounts', 'Total weight',
+            'Phone', 'Referring Site', 'Processed At', 'Source name', 'Total weight',
             'Total Tax', 'Shipping Company', 'Shipping Name', 'Shipping Phone', 'Shipping First Name',
             'Shipping Last Name', 'Shipping Address1', 'Shipping Address2', 'Shipping City',
             'Shipping Province', 'Shipping Province Code', 'Shipping Zip', 'Shipping Country',
@@ -22,10 +22,11 @@ module ShopifyTransporter
             'Billing First Name', 'Billing Last Name', 'Billing Address1', 'Billing Address2',
             'Billing City', 'Billing Province', 'Billing Province Code', 'Billing Zip',
             'Billing Country', 'Billing Country Code', 'Lineitem name', 'Lineitem quantity',
-            'Lineitem price', 'Lineitem discount', 'Lineitem compare at price', 'Lineitem sku',
-            'Lineitem requires shipping', 'Lineitem taxable', 'Lineitem fulfillment status',
-            'Tax 1 Title', 'Tax 1 Price', 'Tax 1 Rate', 'Tax 2 Title', 'Tax 2 Price', 'Tax 2 Rate',
-            'Tax 3 Title', 'Tax 3 Price', 'Tax 3 Rate', 'Transaction amount', 'Transaction kind', 'Transaction status',
+            'Lineitem price', 'Lineitem sku', 'Lineitem requires shipping', 'Lineitem taxable',
+            'Lineitem fulfillment status', 'Tax 1 Title', 'Tax 1 Price', 'Tax 1 Rate', 'Tax 2 Title',
+            'Tax 2 Price', 'Tax 2 Rate', 'Tax 3 Title', 'Tax 3 Price', 'Tax 3 Rate',
+            'Transaction amount', 'Transaction kind', 'Transaction status',
+            'Discount code', 'Discount amount', 'Discount type',
             'Metafield Namespace', 'Metafield Key', 'Metafield Value', 'Metafield Value Type'
           ].to_csv
         end
@@ -46,6 +47,7 @@ module ShopifyTransporter
           csv << top_level_row_values
           line_item_row_values.each { |row| csv << row }
           transaction_row_values.each { |row| csv << row }
+          discount_row_values.each { |row| csv << row }
           metafield_row_values.each { |row| csv << row }
         end
       end
@@ -65,7 +67,7 @@ module ShopifyTransporter
       LINE_ITEM_PREFIX = 'lineitem_'
 
       LINE_ITEM_ATTRIBUTES = %w(
-        name quantity price discount compare_at_price sku requires_shipping taxable fulfillment_status
+        name quantity price sku requires_shipping taxable fulfillment_status
       )
 
       TRANSACTION_PREFIX = 'transaction_'
@@ -74,6 +76,12 @@ module ShopifyTransporter
         amount kind status
       )
 
+      DISCOUNT_PREFIX = 'discount_'
+
+      DISCOUNT_ATTRIBUTES = %w(
+        code amount type
+      )
+
       def address_hash_for(address_hash, prefix)
         return {} if address_hash.blank?
 
@@ -120,6 +128,17 @@ module ShopifyTransporter
           row_values_from(transaction) if self.class.has_values?(transaction)
         end.compact
       end
+
+      def discount_row_values
+        return [] unless record_hash['discounts']
+
+        record_hash['discounts'].map do |discount_hash|
+          discount = discount_hash.slice(*DISCOUNT_ATTRIBUTES)
+            .transform_keys! { |k| "#{DISCOUNT_PREFIX}#{k}" }
+
+          row_values_from(discount) if self.class.has_values?(discount)
+        end.compact
+      end
     end
   end
 end

data/lib/shopify_transporter/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module ShopifyTransporter
-  VERSION = '2.2.0'
+  VERSION = '2.3.1'
 end

data/lib/templates/magento/config.tt

@@ -29,6 +29,7 @@ object_types:
       - LineItems
       - AddressesAttribute
       - Transactions
+      - Discounts
 
 extract_configuration:
   soap:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify_transporter
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.1
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-15 00:00:00.000000000 Z
+date: 2018-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -161,6 +161,7 @@ files:
 - lib/shopify_transporter/pipeline/magento/customer/addresses_attribute.rb
 - lib/shopify_transporter/pipeline/magento/customer/top_level_attributes.rb
 - lib/shopify_transporter/pipeline/magento/order/addresses_attribute.rb
+- lib/shopify_transporter/pipeline/magento/order/discounts.rb
 - lib/shopify_transporter/pipeline/magento/order/line_items.rb
 - lib/shopify_transporter/pipeline/magento/order/top_level_attributes.rb
 - lib/shopify_transporter/pipeline/magento/order/transactions.rb