Sign upLogin

sanger/sequencescape

View on GitHub
Star
app/controllers/api/v2/concerns/api_key_authenticatable.rb

Summary

Maintainability
A
0 mins
Test Coverage
A
100%

Api::V2::Concerns::ApiKeyAuthenticatable#authenticate_with_api_key calls 'request.env' 2 times
Open

          if request.env.key? http_env_api_key
            validate_api_key request.env[http_env_api_key]
Severity: Minor
Found in app/controllers/api/v2/concerns/api_key_authenticatable.rb by reek

Duplication occurs when two fragments of code look nearly identical, or when two fragments of code have nearly identical effects at some conceptual level.

Reek implements a check for Duplicate Method Call.

Example

Here's a very much simplified and contrived example. The following method will report a warning:

def double_thing()
  @other.thing + @other.thing
end

One quick approach to silence Reek would be to refactor the code thus:

def double_thing()
  thing = @other.thing
  thing + thing
end

A slightly different approach would be to replace all calls of double_thing by calls to @other.double_thing:

class Other
  def double_thing()
    thing + thing
  end
end

The approach you take will depend on balancing other factors in your code.

Api::V2::Concerns::ApiKeyAuthenticatable#request_log calls 'request.env' 2 times
Open

            user_agent: request.env['HTTP_USER_AGENT'],
            origin: request.env['HTTP_ORIGIN'],
Severity: Minor
Found in app/controllers/api/v2/concerns/api_key_authenticatable.rb by reek

Duplication occurs when two fragments of code look nearly identical, or when two fragments of code have nearly identical effects at some conceptual level.

Reek implements a check for Duplicate Method Call.

Example

Here's a very much simplified and contrived example. The following method will report a warning:

def double_thing()
  @other.thing + @other.thing
end

One quick approach to silence Reek would be to refactor the code thus:

def double_thing()
  thing = @other.thing
  thing + thing
end

A slightly different approach would be to replace all calls of double_thing by calls to @other.double_thing:

class Other
  def double_thing()
    thing + thing
  end
end

The approach you take will depend on balancing other factors in your code.

Api::V2 has the name 'V2'
Open

  module V2
Severity: Minor
Found in app/controllers/api/v2/concerns/api_key_authenticatable.rb by reek

An Uncommunicative Module Name is a module name that doesn't communicate its intent well enough.

Poor names make it hard for the reader to build a mental picture of what's going on in the code. They can also be mis-interpreted; and they hurt the flow of reading, because the reader must slow down to interpret the names.

There are no issues that match your filters.

Category
Status