shopify_transporter 2.0.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 409e6ea11b360d21895a05e2f8f37fa7f924f7e4
-  data.tar.gz: 94c775ed84f0ecfbe3b8e7a5b084b0e990e5d4ff
+  metadata.gz: 6eda8c759a40e474719373d41d3554e10d43f5bf
+  data.tar.gz: baca1185566a388a56a725e80e641066b91a8b05
 SHA512:
-  metadata.gz: 5eec50cdc6736cca34376105ecbfc8c3b954365a04c9224a112e64ace3f84ae98ccd320b5f09d75ecdc9a7d11e2c11e3384a1a53241c46e94c22f7341ed9a2f4
-  data.tar.gz: bef84c59176901f9c10a0353f81a22dbcd62dd1865b7e539ce0d3c6ffbe0c0c79e3376c620e08c502b2ab381681bdddcce2bf4ba03e60bf60479a5e129c2260f
+  metadata.gz: 6589791c84651519d8b184ff6bb1dd077d08711fab9abd522884c8a74a677d57b034d7b23d9f809bc782142e3845825eefcd3f20e6d362669e166dcd6374ac00
+  data.tar.gz: db735a4ed6eba567b4e4a3ec65f8d2182a34bbe8371ec901ccd56252b3b84485bc6ddf5606d249e6577545cdcc1d5bbc8533e2cade66f59167cd1d8b603b24ef

data/lib/shopify_transporter/exporters/magento/customer_exporter.rb

@@ -15,7 +15,12 @@ module ShopifyTransporter
 
         def export
           base_customers.each do |customer|
-            yield with_attributes(customer)
+            begin
+              yield with_attributes(customer)
+            rescue Savon::Error => e
+              print_customer_details_error(customer, e)
+              yield customer
+            end
           end
         end
 
@@ -38,6 +43,20 @@ module ShopifyTransporter
         def customer_address_list(customer_id)
           @client.call(:customer_address_list, customer_id: customer_id).body
         end
+
+        def print_customer_details_error(customer, e)
+          $stderr.puts '***'
+          $stderr.puts 'Warning:'
+          $stderr.puts "Encountered an error with fetching details for customer with id: #{customer[:customer_id]}"
+          $stderr.puts JSON.pretty_generate(customer)
+          $stderr.puts 'The exact error was:'
+          $stderr.puts "#{e.class}: "
+          $stderr.puts e.message
+          $stderr.puts '-'
+          $stderr.puts "Exporting the customer (#{customer[:customer_id]}) without its details."
+          $stderr.puts 'Continuing with the next customer.'
+          $stderr.puts '***'
+        end
       end
     end
   end

data/lib/shopify_transporter/exporters/magento/order_exporter.rb

@@ -15,7 +15,12 @@ module ShopifyTransporter
 
         def export
           base_orders.each do |order|
-            yield with_attributes(order)
+            begin
+              yield with_attributes(order)
+            rescue Savon::Error => e
+              print_order_details_error(order, e)
+              yield order
+            end
           end
         end
 
@@ -40,6 +45,20 @@ module ShopifyTransporter
             .call(:sales_order_info, order_increment_id: order_increment_id)
             .body[:sales_order_info_response]
         end
+
+        def print_order_details_error(order, e)
+          $stderr.puts '***'
+          $stderr.puts 'Warning:'
+          $stderr.puts "Encountered an error with fetching details for order with id: #{order[:order_id]}"
+          $stderr.puts JSON.pretty_generate(order)
+          $stderr.puts 'The exact error was:'
+          $stderr.puts "#{e.class}: "
+          $stderr.puts e.message
+          $stderr.puts '-'
+          $stderr.puts "Exporting the order (#{order[:order_id]}) without its details."
+          $stderr.puts 'Continuing with the next order.'
+          $stderr.puts '***'
+        end
       end
     end
   end

data/lib/shopify_transporter/exporters/magento/product_exporter.rb

@@ -21,7 +21,12 @@ module ShopifyTransporter
 
         def export
           base_products.each do |product|
-            yield with_attributes(product)
+            begin
+              yield with_attributes(product)
+            rescue Savon::Error => e
+              print_product_details_error(product, e)
+              yield product
+            end
           end
         end
 
@@ -123,6 +128,20 @@ module ShopifyTransporter
             .call(:catalog_product_tag_list, product_id: product_id.to_i)
             .body[:catalog_product_tag_list_response][:result][:item]
         end
+
+        def print_product_details_error(product, e)
+          $stderr.puts '***'
+          $stderr.puts 'Warning:'
+          $stderr.puts "Encountered an error with fetching details for product with id: #{product[:product_id]}"
+          $stderr.puts JSON.pretty_generate(product)
+          $stderr.puts 'The exact error was:'
+          $stderr.puts "#{e.class}: "
+          $stderr.puts e.message
+          $stderr.puts '-'
+          $stderr.puts "Exporting the product (#{product[:product_id]}) without its details."
+          $stderr.puts 'Continuing with the next product.'
+          $stderr.puts '***'
+        end
       end
     end
   end

data/lib/shopify_transporter/exporters/magento/soap.rb

@@ -33,10 +33,19 @@ module ShopifyTransporter
 
               $stderr.puts "Processing batch: #{current_id}..#{end_of_range}"
 
-              enumerator << call(
-                method,
-                params.merge(batching_filter(current_id, end_of_range, batch_index_column)),
-              )
+              begin
+                enumerator << call(
+                  method,
+                  params.merge(batching_filter(current_id, end_of_range, batch_index_column)),
+                )
+              rescue Savon::Error => e
+                output = 'Skipping batch: '\
+                  "#{current_id}..#{end_of_range} after #{MAX_RETRIES} retries because of an error."
+                $stderr.puts output
+                $stderr.puts 'The exact error was:'
+                $stderr.puts "#{e.class}: "
+                $stderr.puts e.message
+              end
 
               current_id += batch_size
             end

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

@@ -31,14 +31,22 @@ module ShopifyTransporter
             {
               first_name: address_attrs['firstname'],
               last_name: address_attrs['lastname'],
+              name: name(address_attrs),
               phone: address_attrs['telephone'],
               address1: address_attrs['street'],
               city: address_attrs['city'],
               province_code: address_attrs['region'],
               zip: address_attrs['postcode'],
               country_code: address_attrs['country_id'],
+              company: address_attrs['company'],
             }
           end
+
+          def name(address_attrs)
+            if address_attrs['firstname'].present? && address_attrs['lastname'].present?
+              address_attrs['firstname'] + ' ' + address_attrs['lastname']
+            end
+          end
         end
       end
     end

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

@@ -42,6 +42,7 @@ module ShopifyTransporter
           end
 
           def tax_lines(item)
+            return unless tax_applied?(item)
             [
               {
                 title: 'Tax',
@@ -50,6 +51,10 @@ module ShopifyTransporter
               }.stringify_keys,
             ]
           end
+
+          def tax_applied?(item)
+            item['tax_percent'].to_f > 0 && item['tax_amount'].to_f > 0
+          end
         end
       end
     end

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

@@ -12,10 +12,17 @@ module ShopifyTransporter
               {
                 name: hash['increment_id'],
                 email: hash['customer_email'],
+                currency: hash['order_currency_code'],
+                cancelled_at: cancelled_at(hash),
+                closed_at: closed_at(hash),
                 processed_at: hash['created_at'],
                 subtotal_price: hash['subtotal'],
                 total_tax: hash['tax_amount'],
                 total_price: hash['grand_total'],
+                source_name: ORDER_ORIGINATED_FROM,
+                total_weight: hash['weight'],
+                financial_status: financial_status(hash),
+                fulfillment_status: fulfillment_status(hash),
               }.stringify_keys
             )
             customer = build_customer(hash)
@@ -25,6 +32,8 @@ module ShopifyTransporter
 
           private
 
+          ORDER_ORIGINATED_FROM = 'Magento'
+
           def build_customer(hash)
             {
               email: hash['customer_email'],
@@ -32,6 +41,102 @@ module ShopifyTransporter
               last_name: hash['customer_lastname'],
             }.stringify_keys
           end
+
+          def financial_status(hash)
+            order_state = hash['state']
+            status = nil
+
+            if order_state == 'Pending Payment'
+              status = 'pending'
+            elsif paid?(hash)
+              status = 'paid'
+            elsif partially_paid?(hash)
+              status = 'partially_paid'
+            elsif partially_refunded?(hash)
+              status = 'partially_refunded'
+            elsif refunded?(hash)
+              status = 'refunded'
+            end
+            status
+          end
+
+          def fulfillment_status(hash)
+            total_qty_ordered = hash['total_qty_ordered'].to_i
+            total_qty_shipped = total_qty_shipped(hash)
+            status = nil
+
+            if total_qty_shipped == total_qty_ordered
+              status = 'fulfilled'
+            elsif total_qty_shipped > 0 && total_qty_shipped < total_qty_ordered
+              status = 'partial'
+            end
+            status
+          end
+
+          def cancelled_at(hash)
+            timestamp(hash, 'canceled') if cancelled?(hash)
+          end
+
+          def closed_at(hash)
+            timestamp(hash, 'closed') if closed?(hash)
+          end
+
+          def cancelled?(hash)
+            hash['state'] == 'canceled'
+          end
+
+          def closed?(hash)
+            hash['state'] == 'closed'
+          end
+
+          def total_price(hash)
+            hash['grand_total'].to_i
+          end
+
+          def total_paid(hash)
+            return hash['total_paid'].to_i if hash['total_paid'].present?
+            0
+          end
+
+          def total_refunded(hash)
+            return hash['total_refunded'].to_i if hash['total_refunded'].present?
+            0
+          end
+
+          def paid?(hash)
+            total_price(hash) == total_paid(hash) && total_refunded(hash) == 0
+          end
+
+          def partially_paid?(hash)
+            total_paid(hash) > 0 && total_paid(hash) < total_price(hash) && total_refunded(hash) == 0
+          end
+
+          def partially_refunded?(hash)
+            total_refunded(hash) > 0 && total_refunded(hash) < total_paid(hash)
+          end
+
+          def refunded?(hash)
+            total_refunded(hash) == total_paid(hash) && total_refunded(hash) != 0
+          end
+
+          def total_qty_shipped(hash)
+            return 0 unless hash.dig('items', 'result', 'items', 'item').present?
+            line_items = hash['items']['result']['items']['item']
+            return line_items['qty_shipped'].to_i if line_items.is_a?(Hash)
+            line_items.map { |line_item| line_item['qty_shipped'].to_i }.sum
+          end
+
+          def timestamp(hash, status)
+            return unless hash.dig('items', 'result', 'status_history', 'item').present?
+
+            history_items = hash['items']['result']['status_history']['item']
+            return history_items['created_at'] if history_items.is_a?(Hash) && history_items['status'] == status
+
+            last_applicable_history_item = history_items.select do |history|
+              history['status'] == status
+            end.last
+            last_applicable_history_item['created_at'] if last_applicable_history_item.present?
+          end
         end
       end
     end

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+require 'shopify_transporter/pipeline/stage'
+require 'shopify_transporter/shopify'
+module ShopifyTransporter
+  module Pipeline
+    module Magento
+      module Order
+        class Transactions < Pipeline::Stage
+          def convert(input, record)
+            record.merge!(
+              {
+                transactions: transactions(input),
+              }.stringify_keys
+            )
+          end
+
+          private
+
+          def transactions(input)
+            [
+              sale_transaction(input),
+              refund_transaction(input),
+            ].compact
+          end
+
+          def sale_transaction(input)
+            return unless input['total_paid'].present?
+            {
+              amount: input['total_paid'].to_f,
+              kind: 'sale',
+              status: 'success',
+            }.stringify_keys
+          end
+
+          def refund_transaction(input)
+            return unless input['total_refunded'].present?
+            {
+              amount: input['total_refunded'].to_f,
+              kind: 'refund',
+              status: 'success',
+            }.stringify_keys
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shopify_transporter/shopify/order.rb

@@ -25,8 +25,8 @@ module ShopifyTransporter
             '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', 'Metafield Namespace', 'Metafield Key',
-            'Metafield Value', 'Metafield Value Type'
+            'Tax 3 Title', 'Tax 3 Price', 'Tax 3 Rate', 'Transaction amount', 'Transaction kind', 'Transaction status',
+            'Metafield Namespace', 'Metafield Key', 'Metafield Value', 'Metafield Value Type'
           ].to_csv
         end
 
@@ -45,6 +45,7 @@ module ShopifyTransporter
         CSV.generate do |csv|
           csv << top_level_row_values
           line_item_row_values.each { |row| csv << row }
+          transaction_row_values.each { |row| csv << row }
           metafield_row_values.each { |row| csv << row }
         end
       end
@@ -67,6 +68,12 @@ module ShopifyTransporter
         name quantity price discount compare_at_price sku requires_shipping taxable fulfillment_status
       )
 
+      TRANSACTION_PREFIX = 'transaction_'
+
+      TRANSACTION_ATTRIBUTES = %w(
+        amount kind status
+      )
+
       def address_hash_for(address_hash, prefix)
         return {} if address_hash.blank?
 
@@ -102,6 +109,17 @@ module ShopifyTransporter
           row_values_from(line_item) if self.class.has_values?(line_item)
         end.compact
       end
+
+      def transaction_row_values
+        return [] unless record_hash['transactions']
+
+        record_hash['transactions'].map do |transaction_hash|
+          transaction = transaction_hash.slice(*TRANSACTION_ATTRIBUTES)
+            .transform_keys! { |k| "#{TRANSACTION_PREFIX}#{k}" }
+
+          row_values_from(transaction) if self.class.has_values?(transaction)
+        end.compact
+      end
     end
   end
 end

data/lib/shopify_transporter/version.rb

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

data/lib/templates/magento/config.tt

@@ -28,6 +28,7 @@ object_types:
       - TopLevelAttributes
       - LineItems
       - AddressesAttribute
+      - Transactions
 
 extract_configuration:
   soap:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify_transporter
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-04 00:00:00.000000000 Z
+date: 2018-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -163,6 +163,7 @@ files:
 - lib/shopify_transporter/pipeline/magento/order/addresses_attribute.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
 - lib/shopify_transporter/pipeline/magento/product/top_level_attributes.rb
 - lib/shopify_transporter/pipeline/magento/product/top_level_variant_attributes.rb
 - lib/shopify_transporter/pipeline/magento/product/variant_attributes.rb