ups 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8bbb686432266ab1abecf098744a453d0c1747eb51a40629335c6f7ce083475b
-  data.tar.gz: fbe3f140f3c29831f21cc340fe272916d26efc9365183f01cdd6dceb8c06ea58
+  metadata.gz: d62618324bb4d42efc9229e45d8aadf4b797d57f56849bb4687d8506797b74e5
+  data.tar.gz: bf5f9c912258731ecafaa692ac373a53b41ac762bcde6bdf4f71bf9777f320c7
 SHA512:
-  metadata.gz: 791b16e26b54f1e9f0a02353d73d0a4b84c89f459461334d20292341e4ba707ab569a249e617cdc5eaa69f99964177b358ea2f13bd58295998f5627dec871292
-  data.tar.gz: 8483e06fa271c7a514b0d073a9763011f960b7df38d08843ff9d2760dc5fa457b9d5286b429718e39a082ca0002f232a0f63aa72ee0fbbadb7ca847a55c00460
+  metadata.gz: 03237a9fb524ca471fc2d224edff0a8fda897f940d3eabc2d1d23f47ecf93a00e271b457946fdfa5302887fb17c6fb7e5b3b1d21ef080fd1f2a008c07d4e5dba
+  data.tar.gz: 9ac07d0a408b817931f3fd46112f7871a56f207f2b2430bf727e804170e853459397cfce8eaf75dcedd59de6afc335d2d92ce90378aefa656d9e66b0024715a0

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,
@@ -68,7 +72,7 @@ rating_service = Ups::Rating.new(Ups.client)
 rates = rating_service.get_rates(rate_request)
 
 rates.each do |rate|
-  puts "#{rate[:service_name]}: $#{rate[:total_cost]} #{rate[:currency]}"
+  puts "#{rate[:service_name]}: $#{rate[:total]} #{rate[:currency]}"
 end
 ```
 
@@ -90,8 +94,8 @@ shipping_service = Ups::Shipping.new(Ups.client)
 result = shipping_service.create_shipment(ship_request)
 
 puts "Tracking Number: #{result[:tracking_number]}"
-puts "Total Cost: $#{result[:total_cost]} #{result[:currency]}"
-puts "Label URL: #{result[:label_url]}"
+puts "Total Cost: $#{result[:total]} #{result[:currency]}"
+puts "Label: #{result[:label]}"
 ```
 
 ## Service Codes

data/lib/ups/models/ship_request.rb

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

data/lib/ups/rating.rb

@@ -48,12 +48,7 @@ module Ups
                 }
               }
             },
-#            ShipmentServiceOptions: {
-#              DeliveryConfirmation: {
-#                DCISType: rate_request.dcis_type || 0 # "2" = Signature Required
-#              }
-#            },
-            Package: rate_request.packages.map { |pkg| package_hash(pkg) },
+            Package: rate_request.packages.map { |pkg| package_hash(pkg, dcis_type: rate_request.dcis_type) },
             Service: {
               Code: rate_request.service_code || "03"
             }
@@ -72,8 +67,8 @@ module Ups
       }
     end
 
-    def package_hash(package)
-      {
+    def package_hash(package, dcis_type: 3)
+      base = {
         PackagingType: {
           Code: package.packaging_type || "02"
         },
@@ -98,6 +93,18 @@ module Ups
           }
         }
       }
+      base.deep_merge!(signature_required(dcis_type)) if [2,3].include?(dcis_type.to_i)
+      base
+    end
+
+    def signature_required(type = '3')
+      {
+        PackageServiceOptions: {
+          DeliveryConfirmation: {
+            DCISType: type.to_s
+          }
+        }
+      }
     end
 
     def parse_rate_response(response)

data/lib/ups/shipping.rb

@@ -66,7 +66,7 @@ module Ups
               Code: ship_request.service_code || "02",
               Description: "Service Code"
             },
-            Package: ship_request.packages.map { |pkg| package_hash(pkg) }
+            Package: ship_request.packages.map { |pkg| package_hash(pkg, dcis_type: ship_request.dcis_type) }
           },
           LabelSpecification: {
             LabelImageFormat: {
@@ -88,8 +88,8 @@ module Ups
       }
     end
 
-    def package_hash(package)
-      {
+    def package_hash(package, dcis_type: 3)
+      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.value
+          }
+        },
+        InsuredValue: {
+          CurrencyCode: "USD",
+          MonetaryValue: package.value
+        }
+      }
+      base.deep_merge!(signature_required(dcis_type)) if [2,3].include?(dcis_type.to_i)
+      base
+    end
+
+    def signature_required(type = '3')
+      {
+        PackageServiceOptions: {
+          DeliveryConfirmation: {
+            DCISType: type.to_s
+          }
         }
       }
     end
@@ -118,7 +140,7 @@ module Ups
           tracking_number: results['ShipmentIdentificationNumber'],
           label: results['PackageResults'][0]['ShippingLabel']['GraphicImage'],
           extension: results['PackageResults'][0]['ShippingLabel']['ImageFormat']['Code'],
-          cost: results['ShipmentCharges']['TotalCharges']['MonetaryValue'].to_f,
+          total: results['ShipmentCharges']['TotalCharges']['MonetaryValue'].to_f,
           currency: results['ShipmentCharges']['TotalCharges']['CurrencyCode'],
           data: response.as_json(except: ["GraphicImage", "HTMLImage"]),
           alerts: response['ShipmentResponse']['Response']['Alert']&.map{|s| s['Description'] }

data/lib/ups/version.rb

@@ -1,4 +1,4 @@
 module Ups
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ups
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - JD Warren