Sign upLogin

zendesk/zendesk_api_client_rb

View on GitHub
Star
.rubocop_todo.yml

Summary

Maintainability
Test Coverage
# This configuration was generated by
# `rubocop --auto-gen-config`
# on 2019-03-12 16:33:35 -0700 using RuboCop version 0.64.0.
# The point is for the user to remove these configuration records
# one by one as the offenses are removed from the code base.
# Note that changes in the inspected code, or installation of new
# versions of RuboCop, may require this file to be generated again.

# Offense count: 4
# Cop supports --auto-correct.
# Configuration parameters: TreatCommentsAsGroupSeparators, Include.
# Include: **/*.gemfile, **/Gemfile, **/gems.rb
Bundler/OrderedGems:
  Exclude:
    - 'Gemfile'

# Offense count: 1
# Cop supports --auto-correct.
# Configuration parameters: TreatCommentsAsGroupSeparators, Include.
# Include: **/*.gemspec
Gemspec/OrderedDependencies:
  Exclude:
    - 'zendesk_api.gemspec'

# Offense count: 1
# Cop supports --auto-correct.
# Configuration parameters: EnforcedHashRocketStyle, EnforcedColonStyle, EnforcedLastArgumentHashStyle.
# SupportedHashRocketStyles: key, separator, table
# SupportedColonStyles: key, separator, table
# SupportedLastArgumentHashStyles: always_inspect, always_ignore, ignore_implicit, ignore_explicit
Layout/HashAlignment:
  Exclude:
    - 'spec/live/user_view_spec.rb'

Layout/LineLength:
  Max: 160

# Offense count: 17
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle.
# SupportedStyles: leading, trailing
Layout/DotPosition:
  Exclude:
    - 'lib/zendesk_api/helpers.rb'
    - 'spec/core/collection_spec.rb'
    - 'spec/core/data_namespace_spec.rb'
    - 'spec/core/middleware/request/retry_spec.rb'

# Offense count: 14
# Cop supports --auto-correct.
Layout/EmptyLineAfterGuardClause:
  Exclude:
    - 'lib/zendesk_api/actions.rb'
    - 'lib/zendesk_api/client.rb'
    - 'lib/zendesk_api/collection.rb'
    - 'lib/zendesk_api/resource.rb'
    - 'lib/zendesk_api/resources.rb'
    - 'lib/zendesk_api/sideloading.rb'
    - 'spec/live/ticket_spec.rb'

# Offense count: 5
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle.
# SupportedStyles: symmetrical, new_line, same_line
Layout/MultilineMethodCallBraceLayout:
  Exclude:
    - 'spec/core/bulk_actions_spec.rb'
    - 'spec/core/collection_spec.rb'

# Offense count: 3
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces.
# SupportedStyles: space, no_space
# SupportedStylesForEmptyBraces: space, no_space
Layout/SpaceBeforeBlockBraces:
  Exclude:
    - 'spec/core/middleware/response/parse_iso_dates_spec.rb'
    - 'spec/core/read_resource_spec.rb'
    - 'spec/core/resource_spec.rb'

# Offense count: 2
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces, SpaceBeforeBlockParameters.
# SupportedStyles: space, no_space
# SupportedStylesForEmptyBraces: space, no_space
Layout/SpaceInsideBlockBraces:
  Exclude:
    - 'lib/zendesk_api/association.rb'

# Offense count: 11
# Configuration parameters: AllowSafeAssignment.
Lint/AssignmentInCondition:
  Exclude:
    - 'lib/zendesk_api/actions.rb'
    - 'lib/zendesk_api/association.rb'
    - 'lib/zendesk_api/associations.rb'
    - 'lib/zendesk_api/client.rb'
    - 'lib/zendesk_api/collection.rb'
    - 'lib/zendesk_api/resources.rb'

# Offense count: 1
Lint/BooleanSymbol:
  Exclude:
    - 'spec/live/target_spec.rb'

# Offense count: 1
Lint/DuplicateMethods:
  Exclude:
    - 'lib/zendesk_api/resource.rb'

# Offense count: 3
Lint/SuppressedException:
  Exclude:
    - 'Rakefile'
    - 'spec/core/collection_spec.rb'
    - 'spec/core/spec_helper.rb'

# Offense count: 1
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle.
# SupportedStyles: runtime_error, standard_error
Lint/InheritException:
  Exclude:
    - 'spec/core/collection_spec.rb'

# Offense count: 1
# Configuration parameters: IgnoreImplicitReferences.
Lint/ShadowedArgument:
  Exclude:
    - 'lib/zendesk_api/association.rb'

# Offense count: 6
Lint/ShadowingOuterLocalVariable:
  Exclude:
    - 'lib/zendesk_api/association.rb'
    - 'lib/zendesk_api/middleware/response/callback.rb'
    - 'lib/zendesk_api/middleware/response/logger.rb'
    - 'lib/zendesk_api/middleware/response/parse_iso_dates.rb'
    - 'spec/live/ticket_spec.rb'
    - 'util/resource_handler.rb'

# Offense count: 10
# Cop supports --auto-correct.
Lint/RedundantStringCoercion:
  Exclude:
    - 'lib/zendesk_api/middleware/response/logger.rb'
    - 'spec/live/macro_spec.rb'
    - 'spec/macros/resource_macros.rb'

# Offense count: 4
# Cop supports --auto-correct.
# Configuration parameters: IgnoreEmptyBlocks, AllowUnusedKeywordArguments.
Lint/UnusedBlockArgument:
  Exclude:
    - 'lib/zendesk_api/track_changes.rb'
    - 'spec/core/collection_spec.rb'

# Offense count: 3
# Cop supports --auto-correct.
# Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods.
Lint/UnusedMethodArgument:
  Exclude:
    - 'lib/zendesk_api/client.rb'
    - 'lib/zendesk_api/collection.rb'
    - 'spec/fixtures/test_resources.rb'

# Offense count: 1
# Configuration parameters: CheckForMethodsWithNoSideEffects.
Lint/Void:
  Exclude:
    - 'lib/zendesk_api/middleware/request/encode_json.rb'

# Offense count: 4
Naming/AccessorMethodName:
  Exclude:
    - 'lib/zendesk_api/collection.rb'
    - 'lib/zendesk_api/lru_cache.rb'
    - 'lib/zendesk_api/resources.rb'
    - 'lib/zendesk_api/pagination.rb'

# Offense count: 1
# Configuration parameters: EnforcedStyleForLeadingUnderscores.
# SupportedStylesForLeadingUnderscores: disallowed, required, optional
Naming/MemoizedInstanceVariableName:
  Exclude:
    - 'lib/zendesk_api/collection.rb'

# Offense count: 1
# Configuration parameters: NamePrefix, NamePrefixBlacklist, NameWhitelist, MethodDefinitionMacros.
# NamePrefix: is_, has_, have_
# NamePrefixBlacklist: is_, has_, have_
# NameWhitelist: is_a?
# MethodDefinitionMacros: define_method, define_singleton_method
Naming/PredicateName:
  Exclude:
    - 'spec/**/*'
    - 'lib/zendesk_api/associations.rb'

# Offense count: 1
# Cop supports --auto-correct.
Security/YAMLLoad:
  Exclude:
    - 'spec/core/spec_helper.rb'

# Offense count: 13
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle.
# SupportedStyles: prefer_alias, prefer_alias_method
Style/Alias:
  Exclude:
    - 'lib/zendesk_api/collection.rb'
    - 'lib/zendesk_api/resource.rb'
    - 'lib/zendesk_api/resources.rb'
    - 'lib/zendesk_api/track_changes.rb'

# Offense count: 1
# Cop supports --auto-correct.
Style/BlockComments:
  Exclude:
    - 'spec/core/trackie_spec.rb'

# Offense count: 9
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, ProceduralMethods, FunctionalMethods, IgnoredMethods.
# SupportedStyles: line_count_based, semantic, braces_for_chaining
# ProceduralMethods: benchmark, bm, bmbm, create, each_with_object, measure, new, realtime, tap, with_object
# FunctionalMethods: let, let!, subject, watch
# IgnoredMethods: lambda, proc, it
Style/BlockDelimiters:
  Exclude:
    - 'lib/zendesk_api/association.rb'
    - 'spec/core/middleware/request/encode_json_spec.rb'
    - 'spec/core/middleware/request/retry_spec.rb'
    - 'spec/core/middleware/response/parse_iso_dates_spec.rb'
    - 'spec/core/read_resource_spec.rb'
    - 'spec/core/resource_spec.rb'

# Offense count: 18
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle.
# SupportedStyles: braces, no_braces, context_dependent
Style/BracesAroundHashParameters:
  Exclude:
    - 'spec/core/collection_spec.rb'
    - 'spec/core/middleware/request/etag_cache_spec.rb'
    - 'spec/core/middleware/response/callback_spec.rb'
    - 'spec/core/middleware/response/parse_iso_dates_spec.rb'
    - 'spec/core/resource_spec.rb'
    - 'spec/core/search_spec.rb'
    - 'spec/live/app_spec.rb'
    - 'spec/live/automation_spec.rb'
    - 'spec/live/request_spec.rb'
    - 'spec/live/ticket_spec.rb'
    - 'spec/live/trigger_spec.rb'
    - 'spec/live/view_spec.rb'

# Offense count: 8
# Cop supports --auto-correct.
# Configuration parameters: AutoCorrect, EnforcedStyle.
# SupportedStyles: nested, compact
Style/ClassAndModuleChildren:
  Exclude:
    - 'lib/zendesk_api/lru_cache.rb'
    - 'spec/core/data_namespace_spec.rb'
    - 'spec/core/resource_spec.rb'
    - 'spec/fixtures/test_resources.rb'

# Offense count: 94
Style/Documentation:
  Exclude:
    - 'spec/**/*'
    - 'test/**/*'
    - 'lib/zendesk_api.rb'
    - 'lib/zendesk_api/actions.rb'
    - 'lib/zendesk_api/associations.rb'
    - 'lib/zendesk_api/error.rb'
    - 'lib/zendesk_api/middleware/request/encode_json.rb'
    - 'lib/zendesk_api/middleware/request/url_based_access_token.rb'
    - 'lib/zendesk_api/middleware/response/parse_json.rb'
    - 'lib/zendesk_api/middleware/response/raise_error.rb'
    - 'lib/zendesk_api/middleware/response/sanitize_response.rb'
    - 'lib/zendesk_api/resource.rb'
    - 'lib/zendesk_api/resources.rb'
    - 'util/resource_handler.rb'
    - 'util/verb_handler.rb'

# Offense count: 3
Style/DoubleNegation:
  Exclude:
    - 'lib/zendesk_api/associations.rb'
    - 'lib/zendesk_api/client.rb'
    - 'spec/macros/resource_macros.rb'

# Offense count: 1
# Cop supports --auto-correct.
Style/EachWithObject:
  Exclude:
    - 'lib/zendesk_api/associations.rb'

# Offense count: 1
# Cop supports --auto-correct.
Style/ExpandPathArguments:
  Exclude:
    - 'zendesk_api.gemspec'

# Offense count: 116
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle.
# SupportedStyles: when_needed, always, never
Style/FrozenStringLiteralComment:
  Enabled: false

# Offense count: 3
# Configuration parameters: AllowedVariables.
Style/GlobalVars:
  Exclude:
    - 'spec/core/spec_helper.rb'

# Offense count: 13
# Configuration parameters: MinBodyLength.
Style/GuardClause:
  Exclude:
    - 'lib/zendesk_api/actions.rb'
    - 'lib/zendesk_api/association.rb'
    - 'lib/zendesk_api/client.rb'
    - 'lib/zendesk_api/collection.rb'
    - 'lib/zendesk_api/middleware/request/upload.rb'
    - 'lib/zendesk_api/middleware/response/deflate.rb'
    - 'lib/zendesk_api/middleware/response/gzip.rb'
    - 'lib/zendesk_api/middleware/response/parse_json.rb'
    - 'lib/zendesk_api/resources.rb'

# Offense count: 892
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
# SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys
Style/HashSyntax:
  Enabled: false

# Offense count: 33
# Cop supports --auto-correct.
Style/IfUnlessModifier:
  Enabled: false

# Offense count: 2
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle.
# SupportedStyles: line_count_dependent, lambda, literal
Style/Lambda:
  Exclude:
    - 'spec/core/middleware/request/encode_json_spec.rb'
    - 'spec/core/middleware/request/upload_spec.rb'

# Offense count: 3
Style/MethodMissingSuper:
  Exclude:
    - 'lib/zendesk_api/client.rb'
    - 'lib/zendesk_api/collection.rb'
    - 'lib/zendesk_api/resource.rb'

# Offense count: 2
Style/MissingRespondToMissing:
  Exclude:
    - 'lib/zendesk_api/client.rb'
    - 'lib/zendesk_api/resource.rb'

# Offense count: 1
Style/MixinUsage:
  Exclude:
    - 'spec/core/spec_helper.rb'

# Offense count: 4
# Cop supports --auto-correct.
Style/MultilineIfModifier:
  Exclude:
    - 'spec/macros/resource_macros.rb'

# Offense count: 4
# Cop supports --auto-correct.
Style/MutableConstant:
  Exclude:
    - 'lib/zendesk_api/client.rb'
    - 'lib/zendesk_api/collection.rb'
    - 'lib/zendesk_api/middleware/request/retry.rb'
    - 'lib/zendesk_api/version.rb'

# Offense count: 1
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle.
# SupportedStyles: both, prefix, postfix
Style/NegatedIf:
  Exclude:
    - 'lib/zendesk_api/middleware/request/upload.rb'

# Offense count: 4
# Cop supports --auto-correct.
# Configuration parameters: Strict.
Style/NumericLiterals:
  MinDigits: 11

# Offense count: 2
# Cop supports --auto-correct.
# Configuration parameters: AutoCorrect, EnforcedStyle, IgnoredMethods.
# SupportedStyles: predicate, comparison
Style/NumericPredicate:
  Exclude:
    - 'spec/**/*'
    - 'lib/zendesk_api/middleware/request/retry.rb'

# Offense count: 2
# Cop supports --auto-correct.
Style/ParallelAssignment:
  Exclude:
    - 'lib/zendesk_api/collection.rb'

# Offense count: 1
# Cop supports --auto-correct.
# Configuration parameters: AllowSafeAssignment, AllowInMultilineConditions.
Style/ParenthesesAroundCondition:
  Exclude:
    - 'lib/zendesk_api/collection.rb'

# Offense count: 22
# Cop supports --auto-correct.
# Configuration parameters: PreferredDelimiters.
Style/PercentLiteralDelimiters:
  Exclude:
    - 'Rakefile'
    - 'lib/zendesk_api/collection.rb'
    - 'lib/zendesk_api/resources.rb'
    - 'spec/core/collection_spec.rb'
    - 'spec/core/middleware/request/etag_cache_spec.rb'
    - 'spec/core/resource_spec.rb'
    - 'spec/core/resources/view_spec.rb'
    - 'spec/live/app_installation_spec.rb'
    - 'spec/live/app_spec.rb'
    - 'spec/live/push_notification_device_spec.rb'
    - 'spec/live/tag_spec.rb'
    - 'spec/live/ticket_spec.rb'

# Offense count: 7
# Cop supports --auto-correct.
Style/PerlBackrefs:
  Exclude:
    - 'lib/zendesk_api/collection.rb'
    - 'lib/zendesk_api/helpers.rb'

# Offense count: 6
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle.
# SupportedStyles: short, verbose
Style/PreferredHashMethods:
  Exclude:
    - 'lib/zendesk_api/associations.rb'
    - 'lib/zendesk_api/lru_cache.rb'
    - 'lib/zendesk_api/track_changes.rb'

# Offense count: 1
# Cop supports --auto-correct.
Style/Proc:
  Exclude:
    - 'spec/core/collection_spec.rb'

# Offense count: 4
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle.
# SupportedStyles: compact, exploded
Style/RaiseArgs:
  Exclude:
    - 'lib/zendesk_api/association.rb'
    - 'lib/zendesk_api/middleware/response/raise_error.rb'

# Offense count: 1
# Cop supports --auto-correct.
# Configuration parameters: AllowMultipleReturnValues.
Style/RedundantReturn:
  Exclude:
    - 'lib/zendesk_api/client.rb'

# Offense count: 52
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, AllowInnerSlashes.
# SupportedStyles: slashes, percent_r, mixed
Style/RegexpLiteral:
  Exclude:
    - 'lib/zendesk_api/helpers.rb'
    - 'spec/core/client_spec.rb'
    - 'spec/core/collection_spec.rb'
    - 'spec/core/create_resource_spec.rb'
    - 'spec/core/middleware/request/etag_cache_spec.rb'
    - 'spec/core/middleware/request/retry_spec.rb'
    - 'spec/core/middleware/response/callback_spec.rb'
    - 'spec/core/middleware/response/deflate_spec.rb'
    - 'spec/core/middleware/response/gzip_spec.rb'
    - 'spec/core/middleware/response/parse_iso_dates_spec.rb'
    - 'spec/core/middleware/response/parse_json_spec.rb'
    - 'spec/core/resource_spec.rb'

# Offense count: 1
# Cop supports --auto-correct.
Style/RescueModifier:
  Exclude:
    - 'lib/zendesk_api/resources.rb'

# Offense count: 4
# Cop supports --auto-correct.
# Configuration parameters: ConvertCodeThatCanStartToReturnNil, Whitelist.
# Whitelist: present?, blank?, presence, try, try!
Style/SafeNavigation:
  Exclude:
    - 'lib/zendesk_api/association.rb'
    - 'lib/zendesk_api/collection.rb'
    - 'lib/zendesk_api/middleware/request/retry.rb'

# Offense count: 5
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle.
# SupportedStyles: only_raise, only_fail, semantic
Style/SignalException:
  Exclude:
    - 'spec/core/middleware/response/raise_error_spec.rb'
    - 'spec/live/app_installation_spec.rb'
    - 'spec/live/app_spec.rb'
    - 'spec/live/ticket_spec.rb'

# Offense count: 1
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle.
# SupportedStyles: use_perl_names, use_english_names
Style/SpecialGlobalVars:
  Exclude:
    - 'spec/core/spec_helper.rb'

# Offense count: 1412
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
# SupportedStyles: single_quotes, double_quotes
Style/StringLiterals:
  Enabled: false

# Offense count: 8
# Cop supports --auto-correct.
# Configuration parameters: MinSize.
# SupportedStyles: percent, brackets
Style/SymbolArray:
  EnforcedStyle: brackets

# Offense count: 1
# Cop supports --auto-correct.
# Configuration parameters: ExactNameMatch, AllowPredicates, AllowDSLWriters, IgnoreClassMethods, Whitelist.
# Whitelist: to_ary, to_a, to_c, to_enum, to_h, to_hash, to_i, to_int, to_io, to_open, to_path, to_proc, to_r, to_regexp, to_str, to_s, to_sym
Style/TrivialAccessors:
  Exclude:
    - 'lib/zendesk_api/resource.rb'