Skip to content

Add Sandbox Projects API #78

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
i7an merged 12 commits into from
Jan 13, 2026
Merged

Add Sandbox Projects API #78

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
7a51baf
Add Projects API
DagonWat Dec 9, 2025
657ad0a
Fix rubocop issues
DagonWat Dec 10, 2025
c5132a5
Add new examples and update Readme
DagonWat Dec 10, 2025
3cf8e26
Move Inboxes initialisation to ProjectApi
DagonWat Dec 23, 2025
2173be8
Fix failing rubocop
DagonWat Dec 23, 2025
107f2ba
Remove unnecessary header
DagonWat Jan 4, 2026
dee41d1
Remove to_h
DagonWat Jan 6, 2026
886a763
Fix handle respoinse
DagonWat Jan 6, 2026
471f831
Fix struct_match method
DagonWat Jan 7, 2026
605cc2e
Add cleaning up of credentials
DagonWat Jan 8, 2026
e12ab39
Cleanup email username
DagonWat Jan 8, 2026
193fee3
Clean user email leakage
DagonWat Jan 12, 2026
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
4 changes: 2 additions & 2 deletions lib/mailtrap/projects_api.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@ def delete(project_id)
base_delete(project_id)
end
Comment on lines +50 to +56

@coderabbitai coderabbitai Bot Jan 6, 2026

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

Update the return value documentation.

The YARD comment states @return nil, but base_delete returns the response from client.delete, which the specs expect to be a hash like { id: project_id }.

📝 Suggested fix 
-    # @return nil
+    # @return [Hash] The deleted project response, e.g., { id: project_id }
🤖 Prompt for AI Agents 
In @lib/mailtrap/projects_api.rb around lines 50 - 56, The YARD @return is
incorrect: the delete(project_id) method calls base_delete(project_id) which
returns the client response (e.g., a Hash like { id: project_id }), not nil;
update the comment for delete to reflect the actual return type and shape (for
example "@return [Hash] response hash containing the deleted project id" or
similar) and ensure any related docs/macro references match the new return
description; keep the method body unchanged (it should still call
base_delete(project_id)).


private

def handle_response(response)

@i7an i7an Jan 6, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

must be private.

build_entity(
response.merge(
Expand All @@ -64,8 +66,6 @@ def handle_response(response)
)
end

private

def base_path
"/api/accounts/#{account_id}/projects"
end
Expand Down
87 changes: 0 additions & 87 deletions ...ssettes/Mailtrap_EmailTemplatesAPI/_create/maps_response_data_to_EmailTemplate_object.yml
View file
Open in desktop

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

87 changes: 0 additions & 87 deletions ...ures/vcr_cassettes/Mailtrap_EmailTemplatesAPI/_create/returns_an_EmailTemplate_object.yml
View file
Open in desktop

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

Loading