solidus_bactracs 3.3.0 → 3.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0013aa0b04dbd61b4b6dc02af169425be44089ecb2cc19d2ec246ce81cb9ce2d
-  data.tar.gz: d9e6e69eb3ddd8c81c68e39fc3b3eb8b5277c183a45e1d96e941778472beaf8b
+  metadata.gz: c253cf9eff07138bbc398a46d8cb03d0d30af1c0d7000e91554135cc15a8fbd9
+  data.tar.gz: 3683cd659eef9d33c6f487b8611876cb756697778ef7fd1856c752a355cbf2a9
 SHA512:
-  metadata.gz: a69d203aa13627e8719cd1501cc4d807a9ae20ed8c045e038592ee7448c675376d43517127f9640037ea069128db27be8d6878f388102d76a839f2727f1ceec0
-  data.tar.gz: 80b5f4ad0db3b8c7e7fdc280cf36f825bc996bd8b8c49ebb7bb28d5e71fc272a1c5d1724503702773f0d7944d4cc4cadccac7f47489f6054a5ce47a8d001171c
+  metadata.gz: e5fffca275370de98ca4f38fa53b144275c0d37a5c09f1de2445ac8ce0586d2a8ebd4f8d6eb714fdca045c9dab16a2a68b09420c4905d49b2995408743a959bb
+  data.tar.gz: 45d5a089947e1c9ebb741066bc3d13ba165bbc42b027bfb58d9c2d6d1cb3aa496d96d81e0196d479328fd6d78883b8f966cb08210c02429f711d398825757573

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 3.3.0
+Exposed a config var that holds an evaluator for the type of RMA being sent through bactracs.  `config.evaluate_rma_type` . You should overwrite this with your own means of determining the RMA type for a given shipment.
+
 ## 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.
 

data/README.md

@@ -98,9 +98,19 @@ implementation, but the extension abstracts it all away for you.
 
 #### API integration: Configuration
 
-In order to enable the API integration, make sure to configure the relevant section of the
-configuration initializer. At the very least, the integration needs to know your API credentials
-and store ID, but there are additional options you can configure — just look at the initializer!
+In order to enable the API integration, make sure to configure the relevant section of the configuration initializer. At the very least, the integration needs to know your API credentials and store ID, but there are additional options you can configure — just look at the initializer!
+
+##### RMA Type
+
+This gem exposes a config var that holds an evaluator for the type of RMA being sent through bactracs.  E.G. `1`, `2`, `W`, etc.
+
+```
+config.evaluate_rma_type = proc do |shipment|
+ "W"
+end
+```
+
+You should overwrite this with your own means of determining the RMA type for a given shipment.
 
 #### API integration: Usage
 
@@ -146,7 +156,7 @@ This is a problem that is faced by all recurring jobs. The solution is two-fold:
 
 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 
+Create a new harness in the console via
 
 ```ruby
 h = SolidusBactracs::ConsoleHarness.new

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

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

data/lib/solidus_bactracs/api/shipment_serializer.rb

@@ -13,6 +13,7 @@ module SolidusBactracs
       def call(sguid: nil)
         order = @shipment.order
         user = @shipment.user
+        rma_type = safe_rma_type
 
         xml = Builder::XmlMarkup.new
         xml.instruct!(:xml, :encoding => "UTF-8")
@@ -23,7 +24,7 @@ module SolidusBactracs
               xml.sGuid                       sguid
               xml.NewRMA {
                 xml.RMANumber                 @shipment.number
-                xml.RMATypeName               @shipment.rma_type.present? ? @shipment.rma_type : @config.evaluate_rma_type
+                xml.RMATypeName               rma_type
                 xml.RMASubTypeName
                 xml.CustomerRef
                 xml.InboundShippingPriority
@@ -96,6 +97,11 @@ module SolidusBactracs
         }
       end
 
+      def safe_rma_type
+        rma_type = @shipment.rma_type if (@shipment.respond_to?(:rma_type) && @shipment.rma_type.present?)
+        rma_type ||= @config.evaluate_rma_type.call(@shipment)
+      end
+
       def find_sku_variant(variant)
         @config.sku_map[variant.sku].present? ? @config.sku_map[variant.sku] : variant.sku
       end

data/lib/solidus_bactracs/console_harness.rb

@@ -9,7 +9,7 @@ module SolidusBactracs
       @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
+      @shipments_elegible = SolidusBactracs::Api::ScheduleShipmentSyncsJob.new.all_eligible_shipments
       @cursor = 0
       @batch = 4
     end
@@ -18,11 +18,11 @@ module SolidusBactracs
       @shipments = SolidusBactracs::Api::ScheduleShipmentSyncsJob.new.query_shipments
     end
 
-    def shipment(id)
+    def has_shipment?(id)
       @shipments.find_by(id: id)
     end
 
-    def shipment_number(ship_number)
+    def has_shipment_number?(ship_number)
       @shipments.find_by(number: ship_number)
     end
 

data/lib/solidus_bactracs/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: solidus_bactracs
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.3.2
 platform: ruby
 authors:
 - Zeryab Ali
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-16 00:00:00.000000000 Z
+date: 2022-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty