soaspec 0.1.6 → 0.1.7

data/exe/soaspec-virtual-server

@@ -1,156 +1,156 @@
-#!/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!
+#!/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!

data/exe/xml_to_yaml_file

@@ -1,61 +1,61 @@
-#!/usr/bin/env ruby
-
-require 'xmlsimple'
-require 'yaml'
-require 'fileutils'
-
-$LOAD_PATH.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
-
-require 'soaspec'
-
-include Soaspec::ExeHelpers
-
-default_output_file = 'output.yml'
-
-# Create file if not present. If present but different give warning
-def create_file(options)
-  filename = options[:filename]
-  raise 'Need to pass filename' unless filename
-  content = options[:content]
-  raise 'Need to pass contents to insert into file' unless content
-  if File.exist? filename
-    old_content = File.read(filename)
-    if old_content != content
-      warn "!! #{filename} already exists and differs from template"
-    end
-  else
-    File.open(filename, 'w') do |f|
-      f.puts content
-    end
-    puts 'Created: ' + filename
-  end
-end
-
-# For all keys in a Hash, convert Camelcase to underscore separated
-def convert_hash_keys(value)
-  case value
-  when Array
-    value.map { |v| convert_hash_keys(v) }
-  when Hash
-    Hash[value.map { |k, v| [k.snakecase, convert_hash_keys(v)] }]
-  else
-    value
-  end
-end
-
-# Remove arrays created as another string
-def clean_up_yaml(yaml_string)
-  yaml_string = yaml_string.gsub(/\R+(\s*)-/, '').gsub(/{}/, "''") # Remove arrays, {} -> ''
-  # Insert new line where there are 2 ':' on 1 line. Issue from first gsub
-  yaml_string.gsub(/:(\s)(\w*):/){|s| s.insert(1, "\n")}
-end
-
-if ARGV[0]
-  warn "Using '#{default_output_file}' as default output file since no 2nd argument passed" unless ARGV[1]
-  hash = XmlSimple.xml_in(ARGV[0])
-  converted = convert_hash_keys hash
-  yaml_file = clean_up_yaml(converted.to_yaml)
-  create_file(filename: ARGV[1] || default_output_file, content: yaml_file)
-else
-  puts 'usage: xml_to_yaml_file [input.xml] [output.yml] '
+#!/usr/bin/env ruby
+
+require 'xmlsimple'
+require 'yaml'
+require 'fileutils'
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+require 'soaspec'
+
+include Soaspec::ExeHelpers
+
+default_output_file = 'output.yml'
+
+# Create file if not present. If present but different give warning
+def create_file(options)
+  filename = options[:filename]
+  raise 'Need to pass filename' unless filename
+  content = options[:content]
+  raise 'Need to pass contents to insert into file' unless content
+  if File.exist? filename
+    old_content = File.read(filename)
+    if old_content != content
+      warn "!! #{filename} already exists and differs from template"
+    end
+  else
+    File.open(filename, 'w') do |f|
+      f.puts content
+    end
+    puts 'Created: ' + filename
+  end
+end
+
+# For all keys in a Hash, convert Camelcase to underscore separated
+def convert_hash_keys(value)
+  case value
+  when Array
+    value.map { |v| convert_hash_keys(v) }
+  when Hash
+    Hash[value.map { |k, v| [k.snakecase, convert_hash_keys(v)] }]
+  else
+    value
+  end
+end
+
+# Remove arrays created as another string
+def clean_up_yaml(yaml_string)
+  yaml_string = yaml_string.gsub(/\R+(\s*)-/, '').gsub(/{}/, "''") # Remove arrays, {} -> ''
+  # Insert new line where there are 2 ':' on 1 line. Issue from first gsub
+  yaml_string.gsub(/:(\s)(\w*):/){|s| s.insert(1, "\n")}
+end
+
+if ARGV[0]
+  warn "Using '#{default_output_file}' as default output file since no 2nd argument passed" unless ARGV[1]
+  hash = XmlSimple.xml_in(ARGV[0])
+  converted = convert_hash_keys hash
+  yaml_file = clean_up_yaml(converted.to_yaml)
+  create_file(filename: ARGV[1] || default_output_file, content: yaml_file)
+else
+  puts 'usage: xml_to_yaml_file [input.xml] [output.yml] '
 end

data/lib/soaspec.rb

@@ -1,103 +1,107 @@
-require 'rest-client' # REST
-require 'erb' # Embedded ruby
-require 'yaml' # Reading yaml
-require 'rspec' # Testing framework
-require 'rspec/its'
-require 'savon' # SOAP
-require 'nokogiri' # XPath
-require 'date'
-require 'jsonpath'
-
-require 'soaspec/version'
-require 'soaspec/exchange_handlers/soap_handler'
-require 'soaspec/exchange_handlers/exchange_handler'
-require 'soaspec/exchange_handlers/rest_methods'
-require 'soaspec/exchange'
-require 'soaspec/matchers'
-require 'soaspec/soaspec_shared_examples'
-require 'soaspec/core_ext/hash'
-require 'soaspec/spec_logger'
-require 'soaspec/exe_helpers'
-require 'soaspec/exchange_handlers/rest_handler'
-require 'soaspec/exchange_handlers/handler_accessors'
-require 'soaspec/interpreter'
-require 'soaspec/not_found_errors'
-require 'soaspec/test_server/get_bank'
-require 'soaspec/test_server/test_attribute'
-require 'soaspec/test_server/puppy_service'
-require 'soaspec/test_server/invoices'
-require 'soaspec/test_server/test_namespace'
-require 'soaspec/test_server/id_manager'
-require 'soaspec/wsdl_generator'
-
-# Gem for handling SOAP and REST api tests
-module Soaspec
-
-  @template_folder = 'template'
-
-  class << self
-    # Specify whether to see params sent to and retrieved from oauth. This will put password in log file, only recommended for debugging
-    attr_writer :debug_oauth
-    # Folder used to store templates for API calls
-    attr_accessor :template_folder
-    # Stores last exchange
-    attr_accessor :last_exchange
-
-    # Folder used to store credentials
-    # Used in auth2_file command
-    # @param [String] folder
-    def credentials_folder=(folder)
-      @credentials_folder = folder
-    end
-
-    # Credentials folder used to store secret data (not in source control) E.g passwords
-    def credentials_folder
-      @credentials_folder
-    end
-
-    # Used so that exchange class knows what context it's in
-    # @param [ExchangeHandler] handler A class inheriting from Soaspec::ExchangeHandler. Exchange class uses this
-    def api_handler=(handler)
-      @api_handler = handler
-    end
-
-    # Exchange Handler class currently being used
-    def api_handler
-      @api_handler
-    end
-
-    # Set whether to transform strings to keys in request automatically
-    # @param [Boolean] use_keys
-    def always_use_keys=(use_keys)
-      @always_use_keys = use_keys
-    end
-
-    # @return [Boolean] Whether to transform strings to keys in request automatically
-    def always_use_keys?
-      @always_use_keys || true
-    end
-
-    # @return [Boolean] Whether to see params sent to & received from oauth URL
-    def debug_oauth?
-      @debug_oauth || false
-    end
-
-    # @return [String] Folder used to store templates for API calls
-    # def template_folder
-    #   @template_folder || 'template'
-    # end
-
-    # Whether to log all API traffic
-    def log_api_traffic=(set)
-      @log_api_traffic = set
-      RestClient.log = nil unless set
-    end
-
-    # @return [Boolean] Whether to log all API traffic
-    def log_api_traffic?
-      @log_api_traffic.nil? ? true : @log_api_traffic
-    end
-  end
-end
-
-RestClient.log = Soaspec::SpecLogger.create
+require 'rest-client' # REST
+require 'erb' # Embedded ruby
+require 'yaml' # Reading yaml
+require 'rspec' # Testing framework
+require 'rspec/its'
+require 'savon' # SOAP
+require 'nokogiri' # XPath
+require 'date'
+require 'jsonpath'
+
+require 'soaspec/version'
+require 'soaspec/o_auth2'
+require 'soaspec/exchange_handlers/soap_handler'
+require 'soaspec/exchange_handlers/exchange_handler'
+require 'soaspec/exchange_handlers/rest_methods'
+require 'soaspec/exchange'
+require 'soaspec/matchers'
+require 'soaspec/soaspec_shared_examples'
+require 'soaspec/core_ext/hash'
+require 'soaspec/spec_logger'
+require 'soaspec/exe_helpers'
+require 'soaspec/exchange_handlers/rest_handler'
+require 'soaspec/exchange_handlers/handler_accessors'
+require 'soaspec/interpreter'
+require 'soaspec/not_found_errors'
+require 'soaspec/test_server/get_bank'
+require 'soaspec/test_server/test_attribute'
+require 'soaspec/test_server/puppy_service'
+require 'soaspec/test_server/invoices'
+require 'soaspec/test_server/test_namespace'
+require 'soaspec/test_server/id_manager'
+require 'soaspec/wsdl_generator'
+
+# Gem for handling SOAP and REST api tests
+module Soaspec
+
+  @template_folder = 'template'
+  @auto_oauth = true
+
+  class << self
+    # Specify whether to see params sent to and retrieved from oauth. This will put password in log file, only recommended for debugging
+    attr_writer :debug_oauth
+    # Folder used to store templates for API calls
+    attr_accessor :template_folder
+    # Stores last exchange
+    attr_accessor :last_exchange
+    # Automatically add Authorization header to RestHandler where oauth2 credentials are specified
+    attr_accessor :auto_oauth
+
+    # Folder used to store credentials
+    # Used in auth2_file command
+    # @param [String] folder
+    def credentials_folder=(folder)
+      @credentials_folder = folder
+    end
+
+    # Credentials folder used to store secret data (not in source control) E.g passwords
+    def credentials_folder
+      @credentials_folder
+    end
+
+    # Used so that exchange class knows what context it's in
+    # @param [ExchangeHandler] handler A class inheriting from Soaspec::ExchangeHandler. Exchange class uses this
+    def api_handler=(handler)
+      @api_handler = handler
+    end
+
+    # Exchange Handler class currently being used
+    def api_handler
+      @api_handler
+    end
+
+    # Set whether to transform strings to keys in request automatically
+    # @param [Boolean] use_keys
+    def always_use_keys=(use_keys)
+      @always_use_keys = use_keys
+    end
+
+    # @return [Boolean] Whether to transform strings to keys in request automatically
+    def always_use_keys?
+      @always_use_keys || true
+    end
+
+    # @return [Boolean] Whether to see params sent to & received from oauth URL
+    def debug_oauth?
+      @debug_oauth || false
+    end
+
+    # @return [String] Folder used to store templates for API calls
+    # def template_folder
+    #   @template_folder || 'template'
+    # end
+
+    # Whether to log all API traffic
+    def log_api_traffic=(set)
+      @log_api_traffic = set
+      RestClient.log = nil unless set
+    end
+
+    # @return [Boolean] Whether to log all API traffic
+    def log_api_traffic?
+      @log_api_traffic.nil? ? true : @log_api_traffic
+    end
+  end
+end
+
+RestClient.log = Soaspec::SpecLogger.create