Add Sandbox Projects API #78
Conversation
WalkthroughThis pull request introduces a complete Projects API module for Mailtrap, adding data transfer objects for projects and inboxes, along with REST API operations for listing, fetching, creating, updating, and deleting projects. Comprehensive test coverage and VCR cassettes are included. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 5
🧹 Nitpick comments (2)
spec/mailtrap/projects_api_spec.rb (1)
60-89: "with hash request" contexts don't exercise hash-argument callsBoth
#createand#updateexamples useproject_api.create(**request)andproject_api.update(project_id, **request)in their parent subjects (lines 61 and 108). The nested"with hash request"contexts (lines 76–89 and 129–142) only redefinelet(:request)but inherit the parent subject, so they still unpack the hash with**and hit the same code path.To verify both calling conventions, redefine
subjectin the nested contexts to pass the raw Hash argument:context 'with hash request' do + subject(:create) { project_api.create(request) } + let(:request) do { name: 'New Project' } end it 'maps response data to Project object' do expect(create).to be_a(Mailtrap::Project) expect(create).to have_attributes( - name: 'New Project' + name: 'New Project' ) end endApply the same fix to the
#updatecontext (lines 129–142), substitutingsubject(:update) { project_api.update(project_id, request) }.Also applies to: 129-142
lib/mailtrap/project.rb (1)
25-32: Use safe navigation (&.) for inbox mappingRubocop flags this code with Style/SafeNavigation. Simplify the initialization of
@inboxesusing safe navigation:- raw_inboxes = args[:inboxes] - @inboxes = - if raw_inboxes - raw_inboxes.map do |inbox| - inbox.is_a?(Mailtrap::Inbox) ? inbox : Mailtrap::Inbox.new(**inbox) - end - end + raw_inboxes = args[:inboxes] + @inboxes = raw_inboxes&.map do |inbox| + inbox.is_a?(Mailtrap::Inbox) ? inbox : Mailtrap::Inbox.new(**inbox) + endSemantics remain unchanged (
@inboxesisnilwhen no inboxes are provided), but this reduces nesting and aligns with idiomatic Ruby style.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (19)
lib/mailtrap.rb(1 hunks)lib/mailtrap/inbox.rb(1 hunks)lib/mailtrap/project.rb(1 hunks)lib/mailtrap/projects_api.rb(1 hunks)spec/fixtures/vcr_cassettes/Mailtrap_ProjectsAPI/_create/maps_response_data_to_Project_object.yml(1 hunks)spec/fixtures/vcr_cassettes/Mailtrap_ProjectsAPI/_create/when_API_returns_an_error/raises_a_Mailtrap_Error.yml(1 hunks)spec/fixtures/vcr_cassettes/Mailtrap_ProjectsAPI/_create/with_hash_request/maps_response_data_to_Project_object.yml(1 hunks)spec/fixtures/vcr_cassettes/Mailtrap_ProjectsAPI/_delete/returns_deleted_project_id.yml(1 hunks)spec/fixtures/vcr_cassettes/Mailtrap_ProjectsAPI/_delete/when_project_does_not_exist/raises_not_found_error.yml(1 hunks)spec/fixtures/vcr_cassettes/Mailtrap_ProjectsAPI/_get/maps_response_data_to_Project_object.yml(1 hunks)spec/fixtures/vcr_cassettes/Mailtrap_ProjectsAPI/_get/when_project_does_not_exist/raises_not_found_error.yml(1 hunks)spec/fixtures/vcr_cassettes/Mailtrap_ProjectsAPI/_list/maps_response_data_to_Project_objects.yml(1 hunks)spec/fixtures/vcr_cassettes/Mailtrap_ProjectsAPI/_list/when_api_key_is_incorrect/raises_authorization_error.yml(1 hunks)spec/fixtures/vcr_cassettes/Mailtrap_ProjectsAPI/_update/maps_response_data_to_Project_object.yml(1 hunks)spec/fixtures/vcr_cassettes/Mailtrap_ProjectsAPI/_update/when_project_does_not_exist/raises_not_found_error.yml(1 hunks)spec/fixtures/vcr_cassettes/Mailtrap_ProjectsAPI/_update/when_updating_only_name/updates_only_the_name_field.yml(1 hunks)spec/fixtures/vcr_cassettes/Mailtrap_ProjectsAPI/_update/with_hash_request/maps_response_data_to_Project_object.yml(1 hunks)spec/mailtrap/project_spec.rb(1 hunks)spec/mailtrap/projects_api_spec.rb(1 hunks)
🧰 Additional context used
🧬 Code graph analysis (5)
lib/mailtrap/inbox.rb (1)
lib/mailtrap/project.rb (1)
to_h(35-43)
spec/mailtrap/project_spec.rb (2)
lib/mailtrap/inbox.rb (1)
to_h(58-60)lib/mailtrap/project.rb (1)
to_h(35-43)
spec/mailtrap/projects_api_spec.rb (1)
lib/mailtrap/projects_api.rb (6)
list(18-20)include(8-67)get(26-28)create(36-38)update(46-48)delete(54-56)
lib/mailtrap/project.rb (1)
lib/mailtrap/inbox.rb (1)
to_h(58-60)
lib/mailtrap/projects_api.rb (1)
lib/mailtrap/base_api.rb (7)
supported_options(27-29)response_class(31-33)base_list(67-70)base_get(46-49)base_create(51-55)base_update(57-61)base_delete(63-65)
🪛 GitHub Actions: Ruby
spec/mailtrap/project_spec.rb
[error] 54-54: Rubocop: Layout/FirstArrayElementIndentation: Use 2 spaces for indentation in an array, relative to the first position after the preceding left parenthesis. ({ ...
[error] 59-59: Rubocop: Layout/FirstArrayElementIndentation: Indent the right bracket the same as the first position after the preceding left parenthesis. })
spec/mailtrap/projects_api_spec.rb
[error] 42-42: Rubocop: Layout/FirstArgumentIndentation: Indent the first argument one step more than the start of the previous line. (id: project_id, ...)
[error] 72-72: Rubocop: Layout/FirstArgumentIndentation: Indent the first argument one step more than the start of the previous line. (name: 'New Project')
[error] 86-86: Rubocop: Layout/FirstArgumentIndentation: Indent the first argument one step more than the start of the previous line. (name: 'New Project')
[error] 125-125: Rubocop: Layout/FirstArgumentIndentation: Indent the first argument one step more than the start of the previous line. (name: 'Updated Project')
[error] 139-139: Rubocop: Layout/FirstArgumentIndentation: Indent the first argument one step more than the start of the previous line. (name: 'Updated Project')
[error] 150-150: Rubocop: Layout/FirstArgumentIndentation: Indent the first argument one step more than the start of the previous line. (name: 'New Name Only')
lib/mailtrap/project.rb
[error] 15-15: Rubocop: Style/SymbolArray: Use %i or %I for an array of symbols. [:id, :name, :share_links, :inboxes, :permissions]
[error] 27-27: Rubocop: Style/SafeNavigation: Use safe navigation (&.) instead of checking if an object exists before calling the method. (if raw_inboxes ...)
🔇 Additional comments (9)
spec/fixtures/vcr_cassettes/Mailtrap_ProjectsAPI/_get/when_project_does_not_exist/raises_not_found_error.yml (1)
1-331: LGTM! Test fixture properly captures the not-found error scenario.The VCR cassette correctly records the project creation setup and the subsequent 404 response when attempting to retrieve a non-existent project, with sensitive data appropriately redacted.
spec/fixtures/vcr_cassettes/Mailtrap_ProjectsAPI/_update/when_updating_only_name/updates_only_the_name_field.yml (1)
1-333: LGTM! Fixture correctly validates partial update behavior.This cassette appropriately tests updating only the name field, demonstrating that the API supports partial updates without requiring all fields.
spec/fixtures/vcr_cassettes/Mailtrap_ProjectsAPI/_update/with_hash_request/maps_response_data_to_Project_object.yml (1)
1-333: LGTM! Test fixture correctly captures the update flow.The cassette appropriately records the project creation and update lifecycle, verifying the hash request format and response mapping.
lib/mailtrap/inbox.rb (1)
30-61: LGTM! Clean DTO implementation with appropriate serialization.The Struct-based approach with
keyword_init: trueand the compactedto_hoverride provide a clean, idiomatic Ruby DTO implementation.spec/fixtures/vcr_cassettes/Mailtrap_ProjectsAPI/_update/when_project_does_not_exist/raises_not_found_error.yml (1)
1-331: LGTM! Fixture properly tests update error handling.Correctly captures the 404 response when attempting to update a non-existent project.
lib/mailtrap.rb (1)
13-13: LGTM! Projects API properly wired into the module.The require statement is correctly positioned and follows the existing pattern for other API modules.
spec/fixtures/vcr_cassettes/Mailtrap_ProjectsAPI/_create/when_API_returns_an_error/raises_a_Mailtrap_Error.yml (1)
1-166: LGTM! Fixture correctly captures validation error response.Appropriately tests the API's validation behavior when creating a project with an invalid (empty) name, returning a 422 status with detailed error messages.
spec/fixtures/vcr_cassettes/Mailtrap_ProjectsAPI/_create/with_hash_request/maps_response_data_to_Project_object.yml (1)
1-168: LGTM! Fixture properly records successful project creation.Correctly captures the hash request format and the successful 200 response with full project details.
spec/mailtrap/projects_api_spec.rb (1)
39-45: Fixhave_attributesindentation to satisfy Rubocop Layout/FirstArgumentIndentationRubocop is flagging the first arguments to
have_attributesas over‑indented. Align them one indentation step past the previous line, e.g.:- expect(get).to have_attributes( - id: project_id, - name: 'Test Project' - ) + expect(get).to have_attributes( + id: project_id, + name: 'Test Project' + ) @@ - expect(create).to have_attributes( - name: 'New Project' - ) + expect(create).to have_attributes( + name: 'New Project' + ) @@ - expect(create).to have_attributes( - name: 'New Project' - ) + expect(create).to have_attributes( + name: 'New Project' + ) @@ - expect(update).to have_attributes( - name: 'Updated Project' - ) + expect(update).to have_attributes( + name: 'Updated Project' + ) @@ - expect(update).to have_attributes( - name: 'Updated Project' - ) + expect(update).to have_attributes( + name: 'Updated Project' + ) @@ - expect(update).to have_attributes( - name: 'New Name Only' - ) + expect(update).to have_attributes( + name: 'New Name Only' + )This should clear the Layout/FirstArgumentIndentation offenses reported in CI. Based on pipeline failures, this is currently blocking.
Also applies to: 69-74, 83-88, 122-127, 136-141, 147-151
| module Mailtrap | ||
| # Data Transfer Object for Inbox | ||
| # @see https://api-docs.mailtrap.io/docs/mailtrap-api-docs/ee252e413d78a-create-project | ||
| # @attr_reader id [Integer] The project ID |
There was a problem hiding this comment.
Fix incorrect documentation: field describes inbox ID, not project ID.
Line 6 incorrectly states "The project ID" but this documents the id field of the Inbox struct, not a project.
Apply this diff:
- # @attr_reader id [Integer] The project ID
+ # @attr_reader id [Integer] The inbox ID📝 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.
| # @attr_reader id [Integer] The project ID | |
| # @attr_reader id [Integer] The inbox ID |
🤖 Prompt for AI Agents
In lib/mailtrap/inbox.rb around line 6, the YARD doc for the Inbox struct's `id`
field incorrectly says "The project ID"; change the description to correctly
reflect that this is the inbox ID (e.g., "The inbox ID" or "The ID of the
inbox"). Update only that comment text so the @attr_reader reflects the inbox
identifier instead of a project identifier.
| # @attr_reader email_username_enabled [Boolean] Whether the email username is enabled | ||
| # @attr_reader sent_messages_count [Integer] The count of sent messages | ||
| # @attr_reader forwarded_messages_count [Integer] The count of forwarded messages | ||
| # @attr_reader used [Boolean] The used inbox size in MB |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
# First, let's examine the file structure and the inbox class
cat -n lib/mailtrap/inbox.rb | head -30Repository: mailtrap/mailtrap-ruby
Length of output: 2012
🏁 Script executed:
# Search for any API documentation or examples in the repository
find . -type f \( -name "*.md" -o -name "*.txt" -o -name "*.json" \) | head -20Repository: mailtrap/mailtrap-ruby
Length of output: 205
🏁 Script executed:
# Look for test fixtures or examples that might show the actual API response
fd -t f "fixture|example|spec|test" -i | grep -i inbox | head -20Repository: mailtrap/mailtrap-ruby
Length of output: 48
🏁 Script executed:
# Search for usages of the `used` attribute to understand its type
rg "\.used" -A 2 -B 2 --max-count 20Repository: mailtrap/mailtrap-ruby
Length of output: 48
🏁 Script executed:
# Check if there's any mention of the API structure or used attribute in the README or docs
rg "used" -i lib/mailtrap/inbox.rb -A 1 -B 1Repository: mailtrap/mailtrap-ruby
Length of output: 367
🏁 Script executed:
# Look at the full Inbox struct definition to understand all attributes
cat -n lib/mailtrap/inbox.rb | head -50Repository: mailtrap/mailtrap-ruby
Length of output: 2537
Change used attribute type from [Boolean] to [Integer].
The documentation describes "The used inbox size in MB", which is a numeric value, not a boolean. This is inconsistent with the [Boolean] type annotation. Following the pattern of similar attributes (max_size [Integer], sent_messages_count [Integer], max_message_size [Integer]), the type should be [Integer]:
- # @attr_reader used [Boolean] The used inbox size in MB
+ # @attr_reader used [Integer] The used inbox size in MB📝 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.
| # @attr_reader used [Boolean] The used inbox size in MB | |
| # @attr_reader used [Integer] The used inbox size in MB |
🤖 Prompt for AI Agents
In lib/mailtrap/inbox.rb around line 16, the YARD attribute comment for `used`
incorrectly documents its type as [Boolean] while it represents the used inbox
size in MB; change the type annotation to [Integer] to match the numeric
semantics and align with similar attributes (e.g., max_size,
sent_messages_count, max_message_size), updating the comment text if necessary
so it reads something like "# @attr_reader used [Integer] The used inbox size in
MB".
| def self.members | ||
| [:id, :name, :share_links, :inboxes, :permissions] | ||
| end |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
cd /tmp && git ls-files lib/mailtrap/project.rbRepository: mailtrap/mailtrap-ruby
Length of output: 136
🏁 Script executed:
cat -n lib/mailtrap/project.rb | head -25Repository: mailtrap/mailtrap-ruby
Length of output: 1136
🏁 Script executed:
# Check if Rubocop is available and run it on the target file
if command -v rubocop &> /dev/null; then
rubocop lib/mailtrap/project.rb --format json 2>/dev/null | head -200
else
echo "Rubocop not available in sandbox"
fiRepository: mailtrap/mailtrap-ruby
Length of output: 918
🏁 Script executed:
# Look for .rubocop.yml or similar config files
fd -e ".rubocop.yml" -e "rubocop.yml"Repository: mailtrap/mailtrap-ruby
Length of output: 48
Use %i[...] for the symbol array to satisfy Rubocop Style/SymbolArray
Rubocop is flagging the literal array of symbols. Switch to %i[...] for idiomatic style:
def self.members
- [:id, :name, :share_links, :inboxes, :permissions]
+ %i[id name share_links inboxes permissions]
endThis keeps behavior identical and clears the Style/SymbolArray offense.
📝 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.
| def self.members | |
| [:id, :name, :share_links, :inboxes, :permissions] | |
| end | |
| def self.members | |
| %i[id name share_links inboxes permissions] | |
| end |
🧰 Tools
🪛 GitHub Actions: Ruby
[error] 15-15: Rubocop: Style/SymbolArray: Use %i or %I for an array of symbols. [:id, :name, :share_links, :inboxes, :permissions]
🤖 Prompt for AI Agents
In lib/mailtrap/project.rb around lines 14 to 16, the literal array of symbols
should be rewritten using the %i[...] syntax to satisfy RuboCop
Style/SymbolArray; replace the current [:id, :name, :share_links, :inboxes,
:permissions] with the equivalent %i[id name share_links inboxes permissions] so
behavior remains identical and the linter warning is resolved.
| # Deletes a project | ||
| # @param project_id [Integer] The project ID | ||
| # @return nil | ||
| # @!macro api_errors | ||
| def delete(project_id) | ||
| base_delete(project_id) | ||
| end |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# First, let's find all delete methods in the lib directory
rg -n "def delete\(" lib/mailtrap --type rbRepository: mailtrap/mailtrap-ruby
Length of output: 92
🏁 Script executed:
#!/bin/bash
# Check the spec file to verify delete expectations
find . -name "*projects_api*spec*" -type fRepository: mailtrap/mailtrap-ruby
Length of output: 102
🏁 Script executed:
#!/bin/bash
# Look at the BaseAPI to understand base_delete behavior
find . -name "*base*api*" -type f | grep -E "\.(rb|py)$"Repository: mailtrap/mailtrap-ruby
Length of output: 92
🏁 Script executed:
#!/bin/bash
# Search for delete methods without type flag
rg -n "def delete\(" lib/mailtrap/Repository: mailtrap/mailtrap-ruby
Length of output: 489
🏁 Script executed:
#!/bin/bash
# Read the projects_api_spec.rb to verify delete expectations
cat ./spec/mailtrap/projects_api_spec.rbRepository: mailtrap/mailtrap-ruby
Length of output: 5345
🏁 Script executed:
#!/bin/bash
# Read the base_api.rb to understand base_delete
cat ./lib/mailtrap/base_api.rbRepository: mailtrap/mailtrap-ruby
Length of output: 2361
🏁 Script executed:
#!/bin/bash
# Read the Client class to see what delete returns
cat ./lib/mailtrap/client.rb | head -250Repository: mailtrap/mailtrap-ruby
Length of output: 7799
🏁 Script executed:
#!/bin/bash
# Also check projects_api.rb to see the full context
cat ./lib/mailtrap/projects_api.rbRepository: mailtrap/mailtrap-ruby
Length of output: 1692
🏁 Script executed:
#!/bin/bash
# Check other delete method YARD docs for consistency
grep -A 3 "def delete(" lib/mailtrap/*.rb | grep -E "(def delete|@return)"Repository: mailtrap/mailtrap-ruby
Length of output: 467
🏁 Script executed:
#!/bin/bash
# Check a couple of other spec files to see if they also expect hash return
grep -A 2 "it 'returns" spec/mailtrap/*_spec.rb | grep -E "(it 'returns|expect.*delete)"Repository: mailtrap/mailtrap-ruby
Length of output: 1662
Update #delete YARD documentation to reflect actual return value
The YARD comment for delete states # @return nil, but the spec in spec/mailtrap/projects_api_spec.rb expects it to return { id: project_id }. The implementation delegates to base_delete, which returns the raw response from client.delete.
Update the documentation to match the actual behavior:
- # @return nil
+ # @return [Hash] Deleted project identifier, e.g. { id: project_id }🤖 Prompt for AI Agents
In lib/mailtrap/projects_api.rb around lines 50 to 56, the YARD comment for
#delete incorrectly states `@return nil` while the method actually returns the
raw client response (expected by specs to be `{ id: project_id }`); update the
YARD block to reflect the actual return value (for example `# @return [Hash] the
deleted project response, e.g. { id: project_id }`) and ensure any other related
tags/comments describe that it delegates to base_delete/client.delete.
| expect(project.inboxes.map(&:to_h)).to eq([ | ||
| { | ||
| id: 456, | ||
| name: 'Test Inbox', | ||
| username: 'test@inbox.mailtrap.io' | ||
| } | ||
| ]) | ||
| end |
There was a problem hiding this comment.
Fix array indentation to resolve Rubocop violations.
The array starting at line 54 and closing at line 59 has incorrect indentation, causing CI failures.
Apply this diff to fix the indentation:
- expect(project.inboxes.map(&:to_h)).to eq([
- {
- id: 456,
- name: 'Test Inbox',
- username: 'test@inbox.mailtrap.io'
- }
- ])
+ expect(project.inboxes.map(&:to_h)).to eq(
+ [{
+ id: 456,
+ name: 'Test Inbox',
+ username: 'test@inbox.mailtrap.io'
+ }]
+ )📝 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.
| expect(project.inboxes.map(&:to_h)).to eq([ | |
| { | |
| id: 456, | |
| name: 'Test Inbox', | |
| username: 'test@inbox.mailtrap.io' | |
| } | |
| ]) | |
| end | |
| expect(project.inboxes.map(&:to_h)).to eq( | |
| [{ | |
| id: 456, | |
| name: 'Test Inbox', | |
| username: 'test@inbox.mailtrap.io' | |
| }] | |
| ) | |
| end |
🧰 Tools
🪛 GitHub Actions: Ruby
[error] 54-54: Rubocop: Layout/FirstArrayElementIndentation: Use 2 spaces for indentation in an array, relative to the first position after the preceding left parenthesis. ({ ...
[error] 59-59: Rubocop: Layout/FirstArrayElementIndentation: Indent the right bracket the same as the first position after the preceding left parenthesis. })
🤖 Prompt for AI Agents
In spec/mailtrap/project_spec.rb around lines 53 to 60, the multi-line array
used in the expectation is mis-indented causing RuboCop failures; fix it by
aligning the array elements and closing bracket with the expect call indent
level (indent the inner hash one additional level so each key/value and the
closing brace line up consistently and the final closing ]) aligns with the
expect(...).to eq([ line).
Motivation
Add Sandbox Projects API support for Rybu SDK
Changes
Summary by CodeRabbit
New Features
Tests
✏️ Tip: You can customize this high-level summary in your review settings.