soaspec 0.0.19 → 0.0.20

data/LICENSE.txt

@@ -1,21 +1,21 @@
-The MIT License (MIT)
-
-Copyright (c) 2018 Samuel Garratt
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+The MIT License (MIT)
+
+Copyright (c) 2018 Samuel Garratt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -1,66 +1,85 @@
-# Soaspec
-
-This gem helps to represent multiple API tests against a backend briefly, concisely and clearly. It is essentially a wrapper around the Savon and RestClient gems. Note it is still in early stages of development.
-
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'soaspec'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install soaspec
-
-## Todo
-
-Handle REST
-Give examples and convenience methods for building classes for each SOAP or REST operation
-Potentially have in built use of 'vcr' and 'http_stub' gems
-
-## Usage
-
-* SOAP - this uses Savon behind the scenes. Some defaults are overridden. Please see 'basic_soap_handler.rb'-'default_options' method
-for such defaults. When describing an API override this in 'savon_options' method  
-
-See specs for example of usage. This will be added to later. 
-
-### Recommended
-
-It is recommended that a class be created representing a Web Service Operation or REST call. Then tests refer back to 
-that class. See 'weather_web_service.rb' class in spec/soaspec/soap folder for example.
-
-If you find having a large backtrace on errors or RSpec shared examples such as 'success scenarios' this can shorten the 
-backtrace.
-
-RSpec.configure do |config|
-
-  config.backtrace_exclusion_patterns = [
-    /rspec/
-  ]
-end
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitLab at https://gitlab.com/samuel-garratt/soaspec. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the Soaspec project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://gitlab.com/samuel-garratt/soaspec/blob/master/CODE_OF_CONDUCT.md).
+# Soaspec
+
+This gem helps to represent multiple API tests against a backend briefly, concisely and clearly. It is essentially a wrapper around the Savon and RestClient gems. Note it is still in early stages of development.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'soaspec'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install soaspec
+
+## Todo
+
+Handle REST
+Give examples and convenience methods for building classes for each SOAP or REST operation
+Potentially have in built use of 'vcr' and 'http_stub' gems
+
+## Getting Started
+
+To create a new test suite using this you can use the 'soaspec-init' binary.
+
+Example:
+
+```
+mkdir 'api_test'
+cd 'api_test'
+soaspec-init
+bundle install
+```
+
+Then you can run the tests with:
+
+```
+rake spec
+```
+
+## Usage
+
+* SOAP - this uses Savon behind the scenes. Some defaults are overridden. Please see 'basic_soap_handler.rb'-'default_options' method
+for such defaults. When describing an API override this in 'savon_options' method  
+
+See specs for example of usage. This will be added to later. 
+
+### Recommended
+
+It is recommended that a class be created representing a Web Service Operation or REST call. Then tests refer back to 
+that class. See 'weather_web_service.rb' class in spec/soaspec/soap folder for example.
+
+If you find having a large backtrace on errors or RSpec shared examples such as 'success scenarios' this can shorten the 
+backtrace.
+
+RSpec.configure do |config|
+
+  config.backtrace_exclusion_patterns = [
+    /rspec/
+  ]
+end
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitLab at https://gitlab.com/samuel-garratt/soaspec. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Soaspec project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://gitlab.com/samuel-garratt/soaspec/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,20 +1,20 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require 'rake/clean'
-
-RSpec::Core::RakeTask.new(:run_spec) do |t|
-  t.pattern = "spec/*/*/*_spec.rb"
-end
-
-desc 'Prepare log files'
-task :logs do
-  mkdir_p 'logs'
-  touch 'logs/traffic.log'
-end
-
-desc 'Run tests'
-task :spec => %w[logs run_spec]
-
-task :default => :spec
-
-CLOBBER.include 'logs/*'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rake/clean'
+
+RSpec::Core::RakeTask.new(:run_spec) do |t|
+  t.pattern = "spec/*/*/*_spec.rb"
+end
+
+desc 'Prepare log files'
+task :logs do
+  mkdir_p 'logs'
+  touch 'logs/traffic.log'
+end
+
+desc 'Run tests'
+task :spec => %w[logs run_spec]
+
+task :default => :spec
+
+CLOBBER.include 'logs/*'

data/bin/console

@@ -1,14 +1,14 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "soaspec"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "soaspec"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +1,8 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/data/default.yml

@@ -1,3 +1,3 @@
-japan:
-  city_name: 'Tokyo'
+japan:
+  city_name: 'Tokyo'
   country_name: 'Japan'

data/exe/soaspec-init

@@ -1,252 +1,254 @@
-#!/usr/bin/env ruby
-
-require 'soaspec'
-require 'fileutils'
-
-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
-
-def create_folder(folder)
-  if File.exists? folder
-    unless File.directory? folder
-      $stderr.puts "!! #{folder} already exists and is not a directory"
-    end
-  else
-    FileUtils.mkdir folder
-    puts "Created folder: #{folder}/"
-  end
-end
-
-puts 'Creating files for soaspec'
-
-gem_content = <<-EOF
-
-source 'https://rubygems.org'
-
-gem 'data_magic'
-gem 'require_all'
-gem 'rspec_junit_formatter'
-gem 'rake'
-gem 'soaspec'
-
-EOF
-
-rake_content = <<-EOF
-# The list of task for a Rake file can be seen with `rake -T`
-require 'rspec/core/rake_task' # See See https://relishapp.com/rspec/rspec-core/docs/command-line/rake-task for details
-
-# This runs `rspec` command with the following options. Type `rake spec` to run this task
-RSpec::Core::RakeTask.new(:spec) do |t, task_args|
-  t.pattern = "spec/*_spec.rb" # Run all specs in 'spec' folder ending in '_spec'
-  # Next line shows output on the screen, Junit xml report and an HTML report
-  t.rspec_opts = "--format documentation --format RspecJunitFormatter --out logs/spec.xml --format html --out logs/spec.html"
-  t.fail_on_error = false
-end
-
-task :default => :spec # This runs the 'spec' task by default when no task is mentioned. E.g., if only `rake` is typed
-EOF
-
-
-spec_helper_content = <<-EOF
-
-require 'soaspec'
-require 'require_all'
-require_all 'lib'
-require 'data_magic'
-
-include DataMagic # Used as example of loading data smartly. Use 'data_for' method to load yml data
-
-RSpec.configure do |config|
-  # This will make backtrace much shorter by removing many lines from rspec failure message
-  config.backtrace_exclusion_patterns = [
-    /rspec/
-  ]
-end
-
-EOF
-
-weather_web_service = <<-EOF
-
-require 'soaspec'
-
-# This class is not part of the gem. It's an example of a class you can make
-# to describe your APIs. Usually this would exist in the 'lib' directory
-# Common configuration for the Savon client should go here
-class WeatherWebService < Soaspec::BasicSoapHandler
-  # Add to or override default Savon client options
-  def savon_options
-    {
-      wsdl: 'http://www.webservicex.com/globalweather.asmx?wsdl',
-      convert_request_keys_to: :camelcase
-    }
-  end
-
-  # Specifying that get_weather_result must be present in the SOAP response
-  def mandatory_elements
-    [:get_weather_result]
-  end
-
-  # Example of xpath value that must be true for all success scenarios
-  def mandatory_xpath_values
-    {
-      '//xmlns:GetWeatherResult' => 'Data Not Found'
-    }
-  end
-
-  # Example of setting an attribute on the root XML element
-  def root_attributes
-    {
-      'Version' => '1'
-    }
-  end
-
-end
-
-EOF
-
-soap_spec_content = <<-EOF
-
-require 'spec_helper'
-
-soap_example = WeatherWebService.new('Get Weather')
-soap_example.operation = :get_weather
-soap_example.default_hash = { city_name: 'Sydney', country_name: 'Australia' }
-# soap_example.template_name = 'soap_template' # Use this if you'd rather use template file and comment out previous line
-
-
-  context soap_example do
-    describe Exchange.new(:default) do
-      it { is_expected.to contain_value 'Data Not Found' }
-      it_behaves_like 'success scenario'
-    end
-
-    describe Exchange.new(:china, city_name: 'Shanghai', country_name: 'China') do
-      it_behaves_like 'success scenario'
-      context 'handle xpath' do
-        its(['//xmlns:GetWeatherResult']) { is_expected.to eq 'Data Not Found' }
-        its(['xmlns:GetWeatherResult']) { is_expected.to eq 'Data Not Found' }
-        it { is_expected.to have_element_at_xpath '//xmlns:GetWeatherResult' }
-        it { is_expected.to have_xpath_value '//xmlns:GetWeatherResult' => 'Data Not Found' }
-      end
-    end
-
-    describe Exchange.new(:japan, data_for(:japan)) do
-      it_behaves_like 'success scenario'
-    end
-
-  end
-
-soap_example.default_hash = { city_name: 'Washington' }
-context 'error scenarios' do
-  context soap_example do
-    describe Exchange.new(:error) do
-      it_behaves_like 'error scenario'
-    end
-  end
-end
-
-
-EOF
-
-shared_examples_content = <<-EOF
-
-require 'rspec'
-
-shared_examples_for 'error scenario' do
-  it 'does not have status code of 200' do
-    expect(described_class.status_code).not_to eq 200
-  end
-end
-
-EOF
-
-soap_template_content = <<-EOF
-<s12:Envelope xmlns:s12='http://www.w3.org/2003/05/soap-envelope'>
-  <s12:Body>
-    <ns1:GetWeather xmlns:ns1='http://www.webserviceX.NET'>
-      <!-- optional -->
-      <ns1:CityName><%= test_values[:city_name] || 'Wellington' %></ns1:CityName>
-      <!-- optional -->
-      <ns1:CountryName><%= test_values[:country] || 'New Zealand' %></ns1:CountryName>
-    </ns1:GetWeather>
-  </s12:Body>
-</s12:Envelope>
-EOF
-
-default_yaml_content = <<-EOF
-japan:
-  city_name: 'Tokyo'
-  country_name: 'Japan'
-
-EOF
-
-readme_content = <<-EOF
-
-# Prerequisites
-This creates files within an existing folder. It could add onto an existing project.
-For a new project create a folder and be at it's location on the command line
-
-```
-mkdir soaspec_test
-cd soaspec_test
-```
-
-Run `bundle install` to install the gems mentioned in the Gemfile.
-
-To avoid conflict with gems on the machine globally it may be better to specify gem location with:
-
-`bundle install --path ~/.gem`
-
-# Running tests
-On the command line type:
-`bundle exec rake spec` or simply `bundle exec rake`
-
-# Structure
-
-## Tests
-Tests are within the 'spec' folder and end in '_spec'. Setup and teardown for tests is in 'spec/spec_helper'
-
-## Templates
-These are the base requests with ERB inside them to create smartly changing requests accoring to the test.yml
-
-## Libaries
-Libaries to be installed are in 'Gemfile'. Specific gem versions can be specified here and enforeced with `bundle exec rake`
-
-## Reports
-Reports are shown in the 'logs' folder. By default Rake produces a junit, an html report, and a traffic.log file with the API request and responses in it
-
-EOF
-
-create_file(filename: 'Gemfile', content: gem_content)
-create_file(filename: 'Rakefile', content: rake_content)
-create_file(filename: 'README.md', content: readme_content)
-create_folder 'lib'
-create_file(filename: 'lib/weather_web_service.rb', content: weather_web_service)
-create_file filename: 'lib/shared_example.rb', content: shared_examples_content
-create_folder 'config'
-create_folder 'config/data'
-create_file(filename: 'config/data/default.yml', content: default_yaml_content)
-create_folder 'spec'
-create_file(filename: 'spec/spec_helper.rb', content: spec_helper_content)
-create_file(filename: 'spec/soap_spec.rb', content: soap_spec_content)
-create_folder 'template'
-create_file(filename: 'template/soap_template.xml', content: soap_template_content)
-create_folder 'logs'
-
-puts "Run 'bundle install' to install necessary gems"
-puts "Run 'rake spec' to run the tests"
+#!/usr/bin/env ruby
+
+require 'soaspec'
+require 'fileutils'
+
+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
+
+def create_folder(folder)
+  if File.exists? folder
+    unless File.directory? folder
+      $stderr.puts "!! #{folder} already exists and is not a directory"
+    end
+  else
+    FileUtils.mkdir folder
+    puts "Created folder: #{folder}/"
+  end
+end
+
+puts 'Creating files for soaspec'
+
+gem_content = <<-EOF
+
+source 'https://rubygems.org'
+
+gem 'data_magic'
+gem 'require_all'
+gem 'rspec_junit_formatter'
+gem 'rake'
+gem 'soaspec'
+
+EOF
+
+rake_content = <<-EOF
+# The list of task for a Rake file can be seen with `rake -T`
+require 'rspec/core/rake_task' # See See https://relishapp.com/rspec/rspec-core/docs/command-line/rake-task for details
+
+# This runs `rspec` command with the following options. Type `rake spec` to run this task
+RSpec::Core::RakeTask.new(:spec) do |t, task_args|
+  t.pattern = "spec/*_spec.rb" # Run all specs in 'spec' folder ending in '_spec'
+  # Next line shows output on the screen, Junit xml report and an HTML report
+  t.rspec_opts = "--format documentation --format RspecJunitFormatter --out logs/spec.xml --format html --out logs/spec.html"
+  t.fail_on_error = false
+end
+
+task :default => :spec # This runs the 'spec' task by default when no task is mentioned. E.g., if only `rake` is typed
+EOF
+
+
+spec_helper_content = <<-EOF
+
+require 'soaspec'
+require 'require_all'
+require_all 'lib'
+require 'data_magic'
+
+include DataMagic # Used as example of loading data smartly. Use 'data_for' method to load yml data
+
+RSpec.configure do |config|
+  # This will make backtrace much shorter by removing many lines from rspec failure message
+  config.backtrace_exclusion_patterns = [
+    /rspec/
+  ]
+end
+
+EOF
+
+weather_web_service = <<-EOF
+
+require 'soaspec'
+
+# This class is not part of the gem. It's an example of a class you can make
+# to describe your APIs. Usually this would exist in the 'lib' directory
+# Common configuration for the Savon client should go here
+class WeatherWebService < Soaspec::BasicSoapHandler
+  # Add to or override default Savon client options
+  def savon_options
+    {
+      wsdl: 'http://www.webservicex.com/globalweather.asmx?wsdl',
+      convert_request_keys_to: :camelcase
+    }
+  end
+
+  # Specifying that get_weather_result must be present in the SOAP response
+  def mandatory_elements
+    [:get_weather_result]
+  end
+
+  # Example of xpath value that must be true for all success scenarios
+  def mandatory_xpath_values
+    {
+      '//xmlns:GetWeatherResult' => 'Data Not Found'
+    }
+  end
+
+  # Example of setting an attribute on the root XML element
+  def root_attributes
+    {
+      'Version' => '1'
+    }
+  end
+
+end
+
+EOF
+
+soap_spec_content = <<-EOF
+
+require 'spec_helper'
+
+Soaspec::Environment.strip_namespaces = true # This allows namespace not to be used. Be careful with this
+
+soap_example = WeatherWebService.new('Get Weather')
+soap_example.operation = :get_weather
+soap_example.default_hash = { city_name: 'Sydney', country_name: 'Australia' }
+# soap_example.template_name = 'soap_template' # Use this if you'd rather use template file and comment out previous line
+
+
+  context soap_example do
+    describe Exchange.new(:default) do
+      it { is_expected.to contain_value 'Data Not Found' }
+      it_behaves_like 'success scenario'
+    end
+
+    describe Exchange.new(:china, city_name: 'Shanghai', country_name: 'China') do
+      it_behaves_like 'success scenario'
+      context 'handle xpath' do
+        its(['GetWeatherResult']) { is_expected.to eq 'Data Not Found' } # Don't need to use namespace
+        it { is_expected.to have_element_at_xpath '//xmlns:GetWeatherResult' }
+        it { is_expected.to have_xpath_value '//xmlns:GetWeatherResult' => 'Data Not Found' }
+      end
+    end
+
+    describe Exchange.new(:japan, data_for(:japan)) do
+      it_behaves_like 'success scenario'
+      its(['//xmlns:GetWeatherResult']) { is_expected.to eq 'Data Not Found' } # Can specify namespace if wanted
+    end
+
+  end
+
+soap_example.default_hash = { city_name: 'Washington' }
+context 'error scenarios' do
+  context soap_example do
+    describe Exchange.new(:error) do
+      it_behaves_like 'error scenario'
+    end
+  end
+end
+
+
+EOF
+
+shared_examples_content = <<-EOF
+
+require 'rspec'
+
+shared_examples_for 'error scenario' do
+  it 'does not have status code of 200' do
+    expect(described_class.status_code).not_to eq 200
+  end
+end
+
+EOF
+
+soap_template_content = <<-EOF
+<s12:Envelope xmlns:s12='http://www.w3.org/2003/05/soap-envelope'>
+  <s12:Body>
+    <ns1:GetWeather xmlns:ns1='http://www.webserviceX.NET'>
+      <!-- optional -->
+      <ns1:CityName><%= test_values[:city_name] || 'Wellington' %></ns1:CityName>
+      <!-- optional -->
+      <ns1:CountryName><%= test_values[:country] || 'New Zealand' %></ns1:CountryName>
+    </ns1:GetWeather>
+  </s12:Body>
+</s12:Envelope>
+EOF
+
+default_yaml_content = <<-EOF
+japan:
+  city_name: 'Tokyo'
+  country_name: 'Japan'
+
+EOF
+
+readme_content = <<-EOF
+
+# Prerequisites
+This creates files within an existing folder. It could add onto an existing project.
+For a new project create a folder and be at it's location on the command line
+
+```
+mkdir soaspec_test
+cd soaspec_test
+```
+
+Run `bundle install` to install the gems mentioned in the Gemfile.
+
+To avoid conflict with gems on the machine globally it may be better to specify gem location with:
+
+`bundle install --path ~/.gem`
+
+# Running tests
+On the command line type:
+`bundle exec rake spec` or simply `bundle exec rake`
+
+# Structure
+
+## Tests
+Tests are within the 'spec' folder and end in '_spec'. Setup and teardown for tests is in 'spec/spec_helper'
+
+## Templates
+These are the base requests with ERB inside them to create smartly changing requests accoring to the test.yml
+
+## Libaries
+Libaries to be installed are in 'Gemfile'. Specific gem versions can be specified here and enforeced with `bundle exec rake`
+
+## Reports
+Reports are shown in the 'logs' folder. By default Rake produces a junit, an html report, and a traffic.log file with the API request and responses in it
+
+EOF
+
+create_file(filename: 'Gemfile', content: gem_content)
+create_file(filename: 'Rakefile', content: rake_content)
+create_file(filename: 'README.md', content: readme_content)
+create_folder 'lib'
+create_file(filename: 'lib/weather_web_service.rb', content: weather_web_service)
+create_file filename: 'lib/shared_example.rb', content: shared_examples_content
+create_folder 'config'
+create_folder 'config/data'
+create_file(filename: 'config/data/default.yml', content: default_yaml_content)
+create_folder 'spec'
+create_file(filename: 'spec/spec_helper.rb', content: spec_helper_content)
+create_file(filename: 'spec/soap_spec.rb', content: soap_spec_content)
+create_folder 'template'
+create_file(filename: 'template/soap_template.xml', content: soap_template_content)
+create_folder 'logs'
+
+puts "Run 'bundle install' to install necessary gems"
+puts "Run 'rake spec' to run the tests"