nz_post_api 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0448e4e338c37344fa3fa6ab4d945d881da9dd3792cfe313f5606f557d8b2cb
-  data.tar.gz: b7185609015910d3c29d1035d49ab84de2232b9954843cf68984ab8cedb0e17d
+  metadata.gz: fd7725f76d54c6a212beecd45f4ffc568ae7b0ab010d69ecf0f92d3dcbe57149
+  data.tar.gz: 7298abe8f2dae29e17f9525839b405e5c88a6be22f9072021002cdc1e3a8c957
 SHA512:
-  metadata.gz: 6ea8af8a2e7996843a7717d717a967906347b34f78b05ff7aa06f53f433f51ede93c4a26daab9c6a0d566e801c5c005608739951d626b567609998971e0df394
-  data.tar.gz: acfdac12a138c5961411c03673b28223f7516fd8603756bab64387d5673b189a8d9eb79cd36829b8e154dc4ee70e8c5e347cf6aecf55af64895676c65f21f85b
+  metadata.gz: 233660b133767bfc37a494719f344be5882d5d1093cbd92fc51b835e25481e0ba2d31ac4f5f4991622a9d3f3cae389350580e635bb99e35f55fdd4bce2efad9e
+  data.tar.gz: '08319bcd20474c2bccbc4f69b14bb57ccbe648e9ef95c186b3bc719067259baa4e8e7bd8840acfdd62d79d7564d0283e986be1cafe1cb87eb3f3775892a85070'

data/README.md

@@ -168,7 +168,7 @@ file.unlink # deletes the temp file
 
 List available shipping options based on package details.
 
-```ruby
+````ruby
 shipping_client = client.shipping_options
 
 params = {
@@ -182,10 +182,56 @@ params = {
 
 response = shipping_client.list(params)
 response.services.each do |service|
+  puts service.service_code
   puts service.service_code
   puts service.description
 end
 
+### Parcel Track
+
+#### Track Parcel
+
+Retrieve tracking events for a parcel.
+
+```ruby
+track_client = client.parcel_track
+tracking = track_client.track("TRACKING_NUMBER")
+
+puts tracking.tracking_reference
+tracking.tracking_events.each do |event|
+  puts "#{event.event_datetime}: #{event.event_description}"
+end
+```
+
+#### Subscribe to Updates
+
+Subscribe to tracking updates for a parcel via webhook.
+
+```ruby
+track_client = client.parcel_track
+subscription = track_client.subscribe(
+  tracking_reference: "TRACKING_NUMBER",
+  notification_endpoint: "https://my.endpoint.com/nz_post_tracking"
+)
+
+puts subscription.subscription_guid
+```
+
+#### Unsubscribe
+
+Unsubscribe from tracking updates.
+
+```ruby
+track_client = client.parcel_track
+success = track_client.unsubscribe(subscription_guid: "SUBSCRIPTION_GUID")
+
+if success
+  puts "Unsubscribed successfully"
+else
+  puts "Failed to unsubscribe"
+end
+````
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -203,4 +249,7 @@ The gem is available as open source under the terms of the [MIT License](https:/
 ## Code of Conduct
 
 Everyone interacting in the NzPostApi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/nz_post_api/blob/main/CODE_OF_CONDUCT.md).
+
+```
+
 ```

data/lib/nz_post_api/client.rb

@@ -32,5 +32,9 @@ module NzPostApi
     def shipping_options
       Resources::ShippingOption.new(self)
     end
+
+    def parcel_track
+      Resources::ParcelTrack.new(self)
+    end
   end
 end

data/lib/nz_post_api/objects/parcel_track.rb

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

data/lib/nz_post_api/objects/parcel_track_subscription.rb

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

data/lib/nz_post_api/resources/parcel_track.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module NzPostApi
+  module Resources
+    class ParcelTrack
+      BASE_URL = "https://api.uat.nzpost.co.nz/parceltrack/3.0/parcels"
+
+      def initialize(client)
+        @client = client
+      end
+
+      def track(tracking_reference)
+        response = @client.connection.get("#{BASE_URL}/#{tracking_reference}")
+
+        if response.success?
+          Objects::ParcelTrack.new(response.body["results"])
+        else
+          raise NzPostApi::Error, "Failed to track parcel: #{response.status} - #{response.body}"
+        end
+      end
+
+      def subscribe(tracking_reference:, notification_endpoint:)
+        payload = {
+          tracking_reference: tracking_reference,
+          notification_endpoint: notification_endpoint
+        }
+        response = @client.connection.post("#{BASE_URL.sub('parcels', 'subscription/webhook/')}", payload)
+
+        if response.success?
+          Objects::ParcelTrackSubscription.new(response.body)
+        else
+          raise NzPostApi::Error, "Failed to subscribe to parcel: #{response.status} - #{response.body}"
+        end
+      end
+
+      def unsubscribe(subscription_guid:)
+        response = @client.connection.delete("#{BASE_URL.sub('parcels', 'subscription/webhook')}/#{subscription_guid}")
+
+        if response.success?
+          true
+        else
+          raise NzPostApi::Error, "Failed to unsubscribe from parcel: #{response.status} - #{response.body}"
+        end
+      end
+    end
+  end
+end

data/lib/nz_post_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NzPostApi
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/nz_post_api.rb

@@ -5,11 +5,14 @@ require_relative "nz_post_api/objects/base"
 require_relative "nz_post_api/objects/address"
 require_relative "nz_post_api/objects/label"
 require_relative "nz_post_api/objects/shipping_option"
+require_relative "nz_post_api/objects/parcel_track"
+require_relative "nz_post_api/objects/parcel_track_subscription"
 require_relative "nz_post_api/auth"
 require_relative "nz_post_api/client"
 require_relative "nz_post_api/resources/parcel_address"
 require_relative "nz_post_api/resources/parcel_label"
 require_relative "nz_post_api/resources/shipping_option"
+require_relative "nz_post_api/resources/parcel_track"
 
 module NzPostApi
   class Error < StandardError; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nz_post_api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Andy Chong
@@ -73,9 +73,12 @@ files:
 - lib/nz_post_api/objects/address.rb
 - lib/nz_post_api/objects/base.rb
 - lib/nz_post_api/objects/label.rb
+- lib/nz_post_api/objects/parcel_track.rb
+- lib/nz_post_api/objects/parcel_track_subscription.rb
 - lib/nz_post_api/objects/shipping_option.rb
 - lib/nz_post_api/resources/parcel_address.rb
 - lib/nz_post_api/resources/parcel_label.rb
+- lib/nz_post_api/resources/parcel_track.rb
 - lib/nz_post_api/resources/shipping_option.rb
 - lib/nz_post_api/version.rb
 - sig/nz_post_api.rbs