qbwc 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5bbaec3ca34a9a960128b6933f41fc78682d8ba4
-  data.tar.gz: 7738ce71948875a6ea4a44753eddcfa37528ac64
+  metadata.gz: 3ab957ed6ecd97a44a5e2469092553102ae0adcf
+  data.tar.gz: 8391e13ebcc4a9a91c25590519993a446e1ba189
 SHA512:
-  metadata.gz: e8c027bfc0527d79c5b6bb2a5e1c19f68ef7be4ea90a4d0e39a3b111c62a12ac57ef601dac756f0e951887e4de53955a4b681bf5881b9b5e4e66c374c2cf7a0f
-  data.tar.gz: e52f3419dcc33fe1212600038f90586604603953a3c5a07795f8598e9fe55e8ffbc0018dc6fb18f8ea7ebfe72266a09087a174b081cc88a1025cc3a00fe69120
+  metadata.gz: 12dda6d0e3f59b48b26e85199fdd3ead7b74e2e38d78f22392f5b6b662d505083a1498ad71acc2c94518c14a6866dd7f3ed744c46bc95189642572b97940940f
+  data.tar.gz: b23152610874a9065f64d7d0bac9d12aadcfc1a0a2b7094858ae4d5c6f70dfa369964c28aaaba4b7c6f27dd3daffd26b52ad3dbf4d4726d9746b4c3f02365086

data/.gitignore

@@ -3,3 +3,4 @@ Gemfile.lock
 pkg
 .ruby-gemset
 .ruby-version
+gemfiles/*.lock

data/.travis.yml

@@ -1,8 +1,13 @@
 language: ruby
+
 rvm:
-  - 1.9
-  - 2.0
-  - 2.1
   - 2.2
+  - 2.3.5 # https://github.com/travis-ci/travis-ci/issues/5361
+  - 2.4.2
+gemfile:
+  - gemfiles/rails_5.1.gemfile
+  - gemfiles/rails_5.0.gemfile
 before_install:
   - gem update bundler
+
+script: "bundle exec rake test"

data/Appraisals

@@ -0,0 +1,10 @@
+appraise "rails-5.0" do
+  # At least 5.0.1 due to test failures - https://github.com/rails/rails/pull/25950
+  gem "actionpack", "~> 5.0.1"
+  gem "actionview", "~> 5.0.1"
+end
+
+appraise "rails-5.1" do
+  gem "actionpack", "~> 5.1.1"
+  gem "actionview", "~> 5.1.1"
+end

data/CHANGELOG.md

@@ -1,6 +1,20 @@
 
 # Change Log
 
+## [1.1.0](https://github.com/qbwc/qbwc/releases/tag/v1.1.0) (2016-03-02)
+[Full Changelog](https://github.com/qbwc/qbwc/compare/1.0.0...1.1.0)
+
+**Fixed bugs:**
+
+- Support Rails 5. [\#100](https://github.com/qbwc/qbwc/pull/100) ([rchekaluk](https://github.com/rchekaluk)) [\#117](https://github.com/qbwc/qbwc/pull/117) ([lostapathy](https://github.com/lostapathy))
+- Clarify documentation regarding top-level tag in response hash. [\#91](https://github.com/qbwc/qbwc/pull/91)  ([steintr](https://github.com/steintr))
+- Fix Rails 5 deprecations. [\#97](https://github.com/qbwc/qbwc/pull/97) ([nicholejeannine](https://github.com/nicholejeannine))
+
+**New features:**
+
+- Log qbxml_response closer to the top of \#process_response. [\#90](https://github.com/qbwc/qbwc/pull/90) ([steintr](https://github.com/steintr))
+
+
 ## [1.0.0](https://github.com/qbwc/qbwc/releases/tag/v1.0.0) (2016-03-02)
 [Full Changelog](https://github.com/qbwc/qbwc/compare/0.1.0...1.0.0)
 

data/Gemfile

@@ -1,4 +1,4 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in qbwc.gemspec
 gemspec

data/README.md

@@ -72,12 +72,12 @@ To create a job (e.g. from `rails console` or wherever):
 
 ```ruby
 require 'qbwc'
-QBWC.add_job(:list_customers, true, '', CustomerTestWorker)
+QBWC.add_job(:list_customers, true, 'C:\\QuickBooks\\Oceanic.QBW', CustomerTestWorker)
 ```
 
 * The first argument is a unique name for the job. You can use this later to disable or delete the job.
 * The second argument indicates whether the job is initially enabled.
-* The third argument specifies the path to the QuickBooks company file this job affects. An empty string will make the job run against any company file.
+* The third argument specifies the path to the QuickBooks company file this job affects.
 * The fourth argument is your worker class. See the next section for a description of workers.
 
 Your job will be persisted in your database and will remain active and run every time QuickBooks Web Connector runs an update. If you don't want this to happen, you can have have your job disable or delete itself after completion. For example:
@@ -133,7 +133,7 @@ end
 ```
 
 
-Use the [Onscreen Reference for Intuit Software Development Kits](https://developer-static.intuit.com/qbSDK-current/Common/newOSR/index.html) (use Format: qbXML) to see request and response formats to use in your jobs. Use underscored, lowercased versions of all tags (e.g. `customer_query_rq`, not `CustomerQueryRq`).
+Use the [Onscreen Reference for Intuit Software Development Kits](https://developer-static.intuit.com/qbSDK-current/Common/newOSR/index.html) (use Format: qbXML) to see request and response formats to use in your jobs. Use underscored, lowercased versions of all tags (e.g. `customer_query_rq`, not `CustomerQueryRq`).  Note that while requests include the top-level tag (e.g. `customer_query_rq`), the response hash passed to `QBWC::Worker#handle_response` does not include a corresponding top-level tag such as `customer_query_rs` (despite it being in the actual QBXML and shown in the OSR).
 
 ### Defining requests outside of a worker ###
 

data/Rakefile

@@ -1,4 +1,5 @@
 require "bundler/gem_tasks"
+require 'appraisal'
 
 Bundler::GemHelper.install_tasks
 
@@ -6,4 +7,9 @@ require 'rake/testtask'
 Rake::TestTask.new do |t|
   t.pattern = 'test/**/*_test.rb'
 end
-task :default => :test
+
+task :default => :all
+
+task :all do |_t|
+    exec('bundle exec appraisal install && bundle exec rake appraisal test')
+end

data/gemfiles/rails_5.0.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "actionpack", "~> 5.0.1"
+gem "actionview", "~> 5.0.1"
+
+gemspec path: "../"

data/gemfiles/rails_5.1.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "actionpack", "~> 5.1.1"
+gem "actionview", "~> 5.1.1"
+
+gemspec path: "../"

data/lib/generators/qbwc/install/templates/db/migrate/change_request_index.rb

@@ -1,4 +1,4 @@
-class ChangeRequestIndex < ActiveRecord::Migration
+class ChangeRequestIndex < ActiveRecord::Migration[5.0]
   def change
     change_column :qbwc_jobs, :request_index, :text, null: true, default: nil
   end

data/lib/generators/qbwc/install/templates/db/migrate/create_qbwc_jobs.rb

@@ -1,4 +1,4 @@
-class CreateQbwcJobs < ActiveRecord::Migration
+class CreateQbwcJobs < ActiveRecord::Migration[5.0]
   def change
     create_table :qbwc_jobs, :force => true do |t|
       t.string :name

data/lib/generators/qbwc/install/templates/db/migrate/create_qbwc_sessions.rb

@@ -1,4 +1,4 @@
-class CreateQbwcSessions < ActiveRecord::Migration
+class CreateQbwcSessions < ActiveRecord::Migration[5.0]
   def change
     create_table :qbwc_sessions, :force => true do |t|
       t.string :ticket
@@ -8,7 +8,7 @@ class CreateQbwcSessions < ActiveRecord::Migration
       t.string :current_job
       t.string :iterator_id
       t.string :error, :limit => 1000
-      t.string :pending_jobs, :limit => 1000, :null => false, :default => ''
+      t.text :pending_jobs, :null => false, :default => ''
 
       t.timestamps :null => false
     end

data/lib/generators/qbwc/install/templates/db/migrate/index_qbwc_jobs.rb

@@ -1,4 +1,4 @@
-class IndexQbwcJobs < ActiveRecord::Migration
+class IndexQbwcJobs < ActiveRecord::Migration[5.0]
   def change
     add_index :qbwc_jobs, :name, unique: true
     add_index :qbwc_jobs, :company, length: 150

data/lib/generators/qbwc/install/templates/db/migrate/session_pending_jobs_text.rb

@@ -1,4 +1,4 @@
-class SessionPendingJobsText < ActiveRecord::Migration
+class SessionPendingJobsText < ActiveRecord::Migration[5.0]
   def change
     change_column_default(:qbwc_sessions, :pending_jobs, nil)
     change_column :qbwc_sessions, :pending_jobs, :text, :limit => 1000, :null => false

data/lib/qbwc/controller.rb

@@ -9,10 +9,10 @@ module QBWC
 
     def self.included(base)
       base.class_eval do
-        include WashOut::SOAP
-        skip_before_filter :_parse_soap_parameters, :_authenticate_wsse, :_map_soap_parameters, :only => :qwc
-        before_filter :get_session, :except => [:qwc, :authenticate, :_generate_wsdl]
-        after_filter :save_session, :except => [:qwc, :authenticate, :_generate_wsdl, :close_connection, :connection_error]
+        soap_service
+        skip_before_action :_authenticate_wsse, :_map_soap_parameters, :only => :qwc
+        before_action :get_session, :except => [:qwc, :authenticate, :_generate_wsdl]
+        after_action :save_session, :except => [:qwc, :authenticate, :_generate_wsdl, :close_connection, :connection_error]
 
         # wash_out changed the format of app/views/wash_with_soap/rpc/response.builder in commit
         # https://github.com/inossidabile/wash_out/commit/24a77f4a3d874562732c6e8c3a30e8defafea7cb
@@ -77,7 +77,7 @@ SB
    <AppURL>#{qbwc_action_url(:only_path => false)}</AppURL>
    <AppDescription>Quickbooks integration</AppDescription>
    <AppSupport>#{QBWC.support_site_url || root_url(:protocol => 'https://')}</AppSupport>
-   <UserName>#{@username || QBWC.username}</UserName>
+   <UserName>#{QBWC.username}</UserName>
    <OwnerID>#{QBWC.owner_id}</OwnerID>
    <FileID>{#{file_id}}</FileID>
    <QBType>QBFS</QBType>
@@ -85,7 +85,7 @@ SB
    #{scheduler_block}
 </QBWCXML>
 QWC
-      send_data qwc, :filename => "#{@filename || Rails.application.class.parent_name}.qwc", :content_type => 'application/x-qwc'
+      send_data qwc, :filename => "#{Rails.application.class.parent_name}.qwc", :content_type => 'application/x-qwc'
     end
 
     class StringArray < WashOut::Type
@@ -162,7 +162,7 @@ QWC
     end
 
     def app_name
-      "#{Rails.application.class.parent_name} #{Rails.env} #{@app_name_suffix}"
+      "#{Rails.application.class.parent_name} #{Rails.env}"
     end
 
     def file_id

data/lib/qbwc/job.rb

@@ -23,10 +23,10 @@ class QBWC::Job
 
   def process_response(qbxml_response, response, session, advance)
     QBWC.logger.info "Processing response."
+    QBWC.logger.info "Job '#{name}' received response: '#{qbxml_response}'." if QBWC.log_requests_and_responses
     request_list = requests(session)
     completed_request = request_list[request_index(session)] if request_list
     advance_next_request(session) if advance
-    QBWC.logger.info "Job '#{name}' received response: '#{qbxml_response}'." if QBWC.log_requests_and_responses
     worker.handle_response(response, session, self, completed_request, data)
   end
 

data/lib/qbwc/version.rb

@@ -1,3 +1,3 @@
 module QBWC
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/qbwc.gemspec

@@ -22,18 +22,20 @@ Gem::Specification.new do |s|
     "README.md"
   ]
 
+  s.required_ruby_version = '>= 2.2.2'
+
   s.add_dependency "qbxml", [">= 0.3.0"]
-  s.add_dependency "wash_out", [">= 0.7.1"]
+  s.add_dependency "wash_out", ['>=0.12.0']
+  s.add_dependency 'actionpack', ['>= 5.0.1']
 
-  s.add_development_dependency('guard')
-  s.add_development_dependency('guard-rspec')
-  s.add_development_dependency('rb-fsevent')
   s.add_development_dependency('webmock')
   s.add_development_dependency('rspec')
   s.add_development_dependency('activerecord')
-  s.add_development_dependency('actionpack')
-  s.add_development_dependency('rails', [">= 4.1.0"])
+  s.add_development_dependency('rails', [">= 5.0.1"])
   s.add_development_dependency('sqlite3')
   s.add_development_dependency('minitest')
   s.add_development_dependency('rake')
+  s.add_development_dependency('appraisal')
+  s.add_development_dependency('savon')
+  s.add_development_dependency('httpi')
 end

data/test/qbwc/controllers/controller_test.rb

@@ -31,13 +31,18 @@ class QBWCControllerTest < ActionController::TestCase
     #_inspect_routes
     process(:qwc)
 
-    assert_match /QBWCXML/,                                                 @response.body
-    assert_match Regexp.new("AppName.*QbwcTestApplication #{Rails.env}.*AppName"),       @response.body
-    assert_match /AppURL.*http:\/\/test.host\/qbwc\/action.*AppURL/,        @response.body
-    assert_match /AppDescription.*Quickbooks integration.*AppDescription/,  @response.body
-    assert_match /AppSupport.*https:\/\/test.host\/.*AppSupport/,           @response.body
-    assert_match /UserName.*#{QBWC_USERNAME}.*UserName/,                    @response.body
-    assert_match /FileID.*{90A44FB5-33D9-4815-AC85-BC87A7E7D1EB}.*FileID/,  @response.body
+    assert_match(/QBWCXML/,                                                 @response.body)
+    assert_match(Regexp.new("AppName.*QbwcTestApplication #{Rails.env}.*AppName"),       @response.body)
+    assert_match(/AppURL.*http:\/\/test.host\/qbwc\/action.*AppURL/,        @response.body)
+    assert_match(/AppDescription.*Quickbooks integration.*AppDescription/,  @response.body)
+    assert_match(/AppSupport.*https:\/\/test.host\/.*AppSupport/,           @response.body)
+    assert_match(/UserName.*#{QBWC_USERNAME}.*UserName/,                    @response.body)
+    assert_match(/FileID.*{90A44FB5-33D9-4815-AC85-BC87A7E7D1EB}.*FileID/,  @response.body)
+  end
+
+  test "server_version" do
+    _simulate_soap_request('server_version', SERVER_VERSION_SOAP_ACTION, SERVER_VERSION_PARAMS)
+    assert_match(/tns:serverVersionResult/, @response.body)
   end
 
   test "authenticate with no jobs" do
@@ -101,7 +106,7 @@ class QBWCControllerTest < ActionController::TestCase
     _authenticate_with_queued_job
     _simulate_soap_request('receive_response', RECEIVE_RESPONSE_SOAP_ACTION, RECEIVE_RESPONSE_PARAMS)
 
-    assert_match /tns:receiveResponseXMLResult.*100..tns:receiveResponseXMLResult/, @response.body
+    assert_match(/tns:receiveResponseXMLResult.*100..tns:receiveResponseXMLResult/, @response.body)
   end
 
   class CheckErrorValuesWorker < QBWC::Worker
@@ -137,7 +142,7 @@ class QBWCControllerTest < ActionController::TestCase
     _simulate_soap_request('receive_response', RECEIVE_RESPONSE_SOAP_ACTION, RECEIVE_RESPONSE_ERROR_PARAMS)
 
     assert $HANDLE_RESPONSE_EXECUTED  # https://github.com/skryl/qbwc/pull/50#discussion_r23764154
-    assert_match /tns:receiveResponseXMLResult.*#{receive_response_xml_result}..tns:receiveResponseXMLResult/, @response.body
+    assert_match(/tns:receiveResponseXMLResult.*#{receive_response_xml_result}..tns:receiveResponseXMLResult/, @response.body)
   end
 
   test "receive_response error stop" do

data/test/qbwc/integration/job_management_test.rb

@@ -50,7 +50,7 @@ class JobManagementTest < ActionDispatch::IntegrationTest
 
   test "requests with default session" do
     job = QBWC.add_job(:integration_test, true, '', QBWC::Worker)
-    session = QBWC::Session.new('foo', '')
+    QBWC::Session.new('foo', '')
     assert_nil job.requests
   end
 
@@ -62,7 +62,7 @@ class JobManagementTest < ActionDispatch::IntegrationTest
 
   test "next_request with default session" do
     job = QBWC.add_job(:integration_test, true, '', QBWC::Worker)
-    session = QBWC::Session.new('foo', '')
+    QBWC::Session.new('foo', '')
     assert_nil job.next_request
   end
 

data/test/qbwc/integration/request_generation_test.rb

@@ -30,7 +30,7 @@ class RequestGenerationTest < ActionDispatch::IntegrationTest
 
   class SingleRequestWorker < QBWC::Worker
     def requests(job, session, data)
-      $SINGLE_REQUESTS_INVOKED_COUNT += 1 if $SINGLE_REQUESTS_INVOKED_COUNT.is_a?(Integer)
+      $SINGLE_REQUESTS_INVOKED_COUNT += 1 if defined?($SINGLE_REQUESTS_INVOKED_COUNT) && $SINGLE_REQUESTS_INVOKED_COUNT.is_a?(Integer)
       {:customer_query_rq => {:full_name => 'Quincy Bob William Carlos'}}
     end
   end
@@ -41,14 +41,14 @@ class RequestGenerationTest < ActionDispatch::IntegrationTest
     session = QBWC::Session.new('foo', '')
     nr = session.next_request
     assert_not_nil nr
-    assert_match /FullName.*Quincy Bob William Carlos.*FullName/, nr.request
+    assert_match(/FullName.*Quincy Bob William Carlos.*FullName/, nr.request)
     simulate_response(session)
     assert_nil session.next_request
   end
 
   class SingleStringRequestWorker < QBWC::Worker
     def requests(job, session, data)
-      $SINGLE_REQUESTS_INVOKED_COUNT += 1 if $SINGLE_REQUESTS_INVOKED_COUNT.is_a?(Integer)
+      $SINGLE_REQUESTS_INVOKED_COUNT += 1 if defined?($SINGLE_REQUESTS_INVOKED_COUNT) && $SINGLE_REQUESTS_INVOKED_COUNT.is_a?(Integer)
       QBWC_CUSTOMER_QUERY_RQ
     end
   end
@@ -59,7 +59,7 @@ class RequestGenerationTest < ActionDispatch::IntegrationTest
     session = QBWC::Session.new('foo', '')
     nr = session.next_request
     assert_not_nil nr
-    assert_match /FullName.*#{QBWC_USERNAME}.*FullName/, nr.request
+    assert_match(/FullName.*#{QBWC_USERNAME}.*FullName/, nr.request)
     simulate_response(session)
     assert_nil session.next_request
   end
@@ -130,17 +130,17 @@ class RequestGenerationTest < ActionDispatch::IntegrationTest
 
     req1 = session.next_request
     assert_not_nil req1
-    assert_match /xml.*FullName.*Quincy Bob William Carlos.*FullName/m, req1.request
+    assert_match(/xml.*FullName.*Quincy Bob William Carlos.*FullName/m, req1.request)
     simulate_response(session)
 
     req2 = session.next_request
     assert_not_nil req2
-    assert_match /xml.*FullName.*Quentin Billy Wyatt Charles.*FullName/m, req2.request
+    assert_match(/xml.*FullName.*Quentin Billy Wyatt Charles.*FullName/m, req2.request)
     simulate_response(session)
 
     req3 = session.next_request
     assert_not_nil req3
-    assert_match /xml.*FullName.*Quigley Brian Wally Colin.*FullName/m, req3.request
+    assert_match(/xml.*FullName.*Quigley Brian Wally Colin.*FullName/m, req3.request)
     simulate_response(session)
 
     assert_nil session.next_request
@@ -261,11 +261,11 @@ class RequestGenerationTest < ActionDispatch::IntegrationTest
     session = QBWC::Session.new('foo', '')
     request = session.next_request
     assert_not_nil request
-    assert_match /CustomerAddRq.*\/CustomerAddRq/m, request.request
+    assert_match(/CustomerAddRq.*\/CustomerAddRq/m, request.request)
     simulate_response(session)
     assert_nil session.next_request
 
-    assert_match /CustomerAddRq.*\/CustomerAddRq/m, extract_request(QBWC::ActiveRecord::Job::QbwcJob.first, session)[0]
+    assert_match(/CustomerAddRq.*\/CustomerAddRq/m, extract_request(QBWC::ActiveRecord::Job::QbwcJob.first, session)[0])
     QBWC.jobs.each {|job| assert job.requests_provided_when_job_added == true}
   end
 
@@ -296,7 +296,7 @@ class RequestGenerationTest < ActionDispatch::IntegrationTest
     session = QBWC::Session.new('foo', '')
     request = session.next_request
     assert_not_nil request
-    assert_match /FullName.#{QBWC_USERNAME}.\/FullName/, request.request
+    assert_match(/FullName.#{QBWC_USERNAME}.\/FullName/, request.request)
 
     expected = {[nil, ""] => [{:customer_query_rq => {:full_name => QBWC_USERNAME}}]}
     assert_equal expected, QBWC::ActiveRecord::Job::QbwcJob.first[:requests]
@@ -327,11 +327,11 @@ class RequestGenerationTest < ActionDispatch::IntegrationTest
 
     session = QBWC::Session.new('foo', '')
     request1 = session.next_request
-    assert_match /FullName.#{QBWC_USERNAME}.\/FullName/, request1.request
+    assert_match(/FullName.#{QBWC_USERNAME}.\/FullName/, request1.request)
     simulate_response(session)
 
     request2 = session.next_request
-    assert_match /FullName.usr2 name.\/FullName/, request2.request
+    assert_match(/FullName.usr2 name.\/FullName/, request2.request)
     simulate_response(session)
 
     assert_nil session.next_request

data/test/qbwc/integration/response_test.rb

@@ -30,6 +30,8 @@ class ResponseTest < ActionDispatch::IntegrationTest
 
     # Simulate controller authenticate
     ticket_string = QBWC::ActiveRecord::Session.new(QBWC_USERNAME, COMPANY).ticket
+    assert_not_nil(ticket_string)
+
     session = QBWC::Session.new(nil, COMPANY)
 
     responses.each do |resp|

data/test/qbwc/integration/routes_test.rb

@@ -21,12 +21,12 @@ class RoutesTest < ActionDispatch::IntegrationTest
     #_inspect_routes
     get '/qbwc/qwc'
 
-    assert_match /QBWCXML/,                                                 @response.body
-    assert_match Regexp.new("AppName.*QbwcTestApplication #{Rails.env}.*AppName"),       @response.body
-    assert_match /AppURL.*http:\/\/www.example.com\/qbwc\/action.*AppURL/,  @response.body
-    assert_match /AppDescription.*Quickbooks integration.*AppDescription/,  @response.body
-    assert_match /AppSupport.*https:\/\/www.example.com\/.*AppSupport/,     @response.body
-    assert_match /UserName.*#{QBWC_USERNAME}.*UserName/,        	    @response.body
+    assert_match(/QBWCXML/,                                                 @response.body)
+    assert_match(Regexp.new("AppName.*QbwcTestApplication #{Rails.env}.*AppName"),       @response.body)
+    assert_match(/AppURL.*http:\/\/www.example.com\/qbwc\/action.*AppURL/,  @response.body)
+    assert_match(/AppDescription.*Quickbooks integration.*AppDescription/,  @response.body)
+    assert_match(/AppSupport.*https:\/\/www.example.com\/.*AppSupport/,     @response.body)
+    assert_match(/UserName.*#{QBWC_USERNAME}.*UserName/,        	    @response.body)
   end
 
   test "qbwc/action without soap returns successfully" do

data/test/qbwc/integration/savon_client_test.rb

@@ -0,0 +1,48 @@
+$:<< File.expand_path(File.dirname(__FILE__) + '/../..')
+require 'test_helper.rb'
+require 'savon'
+
+class SavonClientTest < ActionDispatch::IntegrationTest
+
+  def setup
+    SavonClientTest.app = Rails.application
+
+    # Initialize sets view paths
+    SavonClientTest.app.initialize! unless SavonClientTest.app.initialized?
+
+    # Assign routes
+    QbwcTestApplication::Application.routes.draw do
+      _assign_routes
+    end
+
+    QBWC.clear_jobs
+  end
+
+  # http://blog.johnsonch.com/2013/04/18/rails-3-soap-and-testing-oh-my/
+  test "qbwc/action serverVersion" do
+    host     = 'application'
+    url_base = "http://#{host}"
+    url_path = '/qbwc/action'
+
+    # http://httpirb.com/
+    # https://github.com/savonrb/httpi
+    HTTPI.adapter = :rack
+    HTTPI::Adapter::Rack.mount(host, SavonClientTest.app)
+
+    # https://github.com/savonrb/savon#usage-example
+    # https://github.com/inossidabile/wash_out#usage
+    client = Savon::Client.new({:wsdl => url_base + url_path })
+    result = client.call(:server_version, :message => nil)
+
+    # Use this assertion when QBWC::Controller.server_version_response returns nil
+    if WashOut::VERSION == "0.10.0"
+      assert_equal({:"@xsi:type"=>"xsd:string"}, result.body[:server_version_response][:server_version_result])
+    else
+      assert_nil result.body[:server_version_response][:server_version_result]
+    end
+
+    # Use this assertion when QBWC::Controller.server_version_response returns a value
+    # assert_equal("SERVER_VERSION_RESPONSE", result.body[:server_version_response][:server_version_result])
+  end
+
+end

data/test/qbwc/integration/session_test.rb

@@ -89,7 +89,7 @@ class SessionTest < ActionDispatch::IntegrationTest
     assert_equal 1, QBWC.pending_jobs(COMPANY, session).count
 
     # Simulate controller send_request
-    request = session.request_to_send
+    session.request_to_send
   end
 
   class ConditionalTestWorker < QBWC::Worker

data/test/test_helper.rb

@@ -9,6 +9,19 @@ require 'active_record'
 require 'action_controller'
 require 'rails'
 
+# Determine location of local wash_out gem
+# https://github.com/rubygems/rubygems/blob/master/lib/rubygems/commands/which_command.rb
+require 'rubygems/commands/which_command'
+which_command = Gem::Commands::WhichCommand.new
+paths = which_command.find_paths('wash_out', $LOAD_PATH)
+wash_out_lib = File.dirname(paths[0])  # Alternate technique: File.dirname(`gem which wash_out`)
+
+# Add wash_out to autoload_paths so that WashOutHelper can be included directly
+# http://api.rubyonrails.org/classes/AbstractController/Helpers/ClassMethods.html#method-i-helper
+# http://guides.rubyonrails.org/autoloading_and_reloading_constants.html#require-dependency
+# http://guides.rubyonrails.org/autoloading_and_reloading_constants.html#autoload-paths
+ActiveSupport::Dependencies.autoload_paths << "#{wash_out_lib}/../app/helpers"
+
 $:<< File.expand_path(File.dirname(__FILE__) + '/../lib')
 require 'qbwc'
 require 'qbwc/controller'
@@ -89,6 +102,8 @@ QbwcTestApplication::Application.routes.draw do
 end
 
 class QbwcController < ActionController::Base
+  protect_from_forgery with: :exception  # Must precede QWBC::Controller to emulate Rails load order
+
   include Rails.application.routes.url_helpers
   include QBWC::Controller
 end
@@ -176,6 +191,12 @@ AUTHENTICATE_WASH_OUT_SOAP_DATA = {
   }
 }
 
+SERVER_VERSION_PARAMS = {
+  :@xmlns      => "http://developer.intuit.com/"
+}
+
+SERVER_VERSION_SOAP_ACTION = :serverVersion
+
 SEND_REQUEST_PARAMS = {
   :qbXMLCountry   => "US",
   :qbXMLMajorVers => "13",
@@ -202,18 +223,44 @@ RECEIVE_RESPONSE_ERROR_PARAMS = {
 
 RECEIVE_RESPONSE_SOAP_ACTION = :receiveResponseXML
 
+#-------------------------------------------
+def _controller_env_is_required?
+  # qbwc requires minimum wash_out 0.10.0
+  # wash_out 0.10.0 uses controller env
+  # wash_out 0.11.0 uses request.env
+  WashOut::VERSION == "0.10.0"
+end
+
+#-------------------------------------------
+def _set_controller_env_if_required
+  if _controller_env_is_required?
+    @controller.set_request!(@request) if Rails::VERSION::MAJOR >= 5
+    @controller.env["wash_out.soap_data"] = @request.env["wash_out.soap_data"]
+  end
+end
+
 #-------------------------------------------
 def _simulate_soap_request(http_action, soap_action, soap_params)
 
-  ticket = QBWC::ActiveRecord::Session::QbwcSession.first.ticket
-  wash_out_soap_data = { :Envelope => { :Body => { soap_action => soap_params.update(:ticket => ticket) }}}
+  session = QBWC::ActiveRecord::Session::QbwcSession.first
+  unless session.blank?
+    ticket = session.ticket
+    soap_params = soap_params.update(:ticket => ticket)
+  end
+
+  wash_out_soap_data = { :Envelope => { :Body => { soap_action => soap_params }}}
 
   # http://twobitlabs.com/2010/09/setting-request-headers-in-rails-functional-tests/
   @request.env["wash_out.soap_action"]  = soap_action.to_s
   @request.env["wash_out.soap_data"]    = wash_out_soap_data
-  @controller.env["wash_out.soap_data"] = @request.env["wash_out.soap_data"]
+  _set_controller_env_if_required
+
+  if Rails::VERSION::MAJOR <= 4
+    post http_action, use_route: :qbwc_action
+  else
+    post http_action, params: { use_route: :qbwc_action }
+  end
 
-  post http_action, use_route: :qbwc_action
 end
 
 #-------------------------------------------
@@ -221,7 +268,7 @@ def _authenticate
   # http://twobitlabs.com/2010/09/setting-request-headers-in-rails-functional-tests/
   @request.env["wash_out.soap_action"]  = AUTHENTICATE_SOAP_ACTION.to_s
   @request.env["wash_out.soap_data"]    = AUTHENTICATE_WASH_OUT_SOAP_DATA
-  @controller.env["wash_out.soap_data"] = @request.env["wash_out.soap_data"]
+  _set_controller_env_if_required
 
   process(:authenticate)
 end
@@ -241,7 +288,7 @@ def _authenticate_wrong_password
   bad_password_soap_data[:Envelope][:Body][AUTHENTICATE_SOAP_ACTION][:strPassword] = 'something wrong'
   @request.env["wash_out.soap_action"]  = AUTHENTICATE_SOAP_ACTION.to_s
   @request.env["wash_out.soap_data"]    = bad_password_soap_data
-  @controller.env["wash_out.soap_data"] = @request.env["wash_out.soap_data"]
+  _set_controller_env_if_required
 
   process(:authenticate)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qbwc
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Alex Skryl
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-03 00:00:00.000000000 Z
+date: 2017-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: qbxml
@@ -33,30 +33,30 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: 0.12.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: 0.12.0
 - !ruby/object:Gem::Dependency
-  name: guard
+  name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 5.0.1
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.0.1
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -70,7 +70,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rb-fsevent
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -84,7 +84,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -98,21 +98,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.0.1
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -126,7 +126,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: actionpack
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -140,21 +140,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -168,7 +168,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: savon
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -182,7 +182,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: httpi
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -209,12 +209,14 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- Appraisals
 - CHANGELOG.md
 - Gemfile
-- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- gemfiles/rails_5.0.gemfile
+- gemfiles/rails_5.1.gemfile
 - lib/generators/qbwc/install/install_generator.rb
 - lib/generators/qbwc/install/templates/config/qbwc.rb
 - lib/generators/qbwc/install/templates/controllers/qbwc_controller.rb
@@ -241,9 +243,9 @@ files:
 - test/qbwc/integration/request_generation_test.rb
 - test/qbwc/integration/response_test.rb
 - test/qbwc/integration/routes_test.rb
+- test/qbwc/integration/savon_client_test.rb
 - test/qbwc/integration/session_test.rb
 - test/test_helper.rb
-- test/wash_out_helper.rb
 homepage: ''
 licenses: []
 metadata: {}
@@ -255,7 +257,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -263,7 +265,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: qbwc
-rubygems_version: 2.4.6
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: A Rails interface for Intuit's Quickbooks Web Connector

data/Guardfile

@@ -1,46 +0,0 @@
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
-
-guard 'rspec' do
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec" }
-
-  # Rails example
-  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
-  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
-  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
-  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
-  watch('config/routes.rb')                           { "spec/routing" }
-  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
-
-  # Capybara features specs
-  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/features/#{m[1]}_spec.rb" }
-
-  # Turnip features and steps
-  watch(%r{^spec/acceptance/(.+)\.feature$})
-  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
-end
-
-
-guard 'rspec' do
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec" }
-
-  # Rails example
-  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
-  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
-  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
-  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
-  watch('config/routes.rb')                           { "spec/routing" }
-  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
-
-  # Capybara features specs
-  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/features/#{m[1]}_spec.rb" }
-
-  # Turnip features and steps
-  watch(%r{^spec/acceptance/(.+)\.feature$})
-  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
-end
-

data/test/wash_out_helper.rb

@@ -1,76 +0,0 @@
-# Copy of what's in the gem. Can't figure out how to include it.
-module WashOutHelper
-
-  def wsdl_data_options(param)
-    case controller.soap_config.wsdl_style
-    when 'rpc'
-      { :"xsi:type" => param.namespaced_type }
-    when 'document'
-      { }
-    end
-  end
-
-  def wsdl_data(xml, params)
-    params.each do |param|
-      tag_name = param.name
-      param_options = wsdl_data_options(param)
-
-      if !param.struct?
-        if !param.multiplied
-          xml.tag! tag_name, param.value, param_options
-        else
-          param.value = [] unless param.value.is_a?(Array)
-          param.value.each do |v|
-            xml.tag! tag_name, v, param_options
-          end
-        end
-      else
-        if !param.multiplied
-          xml.tag! tag_name,  param_options do
-            wsdl_data(xml, param.map)
-          end
-        else
-          param.map.each do |p|
-            xml.tag! tag_name, param_options do
-              wsdl_data(xml, p.map)
-            end
-          end
-        end
-      end
-    end
-  end
-
-  def wsdl_type(xml, param, defined=[])
-    more = []
-
-    if param.struct?
-      if !defined.include?(param.basic_type)
-        xml.tag! "xsd:complexType", :name => param.basic_type do
-          xml.tag! "xsd:sequence" do
-            param.map.each do |value|
-              more << value if value.struct?
-              xml.tag! "xsd:element", wsdl_occurence(value, false, :name => value.name, :type => value.namespaced_type)
-            end
-          end
-        end
-
-        defined << param.basic_type
-      elsif !param.classified?
-        raise RuntimeError, "Duplicate use of `#{param.basic_type}` type name. Consider using classified types."
-      end
-    end
-
-    more.each do |p|
-      wsdl_type xml, p, defined
-    end
-  end
-
-  def wsdl_occurence(param, inject, extend_with = {})
-    data = !param.multiplied ? {} : {
-      "#{'xsi:' if inject}minOccurs" => 0,
-      "#{'xsi:' if inject}maxOccurs" => 'unbounded'
-    }
-
-    extend_with.merge(data)
-  end
-end