qbwc 0.0.3

data/.gitignore

@@ -0,0 +1 @@
+.rvmrc 

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    qbwc (0.0.3)
+      quickbooks_api (>= 0.1.6)
+      rubyjedi-soap4r (>= 1.5.8.20100619003610)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    buffered_logger (0.1.3)
+      activesupport
+      i18n
+      term-ansicolor
+    httpclient (2.1.5.2)
+    i18n (0.6.0)
+    multi_json (1.3.6)
+    nokogiri (1.5.5)
+    quickbooks_api (0.1.6)
+      activesupport
+      buffered_logger (>= 0.1.3)
+      nokogiri
+    rubyjedi-soap4r (1.5.8.20100619003610)
+      httpclient (~> 2.1.5.2)
+    term-ansicolor (1.0.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  qbwc!

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 
+
+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

@@ -0,0 +1,182 @@
+# Quickbooks Web Connector (QBWC)
+
+Be Warned, this code is still hot out of the oven. 
+
+## Installation
+
+Install the gem
+
+  `gem install qbwc`
+
+Add it to your Gemfile
+
+  `gem "qbwc"`
+
+Run the generator:
+
+  `rails generate qbwc:install`
+
+## Features
+
+QBWC was designed to add quickbooks web connector integration to your Rails 3 application. 
+
+* Implementation of the Soap WDSL spec for Intuit Quickbooks and Point of Sale
+* Integration with the [quickbooks_api](https://github.com/skryl/quickbooks_api) gem providing qbxml processing
+
+## Getting Started
+
+### Configuration
+
+All configuration takes place in the gem initializer. See the initializer for more details regarding the configuration options.
+
+### Basics
+
+The QBWC gem provides a persistent work queue for the Web Connector to talk to.
+
+Every time the Web Connector initiates a new conversation with the application a
+Session will be created. The Session is a collection of jobs and the requests
+that comprise these jobs. A new Session will automatically queue up all the work
+available across all currently enabled jobs for processing by the web connector.
+The session instance will persist across all requests until the work it contains
+has been exhausted. You never have to interact with the Session class directly
+(unless you want to...) since creating a new job will automatically add it's
+work to the next session instance.
+
+A Job is just a named work queue. It consists of a name and a code block. The
+block can contain:
+
+  * A single qbxml request
+  * An array of qbxml requests
+  * Code that genrates a qbxml request
+  * Code that generates an array of qbxml requests
+
+*Note: All requests may be in ruby hash form, generated using quickbooks_api. 
+Raw requests are supported supported as of 0.0.3 (8/28/2012)*
+
+The code block is re-evaluated every time a session instance with that job is
+created. Only enabled jobs are added to a new session instance. 
+
+An optional response processor block can also be added to a job. Responses to
+all requests are either processed immediately after being received or saved for
+processing after the web connector closes its connection. The delayed processing
+configuration option decides this.
+
+Here is the rough order in which things happen:
+
+  1. The Web Connector initiates a connection
+  2. A new Session is created (with work from all enabled jobs)
+  3. The web connector requests work
+  4. The session responds with the next request in the work queue
+  5. The web connector provides a response
+  6. The session responds with the current progress of the work queue (0 - 100)
+  6. The response is processed or saved for later processing
+  7. If progress == 100 then the web connector closes the connection, otherwise goto 3
+  8. Saved responses are processed if any exist
+
+### Adding Jobs
+
+Create a new job
+
+    QBWC.add_job('my job') do
+      # work to do
+    end
+
+Add a response proc
+
+    QBWC.jobs['my job'].set_response_proc do |r|
+      # response processing work here
+    end
+
+Caveats
+  * Jobs are enabled by default
+  * Using a non unique job name will overwrite the existing job
+
+###Sample Jobs
+
+Add a Customer (Wrapped)
+
+          {  :qbxml_msgs_rq => 
+            [
+              {
+                :xml_attributes =>  { "onError" => "stopOnError"}, 
+                :customer_add_rq => 
+                [
+                  {
+                    :xml_attributes => {"requestID" => "1"},  ##Optional
+                    :customer_add   => { :name => "GermanGR" }
+                  } 
+                ] 
+              }
+            ]
+          }
+          
+Add a Customer (Unwrapped)
+
+        {
+          :customer_add_rq    => 
+          [
+            {
+              :xml_attributes => {"requestID" => "1"},  ##Optional
+              :customer_add   => { :name => "GermanGR" }
+            } 
+          ] 
+        }
+
+Get All Vendors (In Chunks of 5)
+
+        QBWC.add_job(:import_vendors) do
+          [
+            :vendor_query_rq  =>
+            {
+              :xml_attributes => { "requestID" =>"1", 'iterator'  => "Start" },
+      
+              :max_returned => 5,
+              :owner_id => 0,
+              :from_modified_date=> "1984-01-29T22:03:19"
+
+            }
+          ]
+        end
+        
+Get All Vendors (Raw QBXML)
+
+        QBWC.add_job(:import_vendors) do
+          '<QBXML>
+            <QBXMLMsgsRq onError="continueOnError">
+            <VendorQueryRq requestID="6" iterator="Start">
+            <MaxReturned>5</MaxReturned>
+            <FromModifiedDate>1984-01-29T22:03:19-05:00</FromModifiedDate>
+            <OwnerID>0</OwnerID>
+          </VendorQueryRq>
+          </QBXMLMsgsRq>
+          </QBXML>
+          '
+        end
+
+### Managing Jobs
+
+Jobs can be added, removed, enabled, and disabled. See the above section for
+details on adding new jobs. 
+
+Removing jobs is as easy as deleting them from the jobs hash.                   
+
+    QBWC.jobs.delete('my job')
+
+Disabling a job
+
+    QBWC.jobs['my job'].disable
+
+Enabling a job
+
+    QBWC.jobs['my job'].enable
+
+
+## Contributing to qbwc
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/gem_tasks"
+
+Bundler::GemHelper.install_tasks

data/lib/generators/qbwc/install/install_generator.rb

@@ -0,0 +1,24 @@
+require 'rails/generators'
+
+module QBWC
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      namespace "qbwc:install"
+      desc "Copy Quickbooks Web Connector default files"
+      source_root File.expand_path('../templates', __FILE__)
+      
+      def copy_config
+         template('config/qbwc.rb', "config/initializers/qbwc.rb")
+      end
+
+      def copy_controller 
+         template('controllers/qbwc_controller.rb', "app/controllers/qbwc_controller.rb")
+      end
+
+      def setup_routes
+        route("match 'apis/quickbooks/:action', :controller => 'qbwc', :as => 'quickbooks'")
+      end
+      
+    end
+  end
+end

data/lib/generators/qbwc/install/templates/config/qbwc.rb

@@ -0,0 +1,35 @@
+QBWC.configure do |c|
+  
+  #Currently Only supported for single logins. 
+  c.username = "foo"
+  c.password = "bar"
+  
+  #Path to Company File (blank for open or named path or function etc..)
+  c.company_file_path = ""
+  
+  #Minimum Quickbooks Version Required for use in QBXML Requests
+  c.min_version = 7.0
+  
+  #Quickbooks Type (either :qb or :qbpos)
+  c.api = :qb
+  
+  #Quickbooks Support URL provided in QWC File
+  c.support_site_url = "localhost:3000"
+  
+  #Quickbooks Owner ID provided in QWC File
+  c.owner_id = '{57F3B9B1-86F1-4fcc-B1EE-566DE1813D20}'
+
+  # Perform response processing after session termination. Enabling this option
+  # will speed up qbwc session time (and potentially fix timeout issues) but
+  # will necessarily eat up more memory since every response must be stored
+  # until it is processed. 
+  c.delayed_processing = false
+
+  # In the event of an error in the communcation process do you wish the sync to stop or blase through
+  #
+  # Options: 
+  # :stop
+  # :continue
+  c.on_error = :stop
+  
+end

data/lib/generators/qbwc/install/templates/controllers/qbwc_controller.rb

@@ -0,0 +1,39 @@
+class QBWCController < ApplicationController
+  require "Quickbooks"
+
+  def qwc
+    qwc = <<-QWC
+    <QBWCXML>
+    <AppName>#{Rails.application.class.parent_name} #{Rails.env}</AppName>
+    <AppID></AppID>
+    <AppURL>#{quickbooks_url(:protocol => 'https://', :action => 'api')}</AppURL>
+    <AppDescription>I like to describe my awesome app</AppDescription>
+    <AppSupport>#{QBWC.support_site_url}</AppSupport>
+    <UserName>#{QBWC.username}</UserName>
+    <OwnerID>#{QBWC.owner_id}</OwnerID>
+    <FileID>{90A44FB5-33D9-4815-AC85-BC87A7E7D1EB}</FileID>
+    <QBType>QBFS</QBType>
+    <Style>Document</Style>
+    <Scheduler>
+      <RunEveryNMinutes>5</RunEveryNMinutes>
+    </Scheduler>
+    </QBWCXML>
+    QWC
+    send_data qwc, :filename => 'name_me.qwc'
+  end
+
+  def api
+    # respond successfully to a GET which some versions of the Web Connector send to verify the url
+
+    if request.get?
+      render :nothing => true
+      return
+    end
+
+    req = request
+    puts "========== #{ params["Envelope"]["Body"].keys.first}  =========="
+    res = QBWC::SoapWrapper.route_request(req)
+    render :xml => res, :content_type => 'text/xml'
+  end
+
+end

data/lib/generators/qbwc/install/usage.md

@@ -0,0 +1,3 @@
+To copy a QBWC initializer to your Rails App, with some configuration values, just do:
+
+    rails generate qbwc:install

data/lib/qbwc.rb

@@ -0,0 +1,83 @@
+$:.unshift File.dirname(File.expand_path(__FILE__))
+require 'qbwc/version'
+require 'quickbooks'
+
+module QBWC
+
+  # Web connector login credentials
+  mattr_accessor :username
+  @@username = 'foo'
+  mattr_accessor :password
+  @@password = 'bar'
+  
+  # Full path to pompany file 
+  mattr_accessor :company_file_path 
+  @@company_file_path = ""
+  
+  # Minimum quickbooks version required for use in qbxml requests
+  mattr_accessor :min_version
+  @@min_version = 3.0
+  
+  # Quickbooks support url provided in qwc file
+  mattr_accessor :support_site_url
+  @@support_site_url = 'http://google.com'
+  
+  # Quickbooks owner id provided in qwc file
+  mattr_accessor :owner_id
+  @@owner_id = '{57F3B9B1-86F1-4fcc-B1EE-566DE1813D20}'
+  
+  # Job definitions
+  mattr_reader :jobs
+  @@jobs = {}
+  
+  mattr_reader :on_error
+  @@on_error = 'stopOnError'
+  # Do processing after session termination
+  # Enabling this option will speed up qbwc session time but will necessarily eat
+  # up more memory since every response must be stored until it is processed. 
+  mattr_accessor :delayed_processing
+  @@delayed_processing = false
+
+  # Quickbooks Type (either :qb or :qbpos)
+  mattr_reader :api, :parser
+  @@api= ::Quickbooks::API[:qb]
+  
+class << self
+
+  def add_job(name, &block)
+    @@jobs[name] = Job.new(name, &block)
+  end
+  
+  def on_error=(reaction)
+    raise 'Quickbooks type must be :qb or :qbpos' unless [:stop, :continue].include?(reaction)
+    @@on_error = "stopOnError" if reaction == :stop
+    @@on_error = "continueOnError" if reaction == :continue
+  end
+  
+  def api=(api)
+    raise 'Quickbooks type must be :qb or :qbpos' unless [:qb, :qbpos].include?(api)
+    @@api = api
+    @@parser = ::Quickbooks::API[api]
+  end
+
+  # Allow configuration overrides
+  def configure
+    yield self
+  end
+
+
+end
+  
+end
+
+require 'fiber'
+
+#Todo Move this to Autolaod
+require 'qbwc/soap_wrapper/default'
+require 'qbwc/soap_wrapper/defaultMappingRegistry'
+require 'qbwc/soap_wrapper/defaultServant'
+require 'qbwc/soap_wrapper/QBWebConnectorSvc'
+require 'qbwc/soap_wrapper'
+require 'qbwc/session'
+require 'qbwc/request'
+require 'qbwc/job'

data/lib/qbwc/job.rb

@@ -0,0 +1,47 @@
+class QBWC::Job
+
+  attr_reader :name, :response_proc, :requests
+
+  def initialize(name, &block)
+    @name = name
+    @enabled = true
+    @requests = block
+
+    reset
+  end
+
+  def set_response_proc(&block) 
+    @response_proc = block
+  end
+
+  def enable
+    @enabled = true
+  end
+
+  def disable
+    @enabled = false
+  end
+
+  def enabled?
+    @enabled
+  end
+
+  def next
+    @request_gen.alive? ? @request_gen.resume : nil
+  end
+
+  def reset
+    @request_gen = new_request_generator
+  end
+
+private
+
+  def new_request_generator
+    Fiber.new { request_queue.each { |r| Fiber.yield r }; nil }
+  end
+
+  def request_queue
+    QBWC::Request.from_array(@requests.call, @response_proc )
+  end
+
+end