undo a breaking change

[matin]

add Client.profile back in to avoid a breaking change like #73 (comment)

Summary by CodeRabbit

• New Features

  • Introduced a new profile property in the Client class to enhance user profile access.

• Bug Fixes

  • Updated tests to reflect changes in user profile naming conventions, ensuring accuracy in assertions.

• Chores

  • Updated version number from 0.5.1 to 0.5.2.

[coderabbitai]

Walkthrough

The changes in this pull request involve modifications to the Client class in garth/http.py, where a private attribute _social_profile is renamed to _user_profile, and its associated property method social_profile is updated to user_profile. A new property method profile is introduced, returning the result of user_profile. Additionally, the version number in garth/version.py is incremented from "0.5.1" to "0.5.2". The test suite in tests/test_http.py is updated to reflect these changes, including a new test for the profile property.

Changes

File	Change Summary
garth/http.py	Renamed _social_profile to _user_profile. Updated social_profile method to user_profile. Added new method profile. Updated username to access user_profile.
garth/version.py	Updated version number from "0.5.1" to "0.5.2".
tests/test_http.py	Updated test_username to use _user_profile. Added test_profile_alias to verify profile returns the same value as user_profile.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant ConnectAPI

    Client->>ConnectAPI: request user profile
    ConnectAPI-->>Client: return user profile data
    Client->>Client: set _user_profile
    Client->>Client: return user_profile
    Client->>Client: return profile (alias for user_profile)

Loading

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4a22315 and 977d05f.

⛔ Files ignored due to path filters (2)

• tests/cassettes/test_profile_alias.yaml is excluded by !tests/**/cassettes/**
• uv.lock is excluded by !**/*.lock

📒 Files selected for processing (3)

• garth/http.py (2 hunks)
• garth/version.py (1 hunks)
• tests/test_http.py (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

tests/test_http.py (1)

Pattern tests/**: - test functions shouldn't have a return type hint

• it's ok to use assert instead of pytest.assume()

🔇 Additional comments (7)

garth/version.py (1)

1-1: LGTM: Version bump follows semver principles

The patch version increment (0.5.1 → 0.5.2) is appropriate for this backward-compatibility restoration.

tests/test_http.py (2)

147-150: LGTM: Test properly validates user profile behavior

The test correctly verifies that the username property initializes and populates the user profile.

---

152-157: LGTM: Test ensures profile property maintains backward compatibility

The test properly verifies that the new profile property returns the same value as user_profile, ensuring backward compatibility is maintained.

garth/http.py (4)

31-31: LGTM: Attribute renamed while maintaining type safety

The private attribute has been renamed from _social_profile to _user_profile while preserving the type annotation.

---

95-103: LGTM: Property implementation maintains existing functionality

The user_profile property correctly maintains the functionality of the previous social_profile property with proper type checking.

---

105-107: LGTM: Profile property restores backward compatibility

The new profile property correctly aliases to user_profile, successfully restoring the backward compatibility as intended in the PR objectives.

---

111-111: LGTM: Username property updated consistently

The username property has been updated to use the new user_profile property name while maintaining the same functionality.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Experiment)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (4a22315) to head (977d05f).
Report is 2 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##              main       #85   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           34        34           
  Lines         1326      1335    +9     
=========================================
+ Hits          1326      1335    +9     

Flag	Coverage Δ
unittests	100.00% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.