effective_orders 4.5.0

data/lib/effective_orders/engine.rb

@@ -0,0 +1,60 @@
+module EffectiveOrders
+  class Engine < ::Rails::Engine
+    engine_name 'effective_orders'
+
+    # Include acts_as_addressable concern and allow any ActiveRecord object to call it
+    initializer 'effective_orders.active_record' do |app|
+      ActiveSupport.on_load :active_record do
+        ActiveRecord::Base.extend(ActsAsPurchasable::Base)
+        ActiveRecord::Base.extend(ActsAsSubscribable::Base)
+        ActiveRecord::Base.extend(ActsAsSubscribableBuyer::Base)
+      end
+    end
+
+    # Set up our default configuration options.
+    initializer 'effective_orders.defaults', before: :load_config_initializers do |app|
+      eval File.read("#{config.root}/config/effective_orders.rb")
+    end
+
+    # Set up mail delivering config option
+    initializer 'effective_orders.mailer', after: :load_config_initializers do |app|
+      EffectiveOrders.mailer[:deliver_method] ||= (
+        (Rails.application.config.respond_to?(:active_job) && Rails.application.config.active_job.queue_adapter) ? :deliver_later : :deliver_now
+      )
+    end
+
+    initializer "effective_orders.append_precompiled_assets" do |app|
+      Rails.application.config.assets.precompile += ['effective_orders/*']
+    end
+
+    initializer 'effective_orders.refund', after: :load_config_initializers do
+      if EffectiveOrders.refund?
+        unless (EffectiveOrders.mailer[:admin_email].to_s.include?('@') rescue false)
+          raise("config.mailer[:admin_email] must be present when refunds enabled.")
+        end
+      end
+    end
+
+    initializer 'effective_orders.stripe', after: :load_config_initializers do
+      if EffectiveOrders.stripe?
+        begin
+          require 'stripe'
+          ::Stripe.api_key = EffectiveOrders.stripe[:secret_key]
+        rescue Exception
+          raise "unable to load stripe. Plese add gem 'stripe' to your Gemfile and then 'bundle install'"
+        end
+      end
+    end
+
+    initializer 'effective_orders.obfuscate_order_ids' do
+      if EffectiveOrders.obfuscate_order_ids
+        begin
+          require 'effective_obfuscation'
+        rescue Exception
+          raise "unable to load effective_obfuscation. Please add gem 'effective_obfuscation' to your Gemfile and then 'bundle install'"
+        end
+      end
+    end
+
+  end
+end

data/lib/effective_orders/version.rb

@@ -0,0 +1,3 @@
+module EffectiveOrders
+  VERSION = '4.5.0'.freeze
+end

data/lib/generators/effective_orders/install_generator.rb

@@ -0,0 +1,63 @@
+module EffectiveOrders
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      desc 'Creates an EffectiveOrders initializer in your application.'
+
+      source_root File.expand_path('../../templates', __FILE__)
+
+      def self.next_migration_number(dirname)
+        unless ActiveRecord::Base.timestamped_migrations
+          Time.new.utc.strftime("%Y%m%d%H%M%S")
+        else
+          "%.3d" % (current_migration_number(dirname) + 1)
+        end
+      end
+
+      def install_effective_addresses
+        run 'rails generate effective_addresses:install'
+      end
+
+      def copy_initializer
+        template ('../' * 3) + 'config/effective_orders.rb', 'config/initializers/effective_orders.rb'
+      end
+
+      def copy_mailer_layout
+        layout = 'app/views/layouts/effective_orders_mailer_layout.html.haml'
+        template ('../' * 3) + layout, layout
+      end
+
+      def copy_mailer_templates
+        path = 'app/views/effective/orders_mailer/'
+
+        Dir["#{source_paths.first}/../../../#{path}**"].map { |file| file.split('/').last }.each do |name|
+          template (('../' * 3) + path + name), (path + name)
+        end
+      end
+
+      def copy_mailer_preview
+        mailer_preview_path = (Rails.application.config.action_mailer.preview_path rescue nil)
+
+        if mailer_preview_path.present?
+          template 'effective_orders_mailer_preview.rb', File.join(mailer_preview_path, 'effective_orders_mailer_preview.rb')
+        else
+          puts "couldn't find action_mailer.preview_path. Skipping effective_orders_mailer_preview."
+        end
+      end
+
+      def create_migration_file
+        @orders_table_name = ':' + EffectiveOrders.orders_table_name.to_s
+        @order_items_table_name = ':' + EffectiveOrders.order_items_table_name.to_s
+        @carts_table_name = ':' + EffectiveOrders.carts_table_name.to_s
+        @cart_items_table_name = ':' + EffectiveOrders.cart_items_table_name.to_s
+        @customers_table_name = ':' + EffectiveOrders.customers_table_name.to_s
+        @subscriptions_table_name = ':' + EffectiveOrders.subscriptions_table_name.to_s
+        @products_table_name = ':' + EffectiveOrders.products_table_name.to_s
+
+        migration_template ('../' * 3) + 'db/migrate/01_create_effective_orders.rb.erb', 'db/migrate/create_effective_orders.rb'
+      end
+
+    end
+  end
+end

data/lib/generators/templates/effective_orders_mailer_preview.rb

@@ -0,0 +1,120 @@
+# In Rails 4.1 and above, visit:
+# http://localhost:3000/rails/mailers
+# to see a preview of the following 3 emails:
+
+class EffectiveOrdersMailerPreview < ActionMailer::Preview
+  def order_receipt_to_admin
+    Effective::OrdersMailer.order_receipt_to_admin(build_preview_order)
+  end
+
+  def order_receipt_to_buyer
+    Effective::OrdersMailer.order_receipt_to_buyer(build_preview_order)
+  end
+
+  def payment_request_to_buyer
+    Effective::OrdersMailer.payment_request_to_buyer(build_preview_order)
+  end
+
+  def pending_order_invoice_to_buyer
+    Effective::OrdersMailer.pending_order_invoice_to_buyer(build_preview_order)
+  end
+
+  def subscription_payment_succeeded
+    Effective::OrdersMailer.subscription_payment_succeeded(preview_customer)
+  end
+
+  def subscription_payment_failed
+    Effective::OrdersMailer.subscription_payment_failed(preview_customer)
+  end
+
+  def subscription_created
+    Effective::OrdersMailer.subscription_created(preview_customer)
+  end
+
+  def subscription_updated
+    Effective::OrdersMailer.subscription_updated(preview_customer)
+  end
+
+  def subscription_canceled
+    Effective::OrdersMailer.subscription_canceled(preview_customer)
+  end
+
+  def subscription_trialing
+    Effective::OrdersMailer.subscription_trialing(preview_subscribable)
+  end
+
+  def subscription_trial_expired
+    Effective::OrdersMailer.subscription_trial_expired(preview_subscribable)
+  end
+
+  def subscription_event_to_admin
+    Effective::OrdersMailer.subscription_event_to_admin(:subscription_updated, preview_customer)
+  end
+
+  def order_error
+    Effective::OrdersMailer.order_error(order: build_preview_order, error: 'Something did not work out')
+  end
+
+  protected
+
+  def build_preview_order
+    order = Effective::Order.new(id: 1)
+    order.user = preview_user
+    preview_order_items.each { |atts| order.order_items.build(atts) }
+    order.valid?
+    order
+  end
+
+  def build_address
+    Effective::Address.new(category: 'billing', full_name: 'Valued Customer', address1: '1234 Fake Street', address2: 'Suite 200', city: 'Edmonton', state_code: 'AB', country_code: 'CA', postal_code: 'T5T 2T1')
+  end
+
+  private
+
+  # We're building Effective::OrderItems directly rather than creating acts_as_purchasable objects
+  # so that this mailer will not have to guess at your app's acts_as_purchasable objects
+  def preview_order_items
+    [
+      { name: 'Item One', quantity: 2, price: 999, tax_exempt: false },
+      { name: 'Item Two', quantity: 1, price: 25000, tax_exempt: false },
+      { name: 'Item Three', quantity: 1, price: 8999, tax_exempt: false },
+      { name: 'Item Four', quantity: 1, price: 100000, tax_exempt: false }
+    ]
+  end
+
+  def preview_user
+    User.new(email: 'buyer@website.com').tap do |user|
+      user.name = 'Valued Customer' if user.respond_to?(:name=)
+      user.full_name = 'Valued Customer' if user.respond_to?(:full_name=)
+
+      if user.respond_to?(:first_name=) && user.respond_to?(:last_name=)
+        user.first_name = 'Valued'
+        user.last_name = 'Customer'
+      end
+
+      user.billing_address = build_address if user.respond_to?(:billing_address=)
+    end
+  end
+
+  def preview_customer
+    customer = Effective::Customer.new(user: preview_user, active_card: '**** **** **** 1234 Visa 04/20')
+
+    if preview_subscribable.present?
+      customer.subscriptions.build(subscribable: preview_subscribable, name: 'Bronze Plan')
+      customer.subscriptions.build(subscribable: preview_subscribable, name: 'Silver Plan')
+    end
+
+    customer
+  end
+
+  def preview_subscribable
+    Rails.application.eager_load!
+
+    klasses = Array(ActsAsSubscribable.descendants).compact
+    return unless klasses.present?
+
+    klasses.map { |klass| klass.all.order(Arel.sql('random()')).first }.compact.first ||
+    klasses.first.new(subscribable_buyer: preview_user)
+  end
+
+end

data/lib/tasks/effective_orders_tasks.rake

@@ -0,0 +1,69 @@
+# rake effective_orders:overwrite_order_item_names
+
+namespace :effective_orders do
+  desc 'Overwrite all order item names with current acts_as_purchasable object names'
+  task overwrite_order_item_names: :environment do
+    puts 'WARNING: this task will overwrite all existing order items with new names. Proceed? (y/n)'
+    (puts 'Aborted' and exit) unless STDIN.gets.chomp.downcase == 'y'
+
+    Effective::OrderItem.transaction do
+      begin
+
+        Effective::OrderItem.includes(:purchasable).find_each do |order_item|
+          new_name = order_item.purchasable.purchasable_name
+
+          unless new_name
+            raise "acts_as_purchasable object #{order_item.purchasable_type.try(:classify)}<#{order_item.purchasable_id}>.title() from Effective::OrderItem<#{order_item.id}> cannot be nil."
+          end
+
+          order_item.update_column(:name, new_name) # This intentionally skips validation
+        end
+
+        puts 'Successfully updated all order item names.'
+      rescue => e
+        puts "An error has occurred: #{e.message}"
+        puts "(effective_orders) Rollback. No order item names have been changed."
+        raise ActiveRecord::Rollback
+      end
+    end
+  end
+
+  # rake effective_orders:send_trial_emails
+  desc 'Sends subscription_trialing and subscription_trial_expired emails to each subscribable. Schedule me to run once per day.'
+  task send_trial_emails: :environment do
+    trial_remind_at = Array(EffectiveOrders.trial[:remind_at]).compact
+    exit unless trial_remind_at.present? && trial_remind_at.all? { |x| x.present? }
+
+    Rails.application.eager_load!
+
+    today = Time.zone.now.beginning_of_day
+    reminders = trial_remind_at.select { |remind_at| remind_at.kind_of?(ActiveSupport::Duration) }
+
+    begin
+      ActsAsSubscribable.descendants.each do |klass|
+        klass.trialing.find_each do |subscribable|
+          if subscribable.trialing_until == today
+            puts "sending trial expired to #{subscribable}"
+            Effective::OrdersMailer.subscription_trial_expired(subscribable).deliver_now
+          end
+
+          next if subscribable.trial_past_due? # We already notified them
+
+          date = (subscribable.trialing_until - EffectiveOrders.trial.fetch(:length)).beginning_of_day # Should be same as created_at.beginning_of_day
+
+          reminders.each do |remind_at|
+            next unless today == (date + remind_at)
+            Effective::OrdersMailer.subscription_trialing(subscribable).deliver_now
+          end
+        end
+      end
+
+      puts 'send_trial_emails completed'
+      EffectiveLogger.success('scheduled task send_trial_emails completed') if defined?(EffectiveLogger)
+    rescue => e
+      ExceptionNotifier.notify_exception(e) if defined?(ExceptionNotifier)
+      raise e
+    end
+  end
+
+end

metadata

@@ -0,0 +1,276 @@
+--- !ruby/object:Gem::Specification
+name: effective_orders
+version: !ruby/object:Gem::Version
+  version: 4.5.0
+platform: ruby
+authors:
+- Code and Effect
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-07-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: coffee-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: devise
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: effective_datatables
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: effective_bootstrap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: effective_resources
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Quickly build an online store with carts, orders, automatic email receipts
+  and payment collection via Stripe, StripeConnect, PayPal and Moneris.
+email:
+- info@codeandeffect.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- app/assets/images/effective_orders/stripe.png
+- app/assets/javascripts/effective_orders.js
+- app/assets/javascripts/effective_orders/customers.js.coffee
+- app/assets/javascripts/effective_orders/providers/stripe.js.coffee
+- app/assets/javascripts/effective_orders/subscriptions.js.coffee
+- app/assets/stylesheets/effective_orders.scss
+- app/assets/stylesheets/effective_orders/_cart.scss
+- app/assets/stylesheets/effective_orders/_order.scss
+- app/controllers/admin/customers_controller.rb
+- app/controllers/admin/order_items_controller.rb
+- app/controllers/admin/orders_controller.rb
+- app/controllers/effective/carts_controller.rb
+- app/controllers/effective/concerns/purchase.rb
+- app/controllers/effective/customers_controller.rb
+- app/controllers/effective/orders_controller.rb
+- app/controllers/effective/providers/cheque.rb
+- app/controllers/effective/providers/free.rb
+- app/controllers/effective/providers/mark_as_paid.rb
+- app/controllers/effective/providers/moneris.rb
+- app/controllers/effective/providers/paypal.rb
+- app/controllers/effective/providers/phone.rb
+- app/controllers/effective/providers/pretend.rb
+- app/controllers/effective/providers/refund.rb
+- app/controllers/effective/providers/stripe.rb
+- app/controllers/effective/subscripter_controller.rb
+- app/controllers/effective/webhooks_controller.rb
+- app/datatables/admin/effective_customers_datatable.rb
+- app/datatables/admin/effective_orders_datatable.rb
+- app/datatables/effective_orders_datatable.rb
+- app/helpers/effective_carts_helper.rb
+- app/helpers/effective_orders_helper.rb
+- app/helpers/effective_paypal_helper.rb
+- app/helpers/effective_stripe_helper.rb
+- app/helpers/effective_subscriptions_helper.rb
+- app/mailers/effective/orders_mailer.rb
+- app/models/concerns/acts_as_purchasable.rb
+- app/models/concerns/acts_as_subscribable.rb
+- app/models/concerns/acts_as_subscribable_buyer.rb
+- app/models/effective/access_denied.rb
+- app/models/effective/cart.rb
+- app/models/effective/cart_item.rb
+- app/models/effective/customer.rb
+- app/models/effective/order.rb
+- app/models/effective/order_item.rb
+- app/models/effective/product.rb
+- app/models/effective/sold_out_validator.rb
+- app/models/effective/subscripter.rb
+- app/models/effective/subscription.rb
+- app/models/effective/tax_rate_calculator.rb
+- app/views/admin/customers/_actions.html.haml
+- app/views/admin/customers/index.html.haml
+- app/views/admin/customers/show.html.haml
+- app/views/admin/order_items/index.html.haml
+- app/views/admin/orders/_datatable_actions.html.haml
+- app/views/admin/orders/_form.html.haml
+- app/views/admin/orders/_form_note_internal.html.haml
+- app/views/admin/orders/_order_actions.html.haml
+- app/views/admin/orders/_order_item_fields.html.haml
+- app/views/admin/orders/checkout.html.haml
+- app/views/admin/orders/edit.html.haml
+- app/views/admin/orders/index.html.haml
+- app/views/admin/orders/new.html.haml
+- app/views/admin/orders/show.html.haml
+- app/views/effective/carts/_cart.html.haml
+- app/views/effective/carts/_cart_actions.html.haml
+- app/views/effective/carts/show.html.haml
+- app/views/effective/customers/_customer.html.haml
+- app/views/effective/customers/_form.html.haml
+- app/views/effective/customers/edit.html.haml
+- app/views/effective/customers/update.js.erb
+- app/views/effective/orders/_checkout_actions.html.haml
+- app/views/effective/orders/_checkout_step1.html.haml
+- app/views/effective/orders/_checkout_step2.html.haml
+- app/views/effective/orders/_datatable_actions.html.haml
+- app/views/effective/orders/_fields.html.haml
+- app/views/effective/orders/_fields_note.html.haml
+- app/views/effective/orders/_fields_terms.html.haml
+- app/views/effective/orders/_order.html.haml
+- app/views/effective/orders/_order_actions.html.haml
+- app/views/effective/orders/_order_deferred.html.haml
+- app/views/effective/orders/_order_footer.html.haml
+- app/views/effective/orders/_order_header.html.haml
+- app/views/effective/orders/_order_items.html.haml
+- app/views/effective/orders/_order_notes.html.haml
+- app/views/effective/orders/_order_payment.html.haml
+- app/views/effective/orders/_order_shipping.html.haml
+- app/views/effective/orders/_orders_table.html.haml
+- app/views/effective/orders/cheque/_form.html.haml
+- app/views/effective/orders/declined.html.haml
+- app/views/effective/orders/deferred.html.haml
+- app/views/effective/orders/deferred/_form.html.haml
+- app/views/effective/orders/edit.html.haml
+- app/views/effective/orders/free/_form.html.haml
+- app/views/effective/orders/index.html.haml
+- app/views/effective/orders/mark_as_paid/_form.html.haml
+- app/views/effective/orders/moneris/_form.html.haml
+- app/views/effective/orders/new.html.haml
+- app/views/effective/orders/paypal/_form.html.haml
+- app/views/effective/orders/phone/_form.html.haml
+- app/views/effective/orders/pretend/_form.html.haml
+- app/views/effective/orders/purchased.html.haml
+- app/views/effective/orders/refund/_form.html.haml
+- app/views/effective/orders/show.html.haml
+- app/views/effective/orders/stripe/_element.html.haml
+- app/views/effective/orders/stripe/_form.html.haml
+- app/views/effective/orders_mailer/order_error.html.haml
+- app/views/effective/orders_mailer/order_receipt_to_admin.html.haml
+- app/views/effective/orders_mailer/order_receipt_to_buyer.html.haml
+- app/views/effective/orders_mailer/payment_request_to_buyer.html.haml
+- app/views/effective/orders_mailer/pending_order_invoice_to_buyer.html.haml
+- app/views/effective/orders_mailer/refund_notification_to_admin.html.haml
+- app/views/effective/orders_mailer/subscription_canceled.html.haml
+- app/views/effective/orders_mailer/subscription_created.html.haml
+- app/views/effective/orders_mailer/subscription_event_to_admin.html.haml
+- app/views/effective/orders_mailer/subscription_payment_failed.html.haml
+- app/views/effective/orders_mailer/subscription_payment_succeeded.html.haml
+- app/views/effective/orders_mailer/subscription_trial_expired.html.haml
+- app/views/effective/orders_mailer/subscription_trialing.html.haml
+- app/views/effective/orders_mailer/subscription_updated.html.haml
+- app/views/effective/subscripter/_form.html.haml
+- app/views/effective/subscripter/_plan.html.haml
+- app/views/layouts/effective_orders_mailer_layout.html.haml
+- config/effective_orders.rb
+- config/routes.rb
+- db/migrate/01_create_effective_orders.rb.erb
+- lib/effective_orders.rb
+- lib/effective_orders/engine.rb
+- lib/effective_orders/version.rb
+- lib/generators/effective_orders/install_generator.rb
+- lib/generators/templates/effective_orders_mailer_preview.rb
+- lib/tasks/effective_orders_tasks.rake
+homepage: https://github.com/code-and-effect/effective_orders
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Quickly build an online store with carts, orders, automatic email receipts
+  and payment collection via Stripe, StripeConnect, PayPal and Moneris.
+test_files: []