qbwc 0.0.5 → 0.1.0

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

@@ -1,39 +1,3 @@
-class QbwcController < ApplicationController
-  require "Quickbooks"
-  protect_from_forgery :except => :api 
-  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
-
+class <%= controller_name.camelize %>Controller < ApplicationController
+  include QBWC::Controller
 end

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

@@ -0,0 +1,15 @@
+class CreateQbwcJobs < ActiveRecord::Migration
+  def change
+    create_table :qbwc_jobs, :force => true do |t|
+      t.string :name
+      t.string :company, :limit => 1000
+      t.string :worker_class, :limit => 100
+      t.boolean :enabled, :null => false, :default => false
+      t.integer :request_index, :null => false, :default => 0
+      t.text :requests
+      t.boolean :requests_provided_when_job_added, :null => false, :default => false
+      t.text :data
+      t.timestamps :null => false
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+class CreateQbwcSessions < ActiveRecord::Migration
+  def change
+    create_table :qbwc_sessions, :force => true do |t|
+      t.string :ticket
+      t.string :user
+      t.string :company, :limit => 1000
+      t.integer :progress, :null => false, :default => 0
+      t.string :current_job
+      t.string :iterator_id
+      t.string :error, :limit => 1000
+      t.string :pending_jobs, :limit => 1000, :null => false, :default => ''
+
+      t.timestamps :null => false
+    end
+  end
+end

data/lib/qbwc.rb

@@ -1,93 +1,129 @@
-$:.unshift File.dirname(File.expand_path(__FILE__))
-require 'qbwc/version'
-require 'quickbooks'
+require 'qbwc/railtie'
+require 'qbxml'
 
 module QBWC
+  autoload :ActiveRecord, 'qbwc/active_record'
+  autoload :Controller, 'qbwc/controller'
+  autoload :Version, 'qbwc/version'
+  autoload :Job, 'qbwc/job'
+  autoload :Session, 'qbwc/session'
+  autoload :Request, 'qbwc/request'
+  autoload :Worker, 'qbwc/worker'
 
-  # Web connector login credentials
+  # Credentials to be entered in QuickBooks Web Connector.
   mattr_accessor :username
-  @@username = 'foo'
+  @@username = nil
   mattr_accessor :password
-  @@password = 'bar'
-  
-  # Full path to pompany file 
+  @@password = nil
+
+  # Path to QuickBooks company file on the client. Empty string to use whatever file is open when the connector runs.
   mattr_accessor :company_file_path 
   @@company_file_path = ""
-  
-  # Minimum quickbooks version required for use in qbxml requests
+
+  # Instead of using hard coded username, password, and path, use a proc
+  # to determine who has access to what. Useful for multiple users or
+  # multiple company files.
+  mattr_accessor :authenticator
+  @@authenticator = nil
+
+  # QBXML version to use. Check the "Implementation" column in the QuickBooks Onscreen Reference to see which fields are supported in which versions. Newer versions of QuickBooks are backwards compatible with older QBXML versions.
   mattr_accessor :min_version
-  @@min_version = 3.0
-  
-  # Quickbooks support url provided in qwc file
+  @@min_version = "3.0"
+
+  # Quickbooks type (either :qb or :qbpos).
+  mattr_reader :api
+  @@api = :qb
+
+  # Storage module. Only :active_record is currently supported.
+  mattr_accessor :storage
+  @@storage = :active_record
+
+  # Support URL shown in QuickBooks Web Connector. nil will use root path of the app.
   mattr_accessor :support_site_url
-  @@support_site_url = 'http://google.com'
-  
-  # Quickbooks owner id provided in qwc file
+  @@support_site_url = nil
+
+  # Unique user GUID. If you want access by multiple users to the same file, you will need to modify this in the generated QWC file.
   mattr_accessor :owner_id
   @@owner_id = '{57F3B9B1-86F1-4fcc-B1EE-566DE1813D20}'
-  
-  # Job definitions
-  mattr_reader :jobs
-  @@jobs = {}
-  
+
+  # How often to run web service (in minutes) or nil to only run manually.
+  mattr_accessor :minutes_to_run
+  @@minutes_to_run = nil
+
+  # Code to execute after each session is authenticated
+  mattr_accessor :session_initializer
+  @@session_initializer = nil
+
+  # In the event of an error running requests, :stop all work or :continue with the next request?
   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 = :qb #::Quickbooks::API[:qb]
+
+  # Logger to use.
+  mattr_accessor :logger
+  @@logger = Rails.logger
   
-  # Check Rails Cache for Parser before boot
-  mattr_accessor :warm_boot
-  @@warm_boot = false
+  # Some log lines contain sensitive information
+  mattr_accessor :log_requests_and_responses
+  @@log_requests_and_responses = Rails.env == 'production' ? false : true
 
-class << self
+  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
-    if @@warm_boot
-      ::Rails.logger.warn "using warm boot"
-      @@parser = ::Rails.cache.read("qb_api_#{api}") || ::Quickbooks::API[api] 
-      ::Rails.cache.write("qb_api_#{api}", @@parser)
-    else
-      @@parser = ::Quickbooks::API[api] 
+    def storage_module
+      const_get storage.to_s.camelize
     end
-  end
 
-  # Allow configuration overrides
-  def configure
-    yield self
-  end
+    def jobs
+      storage_module::Job.list_jobs
+    end
+
+    def add_job(name, enabled = true, company = nil, klass = QBWC::Worker, requests = nil, data = nil)
+      storage_module::Job.add_job(name, enabled, company, klass, requests, data)
+    end
 
+    def get_job(name)
+      storage_module::Job.find_job_with_name(name)
+    end
 
-end
+    def delete_job(object_or_name)
+      name = (object_or_name.is_a?(Job) ? object_or_name.name : object_or_name)
+      storage_module::Job.delete_job_with_name(name)
+    end
+
+    def pending_jobs(company)
+      js = jobs
+      QBWC.logger.info "#{js.length} jobs exist, checking for pending jobs for company '#{company}'."
+      storage_module::Job.sort_in_time_order(js.select {|job| job.company == company && job.pending?})
+    end
+    
+    def set_session_initializer(&block)
+      @@session_initializer = block
+      self
+    end
+
+    def on_error=(reaction)
+      raise 'Quickbooks on_error must be :stop or :continue' 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
+    end
+
+    def parser
+      @@parser ||= Qbxml.new(api, min_version)
+    end
+
+    # Allow configuration overrides
+    def configure
+      yield self
+    end
+
+    def clear_jobs
+      storage_module::Job.clear_jobs
+    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/active_record.rb

@@ -0,0 +1,6 @@
+module QBWC
+  module ActiveRecord
+    autoload 'Job', 'qbwc/active_record/job'
+    autoload 'Session', 'qbwc/active_record/session'
+  end
+end

data/lib/qbwc/active_record/job.rb

@@ -0,0 +1,111 @@
+class QBWC::ActiveRecord::Job < QBWC::Job
+  class QbwcJob < ActiveRecord::Base
+    validates :name, :uniqueness => true, :presence => true
+    serialize :requests, Array
+    serialize :data
+
+    def to_qbwc_job
+      QBWC::ActiveRecord::Job.new(name, enabled, company, worker_class, requests, data)
+    end
+
+  end
+
+  # Creates and persists a job.
+  def self.add_job(name, enabled, company, worker_class, requests, data)
+
+    worker_class = worker_class.to_s
+    ar_job = find_ar_job_with_name(name).first_or_initialize
+    ar_job.company = company
+    ar_job.enabled = enabled
+    ar_job.request_index = 0
+    ar_job.worker_class = worker_class
+    ar_job.save!
+
+    jb = self.new(name, enabled, company, worker_class, requests, data)
+    jb.requests = requests.is_a?(Array) ? requests : [requests] unless requests.nil?
+    jb.requests_provided_when_job_added = (! requests.nil? && ! requests.empty?)
+    jb.data = data
+
+    jb
+  end
+
+  def self.find_job_with_name(name)
+    j = find_ar_job_with_name(name).first
+    j = j.to_qbwc_job unless j.nil?
+    return j
+  end
+
+  def self.find_ar_job_with_name(name)
+    QbwcJob.where(:name => name)
+  end
+
+  def find_ar_job
+    self.class.find_ar_job_with_name(name)
+  end
+
+  def self.delete_job_with_name(name)
+    j = find_ar_job_with_name(name).first
+    j.destroy unless j.nil?
+  end
+
+  def enabled=(value)
+    find_ar_job.update_all(:enabled => value)
+  end
+
+  def enabled?
+    find_ar_job.where(:enabled => true).exists?
+  end
+
+  def requests
+    find_ar_job.pluck(:requests).first
+  end
+
+  def requests=(r)
+    find_ar_job.update_all(:requests => r)
+    super
+  end
+
+  def requests_provided_when_job_added
+    find_ar_job.pluck(:requests_provided_when_job_added).first
+  end
+
+  def requests_provided_when_job_added=(value)
+    find_ar_job.update_all(:requests_provided_when_job_added => value)
+    super
+  end
+
+  def data
+    find_ar_job.pluck(:data).first
+  end
+
+  def data=(r)
+    find_ar_job.update_all(:data => r)
+    super
+  end
+
+  def request_index
+    find_ar_job.pluck(:request_index).first
+  end
+
+  def request_index=(nr)
+    find_ar_job.update_all(:request_index => nr)
+  end
+
+  def advance_next_request
+    nr = request_index
+    self.request_index = nr + 1
+  end
+
+  def self.list_jobs
+    QbwcJob.all.map {|ar_job| ar_job.to_qbwc_job}
+  end
+
+  def self.clear_jobs
+    QbwcJob.delete_all
+  end
+
+  def self.sort_in_time_order(ary)
+    ary.sort {|a,b| a.find_ar_job.first.created_at <=> b.find_ar_job.first.created_at}
+  end
+
+end

data/lib/qbwc/active_record/session.rb

@@ -0,0 +1,52 @@
+class QBWC::ActiveRecord::Session < QBWC::Session
+  class QbwcSession < ActiveRecord::Base
+    attr_accessible :company, :ticket, :user unless Rails::VERSION::MAJOR >= 4
+  end
+
+	def self.get(ticket)
+		session = QbwcSession.find_by_ticket(ticket)
+    self.new(session) if session
+	end
+
+  def initialize(session_or_user = nil, company = nil, ticket = nil)
+    if session_or_user.is_a? QbwcSession
+      @session = session_or_user
+      # Restore current job from saved one on QbwcSession
+      @current_job = QBWC.get_job(@session.current_job) if @session.current_job
+      # Restore pending jobs from saved list on QbwcSession
+      @pending_jobs = @session.pending_jobs.split(',').map { |job_name| QBWC.get_job(job_name) }.select { |job| ! job.nil? }
+      super(@session.user, @session.company, @session.ticket)
+    else
+      super
+      @session = QbwcSession.new
+      @session.user = self.user
+      @session.company = self.company
+      @session.ticket = self.ticket
+      self.save
+      @session
+    end
+  end
+
+  def save
+    @session.pending_jobs = pending_jobs.map(&:name).join(',')
+    @session.current_job = current_job.try(:name)
+    @session.save
+    super
+  end
+
+  def destroy
+    @session.destroy
+    super
+  end
+
+  [:error, :progress, :iterator_id].each do |method|
+    define_method method do
+      @session.send(method)
+    end
+    define_method "#{method}=" do |value|
+      @session.send("#{method}=", value)
+    end
+  end
+  protected :progress=, :iterator_id=, :iterator_id
+
+end