parseapi 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6598fb8f4a05494418599738f387ab8137099ddb12ac09f63ca42410d6b4b89
-  data.tar.gz: 9de6f2540a617508c1c9a298361db8218e5f0460fb4a03e1e2c04a85179badca
+  metadata.gz: 3bd44c95f15db2d0248e3b9afebf94580ef381cd5df317b668d92bd6ba8e5f3a
+  data.tar.gz: 51258c88b79a3c61ce685fbc5c4fa4606adc86ee1a64a22574f9cd41a690b418
 SHA512:
-  metadata.gz: 2599c0832bed2f4306ac4f1b5eb31a2d4757546a7349178a8c7bd693605ee091b107cec97c2005d0ed002afa9e2758f0b22d86c679fd15efffad1bd6fa0453d4
-  data.tar.gz: 3d6a7f151089a85c0e76624f84cdd788df87a329371669505efd3179ec98c682017248e969072949f3975c70687ae4d9dfc766fec0949211df22a89374c80533
+  metadata.gz: 9bd2d3e93c4c1f5aa2668146a4af0ad4a18379a483ca77578971980d11dbc64be2942c3a50522723f4ff2492cd23b523fb077769b38c6f4b77aa1f1670a8c71c
+  data.tar.gz: 1d06c9bf515839953e35f563bc808a177fde1bdac02a4f7a095b90a6d34b2013dfdbec32d4b7b95d0f046cdb514094b7fc370e6c2581bfe1fefe31713be7de1d

data/README.md

@@ -53,9 +53,9 @@ parse.ip('8.8.8.8')
 parse.ip_self
 parse.email('hello@gmail.com')
 parse.vat('DE136695976')
-parse.iban('DE89370400440532013000')
-parse.bin('424242')
-parse.npi('1881018208')
+parse.bank('DE89370400440532013000')
+parse.card('424242')
+parse.provider('1881018208')
 parse.phone('+14155552671')
 parse.carrier('+14155552671')
 parse.caller('+14155552671')
@@ -107,16 +107,18 @@ parse.mx('example.com')
 parse.dns('example.com')
 parse.dns('_dmarc.example.com', type: 'TXT')
 parse.useragent(ua_string)
-parse.vin('1HGCM82633A004352')
-parse.naics('541511')
-parse.naics_search('coffee shop', limit: 5)
+parse.vehicle('1HGCM82633A004352')
+parse.industry('541511')
+parse.industry_search('coffee shop', limit: 5)
 parse.tariff('8471.30.01.00', origin: 'CN', deep: true)
 parse.tariff_search('sunglasses')
 parse.emoji('rocket')
 parse.emoji_search('fire')
 ```
 
-NAICS paid deep records include classification `deep.exclusions`, each with a description and linked codes. Generic exclusions can have no linked codes. Omitted or null exclusions in older responses remain unknown. Search results also include `match`: the matched `field` (`name`, `term` or `naics`) and `text`, plus `corrections` with `from` and `to` tokens for typo fallback. Corrections are empty for exact, plural and prefix matches. Direct code lookups omit `match`. Older responses may omit it.
+The existing NAICS lookup and search methods remain available as compatibility names for Industry.
+
+Industry paid deep records include classification `deep.exclusions`, each with a description and linked codes. Generic exclusions can have no linked codes. Omitted or null exclusions in older responses remain unknown. Search results also include `match`: the matched `field` (`name`, `term` or `naics`) and `text`, plus `corrections` with `from` and `to` tokens for typo fallback. Corrections are empty for exact, plural and prefix matches. Direct code lookups omit `match`. Older responses may omit it.
 
 Each lookup returns a plain hash with string keys. Related lookups are separate calls, such as `country_states('US')`. Reading the result makes no further requests. New response fields and `nil` values are preserved.
 
@@ -235,6 +237,32 @@ Address search uses context from the form: prefer postal, or city and state. An
 
 HLR reports status at the last check. `live` means assigned and `connected` means reachable at that check. Cached results may be returned. Null means unconfirmed. Deep diagnostics stay within the same metered lookup.
 
+Bank returns core `checks` for input, country, length, structure, checksum and national rules, plus an `issues` list. States are `passed`, `failed`, `not_checked` or `not_supported`. Unsupported national checking is not a failure. `valid` covers the implemented format and checksum rules, not account existence, ownership or payment reachability. Directory names and BICs may be null independently. Older responses may omit `checks` and `issues`, and future states and issue codes remain strings. Pass the original input unchanged so the API can report invalid characters. Deep `account` remains the BBAN remainder.
+
+Bank inputs use `POST /bank` JSON bodies, keeping IBAN and account values out of request URLs. Pass original strings; the server owns normalization and validation. Avoid logging request bodies. IBAN deep can include `directory` with the immutable `edition`, resolved `country` and actual `match` grain (`bank`, `branch`, `prefix` or `none`); it is absent if no directory lookup ran. A match does not prove complete country coverage or payment reachability.
+
+Use country requirements to build supported input fields. US ACH has an explicit helper with no deep option. It checks the routing format/ABA checksum and account-field syntax; `account_checksum` is `not_supported`. It preserves account characters and leading zeros. A nullable bank name is routing-directory identity, not account existence, ownership or ACH eligibility. The examples below are synthetic test inputs, not payment instructions.
+
+```ruby
+parse.bank_requirements('US', format: 'us_ach')
+parse.bank_us_ach(routing: '011000015', account: '0001234567')
+```
+
+## Provider lookup
+
+```ruby
+provider = parse.provider('1881018208')
+profile = parse.provider('1881018208', deep: true)
+```
+
+Pass the original NPI as a string. `valid` checks its format and checksum; `registered` means a match in the stored NPPES snapshot. `active` reflects recorded NPI deactivation, not licensure. `excluded` is an NPI-only OIG LEIE match; `false` is not a complete exclusion clearance. These directory facts do not verify credentials, current practice contact or payment eligibility.
+
+Invalid input returns `valid: false` with unknown provider fields. A checksum-valid number missing from the snapshot returns `registered: false`; unavailable storage remains an API error. Preserve `null` as unknown.
+
+The default pooled lookup includes provider identity, specialty and practice contact where held. Paid `deep` adds `deactivated_at`, `medicare`, `opt_out` and `enrollments` from stored source files, with no separate check meter or live verification. `enrollments: null` means unavailable; `[]` means no enrollment rows are returned. The API omits unrequested `deep` and returns `{}` when requested on Free.
+
+Paid Deep also returns `taxonomies` in published order, with taxonomy code, specialty label, primary flag and provider-reported license number/state, plus `enumerated_at`, `updated_at` and `reactivated_at` record dates. Reported licenses are not verified licenses. Null lists mean unavailable; empty lists mean the edition contains no entries. Core `sources` is available on every plan: NPPES, LEIE, PECOS and opt-out each have nullable edition metadata (`edition`, `published_at`, `through`, `imported_at`). Provider record dates are separate from source publication and completed import dates. Older responses may omit these additions. Edition details remain null until a verified source is served.
+
 ## Deep
 
 Choose enrichment for the question you need answered.
@@ -245,10 +273,11 @@ Choose enrichment for the question you need answered.
 | Domain | Registration dates, registrar, status and DNSSEC, included with a paid plan. Use `dns` for DNS records and `mx` for mail routing. |
 | Email | A metered mailbox check with deliverability, catch-all, status, reason and address hints, using included email checks or enabled on-demand usage. |
 | VAT | A metered registry check where supported, using included VAT checks or enabled on-demand usage. |
-| Phone, Time, Date, Currency, Language, Emoji, IBAN, Point | Optional detail in the same pooled request on every plan. |
+| Phone, Time, Date, Currency, Language, Emoji, Bank, Point | Optional detail in the same pooled request on every plan. |
 | Country, State, District, City, Postal | The place profile on paid plans, including demographic and tax facts where held. |
-| Name, NAICS | Name evidence or the industry definition profile on paid plans. |
-| VIN, NPI, Tariff, Company | The complete product detail bag on paid plans. |
+| Name, Industry | Name evidence or the industry definition profile on paid plans. |
+| NPI | Deactivation date, Medicare enrollment, opt-out and enrollment rows from stored sources on paid plans. Exclusion evidence stays core. |
+| Vehicle, Tariff, Company | The complete product detail bag on paid plans. |
 | Weather | Specialist current measurements and the existing forecast, alert, air and history bag on paid plans. |
 | Carrier, HLR | Optional diagnostic detail within the same metered core unit, including Free allowance units. No second gate or additional check. |
 
@@ -267,7 +296,7 @@ ip.dig('deep', 'datacenter') # true, false, or nil
 
 ## Errors
 
-Every non-2xx response raises `ParseAPI::Error` with `status`, `code`, `docs`, and `request_id`. Branch on `code`.
+Every non-2xx response raises `ParseAPI::Error` with `status`, `code`, `docs`, and `request_id`, plus nullable `retry_after` header metadata. Branch on `code`.
 
 ```ruby
 begin
@@ -292,11 +321,13 @@ Ordinary lookups retry network errors and HTTP 429, 500, 502, 503, and 504 up to
 
 Pass `retries: 0` to make every lookup a single attempt. An explicit count such as `retries: 2` applies to every lookup, including paid ones. A retried request can count toward usage even when the first response was lost. Omit `retries` or pass `nil` to use the defaults above.
 
+Automatic retries honor numeric and HTTP-date `Retry-After` values up to five seconds. A longer server wait returns the original API error immediately, with the raw header in `retry_after`, so the application can schedule a later attempt. Missing or invalid headers use ordinary backoff.
+
 Reuse one client for successive lookups. Call `parse.close` to release its connection when finished. A later lookup opens a new connection. Use a separate client in each concurrent thread.
 
 Network failures raise native Ruby exceptions. An invalid JSON response raises `JSON::ParserError`.
 
-For testing or instrumentation, pass a callable as `transport:`. It receives the URL and request-header hash and returns `[status, lowercase_response_headers, body]`. Custom transports should use the supplied headers and keep redirect following disabled.
+For testing or instrumentation, pass a callable as `transport:`. For GET it receives the URL and request-header hash. For Bank POST it also receives a third `"POST"` argument and fourth serialized JSON body argument. Accept optional method/body parameters when supplying a custom transport. It returns `[status, lowercase_response_headers, body]`. Custom transports should use the supplied headers and keep redirect following disabled.
 
 Requires Ruby 3.0 or later. Standard library only, zero dependencies.
 
@@ -304,12 +335,34 @@ Requires Ruby 3.0 or later. Standard library only, zero dependencies.
 
 Full field reference for every endpoint: [parseapi.com/docs](https://parseapi.com/docs)
 
-BIN lookup accepts 6-11 digits as a string, including leading zeros. Spaces and hyphens are accepted. `prefix` is the actual longest match and can be shorter than the input. Unknown reference fields are null. `deep` adds an empty object on every plan.
+## Card
+
+Send 2–11 leading digits as a string. Core returns `bin`, `brand`, `brand_name`
+and a CDN SVG `logo`. Brand detection uses reviewed network rules independently
+of issuer records. Unknown or ambiguous prefixes return null brand fields and a
+generic logo; a known network without reviewed artwork also uses the generic logo.
 
+Optional Deep adds `prefix`, `issuer`, `country`, `type` and `prepaid`, included
+in the same pooled request on every plan. Six or more digits enable directory
+matching. Fewer digits return all-null Deep fields. Compare `deep.prefix` with
+`bin`: equal is an exact recorded match; shorter is broader; null is no match.
+The longest row wins, including null fields. `prepaid: null` means unknown, not
+false. This is partial reference data, not card validity or payment acceptance.
+
+```ruby
+card = parse.card("51")
+puts card["logo"]
+details = parse.card("43737400", deep: true)
+issuer = details["deep"]["issuer"]
+```
+
+Leading zeros are preserved. Only ASCII spaces, tabs, CR, LF and hyphens are
+removed; raw input is limited to 64 characters. Invalid prefixes are rejected
+before dispatch, accepted input is forwarded unchanged. Never send a full card number.
 
 ## Optional detail
 
-The default response answers the common task. Ask for `deep` when you need more detail about that same result. Core fields stay equal. City, NAICS and Emoji searches put detail inside each result. Postal nearby and distance put metropolitan detail beside the entity it describes. Time conversion keeps target detail in `to.deep`; only the source has `deep.next_dst`.
+The default response answers the common task. Ask for `deep` when you need more detail about that same result. Core fields stay equal. City, Industry and Emoji searches put detail inside each result. Postal nearby and distance put metropolitan detail beside the entity it describes. Time conversion keeps target detail in `to.deep`; only the source has `deep.next_dst`.
 
 ```ruby
 basic = parse.time('America/New_York')
@@ -330,3 +383,5 @@ Pass a public hostname without a scheme, path, port or IP address. Stack returns
 Successful checks may be reused for up to 24 hours. `pretty` optionally formats the wire JSON. Stack uses your plan's request allowance and API version 2.0.0 selected by this client.
 
 Stack defaults to a 35-second transport timeout so a first scan has time to finish. Other lookups retain their 10-second default. An explicit client timeout takes precedence.
+
+Vehicle lookups use `vin` as the input and response field. Existing VIN methods remain available for compatibility.

data/lib/parseapi/client.rb

@@ -6,14 +6,15 @@ require 'time'
 module ParseAPI
 	# Every non-2xx response from the API. Branch on +code+, never on the message.
 	class Error < StandardError
-		attr_reader :status, :code, :docs, :request_id
+		attr_reader :status, :code, :docs, :request_id, :retry_after
 
-		def initialize(status:, code:, message:, docs: nil, request_id: nil)
+		def initialize(status:, code:, message:, docs: nil, request_id: nil, retry_after: nil)
 			super(message)
 			@status = status
 			@code = code
 			@docs = docs
 			@request_id = request_id
+			@retry_after = retry_after
 		end
 	end
 
@@ -173,16 +174,39 @@ module ParseAPI
 			get("/iban/#{seg(iban)}", country: country, deep: deep)
 		end
 
-		# Look up a 6-11 digit card prefix, preserving leading zeros.
 		def bin(bin, deep: false)
 			get("/bin/#{seg(bin)}", deep: deep)
 		end
 
-
 		def npi(npi, deep: false, lang: nil)
 			get("/npi/#{seg(npi)}", deep: deep, lang: lang)
 		end
 
+		def bank(iban, country: nil, deep: false)
+			get("/bank", {}, {}, { iban: iban, country: country, deep: deep }.reject { |_key, value| value.nil? })
+		end
+
+		# Look up a 2-11 digit card prefix, preserving leading zeros.
+		def card(bin, deep: false)
+			raise ArgumentError, 'parseapi: Card requires a 2-11 digit prefix string.' unless bin.is_a?(String) && bin.length <= 64 && /\A[0-9]{2,11}\z/.match?(bin.delete(" \t\r\n-"))
+			get("/card/#{seg(bin)}", deep: deep)
+		end
+
+
+		# US routing/account syntax only; not account or ACH eligibility verification.
+		def bank_us_ach(routing:, account:)
+			get('/bank', {}, {}, { format: 'us_ach', country: 'US', routing: routing, account: account })
+		end
+
+		# Describe accepted fields and check scope, not directory completeness.
+		def bank_requirements(country, format: nil)
+			get('/bank/requirements', country: country, format: format)
+		end
+
+		def provider(npi, deep: false, lang: nil)
+			get("/provider/#{seg(npi)}", deep: deep, lang: lang)
+		end
+
 		# Parse a phone number and its formats. Pass country for national numbers when needed. Deep
 		# adds numbering-plan geography on every plan. Carrier, caller, and HLR are separate metered lookups.
 		def phone(number, country: nil, deep: false)
@@ -240,18 +264,31 @@ module ParseAPI
 			get('/useragent', { deep: deep }, { 'User-Agent' => ua })
 		end
 
+		def vehicle(vin, deep: false)
+			get("/vehicle/#{seg(vin)}", deep: deep)
+		end
+
 		def vin(vin, deep: false)
 			get("/vin/#{seg(vin)}", deep: deep)
 		end
 
 		# US NAICS 2022 definition and hierarchy.
+		# Compatibility names for Industry.
 		def naics(code, deep: false)
-			get("/naics/#{seg(code)}", deep: deep)
+			industry(code, deep: deep)
 		end
 
-		# Keyword search. Limit defaults to 10 and accepts 1-50.
 		def naics_search(query, limit: nil, deep: false)
-			get('/naics', q: query, limit: limit, deep: deep)
+			industry_search(query, limit: limit, deep: deep)
+		end
+
+		def industry(code, deep: false)
+			get("/industry/#{seg(code)}", deep: deep)
+		end
+
+		# Keyword search. Limit defaults to 10 and accepts 1-50.
+		def industry_search(query, limit: nil, deep: false)
+			get('/industry', q: query, limit: limit, deep: deep)
 		end
 
 		# Look up the general US duty schedule line. Paid deep adds units and the special and other
@@ -393,17 +430,22 @@ module ParseAPI
 			URI.encode_www_form_component(value.to_s).gsub('+', '%20')
 		end
 
-		def get(path, params = {}, headers = {})
+		def get(path, params = {}, headers = {}, json = nil)
 			retries = retries_for(path, params)
 			query = params.reject { |_name, value| value.nil? || value == false }
 			uri = @base_url.dup
 			uri.path = path
 			uri.query = URI.encode_www_form(query) unless query.empty?
 
+			encoded = json.nil? ? nil : JSON.generate(json)
 			attempt = 0
 			loop do
 				begin
-					status, response_headers, body = execute(uri, request_headers(headers))
+					status, response_headers, body = if encoded.nil?
+						execute(uri, request_headers(headers))
+					else
+						execute(uri, request_headers(headers.merge('Content-Type' => 'application/json')), 'POST', encoded)
+					end
 				rescue *NETWORK_ERRORS
 					raise if attempt >= retries
 
@@ -414,13 +456,14 @@ module ParseAPI
 
 				return JSON.parse(body) if (200..299).cover?(status)
 
-				if RETRY_STATUS.include?(status) && attempt < retries
-					sleep(retry_delay(attempt, response_headers['retry-after']))
+				retry_after = response_headers['retry-after']
+				if RETRY_STATUS.include?(status) && attempt < retries && (wait = retry_delay(attempt, retry_after))
+					sleep(wait)
 					attempt += 1
 					next
 				end
 
-				raise build_error(status, body)
+				raise build_error(status, body, retry_after)
 			end
 		end
 
@@ -429,12 +472,13 @@ module ParseAPI
 		end
 
 		# Returns [status, headers_hash, body_string]. Overridden in tests.
-		def execute(uri, headers)
-			return @transport.call(uri.to_s, headers) if @transport
+		def execute(uri, headers, method = 'GET', body = nil)
+			return (method == 'GET' ? @transport.call(uri.to_s, headers) : @transport.call(uri.to_s, headers, method, body)) if @transport
 
 			timeout = !@timeout_explicit && uri.path.start_with?('/stack/') ? 35 : @timeout
 			http = connection(timeout)
-			request = Net::HTTP::Get.new(uri.request_uri)
+			request = (method == 'POST' ? Net::HTTP::Post : Net::HTTP::Get).new(uri.request_uri)
+			request.body = body unless body.nil?
 			headers.each { |name, value| request[name] = value }
 			response = http.request(request)
 			header_hash = {}
@@ -459,15 +503,18 @@ module ParseAPI
 
 		def retry_delay(attempt, retry_after)
 			if retry_after
-				seconds = Float(retry_after, exception: false)
-				return [seconds, RETRY_AFTER_CAP].min if seconds && seconds.finite? && seconds >= 0
+				if /\A[0-9]+(?:\.[0-9]+)?\z/.match?(retry_after.strip)
+					seconds = Float(retry_after, exception: false)
+					return seconds && seconds.finite? && seconds <= RETRY_AFTER_CAP ? seconds : nil
+				end
 				begin
-					return [[Time.httpdate(retry_after) - Time.now, 0].max, RETRY_AFTER_CAP].min
+					seconds = [Time.httpdate(retry_after) - Time.now, 0].max
+					return seconds > RETRY_AFTER_CAP ? nil : seconds
 				rescue ArgumentError
 					# Fall back to jitter when the header is not a delay or HTTP date.
 				end
 			end
-			rand * 0.25 * (2**attempt)
+			rand * [0.25 * (2**[attempt, 5].min), RETRY_AFTER_CAP].min
 		end
 
 		def retries_for(path, params)
@@ -478,7 +525,7 @@ module ParseAPI
 			metered ? 0 : DEFAULT_RETRIES
 		end
 
-		def build_error(status, body)
+		def build_error(status, body, retry_after = nil)
 			parsed = begin
 				JSON.parse(body)
 			rescue JSON::ParserError
@@ -490,7 +537,8 @@ module ParseAPI
 				code: parsed['code'].is_a?(String) ? parsed['code'] : 'unknown_error',
 				message: parsed['message'].is_a?(String) ? parsed['message'] : "Request failed with status #{status}",
 				docs: parsed['docs'].is_a?(String) ? parsed['docs'] : nil,
-				request_id: parsed['request_id'].is_a?(String) ? parsed['request_id'] : nil
+				request_id: parsed['request_id'].is_a?(String) ? parsed['request_id'] : nil,
+				retry_after: retry_after
 			)
 		end
 	end

data/lib/parseapi/version.rb

@@ -1,3 +1,3 @@
 module ParseAPI
-	VERSION = '1.7.0'.freeze
+	VERSION = '1.8.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parseapi
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - ParseAPI
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-09-24 00:00:00.000000000 Z
+date: 2026-09-25 00:00:00.000000000 Z
 dependencies: []
 description:
 email: