solidus_bactracs 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc8997f6f0e758dad7788168d7277d6995338887221e16eaf5173c5f8e56a93a
-  data.tar.gz: 1e8e6ce7ecba59996b70cebbd91f49153074eb5cad64af726ba3f0bca3aa40c8
+  metadata.gz: e67ac9974b0c0fb6e097172f14667e73c99c5d4ccd948423e48dcdd5820becde
+  data.tar.gz: a7fb4b01e858278ab263373d087aa5a4c63222f9389d2f2a8087566e50f42270
 SHA512:
-  metadata.gz: 86bd10aa960cf5e863e71df839786a7b960a88eb846bf615688ca47d005207d40cd7249e313260888ec35eb496473159539720c66346e622062f613ed4d54a66
-  data.tar.gz: 7ee9d87aec037766f6c92d5696e66213fcd10183d09ea0e193cce4253c99743c96fcfacc857e0998d87a652079aae58cd4dc46cd2139804d24fb9fcea6cb15f6
+  metadata.gz: d6232847569c2a6166959fcfdd3791597d8e32aaa71f68def3d4eff77b8b8269857c0973143f5c8af3b33cf47ffcd326b209a43f8c36d6ae07c0542db3255205
+  data.tar.gz: d61675ac31273aa2751b300350d3b3b20ce8d4c23c62c39192a9a90c489762c4d6ff5179abefbcb53ce17031c4f9a68c976663599b49194078a3857d49cf6116

data/CHANGELOG.md

@@ -1,9 +1,12 @@
 # Changelog
 
+## 3.1.2
+Fully include retry support tables and methods within the gem. Earlier in 3.1.x some migrations, etc, were expected to be handled by the host rails app.
+
 ## 3.1.0
 Different retry support for CreateRMA, as well as more logging
 
-## 3.0.0
+## 3.0.x
 Re-release the gem under a new non-forked repo, since this gem is a non-mergeable divergence from the solidus_shipstation gem
 
 ## 2.2.0

data/README.md

@@ -28,7 +28,8 @@ used by the extension.
 
 ## Usage
 
-This extension can integrate with ShipStation in two ways.
+This extension can integrate with Bactracs via SOAP-based XML API integration.  The gem currently makes SOAP 1.1 format calls, though the API support SOAP 1.2
+
 
 ### XML integration
 

data/Rakefile

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+import "./lib/tasks/solidus_bactracs.rake"
 require 'solidus_dev_support/rake_tasks'
 SolidusDevSupport::RakeTasks.install
 

data/app/decorators/models/solidus_bactracs/spree/shipment_decorator.rb

@@ -7,6 +7,19 @@ module SolidusBactracs
         base.singleton_class.prepend ClassMethods
       end
 
+      def verify_bactracs_sync!
+        if bactracs_sync_verified_at.nil?
+          # API call to verify RMAs of shipments
+          if BactracsService.new.rma_was_synced?(self)
+            self.update_column(:bactracs_sync_verified_at, Time.now)
+          else
+            self.update_column(:bactracs_synced_at, nil)
+          end
+        end
+      rescue => e
+        Rails.logger.error({ message: "#{e.message}, file: shipment_decorator.rb", shipment_number: number })
+      end
+
       module ClassMethods
         def exportable
           ::Spree::Deprecation.warn <<~DEPRECATION

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

@@ -21,16 +21,17 @@ module SolidusBactracs
       end
 
       def query_shipments
-        shipments = SolidusBactracs::Shipment::PendingApiSyncQuery.apply(
-          ::Spree::Shipment
+        shipments = SolidusBactracs::Shipment::PendingApiSyncQuery.apply(all_elegible_shipments)
+      end
+
+      def all_elegible_shipments(skus: SolidusBactracs.config.shippable_skus, state: :ready)
+        ::Spree::Shipment
             .joins(inventory_units: [:variant])
-            .where("spree_variants.sku" => SolidusBactracs.config.shippable_skus)
-            .where("spree_shipments.state" => :ready)
+            .where("spree_variants.sku" => skus)
+            .where("spree_shipments.state" => state)
             .where(bactracs_synced_at: nil)
             .distinct
-        )
       end
     end
   end
 end
-

data/app/jobs/solidus_bactracs/api/sync_shipments_job.rb

@@ -10,6 +10,10 @@ module SolidusBactracs
         return if shipments.empty?
 
         sync_shipments(shipments)
+
+        # Verify bactracs sync
+        shipments.each { |shipment| VerifyBactracsSyncWorker.perform_async(shipment.id) }
+
       rescue RateLimitedError => e
         self.class.set(wait: e.retry_in).perform_later
       rescue StandardError => e

data/app/workers/verify_bactracs_sync_worker.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class VerifyBactracsSyncWorker
+  include Sidekiq::Worker
+
+  sidekiq_options queue: 'default'
+
+  def perform(shipment_id)
+    shipment = Spree::Shipment.find_by(id: shipment_id)
+    if shipment
+      shipment.verify_bactracs_sync!
+    end
+  end
+end

data/db/migrate/20210220093010_add_bactracs_api_sync_fields.rb

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
 # NOTE: This migration is only required if you use the API integration strategy.
 # If you're using the XML file instead, you can safely skip these columns.
 
 class AddBactracsApiSyncFields < ActiveRecord::Migration[5.2]
   def change
-    add_column :spree_shipments, :bactracs_synced_at, :datetime
+    if !ActiveRecord::Base.connection.column_exists?(:spree_shipments, :bactracs_synced_at)
+      add_column :spree_shipments, :bactracs_synced_at, :datetime
+    end
   end
 end

data/db/migrate/20220701000001_bactracs_typo_correction.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class BactracsTypoCorrection < ActiveRecord::Migration[5.2]
+  def change
+    if ( ActiveRecord::Base.connection.column_exists?(:spree_shipments, :backtracs_synced_at) &&
+        !ActiveRecord::Base.connection.column_exists?(:spree_shipments, :bactracs_synced_at))
+      rename_column :spree_shipments, :backtracs_synced_at, :bactracs_synced_at
+    end
+  end
+end

data/db/migrate/20220704144504_rename_bactracs_columns_in_spree_shipment.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class RenameBactracsColumnsInSpreeShipment < ActiveRecord::Migration[5.2]
+  def change
+    if ( ActiveRecord::Base.connection.column_exists?(:spree_shipments, :backtracs_sync_verified_at) &&
+        !ActiveRecord::Base.connection.column_exists?(:spree_shipments, :bactracs_sync_verified_at))
+      rename_column :spree_shipments, :backtracs_sync_verified_at, :bactracs_sync_verified_at
+    end
+  end
+end

data/lib/bactracs_service.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require "uri"
+require "net/http"
+
+class BactracsService
+  attr_accessor :token
+
+  def initialize
+    @username = SolidusBactracs.configuration.authentication_username
+    @password = SolidusBactracs.configuration.authentication_password
+    @runner = SolidusBactracs::Api::RequestRunner.new
+    # Authenticate account
+    authenticate!
+  end
+
+  def rma_was_synced?(shipment)
+    if @token.present?
+
+      response =
+        @runner.call(
+          method: :post,
+          path: "/webservices/rma/rmaservice.asmx?op=Read",
+          params:
+            "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n
+              <soap:Envelope xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\">\n
+              <soap:Body>
+                <Read xmlns=\"http://bactracs.andlor.com/rmaservice\">\n
+                  <sGuid>#{@token}</sGuid>\n
+                  <sRMANumber>#{shipment.number}</sRMANumber>\n
+                </Read>\n
+              </soap:Body>\n
+            </soap:Envelope>"
+        )
+
+      if response
+        return response.dig("Envelope", "Body", "ReadResponse", "ReadResult", "oRMA").present? rescue false
+      end
+    end
+
+    return false
+
+  rescue => e
+    Rails.logger.error({ message: e.message.to_s, file: "bactracs_service.rb" })
+
+    return false
+  end
+
+  private
+
+  def authenticate!
+
+    response =
+      @runner.call(
+        method: :get,
+        path: "/webservices/user/Authentication.asmx/Login?sUserName=#{@username}&sPassword=#{@password}"
+      )
+
+    if response.dig("AuthenticationResponse", "Result") == "true"
+      @token = response.dig("AuthenticationResponse", "Message")
+    end
+
+  rescue => e
+    Rails.logger.error({ message: "#{e.message}, file: bactracs_service.rb" })
+  end
+end

data/lib/solidus_bactracs/api/request_runner.rb

@@ -13,18 +13,18 @@ module SolidusBactracs
         @retries  = SolidusBactracs.configuration.api_retries
       end
 
-      def authenticated_call(method: nil, path: nil, serializer: nil, shipment: nil, count: 0)
+      def authenticated_call(serializer: nil, shipment: nil, method: :post, path: '/webservices/rma/rmaservice.asmx', count: 0)
         if count <= @retries
           sguid = authenticate! rescue nil
 
           if !sguid.presence
             clear_cache
             count += 1
-            self.authenticated_call(method: :post, path: '/webservices/rma/rmaservice.asmx', serializer: serializer, shipment: shipment, count: count)
+            self.authenticated_call(method: method, path: path, serializer: serializer, shipment: shipment, count: count)
           else
             params = serializer.call(shipment, sguid)
 
-            rma_response = call(method: :post, path: path, params: params)
+            rma_response = call(method: method, path: path, params: params)
             if create_rma_success?(rma_response)
               Rails.logger.info({ event: 'success CreateRMA', rma: shipment.number, response: parse_rma_creation_response(rma_response, "Message")})
               shipment_synced(shipment)
@@ -35,11 +35,12 @@ module SolidusBactracs
               clear_cache
               count += 1
               Rails.logger.warn({ event: 'bactracs failed CreateRMA', error: parse_rma_creation_response(rma_response, "Message")})
-              self.authenticated_call(method: :post, path: '/webservices/rma/rmaservice.asmx', serializer: serializer, shipment: shipment, count: count)
+              self.authenticated_call(method: method, path: path, serializer: serializer, shipment: shipment, count: count)
             end
           end
         else
           shipment_sync_failed(shipment)
+          return false
         end
       end
 
@@ -77,7 +78,7 @@ module SolidusBactracs
         @response = nil
       end
 
-      def authenticate!()
+      def authenticate!
         unless @username.present? || @password.present? || @api_base.present?
           raise "Credentials not defined for Authentication"
         end
@@ -110,7 +111,7 @@ module SolidusBactracs
 
       def rma_exists?(response)
         if parse_rma_creation_response(response, "Message").match(/rma .* already exists/)
-          Rails.logger.warn({ event: 'bactracs failed CreateRMA', error: parse_rma_creation_response(rma_response, "Message")})
+          Rails.logger.warn({ event: 'bactracs failed CreateRMA', error: parse_rma_creation_response(response, "Message")})
           return true
         end
       end

data/lib/solidus_bactracs/console_harness.rb

@@ -0,0 +1,53 @@
+module SolidusBactracs
+  class ConsoleHarness
+    attr_reader :runner, :syncer, :sync, :shipments, :shipments_elegible
+
+    attr_accessor :cursor, :batch
+
+    def initialize
+      @runner = SolidusBactracs::Api::RequestRunner.new
+      @syncer = SolidusBactracs::Api::BatchSyncer.from_config
+      @sync = SolidusBactracs::Api::ScheduleShipmentSyncsJob.new
+      @shipments = SolidusBactracs::Api::ScheduleShipmentSyncsJob.new.query_shipments
+      @shipments_elegible = SolidusBactracs::Api::ScheduleShipmentSyncsJob.new.all_elegible_shipments
+      @cursor = 0
+      @batch = 4
+    end
+
+    def refresh
+      @shipments = SolidusBactracs::Api::ScheduleShipmentSyncsJob.new.query_shipments
+    end
+
+    def shipment(id)
+      @shipments.find_by(id: id)
+    end
+
+    def shipment_number(ship_number)
+      @shipments.find_by(number: ship_number)
+    end
+
+    def serialize(shipment)
+      # SolidusShipstation::Api::ApplianceShipmentSerializer.new(shipment)
+      @syncer.client.shipment_serializer.call(shipment, @runner.authenticate!)
+    end
+
+    def try_one
+      puts "trying shipment #{(shipment = @shipments[@cursor]).id}"
+      # resp = @runner.call(:post, '/orders/createorders', [serialize(shipment)])
+      resp = @runner.authenticated_call(shipment: shipment, serializer: @syncer.client.shipment_serializer)
+      if resp
+        @cursor += 1
+        return resp
+      end
+    ensure
+      puts resp
+    end
+
+    def try_batch(batch_size=nil)
+      b = [batch_size.to_i, @batch].max
+      b.times do
+        break unless try_one
+      end
+    end
+  end
+end

data/lib/solidus_bactracs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SolidusBactracs
-  VERSION = '3.1.0'
+  VERSION = '3.2.0'
 end

data/lib/tasks/solidus_bactracs.rake

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+namespace :solidus_bactracs do
+  desc 'Run export jobs to send shipments to Bactracs'
+  task export: :environment do
+    SolidusBactracs::Api::ScheduleShipmentSyncsJob.perform_later
+  end
+
+  desc "Verify bactracs RMA creation"
+  task verify_bactracs_sync: :environment do
+    Spree::Shipment.not_bactracs_sync_verified.find_each(batch_size: 200) do |shipment|
+      # set shipment sync at and bactracs_sync_verified_at attributes by verifying RMA
+      shipment.verify_bactracs_sync!
+    end
+  end
+end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: solidus_bactracs
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Zeryab Ali
 - Zachary Jones
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-01 00:00:00.000000000 Z
+date: 2022-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -115,7 +115,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email: techbilling@suvie.com
 executables: []
 extensions: []
@@ -155,6 +155,7 @@ files:
 - app/queries/solidus_bactracs/shipment/exportable_query.rb
 - app/queries/solidus_bactracs/shipment/pending_api_sync_query.rb
 - app/views/spree/bactracs/export.xml.builder
+- app/workers/verify_bactracs_sync_worker.rb
 - bin/console
 - bin/rails
 - bin/rails-engine
@@ -165,9 +166,11 @@ files:
 - config/locales/en.yml
 - config/routes.rb
 - db/migrate/20210220093010_add_bactracs_api_sync_fields.rb
+- db/migrate/20220701000001_bactracs_typo_correction.rb
+- db/migrate/20220704144504_rename_bactracs_columns_in_spree_shipment.rb
+- lib/bactracs_service.rb
 - lib/generators/solidus_bactracs/install/install_generator.rb
 - lib/generators/solidus_bactracs/install/templates/initializer.rb
-- lib/solidus_backtracs/version.rb
 - lib/solidus_bactracs.rb
 - lib/solidus_bactracs/api/batch_syncer.rb
 - lib/solidus_bactracs/api/client.rb
@@ -177,11 +180,13 @@ files:
 - lib/solidus_bactracs/api/shipment_serializer.rb
 - lib/solidus_bactracs/api/threshold_verifier.rb
 - lib/solidus_bactracs/configuration.rb
+- lib/solidus_bactracs/console_harness.rb
 - lib/solidus_bactracs/engine.rb
 - lib/solidus_bactracs/errors.rb
 - lib/solidus_bactracs/shipment_notice.rb
 - lib/solidus_bactracs/testing_support/factories.rb
 - lib/solidus_bactracs/version.rb
+- lib/tasks/solidus_bactracs.rake
 - solidus_bactracs.gemspec
 - spec/controllers/spree/bactracs_controller_spec.rb
 - spec/fixtures/bactracs_xml_schema.xsd
@@ -213,7 +218,7 @@ metadata:
   source_code_uri: https://github.com/suvie-eng/solidus_bactracs/
   changelog_uri: https://github.com/suvie-eng/solidus_bactracs/blob/master/CHANGELOG.md
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -229,7 +234,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.4
-signing_key: 
+signing_key:
 specification_version: 4
 summary: A Solidus extension for integrating the Bactracs API.
 test_files:

data/lib/solidus_backtracs/version.rb

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