effective_qb_online 0.1.0

data/app/models/effective/qb_receipt_item.rb

@@ -0,0 +1,26 @@
+module Effective
+  class QbReceiptItem < ActiveRecord::Base
+    belongs_to :qb_receipt
+    belongs_to :order_item
+
+    log_changes(to: :qb_receipt) if respond_to?(:log_changes)
+
+    effective_resource do
+      # Will be blank when first created. Populated by QbSalesReceipt.build_from_receipt!
+      item_id       :string
+
+      timestamps
+    end
+
+    scope :deep, -> { includes(:qb_receipt, :order_item) }
+
+    def to_s
+      item_id.presence || 'New Qb Receipt Item'
+    end
+
+    def order_item_qb_name
+      item_id || order_item.purchasable.try(:qb_item_id) || order_item.purchasable.try(:qb_item_name)
+    end
+
+  end
+end

data/app/models/effective/qb_sales_receipt.rb

@@ -0,0 +1,101 @@
+module Effective
+  class QbSalesReceipt
+
+    # Build the Quickbooks SalesReceipt from a QbReceipt
+    def self.build_from_receipt!(receipt, api: nil)
+      raise('Expected a persisted Effective::QbReceipt') unless receipt.kind_of?(Effective::QbReceipt) && receipt.persisted?
+
+      api ||= EffectiveQbOnline.api
+      raise('Expected a connected Quickbooks API') unless api.present?
+
+      order = receipt.order
+      raise('Expected a purchased Effective::Order') unless order.purchased?
+
+      user = order.user
+      raise('Expected a user with an email') unless user.respond_to?(:email)
+
+      realm = api.realm
+      raise('Missing Deposit to Account') unless realm.deposit_to_account_id.present?
+      raise('Missing Payment Method') unless realm.payment_method_id.present?
+
+      taxes = api.taxes_collection
+      raise("Missing Tax Code for tax rate #{order.tax_rate.presence || 'blank'}") unless taxes[order.tax_rate.to_s].present?
+      raise("Missing Tax Code for tax exempt 0.0 rate") unless taxes['0.0'].present?
+
+      # Find and validate items
+      items = api.items()
+
+      receipt.qb_receipt_items.each do |receipt_item|
+        purchasable = receipt_item.order_item.purchasable
+        raise("Expected a purchasable for Effective::OrderItem #{receipt_item.order_item.id}") unless purchasable.present?
+
+        # Find item by receipt item
+        item = items.find { |item| [item.id, item.name].include?(receipt_item.item_id) }
+
+        # Find item by purchasable qb_item_id and qb_item_name
+        item ||= begin
+          purchasable_id_name = [purchasable.try(:qb_item_id), purchasable.try(:qb_item_name)]
+          items.find { |item| ([item.id, item.name] & purchasable_id_name).present? }
+        end
+
+        if item.blank?
+          raise("Unknown Quickbooks Item for #{purchasable} (#{purchasable.class.name} ##{purchasable.id})")
+        end
+
+        receipt_item.update!(item_id: item.id)
+      end
+
+      # Find or build customer
+      if receipt.customer_id.blank?
+        customer = api.find_or_create_customer(user: user)
+        receipt.update!(customer_id: customer.id)
+      end
+
+      # Receipt
+      sales_receipt = Quickbooks::Model::SalesReceipt.new(
+        customer_id: receipt.customer_id,
+        deposit_to_account_id: api.realm.deposit_to_account_id,   # The ID of the Account Entity you want hte SalesReceipt to be deposited to
+        payment_method_id: api.realm.payment_method_id,           # The ID of the PaymentMethod Entity
+        payment_ref_number: order.to_param,                       # Optional payment reference number/string
+        txn_date: order.purchased_at.to_date,
+        customer_memo: order.note_to_buyer,
+        private_note: order.note_internal,
+        bill_email: Quickbooks::Model::EmailAddress.new(order.email),
+        email_status: 'EmailSent'
+      )
+
+      # Allows Quickbooks to auto-generate the transaction number
+      sales_receipt.auto_doc_number!
+
+      # Addresses
+      sales_receipt.bill_address = api.build_address(order.billing_address) if order.billing_address.present?
+      sales_receipt.ship_address = api.build_address(order.shipping_address) if order.shipping_address.present?
+
+      # Line Items
+      tax_code = taxes[order.tax_rate.to_s]
+      tax_exempt = taxes['0.0']
+
+      receipt.qb_receipt_items.each do |receipt_item|
+        order_item = receipt_item.order_item
+        line_item = Quickbooks::Model::Line.new(amount: api.price_to_amount(order_item.subtotal), description: order_item.name)
+
+        line_item.sales_item! do |line|
+          line.item_id = receipt_item.item_id
+          line.tax_code_id = (order_item.tax_exempt? ? tax_exempt.id : tax_code.id)
+
+          line.unit_price = api.price_to_amount(order_item.price)
+          line.quantity = order_item.quantity
+        end
+
+        sales_receipt.line_items << line_item
+      end
+
+      # Double check
+      raise("Invalid SalesReceipt generated for Effective::Order #{order.id}") unless sales_receipt.valid?
+
+      # Return a Quickbooks::Model::SalesReceipt that is ready to create
+      sales_receipt
+    end
+
+  end
+end

data/app/views/admin/qb_online/_company.html.haml

@@ -0,0 +1,31 @@
+%table.table.table-sm
+  - company_info = api.company_info
+
+  %tbody
+    %tr
+      %td Name
+      %td= company_info.company_name
+
+    %tr
+      %td Country
+      %td= company_info.country
+
+    %tr
+      %td OAuth2 Connection
+      %td= link_to('Reconnect to Quickbooks Online', effective_qb_online.quickbooks_oauth_path)
+
+    %tr
+      %td Deposit to Account
+      %td
+        = effective_form_with(model: [:admin, api.realm], engine: true) do |f|
+          .row
+            .col= f.select :deposit_to_account_id, api.accounts_collection, grouped: true, label: false
+            .col= f.save
+
+    %tr
+      %td Payment Method
+      %td
+        = effective_form_with(model: [:admin, api.realm], engine: true) do |f|
+          .row
+            .col= f.select :payment_method_id, api.payment_methods_collection, label: false
+            .col= f.save

data/app/views/admin/qb_online/_test_credentials.html.haml

@@ -0,0 +1,15 @@
+- realm = api.realm
+
+%p
+  QB_REALM_ID=#{realm.realm_id}
+  %br
+  QB_ACCESS_TOKEN=#{realm.access_token}
+  %br
+  QB_REFRESH_TOKEN=#{realm.refresh_token}
+  %br
+  QB_DEPOSIT_TO_ACCOUNT=#{realm.deposit_to_account_id}
+  %br
+  QB_PAYMENT_METHOD=#{realm.payment_method_id}
+
+%p
+  %small Copy these values into effective_qb_online/.env to run the test suite

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

@@ -0,0 +1,14 @@
+%h1.effective-admin-heading= @page_title
+
+- if Rails.env.development?
+  = card('Test Credentials') do
+    = render('test_credentials', api: @api)
+
+= card('Company') do
+  = render('company', api: @api)
+
+= card('Sales Receipts') do
+  .text-right.mb-2
+    = link_to 'New Sales Receipt', effective_qb_online.new_admin_qb_receipt_path, class: 'btn btn-primary btn-sm'
+
+  = render_datatable(Admin::EffectiveQbReceiptsDatatable.new)

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

@@ -0,0 +1,18 @@
+%h1.effective-page-title= @page_title
+
+%p Welcome to the Quickbooks Online first run instructions!
+
+%p
+  1.) Ask Code & Effect to add a Redirect URI
+  to the Quickbooks Online Effective Orders application.
+
+%ul
+  %li The uri is: #{effective_qb_online.quickbooks_oauth_callback_url}
+
+%p
+  2.) Then
+  = link_to('click here', effective_qb_online.quickbooks_oauth_path)
+  and sign in to the Quickbooks Online company you wish to connect.
+
+%p
+  3.) Once connected, you will be be returned to this website. All done!

data/app/views/admin/qb_receipts/_form.html.haml

@@ -0,0 +1,40 @@
+= effective_form_with(model: [:admin, qb_receipt], engine: true) do |f|
+
+  - if f.object.new_record?
+    = f.select :order_id, qb_receipt_effective_orders_collection(f.object), required: true,
+      label: 'Unsynchronized purchased order',
+      hint: "If you don't see your purchased order in the list, it already has an existing sales receipt."
+
+  - if f.object.persisted?
+    = f.static_field :order
+
+    = f.static_field :updated_at
+
+    = f.static_field :status
+    = f.static_field :result, label: 'Quickbooks Online Result'
+
+    %table.table.table-sm
+      %thead
+        %tr
+          %th Id
+          %th Order Item
+          %th Existing Name
+          %th Quickbooks Online Item
+
+      %tbody
+        - items_collection = EffectiveQbOnline.api.items_collection
+        - items = items_collection.flatten(2)
+
+        = f.fields_for :qb_receipt_items do |fi|
+          %tr
+            %td= fi.object.order_item_id
+            %td= fi.object.order_item
+            %td
+              - if fi.object.item_id.present?
+                - existing = items.find { |(name, id)| id == fi.object.item_id }&.first
+
+              = existing || fi.object.order_item_qb_name || '-'
+
+            %td= fi.select :item_id, items_collection, grouped: true, label: false
+
+  = f.submit 'Save and Sync'

data/app/views/admin/qb_receipts/edit.html.haml

@@ -0,0 +1,4 @@
+%h1.effective-admin-heading= @page_title
+
+= card(@qb_receipt) do
+  = render_resource_form(@qb_receipt)

data/app/views/admin/qb_receipts/new.html.haml

@@ -0,0 +1,4 @@
+%h1.effective-admin-heading= @page_title
+
+= card(@qb_receipt) do
+  = render_resource_form(@qb_receipt)

data/config/effective_qb_online.rb

@@ -0,0 +1,23 @@
+EffectiveQbOnline.setup do |config|
+  config.qb_realms_table_name = :qb_realms
+  config.qb_receipts_table_name = :qb_receipts
+  config.qb_receipt_items_table_name = :qb_receipt_items
+
+  # Layout Settings
+  # Configure the Layout per controller, or all at once
+  # config.layout = { application: 'application', admin: 'admin' }
+
+  # Quickbooks Online Application
+  # Client and Seceret
+  config.oauth_client_id = ENV['QUICKBOOKS_ONLINE_OAUTH_CLIENT_ID']
+  config.oauth_client_secret = ENV['QUICKBOOKS_ONLINE_OAUTH_CLIENT_SECRET']
+
+  # Quickbooks API
+  # https://github.com/ruckus/quickbooks-ruby
+  Quickbooks.sandbox_mode = (ENV['QUICKBOOKS_ONLINE_SANDBOX'].to_s == 'true')
+
+  # Effective Orders
+  # Add the following to your config/intializers/effective_orders.rb
+  # config.use_effective_qb_online = true
+
+end

data/config/routes.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+Rails.application.routes.draw do
+  mount EffectiveQbOnline::Engine => '/', as: 'effective_qb_online'
+end
+
+EffectiveQbOnline::Engine.routes.draw do
+  # Public routes
+  scope module: 'effective' do
+    get '/quickbooks/oauth/authorize', to: 'qb_oauth#authorize', as: :quickbooks_oauth
+    get '/quickbooks/oauth/callback', to: 'qb_oauth#callback', as: :quickbooks_oauth_callback
+  end
+
+  namespace :admin do
+    resources :qb_realms, only: [:edit, :update]
+
+    resources :qb_receipts, except: [:show, :destroy] do
+      post :skip, on: :member
+      post :sync, on: :member
+    end
+
+    get '/quickbooks', to: 'qb_online#index', as: :quickbooks
+  end
+
+end

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

@@ -0,0 +1,40 @@
+class CreateEffectiveQbOnline < ActiveRecord::Migration[6.1]
+  def change
+    create_table <%= @qb_realms_table_name %> do |t|
+      t.string :realm_id
+
+      t.integer :deposit_to_account_id
+      t.integer :payment_method_id
+
+      t.text :access_token
+      t.datetime :access_token_expires_at
+
+      t.text :refresh_token
+      t.datetime :refresh_token_expires_at
+
+      t.timestamps
+    end
+
+    create_table <%= @qb_receipts_table_name %> do |t|
+      t.integer :order_id
+      t.integer :customer_id
+
+      t.text :result
+
+      t.string :status
+      t.text :status_steps
+
+      t.timestamps
+    end
+
+    create_table <%= @qb_receipt_items_name %> do |t|
+      t.integer :qb_receipt_id
+      t.integer :order_item_id
+
+      t.integer :item_id
+
+      t.timestamps
+    end
+
+  end
+end

data/db/seeds.rb

@@ -0,0 +1 @@
+puts "Running effective_qb_online seeds"

data/lib/effective_qb_online/engine.rb

@@ -0,0 +1,17 @@
+module EffectiveQbOnline
+  class Engine < ::Rails::Engine
+    engine_name 'effective_qb_online'
+
+    # Set up our default configuration options.
+    initializer 'effective_qb_online.defaults', before: :load_config_initializers do |app|
+      eval File.read("#{config.root}/config/effective_qb_online.rb")
+    end
+
+    # Include acts_as_addressable concern and allow any ActiveRecord object to call it
+    initializer 'effective_qb_online.active_record' do |app|
+      ActiveSupport.on_load :active_record do
+      end
+    end
+
+  end
+end

data/lib/effective_qb_online/version.rb

@@ -0,0 +1,3 @@
+module EffectiveQbOnline
+  VERSION = '0.1.0'.freeze
+end

data/lib/effective_qb_online.rb

@@ -0,0 +1,55 @@
+require 'quickbooks-ruby'
+require 'effective_resources'
+require 'effective_datatables'
+require 'effective_qb_online/engine'
+require 'effective_qb_online/version'
+
+module EffectiveQbOnline
+  def self.config_keys
+    [
+      :qb_realms_table_name, :qb_receipts_table_name, :qb_receipt_items_table_name,
+      :oauth_client_id, :oauth_client_secret,
+      :layout
+    ]
+  end
+
+  include EffectiveGem
+
+  def self.oauth2_client
+    OAuth2::Client.new(
+      oauth_client_id,
+      oauth_client_secret,
+      site: 'https://appcenter.intuit.com/connect/oauth2',
+      authorize_url: 'https://appcenter.intuit.com/connect/oauth2',
+      token_url: 'https://oauth.platform.intuit.com/oauth2/v1/tokens/bearer'
+    )
+  end
+
+  def self.api(realm: nil)
+    realm ||= Effective::QbRealm.first
+    return nil if realm.blank?
+
+    Effective::QbApi.new(realm: realm)
+  end
+
+  def self.sync_order!(order, perform_now: false)
+    raise 'expected a purchased Effective::Order' unless order.kind_of?(Effective::Order) && order.purchased?
+
+    if perform_now
+      qb_receipt = Effective::QbReceipt.create_from_order!(order)
+      qb_receipt.sync!
+    else
+      QbSyncOrderJob.perform_later(order)
+    end
+
+    true
+  end
+
+  def self.skip_order!(order)
+    raise 'expected a purchased Effective::Order' unless order.kind_of?(Effective::Order) && order.purchased?
+
+    qb_receipt = Effective::QbReceipt.create_from_order!(order)
+    qb_receipt.skip!
+  end
+
+end

data/lib/generators/effective_qb_online/install_generator.rb

@@ -0,0 +1,32 @@
+module EffectiveMemberships
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      desc 'Creates an EffectiveQbOnline initializer in your application.'
+
+      source_root File.expand_path('../../templates', __FILE__)
+
+      def self.next_migration_number(dirname)
+        if not ActiveRecord::Base.timestamped_migrations
+          Time.new.utc.strftime("%Y%m%d%H%M%S")
+        else
+          '%.3d' % (current_migration_number(dirname) + 1)
+        end
+      end
+
+      def copy_initializer
+        template ('../' * 3) + 'config/effective_qb_online.rb', 'config/initializers/effective_qb_online.rb'
+      end
+
+      def create_migration_file
+        @qb_realms_table_name  = ':' + EffectiveQbOnline.qb_realms_table_name.to_s
+        @qb_receipts_table_name  = ':' + EffectiveQbOnline.qb_receipts_table_name.to_s
+        @qb_receipt_items_table_name  = ':' + EffectiveQbOnline.qb_receipt_items_table_name.to_s
+
+        migration_template ('../' * 3) + 'db/migrate/01_create_effective_qb_online.rb.erb', 'db/migrate/create_effective_qb_online.rb'
+      end
+
+    end
+  end
+end

data/lib/generators/templates/effective_qb_online_mailer_preview.rb

@@ -0,0 +1,4 @@
+# Visit http://localhost:3000/rails/mailers
+
+class EffectiveQbOnlineMailerPreview < ActionMailer::Preview
+end

data/lib/tasks/effective_qb_online_tasks.rake

@@ -0,0 +1,8 @@
+namespace :effective_qb_online do
+
+  # bundle exec rake effective_qb_online:seed
+  task seed: :environment do
+    load "#{__dir__}/../../db/seeds.rb"
+  end
+
+end