nz_post_api 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db4c2d341925855b00d54c677d88820dfcb183e16bf3a92e12c284bbdc665f80
-  data.tar.gz: 6ffccabb911d0b5683984b45c75b5aea2392771452794c0572a65bae0fea8350
+  metadata.gz: 79fc7d9823bc2ee076dd26982aad65e2ec9cd2354403ffd0afd6414f0a1b9f49
+  data.tar.gz: 22a970d9bba8db00bf083b2a586d024a1e8905c8430af12218bfce287926ebb1
 SHA512:
-  metadata.gz: 4d66466023a5ae7a3d341218fe006cf25d022747bfc7dbf08be4a2026629982507cba8837b884609c68f1b11a3ca270484c13b50f4e43fb02e72683420ada83b
-  data.tar.gz: 2dac646484e52891d15da15f731625fb28a8fc1a389f54b2f3b66302f5f9b4f111fc8a5727a6ae516c90d51dba0c659944d67c3804a79290c4a4cec4e884a5b2
+  metadata.gz: c6f21391ee069bcb2e08742f2b7c4e6aec58703063c5ed76c0e3bded858e6d4f6fa6180bafbaeb45178661997c826fcb8af40520532713f5e7d30c5e13acde78
+  data.tar.gz: f5c356b9498efcacfdc383b2f9333c936cfea3a1603cd724b3dccb812ae50c39176e18d847fc8e82f4c1b0b98e02590b1e68a8ba2fd434ddaa538b0c8ccd3cee

data/README.md

@@ -31,21 +31,21 @@ expires_in = token_response["expires_in"]
 > [!IMPORTANT]
 > The access token expires after a certain period (indicated by `expires_in`). It is highly recommended to cache the `access_token` and reuse it until it expires to avoid unnecessary API calls and potential rate limiting.
 
-Then, initialize the client with the access token.
+Then, initialize the client with your credentials:
 
 ```ruby
-client = NzPostApi::Client.new(client_id: "YOUR_CLIENT_ID", access_token: access_token)
+client = NzPostApi::Client.new(
+  "YOUR_CLIENT_ID",
+  access_token,
+  prod: true  # set to true for production, false for UAT (default)
+)
 ```
 
-### Configuration
-
-By default, the gem uses the UAT environment. To use the production environment, configure the gem as follows:
+**Client constructor:**
 
-```ruby
-NzPostApi.configure do |config|
-  config.prod = true # set to true for production, defaults to false (UAT)
-end
-```
+- `client_id` – Your NZ Post API client ID (required)
+- `access_token` – Bearer token from `NzPostApi::Auth.fetch_token` (required)
+- `prod:` – Set to `true` for production (`https://api.nzpost.co.nz`), `false` for UAT (`https://api.uat.nzpost.co.nz`). Defaults to `false`.
 
 ### Parcel Address
 
@@ -69,6 +69,10 @@ end
 
 Create a new parcel label.
 
+- **NZ Post rates**: To use your own NZ Post rates, include `account_number` and `site_code` in the payload.
+- **Notification endpoint**: The `notification_endpoint` is a webhook URL. NZ Post will send HTTP requests to this endpoint when the parcel label status is updated.
+- **Service codes** (in `parcel_details`): `CPOLP` is Overnight Returns (supports pickup); `EROLE` is Economy Returns (only drop off, the pickup address street must have the prefix "PO Box" or "Private Bag" followed by digits).
+
 ```ruby
 label_client = client.parcel_label
 
@@ -259,7 +263,3 @@ 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/auth.rb

@@ -2,17 +2,20 @@
 
 require "faraday"
 require "json"
+require "uri"
 
 module NzPostApi
   class Auth
     TOKEN_URL = "https://oauth.nzpost.co.nz/as/token.oauth2"
 
     def self.fetch_token(client_id, client_secret)
-      response = Faraday.post(TOKEN_URL, {
+      params = {
         client_id: client_id,
         client_secret: client_secret,
         grant_type: "client_credentials"
-      })
+      }
+      url_with_params = "#{TOKEN_URL}?#{URI.encode_www_form(params)}"
+      response = Faraday.post(url_with_params, nil)
 
       if response.success?
         JSON.parse(response.body)

data/lib/nz_post_api/client.rb

@@ -4,19 +4,26 @@ require "faraday"
 
 module NzPostApi
   class Client
-    attr_reader :client_id, :access_token
-
-    def initialize(client_id:, access_token:)
+    def initialize(client_id, access_token, prod: false)
       @client_id = client_id
       @access_token = access_token
+      @prod = prod
+    end
+
+    def base_url
+      if @prod
+        "https://api.nzpost.co.nz"
+      else
+        "https://api.uat.nzpost.co.nz"
+      end
     end
 
     def connection
       @connection ||= Faraday.new do |f|
         f.request :json
         f.response :json
-        f.headers["client_id"] = client_id
-        f.headers["Authorization"] = "Bearer #{access_token}"
+        f.headers["client_id"] = @client_id
+        f.headers["Authorization"] = "Bearer #{@access_token}"
         f.headers["Content-Type"] = "application/json"
       end
     end

data/lib/nz_post_api/resources/parcel_address.rb

@@ -4,7 +4,7 @@ module NzPostApi
   module Resources
     class ParcelAddress
       def base_url
-        "#{NzPostApi.configuration.base_url}/parceladdress/2.0/domestic/addresses"
+        "#{@client.base_url}/parceladdress/2.0/domestic/addresses"
       end
 
       def initialize(client)

data/lib/nz_post_api/resources/parcel_label.rb

@@ -4,7 +4,7 @@ module NzPostApi
   module Resources
     class ParcelLabel
       def base_url
-        "#{NzPostApi.configuration.base_url}/parcellabel/v3/labels"
+        "#{@client.base_url}/parcellabel/v3/labels"
       end
 
       def initialize(client)

data/lib/nz_post_api/resources/parcel_track.rb

@@ -4,7 +4,7 @@ module NzPostApi
   module Resources
     class ParcelTrack
       def base_url
-        "#{NzPostApi.configuration.base_url}/parceltrack/3.0/parcels"
+        "#{@client.base_url}/parceltrack/3.0/parcels"
       end
 
       def initialize(client)

data/lib/nz_post_api/resources/shipping_option.rb

@@ -4,7 +4,7 @@ module NzPostApi
   module Resources
     class ShippingOption
       def base_url
-        "#{NzPostApi.configuration.base_url}/shippingoptions/2.0/domestic"
+        "#{@client.base_url}/shippingoptions/2.0/domestic"
       end
 
       def initialize(client)

data/lib/nz_post_api/version.rb

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

data/lib/nz_post_api.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require_relative "nz_post_api/version"
-require_relative "nz_post_api/configuration"
 require_relative "nz_post_api/objects/base"
 require_relative "nz_post_api/objects/address"
 require_relative "nz_post_api/objects/label"
@@ -17,14 +16,4 @@ require_relative "nz_post_api/resources/parcel_track"
 
 module NzPostApi
   class Error < StandardError; end
-
-  class << self
-    def configuration
-      @configuration ||= Configuration.new
-    end
-
-    def configure
-      yield(configuration)
-    end
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nz_post_api
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Andy Chong
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-02-02 00:00:00.000000000 Z
+date: 2026-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -70,7 +70,6 @@ files:
 - lib/nz_post_api.rb
 - lib/nz_post_api/auth.rb
 - lib/nz_post_api/client.rb
-- lib/nz_post_api/configuration.rb
 - lib/nz_post_api/objects/address.rb
 - lib/nz_post_api/objects/base.rb
 - lib/nz_post_api/objects/label.rb

data/lib/nz_post_api/configuration.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module NzPostApi
-  class Configuration
-    attr_accessor :prod
-
-    def initialize
-      @prod = false
-    end
-
-    def base_url
-      if @prod
-        "https://api.nzpost.co.nz"
-      else
-        "https://api.uat.nzpost.co.nz"
-      end
-    end
-  end
-end