node-red 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a448f70ca26bba12cb8a9d4f6a25f93b2956e3144c70f2b215a5b0d1efa320f
-  data.tar.gz: abd51032ec4f34f15f1ef1e5b00dea2c71a7bc4135b519f1838145bb00be42cb
+  metadata.gz: 9cc4a2ebc55b4f440b05fdb7209304381bafee347ef54257306bdf74b196963d
+  data.tar.gz: 151b1bb1140a55798308f499077ea575826010b8c2587a19efe277bbc6371ae0
 SHA512:
-  metadata.gz: 1421fecb786a1a74a5db7f094717a28070468a904ad8b67f43c97250c928424a831d76a30fb340f11c369dabb631f55cc0f129edaf9d9cd62604337bbb6ec92b
-  data.tar.gz: 9dcd66078d904b340be8f97faae4730112fc8f41eecf5b975e74efffd1af96033a79bc1efce9be944519724c144841d02308403d9561b198971ed27050d55bac
+  metadata.gz: 80f109e87d03189d1513944d074b02b7292988229a16c1b285f87e1abfbfb402a9f648a09d2458e5d07bd6cbd6e3168e31cda8c5897d007363f2cb10a643860e
+  data.tar.gz: 61951643190f2f562b81836600e84e81c843353a1798413eb1f8007a3d46b4be1bd3dbcf815728261bb51a699cf483a8bbcb9236b0c163ff1db4edae737d30f7

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## [0.2.0] - 2025-10-28
+
+### Added
+- Structured error classes with contextual information (`status`, `code`, `details`)
+- Extensive WebMock-backed RSpec coverage for every Admin API endpoint and error path
+
+### Changed
+- Improved error handling to map Node-RED response codes (400/401/404/409/5xx) to dedicated exceptions
+- Enhanced JSON parsing safeguards on responses and errors for clearer diagnostics
+- Updated README with advanced error-handling guidance
+
 ## [0.1.0] - 2025-10-28
 
 - Initial release

data/README.md

@@ -140,6 +140,16 @@ rescue Node::Red::ApiError => e
 end
 ```
 
+Each error object carries contextual information to help with debugging:
+
+```ruby
+rescue Node::Red::ApiError => e
+  puts e.status   # => 400, 401, 404, 409, 500, ...
+  puts e.code     # => "invalid_request", "module_already_loaded", ... (may be nil)
+  puts e.details  # => full parsed response body, if available
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/examples/flow_management.rb

@@ -56,44 +56,6 @@ begin
   puts "=== Deploying Complete Flow Configuration ==="
 
   # Create a simple flow with an inject and debug node
-  complete_flows = [
-    {
-      id: "flow1",
-      type: "tab",
-      label: "Test Flow"
-    },
-    {
-      id: "inject1",
-      type: "inject",
-      z: "flow1",
-      name: "Test Inject",
-      props: [{ p: "payload" }],
-      repeat: "",
-      crontab: "",
-      once: false,
-      onceDelay: 0.1,
-      topic: "",
-      payload: "Hello from Ruby!",
-      payloadType: "str",
-      x: 150,
-      y: 100
-    },
-    {
-      id: "debug1",
-      type: "debug",
-      z: "flow1",
-      name: "Test Debug",
-      active: true,
-      tosidebar: true,
-      console: false,
-      tostatus: false,
-      complete: "payload",
-      targetType: "msg",
-      x: 350,
-      y: 100,
-      wires: []
-    }
-  ]
 
   # NOTE: Be careful with deploy_flows as it replaces ALL flows
   # Uncomment the following lines to deploy

data/lib/node/red/client.rb

@@ -286,34 +286,70 @@ module Node
       def handle_response(response)
         case response
         when Net::HTTPSuccess
-          response.body && !response.body.empty? ? JSON.parse(response.body) : {}
+          parse_response_body(response)
+        when Net::HTTPBadRequest
+          raise_api_error(BadRequestError, response)
         when Net::HTTPUnauthorized
-          raise AuthenticationError, "Authentication failed: #{response.code} #{response.message}"
+          raise_api_error(AuthenticationError, response)
         when Net::HTTPNotFound
-          raise NotFoundError, "Resource not found: #{response.code} #{response.message}"
+          raise_api_error(NotFoundError, response)
+        when Net::HTTPConflict
+          raise_api_error(ConflictError, response)
         when Net::HTTPClientError
-          error_message = parse_error_message(response)
-          raise ApiError, "API error: #{response.code} #{error_message}"
+          raise_api_error(ApiError, response)
         when Net::HTTPServerError
-          raise ServerError, "Server error: #{response.code} #{response.message}"
+          raise_api_error(ServerError, response)
         else
-          raise ApiError, "Unexpected response: #{response.code} #{response.message}"
+          raise_api_error(UnexpectedResponseError, response)
         end
       end
 
-      # Parse error message from response
+      # Parse a successful HTTP response body, ensuring JSON content
       #
       # @param response [Net::HTTPResponse] The HTTP response
-      # @return [String] Error message
-      def parse_error_message(response)
-        return response.message unless response.body && !response.body.empty?
-
-        begin
-          error_data = JSON.parse(response.body)
-          error_data["message"] || error_data["error"] || response.message
-        rescue JSON::ParserError
-          response.message
-        end
+      # @return [Hash, Array] Parsed JSON response or empty hash for blank body
+      def parse_response_body(response)
+        body = response.body
+        return {} if body.nil? || body.strip.empty?
+
+        JSON.parse(body)
+      rescue JSON::ParserError => e
+        raise UnexpectedResponseError.new(
+          "Invalid JSON response: #{e.message}",
+          status: response.code.to_i,
+          details: { body: body }
+        )
+      end
+
+      # Raise a structured API error based on the HTTP response
+      #
+      # @param error_class [Class<ApiError>] The error class to raise
+      # @param response [Net::HTTPResponse] The HTTP response
+      # @raise [ApiError]
+      def raise_api_error(error_class, response)
+        message, error_code, details = extract_error_details(response)
+        raise error_class.new(
+          message,
+          status: response.code.to_i,
+          code: error_code,
+          details: details
+        )
+      end
+
+      # Extract error details from a failed HTTP response
+      #
+      # @param response [Net::HTTPResponse] The HTTP response
+      # @return [Array(String, String, Hash, nil)] message, error code and raw details
+      def extract_error_details(response)
+        body = response.body
+        return [response.message, nil, nil] if body.nil? || body.strip.empty?
+
+        data = JSON.parse(body)
+        message = data["message"] || data["error"] || response.message
+        error_code = data["code"]
+        [message, error_code, data]
+      rescue JSON::ParserError
+        [response.message, nil, { raw_body: body }]
       end
     end
   end

data/lib/node/red/errors.rb

@@ -2,16 +2,34 @@
 
 module Node
   module Red
-    # Base error class for Node-RED API errors
-    class ApiError < StandardError; end
+    # Base error class for Node-RED API errors that keeps rich context
+    class ApiError < StandardError
+      attr_reader :status, :code, :details
 
-    # Raised when authentication fails
+      def initialize(message, status:, code: nil, details: nil)
+        super(message)
+        @status = status
+        @code = code
+        @details = details
+      end
+    end
+
+    # Raised when the request is malformed (HTTP 400)
+    class BadRequestError < ApiError; end
+
+    # Raised when authentication fails (HTTP 401)
     class AuthenticationError < ApiError; end
 
-    # Raised when a resource is not found
+    # Raised when a resource is not found (HTTP 404)
     class NotFoundError < ApiError; end
 
+    # Raised when there is a version mismatch (HTTP 409)
+    class ConflictError < ApiError; end
+
     # Raised when the server returns a 5xx error
     class ServerError < ApiError; end
+
+    # Raised when the response type is unexpected
+    class UnexpectedResponseError < ApiError; end
   end
 end

data/lib/node/red/version.rb

@@ -2,6 +2,6 @@
 
 module Node
   module Red
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: node-red
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Davide Santangelo