soaspec 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1c1e38e1213ce6461e1bca9a181d6be4130295a4
-  data.tar.gz: 9e2170b74242c21f8c9ac3fe51fccf5676a4db49
+  metadata.gz: 33b4fef9deff557c6531eb1d12aac9071bbcc95e
+  data.tar.gz: c317a3e008dd94f7094eae9be7d6e133a1376c0b
 SHA512:
-  metadata.gz: 9c41202a31e2e2740688628efada58bb0631cd91b5f1b60f624219d0f254c1cb5e823f00d2ea2451f16890b8059594fe8add22c9db4cb4d4db3acca8f06dcd90
-  data.tar.gz: 76bbf2ad8ba5a5e1333cb33653ba45220c9dcca5d8257b7e5c235dc849dfd85ea0b5783d3e1100ee7b606c3072a9cf95c5e4e362e91ba2b4f3c1a8586ccb0d05
+  metadata.gz: 12f211b2ff81229e85b6bb6d4b70899067cf59c8f8d37a74d3d24feeaf4a9285b368af4e909bc3d250a5206de4a056d9872844357f97a7fc5470c9bcb3dd1457
+  data.tar.gz: aa6269a25076f3f0132b879c88136e7d6becadf4871e3c66bbea9a5a5083f263b1d5e89e5f11bfcbba5cda0434e69465c8a5f907193090b90ad870b278bb2bb0

data/ChangeLog

@@ -1,3 +1,9 @@
+Version 0.1.4
+* Enhancements
+  * create_file method create folders automatically if necessary
+  * Package spec to help one learn testing for items in a list
+  * Added docs for soaspec-virtual-server
+
 Version 0.1.3
 * Enhancements
   * Ability to set template folder

data/exe/soaspec

@@ -34,18 +34,13 @@ module Soaspec
       create_file(filename: '.rspec')
       create_file(filename: '.travis.yml') if options[:ci] == 'travis'
       create_file(filename: 'README.md')
-      create_folder 'lib'
       if type == 'soap'
         create_file filename: 'lib/blz_service.rb'
         create_file filename: 'lib/shared_example.rb'
       end
-      create_folder 'config'
-      create_folder 'config/data'
       create_file(filename: 'config/data/default.yml')
-      create_folder 'spec'
       create_file(filename: 'spec/spec_helper.rb')
       create_file(filename: 'spec/soap_spec.rb') if type == 'soap'
-      create_folder 'template'
       create_file(filename: 'template/soap_template.xml', erb: false) if type == 'soap'
       create_folder 'logs'
 
@@ -80,13 +75,8 @@ module Soaspec
       create_file(filename: '.rspec')
       create_file(filename: '.travis.yml') if options[:ci] == 'travis'
       create_file filename: 'README.md', ignore_if_present: true
-      create_folder 'spec'
       create_file filename: 'spec/spec_helper.rb', ignore_if_present: true
-
       create_folder 'logs'
-      create_folder 'config'
-      create_folder 'config/data'
-      create_folder 'lib'
       create_file filename: "lib/#{options[:name].snakecase}.rb", content: class_content
 
       # Files according to WSDL

data/exe/soaspec-virtual-server

@@ -1,47 +1,91 @@
 #!/usr/bin/env ruby
 
-$LOAD_PATH.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 require 'soaspec'
 require 'sinatra'
 require 'sinatra/basic_auth'
+require 'docdsl'
 require 'nokogiri'
 require 'erb'
 require 'json'
 require 'faker'
 
+# Used to run virtual web service on localhost. This makes tests more reliable and faster
 class SoaspecVirtualServer < Sinatra::Application
+  set :port, 4999
 
-  # Used to run virtual web service on localhost. This makes tests more reliable and faster
+  register Sinatra::DocDsl
 
-  set :port, 4999
+  page do
+    title 'Soaspec Virtual Services'
+    header 'Perform efficient API testing with Ruby'
+    introduction 'This has some simple virtual services aimed at helping you with testing your Ruby API code.'
+  end
+
+  documentation 'Nothing under /. Go look at /docs' do
+    response 'redirects to the documentation page'
+    status 303
+  end
+  get '/' do
+    redirect '/docs'
+  end
 
-  # Used to test attributes
+  doc_endpoint '/docs'
+
+  documentation 'Used to test attributes' do
+    response 'A simple Note XML with a date attribute'
+  end
   get '/test_attribute' do
     Soaspec::TestServer::TestAttribute.note
   end
 
-  # Used to test attributes
+  documentation 'Used to test namespaces' do
+    response 'XML with 2 namespaces and same elements inside it'
+  end
   get '/namespace' do
-    # Soaspec::TestServer::TestAttribute.note
     Soaspec::TestServer::TestNamespace.food
   end
 
+  documentation 'Used for showing a simple difference in value depending on the id used' do
+    param :num, 'Number of tester'
+    param :id, 'Test parameter'
+    response 'JSON with success or true or false and the id sent
+      Idea is for tester to find the id that causes a failure (the fake "defect")
+    '
+  end
+  get '/packages/:num/:id' do |num, id|
+    result = case num
+             when '1', '4', '10' then 'false' if id == '40'
+             when '3', '11', '9' then 'false' if id == '74'
+             when '8', '6', '8' then 'false' if id == '80'
+             when '7', '5', '12' then 'false' if id == '64'
+             else
+               true
+             end
+    result ||= true
+    JSON.generate(success: result, id: id)
+  end
+
   # Used for simple testing of posing
+  documentation 'Simply sends the response body back'
   post '/echoer' do
     request.body
   end
 
-  # Simulate retrieving an ouath token. Passed to '/invoices'
+  documentation "Simulate retrieving an ouath token Passed to '/invoices'"
   post '/as/token.oauth2' do
     Soaspec::TestServer::Invoices.user_used = request.env['rack.request.form_hash']['username']
     [200, Soaspec::TestServer::Invoices.oauth_headers, JSON.generate(Soaspec::TestServer::Invoices.oauth_body)]
   end
 
+  documentation 'Replies with HTTP authorization and user set in /as/token.oauth2'
   get '/invoice/:id' do |id|
     JSON.generate(customer_id: id, oauth: request.env['HTTP_AUTHORIZATION'], user: Soaspec::TestServer::Invoices.user_used)
   end
 
-  # This is returned when a query for the WSDL is made
+  documentation 'This is returned when a query for the WSDL is made' do
+    response 'WSDL containing SCHEMA information'
+  end
   get '/BLZService' do
     [200, { 'Content-Type' => 'text/xml' }, Soaspec::TestServer::GetBank.test_wsdl]
   end
@@ -51,17 +95,23 @@ class SoaspecVirtualServer < Sinatra::Application
   end
 
   protect do
+    documentation "Get path used to test basic auth. User is 'admin' & password is 'secret'" do
+      response 'Secret text'
+    end
     get '/basic_secrets' do
       'Secret data'
     end
 
-    # This is the one being hit by SOAP actions
+    documentation 'This is the basic service being hit by SOAP actions'
     post '/BLZService' do
       Soaspec::TestServer::GetBank.response_for request
     end
   end
 
-  # Used for testing storage of data
+  documentation 'Used for testing storage of data' do
+    payload 'Puppy JSON',
+            Name: 'Test', Failure_Type__c: 'Fail'
+  end
   post '/test/puppy' do
     request_hash = JSON.parse(request.body.string)
     id = Soaspec::TestServer::PuppyService.new_id
@@ -71,12 +121,23 @@ class SoaspecVirtualServer < Sinatra::Application
     JSON.generate response_hash
   end
 
-  # Used for testing retrieving storage of data
+  documentation 'Used for testing retrieving storage of data'
   get '/test/puppy/:id' do |id|
     result = Soaspec::TestServer::PuppyService.data[id.to_i]
     JSON.generate result
   end
 
+  documentation 'Used for testing updating data'
+  patch '/test/puppy/:id' do |id|
+    request_hash = JSON.parse(request.body.string)
+    Soaspec::TestServer::PuppyService.data[id.to_i][:Name] = request_hash['Name']
+    response_hash = { result: { Status: 'updated', With: request_hash['Name'] } }
+    JSON.generate response_hash
+  end
+
+  documentation 'Used for testing the handling of JSON path' do
+    response 'JSON with multiple elements of the same name at different nested levels'
+  end
   get '/test/multiple_json' do
     <<-BOOKS
   {"store":
@@ -93,12 +154,6 @@ class SoaspecVirtualServer < Sinatra::Application
     BOOKS
   end
 
-  patch '/test/puppy/:id' do |id|
-    request_hash = JSON.parse(request.body.string)
-    Soaspec::TestServer::PuppyService.data[id.to_i][:Name] = request_hash['Name']
-    response_hash = { result: { Status: 'updated', With: request_hash['Name'] } }
-    JSON.generate response_hash
-  end
 end
 
 SoaspecVirtualServer.run!

data/lib/soaspec/exchange_handlers/rest_handler.rb

@@ -302,8 +302,8 @@ module Soaspec
         # Make REST Exchange within this Handler context
         # @param [Hash] params Exchange parameters
         # @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
-        define_method(rest_method) do |params|
-          params ||= {}
+        define_method(rest_method) do |params = {}|
+          # params ||= {}
           params[:name] ||= rest_method
           new(params[:name])
           Exchange.new(params[:name], method: rest_method.to_sym, **params)

data/lib/soaspec/exe_helpers.rb

@@ -22,6 +22,7 @@ module Soaspec
     def create_file(filename: nil, content: nil, ignore_if_present: false, erb: true)
       raise 'Need to pass filename' unless filename
       content ||= retrieve_contents(filename, erb)
+      create_folder File.split(filename).first
       if File.exist? filename
         old_content = File.read(filename)
         if old_content != content && !ignore_if_present
@@ -33,11 +34,14 @@ module Soaspec
       end
     end
 
+    # Create folder if there's not a file already there.
+    # Will create parent folder if necessary.
+    # @param [String] folder Folder to create
     def create_folder(folder)
       if File.exist? folder
         warn "!! #{folder} already exists and is not a directory" unless File.directory? folder
       else
-        FileUtils.mkdir folder
+        FileUtils.mkdir_p folder
         puts "Created folder: #{folder}/"
       end
     end

data/lib/soaspec/test_server/test_namespace.rb

@@ -1,4 +1,3 @@
-
 module Soaspec
   module TestServer
     # Helps tests attribute methods

data/lib/soaspec/version.rb

@@ -1,3 +1,3 @@
 module Soaspec
-  VERSION = '0.1.3'.freeze
+  VERSION = '0.1.4'.freeze
 end

data/soaspec.gemspec

@@ -40,6 +40,7 @@ the same configuration "
   spec.add_dependency 'savon', '>= 2' # SOAP
   spec.add_dependency 'sinatra'
   spec.add_dependency 'sinatra-basic-auth'
+  spec.add_dependency 'sinatra-docdsl'
   spec.add_dependency 'thor'
   spec.add_dependency 'xml-simple', '>= 1.1.5'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: soaspec
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - SamuelGarrattIQA
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-18 00:00:00.000000000 Z
+date: 2018-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -262,6 +262,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra-docdsl
+  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'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement