solidus_bactracs 3.0.0 → 3.1.2

data/spec/queries/{solidus_backtracs → solidus_bactracs}/shipment/pending_api_sync_query_spec.rb

@@ -1,4 +1,4 @@
-RSpec.describe SolidusBacktracs::Shipment::PendingApiSyncQuery do
+RSpec.describe SolidusBactracs::Shipment::PendingApiSyncQuery do
   describe '.apply' do
     context 'when dealing with shipments that were never synced' do
       it 'returns the shipments that are within the threshold' do
@@ -19,15 +19,15 @@ RSpec.describe SolidusBacktracs::Shipment::PendingApiSyncQuery do
         stub_configuration(api_sync_threshold: 10.minutes)
         shipment = create(:order_ready_to_ship).shipments.first.tap do |s|
           s.order.update_columns(updated_at: 7.minutes.ago)
-          s.update_columns(backtracs_synced_at: 8.minutes.ago)
+          s.update_columns(bactracs_synced_at: 8.minutes.ago)
         end
         create(:order_ready_to_ship).shipments.first.tap do |s|
           s.order.update_columns(updated_at: 9.minutes.ago)
-          s.update_columns(backtracs_synced_at: 8.minutes.ago)
+          s.update_columns(bactracs_synced_at: 8.minutes.ago)
         end
         create(:order_ready_to_ship).shipments.first.tap do |s|
           s.order.update_columns(updated_at: 11.minutes.ago)
-          s.update_columns(backtracs_synced_at: 10.minutes.ago)
+          s.update_columns(bactracs_synced_at: 10.minutes.ago)
         end
 
         expect(described_class.apply(Spree::Shipment.all)).to match_array([shipment])

data/spec/spec_helper.rb

@@ -18,8 +18,8 @@ require 'solidus_dev_support/rspec/feature_helper'
 # in spec/support/ and its subdirectories.
 Dir["#{__dir__}/support/**/*.rb"].sort.each { |f| require f }
 
-# Requires factories defined in lib/solidus_backtracs/testing_support/factories.rb
-SolidusDevSupport::TestingSupport::Factories.load_for(SolidusBacktracs::Engine)
+# Requires factories defined in lib/solidus_bactracs/testing_support/factories.rb
+SolidusDevSupport::TestingSupport::Factories.load_for(SolidusBactracs::Engine)
 
 RSpec.configure do |config|
   config.infer_spec_type_from_file_location!

data/spec/support/configuration_helper.rb

@@ -1,6 +1,6 @@
 module ConfigurationHelper
   def stub_configuration(options)
-    allow(SolidusBacktracs.configuration).to receive_messages(options)
+    allow(SolidusBactracs.configuration).to receive_messages(options)
 
     if options[:capture_at_notification]
       stub_spree_preferences(require_payment_to_ship: false)

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: solidus_bactracs
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.2
 platform: ruby
 authors:
 - Zeryab Ali
 - Zachary Jones
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-30 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: []
@@ -124,31 +124,38 @@ files:
 - ".bundle/config"
 - ".circleci/config.yml"
 - ".gem_release.yml"
+- ".github/CODEOWNERS"
+- ".github/PULL_REQUEST_TEMPLATE/pull_request_template.md"
 - ".github/stale.yml"
+- ".github/workflows/release.yml"
 - ".github_changelog_generator"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
+- ".ruby-version"
+- ".tool-versions"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
+- PULL_REQUEST_TEMPLATE.md
 - README.md
 - Rakefile
-- app/assets/javascripts/spree/backend/solidus_backtracs.js
-- app/assets/javascripts/spree/frontend/solidus_backtracs.js
-- app/assets/stylesheets/spree/backend/solidus_backtracs.css
-- app/assets/stylesheets/spree/frontend/solidus_backtracs.css
-- app/controllers/spree/backtracs_controller.rb
-- app/decorators/models/solidus_backtracs/spree/shipment_decorator.rb
-- app/helpers/solidus_backtracs/export_helper.rb
-- app/jobs/solidus_backtracs/api/schedule_shipment_syncs_job.rb
-- app/jobs/solidus_backtracs/api/sync_shipment_job.rb
-- app/jobs/solidus_backtracs/api/sync_shipments_job.rb
-- app/queries/solidus_backtracs/shipment/between_query.rb
-- app/queries/solidus_backtracs/shipment/exportable_query.rb
-- app/queries/solidus_backtracs/shipment/pending_api_sync_query.rb
-- app/views/spree/backtracs/export.xml.builder
+- app/assets/javascripts/spree/backend/solidus_bactracs.js
+- app/assets/javascripts/spree/frontend/solidus_bactracs.js
+- app/assets/stylesheets/spree/backend/solidus_bactracs.css
+- app/assets/stylesheets/spree/frontend/solidus_bactracs.css
+- app/controllers/spree/bactracs_controller.rb
+- app/decorators/models/solidus_bactracs/spree/shipment_decorator.rb
+- app/helpers/solidus_bactracs/export_helper.rb
+- app/jobs/solidus_bactracs/api/schedule_shipment_syncs_job.rb
+- app/jobs/solidus_bactracs/api/sync_shipment_job.rb
+- app/jobs/solidus_bactracs/api/sync_shipments_job.rb
+- app/queries/solidus_bactracs/shipment/between_query.rb
+- 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
@@ -158,41 +165,46 @@ files:
 - bin/setup
 - config/locales/en.yml
 - config/routes.rb
-- db/migrate/20210220093010_add_backtracs_api_sync_fields.rb
-- lib/generators/solidus_backtracs/install/install_generator.rb
-- lib/generators/solidus_backtracs/install/templates/initializer.rb
-- lib/solidus_backtracs.rb
-- lib/solidus_backtracs/api/batch_syncer.rb
-- lib/solidus_backtracs/api/client.rb
-- lib/solidus_backtracs/api/rate_limited_error.rb
-- lib/solidus_backtracs/api/request_error.rb
-- lib/solidus_backtracs/api/request_runner.rb
-- lib/solidus_backtracs/api/shipment_serializer.rb
-- lib/solidus_backtracs/api/threshold_verifier.rb
-- lib/solidus_backtracs/configuration.rb
-- lib/solidus_backtracs/engine.rb
-- lib/solidus_backtracs/errors.rb
-- lib/solidus_backtracs/shipment_notice.rb
-- lib/solidus_backtracs/testing_support/factories.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
+- lib/solidus_bactracs/api/rate_limited_error.rb
+- lib/solidus_bactracs/api/request_error.rb
+- lib/solidus_bactracs/api/request_runner.rb
+- lib/solidus_bactracs/api/shipment_serializer.rb
+- lib/solidus_bactracs/api/threshold_verifier.rb
+- lib/solidus_bactracs/configuration.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/backtracs_controller_spec.rb
-- spec/fixtures/backtracs_xml_schema.xsd
-- spec/jobs/solidus_backtracs/api/schedule_shipment_syncs_job_spec.rb
-- spec/jobs/solidus_backtracs/api/sync_shipments_job_spec.rb
-- spec/lib/solidus_backtracs/api/batch_syncer_spec.rb
-- spec/lib/solidus_backtracs/api/client_spec.rb
-- spec/lib/solidus_backtracs/api/rate_limited_error_spec.rb
-- spec/lib/solidus_backtracs/api/request_error_spec.rb
-- spec/lib/solidus_backtracs/api/request_runner_spec.rb
-- spec/lib/solidus_backtracs/api/shipment_serializer_spec.rb
-- spec/lib/solidus_backtracs/api/threshold_verifier_spec.rb
-- spec/lib/solidus_backtracs/shipment_notice_spec.rb
-- spec/lib/solidus_backtracs_spec.rb
+- spec/controllers/spree/bactracs_controller_spec.rb
+- spec/fixtures/bactracs_xml_schema.xsd
+- spec/jobs/solidus_bactracs/api/schedule_shipment_syncs_job_spec.rb
+- spec/jobs/solidus_bactracs/api/sync_shipments_job_spec.rb
+- spec/lib/solidus_bactracs/api/batch_syncer_spec.rb
+- spec/lib/solidus_bactracs/api/client_spec.rb
+- spec/lib/solidus_bactracs/api/rate_limited_error_spec.rb
+- spec/lib/solidus_bactracs/api/request_error_spec.rb
+- spec/lib/solidus_bactracs/api/request_runner_spec.rb
+- spec/lib/solidus_bactracs/api/shipment_serializer_spec.rb
+- spec/lib/solidus_bactracs/api/threshold_verifier_spec.rb
+- spec/lib/solidus_bactracs/shipment_notice_spec.rb
+- spec/lib/solidus_bactracs_spec.rb
 - spec/models/spree/shipment_spec.rb
-- spec/queries/solidus_backtracs/shipment/between_query_spec.rb
-- spec/queries/solidus_backtracs/shipment/exportable_query_spec.rb
-- spec/queries/solidus_backtracs/shipment/pending_api_sync_query_spec.rb
+- spec/queries/solidus_bactracs/shipment/between_query_spec.rb
+- spec/queries/solidus_bactracs/shipment/exportable_query_spec.rb
+- spec/queries/solidus_bactracs/shipment/pending_api_sync_query_spec.rb
 - spec/spec_helper.rb
 - spec/support/configuration_helper.rb
 - spec/support/controllers.rb
@@ -205,7 +217,8 @@ metadata:
   homepage_uri: https://github.com/suvie-eng/solidus_bactracs
   source_code_uri: https://github.com/suvie-eng/solidus_bactracs/
   changelog_uri: https://github.com/suvie-eng/solidus_bactracs/blob/master/CHANGELOG.md
-post_install_message: 
+  allowed_push_host: https://rubygems.org
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -221,27 +234,27 @@ 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:
-- spec/controllers/spree/backtracs_controller_spec.rb
-- spec/fixtures/backtracs_xml_schema.xsd
-- spec/jobs/solidus_backtracs/api/schedule_shipment_syncs_job_spec.rb
-- spec/jobs/solidus_backtracs/api/sync_shipments_job_spec.rb
-- spec/lib/solidus_backtracs/api/batch_syncer_spec.rb
-- spec/lib/solidus_backtracs/api/client_spec.rb
-- spec/lib/solidus_backtracs/api/rate_limited_error_spec.rb
-- spec/lib/solidus_backtracs/api/request_error_spec.rb
-- spec/lib/solidus_backtracs/api/request_runner_spec.rb
-- spec/lib/solidus_backtracs/api/shipment_serializer_spec.rb
-- spec/lib/solidus_backtracs/api/threshold_verifier_spec.rb
-- spec/lib/solidus_backtracs/shipment_notice_spec.rb
-- spec/lib/solidus_backtracs_spec.rb
+- spec/controllers/spree/bactracs_controller_spec.rb
+- spec/fixtures/bactracs_xml_schema.xsd
+- spec/jobs/solidus_bactracs/api/schedule_shipment_syncs_job_spec.rb
+- spec/jobs/solidus_bactracs/api/sync_shipments_job_spec.rb
+- spec/lib/solidus_bactracs/api/batch_syncer_spec.rb
+- spec/lib/solidus_bactracs/api/client_spec.rb
+- spec/lib/solidus_bactracs/api/rate_limited_error_spec.rb
+- spec/lib/solidus_bactracs/api/request_error_spec.rb
+- spec/lib/solidus_bactracs/api/request_runner_spec.rb
+- spec/lib/solidus_bactracs/api/shipment_serializer_spec.rb
+- spec/lib/solidus_bactracs/api/threshold_verifier_spec.rb
+- spec/lib/solidus_bactracs/shipment_notice_spec.rb
+- spec/lib/solidus_bactracs_spec.rb
 - spec/models/spree/shipment_spec.rb
-- spec/queries/solidus_backtracs/shipment/between_query_spec.rb
-- spec/queries/solidus_backtracs/shipment/exportable_query_spec.rb
-- spec/queries/solidus_backtracs/shipment/pending_api_sync_query_spec.rb
+- spec/queries/solidus_bactracs/shipment/between_query_spec.rb
+- spec/queries/solidus_bactracs/shipment/exportable_query_spec.rb
+- spec/queries/solidus_bactracs/shipment/pending_api_sync_query_spec.rb
 - spec/spec_helper.rb
 - spec/support/configuration_helper.rb
 - spec/support/controllers.rb

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

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-module SolidusBacktracs
-  module Spree
-    module ShipmentDecorator
-      def self.prepended(base)
-        base.singleton_class.prepend ClassMethods
-      end
-
-      module ClassMethods
-        def exportable
-          ::Spree::Deprecation.warn <<~DEPRECATION
-            `Spree::Shipment.exportable` is deprecated and will be removed in a future version
-            of solidus_backtracs. Please use `SolidusBacktracs::Shipment::ExportableQuery.apply`.
-          DEPRECATION
-
-          SolidusBacktracs::Shipment::ExportableQuery.apply(self)
-        end
-
-        def between(from, to)
-          ::Spree::Deprecation.warn <<~DEPRECATION
-            `Spree::Shipment.between` is deprecated and will be removed in a future version
-            of solidus_backtracs. Please use `SolidusBacktracs::Shipment::BetweenQuery.apply`.
-          DEPRECATION
-
-          SolidusBacktracs::Shipment::BetweenQuery.apply(self, from: from, to: to)
-        end
-      end
-
-      ::Spree::Shipment.prepend self
-    end
-  end
-end

data/db/migrate/20210220093010_add_backtracs_api_sync_fields.rb

@@ -1,8 +0,0 @@
-# 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 AddBacktracsApiSyncFields < ActiveRecord::Migration[5.2]
-  def change
-    add_column :spree_shipments, :backtracs_synced_at, :datetime
-  end
-end

data/lib/solidus_backtracs/api/request_runner.rb

@@ -1,109 +0,0 @@
-# frozen_string_literal: true
-require "uri"
-require "net/http"
-
-module SolidusBacktracs
-  module Api
-    class RequestRunner
-
-      def initialize
-        @username = SolidusBacktracs.configuration.authentication_username
-        @password = SolidusBacktracs.configuration.authentication_password
-        @api_base = SolidusBacktracs.configuration.api_base
-        @retries  = SolidusBacktracs.configuration.api_retries
-      end
-
-      def authenticated_call(method: nil, path: nil, serializer: nil, shipment: nil, count: 0)
-        if count <= @retries
-          unless @username.present? || @password.present? || @api_base.present?
-            raise "Credentials not defined for Authentication"
-          end
-
-          @response = Rails.cache.fetch("backtracks_cache_key", expires_in: 1.hour, skip_nil: true) do
-            self.call(method: :get, path: "/webservices/user/Authentication.asmx/Login?sUserName=#{@username}&sPassword=#{@password}")
-          end
-
-          raise RequestError.from_response(@response) unless @response # just try again for @retries?
-          authenticted = parse_authentication_response(@response, "Result")
-          raise RequestError.from_response(@response) if authenticted == "false"
-          sguid = parse_authentication_response(@response, "Message")
-
-          if authenticted == 'false'
-            clear_cache
-            raise "User Not Authenticated"
-          else
-            sguid = parse_authentication_response(@response, "Message")
-            params = serializer.call(shipment, sguid)
-
-            rma_response = call(method: :post, path: path, params: params)
-            unless parse_rma_creation_response(rma_response) == 'true'
-              clear_cache
-              count += 1
-              self.authenticated_call(method: :post, path: '/webservices/rma/rmaservice.asmx', serializer: serializer, shipment: shipment, count: count)
-            end
-            shipment_synced(shipment)
-          end
-        else
-          shipment_sync_failed(shipment)
-        end
-      end
-
-      def call(method: nil, path: nil, params: {})
-        doc = {}
-        if params.present?
-          doc = Nokogiri::XML(params.to_s)
-        end
-        response = HTTParty.send(
-          method,
-          URI.join(@api_base, path),
-          body: doc.to_xml,
-          http_proxyaddr: SolidusBacktracs.configuration.proxy_address,
-          http_proxyport: SolidusBacktracs.configuration.proxy_port,
-          http_proxyuser: SolidusBacktracs.configuration.proxy_username,
-          http_proxypass: SolidusBacktracs.configuration.proxy_password,
-          headers: {
-            'Content-Type' => 'text/xml',
-          },
-        )
-
-        case response.code.to_s
-        when /2\d{2}/
-          response
-        when '429'
-          raise RateLimitedError.from_response(response)
-        else
-          raise RequestError.from_response(response)
-        end
-      end
-
-      def clear_cache
-        Rails.cache.delete('backtracks_cache_key')
-        @response = nil
-      end
-
-      def parse_authentication_response(response, type)
-        response.dig("AuthenticationResponse", type)
-      end
-
-      def parse_rma_creation_response(response)
-        response.dig("Envelope", "Body", "CreateNewResponse", "CreateNewResult", "Result")
-      end
-
-      def shipment_synced(shipment)
-        shipment.update_column(:backtracs_synced_at, Time.zone.now)
-
-        ::Spree::Event.fire(
-          'solidus_backtracs.api.sync_completed',
-          shipment: shipment
-        )
-      end
-
-      def shipment_sync_failed(shipment)
-        ::Spree::Event.fire(
-          'solidus_backtracs.api.sync_failed',
-          shipment: shipment
-        )
-      end
-    end
-  end
-end

data/lib/solidus_backtracs.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-require 'httparty'
-
-require 'solidus_backtracs/api/batch_syncer'
-require 'solidus_backtracs/api/request_runner'
-require 'solidus_backtracs/api/client'
-require 'solidus_backtracs/api/request_error'
-require 'solidus_backtracs/api/rate_limited_error'
-require 'solidus_backtracs/api/shipment_serializer'
-require 'solidus_backtracs/api/threshold_verifier'
-require 'solidus_backtracs/configuration'
-require 'solidus_backtracs/errors'
-require 'solidus_backtracs/shipment_notice'
-require 'solidus_backtracs/version'
-require 'solidus_backtracs/engine'

data/spec/lib/solidus_backtracs_spec.rb

@@ -1,9 +0,0 @@
-require 'spec_helper'
-
-RSpec.describe SolidusBacktracs do
-  describe 'VERSION' do
-    it 'is defined' do
-      expect(SolidusBacktracs::VERSION).to be_present
-    end
-  end
-end