solidus_bactracs 3.1.1 → 3.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce11ad638edb1316dea6b8a6865e655bc39329d56ac6ba954171b006e4c12904
-  data.tar.gz: 20e2c5829661277c6d99e9adb95a2e8653e12a5963c790de276690e2cca10bfb
+  metadata.gz: 54959bbe94b9360e9d26b71e5e22e5b3e5acaa71416ffa3db198a0e6c9029905
+  data.tar.gz: e38d854370db42b688dd13ce7ec31fe094333de329559435f2ead8b747991f84
 SHA512:
-  metadata.gz: a91017ed15087d8a88f02d1a8efab5cbf839792664f3bc8dc9bf3a826ef931c208b1da963cb755839c6e3742d557ef5e0d8805dc022f607313b0178dd15738de
-  data.tar.gz: 7dc6cff4a8e9feed90087cea6aa4838e4db707218bc711f67d5f752aef977e6c060474df36b7d3b4c84e143509202d4303a4f580370103ea7804cc0a73b7fdef
+  metadata.gz: d5ebef122f00f3c0254251d8e1d0115dd54bad137eb185e7c257b69f06be418eb6a23eb10c1ec70afb7bf9aa4085e6847e42517ba02dca67d289e4b4be6daffa
+  data.tar.gz: 64e323385ba59a13602f41f502ff21686d8b9f30daafa3bcdab11d909d19eb9aab39838c94bcac1a27270aa78ac687c05a243ef34171d1c51cbf962878a75411

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,9 @@ 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
 
@@ -41,29 +43,27 @@ created and updated shipments in your Solidus store.
 ⛔️ This section is outdated and inaccurate.
 
 In order to enable the XML integration, make sure to configure the relevant section of the
-configuration initializer, and configure your ShipStation store accordingly:
+configuration initializer, and configure your Bactracs/Andlor site accordingly:
 
 - **Username**: the username defined in your configuration.
 - **Password**: the password defined in your configuration.
 - **URL to custom page**: `https://yourdomain.com/bactracs.xml`.
 
-You can also configure your ShipStation store to pull the XML feed automatically on a recurring
+You can also configure your Bactracs/Andlor site to pull the XML feed automatically on a recurring
 basis, or manually by clicking the "Refresh stores" button.
 
-There are five shipment states for an order (= shipment) in ShipStation. These states do not
-necessarily align with Solidus, but you can configure ShipStation to create a mapping for your
+There are five shipment states for an order (= shipment) in Bactracs. These states do not
+necessarily align with Solidus, but you can configure Bactracs to create a mapping for your
 specific needs. Here's the recommended mapping:
 
-Bactracs description    | Bactracs status    | Solidus status
+Bactracs RMA Type    | Bactracs status    | Solidus status
 ------------------------|--------------------|---------------
-Awaiting Payment        | `unpaid`           | `pending`
-Awaiting Shipment       | `paid`             | `ready`
-Shipped                 | `shipped`          | `shipped`
-Cancelled               | `cancelled`        | `cancelled`
-On-Hold                 | `on-hold`          | `pending`
+Type 1        | `unpaid`           | `pending`
+Type W       | `paid`             | `ready`
+Type 3                 | `shipped`          | `shipped`
+Type 4               | `cancelled`        | `cancelled`
+
 
-Once you've configured the XML integration in your app and ShipStation, there's nothing else you
-need to do. ShipStation will
 
 #### XML integration: Usage
 
@@ -73,23 +73,23 @@ There's nothing you need to do. Once properly configured, the integration just w
 
 There are a few gotchas you need to be aware of:
 
-- If you change the shipping method of an order in ShipStation, the change will not be reflected in
+- If you change the shipping method of an order in Bactracs, the change will not be reflected in
   Solidus and the tracking link might not work properly.
 - When `bactracs_capture_at_notification` is enabled, any errors during payment capture will
   prevent the update of the shipment's tracking number.
 
 ### API integration
 
-The [API integration](https://www.bactracs.com/docs/api/) works by calling the ShipStation API
+The [API integration](https://www.bactracs.com/docs/api/) works by calling the Bactracs API
 to sync all of your shipments continuously.
 
-Because ShipStation has very low rate limits (i.e., 40 reqs/minute at the time of writing), the
+Because Bactracs has very low rate limits (i.e., 40 reqs/minute at the time of writing), the
 API integration does not send an API request for every single shipment update, as you would expect
 from a traditional API integration.
 
 Instead, a background job runs on a recurring basis and batches together all the shipments that need
-to be created or updated in ShipStation. These shipments are then sent in groups of 100 (by default)
-to ShipStation's [bulk order upsert endpoint](https://www.bactracs.com/docs/api/orders/create-update-multiple-orders/).
+to be created or updated in ShipStation. These shipments are then sent one at a time
+to Bactracs [RMA creation endpoint](https://www.bactracs.com/docs/api/orders/create-update-multiple-orders/).
 
 This allows us to work around Bactracs's rate limit and sync up to 4000 shipments/minute.
 
@@ -144,6 +144,85 @@ This is a problem that is faced by all recurring jobs. The solution is two-fold:
 
 ## Development
 
+Because of the object abstractions in this gem, some find it difficult to test API responses vis the console.  To ease such console work, a 'console harness' was developed that provides several affordances to exploratory development.
+
+Create a new harness in the console via 
+
+```ruby
+h = SolidusBactracs::ConsoleHarness.new
+```
+
+#### `.try_one`
+
+The easiest way to test the API, seeing both the output of the shipment when serialized as a XML SOAP request, and the result from the Bactracs API.
+
+```ruby
+h.try_one
+```
+
+or try a few
+
+```ruby
+h.try_batch(4)
+```
+
+maybe you have a shipment with particular issues, e.g. shipment number `H123456789`
+
+```ruby
+h.shipment_number('H123456789')
+
+h.try_one(h.shipment_number('H123456789'))
+```
+
+`.shipment_number` retries that shipment from the scope of available `h.shipments`.
+
+#### `.refresh`
+
+If that was successful, you may find your list of shipments has one or more shipments that are already synced
+
+```ruby
+h.shipments.size # => 7
+h.refresh
+h.shipments.size # => 6
+```
+
+#### `.cursor`
+
+You can set where in the recordset you want to continue trying from
+
+```
+h.cursor = 5
+h.try_one
+```
+
+#### `.batch`
+
+You can also change the default batch size
+
+```
+h.batch = 10
+h.try_batch
+# output from 10 runs, if not errors occur
+```
+
+#### deep objects
+
+Several deeply-nested objects are exposed for convenience
+
+* runner
+* syncer
+* sync (job)
+
+```
+h.serialize(shipment)
+# see the output of serialization
+
+h.runner.authenticated_call(shipment: h.shipments[0], serializer: h.syncer.client.shipment_serializer)
+```
+
+Remember that you can monkey patch code in the console, to test the improvement the harness or the gem itself.
+
+
 ### Testing the extension
 
 

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

@@ -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/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(a_shipment = nil)
+      puts "trying shipment #{(shipment = a_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.1'
+  VERSION = '3.2.1'
 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.2.1
 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
@@ -166,9 +167,10 @@ 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
 - lib/solidus_bactracs.rb
 - lib/solidus_bactracs/api/batch_syncer.rb
 - lib/solidus_bactracs/api/client.rb
@@ -178,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
@@ -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:

data/lib/solidus_backtracs/version.rb

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