solidus_backtracs 2.2.1 → 2.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a599802f23077392477db03b1e36eecf30633ef3b5892b85a35304d15b061fe3
-  data.tar.gz: cc197de83a593fbdd81872c61e27a69cc9a09ddf3ba359407e823caad22cc102
+  metadata.gz: d3430b774af9ec754f4c7657dfd160e83ffbeeb898dd29a463a16d7031cc8dad
+  data.tar.gz: ef7e49cb43f69e6f4e94cea99bdc7805ab92dc096bfd78b970ad94502099b702
 SHA512:
-  metadata.gz: 5ddd0296522fa664cd9e92229438f25fa38698dfa9fa66316311b41b49d40bfc2a92bb7507a32d5789b5978ae71b71f3ac75c03f07c6ea657c440d8e960473fc
-  data.tar.gz: 60781ae6012c98e4a88d440e9d7faba29eb2f05b51106da5c3883fe8b12fe6616b4cd4260bc1ffc3a685221ed03d4c07c2b174befec222e999caf84c9287bba9
+  metadata.gz: adcbece7f493aa87d8c20abe19c93072c8f728110ebe8682550e01ff93a7f9a7a4217651d9f05da8b97a024c5ed7908f9732d867a19615a3a06de684bd0b8424
+  data.tar.gz: 67d823281ed419469d6d3addcc13ee9c670f259eeef29a288d8493c10636b77359bfcc00cb53c45f23cffd378b67fb789381bb17fef1753592cf0a4423bb01e3

data/.gitignore

@@ -18,3 +18,5 @@ spec/examples.txt
 .rvmrc
 .ruby-version
 .ruby-gemset
+.tool-versions
+TAGS

data/CHANGELOG.md

@@ -1,2 +1,16 @@
 # Changelog
 
+## 2.2.0
+
+Support the Solidus Assembly gem, consider allowed SKUs within assemblies/bundles
+Retry logic for the authenticated request
+
+## 2.1.0
+
+New auth and API patterns for Backtracs
+Support specific SKUs to be mapped
+
+## 2.0.0
+
+Diverged the gem from Shipstation to the Bactracs API
+

data/app/helpers/solidus_backtracs/export_helper.rb

@@ -30,23 +30,31 @@ module SolidusBacktracs
     end
 
     def self.backtracs_address(xml, order, type)
-      name = "#{type.to_s.titleize}To"
-      address = order.send("#{type}_address")
-
-      xml.__send__(name) {
-        xml.CompanyName   address.company ? address.company : address.name
-        xml.Contact       address.name
-        xml.ContactEmail  order.email
-        xml.Address1      address.address1
-        xml.Address2      address.address2
-        xml.City          address.city
-        xml.State         address.state ? address.state.abbr : address.state_name
-        xml.Zip           address.zipcode
-        xml.Phone         address.phone.present? ? address.phone : "000-000-0000"
-        xml.PhoneAlt      address.phone.present? ? address.phone : "000-000-0000"
-        xml.Country       address.country.iso
-      }
-    end    
+      if type.present?
+        name = "#{type.to_s.titleize}To"
+        address = order.send("#{type}_address")
+
+        xml.__send__(name) {
+          xml.CompanyName   address.company ? address.company : address.name
+          xml.Contact       address.name
+          xml.ContactEmail  order.email
+          xml.Address1      address.address1
+          xml.Address2      address.address2
+          xml.City          address.city
+          xml.State         address.state ? address.state.abbr : address.state_name
+          xml.Zip           address.zipcode
+          xml.Phone         address.phone.present? ? address.phone : "000-000-0000"
+          xml.PhoneAlt      address.phone.present? ? address.phone : "000-000-0000"
+          xml.Country       address.country.iso
+        }
+      end
+    else
+      Rails.logger.info {
+        message: 'missing address type',
+        order: order.id,
+        type: type
+      }.to_s
+    end
     # rubocop:enable all
   end
 end

data/app/jobs/solidus_backtracs/api/schedule_shipment_syncs_job.rb

@@ -20,7 +20,14 @@ module SolidusBacktracs
       end
 
       def query_shipments
-        shipments = SolidusBacktracs::Shipment::PendingApiSyncQuery.apply(::Spree::Shipment.joins(inventory_units: [:variant]).where("spree_variants.sku" => SolidusBacktracs.config.shippable_skus).where("spree_shipments.state" => :ready).where.not(shipstation_order_id: nil).distinct)
+        shipments = SolidusBacktracs::Shipment::PendingApiSyncQuery.apply(
+          ::Spree::Shipment
+            .joins(inventory_units: [:variant])
+            .where("spree_variants.sku" => SolidusBacktracs.config.shippable_skus)
+            .where("spree_shipments.state" => :ready)
+            .where(backtracs_synced_at: nil)
+            .distinct
+        )
       end
     end
   end

data/lib/generators/solidus_backtracs/install/templates/initializer.rb

@@ -11,6 +11,7 @@ SolidusBacktracs.configure do |config|
 
   ## API Configuration
   config.api_base = ENV['BACKTRACS_API_BASE'] || 'https://bactracstest.andlor.com'
+  config.api_retries = ENV['BACKTRACS_API_RETRIES'] || 3
 
   # Backtracs expects the endpoint to be protected by HTTP Basic Auth.
   # Set the username and password you desire for Backtracs to use.
@@ -32,7 +33,7 @@ SolidusBacktracs.configure do |config|
   config.sku_map = {}
   config.default_rma_type = "W"
   config.default_carrier = "FedExGrnd"
-  config.default_ship_method = "GROUND"  
+  config.default_ship_method = "GROUND"
   config.default_status = "OPEN"
   config.default_rp_location = "FG-NEW"
   config.shippable_skus = []

data/lib/solidus_backtracs/api/request_runner.rb

@@ -10,27 +10,41 @@ module SolidusBacktracs
         @username = SolidusBacktracs.configuration.authentication_username
         @password = SolidusBacktracs.configuration.authentication_password
         @api_base = SolidusBacktracs.configuration.api_base
+        @retries  = SolidusBacktracs.configuration.api_retries
       end
 
-      def authenticated_call(method: nil, path: nil, serializer: nil, shipment: nil)
-        unless @username.present? || @password.present? || @api_base.present?
-          raise "Credentials not defined for Authentication"
-        end 
+      def authenticated_call(method: nil, path: nil, serializer: nil, shipment: nil, count: 0)
+        if count <= @retries
+          unless @username.present? || @password.present? || @api_base.present?
+            raise "Credentials not defined for Authentication"
+          end
 
-        Rails.cache.fetch("backtracks_cache_key", expires_in: 1.hour) do
-          @response = self.call(method: :get, path: "/webservices/user/Authentication.asmx/Login?sUserName=#{@username}&sPassword=#{@password}")
-        end
-
-        authenticted = parse_authentication_response(@response, "Result")
+          @response = Rails.cache.fetch("backtracks_cache_key", expires_in: 1.hour, skip_nil: true) do
+            self.call(method: :get, path: "/webservices/user/Authentication.asmx/Login?sUserName=#{@username}&sPassword=#{@password}")
+          end
 
-        if authenticted == 'false'
-          raise RequestError.from_response(@response)
-        else
+          raise RequestError.from_response(@response) unless @response # just try again for @retries?
+          authenticted = parse_authentication_response(@response, "Result")
+          raise RequestError.from_response(@response) if authenticted == "false"
           sguid = parse_authentication_response(@response, "Message")
-          params = serializer.call(shipment, sguid)
 
-          rma_response = call(method: :post, path: path, params: params)
-          sync_shipment(shipment, rma_response)
+          if authenticted == 'false'
+            clear_cache
+            raise "User Not Authenticated"
+          else
+            sguid = parse_authentication_response(@response, "Message")
+            params = serializer.call(shipment, sguid)
+
+            rma_response = call(method: :post, path: path, params: params)
+            unless parse_rma_creation_response(rma_response) == 'true'
+              clear_cache
+              count += 1
+              self.authenticated_call(method: :post, path: '/webservices/rma/rmaservice.asmx', serializer: serializer, shipment: shipment, count: count)
+            end
+            shipment_synced(shipment)
+          end
+        else
+          shipment_sync_failed(shipment)
         end
       end
 
@@ -62,25 +76,33 @@ module SolidusBacktracs
         end
       end
 
+      def clear_cache
+        Rails.cache.delete('backtracks_cache_key')
+        @response = nil
+      end
+
       def parse_authentication_response(response, type)
         response.dig("AuthenticationResponse", type)
       end
 
-      def sync_shipment(shipment, response)
-        result = response.dig("Envelope", "Body", "CreateNewResponse", "CreateNewResult", "Result")
-        if result == 'true'
-          shipment.update_column(:backtracs_synced_at, Time.zone.now)
+      def parse_rma_creation_response(response)
+        response.dig("Envelope", "Body", "CreateNewResponse", "CreateNewResult", "Result")
+      end
 
-          ::Spree::Event.fire(
-            'solidus_backtracs.api.sync_completed',
-            shipment: shipment
-          )
-        else
-          ::Spree::Event.fire(
-            'solidus_backtracs.api.sync_failed',
-            shipment: shipment
-          )
-        end
+      def shipment_synced(shipment)
+        shipment.update_column(:backtracs_synced_at, Time.zone.now)
+
+        ::Spree::Event.fire(
+          'solidus_backtracs.api.sync_completed',
+          shipment: shipment
+        )
+      end
+
+      def shipment_sync_failed(shipment)
+        ::Spree::Event.fire(
+          'solidus_backtracs.api.sync_failed',
+          shipment: shipment
+        )
       end
     end
   end

data/lib/solidus_backtracs/configuration.rb

@@ -19,7 +19,8 @@ module SolidusBacktracs
       :shipment_notice_class,
       :authentication_username,
       :authentication_password,
-      :api_base, 
+      :api_base,
+      :api_retries,
       :proxy_address,
       :proxy_port,
       :proxy_username,

data/lib/solidus_backtracs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SolidusBacktracs
-  VERSION = '2.2.1'
+  VERSION = '2.2.4'
 end

data/{solidus_shipstation.gemspec → solidus_bactracs.gemspec}

@@ -9,12 +9,12 @@ Gem::Specification.new do |spec|
   spec.email = 'zkhan@suvie.com'
 
   spec.summary = 'A Solidus extension for integrating the Backtracs API.'
-  spec.homepage = 'https://github.com/solidusio-contrib/solidus_backtracs'
+  spec.homepage = 'https://github.com/suvie-eng/solidus_backtracs'
   spec.license = 'BSD-3-Clause'
 
   spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = 'https://github.com/solidusio-contrib/solidus_backtracs'
-  spec.metadata['changelog_uri'] = 'https://github.com/solidusio-contrib/solidus_backtracs/blob/master/CHANGELOG.md'
+  spec.metadata['source_code_uri'] = 'https://github.com/suvie-eng/solidus_backtracs/'
+  spec.metadata['changelog_uri'] = 'https://github.com/suvie-eng/solidus_backtracs/blob/master/CHANGELOG.md'
 
   spec.required_ruby_version = Gem::Requirement.new('>= 2.5')
 

data/spec/queries/solidus_backtracs/shipment/pending_api_sync_query_spec.rb

@@ -19,15 +19,15 @@ RSpec.describe SolidusBacktracs::Shipment::PendingApiSyncQuery do
         stub_configuration(api_sync_threshold: 10.minutes)
         shipment = create(:order_ready_to_ship).shipments.first.tap do |s|
           s.order.update_columns(updated_at: 7.minutes.ago)
-          s.update_columns(shipstation_synced_at: 8.minutes.ago)
+          s.update_columns(backtracs_synced_at: 8.minutes.ago)
         end
         create(:order_ready_to_ship).shipments.first.tap do |s|
           s.order.update_columns(updated_at: 9.minutes.ago)
-          s.update_columns(shipstation_synced_at: 8.minutes.ago)
+          s.update_columns(backtracs_synced_at: 8.minutes.ago)
         end
         create(:order_ready_to_ship).shipments.first.tap do |s|
           s.order.update_columns(updated_at: 11.minutes.ago)
-          s.update_columns(shipstation_synced_at: 10.minutes.ago)
+          s.update_columns(backtracs_synced_at: 10.minutes.ago)
         end
 
         expect(described_class.apply(Spree::Shipment.all)).to match_array([shipment])

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solidus_backtracs
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.2.4
 platform: ruby
 authors:
 - Zeryab Ali
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-05-13 00:00:00.000000000 Z
+date: 2022-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -174,7 +174,7 @@ files:
 - lib/solidus_backtracs/shipment_notice.rb
 - lib/solidus_backtracs/testing_support/factories.rb
 - lib/solidus_backtracs/version.rb
-- solidus_shipstation.gemspec
+- solidus_bactracs.gemspec
 - spec/controllers/spree/backtracs_controller_spec.rb
 - spec/fixtures/backtracs_xml_schema.xsd
 - spec/jobs/solidus_backtracs/api/schedule_shipment_syncs_job_spec.rb
@@ -197,13 +197,13 @@ files:
 - spec/support/controllers.rb
 - spec/support/webmock.rb
 - spec/support/xsd.rb
-homepage: https://github.com/solidusio-contrib/solidus_backtracs
+homepage: https://github.com/suvie-eng/solidus_backtracs
 licenses:
 - BSD-3-Clause
 metadata:
-  homepage_uri: https://github.com/solidusio-contrib/solidus_backtracs
-  source_code_uri: https://github.com/solidusio-contrib/solidus_backtracs
-  changelog_uri: https://github.com/solidusio-contrib/solidus_backtracs/blob/master/CHANGELOG.md
+  homepage_uri: https://github.com/suvie-eng/solidus_backtracs
+  source_code_uri: https://github.com/suvie-eng/solidus_backtracs/
+  changelog_uri: https://github.com/suvie-eng/solidus_backtracs/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths: