scanii-ruby 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9fddc91c85da53168797a052626eb0fe200d675267b0752ff2d9e40e08c977e
-  data.tar.gz: 1438bf8d7cd1aa58747a898a6aed657cca75b5108b5ba0f4090511725e39d861
+  metadata.gz: 8b7caeccb8435e1085c555d60e2c0000ed7c57713fce50087be9d4fa33f6e4d1
+  data.tar.gz: e37e050290e8d7e38605861b317040cde9819eda9088e6b0289e836372053e64
 SHA512:
-  metadata.gz: 69e26e752018a0792cf7f8dcb9bf0b49667c454186967f7193668dc5e24f12808c6f7c1ddf131b570f1045005d9b212233e74a22b1dd6b06417571cb71007b1a
-  data.tar.gz: a235aef9683b29e8111235cfbe11787c94594e897a0536703a1cfb7f546f7502c4355b1ccfa2254115af2495075a678c3e99a911f6263e20dd748752d51a0bc3
+  metadata.gz: ae9ced99eb6909f3fa06840a519d953ff77ca729b84ee4a35273dd7bdaaf406c2853b09ba68111a395705bb9a8f7ccd16893eb17b3c86d2844cfc6afddbb8cb1
+  data.tar.gz: 8117f19a3d7e78d1451b01ca9a0e12bf1d2716b43fb664362a6edce5323022aec3742a1ae24f59f99cc824c74dff8476c58513936a44b3658a6b6b98c3b460ee

data/CHANGELOG.md

@@ -2,6 +2,32 @@
 
 All notable changes to `scanii-ruby` are documented here. Versions follow [SemVer](https://semver.org).
 
+## [1.4.0] — split result and trace deletion
+
+### Added
+
+- `Scanii::Client#delete(id)` — deletes a previously processed file result
+  (`DELETE /files/{id}`). Returns `true` on 204; the processing trace is left intact.
+- `Scanii::Client#delete_trace(id)` — deletes the processing trace separately
+  (`DELETE /files/{id}/trace`). Returns `true` on 204; the processing result is left intact.
+
+  The two resources are independent: deleting one does not remove the other.
+  To erase a scan entirely, call both.
+
+### Changed
+
+- Dropped the "v2.2 preview" designation from `retrieve_trace` and `process_from_url`
+  in the README and RDoc. Neither is marked preview in the API contract; the methods
+  themselves are unchanged.
+
+### Fixed
+
+- Path segments are now encoded with `URI.encode_uri_component` rather than
+  `URI.encode_www_form_component`, which rendered a space as `+`. Inside a path a
+  `+` is a literal plus, so an id containing a space reached the server corrupted.
+  Affects every id-taking method. Scanii-issued ids are hex, so this was not
+  reachable in practice with server-generated ids.
+
 ## [1.3.1] — dependency refresh
 
 ### Changed

data/README.md

@@ -60,15 +60,21 @@ puts "findings: #{result.findings.inspect}"
 | `process_file(path, metadata:, callback:)` | `POST /files` | `Scanii::ProcessingResult` |
 | `process_async(io, filename:, content_type:, metadata:, callback:)` | `POST /files/async` | `Scanii::PendingResult` |
 | `process_async_file(path, metadata:, callback:)` | `POST /files/async` | `Scanii::PendingResult` |
-| `process_from_url(location, callback:, metadata:)` | `POST /files` | `Scanii::ProcessingResult` (v2.2 preview) |
+| `process_from_url(location, callback:, metadata:)` | `POST /files` | `Scanii::ProcessingResult` |
 | `fetch(url, metadata:, callback:)` | `POST /files/fetch` | `Scanii::PendingResult` |
 | `retrieve(id)` | `GET /files/{id}` | `Scanii::ProcessingResult` |
-| `retrieve_trace(id)` | `GET /files/{id}/trace` | `Scanii::TraceResult` or `nil` (v2.2 preview) |
+| `retrieve_trace(id)` | `GET /files/{id}/trace` | `Scanii::TraceResult` or `nil` |
+| `delete(id)` | `DELETE /files/{id}` | `true` |
+| `delete_trace(id)` | `DELETE /files/{id}/trace` | `true` |
 | `ping` | `GET /ping` | `true` |
 | `create_auth_token(timeout_seconds)` | `POST /auth/tokens` | `Scanii::AuthToken` |
 | `retrieve_auth_token(id)` | `GET /auth/tokens/{id}` | `Scanii::AuthToken` |
 | `delete_auth_token(id)` | `DELETE /auth/tokens/{id}` | `true` |
 
+`delete` and `delete_trace` act on independent resources: deleting a scan result
+leaves its trace readable, and deleting a trace leaves the result readable. To erase
+a scan entirely, call both.
+
 Full API reference: <https://scanii.github.io/openapi/v22/>.
 
 ## Regional endpoints

data/lib/scanii/client.rb

@@ -202,9 +202,6 @@ module Scanii
     #
     # Returns nil when no trace exists for the given id (HTTP 404).
     #
-    # This is a v2.2 preview surface; the API shape may shift before it is
-    # marked stable.
-    #
     # @param id [String] processing id returned by process or process_file
     # @see https://scanii.github.io/openapi/v22/  GET /files/{id}/trace
     # @return [Scanii::TraceResult, nil]
@@ -218,6 +215,41 @@ module Scanii
       TraceResult.from_response(resp_body, headers)
     end
 
+    # Delete a previously processed file result.
+    #
+    # The processing trace is a separate resource and is *not* removed by this
+    # call — it stays readable via {#retrieve_trace} until you delete it with
+    # {#delete_trace}. To erase a scan entirely, call both.
+    #
+    # @param id [String] processing id returned by {#process} or {#process_file}
+    # @see https://scanii.github.io/openapi/v22/  DELETE /files/{id}
+    # @return [Boolean] true on 204
+    # @raise [Scanii::Error] when no result exists for the id (HTTP 404), which is
+    #   also what a repeated delete of the same id returns
+    def delete(id)
+      raise ArgumentError, "id must not be empty" if id.nil? || id.empty?
+
+      status, resp_body, headers = request("DELETE", "/files/#{url_encode(id)}")
+      raise_for_status(status, resp_body, headers) unless status == 204
+      true
+    end
+
+    # Delete the processing trace for a previously processed file, leaving the
+    # processing result itself untouched.
+    #
+    # @param id [String] processing id returned by {#process} or {#process_file}
+    # @see https://scanii.github.io/openapi/v22/  DELETE /files/{id}/trace
+    # @return [Boolean] true on 204
+    # @raise [Scanii::Error] when no trace exists for the id (HTTP 404), which is
+    #   also what a repeated delete of the same id returns
+    def delete_trace(id)
+      raise ArgumentError, "id must not be empty" if id.nil? || id.empty?
+
+      status, resp_body, headers = request("DELETE", "/files/#{url_encode(id)}/trace")
+      raise_for_status(status, resp_body, headers) unless status == 204
+      true
+    end
+
     # Submit a remote URL for synchronous scanning.
     #
     # Sends the URL as a +location+ field in a multipart/form-data POST to
@@ -228,9 +260,6 @@ module Scanii
     # +location+ must be a String URL. This matches the existing {#fetch}
     # String-URL convention and the Java reference (processFromUrl(String)).
     #
-    # This is a v2.2 preview surface; the API shape may shift before it is
-    # marked stable.
-    #
     # @param location [String] URL of the content to scan
     # @param callback [String, nil] URL to POST the result to on completion
     # @param metadata [Hash{String=>String}, nil] arbitrary key/value pairs attached to the result
@@ -431,8 +460,11 @@ module Scanii
       body
     end
 
+    # Path-segment encoding. NOT encode_www_form_component, which renders a
+    # space as "+" — correct for form bodies, wrong inside a path, where "+"
+    # is a literal plus and the id would arrive corrupted.
     def url_encode(value)
-      URI.encode_www_form_component(value)
+      URI.encode_uri_component(value)
     end
   end
 end

data/lib/scanii/trace_result.rb

@@ -3,9 +3,6 @@ require "json"
 module Scanii
   # Result of Client#retrieve_trace — ordered processing events for a scan.
   #
-  # This is a v2.2 preview surface; the API shape may shift before it is
-  # marked stable.
-  #
   # @see https://scanii.github.io/openapi/v22/
   class TraceResult
     attr_reader :id, :events, :request_id, :host_id, :raw_response

data/lib/scanii/version.rb

@@ -1,3 +1,3 @@
 module Scanii
-  VERSION = "1.3.1".freeze
+  VERSION = "1.4.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scanii-ruby
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Scanii