postio 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee5a074b8751e84901306fd99658973e1635f98761b1a6925a9b3c83d6a00454
-  data.tar.gz: d72f7607c25f2437d0f7436c9b503968a7c3d20f0584ba427365346fb8348649
+  metadata.gz: 41300707dab2745d0a8a84e53ec508775af91729671c2e59c4469f6e16a1c75c
+  data.tar.gz: 749b0014ab03dea3edff07e35a51ae714b2f76c3076ec0d45c71efbe738b85e0
 SHA512:
-  metadata.gz: e5bf796095c34ef9815140482ee8347d79aa747f39e173ca0ea5296d3d16c1cd7a25ad039fe947ddad598236b7be9f070ec6f648d455164be93342f12a9a8b25
-  data.tar.gz: 99e2f1d7221a697535bc165b636cbe683ca4ae41448757f0f43f3af821f8dea7bbf6e2aff3b3694c66c441d566ee4a54512265b443f9d02b69277c0e7cfb7028
+  metadata.gz: e6963d95626b108a75dc8e3f9913a1ded082ae2fd917d0aa1860ed8c2596cd82ceb0a922c0e79d2b1b6987b7f48b89adf51d04f1ec13a5ed76c88c08c81f19f1
+  data.tar.gz: a5da0053ef0c55b0638a39b6d01b5369144dbe20ab678594a1e90830e203e254901a0ab0a1f46b7dd26703ebfc38cba87cdb4d99fca6d985265c1d91172c67e6

data/CHANGELOG.md

@@ -6,6 +6,26 @@ follows [SemVer](https://semver.org/).
 
 ## [Unreleased]
 
+## [0.1.2] — 2026-08-12
+
+### Removed
+
+- `county` from the address model. It came from ONS administrative geography
+  rather than Royal Mail data, resolved for only part of the country, and is
+  not part of a correct UK postal address — Royal Mail removed postal counties
+  from PAF in December 2000. `district` and `ward` remain, and are ONS
+  administrative geography rather than postal fields.
+
+## [0.1.1] — 2026-05-02
+
+### Changed
+
+- Drop the SPEC DRIFT block on `PhoneResult`. postio-api 1.0.3 aligned
+  the spec with the runtime — `is_reachable` is bool|nil, and the
+  runtime now always emits explicit nulls for every nullable field.
+  The hash-lookup `.from_hash` already handled either shape, so no
+  consumer-visible change.
+
 ## [0.1.0] — 2026-05-02
 
 Initial release. First Postio Ruby SDK on RubyGems.
@@ -35,5 +55,6 @@ Initial release. First Postio Ruby SDK on RubyGems.
   live API returns booleans there even though the spec says
   string-only. Aligned once postio-api ships a spec/runtime fix.
 
-[Unreleased]: https://github.com/postio-uk/postio-ruby/compare/v0.1.0...HEAD
+[Unreleased]: https://github.com/postio-uk/postio-ruby/compare/v0.1.1...HEAD
+[0.1.1]: https://github.com/postio-uk/postio-ruby/releases/tag/v0.1.1
 [0.1.0]: https://github.com/postio-uk/postio-ruby/releases/tag/v0.1.0

data/README.md

@@ -4,9 +4,11 @@
 [![Ruby](https://img.shields.io/badge/ruby-%3E%3D%203.1-red)](https://rubygems.org/gems/postio)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-Ruby SDK for the [Postio API](https://postio.co.uk) — UK address, email, and
-phone validation. Backed by Royal Mail PAF and Ordnance Survey. Stdlib
-`net/http` only, zero runtime dependencies.
+Ruby SDK for [Postio](https://postio.co.uk) — the UK validation API for
+addresses, emails and phone numbers. Stdlib `net/http` only, zero runtime
+dependencies. Backed by Royal Mail PAF and Ordnance Survey.
+
+> **First time?** [Sign up free](https://postio.co.uk) — first 100 lookups on us, no card needed.
 
 ## Install
 
@@ -27,7 +29,7 @@ Requires Ruby 3.1+.
 ```ruby
 require "postio"
 
-client = Postio::Client.new(api_key: "pk_live_...")  # or set POSTIO_API_KEY
+client = Postio::Client.new(api_key: "pk_...")  # or set POSTIO_API_KEY
 
 result = client.address.search("downing street")
 result.results.each do |hit|
@@ -84,7 +86,7 @@ the raw `envelope`.
 
 ```ruby
 client = Postio::Client.new(
-  api_key:  "pk_live_...",
+  api_key:  "pk_...",
   base_url: "https://api.postio.co.uk/v1",  # default
   timeout:  10,                              # seconds
   retries:  2,                               # 0 to disable

data/lib/postio/client.rb

@@ -13,7 +13,7 @@ module Postio
   #
   # Example:
   #
-  #   client = Postio::Client.new(api_key: "pk_live_...")
+  #   client = Postio::Client.new(api_key: "pk_...")
   #   r = client.address.search("downing street")
   #   r.results.each { |hit| puts "#{hit.udprn}: #{hit.suggestion}" }
   #

data/lib/postio/models.rb

@@ -44,7 +44,7 @@ module Postio
       :organisation_name, :department_name, :building_name, :building_number,
       :sub_building_name, :po_box, :thoroughfare, :dependent_thoroughfare,
       :dependent_locality, :double_dependent_locality, :delivery_point_suffix,
-      :country, :county, :district, :ward,
+      :country, :district, :ward,
       :latitude, :longitude, :eastings, :northings
     ) do
       def self.from_hash(h)
@@ -70,7 +70,6 @@ module Postio
           double_dependent_locality:   h["double_dependent_locality"],
           delivery_point_suffix:       h["delivery_point_suffix"],
           country:                     h["country"],
-          county:                      h["county"],
           district:                    h["district"],
           ward:                        h["ward"],
           latitude:                    h["latitude"]&.to_f,
@@ -109,13 +108,6 @@ module Postio
     end
 
     # PhoneResult — validation verdict for one phone number.
-    #
-    # SPEC DRIFT (2026-05-02): the OpenAPI spec marks every nullable
-    # field as required, but on invalid input the live API drops them
-    # entirely. The .from_hash fetcher uses h["..."] which returns nil
-    # for missing keys, papering over the drift. Also: spec says
-    # is_reachable is string|null, but the live API returns bool — we
-    # accept either.
     PhoneResult = Data.define(
       :number, :is_valid, :is_possible, :type, :country_code, :country_name,
       :national_format, :international_format, :e164_format, :original_carrier,

data/lib/postio/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Postio
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

data/lib/postio.rb

@@ -7,7 +7,7 @@ require_relative "postio/client"
 
 # Top-level Postio module. Use Postio::Client to construct the API client.
 #
-#   client = Postio::Client.new(api_key: "pk_live_...")
+#   client = Postio::Client.new(api_key: "pk_...")
 #   client.address.search("downing street")
 module Postio
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: postio
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Postio
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-05-02 00:00:00.000000000 Z
+date: 2026-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec