Core: Added SSHID method to Devices

[Seluj78]

Fixes #5

Needs before merging

• Core: Added endpoint validation #7

Summary by CodeRabbit

• New Features

  • New sshid property for devices, enabling easier identification.

• Enhancements

  • Improved URL formatting and validation process.
  • ShellHub class now supports initialization with either an endpoint or a URL.

• Bug Fixes

  • Fixed URL references in __repr__ and __str__ methods to enhance clarity.

• Tests

  • Updated and added tests for new URL handling and sshid generation functionalities.

[coderabbitai]

Walkthrough

The update introduces a new property sshid to the Device class in the ShellHub library, enabling the generation of unique SSH identifiers for devices. Additionally, new test cases have been added to ensure the correct functioning of the SSH ID generation based on device attributes and acceptance criteria.

Changes

File(s)	Change Summary
shellhub/models/device.py	Added a new property sshid to the Device class for SSH ID formatting.
tests/test_devices.py	Added a new test class TestDeviceSSHID with test methods for SSH ID generation verification.

Assessment against linked issues

Objective	Addressed	Explanation
Add a .sshid method (#5)	✅

Poem

Among lines of code, where changes creep,
A rabbit danced, no bug too deep.
With a leap and a bound, a feature complete,
ShellHub shines bright, a dev's heartbeat! 🌟🐇

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 (e5af59c) 81.73% compared to head (3f179df) 82.12%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main       #9      +/-   ##
==========================================
+ Coverage   81.73%   82.12%   +0.38%     
==========================================
  Files           4        4              
  Lines         230      235       +5     
  Branches       26       28       +2     
==========================================
+ Hits          188      193       +5     
  Misses         34       34              
  Partials        8        8              

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

[Seluj78]

@coderabbitai review

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

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

Files selected for processing (7)

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

Files skipped from review due to trivial changes (1)

• shellhub/init.py

Additional comments: 18

tests/utils.py (1)

• 1-1: LGTM!

tests/conftest.py (1)

• 19-19: LGTM!

tests/test_base.py (5)

• 15-15: LGTM!
• 21-21: LGTM!
• 31-31: LGTM!
• 35-49: LGTM!
• 51-55: LGTM!

shellhub/models/device.py (1)

• 138-140: LGTM!

shellhub/models/base.py (9)

• 22-24: LGTM!
• 26-31: LGTM!
• 35-49: LGTM!
• 51-63: LGTM!
• 66-66: LGTM!
• 69-69: LGTM!
• 74-74: LGTM!
• 108-108: LGTM!
• 118-118: LGTM!

tests/test_devices.py (1)

• 265-267: LGTM!

[Seluj78]

@coderabbitai review

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between e5af59c and 3f179df.

Files selected for processing (3)

• shellhub/init.py (1 hunks)
• shellhub/models/device.py (1 hunks)
• tests/test_devices.py (1 hunks)

Files skipped from review as they are similar to previous changes (3)

• shellhub/init.py
• shellhub/models/device.py
• tests/test_devices.py