soaspec 0.1.6 → 0.1.7

data/Gemfile

@@ -1,6 +1,6 @@
-source "https://rubygems.org"
-
-git_source(:gitlab) { |repo_name| "https://gitlab.com/samuel-garratt/soaspec" }
-
-# Specify your gem's dependencies in soaspec.gemspec
-gemspec
+source "https://rubygems.org"
+
+git_source(:gitlab) { |repo_name| "https://gitlab.com/samuel-garratt/soaspec" }
+
+# Specify your gem's dependencies in soaspec.gemspec
+gemspec

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,113 +1,113 @@
-# 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.
-
-[![Build Status](https://gitlab.com/samuel-garratt/soaspec/badges/master/build.svg)](https://gitlab.com/samuel-garratt/soaspec/pipelines)
-[![Coverage](https://gitlab.com/samuel-garratt/soaspec/badges/master/coverage.svg)](https://samuel-garratt.gitlab.io/soaspec)
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'soaspec'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install soaspec
-
-[Things to be done](Todo.md)
-
-## Getting Started
-
-To create a new test suite using this you can use the 'soaspec' binary.
-
-Example:
-
-```
-mkdir 'api_test'
-cd 'api_test'
-soaspec new
-bundle install
-```
-
-Then you can run the tests with:
-
-```
-rake spec
-```
-
-You can also use `soaspec generate` to generate a set of tests from a WSDL. This is still in trial period and will be finished probably after Savon 3 is more stable.
-
-## Usage
-
-* SOAP - this uses Savon behind the scenes. Some defaults are overridden. Please see 'soap_handler.rb'-'default_options' method
-for such defaults. When describing an API override this in 'savon_options' method  
-* REST - this uses the resource class from the Rest-Client gem behind the scenes.
-
-See specs for example of usage. This will be added to later. 
-
-Basically you create a class inheriting from a ‘Handler’ class for each web service that’s tested.
-In this class you define the common parameters used for testing this class.
-
-For example:
-
-```ruby
-class PuppyService < Soaspec::RestHandler
-
-  headers accept: 'application/json', content_type: 'application/json'
-
-  base_url 'http://petstore.swagger.io/v2/pet'
-
-  element :id, :id
-  element :category_id, '$..category.id'
-end
-```
-
-Then you reference this class in creating `Exchange`’s (representing a request / response pair).
-Upon initialization of the Exchange object or later on through setters, parameters specific to this request are set
-All getters of the Exchange are on the response & will implicitly trigger the API request to be made.
-
-For example:
-
-```ruby
-context PuppyService.new('Order Puppies') do
-  describe post(:create_pet, body: { status: 'sold' }) do # Post with status as sold in request
-    its(['status']) { is_expected.to eq 'sold' } # Check responses status is sold
-  end
-end
-```
-
-### Recommended
-
-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.
+
+[![Build Status](https://gitlab.com/samuel-garratt/soaspec/badges/master/build.svg)](https://gitlab.com/samuel-garratt/soaspec/pipelines)
+[![Coverage](https://gitlab.com/samuel-garratt/soaspec/badges/master/coverage.svg)](https://samuel-garratt.gitlab.io/soaspec)
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'soaspec'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install soaspec
+
+[Things to be done](Todo.md)
+
+## Getting Started
+
+To create a new test suite using this you can use the 'soaspec' binary.
+
+Example:
+
+```
+mkdir 'api_test'
+cd 'api_test'
+soaspec new
+bundle install
+```
+
+Then you can run the tests with:
+
+```
+rake spec
+```
+
+You can also use `soaspec generate` to generate a set of tests from a WSDL. This is still in trial period and will be finished probably after Savon 3 is more stable.
+
+## Usage
+
+* SOAP - this uses Savon behind the scenes. Some defaults are overridden. Please see 'soap_handler.rb'-'default_options' method
+for such defaults. When describing an API override this in 'savon_options' method  
+* REST - this uses the resource class from the Rest-Client gem behind the scenes.
+
+See specs for example of usage. This will be added to later. 
+
+Basically you create a class inheriting from a ‘Handler’ class for each web service that’s tested.
+In this class you define the common parameters used for testing this class.
+
+For example:
+
+```ruby
+class PuppyService < Soaspec::RestHandler
+
+  headers accept: 'application/json', content_type: 'application/json'
+
+  base_url 'http://petstore.swagger.io/v2/pet'
+
+  element :id, :id
+  element :category_id, '$..category.id'
+end
+```
+
+Then you reference this class in creating `Exchange`’s (representing a request / response pair).
+Upon initialization of the Exchange object or later on through setters, parameters specific to this request are set
+All getters of the Exchange are on the response & will implicitly trigger the API request to be made.
+
+For example:
+
+```ruby
+context PuppyService.new('Order Puppies') do
+  describe post(:create_pet, body: { status: 'sold' }) do # Post with status as sold in request
+    its(['status']) { is_expected.to eq 'sold' } # Check responses status is sold
+  end
+end
+```
+
+### Recommended
+
+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,24 +1,24 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require 'rake/clean'
-
-ENV['folder'] ||= ''
-ENV['test'] ||= ''
-
-desc 'Run tests'
-RSpec::Core::RakeTask.new(spec: %i[clean clobber start_test_server]) do |t|
-  t.pattern = "spec/**/#{ENV['folder']}*/#{ENV['test']}*_spec.rb"
-end
-
-task default: :spec
-
-CLEAN.include 'tmp/*'
-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
-  sleep 2 # Wait a little for virtual server to start up
-  puts 'Running test server at pid ' + ENV['test_server_pid']
-end
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rake/clean'
+
+ENV['folder'] ||= ''
+ENV['test'] ||= ''
+
+desc 'Run tests'
+RSpec::Core::RakeTask.new(spec: %i[clean clobber start_test_server]) do |t|
+  t.pattern = "spec/**/#{ENV['folder']}*/#{ENV['test']}*_spec.rb"
+end
+
+task default: :spec
+
+CLEAN.include 'tmp/*'
+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
+  sleep 2 # Wait a little for virtual server to start up
+  puts 'Running test server at pid ' + ENV['test_server_pid']
+end

data/Todo.md

@@ -1,6 +1,6 @@
-* Give examples and convenience methods for building classes for each SOAP or REST operation
-  * For SOAP give example of basic_auth
-* Potentially have in built use of 'vcr' and 'http_stub' gems
-* Handle proxies to record traffic for MiddleWare testing
-* Get wsdl generator working for non complex gems (Put on hold til new Savon version)
-* Much more - please raise an issue for suggestion
+* Give examples and convenience methods for building classes for each SOAP or REST operation
+  * For SOAP give example of basic_auth
+* Potentially have in built use of 'vcr' and 'http_stub' gems
+* Handle proxies to record traffic for MiddleWare testing
+* Get wsdl generator working for non complex gems (Put on hold til new Savon version)
+* Much more - please raise an issue for suggestion

data/exe/soaspec

@@ -1,110 +1,110 @@
-#!/usr/bin/env ruby
-
-
-require 'thor'
-$LOAD_PATH.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
-require 'savon'
-require 'soaspec'
-
-module Soaspec
-
-  # Common executable for Soaspec
-  class Exe < Thor
-
-    include Soaspec::ExeHelpers
-    include Soaspec::WsdlGenerator
-
-    long_desc <<-LONGDESC
-    `soaspec new` will generate the initial files and folders for starting a testing project using soaspec
-    \x5
-
-    `soaspec new soap` will create example files testing against a virtual SOAP service
-    \x5
-
-    `soaspec new rest` will create example files testing against a virtual REST service
-    LONGDESC
-    desc 'new [type]', 'Initialize soaspec repository'
-    option :ci, default: 'jenkins', banner: 'What Continuous Integration is used'
-    option :virtual, type: :boolean, default: true, banner: 'Whether to set things up for a virtual server'
-    def new(type = 'initial')
-      @virtual = options[:virtual]
-      puts "Creating files for soaspec. options are #{options}"
-      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')
-      if type == 'soap'
-        create_file filename: 'lib/blz_service.rb'
-        create_file filename: 'lib/shared_example.rb'
-      end
-      create_file(filename: 'config/data/default.yml')
-      create_file(filename: 'spec/spec_helper.rb')
-      create_file(filename: 'spec/soap_spec.rb') if type == 'soap'
-      create_file(filename: 'template/soap_template.xml', erb: false) if type == 'soap'
-      create_folder 'logs'
-
-      puts "Run 'bundle install' to install necessary gems"
-      puts "Run 'rake spec' to run the tests"
-    end
-
-    desc 'generate', 'Generate initial test code from wsdl'
-    long_desc <<-LONGDESC
-    `soaspec generate wsdl=wsdl name=ServiceName ` will generate the initial files and folders to test each operation in a wsdl
-    \x5
-    Additionally the auth parameter can be used to use basic authentication to retrieve the WSDL.
-    To do use the following `soaspec generate --auth=basic`
-
-    LONGDESC
-    option :wsdl, required: true, aliases: :w
-    option :name, default: 'Service', aliases: :n
-    option :ci, default: 'jenkins', banner: 'What Continuous Integration is used'
-    option :auth
-    option :string_default, default: 'test string'
-    def generate
-      enter_auth_details if options[:auth] == 'basic'
-      @virtual = false
-      savon_options = { wsdl: options[:wsdl] }
-      savon_options[:basic_auth] = [@auth_name, @auth_password] if options[:auth] == 'basic'
-
-      @wsdl_doc = Savon.client(**savon_options).wsdl
-      @wsdl_schemas = @wsdl_doc.parser.schemas
-
-      create_file filename: 'Rakefile', ignore_if_present: true
-      create_file filename: 'Gemfile', ignore_if_present: true
-      create_file(filename: '.rspec')
-      create_file(filename: '.travis.yml') if options[:ci] == 'travis'
-      create_file filename: 'README.md', ignore_if_present: true
-      create_file filename: 'spec/spec_helper.rb', ignore_if_present: true
-      create_folder 'logs'
-      create_file filename: "lib/#{options[:name].snakecase}.rb", content: class_content
-
-      # Files according to WSDL
-      @wsdl_doc.operations.each do |operation, details|
-        puts "Creating files for operation: #{operation}"
-        @content = "default:\n"
-        @use_camel_case = false
-        puts 'Message params: ' + details.to_s
-        # From namespace identifier, find namespace, and for that find schemaLocation xsd and use that to build request
-        if details[:parameters]
-          details[:parameters].each do |element, details|
-            @use_camel_case = true if /[[:upper:]]/.match(element.to_s[0]) != nil
-            @content += "  #{element.to_s.snakecase}: #{fill_in_field_from_type(details[:type])} # #{details[:type]} \n"
-            # TODO: If details is a Hash need to loop again
-          end
-        end
-        wsdl_to_yaml_for root_elements_for(details)
-        params = []
-        params << 'convert_request_keys_to: :camelcase' if @use_camel_case
-        params_string = params == [] ? '' : ', ' + params.join(', ')
-        @class_params = "'#{camel_case(operation)}'#{params_string}"
-
-        create_file(filename: "config/data/#{operation}.yml", content: @content)
-        create_file(filename: "spec/#{operation}_spec.rb", content: generated_soap_spec_for(operation))
-      end
-    end
-
-  end
-end
-
+#!/usr/bin/env ruby
+
+
+require 'thor'
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+require 'savon'
+require 'soaspec'
+
+module Soaspec
+
+  # Common executable for Soaspec
+  class Exe < Thor
+
+    include Soaspec::ExeHelpers
+    include Soaspec::WsdlGenerator
+
+    long_desc <<-LONGDESC
+    `soaspec new` will generate the initial files and folders for starting a testing project using soaspec
+    \x5
+
+    `soaspec new soap` will create example files testing against a virtual SOAP service
+    \x5
+
+    `soaspec new rest` will create example files testing against a virtual REST service
+    LONGDESC
+    desc 'new [type]', 'Initialize soaspec repository'
+    option :ci, default: 'jenkins', banner: 'What Continuous Integration is used'
+    option :virtual, type: :boolean, default: true, banner: 'Whether to set things up for a virtual server'
+    def new(type = 'initial')
+      @virtual = options[:virtual]
+      puts "Creating files for soaspec. options are #{options}"
+      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')
+      if type == 'soap'
+        create_file filename: 'lib/blz_service.rb'
+        create_file filename: 'lib/shared_example.rb'
+      end
+      create_file(filename: 'config/data/default.yml')
+      create_file(filename: 'spec/spec_helper.rb')
+      create_file(filename: 'spec/soap_spec.rb') if type == 'soap'
+      create_file(filename: 'template/soap_template.xml', erb: false) if type == 'soap'
+      create_folder 'logs'
+
+      puts "Run 'bundle install' to install necessary gems"
+      puts "Run 'rake spec' to run the tests"
+    end
+
+    desc 'generate', 'Generate initial test code from wsdl'
+    long_desc <<-LONGDESC
+    `soaspec generate wsdl=wsdl name=ServiceName ` will generate the initial files and folders to test each operation in a wsdl
+    \x5
+    Additionally the auth parameter can be used to use basic authentication to retrieve the WSDL.
+    To do use the following `soaspec generate --auth=basic`
+
+    LONGDESC
+    option :wsdl, required: true, aliases: :w
+    option :name, default: 'Service', aliases: :n
+    option :ci, default: 'jenkins', banner: 'What Continuous Integration is used'
+    option :auth
+    option :string_default, default: 'test string'
+    def generate
+      enter_auth_details if options[:auth] == 'basic'
+      @virtual = false
+      savon_options = { wsdl: options[:wsdl] }
+      savon_options[:basic_auth] = [@auth_name, @auth_password] if options[:auth] == 'basic'
+
+      @wsdl_doc = Savon.client(**savon_options).wsdl
+      @wsdl_schemas = @wsdl_doc.parser.schemas
+
+      create_file filename: 'Rakefile', ignore_if_present: true
+      create_file filename: 'Gemfile', ignore_if_present: true
+      create_file(filename: '.rspec')
+      create_file(filename: '.travis.yml') if options[:ci] == 'travis'
+      create_file filename: 'README.md', ignore_if_present: true
+      create_file filename: 'spec/spec_helper.rb', ignore_if_present: true
+      create_folder 'logs'
+      create_file filename: "lib/#{options[:name].snakecase}.rb", content: class_content
+
+      # Files according to WSDL
+      @wsdl_doc.operations.each do |operation, details|
+        puts "Creating files for operation: #{operation}"
+        @content = "default:\n"
+        @use_camel_case = false
+        puts 'Message params: ' + details.to_s
+        # From namespace identifier, find namespace, and for that find schemaLocation xsd and use that to build request
+        if details[:parameters]
+          details[:parameters].each do |element, details|
+            @use_camel_case = true if /[[:upper:]]/.match(element.to_s[0]) != nil
+            @content += "  #{element.to_s.snakecase}: #{fill_in_field_from_type(details[:type])} # #{details[:type]} \n"
+            # TODO: If details is a Hash need to loop again
+          end
+        end
+        wsdl_to_yaml_for root_elements_for(details)
+        params = []
+        params << 'convert_request_keys_to: :camelcase' if @use_camel_case
+        params_string = params == [] ? '' : ', ' + params.join(', ')
+        @class_params = "'#{camel_case(operation)}'#{params_string}"
+
+        create_file(filename: "config/data/#{operation}.yml", content: @content)
+        create_file(filename: "spec/#{operation}_spec.rb", content: generated_soap_spec_for(operation))
+      end
+    end
+
+  end
+end
+
 Soaspec::Exe.start(ARGV)