soaspec 0.2.19 → 0.2.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5da773f49629a9a8f3ed81294f5b313aef067daa
-  data.tar.gz: fd38e2b4f35b1cd9a8335f7a509f8335f807b2c8
+SHA256:
+  metadata.gz: 0f031c3b5588049808871e6fcda16d9381811b18df3cf383f9a777cb82a6fa23
+  data.tar.gz: 5ea7c6cff5d06ed935e43d53f32289c13430a9da8047a946dc84c30ec18994b9
 SHA512:
-  metadata.gz: 6d71b1fc1203a76e112e870482e135dee823cdb55bf17bf38d03c9ec9e834d9cfe65a8de17dd2d86fabe7eb069c122d241918bc5e71324123309db8f19562547
-  data.tar.gz: 1893f9a21d68191ae5e087b9b22eaedd65bdc2a2a0739803211545e8a984f4f22f08e73792aa920e63663663dfbabcec19e87246d39964aa00ee7ccca159f548
+  metadata.gz: 0cd0f0bdc1b1938cdf67e6e3f5c04ec69a9a58d734fd2e815cb8ab9b1cad051618f6a33acc021161ba26715a167ae8b8358bea70889bf5d328c168aed1119251
+  data.tar.gz: 0d3a7087204edf457af446cecc5347f4a7045e3c56d57c1856ab2876ec96570397a2f7fa9b8ef2445c2417c38d409134d0644653cce54b7f699ca1eef2728871

data/ChangeLog

@@ -1,3 +1,7 @@
+Version 0.2.20
+* Enhancement
+  * 'soaspec pry' command to open pry, loading test API classes
+
 Version 0.2.19
 * Enhancement
   * Create 'soaspec generate' (without wsdl) as a way to create an ExchangeHandler from a Web Page

data/exe/soaspec

@@ -4,6 +4,8 @@ require 'thor'
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 require 'savon'
 require 'soaspec'
+require 'soaspec/virtual_server'
+require 'soaspec/wsdl_generator'
 
 module Soaspec
   # Common executable for Soaspec
@@ -86,7 +88,6 @@ module Soaspec
         require 'launchy'
         require 'soaspec/generate_server'
         Soaspec::GenerateServer.run! do
-          sleep 2
           Launchy.open 'http://localhost:8999' if options[:open_browser] == 'true'
         end
       end
@@ -101,6 +102,21 @@ module Soaspec
       require 'soaspec/virtual_server'
       Soaspec::VirtualServer.run!(Port: port)
     end
+
+    long_desc <<-LONGDESC
+    Run pry with Soaspec and other relevant libraries loaded. Pass either the relative path to files desired with a
+    '.rb' extension or the path to the folder to be loaded with 'require_all'
+    LONGDESC
+    desc 'pry [required_files]', 'Run pry with Soaspec and other relevant libraries loaded'
+    def pry(required_files = nil)
+      require 'soaspec'
+
+      require 'require_all'
+      require_all required_files if required_files
+
+      require 'pry'
+      Pry.start
+    end
   end
 end
 

data/lib/soaspec.rb

@@ -25,13 +25,6 @@ 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'
 require 'soaspec/wait'
 
 # Gem for handling SOAP and REST api tests

data/lib/soaspec/exchange/exchange.rb

@@ -83,7 +83,8 @@ class Exchange
     test_name
   end
 
-  # Returns response object from Api. Will make the request if not made and then cache it for later on
+  # @return [RestClient::Response,Savon::Response] Returns response object from Api.
+  #   Will make the request if not made and then cache it for later on
   # @example For SOAP it will be a Savon response
   #   response.body (body of response as Hash)
   #   response.header (head of response as Hash)
@@ -95,5 +96,10 @@ class Exchange
     @response
   end
 
-  alias call response
+  # @return [ResponseObject] Currently returning response object. This will change (in 0.3) to be itself to
+  #   allow easy method chaining
+  def call
+    warn 'This method will be changed to return "Exchange" object in 0.3. Use "response" method if you want the response object'
+    response
+  end
 end

data/lib/soaspec/exe_helpers.rb

@@ -45,18 +45,25 @@ module Soaspec
     # @param [String] filename Name of the file to create
     # @param [String] content Content to place inside file
     # @param [Boolean] ignore_if_present Don't complain if file is present
+    # @return [String] String describing if file created or not
     def create_file(filename: nil, content: nil, ignore_if_present: false, erb: true)
       raise 'Need to pass filename' unless filename
 
       content ||= retrieve_contents(filename, erb)
       create_folder File.split(filename).first
-      if File.exist? filename
-        old_content = File.read(filename)
-        warn "!! #{filename} already exists and differs from template" if old_content != content && !ignore_if_present
-      else
-        File.open(filename, 'w') { |f| f.puts content }
-        puts 'Created: ' + filename
-      end
+      msg = if File.exist? filename
+              old_content = File.read(filename)
+              if old_content != content && !ignore_if_present
+                "!! #{filename} already exists and differs from template"
+              else
+                "#{filename} already exists"
+              end
+            else
+              File.open(filename, 'w') { |f| f.puts content }
+              "Created: #{filename}"
+            end
+      puts msg
+      msg
     end
 
     # Create folder if there's not a file already there.

data/lib/soaspec/generate_server.rb

@@ -6,6 +6,7 @@ module Soaspec
     include Soaspec::ExeHelpers
 
     class << self
+      # @return [Hash] Parameters used when creating handler
       attr_accessor :create_params
     end
 
@@ -22,17 +23,15 @@ module Soaspec
     end
 
     post '/generate' do
-      File.write 'test', params.to_s
-      type = :rest
+      type = :rest # SOAP will be added to later
       @name = params['className']
       @base_url = params['baseUrl']
       filename = File.join('lib', "#{params['className'].snakecase}.rb")
-      create_file filename: filename,
-                  content: retrieve_contents(File.join('lib', "new_#{type}_service.rb"))
+      feedback = create_file filename: filename,
+                             content: retrieve_contents(File.join('lib', "new_#{type}_service.rb"))
       GenerateServer.create_params = params
-      GenerateServer.create_params['feedback'] = "Created file at '#{filename}'"
+      GenerateServer.create_params['feedback'] = feedback
       redirect '/'
-      # params.to_s
     end
   end
-end
+end

data/lib/soaspec/test_server/id_manager.rb

@@ -1,24 +1,33 @@
 module Soaspec
   module TestServer
     # Handles returning ids dependent on a number of factors
-    # Made to demonstrate creating testing a list of ids
+    # Made to demonstrate creating testing a list of ids where a few return false
+    # when not developed and checking each value in the list can find the false value
     class IdManager
+      # @return [Boolean] Whether to simulate a fully developed state where everything is done
       @developed = false
       class << self
         attr_accessor :developed
 
+        # Once developed is set, everything will return true. A 'false' value represents something
+        # not developed
+        # @param [String] num Number representing tester or test number
+        # @param [String] id Id used in test
         # @return  Result depending on num, id and whether '@developed' is set
         def result_for(num, id)
           result = undeveloped_id(num, id) unless @developed
           result || 'true'
         end
 
+        # Idea is that this will return false for a particular id for different test numbers
+        # @param [String] num Number representing tester or test number
+        # @param [String] id Id used in test
         # @return [String] true of false depending on num and id
         def undeveloped_id(num, id)
           case num
           when '1', '4', '10' then 'false' if id == '40'
           when '3', '11', '9' then 'false' if id == '74'
-          when '8', '6', '8' then 'false' if id == '80'
+          when '2', '6', '8' then 'false' if id == '80'
           when '7', '5', '12' then 'false' if id == '64'
           else
             'true'

data/lib/soaspec/version.rb

@@ -1,3 +1,3 @@
 module Soaspec
-  VERSION = '0.2.19'.freeze
+  VERSION = '0.2.20'.freeze
 end

data/lib/soaspec/virtual_server.rb

@@ -6,6 +6,12 @@ require 'nokogiri'
 require 'erb'
 require 'json'
 require 'faker'
+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'
 
 module Soaspec
   # Used to run virtual web service on localhost. This makes tests more reliable and faster

data/lib/soaspec/wsdl_generator.rb

@@ -1,16 +1,18 @@
 module Soaspec
   # Produce test content from a WSDL
   module WsdlGenerator
+    include ExeHelpers
+
     # Generate from WSDL
     def generate_from_wsdl(options)
-      enter_auth_details if options[:auth] == 'basic'
+      auth_name, auth_password = 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
+      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 basic project files
       create_files %w[Rakefile Gemfile README.md spec/spec_helper.rb], ignore_if_present: true
       create_file(filename: '.rspec')
       create_file(filename: '.travis.yml') if options[:ci] == 'travis'
@@ -18,7 +20,7 @@ module Soaspec
       create_file filename: "lib/#{options[:name].snakecase}.rb", content: class_content
 
       # Files according to WSDL
-      @wsdl_doc.operations.each do |operation, op_details|
+      wsdl_doc.operations.each do |operation, op_details|
         puts "Creating files for operation: #{operation}"
         @content = "default:\n"
         @use_camel_case = false
@@ -176,20 +178,22 @@ module Soaspec
     end
 
     # Prompt user to enter basic auth details
+    # @return [Array] Array with Basic auth username and password entered
     def enter_auth_details
       prompt = <<-AUTH_PROMPT
   User Name:
       AUTH_PROMPT
       print prompt.chop
-      @auth_name = $stdin.gets.strip
+      auth_name = $stdin.gets.strip
       puts
 
       prompt = <<-PASSWORD
   User Password:
       PASSWORD
       print prompt.chop
-      @auth_password = $stdin.gets.strip
+      auth_password = $stdin.gets.strip
       puts
+      [auth_name, auth_password]
     end
   end
 end

data/soaspec.gemspec

@@ -29,7 +29,6 @@ the same configuration. Examples designed for RSpec and Cucumber."
   spec.add_development_dependency 'rack'
   spec.add_development_dependency 'rack-test'
   spec.add_development_dependency 'rake', '~> 12.0'
-  spec.add_development_dependency 'require_all', '1.5.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'yard-cucumber'
@@ -40,13 +39,13 @@ the same configuration. Examples designed for RSpec and Cucumber."
   spec.add_dependency 'jsonpath'
   spec.add_dependency 'launchy'
   spec.add_dependency 'nokogiri'
+  spec.add_dependency 'pry'
+  spec.add_dependency 'require_all', '>= 1.5.0'
   spec.add_dependency 'rest-client', '>= 2.0' # REST
   spec.add_dependency 'rspec', '~> 3.0' # This framework is designed to work with RSpec
   spec.add_dependency 'rspec-its'
   spec.add_dependency 'savon', '>= 2' # SOAP
-  # https://github.com/sinatra/sinatra/issues/1514 in 2.0.5 version of Sinatra breaks '?wsdl' a param with no
-  # Only affects Ruby < 2.4
-  spec.add_dependency 'sinatra', '2.0.4'
+  spec.add_dependency 'sinatra', '>= 2.0.4'
   spec.add_dependency 'sinatra-basic-auth'
   spec.add_dependency 'sinatra-docdsl'
   spec.add_dependency 'thor'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: soaspec
 version: !ruby/object:Gem::Version
-  version: 0.2.19
+  version: 0.2.20
 platform: ruby
 authors:
 - SamuelGarrattIQA
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-10 00:00:00.000000000 Z
+date: 2019-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,20 +122,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '12.0'
-- !ruby/object:Gem::Dependency
-  name: require_all
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.5.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.5.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -276,6 +262,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: require_all
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.0
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -336,14 +350,14 @@ dependencies:
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.4
 - !ruby/object:Gem::Dependency
@@ -522,7 +536,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Helps to create tests for 'SOAP' or 'REST' apis