@@ -21,16 +21,28 @@ To implement your own QuickBooks integration, implement the functions outlined i ### Requirements ### -1) Install actionwebservice gem (if it's not already installed) - - sudo gem install actionwebservice - -2) Add a route for the qbwc controller to config/routes.rb +1) Add a route for the qbwc controller to config/routes.rb # example Quickbooks Web Connector api route map.quickbooks_api 'apis/quickbooks/api', :controller => 'qbwc', :action => 'api' - -3) The QBWC will only communicate over SSL so make sure your app has a valid and trusted SSL cert installed. For testing the QBWC will speak to localhost over http. + +2) Add the following block to config/environment.rb + + Rails::Initializer.run do |config| + ... + config.load_paths += %W( #{RAILS_ROOT}/app/apis ) + config.load_paths += Dir["#{RAILS_ROOT}/vendor/gems/**"].map do |dir| + File.directory?(lib = "#{dir}/lib") ? lib : dir + end + ... + end + +3) Add the following lines to an initializer or the bottom of config/environment.rb + + require 'actionwebservice' + require 'action_web_service_ext' + +4) The QBWC will only communicate over SSL so make sure your app has a valid and trusted SSL cert installed. For testing the QBWC will speak to localhost over http. ### Installation ### README.markdown @@ -12,10 +12,15 @@ plugin_root = File.dirname(__FILE__) app_root = File.join(plugin_root, '../../../') FileUtils.mkdir_p File.join(app_root, 'app/apis'), :verbose => true +FileUtils.mkdir_p File.join(app_root, 'vendor/gems'), :verbose => true + safe_copy File.join(plugin_root, 'templates/example_qbwc_controller.rb'), File.join(app_root, 'app/controllers/qbwc_controller.rb') safe_copy File.join(plugin_root, 'templates/example_qbwc_helper.rb'), File.join(app_root, 'app/helpers/qbwc_helper.rb') safe_copy File.join(plugin_root, 'templates/example_qbwc_api.rb'), File.join(app_root, 'app/apis/qbwc_api.rb') safe_copy File.join(plugin_root, 'templates/example_qbwc_controller_test.rb'), File.join(app_root, 'test/functional/qbwc_controller_test.rb') safe_copy File.join(plugin_root, 'templates/example_qbwc.qwc'), File.join(app_root, 'config/qbwc.qwc') +safe_copy File.join(plugin_root, 'lib/action_web_service_ext.rb'), File.join(app_root, 'lib/action_web_service_ext.rb') + +FileUtils.cp_r File.join(plugin_root, 'vendor/actionwebservice'), File.join(app_root, 'vendor/gems/actionwebservice'), :preserve => true, :verbose => true puts IO.read(File.join(File.dirname(__FILE__), 'README.markdown')) \ No newline at end of file install.rb @@ -5,8 +5,9 @@ <AppDescription>QuickBooks Plugin Example</AppDescription> <AppSupport>http://idnforums.intuit.com/</AppSupport> <UserName>CHANGME</UserName> - <OwnerID></OwnerID> - <FileID></FileID> + <!-- OwnerID and FileID should be unique GUIDs - you can change these values for your app --> + <OwnerID>{91F3B9B4-34F1-4fcc-B1EE-566DE1813D20}</OwnerID> + <FileID>bc1286156fa27ecb6ae6d3ae6c96e12193aaf63f</FileID> <QBType>QBFS</QBType> <Style>RPC</Style> </QBWCXML> \ No newline at end of file templates/example_qbwc.qwc 4ba8536c8441108d44ffbf147306706d02871932 Zack Chandler zackchandler@depixelate.com http://github.com/zackchandler/quickbooks_integration_plugin/commit/3fd035e410ef8e696b55c762c100a673f9c6f5e3 3fd035e410ef8e696b55c762c100a673f9c6f5e3 2008-09-10T09:50:35-07:00 2008-09-10T09:50:35-07:00 include "ousted" actionwebservice in vendor/ and copy into vendor/gems include action_web_service_ext to allow the QBWC to "check" status of service using HTTP GET b7fde3d04acdbe7a0dab808360302872fde8ad4e Zack Chandler zackchandler@depixelate.com