solidus_bactracs 3.1.2 → 3.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57358a842b15f8f01b4ef06b6e665d3da2d1e71c2cb9d0c963a53cf790329431
-  data.tar.gz: 50ec2b26961894f93f194047564ffc09df92337fcbcc2ef924d241dda879bb84
+  metadata.gz: a7cb6d0004776ee5cac5518a2198a429c36247c0ca0b86e80f49d33e540831f0
+  data.tar.gz: b40f84c4a7d9a9922dd1d7ce3137ae34f452a760cd33c6884cf9017955fd75c1
 SHA512:
-  metadata.gz: 61b6d5945b5bea4a67e85b44bb2cd719740466d0737599d1e77bb4aad035ce488e7cbb0df89ddedf1307d958dff901f01d0c9f66bb2006d4df06deb62836473e
-  data.tar.gz: 9db512ac8470045e746d5afada89e2634845d175c4bbb45aca29cb6196d8199c5e65aeef0123cd0e5b75e1cfb6b483cbc0e186143e26fedfc5ceadb81b19089d
+  metadata.gz: d38e0f27a7d2bc598e9f97ed3eb9b96385656bc7553bbd93be0de225075e7d94a2ddd842aa4d095293c37eda0270fa45ad6907f7b21f23d33326895cca696e41
+  data.tar.gz: 8ae9d6ebe1e723a006ffc8c99613c42de004096439d8dce5ea4ef0dabb36972f5d23a25d1118d82d419d08c0391e535b4435febdc7e601c231a111960b7de4be

data/README.md

@@ -31,6 +31,7 @@ used by the extension.
 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
 
 The [XML integration](https://help.bactracs.com/hc/en-us/articles/360025856192-Custom-Store-Development-Guide)
@@ -42,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
 
@@ -74,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.
 
@@ -145,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/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/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,13 +111,13 @@ 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
 
       def shipment_synced(shipment)
-        shipment.update_column(:bactracs_synced_at, Time.zone.now)
+        shipment.update_attribute(:bactracs_synced_at, Time.zone.now)
 
         ::Spree::Event.fire(
           'solidus_bactracs.api.sync_completed',

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.2'
+  VERSION = '3.2.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: solidus_bactracs
 version: !ruby/object:Gem::Version
-  version: 3.1.2
+  version: 3.2.2
 platform: ruby
 authors:
 - Zeryab Ali
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-26 00:00:00.000000000 Z
+date: 2022-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -171,7 +171,6 @@ files:
 - 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
@@ -181,6 +180,7 @@ 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

data/lib/solidus_backtracs/version.rb

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