api-tester 1.0.0 → 1.1.3

data/api-tester.gemspec

@@ -4,39 +4,43 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'api-tester/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "api-tester"
+  spec.name          = 'api-tester'
   spec.version       = ApiTester::VERSION
-  spec.authors       = ["arane"]
-  spec.email         = ["arane9@gmail.com"]
+  spec.authors       = ['arane']
+  spec.email         = ['arane9@gmail.com']
 
-  spec.summary       = %q{Tool to help test APIs}
-  spec.description   = %q{Tool to test APIs which will eventually do boundary testing and other sorts of testing automatically given a contract}
-  spec.homepage      = "https://github.com/araneforseti/api-tester"
-  spec.license       = "MIT"
+  spec.summary       = 'Tool to help test APIs'
+  spec.description   = 'Tool to test APIs which will eventually do boundary testing and other sorts of testing automatically given a contract'
+  spec.homepage      = 'https://github.com/araneforseti/api-tester'
+  spec.license       = 'MIT'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
-  if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = 'https://rubygems.org/'
-  else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
-  end
+#  if spec.respond_to?(:metadata)
+#    spec.metadata['allowed_push_host'] = 'https://rubygems.org/'
+#  else
+#    raise 'RubyGems 2.0 or newer is required to protect against ' \
+#      'public gem pushes.'
+#  end
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.13"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "webmock", "~> 3.4"
-  spec.add_development_dependency "pry", "~> 0.11"
-  spec.add_development_dependency "require_all", "~>2.0.0"
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'bundler-audit', '~>0.9.0'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7.3'
+  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', '~> 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 "rest-client", "~> 2.0"
-  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/changelog.txt

@@ -1,3 +1,13 @@
+2.0.0
+
+- Added Required Fields module
+- Added Unexpected Fields module
+- Adding query params to definition
+- Moved base_url to contract
+- Changed endpoints to be relative urls
+- Removed missing field report as it was unused
+- Changing everything with more than one parameter to named parameters
+
 1.0.0
 
 - Switching to using named variables to make future changes less breaky

data/lib/api-tester/config.rb

@@ -1,39 +1,41 @@
+# frozen_string_literal: true
+
 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
+    def initialize(reporter: ApiTester::ApiReport.new)
       self.reporter = reporter
       self.modules = []
     end
 
-    def with_reporter reporter
+    def with_reporter(reporter)
       self.reporter = reporter
       self
     end
 
-    def with_module new_module
-      self.modules << new_module
+    def with_module(new_module)
+      modules << new_module
       self
     end
 
     def with_default_modules
-      self.modules << Format
-      self.modules << GoodCase
-      self.modules << Typo
-      self.modules << UnusedFields
+      modules << Format
+      modules << GoodCase
+      modules << Typo
+      modules << UnusedFields
       self
     end
 
     def with_all_modules
-      self.modules << Format
-      self.modules << ExtraVerbs
-      self.modules << GoodCase
-      self.modules << Typo
-      self.modules << UnusedFields
+      modules << Format
+      modules << ExtraVerbs
+      modules << GoodCase
+      modules << Typo
+      modules << UnusedFields
       self
     end
   end

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

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 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
+    def initialize(description:, payload:, headers:)
       self.description = description
       self.payload = payload
       self.headers = headers

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

@@ -1,15 +1,20 @@
+# frozen_string_literal: true
+
 module ApiTester
+  # Class to define the whole contract
   class Contract
-    attr_accessor :name
-    attr_accessor :endpoints
+    attr_accessor :name, :endpoints, :base_url, :max_time, :required_headers
 
-    def initialize name
+    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
-      self.endpoints << endpoint
+    def add_endpoint(endpoint)
+      endpoints << endpoint
     end
   end
 end

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

@@ -1,75 +1,101 @@
+# frozen_string_literal: true
+
 require 'api-tester/definition/response'
 require 'api-tester/definition/method'
 require 'api-tester/test_helper'
+require 'benchmark'
 require 'rest-client'
 require 'json'
 
 module ApiTester
+  # Class for defining and interacting with endpoints in a contract
   class Endpoint
-    attr_accessor :name
-    attr_accessor :base_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, url
-      self.base_url = url
+    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.bad_request_response = ApiTester::Response.new 400
-      self.not_allowed_response = ApiTester::Response.new 415
-      self.not_found_response = ApiTester::Response.new 404
+      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 = self.base_url
-      self.path_params.each do |param|
-        temp_url.sub! "{#{param}}", self.test_helper.retrieve_param(param)
+      temp_url = relative_url.clone
+      path_params.each do |param|
+        value = test_helper.retrieve_param(param).to_s
+        temp_url = relative_url.sub "{#{param}}", value
       end
       temp_url
     end
 
-    def default_call
-      self.test_helper.before
-      method_defaults = self.methods[0].default_request
-      method_defaults[:url] = self.url
+    def default_call(base_url)
+      test_helper.before
+      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
-      self.test_helper.after
+      test_helper.after
       response
     end
 
-    def call method, payload={}, headers={}
-      self.test_helper.before
+    def call(base_url:, method:, query: '', payload: {}, headers: {})
+      test_helper.before
+      call_url = query ? "#{base_url}#{url}?#{query}" : "#{base_url}#{url}"
       begin
-        response = RestClient::Request.execute(method: method.verb, url: self.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
-      self.test_helper.after
+      test_helper.after
       response
     end
 
-    def add_method verb, response, request=Request.new()
-      self.methods << ApiTester::Method.new(verb, response, request)
+    def add_method(verb:, response:, request: Request.new)
+      methods << ApiTester::Method.new(verb: verb,
+                                       response: response,
+                                       request: request)
       self
     end
 
-    def add_path_param param
-      self.path_params << param
+    def add_path_param(param)
+      path_params << param
       self
     end
 
     def verbs
-      self.methods.map(&:verb)
+      methods.map(&:verb)
     end
   end
 end

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

@@ -1,46 +1,51 @@
+# frozen_string_literal: true
+
 require 'api-tester/definition/fields/field'
 
 module ApiTester
+  # Class used for defining array fields
   class ArrayField < Field
     attr_accessor :fields
 
-    def initialize name: 
-      super name: name
+    def initialize(name:, required: false, has_key: true)
+      super name: name, required: required, has_key: has_key
       self.fields = []
     end
 
-    def with_field newField
-      self.fields << newField
+    def with_field(new_field)
+      fields << new_field
       self
     end
 
-    def has_subfields?
+    def subfields?
       true
     end
 
-    def default_value
-      if self.fields.size == 0
-        return []
-      end
+    def type
+      'array'
+    end
+
+    def default
+      return [] if fields.size.zero?
 
-      obj = Hash.new
-      self.fields.each do |field|
-        obj[field.name] = field.default_value
+      obj = {}
+      fields.each do |field|
+        obj[field.name] = field.default
       end
       [obj]
     end
 
     def negative_boundary_values
       super +
-      [
-        "string",
-        123,
-        0,
-        1,
-        true,
-        false,
-        {}
-      ]
+        [
+          'string',
+          123,
+          0,
+          1,
+          true,
+          false,
+          {}
+        ]
     end
   end
 end

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

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

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

@@ -1,22 +1,39 @@
+# 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"
-      super name: name, default_value: default_value
+    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
       super +
-      [
-        "string",
-        123,
-        1,
-        0,
-        true,
-        false,
-        {}
-      ]
+        [
+          'string',
+          123,
+          1,
+          0,
+          true,
+          false,
+          {}
+        ]
     end
   end
 end

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

@@ -1,14 +1,17 @@
+# frozen_string_literal: true
+
 require 'api-tester/definition/fields/field'
 
 module ApiTester
+  # Class for defining enumerators
   class EnumField < Field
     attr_accessor :acceptable_values
 
-    def initialize name:, acceptable_values:, default_value: nil
-      if default_value
-        super name: name, default_value: default_value
+    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]
+        super name: name, default: acceptable_values[0], required: required
       end
 
       self.acceptable_values = acceptable_values
@@ -16,14 +19,18 @@ module ApiTester
 
     def negative_boundary_values
       super +
-          [
-              123,
-              0,
-              1,
-              true,
-              false,
-              {}
-          ]
+        [
+          123,
+          0,
+          1,
+          true,
+          false,
+          {}
+        ]
+    end
+
+    def good_cases
+      acceptable_values
     end
   end
 end

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

@@ -1,49 +1,56 @@
+# frozen_string_literal: true
+
 module ApiTester
+  # Base class for field definitions
   class Field
-      attr_accessor :name
-      attr_accessor :default_value
-      attr_accessor :required
-      attr_accessor :is_seen
-
-      def initialize name:, required:false, default_value:"string"
-          self.name = name
-          self.default_value = default_value
-          self.required = required
-          self.is_seen = 0
-      end
-
-      def is_required
-          self.required = true
-          self
-      end
-
-      def is_not_required
-          self.required = false
-          self
-      end
-
-      def has_subfields?
-          false
-      end
-
-      def fields
-          []
-      end
-
-      def negative_boundary_values
-          cases = []
-          if self.required
-              cases << nil
-          end
-          cases
-      end
-
-      def seen
-          self.is_seen += 1
-      end
-
-      def display_class
-          self.class
-      end
+    attr_accessor :name, :default, :required, :is_seen, :has_key
+
+    def initialize(name:, required: false, has_key: true, default: 'string')
+      self.name = name
+      self.default = default
+      self.required = required
+      self.is_seen = 0
+      self.has_key = has_key
+    end
+
+    def type
+      'field'
+    end
+
+    def is_required
+      self.required = true
+      self
+    end
+
+    def is_not_required
+      self.required = false
+      self
+    end
+
+    def subfields?
+      false
+    end
+
+    def fields
+      []
+    end
+
+    def negative_boundary_values
+      cases = []
+      cases << nil if required
+      cases
+    end
+
+    def good_cases
+      []
+    end
+
+    def seen
+      self.is_seen += 1
+    end
+
+    def display_class
+      self.class
+    end
   end
 end

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

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