dpd_ie_api 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb11635fe7a354bb8985d5edb82b4e61ae916ed43010849df6add2ef62d6c439
-  data.tar.gz: f29f052b67496fd4558640cc53bbaf381ff8e6e8baaaa94cb1bb57079d6d3e96
+  metadata.gz: 6b5b88bb8e13571ef8c0c054f91249ce27b2e8b96c150502f7c221857f3ee8ee
+  data.tar.gz: bd6ca4477ced7a57505a6160505a9f21da1a375745bed39aeb62b64265f0a58c
 SHA512:
-  metadata.gz: 11361928734bebad3eeb835f74cc7c2c3801010617f417fdb9c7187966ef12d8f25f0072c633ae2edea68580516ae160bc35b128604fba54ede9867819c735b0
-  data.tar.gz: 6c2fb2b988f85e0e0cda8fa5f5aa54209c5ad675b863361ccf647538c68571f1e17f6ead4493e8bf870122800dc1d58985293e10fcd4ec98ce6b9ed4e75725ff
+  metadata.gz: d0d6555fc183eae6676c651aab5c4a2c31767db9d83cd071c2604d88c15a7a1f831bc5cbe16601570f8ba46e5d185cb47fb886c095f17b71a4ecbec57f6ab826
+  data.tar.gz: 1a95e8bbcd680bfba8759a01ca8b20d2cea89f75156a6b5bfe9bf71c3d86ed784ddc0ff39166ee51967932635469af7e7b61e3a1595343dd85f9dfaf4ddb78d5

data/README.md

@@ -20,11 +20,12 @@ gem install dpd_ie_api
 
 The gem provides a **uniform Ruby interface** across all endpoints. You always work with Ruby hashes and objects — the gem picks the best format (JSON or XML) for each endpoint internally:
 
-| Endpoint | Request Format | Response Format |
-|----------|---------------|-----------------|
-| Authorize | JSON | JSON |
-| PreAdvice | XML | XML |
-| Track | XML | JSON |
+| Endpoint  | Request Format | Response Format |
+| --------- | -------------- | --------------- |
+| Authorize | JSON           | JSON            |
+| PreAdvice | XML            | XML             |
+| Track     | XML            | JSON            |
+| Locator   | JSON           | JSON            |
 
 JSON is used wherever the DPD API supports it (simpler, no XML parsing overhead). XML is used only where the API requires it. This is entirely invisible to gem consumers.
 
@@ -161,6 +162,48 @@ The `tracking_type` defaults to `"consignment"` but can be overridden:
 tracking = client.track.find("800436802", tracking_type: "parcel")
 ```
 
+### Locator
+
+#### List
+
+Retrieve DPD Ireland drop-off locations. Test and deactivated locations are automatically filtered out.
+
+```ruby
+locations = client.locator.list
+
+locations.each do |location|
+  puts location.location_name
+  puts location.location_type        # "Pickup" or "Depot"  or "Locker"
+  puts location.location_id
+  puts location.location_address_line1
+  puts location.location_code
+  puts location.county
+  puts location.country
+  puts location.gps_lat
+  puts location.gps_long
+  puts location.depot_no
+  puts location.province
+  puts location.facilities
+  puts location.group_pudo_id
+end
+```
+
+Filter by type or specific location ID:
+
+```ruby
+# Only depots
+locations = client.locator.list(type: "Depot")
+
+# Only pickups
+locations = client.locator.list(type: "Pickup")
+
+# Only lockers
+locations = client.locator.list(type: "Locker")
+
+# Specific location
+locations = client.locator.list(location_id: "5308")
+```
+
 ### Response Objects
 
 All endpoints return response objects that provide:

data/lib/dpd_ie_api/client.rb

@@ -30,5 +30,9 @@ module DpdIeApi
     def track
       Resources::Track.new(self)
     end
+
+    def locator
+      Resources::Locator.new(self)
+    end
   end
 end

data/lib/dpd_ie_api/objects/locator.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module DpdIeApi
+  module Objects
+    class Locator < Base
+    end
+  end
+end

data/lib/dpd_ie_api/resources/locator.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module DpdIeApi
+  module Resources
+    class Locator
+      LOCATOR_PATH = '/common/api/dpdlocation'
+
+      def initialize(client)
+        @client = client
+      end
+
+      def list(type: nil, location_id: nil)
+        response = post_request(type, location_id)
+        parsed = parse_response(response)
+        filter_locations(parsed)
+      end
+
+      private
+
+      def post_request(type, location_id)
+        response = @client.connection.post(LOCATOR_PATH) do |req|
+          req.headers['Content-Type'] = 'application/json'
+          req.headers['Accept'] = 'application/json'
+          req.body = {
+            'CountryCode' => 'IE',
+            'Type' => type.to_s,
+            'LocationID' => location_id.to_s
+          }.to_json
+        end
+
+        unless response.success?
+          raise DpdIeApi::Error.new(
+            "Failed to fetch locations: #{response.status} - #{response.body}",
+            response_http_code: response.status,
+            response_body: response.body
+          )
+        end
+
+        response
+      end
+
+      def parse_response(response)
+        parsed = JSON.parse(response.body)
+
+        if parsed['Status'] != 'OK'
+          raise DpdIeApi::Error.new(
+            "Locator error: #{parsed['Status']}",
+            response_http_code: response.status,
+            response_body: response.body
+          )
+        end
+
+        parsed
+      end
+
+      def filter_locations(parsed)
+        locations = parsed['Location']
+        locations = [locations] if locations.is_a?(Hash)
+        locations = [] if locations.nil?
+
+        locations
+          .reject { |loc| loc['locationName']&.match?(/test|do not reactivate/i) }
+          .map { |loc| Objects::Locator.new(loc) }
+      end
+    end
+  end
+end

data/lib/dpd_ie_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DpdIeApi
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

data/lib/dpd_ie_api.rb

@@ -5,12 +5,14 @@ require_relative 'dpd_ie_api/objects/base'
 require_relative 'dpd_ie_api/objects/auth'
 require_relative 'dpd_ie_api/objects/preadvice'
 require_relative 'dpd_ie_api/objects/track'
+require_relative 'dpd_ie_api/objects/locator'
 require_relative 'dpd_ie_api/xml_builder'
 require_relative 'dpd_ie_api/xml_parser'
 require_relative 'dpd_ie_api/auth'
 require_relative 'dpd_ie_api/client'
 require_relative 'dpd_ie_api/resources/preadvice'
 require_relative 'dpd_ie_api/resources/track'
+require_relative 'dpd_ie_api/resources/locator'
 
 module DpdIeApi
   class Error < StandardError

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dpd_ie_api
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Linh Ho
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-03-16 00:00:00.000000000 Z
+date: 2026-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -99,8 +99,10 @@ files:
 - lib/dpd_ie_api/client.rb
 - lib/dpd_ie_api/objects/auth.rb
 - lib/dpd_ie_api/objects/base.rb
+- lib/dpd_ie_api/objects/locator.rb
 - lib/dpd_ie_api/objects/preadvice.rb
 - lib/dpd_ie_api/objects/track.rb
+- lib/dpd_ie_api/resources/locator.rb
 - lib/dpd_ie_api/resources/preadvice.rb
 - lib/dpd_ie_api/resources/track.rb
 - lib/dpd_ie_api/version.rb