effective_qb_sync 1.0.0

data/lib/effective_qb_sync/engine.rb

@@ -0,0 +1,42 @@
+module EffectiveQbSync
+  class Engine < ::Rails::Engine
+    engine_name 'effective_qb_sync'
+
+    config.autoload_paths += Dir["#{config.root}/app/models/**/"]
+
+    # Set up our default configuration options.
+    initializer "effective_qb_sync.defaults", before: :load_config_initializers do |app|
+      eval File.read("#{config.root}/lib/generators/templates/effective_qb_sync.rb")
+    end
+
+    # Ensure every acts_as_purchasable object responds to qb_item_name
+    initializer 'effective_qb_sync.assert_qb_item_names_present' do |app|
+      if Rails.env.development?
+        Rails.application.eager_load!
+
+        invalids = ActsAsPurchasable.descendants.reject { |klass| klass.new().try(:qb_item_name).present? }
+
+        if invalids.present?
+          raise "expected acts_as_purchasable objects #{invalids.map(&:to_s).to_sentence} .qb_item_name() to be present."
+        end
+      end
+    end
+
+    # Include acts_as_addressable concern and allow any ActiveRecord object to call it
+    initializer 'effective_qb_sync.active_record' do |app|
+      Rails.application.config.to_prepare do
+        ActiveSupport.on_load :active_record do
+          Effective::OrderItem.class_eval do
+            has_one :qb_order_item
+
+            # first or build
+            def qb_item_name
+              (qb_order_item || build_qb_order_item(name: purchasable.try(:qb_item_name))).name
+            end
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/effective_qb_sync/version.rb

@@ -0,0 +1,3 @@
+module EffectiveQbSync
+  VERSION = '1.0.0'.freeze
+end

data/lib/effective_qb_sync.rb

@@ -0,0 +1,42 @@
+require 'haml-rails'
+require 'simple_form'
+require 'effective_orders'
+require 'effective_qb_sync/engine'
+require 'effective_qb_sync/version'
+
+module EffectiveQbSync
+  # The following are all valid config keys
+  mattr_accessor :qb_requests_table_name
+  mattr_accessor :qb_tickets_table_name
+  mattr_accessor :qb_logs_table_name
+  mattr_accessor :qb_order_items_table_name
+
+  mattr_accessor :authorization_method
+
+  mattr_accessor :quickbooks_username
+  mattr_accessor :quickbooks_password
+  mattr_accessor :quickbooks_tax_name
+
+  mattr_accessor :error_email
+
+  mattr_accessor :layout
+  mattr_accessor :admin_simple_form_options
+
+  def self.setup
+    yield self
+  end
+
+  def self.authorized?(controller, action, resource)
+    if authorization_method.respond_to?(:call) || authorization_method.kind_of?(Symbol)
+      raise Effective::AccessDenied.new() unless (controller || self).instance_exec(controller, action, resource, &authorization_method)
+    end
+    true
+  end
+
+  def self.permitted_params
+    [
+      :note
+    ]
+  end
+
+end

data/lib/generators/effective_qb_sync/install_generator.rb

@@ -0,0 +1,42 @@
+module EffectiveQbSync
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      desc "Creates an EffectiveQbSync 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 "effective_qb_sync.rb", "config/initializers/effective_qb_sync.rb"
+      end
+
+      def copy_mailer_preview
+        mailer_preview_path = (Rails.application.config.action_mailer.preview_path rescue nil)
+
+        if mailer_preview_path.present?
+          template 'effective_qb_sync_mailer_preview.rb', File.join(mailer_preview_path, 'effective_qb_sync_mailer_preview.rb')
+        else
+          puts "couldn't find action_mailer.preview_path.  Skipping effective_qb_sync_mailer_preview."
+        end
+      end
+
+      def create_migration_file
+        @qb_requests_table_name = ':' + EffectiveQbSync.qb_requests_table_name.to_s
+        @qb_tickets_table_name = ':' + EffectiveQbSync.qb_tickets_table_name.to_s
+        @qb_logs_table_name = ':' + EffectiveQbSync.qb_logs_table_name.to_s
+        @qb_order_items_table_name = ':' + EffectiveQbSync.qb_order_items_table_name.to_s
+
+        migration_template '../../../db/migrate/01_create_effective_qb_sync.rb.erb', 'db/migrate/create_effective_qb_sync.rb'
+      end
+    end
+  end
+end

data/lib/generators/templates/effective_qb_sync.rb

@@ -0,0 +1,61 @@
+# EffectiveQbSync Rails Engine
+
+EffectiveQbSync.setup do |config|
+  # Configure Database Tables
+  config.qb_requests_table_name = :qb_requests
+  config.qb_tickets_table_name = :qb_tickets
+  config.qb_logs_table_name = :qb_logs
+  config.qb_order_items_table_name = :qb_order_items
+
+  # Authorization Method
+  #
+  # This method is called by all controller actions with the appropriate action and resource
+  # If the method returns false, an Effective::AccessDenied Error will be raised (see README.md for complete info)
+  #
+  # Use via Proc (and with CanCan):
+  # config.authorization_method = Proc.new { |controller, action, resource| authorize!(action, resource) }
+  #
+  # Use via custom method:
+  # config.authorization_method = :my_authorization_method
+  #
+  # And then in your application_controller.rb:
+  #
+  # def my_authorization_method(action, resource)
+  #   current_user.is?(:admin)
+  # end
+  #
+  # Or disable the check completely:
+  # config.authorization_method = false
+  config.authorization_method = Proc.new { |controller, action, resource| true }
+
+  # All EffectiveQbSync controllers will use this layout
+  config.layout = 'application'
+
+  # SimpleForm Options
+  # This Hash of options will be passed into any admin facing simple_form_for() calls
+  config.admin_simple_form_options = {} # For the /admin/qb_syncs form
+
+  # Quickbooks Company File Settings
+
+  # The username / password of the Quickbooks user that should be allowed to synchronize.
+  # This must match the user configured in the Quickbooks .qwc file
+  config.quickbooks_username = ''
+  config.quickbooks_password = ''
+
+  # Sales tax can be added to an order in two ways:
+  # 1. Sales tax should be added by Quickbooks
+  #    - Set below: config.quickbooks_tax_name = ''
+  #    - In Quickbooks: Edit -> Preferences -> Sales Tax -> Company Preferences -> Do you charge sales tax? Yes
+  # 2. Sales tax should be added by the website
+  #    - Set below: config.quickbooks_tax_name = 'GST Collected'
+  #    - In Quickbooks: Edit -> Preferences -> Sales Tax -> Company Preferences -> Do you charge sales tax? No
+  #    - In Quickbooks: Add a regular Quickbooks Item matching the config.quickbooks_tax_name
+  # See /admin/qb_syncs/instructions for more information.
+  config.quickbooks_tax_name = ''
+
+  # If a synchronization errors occurs, send an email with steps to fix the error, to this address
+  # Uses effective_orders mailer layout and settings
+  # Leave nil to use EffectiveOrders.mailer[:admin_email] value, or provide a to email address here
+  config.error_email = nil
+
+end

data/lib/generators/templates/effective_qb_sync_mailer_preview.rb

@@ -0,0 +1,39 @@
+# In Rails 4.1 and above, visit:
+# http://localhost:3000/rails/mailers
+# to see a preview of the following emails:
+
+class EffectiveQbSyncMailerPreview < ActionMailer::Preview
+  # All order_errors are called from QbTicket.error!
+  # There are 3 general types of errors that occur
+
+  def error_record_does_not_exist
+    order_error('Invalid argument. The specified record does not exist in the list.')
+  end
+
+  def error_invalid_reference_to_item
+    order_error('There is an invalid reference to QuickBooks Item "Tax On Sale" in the SalesReceipt line.')
+  end
+
+  def error_element_already_in_use
+    order_error('The name "Peter Pan" of the list element is already in use.')
+  end
+
+  def error_unknown
+    order_error('unknown')
+  end
+
+  private
+
+  def order_error(error)
+    order = Effective::Order.new()
+
+    Effective::OrdersMailer.order_error(
+      order: order,
+      error: error,
+      to: EffectiveQbSync.error_email,
+      subject: "Quickbooks failed to synchronize order ##{order.to_param}",
+      template: 'qb_sync_error'
+    )
+  end
+
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,8 @@
+== README
+
+To change the test database in this dummy app:
+
+- Delete the existing test.sqlite3
+- No migrations, so just make whatever changes you want to schema.rb
+
+ bundle exec rake app:db:test:prepare

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/models/product.rb

@@ -0,0 +1,14 @@
+class Product < ActiveRecord::Base
+  acts_as_purchasable
+
+  after_purchase do |order, order_item|
+  end
+
+  after_decline do |order, order_item|
+  end
+
+  def qb_item_name
+    'Product'
+  end
+
+end

data/spec/dummy/app/models/product_with_float_price.rb

@@ -0,0 +1,13 @@
+class ProductWithFloatPrice < ActiveRecord::Base
+  acts_as_purchasable
+
+  after_purchase do |order, order_item|
+  end
+
+  after_decline do |order, order_item|
+  end
+
+  def qb_item_name
+    'ProductWithFloatPrice'
+  end
+end

data/spec/dummy/app/models/user.rb

@@ -0,0 +1,14 @@
+class User < ActiveRecord::Base
+  devise :database_authenticatable, :registerable, :rememberable, :recoverable, :trackable, :validatable, :authentication_keys => [:email]
+
+  acts_as_addressable :billing, :shipping
+
+  def to_s
+    email
+  end
+
+  def phone
+    '555-555-5555'
+  end
+
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/config/application.rb

@@ -0,0 +1,32 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require 'devise'
+require 'haml'
+require 'effective_addresses'
+require 'effective_orders'
+require 'effective_qb_sync'
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    config.generators do |g|
+      g.template_engine :haml
+    end
+
+  end
+end
+

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3