shopping_cart 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: de878f70210e599591a870b65c1a30fd1fcafcf2
+  data.tar.gz: 45991e81778b420259ba56391bab6d86b732924d
+SHA512:
+  metadata.gz: 4ac5f31a87a6c9bbdb8f198aba8057fc47095286154762564e77b9c81173343c09cda3fd6b7371468e56d17f9a35b79fd73e55507b7ac83664629d8527b12d4e
+  data.tar.gz: e8ed59020c130a2afdb007e3954ec604852a410d7bb07292f4665e9343ea4a31bd2d7b708b89d32186c53c64cd5922062ebb83faaecd96646fd04ac6a5a9f79d

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Igor
+
+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,100 @@
+# ShoppingCart
+Simple gem which adds shopping cart and checkout ability to your shop.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'shopping_cart', github: 'rockandruby/shopping_cart'
+```
+
+## Usage
+ Define root in your routes and run 'rails g shopping_cart:config' to install shopping cart.
+
+  Ensure you have flash messages in app/views/layouts/application.html.erb.
+      For example:
+
+        <p class="notice"><%= notice %></p>
+        <p class="alert"><%= alert %></p>
+
+
+ Firstly, gem depends on devise. Thus your app must have current_{model_name} method to perform
+shopping cart functionality. For right now cart is accessible only for signed in users. Devise
+added as a dependency for cart thus you don't need add devise to your gemfile. All you need - to install device.
+
+ In config/initializers you will find shopping_cart initializer. By default, name of your user model is
+'User' but you can override it by changing ShoppingCart.user_class = 'User' with proper model name in
+string format.
+
+ By default, you have 4 steps for checkout: address, payment, shipping and complete. Payment and shipping
+are optional. In shopping cart initializer you have ShoppingCart.order_steps = %i(shipping payment) array.
+If you want to delete step, just delete it from array. If you want to delete optional steps at all, just
+comment the array ans you will have only address and complete steps.
+
+ Notice!!! Order of elements in ShoppingCart.order_steps are equal to steps' order in your app.
+
+ Notice!!!! If you use shipping step you should create needed shippings like
+ShoppingCart::Shipping.create(title:'Shipping title', price: 123).
+
+ When you install shopping cart, you retrieve migrations for default steps. You can delete proper migration for
+step you want to skip. Then run rails db:migrate to run migrations.
+
+ Of course, you can add your own steps. Just put the name of your step to steps' array in initializer and
+restart your app .
+
+ Run "rails g shopping_cart:controller MySteps 'first_step' 'second_step' " to generate controller,
+proper actions, views and routes for your steps. Don't forget that steps' names should be equal to names in
+your initializer.
+Don't forget that all entities should be in shopping_cart namespace. For instance, to create model for
+your steps you suppose to run shopping_cart/YourModelName.
+
+Your step controller will have 3 main methods:
+1) check_step(:your_step) which checks whether user able to proceed
+   action and returns true/false.
+2) update_step(:your_step) which allows user to proceed to next step.
+3) redirect_by_step(:your_step) which redirects to next step.
+
+Below simple example how it works:
+ def your_step
+  return redirect_to :back unless check_step(:your_step)
+  //do some code
+ end
+
+ def add_your_step
+   //do some code
+   update_step(:your_step)
+   redirect_by_step(:your_step)
+ end
+So
+
+ You should add the following association for your user model "has_many :orders,
+:class_name => 'ShoppingCart::Order'".
+
+ Cart can process any product type quantity, you just need to add the following association to
+your product model(e.g. Book, Magazine etc.)
+"has_many :order_items, :class_name => 'ShoppingCart::OrderItem', as: :productable".
+Also your model must have 'price' attribute.
+
+You form should include following fields:
+ hidden field "name='model' value='your model class'" e.g. "value='@book.class'".
+ text field "name='quantity'" and hidden field "name='id' value='@book.id'". For instance,
+
+ =form_tag(shopping_cart.order_items_path, class: 'form-inline') do
+   =text_field_tag(:quantity, '', class: 'form-control', type: 'number', required: true, min: 1)
+   =hidden_field_tag(:id, @book.id)
+   =hidden_field_tag(:model, @book.class)
+   =submit_tag
+
+ = link_to('cart', shopping_cart.order_items_path)
+
+ Submit your form on the following path shopping_cart.order_items_path.
+
+ You can override views and layout for shopping cart by generating them to your project with
+'rails g shopping_cart:views'.
+
+ Also, you're able to use discount for your cart. Just create the proper discount, for example:
+ShoppingCart::Discount.create(code: 'verification code', amount: 10), where amount is percentage.
+If you don't need discount ability, delete the proper button from view.
+
+I18n:
+ Run 'rails g shopping_cart:translate' to generate internationalization file to your app.

data/Rakefile

@@ -0,0 +1,37 @@
+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    = 'ShoppingCart'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/config/shopping_cart_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/shopping_cart .js
+//= link_directory ../stylesheets/shopping_cart .css

data/app/assets/javascripts/shopping_cart/application.js

@@ -0,0 +1,4 @@
+//= require jquery
+//= require jquery_ujs
+//= require bootstrap-sprockets
+//= require_tree .

data/app/assets/javascripts/shopping_cart/order_items.js.coffee

@@ -0,0 +1,4 @@
+$(document).on 'turbolinks:load, ready', ->
+  $('#coupon').on 'click', ->
+    event.preventDefault()
+    $('#add_couponModal').modal({backdrop: 'static'})

data/app/assets/stylesheets/shopping_cart/application.scss

@@ -0,0 +1,3 @@
+@import "bootstrap-sprockets";
+@import "bootstrap";
+@import "order_items";

data/app/assets/stylesheets/shopping_cart/order_items.scss

@@ -0,0 +1,7 @@
+.alert {
+  color: red;
+}
+
+.notice {
+  color: green;
+}

data/app/controllers/shopping_cart/application_controller.rb

@@ -0,0 +1,23 @@
+module ShoppingCart
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+    before_action "authenticate_#{ShoppingCart.user_class.downcase}!".to_sym
+    alias_method :current_user, "current_#{ShoppingCart.user_class.downcase}".to_sym
+
+    rescue_from CanCan::AccessDenied do |exception|
+      redirect_to '/', alert: exception.message
+    end
+
+    protected
+
+    def get_order
+      @user = send("current_#{ShoppingCart.user_class.downcase}")
+      @current_order = Order.current_order(@user)
+    end
+
+    def check_order
+      redirect_to root_path unless @current_order && @current_order.order_items_count > 0
+    end
+
+  end
+end

data/app/controllers/shopping_cart/checkout_controller.rb

@@ -0,0 +1,99 @@
+require_dependency "shopping_cart/application_controller"
+
+module ShoppingCart
+  class CheckoutController < ApplicationController
+    before_action :get_order
+    before_action :check_order
+    before_action :init_steps
+    before_action :init_address, only: [:index, :add_address]
+    before_action :init_payment, only: [:payment, :add_payment]
+    before_action :check_complete, only: [:complete, :create]
+
+    layout 'shopping_cart/checkout'
+
+    def shipping
+      redirect_to :back unless check_step(:shipping)
+      @shippings = Shipping.all
+    end
+
+    def payment
+      redirect_to :back unless check_step(:payment)
+    end
+
+    def create
+      @current_order.place_order
+      @current_order.update(completed_at: Time.now, total_price: @current_order.total_price)
+      flash[:notice] = t('shopping_cart.order_placed')
+      redirect_to '/'
+    end
+
+    def add_address
+      return render :index unless @address.update(address_params)
+      @current_order.update(step: 0) unless @current_order.step
+      redirect_to @steps ? "/shopping_cart/checkout/#{@steps[0]}" : '/shopping_cart/checkout/complete'
+    end
+
+    def add_shipping
+      unless params[:id]
+        flash[:alert] = t('shopping_cart.choose_shipping')
+        return redirect_to :back
+      end
+      shipping = Shipping.find(params[:id])
+      @current_order.update(shipping: shipping)
+      update_step(:shipping)
+      redirect_by_step(:shipping)
+    end
+
+    def add_payment
+      return render :payment unless @credit_card.update(payment_params)
+      update_step(:payment)
+      redirect_by_step(:payment)
+    end
+
+    private
+
+    def init_steps
+      @steps = ShoppingCart.order_steps
+    end
+
+    def init_address
+      @address = @current_order.address || Address.new(order: @current_order)
+    end
+
+    def init_payment
+      @credit_card = @current_order.credit_card || CreditCard.new(order: @current_order)
+    end
+
+    def address_params
+      params.require(:address).permit(:first_name, :last_name, :city, :phone, :details)
+    end
+
+    def payment_params
+      params.require(:credit_card).permit(:first_name, :last_name, :number, :cvv,
+                                          :expiration_month, :expiration_year)
+    end
+
+    def check_step(current_step)
+      @steps.index(current_step) <= @current_order.step if @current_order.step
+    end
+
+    def update_step(current_step)
+      if @current_order.step == @steps.index(current_step)
+        @current_order.update(step: @current_order.step + 1)
+      end
+    end
+
+    def check_complete
+      if @steps
+        redirect_to :back unless @current_order.step == @steps.count
+      else
+        redirect_to :back unless @current_order.address
+      end
+    end
+
+    def redirect_by_step(current_step)
+      return redirect_to '/shopping_cart/checkout/complete' if !@steps || current_step == @steps.last
+      redirect_to "/shopping_cart/checkout/#{@steps[@steps.index(current_step) + 1]}"
+    end
+  end
+end

data/app/controllers/shopping_cart/order_items_controller.rb

@@ -0,0 +1,51 @@
+require_dependency "shopping_cart/application_controller"
+
+module ShoppingCart
+  class OrderItemsController < ApplicationController
+    load_and_authorize_resource only: [:destroy, :update]
+
+    before_action :get_order
+    before_action :check_order, except: [:index, :create]
+
+    def create
+      model = params['model'].constantize
+      product = model.find(params['id'])
+      return unless product.respond_to?(:price) && OrderItem.new(quantity: params[:quantity]).valid?
+      @current_order ||= Order.create(user: @user)
+      order_item = @current_order.order_items.find_by(productable: product)
+      if order_item
+        order_item.update(quantity: params[:quantity])
+      else
+        @current_order.order_items.create(productable: product,
+                                          price: product.price, quantity: params[:quantity])
+      end
+      flash[:notice] = t('shopping_cart.item_added')
+      redirect_to root_path
+    end
+
+    def update
+      flash[:notice] = t('shopping_cart.cart_updated') if @order_item.update(quantity: params[:quantity])
+      redirect_to root_path
+    end
+
+    def destroy
+      @order_item.destroy
+      redirect_to root_path
+    end
+
+    def destroy_items
+      @current_order.order_items.destroy_all
+      redirect_to root_path
+    end
+
+    def discount
+      discount = Discount.find_by_code(params[:code])
+      if discount && discount.order_id.nil?
+        discount.update(order: @current_order)
+        flash[:notice] = t('shopping_cart.valid_coupon', amount: discount.amount)
+      end
+      redirect_to root_path
+    end
+
+  end
+end

data/app/helpers/shopping_cart/application_helper.rb

@@ -0,0 +1,4 @@
+module ShoppingCart
+  module ApplicationHelper
+  end
+end

data/app/helpers/shopping_cart/order_items_helper.rb

@@ -0,0 +1,7 @@
+module ShoppingCart
+  module OrderItemsHelper
+    def total_for_item(item)
+      item.price * item.quantity
+    end
+  end
+end

data/app/helpers/shopping_cart/orders_helper.rb

@@ -0,0 +1,7 @@
+module ShoppingCart
+  module OrdersHelper
+    def calculate_discount(order)
+      order.discount_amount ? order.subtotal_price * (order.discount_amount.to_f / 100) : 0
+    end
+  end
+end

data/app/jobs/shopping_cart/application_job.rb

@@ -0,0 +1,4 @@
+module ShoppingCart
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/shopping_cart/application_mailer.rb

@@ -0,0 +1,6 @@
+module ShoppingCart
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/ability.rb

@@ -0,0 +1,8 @@
+class Ability
+  include CanCan::Ability
+
+  def initialize(user)
+    alias_action :update, :destroy, to: :modify
+    can :modify, ShoppingCart::OrderItem, order_id: ShoppingCart::Order.current_order(user).id
+  end
+end

data/app/models/shopping_cart/address.rb

@@ -0,0 +1,7 @@
+module ShoppingCart
+  class Address < ApplicationRecord
+    belongs_to :order
+
+    validates :first_name, :last_name, :phone, presence: true
+  end
+end