api-tester 0.3.1 → 1.1.2

data/lib/api-tester/reporter/missing_field_report.rb

@@ -1,25 +1,21 @@
-module ApiReport
+# frozen_string_literal: true
+
+module ApiTester
+  # Report used for when response is missing a field
   class MissingFieldReport
-    attr_accessor :description
-    attr_accessor :url
-    attr_accessor :request
-    attr_accessor :expected_field
-    attr_accessor :actual_response
+    attr_accessor :url, :verb, :expected_field, :description
 
-    def initialize(description, url, request, expected_field)
-      self.description = description
+    def initialize(url:, verb:, expected_field:, description:)
       self.url = url
-      self.request = request
+      self.verb = verb
       self.expected_field = expected_field
-      self.actual_response = ''
+      self.description = description
     end
 
     def print
-      puts "#{self.description}: "
-      puts "   Requested #{self.url} with payload:"
-      puts "      #{self.request}"
-      puts '   Missing field: '
-      puts "      #{self.expected_field}"
+      puts "#{description}:"
+      puts "   #{verb} #{url} is missing response field:"
+      puts "      #{expected_field}"
     end
   end
 end

data/lib/api-tester/reporter/report.rb

@@ -1,12 +1,11 @@
+# frozen_string_literal: true
+
 module ApiTester
+  # Standard report format for differing responses
   class Report
-    attr_accessor :description
-    attr_accessor :url
-    attr_accessor :request
-    attr_accessor :expected_response
-    attr_accessor :actual_response
+    attr_accessor :description, :url, :request, :expected_response, :actual_response
 
-    def initialize description, url, request, expected_response, actual_response
+    def initialize(description:, url:, request:, expected_response:, actual_response:)
       self.description = description
       self.url = url
       self.request = request
@@ -15,13 +14,13 @@ module ApiTester
     end
 
     def print
-      puts "#{self.description}: "
-      puts "   Requested #{self.url} with payload:"
-      puts "      #{self.request.to_json}"
-      puts "   Expecting: "
-      puts "      " + self.expected_response.to_s
-      puts "   Receiving: "
-      puts "      #{self.actual_response}"
+      puts "#{description}: "
+      puts "   Requested #{url} with payload:"
+      puts "      #{request.to_json}"
+      puts '   Expecting: '
+      puts "      #{expected_response}"
+      puts '   Receiving: '
+      puts "      #{actual_response}"
     end
   end
 end

data/lib/api-tester/reporter/response_time_report.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module ApiTester
+  # Report used for when response took too long
+  class ResponseTimeReport
+    attr_accessor :url, :verb, :payload, :max_time, :actual_time, :description
+
+    def initialize(url:, verb:, payload:, max_time:, actual_time:, description:)
+      self.url = url
+      self.verb = verb
+      self.payload = payload
+      self.max_time = max_time
+      self.actual_time = actual_time
+      self.description = description
+    end
+
+    def print
+      puts "#{description}:"
+      puts "   #{verb} #{url} took #{actual_time}ms, the max time is #{max_time}ms:"
+      puts '     Payload:'
+      puts "      #{payload}"
+    end
+  end
+end

data/lib/api-tester/reporter/status_code_report.rb

@@ -1,12 +1,18 @@
+# frozen_string_literal: true
+
 require 'api-tester/reporter/report'
 
 module ApiTester
+  # Report for when status code is different than expected
   class StatusCodeReport < Report
-    attr_accessor :expected_status_code
-    attr_accessor :actual_status_code
+    attr_accessor :expected_status_code, :actual_status_code
 
-    def initialize description, url, request, expected_status_code, actual_status_code
-      super description, url, request, expected_status_code, actual_status_code
+    def initialize(description:, url:, request:, expected_status_code:, actual_status_code:)
+      super description: description,
+            url: url,
+            request: request,
+            expected_response: expected_status_code,
+            actual_response: actual_status_code
       self.expected_status_code = expected_status_code
       self.actual_status_code = actual_status_code
     end

data/lib/api-tester/test_helper.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 module ApiTester
+  # Interface for when things need to be done before or after an api call
   class TestHelper
-    def before
-    end
+    def initialize(url); end
+
+    def before; end
 
-    def retrieve_param key
-    end
+    def retrieve_param(key); end
 
-    def after
-    end
+    def after; end
   end
 end

data/lib/api-tester/util/response_evaluator.rb

@@ -1,75 +1,103 @@
+# frozen_string_literal: true
+
 module ApiTester
+  # Class for evaluating responses against what is expected
   class ResponseEvaluator
-      attr_accessor :response_body
-      attr_accessor :expected_response
+    attr_accessor :response_body, :expected_response, :expected_fields_hash
 
-      def initialize(actual_response_body, expected_response_fields)
-          self.response_body = actual_response_body
-          self.expected_response = expected_response_fields
-      end
+    def initialize(actual_body:, expected_fields:)
+      self.response_body = actual_body
+      self.expected_response = expected_fields
+      self.expected_fields_hash = expected_field_array(expected_response.body)
+    end
 
-      def response_field_array
-          field_array self.response_body
-      end
+    def response_field_array
+      field_array response_body
+    end
 
-      def expected_fields
-          expected_fields_hash.keys
-      end
+    def expected_fields
+      expected_fields_hash.keys
+    end
 
-      def seen_fields
-          seen = []
-          fields = response_field_array - extra_fields
-          expected = expected_fields_hash
-          fields.each do |field_key|
-              seen << expected[field_key]
-          end
-          seen
+    def seen_fields
+      seen = []
+      fields = response_field_array - extra_fields
+      expected = expected_fields_hash
+      fields.each do |field_key|
+        seen << expected[field_key]
       end
+      seen
+    end
 
-      def expected_fields_hash
-          expected_field_array self.expected_response.body
-      end
+    def extra_fields
+      response_field_array - expected_fields
+    end
 
-      def extra_fields
-          response_field_array - expected_fields
-      end
+    def missing_fields
+      expected_fields - response_field_array
+    end
 
-      def missing_fields
-          expected_fields - response_field_array
+    def expected_field_array(expected_fields)
+      fields = {}
+      expected_fields.each do |field|
+        field_name = field.name
+        if field.has_key
+          fields[field.name] = field
+        else
+          field_name = field.type
+        end
+        fields = fields.merge inner_expected_field(expected_fields: field.fields,
+                                                   name: field_name)
       end
+      fields
+    end
 
-      def expected_field_array expected_fields
-          fields = {}
-          expected_fields.each do |field|
-              fields[field.name] = field
-              fields = fields.merge inner_expected_field(field.fields, field.name)
-          end
-          fields
+    def inner_expected_field(expected_fields:, name:)
+      fields = {}
+      expected_fields.each do |field|
+        inner_name = "#{name}.#{field.name}"
+        if field.has_key
+          fields[inner_name] = field
+        else
+          inner_name = "#{name}.#{field.type}"
+        end
+        fields = fields.merge inner_expected_field(expected_fields: field.fields,
+                                                   name: inner_name)
       end
+      fields
+    end
 
-      def inner_expected_field expected_fields, name
-          fields = {}
-          expected_fields.each do |field|
-              inner_name = "#{name}.#{field.name}"
-              fields[inner_name] = field
-              fields = fields.merge inner_expected_field(field.fields, inner_name)
-          end
-          fields
-      end
+    def field_array(object)
+      fields = []
 
-      def field_array object
-          fields = []
-          object.each do |key, value|
-              if(value)
-                  fields << key.to_s
-                  fields.concat(field_array(value).map{|i| "#{key}.#{i}"})
-              else
-                  fields.concat(field_array(key))
-              end
+      if object.instance_of?(Array)
+        name = 'array'
+        fields.concat(field_array(object[0]).map { |i| "#{name}.#{i}" })
+      else
+        object.each do |key, value|
+          if key.respond_to?('each')
+            fields.concat(field_array(key))
+          elsif value == nil || value == 0 || value == false
+            fields << key.to_s
+            fields.concat(field_array(value).map { |i| "#{key}.#{i}" })
+          elsif value.to_s[0] == '[' && value.to_s[-1] == ']' && !value.to_s.include?('=>')
+            fields << key.to_s
+          elsif value
+            passed_value = value
+            fields << key.to_s
+            if value.instance_of?(Array)
+              passed_value = value[0]
+            end
+            fields.concat(field_array(passed_value).map { |i| "#{key}.#{i}" })
+          else
+            fields.concat(field_array(key))
           end
-          fields
-         rescue NoMethodError
-          fields
+        end
       end
+
+      fields
+    rescue NoMethodError
+      fields
+    end
   end
 end

data/lib/api-tester/util/supported_verbs.rb

@@ -1,19 +1,22 @@
+# frozen_string_literal: true
+
 module ApiTester
+  # Class defining the verbs this tool supports
   class SupportedVerbs
-    def SupportedVerbs.add_item(key, value)
+    def self.add_item(key, value)
       @hash ||= {}
       @hash[key] = value
     end
 
-    def SupportedVerbs.const_missing(key)
+    def self.const_missing(key)
       @hash[key]
     end
 
-    def SupportedVerbs.each
-      @hash.each {|key,value| yield(key,value)}
+    def self.each(&block)
+      @hash.each(&block)
     end
 
-    def SupportedVerbs.all
+    def self.all
       @hash.values
     end
 

data/lib/api-tester/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ApiTester
-  VERSION = "0.3.1"
+  VERSION = '1.1.2'
 end

data/lib/api-tester.rb

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

metadata

@@ -1,43 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: api-tester
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 1.1.2
 platform: ruby
 authors:
 - arane
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-30 00:00:00.000000000 Z
+date: 2022-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.3
+- !ruby/object:Gem::Dependency
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '0.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '0.11'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 13.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+- !ruby/object:Gem::Dependency
+  name: require_all
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -53,61 +109,89 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: 1.31.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: 1.31.0
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: terminal-notifier
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: 2.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  name: terminal-notifier-guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
+        version: 1.7.0
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 1.7.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: injection_vulnerability_library
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.2
+        version: 0.1.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.2
+        version: 0.1.3
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 description: Tool to test APIs which will eventually do boundary testing and other
   sorts of testing automatically given a contract
 email:
@@ -116,10 +200,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/dependabot.yml"
+- ".github/workflows/push.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- ".rubocop.yml"
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -139,21 +228,27 @@ files:
 - lib/api-tester/definition/fields/field.rb
 - lib/api-tester/definition/fields/number_field.rb
 - lib/api-tester/definition/fields/object_field.rb
+- lib/api-tester/definition/fields/plain_array_field.rb
 - lib/api-tester/definition/method.rb
 - lib/api-tester/definition/request.rb
 - lib/api-tester/definition/response.rb
 - lib/api-tester/method_case_test.rb
+- lib/api-tester/modules/benchmark_module.rb
 - lib/api-tester/modules/extra_verbs.rb
 - lib/api-tester/modules/format.rb
 - lib/api-tester/modules/good_case.rb
+- lib/api-tester/modules/good_variations.rb
 - lib/api-tester/modules/injection_module.rb
+- lib/api-tester/modules/missing_resource.rb
+- lib/api-tester/modules/required_fields.rb
 - lib/api-tester/modules/server_information.rb
 - lib/api-tester/modules/typo.rb
+- lib/api-tester/modules/unexpected_fields.rb
 - lib/api-tester/modules/unused_fields.rb
 - lib/api-tester/reporter/api_report.rb
 - lib/api-tester/reporter/missing_field_report.rb
-- lib/api-tester/reporter/missing_response_field_report.rb
 - lib/api-tester/reporter/report.rb
+- lib/api-tester/reporter/response_time_report.rb
 - lib/api-tester/reporter/status_code_report.rb
 - lib/api-tester/test_helper.rb
 - lib/api-tester/util/response_evaluator.rb
@@ -162,8 +257,7 @@ files:
 homepage: https://github.com/araneforseti/api-tester
 licenses:
 - MIT
-metadata:
-  allowed_push_host: https://rubygems.org/
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -179,8 +273,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Tool to help test APIs

data/.travis.yml

@@ -1,6 +0,0 @@
-language: ruby
-
-rvm:
-  - 2.2.1
-  
-before_install: gem install bundler -v 1.13.6

data/lib/api-tester/reporter/missing_response_field_report.rb

@@ -1,21 +0,0 @@
-module ApiTester
-  class MissingResponseFieldReport
-    attr_accessor :url
-    attr_accessor :verb
-    attr_accessor :expected_field
-    attr_accessor :description
-
-    def initialize(url, verb, expected_field, description)
-      self.url = url
-      self.verb = verb
-      self.expected_field = expected_field
-      self.description = description
-    end
-
-    def print
-      puts "#{self.description}:"
-      puts "   #{self.verb} #{self.url} is missing response field:"
-      puts "      #{self.expected_field}"
-    end
-  end
-end