Sign upLogin

rapid7/metasploit-framework

View on GitHub
Star
lib/msf/core/web_services/documentation/api/v1/credential_api_doc.rb

Summary

Maintainability
C
7 hrs
Test Coverage

File credential_api_doc.rb has 324 lines of code (exceeds 250 allowed). Consider refactoring.
Open

require 'swagger/blocks'

# TODO: Complete this documentation when the credential model is fully implemented in the API.
module Msf::WebServices::Documentation::Api::V1::CredentialApiDoc
  include Swagger::Blocks
Severity: Minor
Found in lib/msf/core/web_services/documentation/api/v1/credential_api_doc.rb - About 3 hrs to fix

    Similar blocks of code found in 2 locations. Consider refactoring.
    Open

      swagger_schema :Public do
    key :required, [:username, :type]
    property :id, type: :integer, format: :int32, description: Msf::WebServices::Documentation::Api::V1::RootApiDoc::ID_DESC
    property :username, type: :string, description: USERNAME_DESC, example: USERNAME_EXAMPLE
    property :type, type: :string, description: PUBLIC_TYPE_DESC, enum: PUBLIC_TYPE_ENUM
    Severity: Major
    Found in lib/msf/core/web_services/documentation/api/v1/credential_api_doc.rb and 1 other location - About 1 hr to fix
    lib/msf/core/web_services/documentation/api/v1/credential_api_doc.rb on lines 116..123

    Duplicated Code

    Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

    Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

    When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

    Tuning

    This issue has a mass of 72.

    We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

    The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

    If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

    See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

    Refactorings

    Further Reading

    Similar blocks of code found in 2 locations. Consider refactoring.
    Open

      swagger_schema :Realm do
    key :required, [:key, :value]
    property :id, type: :integer, format: :int32, description: Msf::WebServices::Documentation::Api::V1::RootApiDoc::ID_DESC
    property :key, type: :string, description: KEY_DESC, example: KEY_EXAMPLE
    property :value, type: :string, description: VALUE_DESC, example: VALUE_EXAMPLE
    Severity: Major
    Found in lib/msf/core/web_services/documentation/api/v1/credential_api_doc.rb and 1 other location - About 1 hr to fix
    lib/msf/core/web_services/documentation/api/v1/credential_api_doc.rb on lines 97..104

    Duplicated Code

    Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

    Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

    When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

    Tuning

    This issue has a mass of 72.

    We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

    The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

    If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

    See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

    Refactorings

    Further Reading

    There are no issues that match your filters.

    Category
    Status