Skip to content
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion lib/mailtrap.rb
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,9 @@
require_relative 'mailtrap/suppressions_api'
require_relative 'mailtrap/sending_domains_api'
require_relative 'mailtrap/projects_api'
require_relative 'mailtrap/inboxes_api'
require_relative 'mailtrap/sandbox_attachments_api'
Comment thread
i7an marked this conversation as resolved.
Outdated
require_relative 'mailtrap/sandbox_messages_api'
require_relative 'mailtrap/inboxes_api'

module Mailtrap
# @!macro api_errors
Expand Down
39 changes: 39 additions & 0 deletions lib/mailtrap/sandbox_attachment.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# frozen_string_literal: true

module Mailtrap
# Data Transfer Object for SandboxAttachment
# @see https://docs.mailtrap.io/developers/email-sandbox/email-sandbox-api/attachments
# @attr_reader id [Integer] The project ID
Comment thread
coderabbitai[bot] marked this conversation as resolved.
Outdated
# @attr_reader message_id [Integer] The message ID
# @attr_reader filename [String] The attachment filename
# @attr_reader attachment_type [String] The attachment type
# @attr_reader content_type [String] The attachment content type
# @attr_reader content_id [String] The attachment content ID
# @attr_reader transfer_encoding [String] The attachment transfer encoding
# @attr_reader attachment_size [Integer] The attachment size in bytes
# @attr_reader created_at [String] The attachment creation timestamp
# @attr_reader updated_at [String] The attachment update timestamp
# @attr_reader attachment_human_size [String] The attachment size in human-readable format
# @attr_reader download_path [String] The attachment download path
#
SandboxAttachment = Struct.new(
:id,
:message_id,
:filename,
:attachment_type,
:content_type,
:content_id,
:transfer_encoding,
:attachment_size,
:created_at,
:updated_at,
:attachment_human_size,
:download_path,
keyword_init: true
) do
# @return [Hash] The Project attributes as a hash

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Incorrect doc: to_h return description says "Project attributes".

Should say "SandboxAttachment attributes" — same copy-paste issue.

📝 Proposed fix
-    # `@return` [Hash] The Project attributes as a hash
+    # `@return` [Hash] The SandboxAttachment attributes as a hash
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
# @return [Hash] The Project attributes as a hash
# `@return` [Hash] The SandboxAttachment attributes as a hash
🤖 Prompt for AI Agents
In `@lib/mailtrap/sandbox_attachment.rb` at line 34, Update the YARD doc for the
to_h method in class SandboxAttachment: change the `@return` description from
"Project attributes" to "SandboxAttachment attributes" so the documentation
correctly reflects the method returns a Hash of SandboxAttachment attributes;
locate the to_h method and adjust its comment accordingly.

def to_h
super.compact
Comment thread
i7an marked this conversation as resolved.
Outdated
end
end
end
41 changes: 41 additions & 0 deletions lib/mailtrap/sandbox_attachments_api.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# frozen_string_literal: true

require_relative 'base_api'
require_relative 'sandbox_attachment'

module Mailtrap
class SandboxAttachmentsAPI
include BaseAPI

self.response_class = SandboxAttachment

# Retrieves a specific sandbox attachment
# @param inbox_id [Integer] The inbox ID
# @param sandbox_message_id [Integer] The sandbox message ID
# @param sandbox_attachment_id [Integer] The sandbox attachment ID
# @return [SandboxAttachment] Sandbox attachment object
# @!macro api_errors
def get(inbox_id, sandbox_message_id, sandbox_attachment_id)
Comment thread
i7an marked this conversation as resolved.
Outdated
response = client.get(
"#{base_path}/inboxes/#{inbox_id}/messages/#{sandbox_message_id}/attachments/#{sandbox_attachment_id}"
)
handle_response(response)
end

# Lists all sandbox messages for the account, limited up to 30 at once
# @param inbox_id [Integer] The inbox ID
# @param sandbox_message_id [Integer] The sandbox message ID
# @return [Array<SandboxAttachment>] Array of sandbox message objects
Comment thread
coderabbitai[bot] marked this conversation as resolved.
Outdated
# @!macro api_errors
def list(inbox_id, sandbox_message_id)
response = client.get("#{base_path}/inboxes/#{inbox_id}/messages/#{sandbox_message_id}/attachments")
response.map { |item| handle_response(item) }
end

private

def base_path
"/api/accounts/#{account_id}"
end
end
end

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading