ups 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31c3c330095fb77264cc9f1d7b63060d72862cc51c76ff0dd71e561319d50477
-  data.tar.gz: bc9d453d32e0d1e4a1a0829629e753dea696166d164ca4eadc6740138bf9c1e9
+  metadata.gz: 6f299fda5bfe8460f0531eb9d9e63415485e2cbbcd765a354987b4fde149c6e3
+  data.tar.gz: 0fac23629a457243445d9dffd7f88fcb30aece68d93c1abce23712295289b121
 SHA512:
-  metadata.gz: 1385e2e5bb4142356857948230f60ee54243003361becb9a85badc8a819d923d981c78004e2a5d42e2074909371ba8aab199e63aee1ceb3c4e92ebfe5b14eee8
-  data.tar.gz: 1a2ebcc5cde6664a6214b24abe58c4fe16d32d48a3c35cd00fdbd0084ec0409b0d362e0f8b13978085f487f21e3ec643c374b2c9ece299825019c0c5759eb967
+  metadata.gz: f1248beb741ad2d3761602dd0f3e24794d480d90d7e35622572eb096b03b86694cfbf49dbc7934687125e19a3a3f2ff57c4042e25510d67e0d04c05468268e4b
+  data.tar.gz: fd11af41e93dcb64e62d44c0602181ad774b805ad7a38c1ac374663d1c283b6c4ee241d2a859b88c1fd25f046a45d75bb37aa87605d420ff29f7c3dc695a06ea

data/README.md

@@ -2,6 +2,8 @@
 
 A Ruby wrapper for the UPS Shipping API that allows you to get shipping rates and create shipping labels.
 
+This gem handles the new OAuth flow in the UPS API that retrieves a JWT first to make requests with. It will allow you to fetch rates for a given package and purchase a shipping label.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -13,6 +15,8 @@ gem 'ups'
 ## Configuration
 
 ```ruby
+# config/initializers/ups.rb
+
 Ups.configure do |config|
   config.client_id = Rails.application.credentials.ups.client_id
   config.client_secret = Rails.application.credentials.ups.client_secret
@@ -47,7 +51,7 @@ ship_to = Ups::Address.new(
 )
 
 # Create package
-package = Ups:Package.new(
+package = Ups::Package.new(
   length: 10,
   width: 8,
   height: 6,

data/lib/ups/models/package.rb

@@ -1,6 +1,6 @@
 module Ups
   class Package
-    attr_accessor :description, :packaging_type, :length, :width, :height, :weight, :dimension_unit, :weight_unit, :value
+    attr_accessor :description, :packaging_type, :length, :width, :height, :weight, :dimension_unit, :weight_unit, :insurance, :delivery_confirmation
 
     def initialize(attrs = {})
       attrs.map{|k,v| send("#{k}=", v) if respond_to?("#{k}=") }

data/lib/ups/models/rate_request.rb

@@ -1,6 +1,6 @@
 module Ups
   class RateRequest
-    attr_accessor :shipper, :ship_to, :ship_from, :packages, :service_code, :reference, :dcis_type
+    attr_accessor :shipper, :ship_to, :ship_from, :packages, :service_code, :reference
 
     def initialize(attrs = {})
       attrs.map{|k, v| send("#{k}=", v) if respond_to?("#{k}=") }

data/lib/ups/rating.rb

@@ -48,11 +48,6 @@ module Ups
                 }
               }
             },
-#            ShipmentServiceOptions: {
-#              DeliveryConfirmation: {
-#                DCISType: rate_request.dcis_type || 0 # "2" = Signature Required
-#              }
-#            },
             Package: rate_request.packages.map { |pkg| package_hash(pkg) },
             Service: {
               Code: rate_request.service_code || "03"
@@ -73,7 +68,7 @@ module Ups
     end
 
     def package_hash(package)
-      {
+      base = {
         PackagingType: {
           Code: package.packaging_type || "02"
         },
@@ -94,7 +89,28 @@ module Ups
         PackageServiceOptions: {
           DeclaredValue: {
             CurrencyCode: "USD",
-            MonetaryValue: package.value
+            MonetaryValue: package.insurance
+          }
+        }
+      }
+      base.deep_merge!(signature_required(package.delivery_confirmation)) if [2,3].include?(package&.delivery_confirmation.to_i)
+      base
+    end
+
+    def signature_required(type)
+      # https://github.com/UPS-API/api-documentation/blob/main/Rating.yaml
+      # DCISType fails if the value is nil, 0, or 1...
+      # but 2 and 3 work as expected. So we need to omit
+      # the key altogether if the value is not one of 2 or 3.
+      # {
+      #   1 => 'Unsupported', # this fails for some reason, so ignore it
+      #   2 => 'Delivery Confirmation Signature Required',
+      #   3 => 'Delivery Confirmation Adult Signature Required'
+      # }
+      {
+        PackageServiceOptions: {
+          DeliveryConfirmation: {
+            DCISType: type.to_s
           }
         }
       }

data/lib/ups/shipping.rb

@@ -89,7 +89,7 @@ module Ups
     end
 
     def package_hash(package)
-      {
+      base = {
         Description: package.description || "Package",
         Packaging: {
           Code: package.packaging_type || "02"
@@ -107,6 +107,28 @@ module Ups
             Code: package.weight_unit || "LBS"
           },
           Weight: package.weight.to_s
+        },
+        PackageServiceOptions: {
+          DeclaredValue: {
+            CurrencyCode: "USD",
+            MonetaryValue: package.insurance
+          }
+        },
+        InsuredValue: {
+          CurrencyCode: "USD",
+          MonetaryValue: package.insurance
+        }
+      }
+      base.deep_merge!(signature_required(package.delivery_confirmation)) if [2,3].include?(package&.delivery_confirmation.to_i)
+      base
+    end
+
+    def signature_required(type = '3')
+      {
+        PackageServiceOptions: {
+          DeliveryConfirmation: {
+            DCISType: type.to_s
+          }
         }
       }
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ups
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - JD Warren
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-06-13 00:00:00.000000000 Z
+date: 2025-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty