api-tester 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83ee0d9e20fbd649a77f024ef5c59374598defdb
-  data.tar.gz: e940bd076054a3a8fef1d64cdeac36692622dec8
+  metadata.gz: 4c2d7d376e7fabf9e5d3b6d3dcfc46fed51769c4
+  data.tar.gz: bec8bec10284f71f2ac319a341cce60f305ed04f
 SHA512:
-  metadata.gz: 1917a357518a7d848197699e4ef169b409668954f3054c1259835a5424270d815cceae899c841d994eccf8fdb28dfe48d2e7c6955fad2649d4a1c994e933a81b
-  data.tar.gz: f791aa624ebbcd765073765a3949714ad851ffac7a8fd3f50df5bd66ad5c0f82588fca83e86bdd0c446d3f5bd793c5c7b8dd5f08a38ef53aaa1382f975238864
+  metadata.gz: 51849f3cbee0fe669116ec6bd9b1d9ff2c19a4e345d9f9ea2c1fc47e059bf00283a95dcbf5c754bd81ae9697c4db01f17067532d238a58bc85702d0e8e0f176e
+  data.tar.gz: 1fdc1be1f412a64596c58b2c652a69b63b822d18c8b51f889097317375418a14ec7ee0fcd3de40a23454e85f604ce593203e320f2c4af97b0390ceda8b39154e

data/.gitignore

@@ -9,3 +9,4 @@
 /tmp/
 .idea
 *.swp
+*.gem

data/README.md

@@ -2,7 +2,7 @@
 [![Build Status](https://travis-ci.org/araneforseti/api-tester.svg?branch=master)](https://travis-ci.org/araneforseti/api-tester)
 
 Work in Progress! Use at own risk, definitely not ready 
-for prime time!
+for prime time! To isolate your project from the changes, be sure to specify which gem version you use.
 
 This gem is intended to enable easy creation of tests for 
 RESTful API services when given a contract.
@@ -48,10 +48,10 @@ required)
 # Usage
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your application's Gemfile (Note: specify your version due to gem's currently volatile nature):
 
 ```ruby
-gem 'api-tester'
+gem 'api-tester', '0.0.2'
 ```
 
 And then execute:
@@ -70,13 +70,13 @@ stable release
 
 Define your endpoints using
 ```ruby
-endpoint = Endpoint.new "Some name which is currently unused"
+endpoint = Endpoint.new "Some name which is currently unused", "http://yourbase.com/api/endpoint"
 ```
 
 Define methods on endpoints
 
 ```ruby
-get_method = ApiGet.new "http://yourbase.com/api/method"
+get_method = ApiGet.new 
 ```
 Note: Currently only GET and POST have been created, but 
 you can make your own so long as it has `call` and `verb` methods 
@@ -97,10 +97,10 @@ Put them together and call go and off you go!
 ```ruby
 request = Request.new.add_field(Field.new "fieldName")
 expected_response = Response.new(200).add_field(Field.new "fieldName")
-get_method = ApiGet.new "http://yourbase.com/api/method"
+get_method = ApiGet.new 
 get_method.request = request
 get_method.expected_response = expected_response
-endpoint = Endpoint.new "Unused Name Sorry"
+endpoint = Endpoint.new "Unused Name", "http://yourbase.com/api/endpoint"
 endpoint.add_method get_method
 tester = ApiTester.new(endpoint).with_module(Format.new)
 expect(tester.go).to be true

data/changelog.txt

@@ -0,0 +1,3 @@
+0.0.2
+
+- Moving url from methods to endpoints

data/lib/tester/definition/endpoint.rb

@@ -1,13 +1,15 @@
 require 'tester/definition/response'
 
 class Endpoint
+  attr_accessor :url
   attr_accessor :methods
   attr_accessor :name
   attr_accessor :bad_request_response
   attr_accessor :not_allowed_response
   attr_accessor :not_found_response
 
-  def initialize name
+  def initialize name, url
+    self.url = url
     self.name = name
     self.methods = []
     self.bad_request_response = Response.new 400
@@ -19,4 +21,4 @@ class Endpoint
     self.methods << new_method
     self
   end
-end
+end

data/lib/tester/definition/methods/api_get.rb

@@ -7,10 +7,10 @@ require 'json'
 require 'tester/definition/methods/api_method'
 
 class ApiGet < ApiMethod
-  def call params={}, headers={}
+  def call url, params={}, headers={}
     headers[:params] = params
 
-    RestClient.get(self.url, headers)  { |real_response, request, result|
+    RestClient.get(url, headers)  { |real_response, request, result|
       real_response
     }
   end
@@ -18,4 +18,4 @@ class ApiGet < ApiMethod
   def verb
     SupportedVerbs::GET
   end
-end
+end

data/lib/tester/definition/methods/api_method.rb

@@ -8,10 +8,8 @@ require 'json'
 class ApiMethod
   attr_accessor :request
   attr_accessor :expected_response
-  attr_accessor :url
 
-  def initialize url
-    self.url = url
+  def initialize
     self.request = Request.new
     self.expected_response = Response.new 200
   end

data/lib/tester/definition/methods/api_post.rb

@@ -10,14 +10,14 @@ require 'tester/reporter/status_code_report'
 class ApiPost < ApiMethod
   attr_accessor :syntax_error_response
 
-  def post json_payload, headers
-    RestClient.post(self.url, json_payload, headers)  { |real_response, request, result|
+  def post url, json_payload, headers
+    RestClient.post(url, json_payload, headers)  { |real_response, request, result|
       real_response
     }
   end
 
-  def call body_params={}, request_params={}
-    post body_params.to_json, request_params
+  def call url, body_params={}, request_params={}
+    post url, body_params.to_json, request_params
   end
 
   def verb

data/lib/tester/modules/format.rb

@@ -9,8 +9,8 @@ class Format < Module
     definition.methods.each do |method|
       cases = method.request.cases
       cases.each do |format_case|
-        response = self.call method, format_case
-        test = FormatTest.new response, format_case.payload, definition.bad_request_response, method.url, method.verb
+        response = self.call method, definition.url, format_case
+        test = FormatTest.new response, format_case.payload, definition.bad_request_response, definition.url, method.verb
         self.report.reports.concat test.check
       end
     end

data/lib/tester/modules/good_case.rb

@@ -7,9 +7,9 @@ class GoodCase < Module
         super
 
         definition.methods.each do |method|
-            default_case = BoundaryCase.new method.url, method.request.default_payload, method.request.default_headers
-            response = self.call method, default_case
-            test = GoodCaseTest.new response, method
+            default_case = BoundaryCase.new definition.url, method.request.default_payload, method.request.default_headers
+            response = self.call method, definition.url, default_case
+            test = GoodCaseTest.new response, definition.url, method
             self.report.reports.concat test.check
         end
 
@@ -23,7 +23,7 @@ end
 
 
 class GoodCaseTest < MethodCaseTest
-    def initialize response, method
-        super response, method.request.default_payload, method.expected_response, method.url, method.verb, "GoodCaseModule"
+    def initialize response, url, method
+        super response, method.request.default_payload, method.expected_response, url, method.verb, "GoodCaseModule"
     end
 end

data/lib/tester/modules/module.rb

@@ -29,9 +29,9 @@ class Module
     self.test_helper.after
   end
 
-  def call method, format_case
+  def call method, url, format_case
     self.before
-    response = method.call format_case.payload, format_case.headers
+    response = method.call url, format_case.payload, format_case.headers
     self.after
     response
   end

data/lib/tester/modules/typo.rb

@@ -20,9 +20,9 @@ class Typo < Module
     def check_verbs definition, url, verbs
         missing_verbs = SupportedVerbs.all - verbs
         missing_verbs.each do |verb|
-            check_method = create_api_method url, verb
+            check_method = create_api_method verb
             typo_case = BoundaryCase.new("Typo verb check #{verb}", {}, {})
-            response = self.call check_method, typo_case
+            response = self.call check_method, definition.url, typo_case
 
             test = TypoClass.new response, typo_case.payload, definition.not_allowed_response, url, verb
             reports = test.check
@@ -33,23 +33,23 @@ class Typo < Module
     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
+        check_method = create_api_method SupportedVerbs::GET
+        response = self.call check_method, bad_url, 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
+    def create_api_method verb
       method = SupportedVerbs.get_method_for(verb)
-      method.new url
+      method.new
     end
 
     def allowances(definition)
         allowances = {}
         definition.methods.each do |method|
-            url = method.url
+            url = definition.url
             if allowances[url]
                 allowances[url] << method.verb
             else

data/lib/tester/modules/unused_fields.rb

@@ -8,7 +8,7 @@ class UnusedFields < Module
     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")
+          report.add_new_report MissingResponseFieldReport.new(definition.url, method.verb, field.name, "UnusedFieldsModule")
         end
       end
     end

data/lib/tester/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api-tester
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - arane
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-07 00:00:00.000000000 Z
+date: 2018-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -98,6 +98,7 @@ files:
 - api-tester.gemspec
 - bin/console
 - bin/setup
+- changelog.txt
 - lib/tester.rb
 - lib/tester/api_tester.rb
 - lib/tester/definition/boundary_case.rb