soaspec 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c5fd821e9ac9431eda83eb84e36cf5901cba2e1e
-  data.tar.gz: 9557f06d415ecbf523d9d3d4c4ff8235575da19a
+  metadata.gz: a77bc501e360feb0326d9e0453fd134f534488d9
+  data.tar.gz: 0a5543099fdea5c919f5a6fcb10c15823f9d8889
 SHA512:
-  metadata.gz: fc8a3eca5fead9e365fad90c72bb5943a83889cebf3c2bf5bac286878a1791ebcbcae4570692f0679239002dbca4889015d8709bb7779d23073d54b144a6710e
-  data.tar.gz: 12332a4d42e8738640fd9dbafa655693bcc4ba2f093ed009812f35ce6fcf2f58d9e984325ffd7f23c7f47fc2f37cab8172ce0239f55138b648d7598cad51355d
+  metadata.gz: 737e926e4fd459e15f4174c22991dd792d2c891f60ba48b36b538f9bf6beda5c652b4e32f50ce1cfdf189841da7bec26920e3f0ea284ff26417424271375dfc2
+  data.tar.gz: ad5987dbd6099d7887fc0186de8806821c973138f7e1229ec7a7aba179085a20ca6a011850e4c97f69006950bf63bba98d246ae16bac180b2a4ec9fce8d8617f

data/ChangeLog

@@ -1,3 +1,7 @@
+Version 0.1.9
+* Enhancements
+  * Finally move `soaspec-virtual-server` into same binary as `soaspec` utilising Thor
+
 Version 0.1.8
 * Bug fix
   * Could not see OAuth parameters sent in logs when setting oauth debugging to true

data/Rakefile

@@ -18,7 +18,7 @@ CLOBBER.include 'logs/*'
 desc 'Start virtual web service'
 task :start_test_server do
   mkdir_p 'logs'
-  ENV['test_server_pid'] = Process.spawn('ruby', 'exe/soaspec-virtual-server', err: %w[logs/test_server.log w]).to_s
+  ENV['test_server_pid'] = Process.spawn('ruby', 'exe/soaspec', 'virtual_server', err: %w[logs/test_server.log w]).to_s
   sleep 2 # Wait a little for virtual server to start up
   puts 'Running test server at pid ' + ENV['test_server_pid']
 end

data/exe/soaspec

@@ -2,7 +2,7 @@
 
 
 require 'thor'
-$LOAD_PATH.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 require 'savon'
 require 'soaspec'
 
@@ -32,8 +32,8 @@ module Soaspec
       create_file(filename: 'Gemfile')
       create_file(filename: 'Rakefile')
       create_file(filename: '.rspec')
-      create_file(filename: '.travis.yml') if options[:ci] == 'travis'
       create_file(filename: 'README.md')
+      create_file(filename: '.travis.yml') if options[:ci] == 'travis'
       if type == 'soap'
         create_file filename: 'lib/blz_service.rb'
         create_file filename: 'lib/shared_example.rb'
@@ -104,6 +104,15 @@ module Soaspec
       end
     end
 
+    long_desc <<-LONGDESC
+    Run virtual web services on localhost. See root for documentation of web services provided.
+    LONGDESC
+    desc 'virtual_server [port]', 'Run virtual web service on localhost'
+    def virtual_server(port = '4999')
+      ENV['port'] = port
+      require 'soaspec/virtual_server'
+      Soaspec::VirtualServer.run!(Port: port)
+    end
   end
 end
 

data/lib/soaspec/generator/Rakefile.erb

@@ -13,7 +13,7 @@ task default: :spec # This runs the 'spec' task by default when no task is menti
 <% if @virtual %>
 desc 'Start virtual web service'
 task :start_test_server do
-  ENV['test_server_pid'] = Process.spawn('soaspec-virtual-server', err: %w[logs/test_server.log w]).to_s
+  ENV['test_server_pid'] = Process.spawn('soaspec', 'virtual_server', err: %w[logs/test_server.log w]).to_s
   puts 'Running test server at pid ' + ENV['test_server_pid']
   sleep 0.5 # Wait a little for virtual server to start up
 end

data/lib/soaspec/o_auth2.rb

@@ -11,6 +11,7 @@ module Soaspec
     # @param [String] api_username Username to use which can be set by Soaspec::ExchangeHandler
     def initialize(params, api_username)
       raise 'client_id and client_secret not set' unless params[:client_id] && params[:client_secret]
+      raise 'token_url mandatory' unless params[:token_url]
       self.params = params
       params[:username] = api_username || ERB.new(params[:username]).result(binding) if params[:username]
       params[:security_token] = ERB.new(params[:security_token]).result(binding) if params[:security_token]

data/lib/soaspec/version.rb

@@ -1,3 +1,3 @@
 module Soaspec
-  VERSION = '0.1.8'.freeze
+  VERSION = '0.1.9'.freeze
 end

data/lib/soaspec/virtual_server.rb

@@ -0,0 +1,153 @@
+require 'soaspec'
+require 'sinatra'
+require 'sinatra/basic_auth'
+require 'docdsl'
+require 'nokogiri'
+require 'erb'
+require 'json'
+require 'faker'
+
+module Soaspec
+  # Used to run virtual web service on localhost. This makes tests more reliable and faster
+  # First argument overrides the default port
+  class VirtualServer < Sinatra::Application
+    set :bind, '0.0.0.0'
+    set :port, (ENV['port'] || 4999).to_i
+
+    register Sinatra::DocDsl
+
+    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
+
+    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
+
+    documentation 'Used to test namespaces' do
+      response 'XML with 2 namespaces and same elements inside it'
+    end
+    get '/namespace' do
+      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|
+      JSON.generate(success: Soaspec::TestServer::IdManager.result_for(num, id), id: id)
+    end
+
+    post '/packages/developed' do
+      Soaspec::TestServer::IdManager.developed = request.body.include?('true')
+      Soaspec::TestServer::IdManager.developed.to_s
+    end
+
+    # Used for simple testing of posing
+    documentation 'Simply sends the response body back'
+    post '/echoer' do
+      request.body
+    end
+
+    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
+
+    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
+
+    authorize do |username, password|
+      username == 'admin' && password == 'secret'
+    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
+
+      documentation 'This is the basic service being hit by SOAP actions'
+      post '/BLZService' do
+        Soaspec::TestServer::GetBank.response_for request
+      end
+    end
+
+    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
+      Soaspec::TestServer::PuppyService.data[id][:Name] = request_hash['Name']
+      Soaspec::TestServer::PuppyService.data[id][:Failure_Type__c] = request_hash['Failure_Type__c'] if request_hash['Failure_Type__c']
+      response_hash = { result: { Status: 'success', Data: Soaspec::TestServer::PuppyService.data[id] } }
+      JSON.generate response_hash
+    end
+
+    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":
+      {"bicycle":
+        {"price":19.95, "color":"red"},
+        "book":[
+          {"price":8.95, "category":"reference", "title":"Sayings of the Century", "author":"Nigel Rees"},
+          {"price":12.99, "category":"fiction", "title":"Sword of Honour", "author":"Evelyn Waugh"},
+          {"price":8.99, "category":"fiction", "isbn":"0-553-21311-3", "title":"Moby Dick", "author":"Herman Melville","color":"blue"},
+          {"price":22.99, "category":"fiction", "isbn":"0-395-19395-8", "title":"The Lord of the Rings", "author":"Tolkien"}
+        ]
+      }
+    }
+        BOOKS
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: soaspec
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - SamuelGarrattIQA
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-07 00:00:00.000000000 Z
+date: 2018-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -310,7 +310,6 @@ email:
 - samuel.garratt@integrationqa.com
 executables:
 - soaspec
-- soaspec-virtual-server
 - xml_to_yaml_file
 extensions: []
 extra_rdoc_files: []
@@ -327,7 +326,6 @@ files:
 - Rakefile
 - Todo.md
 - exe/soaspec
-- exe/soaspec-virtual-server
 - exe/xml_to_yaml_file
 - lib/soaspec.rb
 - lib/soaspec/core_ext/hash.rb
@@ -368,6 +366,7 @@ files:
 - lib/soaspec/test_server/test_attribute.rb
 - lib/soaspec/test_server/test_namespace.rb
 - lib/soaspec/version.rb
+- lib/soaspec/virtual_server.rb
 - lib/soaspec/wsdl_generator.rb
 - soaspec.gemspec
 - test.wsdl

data/exe/soaspec-virtual-server

@@ -1,156 +0,0 @@
-#!/usr/bin/env ruby
-
-$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
-# First argument overrides the default port
-class SoaspecVirtualServer < Sinatra::Application
-  set :bind, '0.0.0.0'
-  set :port, (ARGV[0] || 4999).to_i
-
-  register Sinatra::DocDsl
-
-  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
-
-  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
-
-  documentation 'Used to test namespaces' do
-    response 'XML with 2 namespaces and same elements inside it'
-  end
-  get '/namespace' do
-    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|
-    JSON.generate(success: Soaspec::TestServer::IdManager.result_for(num, id), id: id)
-  end
-
-  post '/packages/developed' do
-    Soaspec::TestServer::IdManager.developed = request.body.include?('true')
-    Soaspec::TestServer::IdManager.developed.to_s
-  end
-
-  # Used for simple testing of posing
-  documentation 'Simply sends the response body back'
-  post '/echoer' do
-    request.body
-  end
-
-  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
-
-  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
-
-  authorize do |username, password|
-    username == 'admin' && password == 'secret'
-  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
-
-    documentation 'This is the basic service being hit by SOAP actions'
-    post '/BLZService' do
-      Soaspec::TestServer::GetBank.response_for request
-    end
-  end
-
-  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
-    Soaspec::TestServer::PuppyService.data[id][:Name] = request_hash['Name']
-    Soaspec::TestServer::PuppyService.data[id][:Failure_Type__c] = request_hash['Failure_Type__c'] if request_hash['Failure_Type__c']
-    response_hash = { result: { Status: 'success', Data: Soaspec::TestServer::PuppyService.data[id] } }
-    JSON.generate response_hash
-  end
-
-  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":
-    {"bicycle":
-      {"price":19.95, "color":"red"},
-      "book":[
-        {"price":8.95, "category":"reference", "title":"Sayings of the Century", "author":"Nigel Rees"},
-        {"price":12.99, "category":"fiction", "title":"Sword of Honour", "author":"Evelyn Waugh"},
-        {"price":8.99, "category":"fiction", "isbn":"0-553-21311-3", "title":"Moby Dick", "author":"Herman Melville","color":"blue"},
-        {"price":22.99, "category":"fiction", "isbn":"0-395-19395-8", "title":"The Lord of the Rings", "author":"Tolkien"}
-      ]
-    }
-  }
-    BOOKS
-  end
-end
-
-SoaspecVirtualServer.run!