api-tester 0.1.0 → 1.1.1

data/Rakefile

@@ -1,6 +1,11 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new(:rubocop) do |t|
+  t.options = ['--display-cop-names']
+end
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task :default => [:rubocop, :spec]

data/api-tester.gemspec

@@ -1,39 +1,47 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'tester/version'
+require 'api-tester/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "api-tester"
-  spec.version       = Tester::VERSION
-  spec.authors       = ["arane"]
-  spec.email         = ["arane9@gmail.com"]
+  spec.name          = 'api-tester'
+  spec.version       = ApiTester::VERSION
+  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 'bundler'
+  spec.add_development_dependency 'bundler-audit', '~>0.7.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 '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 'rest-client', '~> 2.0'
 end

data/changelog.txt

@@ -1,3 +1,38 @@
+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
+
+0.3.2
+
+- Fixing some issues with how config adds modules
+- Fixing README for same module issue as config
+
+0.3.1
+
+- Adding ability to change headers for request objects
+- Removing the reports from the sub modules and making them just return their reports
+- Adjusted modules to use the full contract instead of endpoints
+- Created module to check for server information being broadcast
+
+0.3.0
+
+- Making modules actually be modules
+
+0.2.0
+
+- Finally fixing the naming scheme
+- Splitting configuration into its own class
+
 0.1.0
 
 - Moving call to endpoint for path param support

data/lib/api-tester.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# Tool for testing through API definitions
+module ApiTester
+  def self.go(contract, config)
+    reporter = config.reporter
+
+    config.modules.sort_by(&:order).each do |mod|
+      reporter.add_reports mod.go contract
+    end
+
+    reporter.print
+    reporter.reports.size.zero?
+  end
+end

data/lib/api-tester/config.rb

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

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module ApiTester
+  # Holds data necessary for tests
+  class BoundaryCase
+    attr_accessor :payload
+    attr_accessor :headers
+    attr_accessor :description
+
+    def initialize(description:, payload:, headers:)
+      self.description = description
+      self.payload = payload
+      self.headers = headers
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ApiTester
+  # Class to define the whole contract
+  class Contract
+    attr_accessor :name
+    attr_accessor :endpoints
+    attr_accessor :base_url
+
+    def initialize(name:, base_url:)
+      self.name = name
+      self.endpoints = []
+      self.base_url = base_url
+    end
+
+    def add_endpoint(endpoint)
+      endpoints << endpoint
+    end
+  end
+end

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

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require 'api-tester/definition/response'
+require 'api-tester/definition/method'
+require 'api-tester/test_helper'
+require 'rest-client'
+require 'json'
+
+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
+
+    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 status_code: 400
+      self.not_allowed_response = ApiTester::Response.new status_code: 415
+      self.not_found_response = ApiTester::Response.new status_code: 404
+    end
+
+    def url
+      temp_url = relative_url
+      path_params.each do |param|
+        temp_url.sub! "{#{param}}", test_helper.retrieve_param(param)
+      end
+      temp_url
+    end
+
+    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)
+      rescue RestClient::ExceptionWithResponse => e
+        response = e.response
+      end
+      test_helper.after
+      response
+    end
+
+    def call(base_url:, method:, query: '', payload: {}, headers: {})
+      test_helper.before
+      url = query ? "#{base_url}#{self.url}?#{query}" : "#{base_url}#{self.url}"
+      begin
+        response = RestClient::Request.execute(method: method.verb,
+                                               url: url,
+                                               payload: payload.to_json,
+                                               headers: headers)
+      rescue RestClient::ExceptionWithResponse => e
+        response = e.response
+      end
+      test_helper.after
+      response
+    end
+
+    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)
+      path_params << param
+      self
+    end
+
+    def verbs
+      methods.map(&:verb)
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# 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:, required: false)
+      super name: name, required: required
+      self.fields = []
+    end
+
+    def with_field(new_field)
+      fields << new_field
+      self
+    end
+
+    def subfields?
+      true
+    end
+
+    def default_value
+      return [] if fields.size.zero?
+
+      obj = {}
+      fields.each do |field|
+        obj[field.name] = field.default_value
+      end
+      [obj]
+    end
+
+    def negative_boundary_values
+      super +
+        [
+          'string',
+          123,
+          0,
+          1,
+          true,
+          false,
+          {}
+        ]
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# 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, required: false)
+      super name: name, default_value: default_value, required: required
+    end
+
+    def negative_boundary_values
+      super +
+        [
+          'string',
+          123,
+          0,
+          1,
+          {}
+        ]
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+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
+    end
+
+    def negative_boundary_values
+      super +
+        [
+          'string',
+          123,
+          1,
+          0,
+          true,
+          false,
+          {}
+        ]
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# 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, required: false)
+      if default_value
+        super name: name, default_value: default_value, required: required
+      else
+        super name: name, default_value: acceptable_values[0], required: required
+      end
+
+      self.acceptable_values = acceptable_values
+    end
+
+    def negative_boundary_values
+      super +
+        [
+          123,
+          0,
+          1,
+          true,
+          false,
+          {}
+        ]
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+# 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 subfields?
+      false
+    end
+
+    def fields
+      []
+    end
+
+    def negative_boundary_values
+      cases = []
+      cases << nil if required
+      cases
+    end
+
+    def seen
+      self.is_seen += 1
+    end
+
+    def display_class
+      self.class
+    end
+  end
+end