class Riffer::FilePart

Represents a file attachment (image or document) in a conversation.

Supports two input sources: - URLs (stored and passed to providers that support them via +from_url+) - Raw base64 data (via +new+)

file = Riffer::FilePart.from_url(“example.com/doc.pdf”, media_type: “application/pdf”) file.url? # => true file.document? # => true

Constants

MEDIA_TYPES
SUPPORTED_MEDIA_TYPES

Attributes

data [R]

Returns the base64-encoded data, or nil for URL-only sources.

filename [R]

The filename, if available.

media_type [R]

The MIME type of the file.

Public Class Methods

from_url (url, media_type: nil)

Source

# File lib/riffer/file_part.rb, line 65
def self.from_url(url, media_type: nil)
  unless media_type
    ext = ::File.extname(URI.parse(url).path).downcase
    media_type = MEDIA_TYPES[ext]
    raise Riffer::ArgumentError, "Cannot detect media type from URL; provide media_type explicitly" unless media_type
  end

  new(url: url, media_type: media_type)
end

Creates a FilePart from a URL.

The URL is stored and passed directly to providers that support URL sources. If +media_type+ is not provided, it is detected from the URL path extension.

Raises Riffer::ArgumentError if media_type cannot be detected.

: (String, ?media_type: String?) -> Riffer::FilePart

new (media_type:, data: nil, filename: nil, url: nil)

Source

# File lib/riffer/file_part.rb, line 47
def initialize(media_type:, data: nil, filename: nil, url: nil)
  raise Riffer::ArgumentError, "Either data or url must be provided" if data.nil? && url.nil?
  raise Riffer::ArgumentError, "Unsupported media type: #{media_type}" unless SUPPORTED_MEDIA_TYPES.include?(media_type)

  @data = data
  @media_type = media_type
  @filename = filename
  @url_string = url
end

Creates a FilePart from raw base64 data or a URL.

At least one of +data+ or +url+ must be provided.

Raises Riffer::ArgumentError if neither data nor url is provided, or if media_type is not supported.

: (media_type: String, ?data: String?, ?filename: String?, ?url: String?) -> void

Public Instance Methods

document? ()

Source

# File lib/riffer/file_part.rb, line 102
def document?
  !image?
end

Returns true if the file is a document (not an image).

: () -> bool

image? ()

Source

# File lib/riffer/file_part.rb, line 95
def image?
  media_type.start_with?("image/")
end

Returns true if the file is an image.

: () -> bool

to_h ()

Source

# File lib/riffer/file_part.rb, line 109
def to_h
  hash = {media_type: media_type}
  hash[:data] = @data if @data
  hash[:url] = @url_string if @url_string
  hash[:filename] = filename if filename
  hash
end

Serializes the FilePart to a hash.

: () -> Hash[Symbol, untyped]

url ()

Source

# File lib/riffer/file_part.rb, line 81
def url
  @url_string
end

Returns the URL if the source was a URL, nil otherwise.

: () -> String?

url? ()

Source

# File lib/riffer/file_part.rb, line 88
def url?
  !@url_string.nil?
end

Returns true if the source was a URL.

: () -> bool