reve_ai 0.1.1 → 0.2.1

data/lib/reve_ai/response.rb

@@ -3,9 +3,13 @@
 module ReveAI
   # Base response wrapper for API responses.
   #
-  # Provides access to HTTP status, headers, and parsed response body.
+  # Provides access to HTTP status, headers, and response body. The body is a
+  # parsed Hash for JSON responses, or the raw image String (bytes) when the
+  # API answers with a binary body (Accept: image/*); in that case all
+  # metadata is carried by the X-Reve-* response headers.
   #
   # @see ImageResponse
+  # @see LayoutResponse
   class Response
     # @return [Integer] HTTP status code
     attr_reader :status
@@ -13,14 +17,15 @@ module ReveAI
     # @return [Hash] Response headers
     attr_reader :headers
 
-    # @return [Hash] Parsed response body
+    # @return [Hash, String] Parsed response body, or raw bytes String
+    #   for binary (image/*) responses
     attr_reader :body
 
     # Creates a new response wrapper.
     #
     # @param status [Integer] HTTP status code
     # @param headers [Hash] Response headers
-    # @param body [Hash] Parsed response body
+    # @param body [Hash, String] Parsed response body, or raw bytes String
     def initialize(status:, headers:, body:)
       @status = status
       @headers = headers
@@ -34,20 +39,42 @@ module ReveAI
       status >= 200 && status < 300
     end
 
+    # Checks if the response body is raw binary data (e.g., image bytes).
+    #
+    # @return [Boolean] true if body is not a parsed JSON Hash
+    def binary?
+      !body.is_a?(Hash)
+    end
+
     # Returns the request ID for this response.
     #
     # Useful for debugging and support requests.
     #
     # @return [String, nil] Request ID from body or headers
     def request_id
-      body[:request_id] || headers["x-reve-request-id"]
+      body_value(:request_id) || headers["x-reve-request-id"]
+    end
+
+    private
+
+    # Reads a key from the body when it is a Hash (JSON response).
+    #
+    # Binary (String) bodies have no keys; header fallbacks apply instead.
+    #
+    # @param key [Symbol] Body key to read
+    # @return [Object, nil] Body value, or nil for binary bodies
+    # @api private
+    def body_value(key)
+      body[key] if body.is_a?(Hash)
     end
   end
 
   # Response wrapper for image generation API responses.
   #
   # Provides convenient accessors for image data, version info,
-  # content policy status, and credit usage.
+  # content policy status, and credit usage. All accessors work for both
+  # JSON responses (values from the parsed body) and binary responses
+  # (values from the X-Reve-* headers).
   #
   # @example Accessing image data
   #   result = client.images.create(prompt: "A sunset")
@@ -66,28 +93,48 @@ module ReveAI
   #
   # @see Response
   class ImageResponse < Response
-    # Returns the base64 encoded image data.
+    # Returns the image data.
     #
-    # The image is in PNG format. Use Base64.decode64 to get raw bytes.
+    # For JSON responses this is the base64 encoded image; for binary
+    # responses (Accept: image/*) it is the raw image bytes in the
+    # negotiated format, ready to write to disk without decoding.
     #
-    # @return [String, nil] Base64 encoded PNG image data
+    # @return [String, nil] Base64 encoded image data (JSON response) or
+    #   raw image bytes (binary response)
     #
-    # @example Save to file
+    # @example Save a JSON (base64) response to file
     #   require "base64"
-    #   png_bytes = Base64.decode64(result.image)
-    #   File.binwrite("output.png", png_bytes)
+    #   File.binwrite("output.png", Base64.decode64(result.image))
+    #
+    # @example Save a binary response to file (no Base64 decode needed)
+    #   File.binwrite("output.webp", result.image)
     def image
-      body[:image]
+      binary? ? body : body[:image]
     end
 
     # Alias for {#image}.
     #
-    # @return [String, nil] Base64 encoded PNG image data
+    # @note Despite the name, binary responses (Accept: image/*) return raw
+    #   image bytes here, not base64 data.
+    #
+    # @return [String, nil] Base64 encoded image data (JSON response) or
+    #   raw image bytes (binary response)
     # @see #image
     def base64
       image
     end
 
+    # Returns the layout object for this generation.
+    #
+    # Present on v2 create/render JSON responses; nil on v1 responses and
+    # on binary (Accept: image/*) responses.
+    #
+    # @return [Hash, nil] Layout Hash (e.g., +prompt+, +regions+, +width+,
+    #   +height+), or nil when absent
+    def layout
+      body_value(:layout)
+    end
+
     # Returns the model version used for generation.
     #
     # @return [String, nil] Model version (e.g., "reve-create@20250915")
@@ -95,7 +142,7 @@ module ReveAI
     # @example
     #   result.version # => "reve-create@20250915"
     def version
-      body[:version] || headers["x-reve-version"]
+      body_value(:version) || headers["x-reve-version"]
     end
 
     # Checks if the generated image violates content policy.
@@ -107,7 +154,7 @@ module ReveAI
     #     puts "Warning: Content policy violated"
     #   end
     def content_violation?
-      body[:content_violation] == true ||
+      body_value(:content_violation) == true ||
         headers["x-reve-content-violation"] == "true"
     end
 
@@ -118,7 +165,7 @@ module ReveAI
     # @example
     #   puts "This request used #{result.credits_used} credits"
     def credits_used
-      body[:credits_used] || headers["x-reve-credits-used"]&.to_i
+      body_value(:credits_used) || headers["x-reve-credits-used"]&.to_i
     end
 
     # Returns the number of credits remaining after this request.
@@ -130,7 +177,51 @@ module ReveAI
     #     puts "Warning: Low credit balance"
     #   end
     def credits_remaining
-      body[:credits_remaining] || headers["x-reve-credits-remaining"]&.to_i
+      body_value(:credits_remaining) || headers["x-reve-credits-remaining"]&.to_i
+    end
+  end
+
+  # Response wrapper for layout-only API responses.
+  #
+  # Returned by the v2 extract_layout and create_layout endpoints, which
+  # produce a layout object but no image. Accessors fall back to the
+  # X-Reve-* headers when the body carries no value.
+  #
+  # @example Inspecting a layout
+  #   result = client.v2.layouts.extract(image: base64_image)
+  #   result.layout # => { prompt: "...", regions: [...], width: 4096, height: 2560 }
+  #
+  # @see Response
+  # @see ImageResponse
+  class LayoutResponse < Response
+    # Returns the layout object.
+    #
+    # @return [Hash, nil] Layout Hash (e.g., +prompt+, +regions+, +width+,
+    #   +height+), or nil when absent
+    def layout
+      body_value(:layout)
+    end
+
+    # Checks if the request violates content policy.
+    #
+    # @return [Boolean] true if content policy was violated
+    def content_violation?
+      body_value(:content_violation) == true ||
+        headers["x-reve-content-violation"] == "true"
+    end
+
+    # Returns the number of credits used for this request.
+    #
+    # @return [Integer, nil] Credits consumed by this request
+    def credits_used
+      body_value(:credits_used) || headers["x-reve-credits-used"]&.to_i
+    end
+
+    # Returns the number of credits remaining after this request.
+    #
+    # @return [Integer, nil] Remaining credit balance
+    def credits_remaining
+      body_value(:credits_remaining) || headers["x-reve-credits-remaining"]&.to_i
     end
   end
 end

data/lib/reve_ai/version.rb

@@ -2,5 +2,5 @@
 
 module ReveAI
   # @return [String] Current gem version
-  VERSION = "0.1.1"
+  VERSION = "0.2.1"
 end

data/lib/reve_ai.rb

@@ -7,6 +7,10 @@ require_relative "reve_ai/response"
 require_relative "reve_ai/http/client"
 require_relative "reve_ai/resources/base"
 require_relative "reve_ai/resources/images"
+require_relative "reve_ai/resources/effects"
+require_relative "reve_ai/resources/v2"
+require_relative "reve_ai/resources/v2/images"
+require_relative "reve_ai/resources/v2/layouts"
 require_relative "reve_ai/client"
 
 # Ruby client for the Reve image generation API.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reve_ai
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - dpaluy
@@ -9,6 +9,20 @@ bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -37,8 +51,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-description: ReveAI provides a lightweight Faraday-based wrapper for the Reve image
-  generation API (create, edit, remix images).
+description: ReveAI was a lightweight Faraday-based wrapper for the Reve image generation
+  API (create, edit, remix images). The upstream public API sunsets on August 14,
+  2026; this gem is deprecated and will be unmaintained after the shutdown.
 email:
 - dpaluy@users.noreply.github.com
 executables: []
@@ -56,7 +71,11 @@ files:
 - lib/reve_ai/errors.rb
 - lib/reve_ai/http/client.rb
 - lib/reve_ai/resources/base.rb
+- lib/reve_ai/resources/effects.rb
 - lib/reve_ai/resources/images.rb
+- lib/reve_ai/resources/v2.rb
+- lib/reve_ai/resources/v2/images.rb
+- lib/reve_ai/resources/v2/layouts.rb
 - lib/reve_ai/response.rb
 - lib/reve_ai/version.rb
 homepage: https://github.com/dpaluy/reve_ai
@@ -69,6 +88,13 @@ metadata:
   source_code_uri: https://github.com/dpaluy/reve_ai
   changelog_uri: https://github.com/dpaluy/reve_ai/blob/master/CHANGELOG.md
   bug_tracker_uri: https://github.com/dpaluy/reve_ai/issues
+  deprecated: 'true'
+post_install_message: |
+  WARNING: The upstream Reve public API sunsets Friday, August 14, 2026.
+  This gem is deprecated and will be unmaintained after the shutdown.
+  Existing approved API users retain access through the sunset window; all other users can no longer access it, and new API onboarding is closed.
+  Unused paid credits begin full-refund processing Monday, August 17, 2026.
+  See the repository README for details: https://github.com/dpaluy/reve_ai#api-sunset-notice
 rdoc_options: []
 require_paths:
 - lib
@@ -85,5 +111,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.9
 specification_version: 4
-summary: Ruby client for the Reve image generation API.
+summary: Deprecated Ruby client for Reve's sunset image generation API.
 test_files: []