api-tester 0.1.0 → 1.1.1

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

@@ -0,0 +1,21 @@
+# 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
+
+    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
+  end
+end

data/lib/api-tester/test_helper.rb

@@ -0,0 +1,12 @@
+# 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 retrieve_param(key); end
+
+    def after; end
+  end
+end

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

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module ApiTester
+  # Class for evaluating responses against what is expected
+  class ResponseEvaluator
+    attr_accessor :response_body
+    attr_accessor :expected_response
+
+    def initialize(actual_body:, expected_fields:)
+      self.response_body = actual_body
+      self.expected_response = expected_fields
+    end
+
+    def response_field_array
+      field_array response_body
+    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
+    end
+
+    def expected_fields_hash
+      expected_field_array expected_response.body
+    end
+
+    def extra_fields
+      response_field_array - expected_fields
+    end
+
+    def missing_fields
+      expected_fields - response_field_array
+    end
+
+    def expected_field_array(expected_fields)
+      fields = {}
+      expected_fields.each do |field|
+        fields[field.name] = field
+        fields = fields.merge inner_expected_field(expected_fields: field.fields,
+                                                   name: field.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(expected_fields: field.fields,
+                                                   name: inner_name)
+      end
+      fields
+    end
+
+    def field_array(object)
+      fields = []
+
+      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
+          fields << key.to_s
+          fields.concat(field_array(value).map { |i| "#{key}.#{i}" })
+        else
+          fields.concat(field_array(key))
+        end
+      end
+      fields
+    rescue NoMethodError
+      fields
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module ApiTester
+  # Class defining the verbs this tool supports
+  class SupportedVerbs
+    def self.add_item(key, value)
+      @hash ||= {}
+      @hash[key] = value
+    end
+
+    def self.const_missing(key)
+      @hash[key]
+    end
+
+    def self.each
+      @hash.each { |key, value| yield(key, value) }
+    end
+
+    def self.all
+      @hash.values
+    end
+
+    SupportedVerbs.add_item :COPY, :copy
+    SupportedVerbs.add_item :DELETE, :delete
+    SupportedVerbs.add_item :GET, :get
+    SupportedVerbs.add_item :HEAD, :head
+    SupportedVerbs.add_item :LOCK, :lock
+    SupportedVerbs.add_item :MKCOL, :mkcol
+    SupportedVerbs.add_item :MOVE, :move
+    SupportedVerbs.add_item :OPTIONS, :options
+    SupportedVerbs.add_item :PATCH, :patch
+    SupportedVerbs.add_item :POST, :post
+    SupportedVerbs.add_item :PROPFIND, :propfind
+    SupportedVerbs.add_item :PROPPATCH, :proppatch
+    SupportedVerbs.add_item :PUT, :put
+    SupportedVerbs.add_item :TRACE, :trace
+    SupportedVerbs.add_item :UNLOCK, :unlock
+  end
+end

data/lib/api-tester/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ApiTester
+  VERSION = '1.1.1'
+end

metadata

@@ -1,43 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: api-tester
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - arane
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-22 00:00:00.000000000 Z
+date: 2020-10-08 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.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.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: '1.13'
+        version: 4.7.3
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        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
@@ -52,6 +108,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.93.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.93.0
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier-guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +164,20 @@ dependencies:
     - - "~>"
       - !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
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.2
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -88,10 +200,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/push.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- ".rubocop.yml"
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -99,42 +215,44 @@ files:
 - bin/console
 - bin/setup
 - changelog.txt
-- lib/tester.rb
-- lib/tester/api_tester.rb
-- lib/tester/definition/api_contract.rb
-- lib/tester/definition/api_method.rb
-- lib/tester/definition/boundary_case.rb
-- lib/tester/definition/endpoint.rb
-- lib/tester/definition/fields/array_field.rb
-- lib/tester/definition/fields/boolean_field.rb
-- lib/tester/definition/fields/email_field.rb
-- lib/tester/definition/fields/enum_field.rb
-- lib/tester/definition/fields/field.rb
-- lib/tester/definition/fields/number_field.rb
-- lib/tester/definition/fields/object_field.rb
-- lib/tester/definition/request.rb
-- lib/tester/definition/response.rb
-- lib/tester/method_case_test.rb
-- lib/tester/modules/extra_verbs.rb
-- lib/tester/modules/format.rb
-- lib/tester/modules/good_case.rb
-- lib/tester/modules/module.rb
-- lib/tester/modules/typo.rb
-- lib/tester/modules/unused_fields.rb
-- lib/tester/reporter/api_report.rb
-- lib/tester/reporter/missing_field_report.rb
-- lib/tester/reporter/missing_response_field_report.rb
-- lib/tester/reporter/report.rb
-- lib/tester/reporter/status_code_report.rb
-- lib/tester/test_helper.rb
-- lib/tester/util/response_evaluator.rb
-- lib/tester/util/supported_verbs.rb
-- lib/tester/version.rb
+- lib/api-tester.rb
+- lib/api-tester/config.rb
+- lib/api-tester/definition/boundary_case.rb
+- lib/api-tester/definition/contract.rb
+- lib/api-tester/definition/endpoint.rb
+- lib/api-tester/definition/fields/array_field.rb
+- lib/api-tester/definition/fields/boolean_field.rb
+- lib/api-tester/definition/fields/email_field.rb
+- lib/api-tester/definition/fields/enum_field.rb
+- 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/extra_verbs.rb
+- lib/api-tester/modules/format.rb
+- lib/api-tester/modules/good_case.rb
+- lib/api-tester/modules/injection_module.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/report.rb
+- lib/api-tester/reporter/status_code_report.rb
+- lib/api-tester/test_helper.rb
+- lib/api-tester/util/response_evaluator.rb
+- lib/api-tester/util/supported_verbs.rb
+- lib/api-tester/version.rb
 homepage: https://github.com/araneforseti/api-tester
 licenses:
 - MIT
-metadata:
-  allowed_push_host: https://rubygems.org/
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -150,8 +268,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
 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