Sign upLogin

icostan/bitmex-api-ruby

View on GitHub
Star

Showing 9 of 9 total issues

Class Client has 22 methods (exceeds 20 allowed). Consider refactoring.
Open

  class Client
    attr_reader :host, :api_key, :api_secret

    # Create new client instance
    # @param testnet [Boolean] true for testnet network
Severity: Minor
Found in lib/bitmex/client.rb - About 2 hrs to fix

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

  class Trade < Base
    # Get all trades
    # @example Get first 10 traders starting Jan 1st for XBTUSD
    #   client.trades.all symbol: 'XBTUSD', startTime: '2019-01-01', count: 10
    # @example Listen to all XBTUSD trades
Severity: Major
Found in lib/bitmex/trade.rb and 1 other location - About 1 hr to fix
lib/bitmex/quote.rb on lines 5..38

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 70.

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

  class Quote < Base
    # Get all quotes
    # @!macro bitmex.filters
    # @return [Array] the quotes
    # @yield [Hash] the quote data
Severity: Major
Found in lib/bitmex/quote.rb and 1 other location - About 1 hr to fix
lib/bitmex/trade.rb on lines 4..49

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 70.

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 3 locations. Consider refactoring.
Open

    def post(path, params: {}, auth: true, json: true)
      body = json ? params.to_json.to_s : URI.encode_www_form(params)

      options = {}
      options[:body] = body
Severity: Major
Found in lib/bitmex/rest.rb and 2 other locations - About 1 hr to fix
lib/bitmex/rest.rb on lines 38..47
lib/bitmex/rest.rb on lines 60..69

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 52.

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 3 locations. Consider refactoring.
Open

    def put(path, params: {}, auth: true, json: true)
      body = json ? params.to_json.to_s : URI.encode_www_form(params)

      options = {}
      options[:body] = body
Severity: Major
Found in lib/bitmex/rest.rb and 2 other locations - About 1 hr to fix
lib/bitmex/rest.rb on lines 49..58
lib/bitmex/rest.rb on lines 60..69

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 52.

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 3 locations. Consider refactoring.
Open

    def delete(path, params: {}, auth: true, json: true)
      body = json ? params.to_json.to_s : URI.encode_www_form(params)

      options = {}
      options[:body] = body
Severity: Major
Found in lib/bitmex/rest.rb and 2 other locations - About 1 hr to fix
lib/bitmex/rest.rb on lines 38..47
lib/bitmex/rest.rb on lines 49..58

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 52.

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

Method headers has 6 arguments (exceeds 4 allowed). Consider refactoring.
Open

  def self.headers(api_key, api_secret, verb, path, body, query)
Severity: Minor
Found in lib/bitmex.rb - About 45 mins to fix

Method signature has 6 arguments (exceeds 4 allowed). Consider refactoring.
Open

  def self.signature(api_secret, verb, path, expires, body, query)
Severity: Minor
Found in lib/bitmex.rb - About 45 mins to fix

Method get has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
Open

    def get(path, params: {}, auth: false, &ablock)
      path = base_path(path) unless path.to_s.start_with?('/')

      options = {}
      options[:query] = params unless params.empty?
Severity: Minor
Found in lib/bitmex/rest.rb - About 35 mins to fix

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

  • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
  • Code is considered more complex for each "break in the linear flow of the code"
  • Code is considered more complex when "flow breaking structures are nested"

Further reading

Severity
Category
Status
Source
Language