solidus_bactracs 3.1.1 → 3.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce11ad638edb1316dea6b8a6865e655bc39329d56ac6ba954171b006e4c12904
-  data.tar.gz: 20e2c5829661277c6d99e9adb95a2e8653e12a5963c790de276690e2cca10bfb
+  metadata.gz: 57358a842b15f8f01b4ef06b6e665d3da2d1e71c2cb9d0c963a53cf790329431
+  data.tar.gz: 50ec2b26961894f93f194047564ffc09df92337fcbcc2ef924d241dda879bb84
 SHA512:
-  metadata.gz: a91017ed15087d8a88f02d1a8efab5cbf839792664f3bc8dc9bf3a826ef931c208b1da963cb755839c6e3742d557ef5e0d8805dc022f607313b0178dd15738de
-  data.tar.gz: 7dc6cff4a8e9feed90087cea6aa4838e4db707218bc711f67d5f752aef977e6c060474df36b7d3b4c84e143509202d4303a4f580370103ea7804cc0a73b7fdef
+  metadata.gz: 61b6d5945b5bea4a67e85b44bb2cd719740466d0737599d1e77bb4aad035ce488e7cbb0df89ddedf1307d958dff901f01d0c9f66bb2006d4df06deb62836473e
+  data.tar.gz: 9db512ac8470045e746d5afada89e2634845d175c4bbb45aca29cb6196d8199c5e65aeef0123cd0e5b75e1cfb6b483cbc0e186143e26fedfc5ceadb81b19089d

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/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

@@ -2,7 +2,8 @@
 
 class BactracsTypoCorrection < ActiveRecord::Migration[5.2]
   def change
-    if ActiveRecord::Base.connection.column_exists?(:spree_shipments, :backtracs_synced_at)
+    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

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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SolidusBactracs
-  VERSION = '3.1.1'
+  VERSION = '3.1.2'
 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.1
+  version: 3.1.2
 platform: ruby
 authors:
 - Zeryab Ali
 - Zachary Jones
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-01 00:00:00.000000000 Z
+date: 2022-07-26 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
@@ -166,6 +167,8 @@ files:
 - 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
@@ -183,6 +186,7 @@ files:
 - 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
@@ -214,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
@@ -230,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: