api-tester 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d7fd0c363094e175b8c3a28f0b208c6a5202f496
-  data.tar.gz: fd8349e6d3f62ab34f34f95f6dd82c1c77dcd62a
+  metadata.gz: 52c7685df4c907ec1841e6b73414281b003670bb
+  data.tar.gz: 4d277569d088a704d840ad7e6c187bee4eeb0629
 SHA512:
-  metadata.gz: 0f99743ce48fb7157e50d6cb2fac17ab7256a6dffb8c3abaf370ae85c6866385087684932899d973388a23758da73079f55eb87946fa39267783db19f533d77d
-  data.tar.gz: c74c4a8c90395deeed9f2a3520a67e3a279f5e011a54fbcdad13be5aa1c799e81f70d519a9fe63e3e9bc4e0306ddc990ff8e9d5cb333a850bda303bc2fab5ffc
+  metadata.gz: 9ea181c7075b97cad1fbfbdfa235a0ab2fcda488a7bdc99efbe981b4bee6cbf69ec98c3024d6cb5cf321004b4bb2e2b4558ca611f9f5fc5628306cdad5dbf541
+  data.tar.gz: d9ad6635b7521e596478c47bea98ceb5c778a18b12a3bb33f5bb50941ec60cf70aaf7f8c90b2ba8e25581ddcf4f85cec93b5da9c0d963cebff67522b85577cc1

data/README.md

@@ -75,7 +75,7 @@ Define your contract and endpoints using
 ```ruby
 require 'api-tester/definition/api_contract'
 require 'api-tester/definition/endpoint'
-contract = ApiContract.new "API Name"
+contract = ApiTester::ApiContract.new "API Name"
 endpoint = ApiTester::Endpoint.new "Some name which is currently unused", "http://yourbase.com/api/endpoint"
 ```
 
@@ -97,16 +97,21 @@ field.has_subfields?
 values_array = field.negative_boundary_values
 ```
 
+Define which modules you want to use through a config
+```ruby
+config = ApiTester::Config().with_module(Format.new)
+```
+
 Put them together and call go and off you go!
 ```ruby
-request = Request.new.add_field(ApiTester::Field.new "fieldName")
+request = ApiTester::Request.new.add_field(ApiTester::Field.new "fieldName")
 expected_response = ApiTester::Response.new(200).add_field(ApiTester::Field.new "fieldName")
 endpoint = ApiTester::Endpoint.new "Unused Name", "http://yourbase.com/api/endpoint"
 endpoint.add_method ApiTester::SupportedVerbs::GET, expected_response, request
 contract = ApiContract.new "API Name"
 contract.add_endpoint endpoint
-tester = ApiTester.new(contract).with_module(Format.new)
-expect(tester.go).to be true
+config = ApiTester::Config().with_module(Format.new)
+expect(ApiTester.go(contract, config)).to be true
 
 ```
 
@@ -159,6 +164,23 @@ detailing unreturned response fields. When using this
 module, it is recommended the good case module is also
 used.
 
+## Custom Modules
+Do you want to do something with the definition which this gem currently does not support?
+You can create your own test module and add it to the config instance class!
+Just make sure it adheres to the following interface:
+```ruby
+module Name
+  def self.go contract, reports
+    # Your test code here - the reports object is where the reports are all stored
+  end
+
+  def self.order
+    # If your module needs to run first, put 0, if last, put 100.
+    # Otherwise this can just be any number
+  end
+end  
+```
+
 # Reporting
 Right now the default reporting mechanism prints out to
 the console all the issues which were found. You can

data/changelog.txt

@@ -1,3 +1,7 @@
+0.3.0
+
+- Making modules actually be modules
+
 0.2.0
 
 - Finally fixing the naming scheme

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

@@ -1,21 +1,23 @@
-require 'api-tester/modules/module'
-require 'api-tester/util/supported_verbs'
+ require 'api-tester/util/supported_verbs'
 
 module ApiTester
-  class ExtraVerbs < Module
-    def go(endpoint, report)
-      super
-
+  module ExtraVerbs
+    def self.go(endpoint, report)
+      reports = []
       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
+        reports.concat test.check
       end
-      self.report.reports == []
+      report.reports.concat reports
+      reports == []
+    end
+
+    def self.order
+      3
     end
   end
 

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

@@ -1,22 +1,25 @@
 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
-
+  class Format
+    def self.go definition, report
+      reports = []
       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
+          reports.concat test.check
         end
       end
 
-      report.reports == []
+      report.reports.concat reports
+      reports == []
+    end
+
+    def self.order
+      2
     end
   end
 

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

@@ -1,23 +1,22 @@
 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
-
+  class GoodCase
+      def self.go endpoint, report
+          reports = []
           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
+              reports.concat test.check
           end
 
-          self.report.reports == []
+          report.reports.concat reports
+          reports == []
       end
 
-      def order
+      def self.order
           1
       end
   end

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

@@ -1,20 +1,19 @@
 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
-
+  class Typo
+      def self.go(endpoint, report)
+          reports = []
           allowances(endpoint).each do |verbs|
-              check_typo_url endpoint
+              reports.concat check_typo_url(endpoint)
           end
 
-          report.reports == []
+          report.reports.concat reports
+          reports == []
       end
 
-      def check_typo_url endpoint
+      def self.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", {}, {})
@@ -22,17 +21,20 @@ module ApiTester
           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
+          test.check
       end
 
-      def allowances(endpoint)
+      def self.allowances(endpoint)
           allowances = []
           endpoint.methods.each do |method|
               allowances << method.verb
           end
           allowances.uniq
       end
+
+      def self.order
+        4
+      end
   end
 
   class TypoClass < MethodCaseTest

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

@@ -1,23 +1,23 @@
 require 'api-tester/reporter/missing_response_field_report'
-require 'api-tester/modules/module'
 
 module ApiTester
-  class UnusedFields < Module
-    def go definition, report
-      super
+  class UnusedFields
+    def self.go definition, report
+      reports = []
 
       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")
+            reports << MissingResponseFieldReport.new(definition.url, method.verb, field.name, "UnusedFieldsModule")
           end
         end
       end
 
-      report.reports == []
+      report.reports.concat reports
+      reports == []
     end
 
-    def order
+    def self.order
       99
     end
   end

data/lib/api-tester/version.rb

@@ -1,3 +1,3 @@
 module ApiTester
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api-tester
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - arane
@@ -118,7 +118,6 @@ files:
 - lib/api-tester/modules/extra_verbs.rb
 - lib/api-tester/modules/format.rb
 - lib/api-tester/modules/good_case.rb
-- lib/api-tester/modules/module.rb
 - lib/api-tester/modules/typo.rb
 - lib/api-tester/modules/unused_fields.rb
 - lib/api-tester/reporter/api_report.rb

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

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