tb_checkout 1.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6855d03966c3d9e13b133132baca368f57f4ed50
+  data.tar.gz: 810740b48a84765bfc42e5be5ca3e14d95506ed1
+SHA512:
+  metadata.gz: 8cb3dc92f75a684adf1902102b471be4d4339c127ff7247f4467ad381e39d0c032199e5d87fc36bf03ca8e7a071ce255f375e25aae102db57476dfc3ce7a25e8
+  data.tar.gz: afaf30847266b291b4d6b6007f2f4154fadd0472e005625e0650f7a5cc8561a0bcfc3525d6433c5bd4f935f2b110be3a86391259a93bfecda4f33e25e33b5a7b

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,162 @@
+# TB Checkout
+
+TB Checkout is a shopping cart engine intended for use with Rails and [Twice Baked](https://bitbucket.org/westlakedesign/tb_core/). The goal of this engine is to make a drop-in tool for shopping carts and transaction management to your existing product database.
+
+TB Checkout is **not** a full-fledged product management system. Instead, our goal is to make it easy for any of your existing ActiveRecord models to fit into the shopping cart and facilite transactions through a payment gateway.
+
+## Requirements
+
+Checkout requires at minimum the following gems:
+
+- Rails 4
+- TB Core 1.2
+- Active Merchant 1.43
+
+## Payment Gateways
+
+Those familiar with [Active Merchant](http://activemerchant.org) will know that it supports a wide variety of payment gateways. However, it should be noted that TB Checkout is currently being built and tested against [Authorize.net](authorize.net).
+
+More gateways may be added in the future, but we do not intend to cover them all. Pull requests adding support for a particular gateway are welcome.
+
+## Installation & Usage
+
+First, it is recommended you run the steps listed in the "Installation/Usage" section of the [TB Core](https://bitbucket.org/westlakedesign/tb_core/) README file. Then, perform the following steps:
+
+1. Add the following to your Gemfile
+
+        gem 'tb_checkout'
+
+2. Run bundle install
+3. Copy in database migrations to your new rails project
+
+        bundle exec rake railties:install:migrations
+        rake db:migrate
+
+4. Restart your application
+
+## Configuration
+
+TB Checkout accepts the following configuration options.
+
+    TbCheckout.configure do |config|
+      config.gateway = ActiveMerchant::Billing::AuthorizeNetGateway.new({ ... })
+      config.card_types = [:visa, :master, :discover, :american_express]
+      config.layout = 'application'
+      config.canada_is_real = true
+      config.cart_lifespan = 3.days
+    end
+
+#### gateway
+
+An `ActiveMerchant` gateway. See the [Active Merchant](http://activemerchant.org) documentation for help creating a payment gateway.
+
+#### card_types
+
+An array of acceptable credit card types. Remove any types you do not wish to see in the payment form.
+
+#### layout
+
+The base view layout to be used for all user-facing views. The default value will inherit from your base `ApplicationController` configuration.
+
+#### canada_is_real
+
+Set to true or false in order to show/hide Canadian provinces in the billing address section of the payment form. Defaults true.
+
+
+#### cart_lifespan
+
+Configures how long a cart lives until it is marked as abandoned. **NOTE:** Carts are not actually marked as abandoned until 
+
+## Purchasable Models
+
+As stated earlier, TB Checkout is not a product management system. You are expected to build your own library of products, categorizations, and so on. Once you have a product model, making it eligible for the shopping cart is easy.
+
+At minimum, a product must have a `price` decimal attribute and a `description` string attribute. You can add these columns to your model using the built-in migration method `add_tb_checkout_purchasable`. Or you could treat these as virtual attributes using instance methods.
+
+    class AddPurchasableToProducts < ActiveRecord::Migration
+      def change
+        add_tb_checkout_purchasable :products
+      end
+    end
+
+And in your model you should include the `TbCheckout::Purchasable` concern.
+
+    class Product < ActiveRecord::Base
+      include TbCheckout::Purchasable
+    end
+
+### Model Configuration
+
+The `TbCheckout::Purchasable` concern also addes a couple class methods for optional configuration.
+
+    class Product < ActiveRecord::Base
+      include TbCheckout::Purchasable
+
+      # Disable the quanitity picker in the shopping cart
+      tb_checkout_quantity_is_editable false
+
+      # Run this block after a transaction is captured
+      tb_checkout_after_capture ->(instance){
+        logger.debug 'My transaction was completed!'
+      }
+
+      # Alternatively, pass a method name as a symbol
+      tb_checkout_after_capture :after_capture
+
+      def after_capture(instance)
+        logger.debug 'My transaction was completed!'
+      end
+
+      # Delete this object if it is removed from the shopping cart
+      tb_checkout_delete_on_removal true
+
+      # Use this helper method to generate a product page url
+      tb_checkout_url_builder ->(instance, view){
+        view.product_path(product)
+      }
+
+      # Configure a partial that you want to render in the shopping cart
+      tb_checkout_cart_detail_view '/products/cart_view'
+    end
+
+#### tb_checkout_quantity_is_editable
+
+Pass false to remove the ability to modify quantities in the shopping cart. This is useful in situations where it only makes sense to purchase 1 quantity of something, i.e., making a donation.
+
+#### tb_checkout_after_capture
+
+Pass a lambda literal, or a symbol naming the method you wish to call. This hook will be called after a successful transation.
+
+#### tb_checkout_delete_on_removal
+
+Set to `true` if the object should be permanently deleted when it is removed from the shopping cart. This might make sense in a scenario where your purchasable objects are one-time use records, but not if your purchasable objects are reused across many carts. Defaults to `false`.
+
+#### tb_checkout_url_builder
+
+Pass a lambda literal, or a symbol naming the method you wish to call. This method will be called whenever we want to generate a URL to your product.
+
+#### tb_checkout_cart_detail_view
+
+Sometimes you want to render some custom HTML in the row of a shopping cart. This configuration allows you to point to a partial view file in your project. This partial will be passed an `item` local variable.
+
+**NOTE:** This partial will only be rendered after a succesful checkout. In-progress carts will only render the product description.
+
+## View Helpers
+
+The following helper methods are provided for convenience. See the Rdocs for the most up to date information regarding arguments and return values.
+
+#### tb_checkout_current_cart
+
+Returns the currently active shopping cart or nil if no cart is active.
+
+#### tb_checkout_cart_link
+
+    <%= tb_checkout_cart_link() %>
+
+Returns a link to the shopping cart.
+
+#### tb_checkout_add_to_cart
+
+    <%= tb_checkout_add_to_cart(my_product) %>
+
+Returns a button that, when clicked, adds a product to the shopping cart.

data/Rakefile

@@ -0,0 +1,24 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'TbCheckout'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_files.include('app/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'

data/app/assets/javascripts/tb_checkout/admin/carts.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/javascripts/tb_checkout/admin/transactions.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/javascripts/tb_checkout/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/app/assets/javascripts/tb_checkout/cart_items.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/javascripts/tb_checkout/carts.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/javascripts/tb_checkout/transactions.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/stylesheets/tb_checkout/admin/carts.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/assets/stylesheets/tb_checkout/admin/transactions.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/assets/stylesheets/tb_checkout/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/app/assets/stylesheets/tb_checkout/cart_items.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/assets/stylesheets/tb_checkout/carts.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/assets/stylesheets/tb_checkout/transactions.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/controllers/concerns/tb_checkout/controller_helpers.rb

@@ -0,0 +1,16 @@
+module TbCheckout::ControllerHelpers
+  extend ActiveSupport::Concern
+
+  included do
+    helper_method :tb_checkout_current_cart
+  end
+
+  def tb_checkout_current_cart
+    return TbCheckout::Cart.find_or_create_by({
+      :session_id => session.id,
+      :spud_user_id => current_user.try(:id),
+      :is_completed => false
+    })
+  end
+
+end

data/app/controllers/tb_checkout/admin/carts_controller.rb

@@ -0,0 +1,39 @@
+class TbCheckout::Admin::CartsController < Spud::Admin::ApplicationController
+  belongs_to_spud_app :shopping_carts
+  before_action :setup_breadcrumb
+  before_action :load_cart, :only => :show
+
+  def index
+    @carts = TbCheckout::Cart.order('created_at desc').includes(:cart_items).paginate(:page => params[:page])
+    if params[:status]
+      if params[:status] == 'completed'
+        @carts = @carts.completed()
+      elsif params[:status] == 'in-progress'
+        @carts = @carts.in_progress()
+      elsif params[:status] == 'abandoned'
+        @carts = @carts.abandoned()
+      end
+    end
+    respond_with @carts
+  end
+
+  def show
+    respond_with @cart
+  end
+
+private
+
+  def setup_breadcrumb
+    add_breadcrumb 'Shopping Carts', tb_checkout_admin_carts_path(:status => params[:status])
+  end
+
+  def load_cart
+    @cart = TbCheckout::Cart.where(:id => params[:id]).first
+    if @cart.blank?
+      flash[:error] = "Could not find the requested Shopping Cart"
+      redirect_to tb_checkout_admin_carts_path
+      return false
+    end
+  end
+
+end

data/app/controllers/tb_checkout/admin/transactions_controller.rb

@@ -0,0 +1,26 @@
+class TbCheckout::Admin::TransactionsController < Spud::Admin::ApplicationController
+  belongs_to_spud_app :transactions
+  add_breadcrumb 'Transactions', :tb_checkout_admin_transactions_path
+  before_action :load_transaction, :only => :show
+
+  def index
+    @transactions = TbCheckout::Transaction.order('created_at desc').paginate(:page => params[:page])
+    respond_with @transactions
+  end
+
+  def show
+    respond_with @transaction
+  end
+
+private
+
+  def load_transaction
+    @transaction = TbCheckout::Transaction.where(:id => params[:id]).first
+    if @transaction.blank?
+      flash[:error] = 'Could not find the requested Transaction'
+      redirect_to tb_checkout_admin_transactions_path
+      return false
+    end
+  end
+
+end

data/app/controllers/tb_checkout/application_controller.rb

@@ -0,0 +1,6 @@
+module TbCheckout
+  class ApplicationController < ::ApplicationController
+    respond_to :html, :json
+    layout TbCheckout.config.layout
+  end
+end

data/app/controllers/tb_checkout/cart_items_controller.rb

@@ -0,0 +1,63 @@
+class TbCheckout::CartItemsController < TbCheckout::ApplicationController
+
+  before_action :load_cart
+  before_action :load_cart_item, :only => [:update, :destroy]
+
+  def create
+    @cart_item = @cart.cart_items.create(cart_item_params)
+    respond_with @cart_item do |format|
+      format.html{
+        if @cart_item.errors.any?
+          flash[:error] = "An error occurred: \"#{@cart_item.errors.full_messages.first}\""
+          redirect_to :back
+        else
+          flash[:notice] = "Added \"#{@cart_item.item_description}\" to your cart"
+          redirect_to tb_checkout_cart_path
+        end
+      }
+    end
+  end
+
+  def update
+    @cart_item.update_attributes(cart_item_params)
+    respond_with @cart_item do |format|
+      format.html{
+        if @cart_item.errors.any?
+          flash[:error] = "An error occurred: \"#{@cart_item.errors.full_messages.first}\""
+          redirect_to :back
+        else
+          flash[:notice] = "Updated \"#{@cart_item.item_description}\" in your cart"
+          redirect_to tb_checkout_cart_path
+        end
+      }
+    end
+  end
+
+  def destroy
+    @cart_item.destroy()
+    respond_with @cart_item do |format|
+      format.html{
+        flash[:notice] = "Removed \"#{@cart_item.item_description}\" from your cart"
+        redirect_to tb_checkout_cart_path
+      }
+    end
+  end
+
+private
+
+  def load_cart
+    @cart = tb_checkout_current_cart
+  end
+
+  def load_cart_item
+    @cart_item = @cart.cart_items.where(:id => params[:id]).first
+    if @cart_item.blank?
+      raise Spud::NotFoundError('Cart Item')
+    end
+  end
+
+  def cart_item_params
+    params.require(:tb_checkout_cart_item).permit(:item_type, :item_id, :quantity)
+  end
+
+end