Sign upLogin

AfterShip/aftership-sdk-php

View on GitHub
Star

Showing 9 of 9 total issues

File testing.php has 413 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php
require( '../vendor/autoload.php' );

$action      = isset( $_GET['action'] ) ? $_GET['action'] : '';
$api_key     = isset( $_GET['api_key'] ) ? $_GET['api_key'] : '';
Severity: Minor
Found in examples/testing.php - About 5 hrs to fix

    Function validate has a Cognitive Complexity of 21 (exceeds 5 allowed). Consider refactoring.
    Open

        private static function validate($additionalFields)
    {
        $validAdditionalFields = [];
        if (array_key_exists('tracking_account_number', $additionalFields)) {
            if (strlen($additionalFields['tracking_account_number']) > 512) {
    Severity: Minor
    Found in src/TrackingAdditionalFields.php - About 2 hrs 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

    Method validate has 44 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        private static function validate($additionalFields)
    {
        $validAdditionalFields = [];
        if (array_key_exists('tracking_account_number', $additionalFields)) {
            if (strlen($additionalFields['tracking_account_number']) > 512) {
    Severity: Minor
    Found in src/TrackingAdditionalFields.php - About 1 hr to fix

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

          public function delete($slug, $trackingNumber, array $params = [], $additionalFields = [])
    {
        if (empty($slug)) {
            throw new AfterShipException('Slug cannot be empty');
        }
      Severity: Major
      Found in src/Notifications.php and 1 other location - About 1 hr to fix
      src/Notifications.php on lines 39..51

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

      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

          public function create($slug, $trackingNumber, array $params = array(), $additionalFields = [])
    {
        if (empty($slug)) {
            throw new AfterShipException('Slug cannot be empty');
        }
      Severity: Major
      Found in src/Notifications.php and 1 other location - About 1 hr to fix
      src/Notifications.php on lines 80..92

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

      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 getHeaders has 31 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          private function getHeaders($method, $url, $data)
    {
        $isRSAEncryptionMethod = strcmp($this->encryptionMethod, Encryption::ENCRYPTION_RSA) == 0;
        $isAESEncryptionMethod = strcmp($this->encryptionMethod, Encryption::ENCRYPTION_AES) == 0;
      Severity: Minor
      Found in src/Request.php - About 1 hr to fix

        Method call has 27 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            private function call($method, $parameters = [])
    {
        $curl       = curl_init();
        // user custom curl opt
        if (!empty($this->curlOpt)) {
        Severity: Minor
        Found in src/Request.php - About 1 hr to fix

          Function __construct has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
          Open

              function __construct($apiKey, $curlOpt)
    {
        $apiSecret = '';
        $encryptionMethod = '';
        $encryptionPassword= '';
          Severity: Minor
          Found in src/Request.php - About 55 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

          Function utf8ize has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
          Open

              private function utf8ize($mixed)
    {
        if (is_array($mixed)) {
            foreach ($mixed as $key => $value) {
                $mixed[$key] = $this->utf8ize($value);
          Severity: Minor
          Found in src/Request.php - About 25 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