class Riffer::Messages::FilePart

Represents a file attachment (image or document) — from a URL (from_url) or raw base64 data (new).

Constants

MEDIA_TYPES: @rbs @url_string: String?
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_hash (file)

Source

# File lib/riffer/messages/file_part.rb, line 66
def self.from_hash(file)
  return file if file.is_a?(Riffer::Messages::FilePart)

  unless file.is_a?(Hash)
    raise Riffer::ArgumentError, "File must be a Hash or FilePart object, got #{file.class}"
  end

  url = file[:url]
  data = file[:data]
  media_type = file[:media_type]
  filename = file[:filename]

  if url
    from_url(url, media_type: media_type)
  elsif data && media_type
    new(data: data, media_type: media_type, filename: filename)
  else
    raise Riffer::ArgumentError, "File hash must include :url or :data with :media_type"
  end
end

Builds a FilePart from a +{url:, media_type:}+ or +{data:, media_type:}+ hash, or returns file unchanged when it is already a FilePart. Raises Riffer::ArgumentError on an invalid hash.

from_url (url, media_type: nil)

Source

# File lib/riffer/messages/file_part.rb, line 51
def self.from_url(url, media_type: nil)
  unless media_type
    ext = ::File.extname(URI.parse(url).path.to_s).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, detecting media_type from the path extension when omitted. Raises Riffer::ArgumentError if it can’t be detected.

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

Source

# File lib/riffer/messages/file_part.rb, line 37
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

Raises Riffer::ArgumentError unless data or url is given and media_type is supported.

Public Instance Methods

document? ()

Source

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

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

image? ()

Source

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

Returns true if the file is an image.

to_h ()

Source

# File lib/riffer/messages/file_part.rb, line 126
def to_h
  hash = {media_type: media_type} #: Hash[Symbol, untyped]
  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.

url ()

Source

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

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

url? ()

Source

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

Returns true if the source was a URL.