friendly_shipping 0.10.2 → 0.10.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1947b72c921f913cd7e75eaf62c82e9453caa017eedd05f3bef555d202d28a9
-  data.tar.gz: 757e4ae6beaf55c89ad726ecf1c7b0609603b033908c7975ba47c436d059f306
+  metadata.gz: 1ea046468f58d0fcb1b73a5a412d1196ba22b5196772bdc09167f085bdad718e
+  data.tar.gz: cdb2ae78f0a244358795e3a695cbb837c5199b16e1b1ea62d35fc3c2db7593ed
 SHA512:
-  metadata.gz: b0091e092439cb74e7d1f34d6342dedbcf15e8d6e451bea5782eda11129df3c94dcb224bb6a319ba859545f090899f0c51f8beb16dbd0de0a91078d57be5521d
-  data.tar.gz: 40d1c62b73125f662061e22c7100d9fa9aa0ec061b18b13066bc3f171e4b60c499ab57aecb77e1a79dc693849ba50fc3391e843bc7626dee6b5563f35039450c
+  metadata.gz: ab58d07654f00ad218e80582bf9ebdc242074e9e10d062d6d89dea04125b71785c05e496800da635805be221b61b544dad233258e78cfe2b633590788b401930
+  data.tar.gz: ccfae1ca937d3f1c93223a40d8a0193943720be569403565795a70cf7457cd010950d4dfef271bfa5e52145c05cffd004f307566485874baa30c864189fc7e4e

data/.env.test.local.template

@@ -1,6 +1,6 @@
 # .env.test.local.template
 
-# When recording VCR cassettes for TForce and UPS JSON service classes, this env var
-# should be set to a valid token for either service.
+# When recording VCR cassettes for TForce, UPS, and USPS Ship service classes, this env var
+# should be set to a valid token for the service being tested.
 
 ACCESS_TOKEN=secret_token

data/CHANGELOG.md

@@ -4,6 +4,37 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.10.3] - 2025
+- Add USPS Ship city/state lookup request (#279)
+
+## [0.10.2] - 2025
+- Remove legacy UPS integration (#275)
+- Add observer gem to Gemfile (#276)
+- Remove legacy USPS integration (#277)
+- Add UPS surcharge code 495 to money hash parser (#278)
+
+## [0.10.1] - 2025-01-03
+- Remove Inflections file (#274)
+
+## [0.10.0] - 2025-01-03
+- Bump version to 0.9.0 and log changes (#257)
+- USPS Ship: Fix machinable criteria (#258)
+- Add debug param to ShipEngine labels method (#259)
+- Truncate R+L BOL address lines to 30 chars (#260)
+- Fix UPS json rate details, add specs (#261)
+- Fix ups label cost breakdown (#262)
+- Remove TForce company name sanitization (#263)
+- Update payload location of NegotiatedRatesIndicator within UPS JSON (#264)
+- Attach cost breakdown to R+L rates data (#265)
+- Expand TForce cost breakdown detail (#266)
+- Never send empty UPS ShipmentRatingOptions (#267)
+- Bump required Ruby version to 3.1 or greater (#269)
+- Add city/state lookup endpoint for UPS JSON API (#268)
+- Extract AccessToken parent class (#270)
+- Return errors in ApiFailures for USPS timings, UPS json parsing (#271)
+- Deprecate ApiFailure class (#272)
+- Use Zeitwerk to load FriendlyShipping (#273)
+
 ## [0.9.0] - 2024-05-02
 - Implement R&L service with rates and timings (#177)
 - Add R&L Freight API call to create BOL and schedule pickup (#178)

data/lib/friendly_shipping/services/usps_ship/machinable_package.rb

@@ -29,13 +29,13 @@ module FriendlyShipping
 
         # @return [Boolean]
         def machinable?
-          at_least_minimum && at_most_maximum
+          at_least_minimum? && at_most_maximum?
         end
 
         private
 
         # @return [Boolean]
-        def at_least_minimum
+        def at_least_minimum?
           package.length >= MIN_LENGTH &&
             package.width >= MIN_WIDTH &&
             package.height >= MIN_HEIGHT &&
@@ -43,7 +43,7 @@ module FriendlyShipping
         end
 
         # @return [Boolean]
-        def at_most_maximum
+        def at_most_maximum?
           package.length <= MAX_LENGTH &&
             package.width <= MAX_WIDTH &&
             package.height <= MAX_HEIGHT &&

data/lib/friendly_shipping/services/usps_ship/parse_city_state_response.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module FriendlyShipping
+  module Services
+    class USPSShip
+      class ParseCityStateResponse
+        extend Dry::Monads::Result::Mixin
+        USA = Carmen::Country.coded("USA")
+
+        class << self
+          # Parse a city/state response.
+          #
+          # @param request [Request] the request that was used to obtain this response
+          # @param response [Response] the response that USPS returned
+          # @return [Success<ApiResult<Physical::Location>>, Failure<ApiResult<String>>]
+          def call(request:, response:)
+            city_state = JSON.parse(response.body)
+
+            if city_state['error']
+              failure(
+                api_error("Error: #{city_state.dig('error', 'message')}"),
+                request,
+                response
+              )
+            else
+              success(
+                Physical::Location.new(
+                  city: city_state['city'],
+                  region: city_state['state'],
+                  zip: city_state['ZIPCode'],
+                  country: USA
+                ),
+                request,
+                response
+              )
+            end
+          rescue JSON::ParserError => e
+            failure(e, request, response)
+          end
+
+          # @param location [Physical::Location]
+          # @param request [Request]
+          # @param response [Response]
+          # @return [Success<ApiResult<Physical::Location>>]
+          def success(location, request, response)
+            Success(
+              ApiResult.new(
+                location,
+                original_request: request,
+                original_response: response
+              )
+            )
+          end
+
+          # @param error [JSON::ParserError, FriendlyShipping::ApiError]
+          # @param request [Request]
+          # @param response [Response]
+          # @return [Failure<ApiResult>]
+          def failure(error, request, response)
+            Failure(
+              ApiResult.new(
+                error,
+                original_request: request,
+                original_response: response
+              )
+            )
+          end
+
+          private
+
+          def api_error(message)
+            FriendlyShipping::ApiError.new(nil, message)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/friendly_shipping/services/usps_ship.rb

@@ -32,7 +32,8 @@ module FriendlyShipping
       RESOURCES = {
         token: 'oauth2/v3/token',
         rates: 'prices/v3/base-rates/search',
-        timings: 'service-standards/v3/estimates'
+        timings: 'service-standards/v3/estimates',
+        city_state: 'addresses/v3/city-state'
       }.freeze
 
       # @param access_token [AccessToken] the access token
@@ -161,6 +162,31 @@ module FriendlyShipping
         end
       end
 
+      # Get city and state for given ZIP code.
+      # @see https://developer.usps.com/addressesv3#tag/Resources/operation/get-city-state API documentation
+      #
+      # @param location [Physical::Location] the location with ZIP code we want to complete
+      # @return [Result<ApiResult<Array<Timing>>>] the {Timing}s wrapped in an {ApiResult} object
+      # @return [Result<ApiResult<Physical::Location>>] The response data from USPS encoded in a
+      #   `Physical::Location` object. Country, City and ZIP code will be set, everything else nil.
+      def city_state(location, debug: false)
+        request = FriendlyShipping::Request.new(
+          url: "#{BASE_URL}/#{RESOURCES[:city_state]}?ZIPCode=#{location.zip}",
+          http_method: "GET",
+          debug: debug,
+          headers: {
+            Accept: "application/json",
+            Authorization: "Bearer #{access_token.raw_token}"
+          }
+        )
+
+        client.get(request).bind do |response|
+          ParseCityStateResponse.call(response: response, request: request)
+        end
+      end
+
+      alias_method :city_state_lookup, :city_state
+
       private
 
       # @param api [Symbol]

data/lib/friendly_shipping/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FriendlyShipping
-  VERSION = "0.10.2"
+  VERSION = "0.10.3"
 end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: friendly_shipping
 version: !ruby/object:Gem::Version
-  version: 0.10.2
+  version: 0.10.3
 platform: ruby
 authors:
 - Martin Meyerhoff
 - Matthew Bass
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-05-27 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-monads
@@ -304,6 +303,7 @@ files:
 - lib/friendly_shipping/services/usps_ship/access_token.rb
 - lib/friendly_shipping/services/usps_ship/api_error.rb
 - lib/friendly_shipping/services/usps_ship/machinable_package.rb
+- lib/friendly_shipping/services/usps_ship/parse_city_state_response.rb
 - lib/friendly_shipping/services/usps_ship/parse_rate_estimates_response.rb
 - lib/friendly_shipping/services/usps_ship/parse_timings_response.rb
 - lib/friendly_shipping/services/usps_ship/rate_estimate_options.rb
@@ -322,7 +322,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -337,8 +336,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: An integration layer for shipping services
 test_files: []