soap-object 0.6.7 → 0.6.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 26ae0f7d6449c9ece08643e7b5869428bd6fecbf
-  data.tar.gz: 759d9adccbd16e16153a1c2a13c12ff4a2f51180
+  metadata.gz: c671cc72ababce59652396a4576c798e29b0a69a
+  data.tar.gz: 13de68c610f9ec82da27ed29c52de2a51fa51471
 SHA512:
-  metadata.gz: 4f432712ceeebb9ccd8f6afcf990b3f7958800867a8ee1e83f31952dd8e4c000eee13500d9782593436045bc902f46699650ddfd3e59317973948af71f1472f3
-  data.tar.gz: 94ab0a0541699d2b78a8f098ee53307eef533e138fc37c3988d1b973182bf3a27207c2ab89d861e0deafb1f3c61b7907a55b7317d9395939ad1b37af0cdcaed1
+  metadata.gz: 8d276efccddab68a8a49f92905bc083324d398a46c655132c13e14fc60bb7d7d7aa275f95ca80922e47cef1d1e6fbe99362272c49925ecc4be3c21cdc34d30d0
+  data.tar.gz: c7d57dac679b88423f18f092a834c1dc9e6c17ae898f9b7cfe863f37e2a1a2aaf0bbbeef35661bb6bc07f5796f1c755b42176443ec65b6bc13f9988d0e2ff664

data/.gitignore

@@ -18,3 +18,4 @@ tmp
 *.swp
 TAGS
 .idea/
+.DS_Store

data/README.md

@@ -1,4 +1,4 @@
-# Soap::Object
+# SoapObject
 
 Module to make it simpler to tests SOAP web services.  The goal is
 to abstract all information about how your call and parse results

data/Rakefile

@@ -11,7 +11,11 @@ end
 task :spec
 
 Cucumber::Rake::Task.new(:features, "Run all features") do |t|
-  t.profile = 'focus'
+  t.profile = 'default'
+end
+
+Cucumber::Rake::Task.new(:wip, "Wip features") do |t|
+  t.profile = 'wip'
 end
 
 desc 'Run all specs and features'

data/cucumber.yml

@@ -2,5 +2,5 @@
 std_opts = "--no-source --color --format pretty"
 %>
 
-default: <%= std_opts %> 
-focus: <%= std_opts %> --tags @focus
+default: <%= std_opts %>
+wip: <%= std_opts %> --tags @wip

data/features/core_functionality.feature

@@ -0,0 +1,24 @@
+Feature: This describes the core functionality of the SoapObject object
+
+  Scenario: Establishing communications with remote wsdl
+    Given I have the url for a remote wsdl
+    When I create an instance of the SoapObject class
+    Then I should have a connection
+
+  Scenario: Establishing communications with a local wsdl
+    Given I have a wsdl file residing locally
+    When I create an instance of the SoapObject class
+    Then I should have a connection
+
+  Scenario: Providing operations when using wsdl
+    Given I have the url for a remote wsdl
+    When I create an instance of the SoapObject class
+    Then I should be able to determine the operations
+
+  Scenario Outline: Calling a service with a remote wsdl
+    When I use a SoapObject with a remote wsdl named "<soap-object>"
+    Then I should be able to successfully call "<operation>" with "<args>"
+    Examples:
+      | soap-object    | operation         | args   |
+      | DefineService  | definition_for    | Cheese |
+      | ZipCodeService | get_zip_code_info | 44114  |

data/features/response_functionality.feature

@@ -0,0 +1,21 @@
+Feature: Functionality to parse the response from the SoapObject call
+
+  Scenario: Getting the xml from a response
+    Given I use a SoapObject with a remote wsdl named "ZipCodeService"
+    When I get the information for zip code "44114"
+    Then the results xml should contain "<STATE>OH"
+
+  Scenario: Getting the doc from a response as a Nokogiri object
+    Given I use a SoapObject with a remote wsdl named "ZipCodeService"
+    When I get the information for zip code "44114"
+    And the results doc should be a Nokogiri XML object
+
+  Scenario: Getting a hash from the response
+    Given I use a SoapObject with a remote wsdl named "ZipCodeService"
+    When I get the information for zip code "44114"
+    Then I should be able access the correct response from a hash
+
+  Scenario: Using xpath to parse the response
+    Given I use a SoapObject with a remote wsdl named "ZipCodeService"
+    When I get the information for zip code "44114"
+    Then I should be able access the correct response by xpath

data/features/step_definitions/core_functionality_steps.rb

@@ -0,0 +1,28 @@
+Given /^I have the url for a remote wsdl$/ do
+  @cls = ZipCodeService
+end
+
+Given /^I have a wsdl file residing locally$/ do
+  @cls = LocalWsdlService
+end
+
+Given /^I use a SoapObject with a remote wsdl named "(.*?)"$/ do |service_class|
+  @cls = Object.const_get(service_class)
+end
+
+When /^I create an instance of the SoapObject class$/ do
+  using(@cls)
+end
+
+Then /^I should have a connection$/ do
+  expect(using(@cls)).to be_connected
+end
+
+Then /^I should be able to determine the operations$/ do
+  operations = using(@cls).operations
+  expect(operations).to include :get_info_by_zip
+end
+
+Then /^I should be able to successfully call "(.*?)" with "(.*?)"$/ do |operation, args|
+  using(@cls).send(operation, args)
+end

data/features/step_definitions/response_steps.rb

@@ -0,0 +1,35 @@
+When(/^I get the information for zip code "([^"]*)"$/) do |zip_code|
+  sleep 0.5 #throttle requests to remote wsdl
+  using(@cls).get_zip_code_info(zip_code)
+end
+
+Then /^the results xml should contain "(.*?)"$/ do |xml|
+  using(@cls) do |so|
+    xml_response = so.to_xml
+    expect(xml_response).to be_an_instance_of(String)
+    expect(xml_response).to include xml
+  end
+end
+
+Then /^the results doc should be a Nokogiri XML object$/ do
+  using(@cls) do |so|
+    expect(so.doc).to be_instance_of Nokogiri::XML::Document
+  end
+end
+
+Then /^I should be able access the correct response from a hash$/ do
+  using(@cls) do |so|
+    expect(so.body).to be_an_instance_of(Hash)
+    expect(so.state).to eq('OH')
+    expect(so.city).to eq('Cleveland')
+    expect(so.area_code).to eq('216')
+  end
+end
+
+Then(/^I should be able access the correct response by xpath$/) do
+  using(@cls) do |so|
+    expect(so.xpath('//Table/STATE').first.text).to eq('OH')
+    expect(so.xpath('//Table/CITY').first.text).to eq('Cleveland')
+    expect(so.xpath('//Table/AREA_CODE').first.text).to eq('216')
+  end
+end

data/features/support/env.rb

@@ -3,3 +3,5 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
 require 'rspec/expectations'
 require 'soap-object'
 require 'nokogiri'
+
+World(SoapObject::Factory)

data/features/support/services/define_service.rb

@@ -0,0 +1,9 @@
+class DefineService
+  include SoapObject
+
+  wsdl "http://services.aonaware.com/DictService/DictService.asmx?WSDL"
+
+  def definition_for(word)
+    define word: word
+  end
+end

data/features/support/services/local_wsdl_service.rb

@@ -0,0 +1,5 @@
+class LocalWsdlService
+  include SoapObject
+
+  wsdl "#{File.dirname(__FILE__)}/../wsdl/uszip.asmx.wsdl"
+end

data/features/support/services/zip_code_service.rb

@@ -0,0 +1,28 @@
+class ZipCodeService
+  include SoapObject
+
+  wsdl 'http://www.webservicex.net/uszip.asmx?WSDL'
+  log_level :error
+
+  def get_zip_code_info(zip_code)
+    get_info_by_zip 'USZip' => zip_code
+  end
+
+  def state
+    message[:state]
+  end
+
+  def city
+    message[:city]
+  end
+
+  def area_code
+    message[:area_code]
+  end
+
+  private
+
+  def message
+    body[:get_info_by_zip_response][:get_info_by_zip_result][:new_data_set][:table]
+  end
+end

data/lib/soap-object.rb

@@ -1,9 +1,9 @@
 require 'savon'
-require 'cgi'
 require 'soap-object/version'
 require 'soap-object/class_methods'
 require 'soap-object/ssl_options'
 require 'soap-object/factory'
+require 'soap-object/response'
 
 #
 # module to make it simpler to tests SOAP web services.  The goal is
@@ -34,6 +34,8 @@ require 'soap-object/factory'
 # view all of the options.
 #
 module SoapObject
+  include Response
+
   attr_reader :wsdl, :response
 
   def initialize(platform)
@@ -60,61 +62,26 @@ module SoapObject
     @client.operations
   end
 
-  #
-  # Return the xml response
-  #
-  def to_xml
-    response.to_xml
-  end
-
-  #
-  # Return value at xpath
-  #
-  def xpath(path)
-    response.xpath(path)
-  end
-
-  #
-  # Return the response as a Hash
-  #
-  def to_hash
-    response.hash
-  end
-
-  #
-  # Return the body of the message as a Hash
-  #
-  def body
-    response.body
-  end
-
-  #
-  # Return the response as a Nokogiri document
-  #
-  def doc
-    response.doc
-  end
-
   private
   DEFAULT_PROPERTIES = {log: false,
                          ssl_verify_mode: :none,
                          ssl_version: :SSLv3}
 
-  def method_missing(*args)
-    operation =args.shift
-    message = args.shift
-    type = message.is_a?(String) ? :xml : :message
-    call(operation, {type => message})
+  def method_missing(operation, body)
+    request = build_request(body)
+    @response = @client.call(operation, request)
+    response.to_xml
   end
 
-  def call(operation, data)
-    @response = @client.call(operation, data)
-    response.to_xml
+  def build_request(body)
+    type = body.is_a?(Hash) ? :message : :xml
+    {type => body}
   end
 
   def client_properties
     properties = DEFAULT_PROPERTIES
      [:with_wsdl,
+     :with_endpoint,
      :with_proxy,
      :with_open_timeout,
      :with_read_timeout,

data/lib/soap-object/class_methods.rb

@@ -16,6 +16,18 @@ module SoapObject
       end
     end
 
+    #
+    # Override the endpoint binding in the WSDL 
+    #
+    # @param [String] The target namespace is used to namespace the SOAP message.
+    #
+    def endpoint(url)
+      define_method(:with_endpoint) do
+        {endpoint: url}
+      end
+    end
+
+
     #
     # Set a proxy server to be used.  This will be used for retrieving
     # the wsdl as well as making the remote requests.

data/lib/soap-object/response.rb

@@ -0,0 +1,39 @@
+module SoapObject
+  module Response
+
+    #
+    # Return the xml response
+    #
+    def to_xml
+      response.to_xml
+    end
+
+    #
+    # Return value at xpath
+    #
+    def xpath(path)
+      response.xpath(path)
+    end
+
+    #
+    # Return the response as a Hash
+    #
+    def to_hash
+      response.hash
+    end
+
+    #
+    # Return the body of the message as a Hash
+    #
+    def body
+      response.body
+    end
+
+    #
+    # Return the response as a Nokogiri document
+    #
+    def doc
+      response.doc
+    end
+  end
+end

data/lib/soap-object/version.rb

@@ -1,3 +1,3 @@
 module SoapObject
-    VERSION = "0.6.7"
+    VERSION = "0.6.8"
 end

data/spec/lib/client_options_spec.rb

@@ -1,24 +1,5 @@
 require 'spec_helper'
 
-class TestSoapObjectWithProperties
-  include SoapObject
-
-  wsdl 'http://blah.com'
-  proxy 'http://proxy.com:8080'
-  open_timeout 10
-  read_timeout 20
-  soap_header 'Token' => 'secret'
-  encoding 'UTF-16'
-  basic_auth 'steve', 'secret'
-  digest_auth 'digest', 'auth'
-  log_level :error
-  soap_version 2
-end
-
-class WithoutClientProperties
-  include SoapObject
-end
-
 describe SoapObject do
   let(:client) { double('client') }
   let(:platform) {double('savon')}
@@ -41,6 +22,12 @@ describe SoapObject do
       TestSoapObjectWithProperties.new(platform)
     end
 
+    it 'should allow one to override the endpoint' do
+      expect(platform).to receive(:client).with(hash_including(endpoint: 'https://blah.com'))
+
+      TestSoapObjectWithProperties.new(platform)
+    end
+
     it 'should allow one to setup a proxy' do
       expect(platform).to receive(:client).with(hash_including(proxy: 'http://proxy.com:8080'))
 

data/spec/lib/factory_spec.rb

@@ -1,15 +1,5 @@
 require 'spec_helper'
 
-class TestSoapObject
-  include SoapObject
-
-  wsdl 'http://blah.com'
-end
-
-class TestWorld
-  include SoapObject::Factory
-end
-
 describe SoapObject::Factory do
   context "when using the factory to create to service" do
     let(:world) { TestWorld.new }

data/spec/lib/soap_object_spec.rb

@@ -1,9 +1,5 @@
 require 'spec_helper'
 
-class WithoutClientProperties
-  include SoapObject
-end
-
 describe SoapObject do
 
   context 'when calling methods on the service' do
@@ -13,8 +9,9 @@ describe SoapObject do
     let(:subject) { WithoutClientProperties.new(platform) }
 
     before do
-      expect(platform).to receive(:client).and_return(client)
-      expect(response).to receive(:to_xml)
+      allow(platform).to receive(:client).and_return(client)
+      allow(client).to receive(:call).with(anything, anything).and_return(response)
+      allow(response).to receive(:to_xml)
     end
 
     it 'should make a valid request' do
@@ -22,10 +19,19 @@ describe SoapObject do
       subject.fake_call data_key: 'some_value'
     end
 
+    it 'should return the repsonse as xml' do
+      expected_xml = '<xml><envelope/><data></data></envelope></xml>'
+      expect(response).to receive(:to_xml).and_return(expected_xml)
+      response = subject.fake_call data_key: 'some_value'
+      expect(response).to eq(expected_xml)
+    end
+
     it 'should make a valid request with custom xml' do
       expected_xml = '<xml><envelope/><data></data></envelope></xml>'
-      expect(client).to receive(:call).with(anything, xml: expected_xml).and_return(response)
+      expect(client).to receive(:call).with(:fake_call, xml: expected_xml).and_return(response)
       subject.fake_call expected_xml
     end
+
+
   end
 end

data/spec/lib/ssl_options_spec.rb

@@ -1,15 +1,5 @@
 require 'spec_helper'
 
-class WithSslOptions
-  include SoapObject
-
-  ssl_options do |opts|
-    opts.verify_mode = :peer
-    opts.version = :SSLv2
-  end
-
-end
-
 describe SoapObject do
   let(:client) { double('client') }
   let(:platform) {double('savon')}

data/spec/spec_helper.rb

@@ -4,3 +4,42 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'rspec'
 require 'soap-object'
 
+class TestWorld
+  include SoapObject::Factory
+end
+
+class TestSoapObjectWithProperties
+  include SoapObject
+
+  wsdl 'http://blah.com'
+  endpoint 'https://blah.com'
+  proxy 'http://proxy.com:8080'
+  open_timeout 10
+  read_timeout 20
+  soap_header 'Token' => 'secret'
+  encoding 'UTF-16'
+  basic_auth 'steve', 'secret'
+  digest_auth 'digest', 'auth'
+  log_level :error
+  soap_version 2
+end
+
+class WithoutClientProperties
+  include SoapObject
+end
+
+class TestSoapObject
+  include SoapObject
+
+  wsdl 'http://blah.com'
+end
+
+class WithSslOptions
+  include SoapObject
+
+  ssl_options do |opts|
+    opts.verify_mode = :peer
+    opts.version = :SSLv2
+  end
+
+end

metadata

@@ -1,56 +1,56 @@
 --- !ruby/object:Gem::Specification
 name: soap-object
 version: !ruby/object:Gem::Version
-  version: 0.6.7
+  version: 0.6.8
 platform: ruby
 authors:
 - Jeffrey S. Morgan
 - Doug Morgan
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-10-24 00:00:00.000000000 Z
+date: 2020-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.12.0
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.0
 description: Wrapper around SOAP service calls to make it easy to test
@@ -61,10 +61,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .ruby-gemset
-- .ruby-version
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
 - ChangeLog
 - Gemfile
 - Guardfile
@@ -72,13 +72,19 @@ files:
 - README.md
 - Rakefile
 - cucumber.yml
-- features/basic_functionality.feature
-- features/step_definitions/basic_functionality_steps.rb
+- features/core_functionality.feature
+- features/response_functionality.feature
+- features/step_definitions/core_functionality_steps.rb
+- features/step_definitions/response_steps.rb
 - features/support/env.rb
+- features/support/services/define_service.rb
+- features/support/services/local_wsdl_service.rb
+- features/support/services/zip_code_service.rb
 - features/wsdl/uszip.asmx.wsdl.xml
 - lib/soap-object.rb
 - lib/soap-object/class_methods.rb
 - lib/soap-object/factory.rb
+- lib/soap-object/response.rb
 - lib/soap-object/ssl_options.rb
 - lib/soap-object/version.rb
 - soap-object.gemspec
@@ -90,30 +96,35 @@ files:
 homepage: http://github.com/cheezy/soap-object
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.6.14.1
+signing_key:
 specification_version: 4
 summary: Wrapper around SOAP service calls to make it easy to test
 test_files:
-- features/basic_functionality.feature
-- features/step_definitions/basic_functionality_steps.rb
+- features/core_functionality.feature
+- features/response_functionality.feature
+- features/step_definitions/core_functionality_steps.rb
+- features/step_definitions/response_steps.rb
 - features/support/env.rb
+- features/support/services/define_service.rb
+- features/support/services/local_wsdl_service.rb
+- features/support/services/zip_code_service.rb
 - features/wsdl/uszip.asmx.wsdl.xml
 - spec/lib/client_options_spec.rb
 - spec/lib/factory_spec.rb

data/features/basic_functionality.feature

@@ -1,40 +0,0 @@
-@focus
-Feature: This describes the core functionality of the SoapObject object
-
-  Scenario: Establishing communications with remote wsdl
-    Given I have the url for a remote wsdl
-    When I create an instance of the SoapObject class
-    Then I should have a connection
-
-  Scenario: Establishing communications with a local wsdl
-    Given I have a wsdl file residing locally
-    When I create an instance of the SoapObject class
-    Then I should have a connection
-
-  Scenario: Providing operations when using wsdl
-    Given I have the url for a remote wsdl
-    When I create an instance of the SoapObject class
-    Then I should be able to determine the operations
-
-  Scenario: Calling a service when using wsdl
-    Given I have the url for a remote wsdl
-    When I create an instance of the SoapObject class
-    Then I should be able to make a call and receive the correct results
-
-  Scenario: Getting the xml from a response
-    Given I have the url for a remote wsdl
-    When I create an instance of the SoapObject class
-    Then I should be able to make a call and receive the correct results
-    And the results xml should contain "<STATE>CA"
-
-  Scenario: Getting the doc from a response as a Nokogiri object
-    Given I have the url for a remote wsdl
-    When I create an instance of the SoapObject class
-    Then I should be able to make a call and receive the correct results
-    And the results doc should be a Nokogiri XML object
-
-  Scenario: Calling another service with wsdl
-    Given I am calling the Define service
-    When I create an instance of the SoapObject class
-    Then I should be able to get the correct definition results
-

data/features/step_definitions/basic_functionality_steps.rb

@@ -1,89 +0,0 @@
-class TestServiceWithWsdl
-  include SoapObject
-
-  wsdl 'http://www.webservicex.net/uszip.asmx?WSDL'
-  log_level :error
-
-  def get_zip_code_info(zip_code)
-    get_info_by_zip 'USZip' => zip_code
-  end
-
-  def state
-    message[:state]
-  end
-
-  def city
-    message[:city]
-  end
-
-  def area_code
-    message[:area_code]
-  end
-
-  private
-
-  def message
-    body[:get_info_by_zip_response][:get_info_by_zip_result][:new_data_set][:table]
-  end
-end
-
-class TestServiceWithLocalWsdl
-  include SoapObject
-
-  wsdl "#{File.dirname(__FILE__)}/../wsdl/uszip.asmx.wsdl"
-end
-
-class TestDefineService
-  include SoapObject
-
-  wsdl "http://services.aonaware.com/DictService/DictService.asmx?WSDL"
-  log_level :error
-
-  def definition_for(word)
-    define word: word
-  end
-end
-
-
-Given /^I have the url for a remote wsdl$/ do
-  @cls = TestServiceWithWsdl
-end
-
-Given /^I have a wsdl file residing locally$/ do
-  @cls = TestServiceWithLocalWsdl
-end
-
-When /^I create an instance of the SoapObject class$/ do
-  @so = @cls.new(Savon)
-end
-
-Then /^I should have a connection$/ do
-  expect(@so).to be_connected
-end
-
-Then /^I should be able to determine the operations$/ do
-  expect(@so.operations).to include :get_info_by_zip
-end
-
-Then /^I should be able to make a call and receive the correct results$/ do
-  @so.get_zip_code_info(90210)
-  expect(@so.state).to eq('CA')
-  expect(@so.city).to  eq('Beverly Hills')
-  expect(@so.area_code).to eq('310')
-end
-
-Then /^the results xml should contain "(.*?)"$/ do |xml|
-  expect(@so.to_xml).to include xml
-end
-
-Then /^the results doc should be a Nokogiri XML object$/ do
-  expect(@so.doc).to be_instance_of Nokogiri::XML::Document
-end
-
-Given /^I am calling the Define service$/ do
-  @cls = TestDefineService
-end
-
-Then /^I should be able to get the correct definition results$/ do
-  @so.definition_for 'Cheese'
-end