api-tester 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f8866f2783c0595b22817fbd6fbaaab7a77531bf55358a50f6e0b3a62fec22a
-  data.tar.gz: 7aa5c6d1d261f322a8190781b62b3bc235641a7c0eec625afb1f9a9900cb4abe
+  metadata.gz: 49d90cf3987edaf1eb823c6bb98fda6618ca9caf02a4475913cd9f7fd7a38c8d
+  data.tar.gz: d78b67dd228819bb6a7d9554206679f8b720d41df7acbaa28aef6db5c4bd2253
 SHA512:
-  metadata.gz: 52da12901f51389ca9a4fb37d775aa8974e7514571d900fcbcfb660b6174f8251d42f6a0bb7fa9b23b3d61b01d64aa7c116c2128badf7390e2dfe106e8703ec3
-  data.tar.gz: 8ae063b4473b4f1fb75ceb203dc569f0e8cc16b8e9963f434bd85aad1c618daecfff77caf4a93d876b7af24cf037118635351ac98bbf82af1491b012c5c5804f
+  metadata.gz: 8c65fa30cad7b220c5055991385a26b630a293fe05e4fe74841228fe3ca58516ec5f7f9745d984dbdc92a0cdf0125606bddf297187eb9a733da7d54d4eb78f1b
+  data.tar.gz: 9a53c3ce1e5bcd11179f718a231e966e61a536322ab096983e87caa7277223a777ef44505d8f766c50a0d196c83cd61fa0ea71f409cc5e4919f629159c3e1227

data/.github/workflows/dependabot.yml

@@ -0,0 +1,29 @@
+name: Dependabot Auto Merge
+
+permissions:
+  pull-requests: write
+  contents: write
+
+on: 
+  pull_request:
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  dependabot:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+    if: ${{ github.actor == 'dependabot[bot]' }}
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      - name: Dependabot metadata
+        id: metadata
+        uses: dependabot/fetch-metadata@v1.3.3
+        with:
+          github-token: "${{ secrets.GITHUB_TOKEN }}"
+          
+      - name: Enable auto-merge for Dependabot patch update PRs
+        run: gh pr merge --auto --merge "$PR_URL"
+        env:
+          PR_URL: ${{github.event.pull_request.html_url}}
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

data/.github/workflows/push.yml

@@ -9,7 +9,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Ruby 2.6
       uses: actions/setup-ruby@v1
       with:

data/.github/workflows/test.yml

@@ -7,7 +7,7 @@
 
 name: Test
 
-on: [push, pull_request]
+on: [push]
 
 jobs:
   test:
@@ -15,12 +15,12 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Ruby
     # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
     # change this to (see https://github.com/ruby/setup-ruby#versioning):
     # uses: ruby/setup-ruby@v1
-      uses: ruby/setup-ruby@a195098f6b1e9074390215a49c1c14e82151a289
+      uses: ruby/setup-ruby@08245253a76fa4d1e459b7809579c62bd9eb718a
       with:
         ruby-version: 2.6
     - name: Install dependencies

data/.rubocop.yml

@@ -1,4 +1,5 @@
 AllCops:
+  NewCops: enable
   Exclude:
     - 'Guardfile'
     - '*.gemspec'
@@ -6,56 +7,165 @@ AllCops:
     - '**/*.rake'
     - 'bin/*'
 
+Gemspec/RequireMFA:
+  Enabled: true
+Gemspec/DeprecatedAttributeAssignment: # (new in 1.10)
+  Enabled: true
+Layout/LineContinuationLeadingSpace:
+  Enabled: true
+Layout/LineContinuationSpacing: 
+  Enabled: true
+Layout/LineEndStringConcatenationIndentation:
+  Enabled: true
+Layout/SpaceBeforeBrackets: # (new in 1.7)
+  Enabled: true
+Lint/AmbiguousAssignment: # (new in 1.7)
+  Enabled: true
+Lint/DeprecatedConstants: # (new in 1.8)
+  Enabled: true
+Lint/DuplicateBranch: # (new in 1.3)
+  Enabled: false
+Lint/DuplicateRegexpCharacterClassElement: # (new in 1.1)
+  Enabled: true
+Lint/EmptyBlock: # (new in 1.1)
+  Enabled: true
+Lint/EmptyClass: # (new in 1.3)
+  Enabled: true
+Lint/LambdaWithoutLiteralBlock: # (new in 1.8)
+  Enabled: true
+Lint/NoReturnInBeginEndBlocks: # (new in 1.2)
+  Enabled: true
+Lint/NumberedParameterAssignment: # (new in 1.9)
+  Enabled: true
+Lint/OrAssignmentToConstant: # (new in 1.9)
+  Enabled: true
+Lint/RedundantDirGlobSort: # (new in 1.8)
+  Enabled: true
+Lint/SymbolConversion: # (new in 1.9)
+  Enabled: true
+Lint/ToEnumArguments: # (new in 1.1)
+  Enabled: true
+Lint/TripleQuotes: # (new in 1.9)
+  Enabled: true
+Lint/UnexpectedBlockArity: # (new in 1.5)
+  Enabled: true
+Lint/UnmodifiedReduceAccumulator: # (new in 1.1)
+  Enabled: true
+Lint/AmbiguousOperatorPrecedence: 
+  Enabled: true
+Lint/AmbiguousRange: 
+  Enabled: true
+Lint/ConstantOverwrittenInRescue:
+  Enabled: true
+Lint/EmptyInPattern: # new in 1.16
+  Enabled: true
+Lint/IncompatibleIoSelectWithFiberScheduler: # new in 1.21
+  Enabled: true
+Lint/NonAtomicFileOperation: # new in 1.31
+  Enabled: true
+Lint/RefinementImportMethods: # new in 1.27
+  Enabled: true
+Lint/RequireRelativeSelfPath: # new in 1.22
+  Enabled: true
+Lint/UselessRuby2Keywords: # new in 1.23
+  Enabled: true
+Lint/BooleanSymbol:
+  Enabled: false
 Metrics/BlockLength:
   Enabled: false
-
 Metrics/MethodLength:
   Enabled: false
-
-Metrics/LineLength:
+Layout/LineLength:
   Enabled: false
-
 Metrics/AbcSize:
   Enabled: false
-
+Metrics/PerceivedComplexity:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
 Metrics/ParameterLists:
   Enabled: false
-
+Naming/BlockForwarding: # new in 1.24
+  Enabled: true
 Naming/PredicateName:
   Enabled: false
-
+Naming/FileName:
+  Enabled: false
+Security/CompoundHash: # new in 1.28
+  Enabled: true
+Security/IoMethods: # new in 1.22
+  Enabled: true
+Style/EnvHome: # new in 1.29
+  Enabled: true
+Style/FetchEnvVar: # new in 1.28
+  Enabled: true
+Style/FileRead: # new in 1.24
+  Enabled: true
+Style/FileWrite: # new in 1.24
+  Enabled: true
+Style/InPatternThen: # new in 1.16
+  Enabled: true
+Style/MapCompactWithConditionalBlock: # new in 1.30
+  Enabled: true
+Style/MapToHash: # new in 1.24
+  Enabled: true
+Style/MultilineInPatternThen: # new in 1.16
+  Enabled: true
+Style/NestedFileDirname: # new in 1.26
+  Enabled: true
+Style/NumberedParameters: # new in 1.22
+  Enabled: true
+Style/NumberedParametersLimit: # new in 1.22
+  Enabled: true
+Style/ObjectThen: # new in 1.28
+  Enabled: true
+Style/OpenStructUse: # new in 1.23
+  Enabled: true
+Style/QuotedSymbols: # new in 1.16
+  Enabled: true
+Style/RedundantInitialize: # new in 1.27
+  Enabled: false
+Style/RedundantSelfAssignmentBranch: # new in 1.19
+  Enabled: true
+Style/SelectByRegexp: # new in 1.22
+  Enabled: true
 Style/IfUnlessModifier:
   Enabled: false
-
 Style/NilComparison:
   Enabled: false
-
 Style/NumericPredicate:
   Enabled: false
-
 Style/MultipleComparison:
   Enabled: false
-
-Metrics/PerceivedComplexity:
-  Enabled: false
-
-Metrics/CyclomaticComplexity:
-  Enabled: false
-
 Style/BlockDelimiters:
   Enabled: false
-
 Style/EmptyLiteral:
   Enabled: false
-
-Lint/BooleanSymbol:
-  Enabled: false
-
 Style/GuardClause:
   Enabled: false
-
-Naming/FileName:
-  Enabled: false
-
 Style/FrozenStringLiteralComment:
   Enabled: false
+Style/ArgumentsForwarding: # (new in 1.1)
+  Enabled: true
+Style/CollectionCompact: # (new in 1.2)
+  Enabled: true
+Style/DocumentDynamicEvalDefinition: # (new in 1.1)
+  Enabled: true
+Style/EndlessMethod: # (new in 1.8)
+  Enabled: true
+Style/HashConversion: # (new in 1.10)
+  Enabled: true
+Style/HashExcept: # (new in 1.7)
+  Enabled: true
+Style/IfWithBooleanLiteralBranches: # (new in 1.9)
+  Enabled: true
+Style/NegatedIfElseCondition: # (new in 1.2)
+  Enabled: true
+Style/NilLambda: # (new in 1.3)
+  Enabled: true
+Style/RedundantArgument: # (new in 1.4)
+  Enabled: true
+Style/StringChars: # (new in 1.12)
+  Enabled: true
+Style/SwapValues:
+  Enabled: true

data/README.md

@@ -207,7 +207,7 @@ Bug reports and pull requests are welcome on [GitHub repo](https://github.com/ar
 
 ## Future Features Under Development
 
-Check out our [Trello Board](https://trello.com/b/R3RtsJ2A/api-tester) to see progress and where we are headed!
+Check out our [Project Board](https://github.com/araneforseti/api-tester/projects/1) to see progress and where we are headed!
 Feel free to leave feedback through Github's issue tracker
 
 - Other Param Testing

data/api-tester.gemspec

@@ -31,17 +31,17 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'bundler-audit', '~>0.7.0'
+  spec.add_development_dependency 'bundler-audit', '~>0.9.0'
   spec.add_development_dependency 'guard-rspec', '~> 4.7.3'
   spec.add_development_dependency 'pry', '~> 0.11'
   spec.add_development_dependency 'rake', '~> 13.0.1'
   spec.add_development_dependency 'require_all', '~>3.0.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 0.93.0'
+  spec.add_development_dependency 'rubocop', '~> 1.31.0'
   spec.add_development_dependency 'terminal-notifier', '~> 2.0.0'
   spec.add_development_dependency 'terminal-notifier-guard', '~> 1.7.0'
   spec.add_development_dependency 'webmock', '~> 3.4'
 
-  spec.add_runtime_dependency 'injection_vulnerability_library', '0.0.2'
+  spec.add_runtime_dependency 'injection_vulnerability_library', '0.1.3'
   spec.add_runtime_dependency 'rest-client', '~> 2.0'
 end

data/lib/api-tester/config.rb

@@ -5,8 +5,7 @@ require 'api-tester/reporter/api_report'
 module ApiTester
   # Config class for changing how the tool operates
   class Config
-    attr_accessor :reporter
-    attr_accessor :modules
+    attr_accessor :reporter, :modules
 
     def initialize(reporter: ApiTester::ApiReport.new)
       self.reporter = reporter

data/lib/api-tester/definition/boundary_case.rb

@@ -3,9 +3,7 @@
 module ApiTester
   # Holds data necessary for tests
   class BoundaryCase
-    attr_accessor :payload
-    attr_accessor :headers
-    attr_accessor :description
+    attr_accessor :payload, :headers, :description
 
     def initialize(description:, payload:, headers:)
       self.description = description

data/lib/api-tester/definition/contract.rb

@@ -3,14 +3,14 @@
 module ApiTester
   # Class to define the whole contract
   class Contract
-    attr_accessor :name
-    attr_accessor :endpoints
-    attr_accessor :base_url
+    attr_accessor :name, :endpoints, :base_url, :max_time, :required_headers
 
-    def initialize(name:, base_url:)
+    def initialize(name:, base_url:, max_time: 500)
       self.name = name
       self.endpoints = []
       self.base_url = base_url
+      self.max_time = max_time
+      self.required_headers = {}
     end
 
     def add_endpoint(endpoint)

data/lib/api-tester/definition/endpoint.rb

@@ -3,36 +3,38 @@
 require 'api-tester/definition/response'
 require 'api-tester/definition/method'
 require 'api-tester/test_helper'
+require 'benchmark'
 require 'rest-client'
 require 'json'
+require 'pry'
 
 module ApiTester
   # Class for defining and interacting with endpoints in a contract
   class Endpoint
-    attr_accessor :name
-    attr_accessor :relative_url
-    attr_accessor :path_params
-    attr_accessor :methods
-    attr_accessor :test_helper
-    attr_accessor :bad_request_response
-    attr_accessor :not_allowed_response
-    attr_accessor :not_found_response
+    attr_accessor :name, :relative_url, :path_params, :methods, :test_helper, :bad_request_response, :not_allowed_response, :not_found_response, :longest_time, :required_headers
 
     def initialize(name:, relative_url:)
       self.relative_url = relative_url
       self.name = name
       self.methods = []
       self.path_params = []
-      self.test_helper = ApiTester::TestHelper.new
+      self.longest_time = { time: 0 }
+      self.test_helper = ApiTester::TestHelper.new ''
       self.bad_request_response = ApiTester::Response.new status_code: 400
       self.not_allowed_response = ApiTester::Response.new status_code: 415
       self.not_found_response = ApiTester::Response.new status_code: 404
+      self.required_headers = {}
+    end
+
+    def display_url
+      relative_url
     end
 
     def url
-      temp_url = relative_url
+      temp_url = relative_url.clone
       path_params.each do |param|
-        temp_url.sub! "{#{param}}", test_helper.retrieve_param(param)
+        value = test_helper.retrieve_param(param).to_s
+        temp_url = relative_url.sub "{#{param}}", value
       end
       temp_url
     end
@@ -42,7 +44,15 @@ module ApiTester
       method_defaults = methods[0].default_request
       method_defaults[:url] = "#{base_url}#{url}"
       begin
-        response = RestClient::Request.execute(method_defaults)
+        response = nil
+        time = Benchmark.measure {
+          response = RestClient::Request.execute(method_defaults)
+        }
+        if time.real > longest_time[:time] && longest_time[:time] > 0
+          longest_time[:time] = time.real
+          longest_time[:payload] = payload.to_json
+          longest_time[:verb] = method.verb
+        end
       rescue RestClient::ExceptionWithResponse => e
         response = e.response
       end
@@ -52,12 +62,20 @@ module ApiTester
 
     def call(base_url:, method:, query: '', payload: {}, headers: {})
       test_helper.before
-      url = query ? "#{base_url}#{self.url}?#{query}" : "#{base_url}#{self.url}"
+      call_url = query ? "#{base_url}#{url}?#{query}" : "#{base_url}#{url}"
       begin
-        response = RestClient::Request.execute(method: method.verb,
-                                               url: url,
-                                               payload: payload.to_json,
-                                               headers: headers)
+        response = nil
+        time = Benchmark.measure {
+          response = RestClient::Request.execute(method: method.verb,
+                                                 url: call_url,
+                                                 payload: payload.to_json,
+                                                 headers: headers)
+        }
+        if time.real > longest_time[:time]
+          longest_time[:time] = time.real
+          longest_time[:payload] = payload.to_json
+          longest_time[:verb] = method.verb
+        end
       rescue RestClient::ExceptionWithResponse => e
         response = e.response
       end

data/lib/api-tester/definition/fields/array_field.rb

@@ -7,8 +7,8 @@ module ApiTester
   class ArrayField < Field
     attr_accessor :fields
 
-    def initialize(name:, required: false)
-      super name: name, required: required
+    def initialize(name:, required: false, has_key: true)
+      super name: name, required: required, has_key: has_key
       self.fields = []
     end
 
@@ -21,12 +21,16 @@ module ApiTester
       true
     end
 
-    def default_value
+    def type
+      'array'
+    end
+
+    def default
       return [] if fields.size.zero?
 
       obj = {}
       fields.each do |field|
-        obj[field.name] = field.default_value
+        obj[field.name] = field.default
       end
       [obj]
     end

data/lib/api-tester/definition/fields/boolean_field.rb

@@ -5,8 +5,8 @@ require 'api-tester/definition/fields/field'
 module ApiTester
   # Class for defining booleans in contract
   class BooleanField < Field
-    def initialize(name:, default_value: true, required: false)
-      super name: name, default_value: default_value, required: required
+    def initialize(name:, default: true, required: false)
+      super name: name, default: default, required: required
     end
 
     def negative_boundary_values
@@ -19,5 +19,12 @@ module ApiTester
           {}
         ]
     end
+
+    def good_cases
+      [
+        true,
+        false
+      ]
+    end
   end
 end

data/lib/api-tester/definition/fields/email_field.rb

@@ -1,12 +1,26 @@
 # frozen_string_literal: true
 
+require 'securerandom'
+
 require 'api-tester/definition/fields/field'
 
 module ApiTester
   # Class for defining email fields in contract
   class EmailField < Field
-    def initialize(name:, default_value: 'test@test.com', required: false)
-      super name: name, default_value: default_value, required: required
+    attr_accessor :randomize
+
+    def initialize(name:, default: 'test@test.com', required: false, randomize: false)
+      super name: name, default: default, required: required
+      self.randomize = randomize
+    end
+
+    def default
+      # Since many APIs have unique email checks, this allows us to generate hopefully unique emails
+      if randomize
+        "test#{SecureRandom.hex(10)}@test.com"
+      else
+        super
+      end
     end
 
     def negative_boundary_values

data/lib/api-tester/definition/fields/enum_field.rb

@@ -7,11 +7,11 @@ module ApiTester
   class EnumField < Field
     attr_accessor :acceptable_values
 
-    def initialize(name:, acceptable_values:, default_value: nil, required: false)
-      if default_value
-        super name: name, default_value: default_value, required: required
+    def initialize(name:, acceptable_values:, default: nil, required: false)
+      if default
+        super name: name, default: default, required: required
       else
-        super name: name, default_value: acceptable_values[0], required: required
+        super name: name, default: acceptable_values[0], required: required
       end
 
       self.acceptable_values = acceptable_values
@@ -28,5 +28,9 @@ module ApiTester
           {}
         ]
     end
+
+    def good_cases
+      acceptable_values
+    end
   end
 end

data/lib/api-tester/definition/fields/field.rb

@@ -3,16 +3,18 @@
 module ApiTester
   # Base class for field definitions
   class Field
-    attr_accessor :name
-    attr_accessor :default_value
-    attr_accessor :required
-    attr_accessor :is_seen
+    attr_accessor :name, :default, :required, :is_seen, :has_key
 
-    def initialize(name:, required: false, default_value: 'string')
+    def initialize(name:, required: false, has_key: true, default: 'string')
       self.name = name
-      self.default_value = default_value
+      self.default = default
       self.required = required
       self.is_seen = 0
+      self.has_key = has_key
+    end
+
+    def type
+      'field'
     end
 
     def is_required
@@ -39,6 +41,10 @@ module ApiTester
       cases
     end
 
+    def good_cases
+      []
+    end
+
     def seen
       self.is_seen += 1
     end

data/lib/api-tester/definition/fields/number_field.rb

@@ -5,8 +5,8 @@ require 'api-tester/definition/fields/field'
 module ApiTester
   # Class for defining numeric fields in contracts
   class NumberField < Field
-    def initialize(name:, default_value: 5, required: false)
-      super name: name, default_value: default_value, required: required
+    def initialize(name:, default: 5, required: false)
+      super name: name, default: default, required: required
     end
 
     def negative_boundary_values
@@ -18,5 +18,16 @@ module ApiTester
           {}
         ]
     end
+
+    def good_cases
+      [
+        -1,
+        0,
+        1,
+        100,
+        9999,
+        12_345_678_901_234_567_890
+      ]
+    end
   end
 end

data/lib/api-tester/definition/fields/object_field.rb

@@ -7,8 +7,8 @@ module ApiTester
   class ObjectField < Field
     attr_accessor :fields
 
-    def initialize(name:, required: false)
-      super name: name, required: required
+    def initialize(name:, required: false, has_key: true)
+      super name: name, required: required, has_key: has_key
       self.fields = []
     end
 
@@ -21,11 +21,15 @@ module ApiTester
       true
     end
 
-    def default_value
+    def type
+      'object'
+    end
+
+    def default
       obj = {}
 
       fields.each do |field|
-        obj[field.name] = field.default_value
+        obj[field.name] = field.default
       end
 
       obj

data/lib/api-tester/definition/fields/plain_array_field.rb

@@ -5,8 +5,8 @@ require 'api-tester/definition/fields/field'
 module ApiTester
   # Class for defining plain arrays
   class PlainArrayField < Field
-    def initialize(name:, default_value: [], required: false)
-      super name: name, default_value: default_value, required: required
+    def initialize(name:, default: [], required: false)
+      super name: name, default: default, required: required
     end
 
     def negative_boundary_values

data/lib/api-tester/definition/method.rb

@@ -3,9 +3,7 @@
 module ApiTester
   # Class for defining methods as part of an endpoint
   class Method
-    attr_accessor :request
-    attr_accessor :expected_response
-    attr_accessor :verb
+    attr_accessor :request, :expected_response, :verb
 
     def initialize(verb:, response:, request:)
       self.verb = verb