api-tester 0.0.1

data/lib/tester/modules/module.rb

@@ -0,0 +1,38 @@
+require 'tester/reporter/status_code_report'
+require 'tester/test_helper'
+
+class Module
+  attr_accessor :report
+  attr_accessor :test_helper
+
+  def initialize
+    self.test_helper = TestHelper.new
+  end
+
+  def set_report report
+    self.report = report
+  end
+
+  def go definition, report
+    set_report report
+  end
+
+  def order
+    5
+  end
+
+  def before
+    self.test_helper.before
+  end
+
+  def after
+    self.test_helper.after
+  end
+
+  def call method, format_case
+    self.before
+    response = method.call format_case.payload, format_case.headers
+    self.after
+    response
+  end
+end

data/lib/tester/modules/typo.rb

@@ -0,0 +1,67 @@
+require 'tester/reporter/status_code_report'
+require 'tester/modules/module'
+require 'tester/util/supported_verbs'
+
+class Typo < Module
+    def go(definition, report)
+        super
+
+        contract = allowances(definition)
+
+        contract.each do |url, verbs|
+            check_verbs definition, url, verbs
+
+            check_typo_url definition, url
+        end
+
+        report.reports == []
+    end
+
+    def check_verbs definition, url, verbs
+        missing_verbs = SupportedVerbs.all - verbs
+        missing_verbs.each do |verb|
+            check_method = create_api_method url, verb
+            typo_case = BoundaryCase.new("Typo verb check #{verb}", {}, {})
+            response = self.call check_method, typo_case
+
+            test = TypoClass.new response, typo_case.payload, definition.not_allowed_response, url, verb
+            reports = test.check
+            self.report.reports.concat reports
+        end
+    end
+
+    def check_typo_url definition, url
+        bad_url = "#{url}gibberishadsfasdf"
+        typo_case = BoundaryCase.new("Typo URL check", {}, {})
+        check_method = create_api_method bad_url, SupportedVerbs::GET
+        response = self.call check_method, typo_case
+
+        test = TypoClass.new response, typo_case.payload, definition.not_found_response, bad_url, SupportedVerbs::GET
+            reports = test.check
+        self.report.reports.concat reports
+    end
+
+    def create_api_method url, verb
+      method = SupportedVerbs.get_method_for(verb)
+      method.new url
+    end
+
+    def allowances(definition)
+        allowances = {}
+        definition.methods.each do |method|
+            url = method.url
+            if allowances[url]
+                allowances[url] << method.verb
+            else
+                allowances[url] = [method.verb]
+            end
+        end
+        allowances
+    end
+end
+
+class TypoClass < MethodCaseTest
+    def initialize response, payload, expected_response, url, verb
+        super response, payload, expected_response, url, verb, "TypoModule"
+    end
+end

data/lib/tester/modules/unused_fields.rb

@@ -0,0 +1,22 @@
+require 'tester/reporter/missing_response_field_report'
+require 'tester/modules/module'
+
+class UnusedFields < Module
+  def go definition, report
+    super
+
+    definition.methods.each do |method|
+      method.expected_response.body.each do |field|
+        if field.is_seen == 0
+          report.add_new_report MissingResponseFieldReport.new(method.url, method.verb, field.name, "UnusedFieldsModule")
+        end
+      end
+    end
+
+    report.reports == []
+  end
+
+  def order
+    99
+  end
+end

data/lib/tester/reporter/api_report.rb

@@ -0,0 +1,33 @@
+require 'tester/reporter/report'
+
+class ApiReport
+  attr_accessor :reports
+
+  def initialize
+    self.reports = []
+  end
+
+  def add_new url, request, expected_response, actual_response, description="A case"
+    report = Report.new description, url, request, expected_response, actual_response
+    self.reports << report
+  end
+
+  def add_new_report report
+    self.reports << report
+  end
+
+  def print
+    if self.reports.size > 0
+      puts "Issues discovered: #{self.reports.size}"
+      self.reports.each do |report|
+        report.print
+        puts "\n"
+        puts "\n"
+      end
+      puts ""
+      puts "Issues discovered: #{self.reports.size}"
+    else
+      puts "No issues found"
+    end
+  end
+end

data/lib/tester/reporter/missing_field_report.rb

@@ -0,0 +1,23 @@
+class MissingFieldReport
+  attr_accessor :description
+  attr_accessor :url
+  attr_accessor :request
+  attr_accessor :expected_field
+  attr_accessor :actual_response
+
+  def initialize(description, url, request, expected_field)
+    self.description = description
+    self.url = url
+    self.request = request
+    self.expected_field = expected_field
+    self.actual_response = ''
+  end
+
+  def print
+    puts "#{self.description}: "
+    puts "   Requested #{self.url} with payload:"
+    puts "      #{self.request}"
+    puts '   Missing field: '
+    puts "      #{self.expected_field}"
+  end
+end

data/lib/tester/reporter/missing_response_field_report.rb

@@ -0,0 +1,19 @@
+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

data/lib/tester/reporter/report.rb

@@ -0,0 +1,25 @@
+class Report
+  attr_accessor :description
+  attr_accessor :url
+  attr_accessor :request
+  attr_accessor :expected_response
+  attr_accessor :actual_response
+
+  def initialize description, url, request, expected_response, actual_response
+    self.description = description
+    self.url = url
+    self.request = request
+    self.expected_response = expected_response
+    self.actual_response = actual_response
+  end
+
+  def print
+    puts "#{self.description}: "
+    puts "   Requested #{self.url} with payload:"
+    puts "      #{self.request.to_json}"
+    puts "   Expecting: "
+    puts "      #{self.expected_response}"
+    puts "   Receiving: "
+    puts "      #{self.actual_response}"
+  end
+end

data/lib/tester/reporter/status_code_report.rb

@@ -0,0 +1,12 @@
+require 'tester/reporter/report'
+
+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, url, request, expected_status_code, actual_status_code
+    self.expected_status_code = expected_status_code
+    self.actual_status_code = actual_status_code
+  end
+end

data/lib/tester/test_helper.rb

@@ -0,0 +1,7 @@
+class TestHelper
+    def before
+    end
+
+    def after
+    end
+end

data/lib/tester/util/response_evaluator.rb

@@ -0,0 +1,73 @@
+class ResponseEvaluator
+    attr_accessor :response_body
+    attr_accessor :expected_response
+
+    def initialize(actual_response_body, expected_response_fields)
+        self.response_body = actual_response_body
+        self.expected_response = expected_response_fields
+    end
+
+    def response_field_array
+        field_array self.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 self.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(field.fields, 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(field.fields, inner_name)
+        end
+        fields
+    end
+
+    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 
+        end
+        fields
+       rescue NoMethodError => e
+        fields
+    end
+end

data/lib/tester/util/supported_verbs.rb

@@ -0,0 +1,25 @@
+class SupportedVerbs
+  def SupportedVerbs.add_item(key, value)
+    @hash ||= {}
+    @hash[key] = value
+  end
+
+  def SupportedVerbs.const_missing(key)
+    @hash[key]
+  end
+
+  def SupportedVerbs.each
+    @hash.each {|key,value| yield(key,value)}
+  end
+
+  def SupportedVerbs.all
+    @hash.values
+  end
+
+  def SupportedVerbs.get_method_for(verb)
+    {:get => ApiGet, :post => ApiPost}[verb]
+  end
+
+  SupportedVerbs.add_item :GET, :get
+  SupportedVerbs.add_item :POST, :post
+end

data/lib/tester/version.rb

@@ -0,0 +1,3 @@
+module Tester
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: api-tester
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- arane
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Tool to test APIs which will eventually do boundary testing and other
+  sorts of testing automatically given a contract
+email:
+- arane9@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- api-tester.gemspec
+- bin/console
+- bin/setup
+- lib/tester.rb
+- lib/tester/api_tester.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/methods/api_get.rb
+- lib/tester/definition/methods/api_method.rb
+- lib/tester/definition/methods/api_post.rb
+- lib/tester/definition/request.rb
+- lib/tester/definition/response.rb
+- lib/tester/method_case_test.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
+homepage: https://github.com/araneforseti/api-tester
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Tool to help test APIs
+test_files: []