api-tester 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 173ab496b5c0a3a43c1e445cabc382335b475730
-  data.tar.gz: 52325c92e2e3296593dd4f281098b3b84b417f92
+  metadata.gz: 2b11d2e3d6f78a6a867a7a205bcd271d1d62b7e8
+  data.tar.gz: fa0a9eec8bda1701b28bdcb7bd00d8632c74b650
 SHA512:
-  metadata.gz: c7accb0f928261574018b33e9d1fca93dd41a919bb8ce888a4c3e26add1cb2f8e3fab0532c125e5e9a43c8cacabef1b696ecdf06cb456013b660e31ca712531e
-  data.tar.gz: aac95b14b2c0170d5c4841a846e8ba7b54fc36f3ab763ca1d64f8a949af69daeb59bff2e58c41c371ab3f3a0687871348c345c4a9dfb63b044cbdf3afee54d26
+  metadata.gz: 138abc36857193eeeb73fe634b6e72bee33be1d9734a522d55ff5ecea80667a8d230e9d9b083990eb8c4eb72ad83f9f1bf2f867859164e8b5722b3e4fd18eb02
+  data.tar.gz: 9dd329012286578853c53ad87197e36a9c61ab9be04b244d3855e58357888586deca8e7f746d518e2263c1481467767c629f6866dcfe07190eac7fd62748247f

data/README.md

@@ -1,4 +1,5 @@
 # Api::Tester
+[![Gem Version](https://badge.fury.io/rb/api-tester.svg)](https://badge.fury.io/rb/api-tester)
 [![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 

data/api-tester.gemspec

@@ -33,7 +33,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.13"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "webmock", "~> 3.4"
 
-  spec.add_runtime_dependency "rest-client"
+  spec.add_runtime_dependency "rest-client", "~> 2.0"
 end

data/changelog.txt

@@ -1,3 +1,16 @@
+0.0.5
+
+- Adding support for delete, put, head, options, copy, mkcol, move, propfind, proppatch, trace, lock, unlock, and patch verbs
+- Fixing test output to be more readable
+
+0.0.4
+
+- Moving test_helper from tester level to endpoint level in preparation for moving to full definition
+
+0.0.3
+
+- Fixing Problem with 0.0.2
+
 0.0.2
 
 - Moving url from methods to endpoints

data/lib/tester/api_tester.rb

@@ -3,6 +3,7 @@ require 'tester/modules/good_case'
 require 'tester/modules/unused_fields'
 require 'tester/modules/typo'
 require 'rest-client'
+require 'tester/reporter/api_report'
 require 'json'
 
 class ApiTester

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

@@ -0,0 +1,13 @@
+require 'tester/util/supported_verbs'
+require 'rest-client'
+require 'tester/definition/methods/api_method'
+
+class ApiCopy < ApiMethod
+  def call url, params={}, headers={}
+    RestClient::Request.execute(method: :copy, url: url, headers: headers)
+  end
+
+  def verb
+    SupportedVerbs::COPY
+  end
+end

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

@@ -0,0 +1,13 @@
+require 'tester/util/supported_verbs'
+require 'rest-client'
+require 'tester/definition/methods/api_method'
+
+class ApiDelete < ApiMethod
+  def call url, params={}, headers={}
+    RestClient::Request.execute(method: :delete, url: url, headers: headers)
+  end
+
+  def verb
+    SupportedVerbs::DELETE
+  end
+end

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

@@ -1,9 +1,4 @@
-require 'tester/definition/request'
-require 'tester/definition/response'
-require "tester/version"
-require 'tester/util/supported_verbs'
 require 'rest-client'
-require 'json'
 require 'tester/definition/methods/api_method'
 
 class ApiGet < ApiMethod

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

@@ -0,0 +1,16 @@
+require 'rest-client'
+require 'tester/definition/methods/api_method'
+
+class ApiHead < ApiMethod
+  def call url, params={}, headers={}
+    headers[:params] = params
+
+    RestClient.head(url, headers)  { |real_response, request, result|
+      real_response
+    }
+  end
+
+  def verb
+    SupportedVerbs::HEAD
+  end
+end

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

@@ -0,0 +1,13 @@
+require 'tester/util/supported_verbs'
+require 'rest-client'
+require 'tester/definition/methods/api_method'
+
+class ApiLock < ApiMethod
+  def call url, params={}, headers={}
+    RestClient::Request.execute(method: :lock, url: url, headers: headers)
+  end
+
+  def verb
+    SupportedVerbs::LOCK
+  end
+end

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

@@ -1,8 +1,5 @@
 require 'tester/definition/request'
 require 'tester/definition/response'
-require 'tester/reporter/status_code_report'
-require 'tester/reporter/missing_field_report'
-require 'tester/reporter/api_report'
 require 'json'
 
 class ApiMethod
@@ -14,6 +11,10 @@ class ApiMethod
     self.expected_response = Response.new 200
   end
 
+  def call
+    throw "Not implemented"
+  end
+
   def verb
     "None"
   end

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

@@ -0,0 +1,13 @@
+require 'tester/util/supported_verbs'
+require 'rest-client'
+require 'tester/definition/methods/api_method'
+
+class ApiMkcol < ApiMethod
+  def call url, params={}, headers={}
+    RestClient::Request.execute(method: :mkcol, url: url, headers: headers)
+  end
+
+  def verb
+    SupportedVerbs::MKCOL
+  end
+end

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

@@ -0,0 +1,13 @@
+require 'tester/util/supported_verbs'
+require 'rest-client'
+require 'tester/definition/methods/api_method'
+
+class ApiMove < ApiMethod
+  def call url, params={}, headers={}
+    RestClient::Request.execute(method: :move, url: url, headers: headers)
+  end
+
+  def verb
+    SupportedVerbs::MOVE
+  end
+end

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

@@ -0,0 +1,16 @@
+require 'rest-client'
+require 'tester/definition/methods/api_method'
+
+class ApiOptions < ApiMethod
+  def call url, params={}, headers={}
+    headers[:params] = params
+
+    RestClient.options(url, headers)  { |real_response, request, result|
+      real_response
+    }
+  end
+
+  def verb
+    SupportedVerbs::OPTIONS
+  end
+end

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

@@ -0,0 +1,18 @@
+require 'rest-client'
+require 'tester/definition/methods/api_method'
+
+class ApiPatch < ApiMethod
+  def patch url, json_payload, headers
+    RestClient.patch(url, json_payload, headers)  { |real_response, request, result|
+      real_response
+    }
+  end
+
+  def call url, body_params={}, request_params={}
+    patch url, body_params.to_json, request_params
+  end
+
+  def verb
+    SupportedVerbs::PATCH
+  end
+end

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

@@ -1,15 +1,7 @@
-require 'tester/definition/request'
-require 'tester/definition/response'
-require "tester/version"
 require 'rest-client'
-require 'json'
 require 'tester/definition/methods/api_method'
-require 'tester/reporter/api_report'
-require 'tester/reporter/status_code_report'
 
 class ApiPost < ApiMethod
-  attr_accessor :syntax_error_response
-
   def post url, json_payload, headers
     RestClient.post(url, json_payload, headers)  { |real_response, request, result|
       real_response

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

@@ -0,0 +1,13 @@
+require 'tester/util/supported_verbs'
+require 'rest-client'
+require 'tester/definition/methods/api_method'
+
+class ApiPropfind < ApiMethod
+  def call url, params={}, headers={}
+    RestClient::Request.execute(method: :propfind, url: url, headers: headers)
+  end
+
+  def verb
+    SupportedVerbs::PROPFIND
+  end
+end

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

@@ -0,0 +1,13 @@
+require 'tester/util/supported_verbs'
+require 'rest-client'
+require 'tester/definition/methods/api_method'
+
+class ApiProppatch < ApiMethod
+  def call url, params={}, headers={}
+    RestClient::Request.execute(method: :proppatch, url: url, headers: headers)
+  end
+
+  def verb
+    SupportedVerbs::PROPPATCH
+  end
+end

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

@@ -0,0 +1,18 @@
+require 'rest-client'
+require 'tester/definition/methods/api_method'
+
+class ApiPut < ApiMethod
+  def put url, json_payload, headers
+    RestClient.put(url, json_payload, headers)  { |real_response, request, result|
+      real_response
+    }
+  end
+
+  def call url, body_params={}, request_params={}
+    self.put url, body_params.to_json, request_params
+  end
+
+  def verb
+    SupportedVerbs::PUT
+  end
+end

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

@@ -0,0 +1,13 @@
+require 'tester/util/supported_verbs'
+require 'rest-client'
+require 'tester/definition/methods/api_method'
+
+class ApiTrace < ApiMethod
+  def call url, params={}, headers={}
+    RestClient::Request.execute(method: :trace, url: url, headers: headers)
+  end
+
+  def verb
+    SupportedVerbs::TRACE
+  end
+end

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

@@ -0,0 +1,13 @@
+require 'tester/util/supported_verbs'
+require 'rest-client'
+require 'tester/definition/methods/api_method'
+
+class ApiUnlock < ApiMethod
+  def call url, params={}, headers={}
+    RestClient::Request.execute(method: :unlock, url: url, headers: headers)
+  end
+
+  def verb
+    SupportedVerbs::UNLOCK
+  end
+end

data/lib/tester/definition/response.rb

@@ -13,17 +13,22 @@ class Response
     end
 
     def to_s
+        des = {}
         s = self.body.map do |f|
-            field_display f
+            des[f.name] = field_display f
         end
-        s.to_s
+        des.to_json
     end
 
     def field_display field
+        des = field.display_class
         if field.has_subfields?
-            "#{field.name}:#{field.fields.map{|f| field_display(f)}}"
-        else
-            "#{field.name}:#{field.display_class}"
+          des = {}
+          s = field.fields.map do |f|
+            des[f.name] = field_display f
+          end
+          des.to_json
         end
+        des
     end
 end

data/lib/tester/modules/module.rb

@@ -26,7 +26,11 @@ class Module
 
   def call method, definition, format_case
     self.before definition
-    response = method.call definition.url, format_case.payload, format_case.headers
+    begin
+      response = method.call definition.url, format_case.payload, format_case.headers
+    rescue RestClient::ExceptionWithResponse => e
+      response = e.response
+    end
     self.after definition
     response
   end

data/lib/tester/reporter/report.rb

@@ -18,7 +18,7 @@ class Report
     puts "   Requested #{self.url} with payload:"
     puts "      #{self.request.to_json}"
     puts "   Expecting: "
-    puts "      #{self.expected_response}"
+    puts "      " + self.expected_response.to_s
     puts "   Receiving: "
     puts "      #{self.actual_response}"
   end

data/lib/tester/util/supported_verbs.rb

@@ -1,3 +1,19 @@
+require 'tester/definition/methods/api_copy'
+require 'tester/definition/methods/api_delete'
+require 'tester/definition/methods/api_get'
+require 'tester/definition/methods/api_head'
+require 'tester/definition/methods/api_lock'
+require 'tester/definition/methods/api_mkcol'
+require 'tester/definition/methods/api_move'
+require 'tester/definition/methods/api_options'
+require 'tester/definition/methods/api_patch'
+require 'tester/definition/methods/api_post'
+require 'tester/definition/methods/api_propfind'
+require 'tester/definition/methods/api_proppatch'
+require 'tester/definition/methods/api_put'
+require 'tester/definition/methods/api_trace'
+require 'tester/definition/methods/api_unlock'
+
 class SupportedVerbs
   def SupportedVerbs.add_item(key, value)
     @hash ||= {}
@@ -17,9 +33,38 @@ class SupportedVerbs
   end
 
   def SupportedVerbs.get_method_for(verb)
-    {:get => ApiGet, :post => ApiPost}[verb]
+    {
+      :copy => ApiCopy,
+      :delete => ApiDelete,
+      :get => ApiGet,
+      :head => ApiHead,
+      :lock => ApiLock,
+      :mkcol => ApiMkcol,
+      :move => ApiMove,
+      :options => ApiOptions,
+      :patch => ApiPatch,
+      :post => ApiPost,
+      :propfind => ApiPropfind,
+      :proppatch => ApiProppatch,
+      :put => ApiPut,
+      :unlock => ApiUnlock,
+      :trace => ApiTrace
+    }[verb]
   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

data/lib/tester/version.rb

@@ -1,3 +1,3 @@
 module Tester
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api-tester
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - arane
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-09 00:00:00.000000000 Z
+date: 2018-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,30 +56,30 @@ dependencies:
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 description: Tool to test APIs which will eventually do boundary testing and other
   sorts of testing automatically given a contract
 email:
@@ -110,9 +110,22 @@ files:
 - 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_copy.rb
+- lib/tester/definition/methods/api_delete.rb
 - lib/tester/definition/methods/api_get.rb
+- lib/tester/definition/methods/api_head.rb
+- lib/tester/definition/methods/api_lock.rb
 - lib/tester/definition/methods/api_method.rb
+- lib/tester/definition/methods/api_mkcol.rb
+- lib/tester/definition/methods/api_move.rb
+- lib/tester/definition/methods/api_options.rb
+- lib/tester/definition/methods/api_patch.rb
 - lib/tester/definition/methods/api_post.rb
+- lib/tester/definition/methods/api_propfind.rb
+- lib/tester/definition/methods/api_proppatch.rb
+- lib/tester/definition/methods/api_put.rb
+- lib/tester/definition/methods/api_trace.rb
+- lib/tester/definition/methods/api_unlock.rb
 - lib/tester/definition/request.rb
 - lib/tester/definition/response.rb
 - lib/tester/method_case_test.rb