soaspec 0.0.5 → 0.0.6

data/README.md

@@ -1,42 +1,51 @@
-# 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. 
-
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'soaspec'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install soaspec
-
-## Usage
-
-See specs for example of usage. This will be added to later. 
-
-## 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 convience methods for building classes for each SOAP or REST operation
+Potentially have in built use of vcr and http_stub gems
+
+## Usage
+
+See specs for example of usage. This will be added to later. 
+
+It is recommended that a class be created representing a Web Service Operation or REST call. Then tests refer back to 
+that class. See get_weather_web_service class in spec/soaspec/soap folder for example
+
+## 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,17 +1,20 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:run_spec) do |t|
-  t.pattern = "spec/*/#{ENV['test_name']}*_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
+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/exe/soaspec-init

@@ -1,142 +1,142 @@
-#!/usr/bin/env ruby
-
-require 'soaspec'
-require 'fileutils'
-
-def create_file(options)
-  filename = options[:filename]
-  fail 'Need to pass filename' unless filename
-  content = options[:content]
-  fail 'Need to pass contents to insert into file' unless content
-  if File.exist? filename
-    old_content = File.read(filename)
-    if old_content != content
-      $stderr.puts "!! #{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 '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'
-
-EOF
-
-soap_spec_content = <<-EOF
-require 'spec_helper'
-
-soap_example = Soaspec::BasicSoapHandler.new('Courier post',
-                                              wsdl: 'http://www.webservicex.com/globalweather.asmx?wsdl')
-soap_example.namespaces = { 'ns1' => 'http://www.webserviceX.NET' }
-soap_example.default_operation = :get_weather
-soap_example.template_name = 'soap_template'
-
-RSpec.context soap_example do
-  describe Exchange.new(:default) do
-    it { is_expected.to contain 'Data Not Found' }
-    it_behaves_like 'success scenario'
-  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
-
-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 'spec'
-create_folder 'template'
-create_folder 'logs'
-create_file(filename: 'spec/spec_helper.rb', content: spec_helper_content)
-create_file(filename: 'spec/soap_spec.rb', content: soap_spec_content)
-create_file(filename: 'template/soap_template.xml', content: soap_template_content)
+#!/usr/bin/env ruby
+
+require 'soaspec'
+require 'fileutils'
+
+def create_file(options)
+  filename = options[:filename]
+  fail 'Need to pass filename' unless filename
+  content = options[:content]
+  fail 'Need to pass contents to insert into file' unless content
+  if File.exist? filename
+    old_content = File.read(filename)
+    if old_content != content
+      $stderr.puts "!! #{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 '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'
+
+EOF
+
+soap_spec_content = <<-EOF
+require 'spec_helper'
+
+soap_example = Soaspec::BasicSoapHandler.new('Courier post',
+                                              wsdl: 'http://www.webservicex.com/globalweather.asmx?wsdl')
+soap_example.namespaces = { 'ns1' => 'http://www.webserviceX.NET' }
+soap_example.default_operation = :get_weather
+soap_example.template_name = 'soap_template'
+
+RSpec.context soap_example do
+  describe Exchange.new(:default) do
+    it { is_expected.to contain 'Data Not Found' }
+    it_behaves_like 'success scenario'
+  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
+
+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 'spec'
+create_folder 'template'
+create_folder 'logs'
+create_file(filename: 'spec/spec_helper.rb', content: spec_helper_content)
+create_file(filename: 'spec/soap_spec.rb', content: soap_spec_content)
+create_file(filename: 'template/soap_template.xml', content: soap_template_content)