Core: Added endpoint validation

[Seluj78]

Fixes #6

Summary by CodeRabbit

• New Features
  • Introduced SSL support for enhanced security.
  • Added URL formatting and validation to improve reliability.
• Enhancements
  • Updated the ShellHub class to support customizable endpoints with SSL configuration.
• Tests
  • Added tests for new URL formatting and validation functionalities.
• Chores
  • Updated version to "0.1.0" indicating significant improvements.

[coderabbitai]

Warning

Rate Limit Exceeded

@Seluj78 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 19 minutes and 45 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 521a6f2 and aca9773.

Walkthrough

This update introduces enhancements to the ShellHub library, focusing on URL handling and SSL usage. The ShellHub class now supports flexible endpoint inputs, automatically formatting and validating URLs to ensure they meet the required scheme. Additionally, the version has been bumped to 0.1.0, reflecting significant improvements in functionality and user experience.

Changes

Files	Change Summary
shellhub/__init__.py	Updated version from 0.0.1 to 0.1.0.
shellhub/models/base.py	Added _url attribute, _use_ssl flag, URL formatting/validation, and updated methods.
tests/conftest.py tests/test_base.py	Updated parameter name to endpoint_or_url and added URL validation tests.
tests/utils.py	Updated MOCKED_DOMAIN_URL value.

Assessment against linked issues

Objective	Addressed	Explanation
Add checks for the endpoint (#6)	✅

Poem

In the realm of code, where the bits do hop,
A rabbit worked hard in the digital crop.
🐾 With a leap and a bound, a new version took flight,
🌐 URLs aligned, in the soft moonlight.

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>.
  • Generate unit-tests for this file.
• 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 tests 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 generate interesting stats about this repository from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (521a6f2) 80.09% compared to head (aca9773) 81.73%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main       #7      +/-   ##
==========================================
+ Coverage   80.09%   81.73%   +1.64%     
==========================================
  Files           4        4              
  Lines         211      230      +19     
  Branches       23       26       +3     
==========================================
+ Hits          169      188      +19     
  Misses         34       34              
  Partials        8        8              

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

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 02e3ede and e671b7d.

Files selected for processing (5)

• shellhub/init.py (1 hunks)
• shellhub/models/base.py (4 hunks)
• tests/conftest.py (1 hunks)
• tests/test_base.py (2 hunks)
• tests/utils.py (1 hunks)

Files skipped from review due to trivial changes (2)

• shellhub/init.py
• tests/utils.py

Additional comments: 14

tests/conftest.py (1)

• 19-19: Change from endpoint to endpoint_or_url aligns with PR objectives.

tests/test_base.py (6)

• 15-15: Parameter name change to endpoint_or_url is consistent with PR objectives.
• 21-21: Parameter name change to endpoint_or_url is consistent with PR objectives.
• 31-31: Parameter name change to endpoint_or_url is consistent with PR objectives.
• 35-35: Update to repr method reflects the internal changes to the ShellHub class.
• 39-39: Update to str method reflects the internal changes to the ShellHub class.
• 42-55: New tests for URL formatting and validation are correctly implemented and necessary for ensuring the new functionality works as expected.

shellhub/models/base.py (7)

• 22-24: Introduction of _url attribute and _use_ssl flag aligns with PR objectives.
• 26-31: Updates to __init__ method to accept endpoint_or_url and use_ssl parameters are correctly implemented.
• 35-49: Implementation of _format_and_validate_url method is correct and necessary for URL formatting and validation.
• 51-63: Implementation of _is_valid_url method is correct and efficiently checks URL format.
• 66-66: Update to __repr__ method reflects the internal changes to the ShellHub class.
• 69-69: Update to __str__ method reflects the internal changes to the ShellHub class.
• 105-111: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [108-118]

Updates to make_request function to use _url attribute for constructing URLs are correctly implemented.