Sign upLogin

sanger/sequencescape

View on GitHub
Star
app/api/core/service/authentication.rb

Summary

Maintainability
A
0 mins
Test Coverage
A
100%

Core::Service::Authentication::UnauthenticatedError has no descriptive comment
Open

  class UnauthenticatedError < Core::Service::Error
Severity: Minor
Found in app/api/core/service/authentication.rb by reek

Classes and modules are the units of reuse and release. It is therefore considered good practice to annotate every class and module with a brief comment outlining its responsibilities.

Example

Given

class Dummy
  # Do things...
end

Reek would emit the following warning:

test.rb -- 1 warning:
  [1]:Dummy has no descriptive comment (IrresponsibleModule)

Fixing this is simple - just an explaining comment:

# The Dummy class is responsible for ...
class Dummy
  # Do things...
end

Core::Service::Authentication has no descriptive comment
Open

module Core::Service::Authentication
Severity: Minor
Found in app/api/core/service/authentication.rb by reek

Classes and modules are the units of reuse and release. It is therefore considered good practice to annotate every class and module with a brief comment outlining its responsibilities.

Example

Given

class Dummy
  # Do things...
end

Reek would emit the following warning:

test.rb -- 1 warning:
  [1]:Dummy has no descriptive comment (IrresponsibleModule)

Fixing this is simple - just an explaining comment:

# The Dummy class is responsible for ...
class Dummy
  # Do things...
end

Core::Service::Authentication::Helpers has no descriptive comment
Open

  module Helpers
Severity: Minor
Found in app/api/core/service/authentication.rb by reek

Classes and modules are the units of reuse and release. It is therefore considered good practice to annotate every class and module with a brief comment outlining its responsibilities.

Example

Given

class Dummy
  # Do things...
end

Reek would emit the following warning:

test.rb -- 1 warning:
  [1]:Dummy has no descriptive comment (IrresponsibleModule)

Fixing this is simple - just an explaining comment:

# The Dummy class is responsible for ...
class Dummy
  # Do things...
end

Core::Service::Authentication::UnauthenticatedError#api_error doesn't depend on instance state (maybe move it to another class?)
Open

    def api_error(response)
Severity: Minor
Found in app/api/core/service/authentication.rb by reek

A Utility Function is any instance method that has no dependency on the state of the instance.

There are no issues that match your filters.

Category
Status