accountability 0.1.1 → 0.2.1

data/app/views/accountability/products/new.html.haml

@@ -0,0 +1,73 @@
+.container
+  = link_to 'Back', accountability_products_path, class: 'btn btn-outline-primary float-right'
+
+  %h1.mb-5 New Product
+
+  - @product.errors.full_messages.each do |message|
+    .alert.alert-danger
+      = message
+
+  = form_with model: [:accountability, @product], local: true do |f|
+    .card.my-3
+      .card-body
+        -# WHEN I GET BACK - Add scope fields and stuff - they only show when @stage is set to 'final' from :create
+        -# .. also we should probably run validations on the fields we show .. or at least the category field
+
+        -# TODO: Add dev only instructions
+
+        %h3.mb-4 Product Info
+
+        .form-row
+          .form-group.col-md-4
+            = f.label :offerable_category
+            = f.select :offerable_category, source_class_options, { }, { disabled: disable_category_field?, class: 'form-control' }
+          .form-group.col-md-8
+            = f.label :name
+            = f.text_field :name, class: 'form-control'
+          .form-group.optional-fields.col-md-2
+            = f.label :sku
+            = f.text_field :sku, class: 'form-control'
+          .form-group.col-md-3
+            = f.label :price
+            = f.number_field :price, step: 2, class: 'form-control'
+          .form-group.col-md-4
+            = f.label :schedule
+            = f.select :schedule, schedule_options, {}, {class: 'form-control' }
+          .form-group.col-md-3
+            = f.label :quantity
+            = f.text_field :quantity, class: 'form-control'
+          .form-group.col-md-12
+            = f.label :description
+            = f.text_area :description, class: 'form-control'
+
+      - if @stage == 'final'
+
+        %hr
+        .card-body
+          %h3.mb-4 Details
+          .form-row
+            - @product.scopes.each do |scope|
+              .form-group.col-md-12
+                = f.label :offerable_category, scope.title.titleize
+                = f.select :offerable_category, scope_options(scope), { }, { class: 'form-control' }
+
+        %hr
+        .card-body
+          %h3.mb-4 Availability Options
+
+          .form-row
+            .form-group.optional-fields.col-md-12
+              = f.label :activation_date
+              = f.datetime_field :activation_date, class: 'form-control'
+              %em.small Product or service becomes available for purchase and use
+            .form-group.optional-fields.col-md-12
+              = f.label :expiration_date
+              = f.datetime_field :expiration_date, class: 'form-control'
+              %em.small Product or service is no longer available for purchase
+            .form-group.optional-fields.col-md-12
+              = f.label :termination_date
+              = f.datetime_field :termination_date, class: 'form-control'
+              %em.small Product or service is no longer available for use
+
+    = link_to 'Reset', new_accountability_product_path, class: 'btn btn-outline-secondary float-right'
+    = f.button 'Submit', type: :submit, name: :stage, value: @stage, class: 'btn btn-success'

data/app/views/accountability/shared/_session_info.html.haml

@@ -0,0 +1,24 @@
+.card.mb-5
+  .card-header
+    Session Info
+  .row.no-gutters
+    .col-md-6
+      .card-body.pb-1
+        %p
+          %strong.text-primary Billable Record:
+          = current_account&.billable_record_name
+
+        %p
+          %strong.text-primary Admin Session:
+          = admin_session? ? 'Yes' : 'No'
+
+    .col-md-6
+      .card-body.pb-1
+
+        %p
+          %strong.text-primary OrderGroup ID:
+          = current_order_group&.id
+
+        %p
+          %strong.text-primary Account ID:
+          = current_account&.id

data/config/locales/en.yml

@@ -0,0 +1,19 @@
+en:
+  activerecord:
+    attributes:
+      'accountability/product':
+        offerable_category: "Category"
+        schedule: "Billing Schedule"
+        quantity: "Bundle Size"
+        sku: "SKU"
+  accountability:
+    gateway:
+      errors:
+        unknown_gateway_error: "An unknown gateway error has occurred"
+  helpers:
+    label:
+      billing_configuration:
+        configuration_name: "Payment Method Name"
+        contact_email: "Billing Email"
+        contact_first_name: "First Name"
+        contact_last_name: "Last Name"

data/db/migrate/20190814000455_create_accountability_tables.rb

@@ -1,16 +1,24 @@
 # rubocop:disable Metrics/AbcSize
+# rubocop:disable Metrics/LineLength
 # rubocop:disable Metrics/MethodLength
 
 class CreateAccountabilityTables < ActiveRecord::Migration[6.0]
   def change
     create_table :accountability_accounts do |t|
       t.belongs_to :billable, null: true, polymorphic: true
-
+      t.integer :statement_schedule, default: 0, null: false # end_of_month bi_weekly
       t.datetime :last_balanced_at, default: nil, null: true
 
       t.timestamps
     end
 
+    create_table :accountability_statements do |t|
+      t.belongs_to :account, null: false, index: { name: :index_account_on_statement }
+      t.datetime :end_date, default: nil, null: false
+
+      t.timestamps
+    end
+
     create_table :accountability_debits do |t|
       t.belongs_to :account, null: false, index: { name: :index_account_on_debit }
       t.belongs_to :payment, null: true, index: { name: :index_payment_on_debit }
@@ -22,13 +30,17 @@ class CreateAccountabilityTables < ActiveRecord::Migration[6.0]
     create_table :accountability_credits do |t|
       t.belongs_to :account, null: false, index: { name: :index_account_on_credit }
       t.belongs_to :order_item, null: false, index: { name: :index_order_item_on_credit }
+      t.belongs_to :statement, null: false, index: { name: :index_statement_on_credit }
       t.decimal :amount, default: 0.00, precision: 8, scale: 2, null: false
+      t.decimal :taxes, default: 0.00, precision: 8, scale: 2, null: false
 
       t.timestamps
     end
 
     create_table :accountability_payments do |t|
       t.belongs_to :account, null: false, index: { name: :index_account_on_payment }
+      t.belongs_to :billing_configuration, null: false, index: { name: :index_billing_configuration_on_payment }
+
       t.decimal :amount, default: 0.00, precision: 8, scale: 2, null: false
       t.integer :status, default: 0, null: false # Pending, Processing, Complete, Failed
 
@@ -72,6 +84,7 @@ class CreateAccountabilityTables < ActiveRecord::Migration[6.0]
 
     create_table :accountability_products do |t|
       t.boolean :public, default: true, null: false
+      t.boolean :tax_exempt, default: false, null: false
       t.decimal :price, default: 0.00, precision: 8, scale: 2, null: false
       t.integer :quantity, default: 1, null: false
       t.string :name, default: nil, null: false
@@ -105,13 +118,42 @@ class CreateAccountabilityTables < ActiveRecord::Migration[6.0]
       t.timestamps
     end
 
+    # rubocop:disable Rails/CreateTableWithTimestamps
     create_table :accountability_coupons_products, id: false do |t|
       t.belongs_to :product, index: { name: :index_product_on_product_coupon }
       t.belongs_to :coupon, index: { name: :index_coupon_on_product_coupon }
     end
+    # rubocop:enable Rails/CreateTableWithTimestamps
 
+    # rubocop:disable Rails/CreateTableWithTimestamps
     create_table :accountability_identities do |t|
       t.belongs_to :identifiable, polymorphic: true, index: { name: :index_identifiable_on_identity }
     end
+    # rubocop:enable Rails/CreateTableWithTimestamps
+
+    create_table :accountability_billing_configurations do |t|
+      t.belongs_to :account, null: false, index: { name: :index_account_on_billing_configuration }
+      t.boolean :primary, default: false, null: false
+      t.text :billing_address, default: nil, null: true # JSON serialized value object
+      t.text :active_merchant_data, default: nil, null: true # JSON serialized data for ActiveMerchant
+      t.integer :provider, default: 0, null: false # [unselected, stripe]
+      t.string :token, default: nil, null: true # Used to retrieve & charge the payment method from the provider
+      t.string :configuration_name, default: nil, null: true # A name for the payment method
+      t.string :contact_email, default: nil, null: true
+      t.string :contact_first_name, default: nil, null: true
+      t.string :contact_last_name, default: nil, null: true
+
+      t.timestamps
+    end
+
+    create_table :accountability_price_overrides do |t|
+      t.belongs_to :product, index: { name: :index_product_on_price_override }
+      t.belongs_to :offerable_source, null: false, polymorphic: true, index: { name: :index_offerable_source_on_price_override }
+
+      t.decimal :price, default: 0.00, precision: 8, scale: 2, null: false # The inventory item's new price
+      t.text :description, default: nil, null: true, limit: 10_000 # Optional field for describing adjustment rationale
+
+      t.timestamps
+    end
   end
 end

data/lib/accountability.rb

@@ -1,7 +1,8 @@
 require_dependency 'accountability/engine'
 require_dependency 'accountability/configuration'
-require_dependency 'accountability/cartographer'
+require_dependency 'accountability/rails/routes'
 require_dependency 'accountability/extensions'
+require_dependency 'accountability/types'
 
 module Accountability
   def self.configure(_tenant = :default)

data/lib/accountability/configuration.rb

@@ -1,8 +1,12 @@
 module Accountability
   class Configuration
     class << self
-      attr_accessor :billable_identifier
-      attr_writer :admin_checker
+      attr_accessor :logo_path, :payment_gateway, :dev_tools_enabled
+      attr_writer :tax_rate, :admin_checker, :billable_identifier, :billable_name_column
+
+      def tax_rate
+        @tax_rate || 0.0
+      end
 
       def admin_checker
         if @admin_checker.is_a? Proc
@@ -11,6 +15,22 @@ module Accountability
           -> { true }
         end
       end
+
+      def billable_identifier
+        if @billable_identifier.is_a? Proc
+          @billable_identifier
+        else
+          -> { @current_user }
+        end
+      end
+
+      def billable_name_column
+        @billable_name_column || :id
+      end
+
+      def dev_tools_enabled?
+        !!dev_tools_enabled
+      end
     end
   end
 end

data/lib/accountability/engine.rb

@@ -2,8 +2,13 @@ module Accountability
   class Engine < ::Rails::Engine
     isolate_namespace Accountability
 
-    ActiveSupport.on_load(:active_record) do
+    ActiveSupport.on_load :active_record do
       include Extensions
+      include Types
+    end
+
+    ActiveSupport.on_load :action_controller do
+      helper Accountability::BillingConfigurationsHelper
     end
   end
 end

data/lib/accountability/extensions/acts_as_billable.rb

@@ -5,8 +5,19 @@ module Accountability
 
       class_methods do
         def acts_as_billable
+          after_create :create_default_account
+
           has_many :accounts, as: :billable, class_name: 'Accountability::Account', dependent: :nullify
+
           self.acts_as = acts_as.dup << :billable
+
+          define_method :create_default_account do
+            accounts.first_or_create
+          end
+
+          define_method :default_account do
+            accounts.first
+          end
         end
       end
     end

data/lib/accountability/rails/routes.rb

@@ -0,0 +1,72 @@
+require 'active_support/core_ext/hash'
+
+module ActionDispatch::Routing
+  class Mapper
+    def accountability_for(_tenants, options = {})
+      options[:controllers] ||= {}
+      options[:routes] ||= {}
+
+      options[:controllers].reverse_merge! default_accountability_controller_options
+      options[:routes].reverse_merge! default_accountability_route_options
+
+      options[:path_prefix] ||= options[:path] if options[:path_prefix].nil?
+
+      define_accountability_routes(options)
+    end
+
+    def define_accountability_routes(options)
+      cartographer = -> { accountability_routes(options) }
+
+      cartographer.call
+      Accountability::Engine.routes.draw(&cartographer)
+    end
+
+    def accountability_routes(options)
+      scope path: options[:path_prefix], as: :accountability do
+        resources :accounts, controller: options.dig(:controllers, :accounts), path: options.dig(:routes, :accounts) do
+          resources :billing_configurations, controller: options.dig(:controllers, :billing_configurations), path: options.dig(:routes, :billing_configurations) do
+            member { patch :designate_as_primary }
+          end
+
+          resources :payments, only: :create, controller: 'accountability/payments', path: 'payments'
+          resources :statements, only: [], controller: 'accountability/statements', path: 'statements' do
+            member { get :download_pdf }
+          end
+        end
+
+        resources :products, controller: options.dig(:controllers, :products), path: options.dig(:routes, :products)
+
+        resources :order_groups, controller: options.dig(:controllers, :order_groups), path: options.dig(:routes, :order_groups) do
+          member { post :add_item }
+        end
+      end
+
+      unscoped_direct(:stripe_v3_javascript) { 'https://js.stripe.com/v3/' }
+    end
+
+    def default_accountability_controller_options
+      {
+        accounts: 'accountability/accounts',
+        products: 'accountability/products',
+        order_groups: 'accountability/order_groups',
+        billing_configurations: 'accountability/billing_configurations'
+      }
+    end
+
+    def default_accountability_route_options
+      {
+        accounts: 'accounts',
+        products: 'products',
+        order_groups: 'orders',
+        billing_configurations: 'billing_configurations'
+      }
+    end
+
+    # Mimic the functionality of Mapper#direct so that we can add a "direct" route from the cartographer proc even
+    # though we are in a scope because of #isolate_namespace.
+    # https://github.com/rails/rails/blob/6-0-stable/actionpack/lib/action_dispatch/routing/mapper.rb#L2119-L2125
+    def unscoped_direct(name, options = {}, &block)
+      @set.add_url_helper(name, options, &block)
+    end
+  end
+end

data/lib/accountability/types.rb

@@ -0,0 +1,9 @@
+require 'active_merchant'
+require_dependency 'accountability/types/billing_configuration_types'
+
+module Accountability
+  module Types
+    include BillingConfigurationTypes
+    ActiveRecord::Type.register(:billing_address, Accountability::Types::BillingAddressType)
+  end
+end

data/lib/accountability/types/billing_configuration_types.rb

@@ -0,0 +1,57 @@
+module Accountability
+  module Types
+    module BillingConfigurationTypes
+      class BillingAddress
+        include ActiveModel::Model
+        include ActiveModel::Attributes
+
+        attribute :address_1, :string
+        attribute :address_2, :string
+        attribute :zip, :integer
+        attribute :city, :string
+        attribute :state, :string
+        attribute :country, :string
+
+        validates :address_1, :city, :state, :country, presence: true
+        validates :zip, numericality: { only_integer: true }
+      end
+
+      class BillingAddressType < ActiveModel::Type::Value
+        def type
+          :text
+        end
+
+        def cast_value(value)
+          case value
+          when String
+            decoded_value = ActiveSupport::JSON.decode(value)
+            BillingAddress.new(decoded_value)
+          when Hash
+            BillingAddress.new(value)
+          when BillingAddress
+            value
+          end
+        end
+
+        # Only serialize the attributes that we have defined
+        # and keep extraneous things like "errors" or
+        # "validation_context" from slipping into the database.
+        def serialize(data)
+          case data
+          when Hash
+            billing_address = BillingAddress.new(data)
+            ActiveSupport::JSON.encode(billing_address.attributes)
+          when BillingAddress
+            ActiveSupport::JSON.encode(data.attributes)
+          else
+            super(data)
+          end
+        end
+
+        def changed_in_place?(raw_old_value, new_value)
+          cast_value(raw_old_value) != new_value
+        end
+      end
+    end
+  end
+end

data/lib/accountability/version.rb

@@ -1,3 +1,3 @@
 module Accountability
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.2.1'.freeze
 end

data/lib/generators/accountability/install_generator.rb

@@ -0,0 +1,47 @@
+require 'rails/generators/active_record'
+
+module Accountability
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      # Executes with: `rails generate accountability:install`
+      # Note: All public instance methods will be called sequentially
+
+      include ActiveRecord::Generators::Migration
+      source_root File.join(__dir__, 'templates')
+
+      # def create_initializer_file
+      #   initializer_content = "Accountability.configure { |_config| }"
+      #   create_file "config/initializers/accountability.rb", initializer_content
+      # end
+
+      def copy_migration
+        # Note: migration.rb is always up-to-date
+        if fresh_installation?
+          destination = 'db/migrate/create_accountability_tables.rb'
+          migration_template 'migration.rb', destination, migration_version: migration_version
+          return true
+        end
+
+        # Existing applications may need new migration files
+        if missing_price_overrides?
+          destination = 'db/migrate/create_accountability_price_overrides_tables.rb'
+          migration_template 'price_overrides_migration.rb', destination, migration_version: migration_version
+        end
+      end
+
+      def migration_version
+        "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+      end
+
+      private
+
+      def fresh_installation?
+        !ActiveRecord::Base.connection.table_exists?('accountability_accounts')
+      end
+
+      def missing_price_overrides?
+        !ActiveRecord::Base.connection.table_exists?('accountability_price_overrides')
+      end
+    end
+  end
+end