nzbn-ruby 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e28560a8398401697187db8a8e71118ea1c85d6153edfdcd1897d90abb5e30a8
-  data.tar.gz: e3efe3817893e5522e4ab55079997d75c7b8eff8aa87d97769fda633ac892957
+  metadata.gz: 0bc9736578fcb4a9663e87a28d910e91dbfdc9acf724f30c09bfc03fb47b5e3f
+  data.tar.gz: 1fffb71fac5bf19a6192220b89674212066f2be603fd37c2a6d8d4f7f8f6cf3f
 SHA512:
-  metadata.gz: ee114a941472f60233c1566824c3bc23b7f8a137bd313518cd6987ac2f7964a4cd3720da12bd1598956a54a512c1d95857d3478ff05b86fb6c6e55f6acac4002
-  data.tar.gz: 39edce821af32feabb8abb760cd552518602833ccfb0293f40b1f6f39c490e404f0c1a78a377e59e40755157a35a00d632406cf2db960fd9a13318cf42efb98f
+  metadata.gz: c5de87bf46f1d4bb736a5bb42815e25524c359e7c3e98b9f5b83fdf854862a4de960c80a1a43a25c18214e485660820cbbcd30003b40ba9cee7a5e7b52ff0403
+  data.tar.gz: 7efe36fe483fe7a4ca917b313e65466aabef6539b8e8dc1ec83666df6ca0c64c96923d53f54782e5e69656fedf697ad74a5d63e80365be2268547aafde5d9f28

data/CHANGELOG.md

@@ -5,10 +5,23 @@ 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.4] - 2026-02-09
+
+### Added
+- Added request/response logging with configurable logger
+- Logs request ID, HTTP method, URL before each API call
+- Logs response status after each API call
+
+## [0.1.3] - 2026-02-09
+
+### Fixed
+- Fixed `:json is not registered on Faraday::Request` error by removing middleware dependency
+- Manually handle JSON encoding/decoding for better compatibility with Faraday 1.x
+
 ## [0.1.2] - 2026-02-09
 
 ### Fixed
-- Update gem version.
+- Update dependency gems.
 
 ## [0.1.1] - 2026-02-09
 

data/README.md

@@ -33,10 +33,13 @@ 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'
+
 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
 end
 ```
 

data/lib/nzbn/client.rb

@@ -109,21 +109,18 @@ module Nzbn
 
     def connection
       @connection ||= Faraday.new(url: configuration.base_url) do |conn|
-        conn.request :json
-        conn.response :json, content_type: /\bjson$/
         conn.adapter Faraday.default_adapter
 
         conn.options.timeout = configuration.timeout
         conn.options.open_timeout = configuration.open_timeout
-
-        if configuration.logger
-          conn.response :logger, configuration.logger
-        end
       end
     end
 
     def request(method, path, data, headers)
       request_id = SecureRandom.uuid
+      full_url = "#{configuration.base_url}#{path}"
+
+      log_request(method, full_url, request_id, data)
 
       merged_headers = default_headers(request_id).merge(headers)
 
@@ -135,10 +132,11 @@ module Nzbn
         when :get, :delete
           req.params = data unless data.empty?
         else
-          req.body = data
+          req.body = JSON.generate(data) unless data.empty?
         end
       end
 
+      log_response(response, request_id)
       handle_response(response)
     rescue Faraday::TimeoutError => e
       raise TimeoutError, "Request timed out: #{e.message}"
@@ -146,6 +144,21 @@ module Nzbn
       raise ConnectionError, "Connection failed: #{e.message}"
     end
 
+    def log_request(method, url, request_id, data)
+      return unless configuration.logger
+
+      configuration.logger.info("[NZBN] Request ID: #{request_id}")
+      configuration.logger.info("[NZBN] #{method.to_s.upcase} #{url}")
+      configuration.logger.debug("[NZBN] Request data: #{data.inspect}") unless data.empty?
+    end
+
+    def log_response(response, request_id)
+      return unless configuration.logger
+
+      configuration.logger.info("[NZBN] Response ID: #{request_id} - Status: #{response.status}")
+      configuration.logger.debug("[NZBN] Response body: #{response.body[0..500]}...")
+    end
+
     def default_headers(request_id)
       {
         'Ocp-Apim-Subscription-Key' => configuration.api_key,
@@ -156,24 +169,34 @@ module Nzbn
     end
 
     def handle_response(response)
+      body = parse_json(response.body)
+
       case response.status
       when 200..299
-        response.body
+        body
       when 400
-        raise ValidationError.new(response: response.body, status: response.status)
+        raise ValidationError.new(response: body, status: response.status)
       when 401
-        raise AuthenticationError.new('Authentication failed', response: response.body, status: response.status)
+        raise AuthenticationError.new('Authentication failed', response: body, status: response.status)
       when 403
-        raise AuthorizationError.new('Authorization denied', response: response.body, status: response.status)
+        raise AuthorizationError.new('Authorization denied', response: body, status: response.status)
       when 404
-        raise NotFoundError.new('Resource not found', response: response.body, status: response.status)
+        raise NotFoundError.new('Resource not found', response: body, status: response.status)
       when 412
-        raise PreconditionFailedError.new('Precondition failed', response: response.body, status: response.status)
+        raise PreconditionFailedError.new('Precondition failed', response: body, status: response.status)
       when 500..599
-        raise ServerError.new('Server error', response: response.body, status: response.status)
+        raise ServerError.new('Server error', response: body, status: response.status)
       else
-        raise ApiError.new("Unexpected response: #{response.status}", response: response.body, status: response.status)
+        raise ApiError.new("Unexpected response: #{response.status}", response: body, status: response.status)
       end
     end
+
+    def parse_json(body)
+      return nil if body.nil? || body.empty?
+
+      JSON.parse(body)
+    rescue JSON::ParserError
+      body
+    end
   end
 end

data/lib/nzbn/version.rb

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

metadata

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