effective_qb_sync 1.0.0

data/app/views/admin/qb_syncs/_actions.html.haml

@@ -0,0 +1,2 @@
+= link_to effective_qb_sync.admin_qb_sync_path(qb_sync), title: 'View' do
+  %span.glyphicon.glyphicon-eye-open

data/app/views/admin/qb_syncs/_qb_item_names.html.haml

@@ -0,0 +1,9 @@
+%table.table
+  %thead
+    %th Quickbooks Item Name/Number
+    -#%th Website object
+  %tbody
+    - ActsAsPurchasable.descendants.each do |klass|
+      %tr
+        %td= klass.new().try(:qb_item_name)
+        -#%td= klass.name

data/app/views/admin/qb_syncs/index.html.haml

@@ -0,0 +1,24 @@
+%h2.effective-qb-sync-page-title= (@page_title || 'Quickbooks Synchronizations')
+
+%p.text-right.effective-qb-sync-page-action
+  = link_to 'Quickbooks Setup Instructions', effective_qb_sync.instructions_admin_qb_syncs_path, class: 'btn btn-primary'
+
+%hr
+- unsynced = Effective::QbRequest.new_requests_for_unsynced_items.length
+
+- if unsynced == 0
+  %p All orders have been synchronized with Quickbooks.
+- elsif unsynced == 1
+  %p There is 1 order ready to be synchronized with Quickbooks.
+- else
+  %p There are #{unsynced} orders ready to be synchronized with Quickbooks.
+
+%hr
+
+- if @datatable.nil?
+  %p Please install #{link_to 'effective_datatables', 'https://github.com/code-and-effect/effective_datatables'} to see this page.
+- elsif @datatable.present?
+  = render_datatable @datatable
+- else
+  %p There are no Quickbook Syncs present
+

data/app/views/admin/qb_syncs/instructions.html.haml

@@ -0,0 +1,136 @@
+%h2.effective-qb-sync-page-title= @page_title
+
+%h3 1. Create a Quickbooks user for sync
+
+%p The Quickbooks web connector requires a user be created for synchronization.
+
+%ul
+  %li
+    Open the Quickbooks Pro company file that will be synchronized with the website
+  %li
+    Click Company -> Set up Users and Passwords -> Set Up Users...
+    - if EffectiveQbSync.quickbooks_username.present? && EffectiveQbSync.quickbooks_password.present?
+      %li
+        Add a Quickbooks user with username
+        %strong= EffectiveQbSync.quickbooks_username
+        and password
+        %strong= EffectiveQbSync.quickbooks_password
+    - else
+      %li
+        (developer) Add a quickbooks_username and quickbooks_password to the config/initializers/effective_qb_sync.rb file
+        %ul
+          %li Add a Quickbooks user with that same username and password
+    %li Access for user: "Selected areas of Quickbooks"
+    %li Sales and Accounts Receivable "Selective Access - Create transactions only"
+    %li Purchases and Accounts Payable "No Access"
+    %li Chequing and Credit Cards "No Access"
+    %li Time Tracking "No Access"
+    %li Payroll and Employees "No Access"
+    %li Sales Tax "No Access"
+    %li Sensitive Accounting Activities "No Access"
+    %li Sensitive Financial Reporting "No Access"
+    %li Changing or Deleting Transactions "Yes" and "No"
+    %li Finished
+
+%h3 2. Create all Quickbooks items
+
+%p
+  Each acts_as_purchasable object on the website has a qb_item_name that must match an existing Quickbooks Item.
+  %br
+  The website's price will override any Quickbooks default item prices.
+
+%p Make sure a Quickbooks Item exists for each of the following:
+= render partial: '/admin/qb_syncs/qb_item_names'
+
+%p To add an Item in Quickbooks:
+
+%ul
+  %li Click the menu bar Lists -> Item List
+  %li In the bottom left, Item -> New
+  %li Make sure the "Item Name/Number" matches with above.
+
+%h3 3. Configure the Quickbooks Sales Tax Behaviour
+
+%p Quickbooks sales tax can be configured in one of two ways:
+
+%ul
+  %li
+    Sales tax should be added by Quickbooks
+    %ul
+      %li Click Edit -> Preferences -> Sales Tax -> Company Preferences
+      %li Do you charge sales tax? Yes
+      %li Add sales tax item...
+      %li Set the config/initializers/effective_qb_sync.rb "quickbooks_tax_name" to an empty string
+      %li When synchronizing, the website will not add in the tax amount
+      %li Quickbooks will consider the order subtotal and add the appropriate tax amount
+
+  %li
+    Sales tax should be added by the website
+    %ul
+      %li Click Edit -> Preferences -> Sales Tax -> Company Preferences
+      %li Do you charge sales tax? No
+      %li Add a regular Quickbooks Item (as per 2. Create all Quickbooks items instructions, above)
+      %li
+        - if EffectiveQbSync.quickbooks_tax_name.present?
+          Ensure that the Item Name in Quickbooks is
+          %strong #{EffectiveQbSync.quickbooks_tax_name}
+        - else
+          (developer) Add a quickbooks_tax_name to the config/initializers/effective_qb_sync.rb file
+      %li The website will add an additional line item with the tax amount.
+
+%p
+  Currently, the website is configured such that:
+  %strong
+    - if EffectiveQbSync.quickbooks_tax_name.present?
+      Sales tax should be added by the website
+    - else
+      Sales tax should be added by Quickbooks
+
+
+%h3 4. Configure the Quickbooks Web Connector
+
+%p Now that the Quickbooks company file has been configured, it is time to set up the Quickbooks Web Connector program.
+
+%ul
+  %li
+    Download the #{link_to 'quickbooks web connector .qwc file', (effective_qb_sync.qwc_admin_qb_syncs_path)} and put it somewhere safe
+  %li
+    Open the Quickbooks Web Connector program from the Start menu
+    %ul
+      %li Click Add an application
+      %li Select the .qwc file just downloaded
+      %li Click OK to add the new web service
+      %li Select any of the 'Yes' options (Yes, always; allow access even if Quickbooks is not running is prefered) and Continue...
+      %li Done
+      %li
+        If the .qwc file doesn't add properly, you can edit the .qwc file with wordpad, and check the following:
+        %ul
+          %li The AppID must be unique between all other .qwc files
+          %li
+            The AppURL must be an
+            %strong https://
+            url that ends with
+            %strong= effective_qb_sync.qb_sync_path
+            such as
+            %strong https://myapp.heroku.com#{effective_qb_sync.qb_sync_path}
+          %li The AppSupport url doesn't matter
+          %li The UserName must be present and match an existing user
+          %li The OwnerID and FileID values must also be unique between all other .qwc files
+      %li Enter the password as above and Save it
+
+
+%h3 5. Start the Synchronization
+
+%p Everything is ready to go. Good luck with the first synchronization!
+
+%ul
+  %li Open the Quickbooks Web Connector
+  %li Check the far left checkbox next to the new application
+  %li Click Update Selected to do the sync
+  %li (optional) or enable Auto-Run
+  %li
+    If any synchronization errors occur,
+    %strong= EffectiveQbSync.error_email || EffectiveOrders.mailer[:admin_email]
+    will receive an email with instructions on how to fix the error
+
+

data/app/views/admin/qb_syncs/show.html.haml

@@ -0,0 +1,52 @@
+%h2.effective-qb-sync-page-title= @page_title
+
+%table.table
+  %tbody
+    - @qb_ticket.attributes.except('hpc_response', 'qb_request_id', 'id').each do |key, value|
+      %tr
+        %th= key.titleize
+        %td= value
+
+%h3 Orders
+
+= simple_form_for @qb_order_items_form, (EffectiveOrders.admin_simple_form_options || {}).merge(url: effective_qb_sync.admin_qb_sync_path(@qb_order_items_form)) do |f|
+  %table.table
+    %thead
+      %tr
+        %th Order
+        %th Order Item
+        %th Quickbooks Item Name
+    %tbody
+      - @qb_ticket.orders.each do |order|
+        - order.order_items.each_with_index do |order_item, index|
+          %tr
+            %td= (link_to(('#' + order.to_param.to_s), effective_orders.admin_order_path(order)) if index == 0)
+            %td= order_item
+            %td
+              = f.simple_fields_for :qb_order_items, order_item.qb_order_item do |foi|
+                = foi.input :order_item_id, as: :hidden, value: order_item.id
+                = foi.input :name, label: false, required: false
+
+  %p= f.button :submit, 'Save Quickbooks Item Names', data: { disable_with: 'Saving...' }
+
+
+
+%h3 Sync Log
+
+%table.table
+  %thead
+    %tr
+      %th Time
+      %th Message
+  %tbody
+    - @qb_ticket.qb_logs.each do |qb_log|
+      %tr
+        %th= qb_log.created_at.strftime("%H:%M:%S").html_safe
+        %td= qb_log.message
+
+
+
+
+
+
+

data/app/views/effective/orders_mailer/qb_sync_error.html.haml

@@ -0,0 +1,56 @@
+!!!
+%html
+  %head
+    %meta{:content => 'text/html; charset=UTF-8', 'http-equiv' => "Content-Type"}
+  %body
+
+    %p
+      %strong An error occurred while synchronizing QuickBooks:
+
+    - if @error.present?
+      %p= @error
+
+    - if @order.present?
+      %p
+        %strong= "Order ##{@order.to_param}"
+        %br
+        = @order.created_at
+        %br
+        = @order.billing_name
+        %br
+        - @order.order_items.each do |oi|
+          = "#{oi.title} (#{oi.try(:qb_item_name)})"
+          %br
+
+    %p
+      %strong Resolution steps:
+
+    %ol
+      - if @error.include?('invalid reference to QuickBooks Item')
+        %li Confirm the QuickBooks Item Names for this Order within QuickBooks
+        %li Visit the website administration
+        %li Visit the Orders screen, find the order, and click the 'QB Item Names'
+        %li Update each order item with a correct Item Name
+        %li Update the Product (Event, Membership Type, Product, etc.) with the correct Item Name
+        %li Re-run the QuickBooks Sync
+
+      - elsif @error.include?('the list element is already in use')
+        %li This customer could not be created because they share a name with an existing Item Name. This could be as a Vendor, Product, or Service.
+        %li Search QuickBooks for the non-customer item name and rename it. Ex: rename "John Doe" to "John Doe (Vendor)"
+        %li Re-run the QuickBooks Sync
+
+      - elsif @error.include?('cannot use the same tax item')
+        %li QuickBooks has been configured to automatically add GST for this item, but the order already contains a GST line item
+        %li Edit the item in QuickBooks and uncheck the inclusion of GST
+        %li Re-run the QuickBooks Sync
+
+      - else
+        %li This is an error without a predefined resolution. Please wait for AgileStyle to follow up with you.
+
+-# Common error messages for refernece:
+
+-# An unexpected error occurred: Order 31 could not be synchronized with QuickBooks: There is an  "qbitemname" in the SalesReceipt line. QuickBooks error message: Invalid argument. The specified record does not exist in the list.
+
+-# An unexpected error occurred: Order 190 could not be synchronized with QuickBooks: There is an invalid reference to QuickBooks Item "GST (1) On Sales" in the SalesReceipt line. QuickBooks error message: You cannot use the same tax item in both the line items and the txn tax.
+
+-# An unexpected error occurred: Customer Peter Jenkins could not be created in QuickBooks: The name "Peter Jenkins" of the list element is already in use.

data/app/views/effective/qb_sync/authenticate.erb

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://developer.intuit.com/">
+	<SOAP-ENV:Body>
+		<ns1:authenticateResponse>
+			<ns1:authenticateResult>
+				<ns1:string><%= @token %></ns1:string>
+				<ns1:string><%= @message %></ns1:string>
+			</ns1:authenticateResult>
+		</ns1:authenticateResponse>
+	</SOAP-ENV:Body>
+</SOAP-ENV:Envelope>
+

data/app/views/effective/qb_sync/clientVersion.erb

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="utf-8"?>
+<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+  <soap:Body>
+    <clientVersionResponse xmlns="http://developer.intuit.com/">
+      <clientVersionResult><%= @version %></clientVersionResult>
+    </clientVersionResponse>
+  </soap:Body>
+</soap:Envelope>

data/app/views/effective/qb_sync/closeConnection.erb

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="utf-8"?>
+<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
+  <soap12:Body>
+    <closeConnectionResponse xmlns="http://developer.intuit.com/">
+      <closeConnectionResult><%= @message %></closeConnectionResult>
+    </closeConnectionResponse>
+  </soap12:Body>
+</soap12:Envelope>

data/app/views/effective/qb_sync/connectionError.erb

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="utf-8"?>
+<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+  <soap:Body>
+    <connectionErrorResponse xmlns="http://developer.intuit.com/">
+      <connectionErrorResult><%= @message %></connectionErrorResult>
+    </connectionErrorResponse>
+  </soap:Body>
+</soap:Envelope>
+

data/app/views/effective/qb_sync/getLastError.erb

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="utf-8"?>
+<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+  <soap:Body>
+    <getLastErrorResponse xmlns="http://developer.intuit.com/">
+      <getLastErrorResult><%= @message %></getLastErrorResult>
+    </getLastErrorResponse>
+  </soap:Body>
+</soap:Envelope>
+

data/app/views/effective/qb_sync/receiveResponseXML.erb

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="utf-8"?>
+<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+  <soap:Body>
+    <receiveResponseXMLResponse xmlns="http://developer.intuit.com/">
+      <receiveResponseXMLResult><%= @message %></receiveResponseXMLResult>
+    </receiveResponseXMLResponse>
+  </soap:Body>
+</soap:Envelope>

data/app/views/effective/qb_sync/sendRequestXML.erb

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="utf-8"?>
+<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+  <soap:Body>
+    <sendRequestXMLResponse xmlns="http://developer.intuit.com/">
+      <sendRequestXMLResult><%= @message %></sendRequestXMLResult>
+    </sendRequestXMLResponse>
+  </soap:Body>
+</soap:Envelope>

data/app/views/effective/qb_sync/serverVersion.erb

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="utf-8"?>
+<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+  <soap:Body>
+    <serverVersionResponse xmlns="http://developer.intuit.com/">
+      <serverVersionResult><%= @version %></serverVersionResult>
+    </serverVersionResponse>
+  </soap:Body>
+</soap:Envelope>

data/app/views/effective/qb_web_connector/quickbooks.qwc.erb

@@ -0,0 +1,12 @@
+<QBWCXML>
+   <AppName><%= Rails.application.class.parent_name.upcase %> Web Connector</AppName>
+   <AppID>{<%= SecureRandom.uuid.upcase %>}</AppID>
+   <AppURL><%= effective_qb_sync.qb_sync_url(protocol: 'https') %></AppURL>
+   <AppDescription><%= Rails.application.class.parent_name.upcase %> EffectiveOrders to Quickbooks Web Connector</AppDescription>
+   <AppSupport><%= effective_qb_sync.instructions_admin_qb_syncs_url(protocol: 'https') %></AppSupport>
+   <UserName><%= EffectiveQbSync.quickbooks_username || 'MISSING' %></UserName>
+   <OwnerID>{<%= SecureRandom.uuid.upcase %>}</OwnerID>
+   <FileID>{<%= SecureRandom.uuid.upcase %>}</FileID>
+   <QBType>QBFS</QBType>
+   <Style>DocWrapped</Style>
+</QBWCXML>

data/config/routes.rb

@@ -0,0 +1,16 @@
+Rails.application.routes.draw do
+  mount EffectiveQbSync::Engine => '/', as: 'effective_qb_sync'
+end
+
+EffectiveQbSync::Engine.routes.draw do
+  scope module: 'effective' do
+    match 'quickbooks/api', to: 'qb_sync#api', as: 'qb_sync', via: :all
+  end
+
+  namespace :admin do
+    resources :qb_syncs, only: [:index, :show, :update] do
+      get :instructions, on: :collection
+      get :qwc, on: :collection
+    end
+  end
+end

data/db/migrate/01_create_effective_qb_sync.rb.erb

@@ -0,0 +1,68 @@
+class CreateEffectiveQbSync < ActiveRecord::Migration
+  def self.up
+    create_table <%= @qb_requests_table_name %> do |t|
+      t.integer   :order_id
+      t.integer   :qb_ticket_id
+
+      t.string    :state, default: 'Processing'
+      t.text      :error
+
+      t.string    :request_type
+      t.text      :request_qbxml
+      t.text      :response_qbxml
+
+      t.datetime  :request_sent_at
+      t.datetime  :response_received_at
+
+      t.timestamps
+    end
+    add_index <%= @qb_requests_table_name %>, :order_id
+
+    create_table <%= @qb_tickets_table_name %> do |t|
+      t.integer   :qb_request_id
+
+      t.string    :username
+      t.text      :hpc_response
+      t.string    :company_file_name
+      t.string    :country
+      t.string    :qbxml_major_version
+      t.string    :qbxml_minor_version
+
+      t.string    :state, default: 'Ready'
+      t.integer   :percent, default: 0
+
+      t.text      :connection_error_hresult
+      t.text      :connection_error_message
+      t.text      :last_error
+
+      t.timestamps
+    end
+    add_index <%= @qb_tickets_table_name %>, :qb_request_id
+
+    create_table <%= @qb_logs_table_name %> do |t|
+      t.integer   :qb_ticket_id
+
+      t.text      :message
+
+      t.timestamps
+    end
+    add_index <%= @qb_logs_table_name %>, :qb_ticket_id
+
+    create_table <%= @qb_order_items_table_name %> do |t|
+      t.integer    :order_item_id
+
+      t.string     :name
+
+      t.timestamps
+    end
+    add_index <%= @qb_order_items_table_name %>, :order_item_id
+
+  end
+
+  def self.down
+    drop_table <%= @qb_requests_table_name %>
+    drop_table <%= @qb_tickets_table_name %>
+    drop_table <%= @qb_logs_table_name %>
+    drop_table <%= @qb_order_items_table_name %>
+  end
+end