api-tester 0.1.0 → 0.2.0

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

@@ -0,0 +1,44 @@
+require 'api-tester/definition/fields/field'
+
+module ApiTester
+  class ObjectField < Field
+      attr_accessor :fields
+
+      def initialize name
+          super(name)
+          self.fields = []
+      end
+
+      def with_field(newField)
+          self.fields << newField
+          self
+      end
+
+      def has_subfields?
+          true
+      end
+
+      def default_value
+          obj = Hash.new
+
+          self.fields.each do |field|
+              obj[field.name] = field.default_value
+          end
+
+          obj
+      end
+
+      def negative_boundary_values
+          super +
+            [
+              "string",
+              [],
+              123,
+              1,
+              0,
+              true,
+              false
+            ]
+      end
+  end
+end

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

@@ -0,0 +1,51 @@
+require 'api-tester/definition/boundary_case'
+
+module ApiTester
+  class Request
+    attr_accessor :definition
+    attr_accessor :headers
+    attr_accessor :fields
+
+    def initialize
+      self.fields = []
+    end
+
+    def add_field(new_field)
+      self.fields << new_field
+      self
+    end
+
+    def payload
+      response = Hash.new
+      self.fields.each do |field|
+        response[field.name] = field.default_value
+      end
+      response
+    end
+
+    def default_payload
+      payload
+    end
+
+    def default_headers
+      {content_type: :json, accept: :json}
+    end
+
+    def cases
+      boundary_cases = Array.new
+      self.fields.each do |field|
+        field.negative_boundary_values.each do |value|
+          bcase = BoundaryCase.new("Setting #{field.name} to #{value}", altered_payload(field.name, value), default_headers)
+          boundary_cases.push(bcase)
+        end
+      end
+      boundary_cases
+    end
+
+    def altered_payload field_name, value
+      body = payload
+      body[field_name] = value
+      body
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+module ApiTester
+  class Response
+      attr_accessor :code
+      attr_accessor :body
+
+      def initialize(status_code=200)
+          self.code = status_code
+          self.body = []
+      end
+
+      def add_field(new_field)
+          self.body << new_field
+          self
+      end
+
+      def to_s
+          des = {}
+          self.body.map do |f|
+              des[f.name] = field_display f
+          end
+          des.to_json
+      end
+
+      def field_display field
+          des = field.display_class
+          if field.has_subfields?
+            des = {}
+            field.fields.map do |f|
+              des[f.name] = field_display f
+            end
+            des.to_json
+          end
+          des
+      end
+  end
+end

data/lib/api-tester/method_case_test.rb

@@ -0,0 +1,69 @@
+require 'api-tester/util/response_evaluator.rb'
+
+module ApiTester
+  class MethodCaseTest
+      attr_accessor :expected_response
+      attr_accessor :payload
+      attr_accessor :response
+      attr_accessor :reports
+      attr_accessor :url
+      attr_accessor :module_name
+
+      def initialize response, payload, expected_response, url, verb, module_name
+          self.payload = payload
+          self.response = response
+          self.expected_response = expected_response
+          self.reports = []
+          self.url = "#{verb} #{url}"
+          self.module_name = module_name
+      end
+
+      def response_code_report
+          report = StatusCodeReport.new "#{module_name} - Incorrect response code", self.url, self.payload, self.expected_response.code, self.response.code
+          self.reports << report
+          nil
+      end
+
+      def missing_field_report field
+          report = Report.new "#{module_name} - Missing field #{field}", self.url, self.payload, self.expected_response, self.response
+          self.reports << report
+          nil
+      end
+
+      def extra_field_report field
+          report = Report.new "#{module_name} - Found extra field #{field}", self.url, self.payload, self.expected_response, self.response
+          self.reports << report
+          nil
+      end
+
+      def check
+          if check_response_code
+              evaluator = ApiTester::ResponseEvaluator.new json_parse(self.response.body), self.expected_response
+              evaluator.missing_fields.map{|field| missing_field_report(field)}
+              evaluator.extra_fields.map{|field| extra_field_report(field)}
+              increment_fields evaluator.seen_fields
+          end
+          return self.reports
+      end
+
+      def check_response_code
+          if response.code != expected_response.code
+              response_code_report
+              return false
+          end
+          return true
+      end
+
+      def increment_fields seen_fields
+          seen_fields.each do |field|
+              field.seen
+          end
+      end
+
+      def json_parse body
+          JSON.parse!(body)
+        rescue JSON::ParserError
+          body
+      end
+  end
+end

data/lib/api-tester/modules/extra_verbs.rb

@@ -0,0 +1,27 @@
+require 'api-tester/modules/module'
+require 'api-tester/util/supported_verbs'
+
+module ApiTester
+  class ExtraVerbs < Module
+    def go(endpoint, report)
+      super
+
+      extras = ApiTester::SupportedVerbs.all - endpoint.verbs
+      extras.each do |verb|
+        verb_case = BoundaryCase.new("Verb check with #{verb} for #{endpoint.name}", {}, {})
+        method = ApiTester::ApiMethod.new verb, ApiTester::Response.new, ApiTester::Request.new
+        response = endpoint.call method, verb_case.payload, verb_case.headers
+        test = VerbClass.new response, verb_case.payload, endpoint.not_allowed_response, endpoint.url, verb
+        reports = test.check
+        self.report.reports.concat reports
+      end
+      self.report.reports == []
+    end
+  end
+
+  class VerbClass < MethodCaseTest
+      def initialize response, payload, expected_response, url, verb
+          super response, payload, expected_response, url, verb, "VerbModule"
+      end
+  end
+end

data/lib/api-tester/modules/format.rb

@@ -0,0 +1,28 @@
+require 'api-tester/reporter/status_code_report'
+require 'api-tester/modules/module'
+require 'api-tester/method_case_test'
+
+module ApiTester
+  class Format < Module
+    def go definition, report
+      super
+
+      definition.methods.each do |method|
+        cases = method.request.cases
+        cases.each do |format_case|
+          response = definition.call method, format_case.payload, format_case.headers
+          test = FormatTest.new response, format_case.payload, definition.bad_request_response, definition.url, method.verb
+          self.report.reports.concat test.check
+        end
+      end
+
+      report.reports == []
+    end
+  end
+
+  class FormatTest < MethodCaseTest
+      def initialize response, payload, expected_response, url, verb
+          super response, payload, expected_response, url, verb, "FormatModule"
+      end
+  end
+end

data/lib/api-tester/modules/good_case.rb

@@ -0,0 +1,31 @@
+require 'api-tester/reporter/status_code_report'
+require 'api-tester/modules/module'
+require 'api-tester/method_case_test'
+
+module ApiTester
+  class GoodCase < Module
+      def go endpoint, report
+          super
+
+          endpoint.methods.each do |method|
+              default_case = BoundaryCase.new endpoint.url, method.request.default_payload, method.request.default_headers
+              response = endpoint.call method, default_case.payload, default_case.headers
+              test = GoodCaseTest.new response, endpoint.url, method
+              self.report.reports.concat test.check
+          end
+
+          self.report.reports == []
+      end
+
+      def order
+          1
+      end
+  end
+
+
+  class GoodCaseTest < MethodCaseTest
+      def initialize response, url, method
+          super response, method.request.default_payload, method.expected_response, url, method.verb, "GoodCaseModule"
+      end
+  end
+end

data/lib/api-tester/modules/module.rb

@@ -0,0 +1,20 @@
+require 'api-tester/reporter/status_code_report'
+require 'api-tester/test_helper'
+
+module ApiTester
+  class Module
+    attr_accessor :report
+
+    def set_report report
+      self.report = report
+    end
+
+    def go definition, report
+      set_report report
+    end
+
+    def order
+      5
+    end
+  end
+end

data/lib/api-tester/modules/typo.rb

@@ -0,0 +1,43 @@
+require 'api-tester/reporter/status_code_report'
+require 'api-tester/modules/module'
+require 'api-tester/util/supported_verbs'
+
+module ApiTester
+  class Typo < Module
+      def go(endpoint, report)
+          super
+
+          allowances(endpoint).each do |verbs|
+              check_typo_url endpoint
+          end
+
+          report.reports == []
+      end
+
+      def check_typo_url endpoint
+          bad_url = "#{endpoint.url}gibberishadsfasdf"
+          bad_endpoint = ApiTester::Endpoint.new "Bad URL", bad_url
+          typo_case = BoundaryCase.new("Typo URL check", {}, {})
+          method = ApiTester::ApiMethod.new ApiTester::SupportedVerbs::GET, ApiTester::Response.new(200), ApiTester::Request.new
+          response = bad_endpoint.call method, typo_case.payload, typo_case.headers
+
+          test = TypoClass.new response, typo_case.payload, endpoint.not_found_response, bad_url, ApiTester::SupportedVerbs::GET
+              reports = test.check
+          self.report.reports.concat reports
+      end
+
+      def allowances(endpoint)
+          allowances = []
+          endpoint.methods.each do |method|
+              allowances << method.verb
+          end
+          allowances.uniq
+      end
+  end
+
+  class TypoClass < MethodCaseTest
+      def initialize response, payload, expected_response, url, verb
+          super response, payload, expected_response, url, verb, "TypoModule"
+      end
+  end
+end

data/lib/api-tester/modules/unused_fields.rb

@@ -0,0 +1,24 @@
+require 'api-tester/reporter/missing_response_field_report'
+require 'api-tester/modules/module'
+
+module ApiTester
+  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(definition.url, method.verb, field.name, "UnusedFieldsModule")
+          end
+        end
+      end
+
+      report.reports == []
+    end
+
+    def order
+      99
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+require 'api-tester/reporter/report'
+
+module ApiTester
+  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
+end

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

@@ -0,0 +1,25 @@
+module ApiReport
+  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
+end