accountability 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6693805b727a73f703afae26091f1dbbfdaf8361204ae9fa52ba1b4932fd7d0
-  data.tar.gz: b0b4f44c7be9a0e0ea9f5ada14fcfd552048a054ba2ece199fdcf7043dce88b2
+  metadata.gz: 25f8546f25aae663976cd6cd712b38b444a385a9b5b609bf9f0fa0f1f62e0bb0
+  data.tar.gz: 278fb73d9c9d2f9d3a5c7ed609514b82cceb9db892508cb5bda6464b8e959607
 SHA512:
-  metadata.gz: da038e1ec8fbf770e59d58cc06ac0e8503ec2e65951ca39ebb968970d2c71a96e598ff1ba334e2217cb802ff1eb64344cc8e8200450cbb1a668e48e3e61bf725
-  data.tar.gz: 1114f3d2273f1f23a8deff9bcd78b7f075b6dfe15796f1aa5e82d91209d0367f5fc9416a783dcc7659f1b01395c687719288b6cfb6f5e4643441db5276457adf
+  metadata.gz: 4bfd0bf5a59e3a8804a96739d416f9dbbb6ade1a56d6bdc821a207eafc58fe783086511001f40262b9c7175e30f8a17078a23af4e1ea1f79d18a1558650b1ab3
+  data.tar.gz: 869170f02d04650f64beefa7cc616189420575ceb497ba7ae97b3970f635ce29c1c555bc66bc1157831cfc02f9dc6c4bf97c99b3097c8a1ae2da5b883f2363e6

data/README.md

@@ -102,6 +102,19 @@ config.tax_rate = 9.53
 
 Note that products can be marked as tax exempt.  
 
+#### Country Whitelist
+To limit which countries your application accepts credit cards from, you can define a whitelist.
+
+The whitelist must be an array of [two-character ISO country codes](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements). 
+
+```ruby
+config.country_whitelist = %w[US CA MX]
+``` 
+
+When a `country_whitelist` is specified, the BillingConfiguration's country field will be validated for inclusion.
+
+The first country listed in the whitelist will be used as the default value for all new BillingConfiguration records. 
+
 #### Debugger tools
 To print helpful session information in the views such as the currently tracked billable entity, enable the dev tools.
 
@@ -142,7 +155,24 @@ end
 #### Dynamic Pricing
 AKA traits
 
+## Contributing
+The only current contribution guideline is that we ask contributors to include detailed commit descriptions and avoid pushing merge commits.
+
+### Versioning
+The version number listed in `lib/accountability/version.rb` is the version being actively developed.
+
+It is formatted `MAJOR.MINOR.TINY`:
+- MAJOR - Will be set to `1` once ready for public use, at which point we will switch to semantic versioning. 
+- MINOR - Is bumped prior to implementing breaking changes.
+- TINY - Is bumped after implementing new features or other meaningful changes.
+
+Rebuild the gem after updating the `version.rb` file.
+```bash
+gem build accountability.gemspec
+```
+
 ## TODO
 - [ ] Finish implementing multi-tenanting features
-- [ ] Add support for controller overrides
-- [ ] Implement product creation workflow in views
+- [ ] Update views to support full E-commerce functionality out of the box
+- [ ] Add test coverage
+- [ ] Add test helpers

data/app/controllers/accountability/billing_configurations_controller.rb

@@ -53,6 +53,9 @@ module Accountability
     end
 
     def updated_billing_elements
+      return unless partial_exists? 'configurations', within: 'accountability/accounts/billing_configurations'
+      return unless partial_exists? 'payment_form', within: 'accountability/accounts'
+
       configurations_partial = 'accountability/accounts/billing_configurations/configurations'
       payment_form_partial = 'accountability/accounts/payment_form'
 

data/app/controllers/accountability/order_groups_controller.rb

@@ -16,12 +16,15 @@ module Accountability
     def edit; end
 
     def create
-      @order_group = OrderGroup.new(order_group_params)
+      @order_group = params[:order_group].present? ? OrderGroup.new(order_group_params) : OrderGroup.new
+      source_scope = params.to_unsafe_h[:source_scope]&.symbolize_keys
 
       if @order_group.save
-        redirect_to accountability_order_groups_path, notice: 'Successfully created new order_group'
+        @order_group.add_item!(params[:product_id], source_scope: source_scope) if params[:product_id].present?
+
+        redirect_to accountability_order_group_path(@order_group), notice: 'Successfully created new order_group'
       else
-        render :new
+        redirect_back fallback_location: root_path, alert: 'Failed to create cart'
       end
     end
 
@@ -43,7 +46,9 @@ module Accountability
 
     def add_item
       product = Product.find(params[:product_id])
-      if @order_group.add_item! product
+      source_scope = params.to_unsafe_h[:source_scope]&.symbolize_keys
+
+      if @order_group.add_item! product, source_scope: source_scope
         redirect_to accountability_order_group_path(current_order_group), notice: 'Successfully added to cart'
       else
         redirect_back fallback_location: accountability_order_groups_path, alert: 'Failed to add to cart'

data/app/controllers/accountability_controller.rb

@@ -44,4 +44,8 @@ class AccountabilityController < ApplicationController
     order_group_id = session[:current_order_group_id]
     Accountability::OrderGroup.find_by(id: order_group_id)
   end
+
+  def partial_exists?(partial_name, within:)
+    helpers.lookup_context.template_exists?(partial_name, within, true)
+  end
 end

data/app/models/accountability/billing_configuration.rb

@@ -1,7 +1,7 @@
 module Accountability
   class BillingConfiguration < ApplicationRecord
     include Accountability::ActiveMerchantInterface
-    after_initialize :set_provider, if: :new_record?
+    after_initialize :set_provider, :set_default_country, if: :new_record?
 
     belongs_to :account
     has_many :payments, dependent: :restrict_with_error
@@ -37,5 +37,12 @@ module Accountability
     def set_provider
       self.provider = Configuration.payment_gateway[:provider]
     end
+
+    def set_default_country
+      return unless self.billing_address.present?
+      return unless Configuration.country_whitelist.present?
+
+      self.billing_address.country = Configuration.country_whitelist.first
+    end
   end
 end

data/app/models/accountability/inventory.rb

@@ -8,7 +8,7 @@ require 'forwardable'
 #
 # Usage:
 #   inventory = Inventory.new(product)
-#   inventory.active.count
+#   inventory.available.count
 
 module Accountability
   class Inventory
@@ -25,10 +25,14 @@ module Accountability
     end
 
     def collection
-      records = source_class.where(**source_scope)
-      records = records.public_send(offerable_template.whitelist) if scope_availability?
+      source_records.map { |record| InventoryItem.new(record: record, product: product, inventory: self) }
+    end
 
-      records.map { |record| InventoryItem.new(record: record, product: product) }
+    def source_records
+      records = source_class.where(**source_scope).includes(:price_overrides)
+      records = records.public_send(offerable_template.whitelist) if scope_availability?
+      records = records.order(@order_params) if @order_params.present?
+      records
     end
 
     def available
@@ -37,18 +41,47 @@ module Accountability
       self
     end
 
+    def order(order_params)
+      @order_params = order_params
+
+      self
+    end
+
+    def available_source_ids
+      return @available_source_ids if @available_source_ids.present?
+
+      @available_source_ids = Inventory.new(product, available_only: true).source_records.ids
+    end
+
     private
 
     class InventoryItem
-      attr_accessor :record, :product
+      attr_accessor :record, :product, :inventory
 
-      def initialize(record:, product:)
+      def initialize(record:, product:, inventory:)
         @record = record
         @product = product
+        @inventory = inventory
+
+        # Expose source record through offerable's name
+        record_alias = product.offerable_category.to_sym
+        alias :"#{record_alias}" record
       end
 
       def price
-        product.price
+        # Iterating pre-loaded content is faster with Ruby than an N+1 in SQL
+        price_override = record.price_overrides.find { |override| override.product_id == product.id }
+        price_override&.price || product.price
+      end
+
+      def available?
+        return @available unless @available.nil?
+
+        @available = inventory.available_source_ids.include? record.id
+      end
+
+      def unavailable?
+        !available?
       end
     end
 

data/app/models/accountability/order_group.rb

@@ -29,8 +29,11 @@ module Accountability
       order_items.each(&:accrue_credit!)
     end
 
-    def add_item!(product)
-      order_items.create! product: product
+    # The `product` parameter accepts Product, String, and Integer objects
+    def add_item!(product, source_scope: nil)
+      product = Product.find(product) unless product.is_a? Product
+
+      order_items.create! product: product, source_scope: source_scope.presence
     end
 
     def unassigned?

data/app/models/accountability/order_item.rb

@@ -51,7 +51,15 @@ class Accountability::OrderItem < ApplicationRecord
   end
 
   def default_price
-    product.price
+    price_override&.price || product.price
+  end
+
+  def price_override
+    return @price_override unless @price_override.nil?
+    return unless source_records.one?
+
+    # Memoize as `false` if nil to avoid re-running query
+    @price_override = product.price_overrides.find_by(offerable_source: source_records) || false
   end
 
   def trigger_callback(trigger)
@@ -76,9 +84,11 @@ class Accountability::OrderItem < ApplicationRecord
   end
 
   def source_records
+    return @source_records unless @source_records.nil?
+
     return [] if source_scope.empty?
     return [] if product.source_class.nil?
 
-    product.source_class.where(**source_scope)
+    @source_records = product.source_class.where(**source_scope)
   end
 end

data/app/models/accountability/price_override.rb

@@ -0,0 +1,8 @@
+module Accountability
+  class PriceOverride < ApplicationRecord
+    belongs_to :offerable_source, polymorphic: true
+    belongs_to :product
+
+    validates :price, presence: true, numericality: { greater_than_or_equal_to: 0 }
+  end
+end

data/app/models/accountability/product.rb

@@ -13,6 +13,7 @@ module Accountability
 
     has_and_belongs_to_many :coupons
     has_many :order_items, dependent: :restrict_with_error
+    has_many :price_overrides, dependent: :destroy
     has_many :credits, through: :order_items, inverse_of: :product
 
     serialize :source_scope, Hash

data/app/models/concerns/accountability/active_merchant_interface/stripe_interface.rb

@@ -46,6 +46,8 @@ module Accountability
     private
 
     def store_card_in_gateway(gateway = initialize_payment_gateway)
+      raise 'No token found' if token.blank?
+
       gateway.store(token, description: configuration_name, email: contact_email, set_default: true)
     end
 

data/config/locales/en.yml

@@ -7,6 +7,8 @@ en:
         quantity: "Bundle Size"
         sku: "SKU"
   accountability:
+    errors:
+      not_permitted: 'is not permitted'
     gateway:
       errors:
         unknown_gateway_error: "An unknown gateway error has occurred"

data/lib/accountability/configuration.rb

@@ -1,7 +1,7 @@
 module Accountability
   class Configuration
     class << self
-      attr_accessor :logo_path, :payment_gateway, :dev_tools_enabled
+      attr_accessor :logo_path, :payment_gateway, :dev_tools_enabled, :country_whitelist
       attr_writer :tax_rate, :admin_checker, :billable_identifier, :billable_name_column
 
       def tax_rate

data/lib/accountability/extensions/acts_as_offerable.rb

@@ -14,6 +14,11 @@ module Accountability
           end
 
           self.acts_as = acts_as.dup << :offerable
+
+          if reflections['price_overrides'].blank?
+            has_many :price_overrides, class_name: 'Accountability::PriceOverride',
+                     as: :offerable_source, dependent: :destroy
+          end
         end
 
         alias_method :acts_as_offerable, :has_offerable

data/lib/accountability/types/billing_configuration_types.rb

@@ -14,6 +14,14 @@ module Accountability
 
         validates :address_1, :city, :state, :country, presence: true
         validates :zip, numericality: { only_integer: true }
+        validate :validate_country_whitelisted
+
+        def validate_country_whitelisted
+          return unless Configuration.country_whitelist.present?
+          return if country.blank?
+
+          errors.add(:country, :not_permitted) unless Configuration.country_whitelist.include? country
+        end
       end
 
       class BillingAddressType < ActiveModel::Type::Value

data/lib/accountability/version.rb

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

data/lib/generators/accountability/install_generator.rb

@@ -9,10 +9,10 @@ module Accountability
       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 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: accountability
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Joshua Stowers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-23 00:00:00.000000000 Z
+date: 2020-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_accountability_merchant
@@ -116,6 +116,7 @@ files:
 - app/models/accountability/order_group.rb
 - app/models/accountability/order_item.rb
 - app/models/accountability/payment.rb
+- app/models/accountability/price_override.rb
 - app/models/accountability/product.rb
 - app/models/accountability/statement.rb
 - app/models/accountability/transactions.rb