nzbn-ruby 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0bc9736578fcb4a9663e87a28d910e91dbfdc9acf724f30c09bfc03fb47b5e3f
-  data.tar.gz: 1fffb71fac5bf19a6192220b89674212066f2be603fd37c2a6d8d4f7f8f6cf3f
+  metadata.gz: e7b5ed421a242eb20a20ab1915ca8b494e841dab14d1a570ba0b2091c96041b5
+  data.tar.gz: 02f681798322954cfe3f1d83f2e78dc745af871b7ec4c00aaa25fa97b12ef5ad
 SHA512:
-  metadata.gz: c5de87bf46f1d4bb736a5bb42815e25524c359e7c3e98b9f5b83fdf854862a4de960c80a1a43a25c18214e485660820cbbcd30003b40ba9cee7a5e7b52ff0403
-  data.tar.gz: 7efe36fe483fe7a4ca917b313e65466aabef6539b8e8dc1ec83666df6ca0c64c96923d53f54782e5e69656fedf697ad74a5d63e80365be2268547aafde5d9f28
+  metadata.gz: b55a33c0e887d0c5a70162ebb32c9ed18f530f9c144c32a03217fb297d97c3c260b0040d701811129bd84c2490f3c6875f16757347cc4795aa459ad8f600be1e
+  data.tar.gz: 89d7aad88299b453d38873e25dacf66bcdd6bac8d1e55a40ae2e7455e29edc50ce1d8246bee8d28190a1ff2a49b29d62f7375ea4ff544f551a09a2ff7165571b

data/CHANGELOG.md

@@ -5,6 +5,16 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.1.5] - 2026-03-13
+
+### Added
+- Support for production and sandbox modes via `config.mode = :production` or `config.mode = :sandbox`
+- Default production URL: `https://api.business.govt.nz/gateway/nzbn/v5`
+- Default sandbox URL: `https://api.business.govt.nz/sandbox/nzbn/v5`
+- `PRODUCTION_BASE_URL` and `SANDBOX_BASE_URL` constants
+- `sandbox?` and `production?` convenience methods on Configuration
+- Validation for invalid mode values with `ArgumentError`
+
 ## [0.1.4] - 2026-02-09
 
 ### Added

data/README.md

@@ -33,13 +33,42 @@ gem install nzbn-ruby
 Configure the gem with your NZBN API key (obtain from [api.business.govt.nz](https://api.business.govt.nz)):
 
 ```ruby
-require 'logger'
+# Production mode (default)
+Nzbn.configure do |config|
+  config.api_key = 'your-api-key'
+end
+
+# Sandbox mode
+Nzbn.configure do |config|
+  config.api_key = 'your-api-key'
+  config.mode = :sandbox
+end
+```
+
+### Configuration Options
+
+| Option | Default | Description |
+|--------|---------|-------------|
+| `api_key` | `nil` | **(Required)** Your NZBN API subscription key |
+| `mode` | `:production` | API mode — `:production` or `:sandbox` |
+| `base_url` | Production URL | Auto-set by mode; can be overridden manually |
+| `timeout` | `30` | Request timeout in seconds |
+| `open_timeout` | `10` | Connection open timeout in seconds |
+| `logger` | `nil` | Logger instance for request/response logging |
+
+### Default URLs
 
+| Mode | URL |
+|------|-----|
+| `:production` | `https://api.business.govt.nz/gateway/nzbn/v5` |
+| `:sandbox` | `https://api.business.govt.nz/sandbox/nzbn/v5` |
+
+You can also set a custom `base_url` directly, which overrides the mode:
+
+```ruby
 Nzbn.configure do |config|
   config.api_key = 'your-api-key'
-  config.base_url = 'https://api.business.govt.nz/gateway/nzbn/v5'  # default
-  config.timeout = 30  # optional, default 30 seconds
-  config.logger = Logger.new(STDOUT)  # optional, enables request/response logging
+  config.base_url = 'https://custom-url.example.com/nzbn/v5'
 end
 ```
 

data/lib/nzbn/configuration.rb

@@ -3,24 +3,64 @@
 module Nzbn
   # Configuration class for NZBN client settings
   #
-  # @example
+  # @example Production mode (default)
   #   Nzbn.configure do |config|
   #     config.api_key = 'your-api-key'
-  #     config.base_url = 'https://api.business.govt.nz/gateway/nzbn/v5'
-  #     config.timeout = 30
+  #   end
+  #
+  # @example Sandbox mode
+  #   Nzbn.configure do |config|
+  #     config.api_key = 'your-api-key'
+  #     config.mode = :sandbox
+  #   end
+  #
+  # @example Custom base URL (overrides mode)
+  #   Nzbn.configure do |config|
+  #     config.api_key = 'your-api-key'
+  #     config.base_url = 'https://custom-url.example.com/nzbn/v5'
   #   end
   #
   class Configuration
-    attr_accessor :api_key, :base_url, :timeout, :open_timeout, :logger
+    MODES = %i[production sandbox].freeze
+
+    attr_accessor :api_key, :timeout, :open_timeout, :logger
+    attr_reader :mode, :base_url
 
     def initialize
       @api_key = nil
-      @base_url = Nzbn::DEFAULT_BASE_URL
+      @mode = :production
+      @base_url = Nzbn::PRODUCTION_BASE_URL
       @timeout = 30
       @open_timeout = 10
       @logger = nil
     end
 
+    # Set the mode (:production or :sandbox).
+    # This automatically updates base_url to the corresponding default URL.
+    def mode=(value)
+      value = value.to_sym
+
+      unless MODES.include?(value)
+        raise ArgumentError, "Invalid mode: #{value}. Must be one of: #{MODES.join(', ')}"
+      end
+
+      @mode = value
+      @base_url = value == :sandbox ? Nzbn::SANDBOX_BASE_URL : Nzbn::PRODUCTION_BASE_URL
+    end
+
+    # Set a custom base URL. This overrides the mode-derived URL.
+    def base_url=(value)
+      @base_url = value
+    end
+
+    def sandbox?
+      @mode == :sandbox
+    end
+
+    def production?
+      @mode == :production
+    end
+
     def valid?
       !api_key.nil? && !api_key.empty?
     end

data/lib/nzbn/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Nzbn
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
 end

data/lib/nzbn.rb

@@ -50,7 +50,9 @@ require_relative 'nzbn/api/history'
 #   entities = client.entities.search(search_term: 'Company Name')
 #
 module Nzbn
-  DEFAULT_BASE_URL = 'https://api.business.govt.nz/gateway/nzbn/v5'
+  PRODUCTION_BASE_URL = 'https://api.business.govt.nz/gateway/nzbn/v5'
+  SANDBOX_BASE_URL = 'https://api.business.govt.nz/sandbox/nzbn/v5'
+  DEFAULT_BASE_URL = PRODUCTION_BASE_URL # backward compatibility
 
   class << self
     attr_accessor :configuration

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nzbn-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Nhan Nguyen