glysellin 0.4.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NTc3ZmMwNGU1YTk5ODFhMDAxZTgwMjBiNDk1Njk5OGZlYzJmOGJmMQ==
+  data.tar.gz: !binary |-
+    YzY4Y2U4NmE1NDEzODQ2NmEwNjVlNWE3NmYzN2NjMDNlYWZlMmIyYw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MmZjMzA5YTRiOWUzN2Y5ZjgxYWZiZmUzOWI3NDQ3ODI0ZDA1YzJmZDBkYzBk
+    MjYzMGE2NThkYWE5NDc4NTM2NDlkMmJmMzU4NmE4ZGI2ZGQxMmU1MTM5OGQ5
+    MTU3NTYyMjg5ZGQxMzEwNTEwM2ZjMmE2YjQxMDRmYjcxZDZmZjE=
+  data.tar.gz: !binary |-
+    MTU1ZjBiY2M0ZjlkNDBmYzdiYThhNzViMDY3N2M0YjY4ODI5Zjk2OTE5MGQ3
+    NzQ4ZjRmNzdmMGNkMDhiNzVhNWJkMzAxY2YyMGVjMjZlYTc3MDNkNmM3MWJm
+    MmM4NjAwYTA3YmE5NDc5N2ZhN2QxZGIwODAwYTE4MTg0MWY5OGM=

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Valentin Ballestrino
+
+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 @@
+# Glysellin
+
+Glysellin is a Rails lightweight e-commerce solution that helps you get simple products, orders and payment gateways without the whole set of functionalities a real e-commerce needs.
+
+In order to stay simple, we choosed for now to keep with some strong dependencies that may not fit to your app.
+
+Also, no admin interface is provided so you can integrate it, but we always use [RailsAdmin](https://github.com/sferik/rails_admin).
+
+
+## Dependencies
+
+* [Devise](https://github.com/plataformatec/devise)
+* [Paperclip](https://github.com/thoughtbot/paperclip)
+* [Simple Form](https://github.com/plataformatec/simple_form)
+
+
+## Disclaimer
+
+Glysellin is under development and can now be used, but documentation is poor, there are no tests and API can change quickly while we don't have tested it within enough projects.
+
+
+## Installing
+
+To process to glysellin's installation, you shall use the install generator which will :
+
+* Create an initializer file to configure the shop's behavior
+* Copy all needed migrations
+* Migrate and seed default data
+* Mount the engine
+* Copy the actions and mailers views to be overriden
+
+The install generator command :
+
+```bash
+rails generate glysellin:install
+```
+
+
+## Using the Cart
+
+The shopping cart contents are stored in user's cookies, with the key `glysellin.cart`
+
+
+### Displaying the cart
+
+To display the cart you must render it's partial in your layout :
+
+```erb
+<%= render_cart(current_cart) %>
+```
+
+
+### Filling the cart
+
+To fill the cart, you can use the pre-built helper to create a simple "Add to cart" form that asynchronously updates user's cart contents.
+You must pass the helper a `Glysellin::Product` instance in order to make it work :
+
+```erb
+<%= add_to_cart_form(@product) %>
+```
+
+
+## Managing orders
+
+By default, being bound to Devise, Glysellin automatically generates anonymous users to bind orders to. You can choose to keep this behavior alone, or add real subscription in the ordering process or remove the default behavior to force users to create an account by switching off the default functionality in the initializer (default parameter is commented) :
+
+```ruby
+# config/initializers/glysellin.rb
+Glysellin.config do |config|
+  # Allows creating fake accounts for customers with automatic random
+  # password generation
+  # Defaults to true
+  #
+  config.allow_anonymous_orders = true
+end
+```
+
+
+## Customizing Order behavior
+
+Since the Order object is implemented with the [state_machine gem](), it emits state transition events.
+On install, a sample observer is copied to `app/models/order_observer.rb` in your application.
+To be able to use it, you must configure your app to allow the `OrderObserver` to listen to `Order` state transitions by uncommenting and editing the following `active_record.observers` config line in your `application.rb` file :
+
+```ruby
+# config/application.rb
+
+# Activate observers that should always be running.
+config.active_record.observers = :order_observer
+```
+
+
+## Gateway integration
+
+The routes to redirect the payments gateways to are :
+
+* For the automatic Server to Server response : `http://yourapp.com/<glysellin_mount_point>/orders/gateway/:gateway` where :gateway is the gateway slug
+* For the "Return to shop" redirections :
+    * Success response : `http://yourapp.com/<glysellin_mount_point>/orders/gateway/response/paid`
+    * Error response : `http://yourapp.com/<glysellin_mount_point>/orders/gateway/response/cancel`

data/Rakefile

@@ -0,0 +1,29 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Glysellin'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+

data/app/assets/javascripts/glysellin/address.coffee

@@ -0,0 +1,38 @@
+class GlysellinAddress
+  defaults =
+    onUpdated: null
+
+  constructor: (@container) ->
+    @shipping_address_container = @container.find('.shipping-address-container')
+    @billing_address_container = @container.find('.billing-address-container')
+    @toggle_shipping_address = @container.find('[data-toggle="address"]')
+    @shipping_address_fields = @shipping_address_container.clone()
+    @bindAll()
+
+  bindAll: () ->
+    @toggle_shipping_address.on "change", =>
+      @switchAddress()
+
+  switchAddress: () ->
+    if @toggle_shipping_address.is(':checked')
+      @shipping_address_container.html(@shipping_address_fields)
+      
+      for attr in ['first_name', 'last_name', 'address', 'zip', 'city', 'tel']
+        if @shipping_address_container.find("[name*='[#{ attr }]']").val() == ""
+          @shipping_address_container.find("[name*='[#{ attr }]']").val(@billing_address_container.find("[name*='[#{ attr }]']").val())
+
+      # Country
+      val = @billing_address_container.find("[name*='country']").val()
+      if @shipping_address_container.find("[name*='country']").val() == ""
+        @shipping_address_container.find("[name*='country']").val(val)
+        @shipping_address_container.find("[name*='country']").change()
+
+    else
+      @shipping_address_fields = @shipping_address_container.clone()
+      @shipping_address_container.html('')
+
+
+$.fn.glysellinAddress = () ->
+  @each ->
+    address = new GlysellinAddress($(this))
+    address.switchAddress() 

data/app/assets/javascripts/glysellin/async-cart.coffee

@@ -0,0 +1,139 @@
+class AsyncCart
+  constructor: (@container) ->
+    @defaultPostOptions = {
+      utf8: @container.find('input[name="utf8"]').val(),
+      authenticity_token: @container.find('input[name="authenticity_token"]').val()
+    }
+
+    $totalRow = @container.find('.products-total-row')
+    @totals = {
+      eot: $totalRow.find('.total-eot-price')
+      total: $totalRow.find('.total-price')
+    }
+
+    @subtotalsRow = @container.find('.products-subtotal-row')
+    @subtotals = {
+      eot: @subtotalsRow.find('.eot-subtotal'),
+      total: @subtotalsRow.find('.subtotal')
+    }
+
+    @adjustmentRow = @container.find('.adjustment-row[data-type=discount-code]')
+    @adjustment = {
+      name: @adjustmentRow.find('.adjustment-name'),
+      value: @adjustmentRow.find('.adjustment-value')
+    }
+
+    @discountCode = @container.find('#glysellin_cart_basket_discount_code')
+
+    @cart_path = @container.data("cart-url")
+
+    @bindAll()
+
+  bindAll: ->
+    @container.find('.quantity-input')
+      .on('change', (e) => @quantityChanged(e.currentTarget))
+      .on 'keyup', (e) =>
+        @handleEnterKey(e)
+
+    @discountCode.on 'keyup', (e) =>
+      @handleEnterKey(e)
+
+    @container.find('.update-discount-code-btn').on 'click', (e) =>
+      @discountCodeUpdated()
+
+    @discountCode.on 'change', (e) =>
+      @discountCodeUpdated()
+
+    @adjustmentRow.find('.remove-discount-btn').on 'click', (e) =>
+      @resetDiscountCode(); false
+
+    @container.on "submit", (e, force = false) -> force
+
+    @container.find("[name=submit_order]").on "click", (e) =>
+      if e.clientX != 0 && e.clientY != 0
+        @container.trigger("submit", [true])
+
+  handleEnterKey: (e) ->
+    $(e.currentTarget).trigger('change') if e.which == 13
+    false
+
+  quantityChanged: (el) ->
+    $el = $(el)
+    quantity = parseInt($el.val(), 10)
+
+    # Ensure we have an int > 0 or use 1
+    unless $.isNumeric(quantity) && quantity > 0
+      quantity = 1
+      $el.val(quantity)
+
+    @update(
+      "products/#{ $el.data('id') }",
+      { _method: "put", quantity: quantity}
+      (resp) => @remoteQuantityUpdated(resp, $el)
+    )
+
+  remoteQuantityUpdated: (resp, $el) ->
+    # Current product row update handling
+    $tr = $el.closest('tr')
+    $el.val(resp.quantity)
+    $tr.find('.product-eot-price').text(resp.eot_price)
+    $tr.find('.product-price').text(resp.price)
+
+    # Total row handling
+    @setTotals(resp)
+    @setDiscountValues(resp)
+
+    @container.trigger('quantity-updated.glysellin')
+
+  discountCodeUpdated: ->
+    @update(
+      "discount_code"
+      { _method: "put", code: @discountCode.val() }
+      (resp) => @remoteAdjustmentUpdated(resp)
+    )
+
+  resetDiscountCode: ->
+    @update(
+      'update-discount-code'
+      { _method: "put", code: '' }
+      (resp) => @remoteAdjustmentUpdated(resp)
+    )
+
+  remoteAdjustmentUpdated: (resp) ->
+    discount = resp.discount_name
+    if discount
+      @setDiscountValues(resp)
+      @subtotalsRow.fadeIn(200)
+      @adjustmentRow.fadeIn(200)
+    else
+      @subtotalsRow.fadeOut(200) unless $('.adjustment-row').length > 1
+      @adjustmentRow.fadeOut(200, => @setDiscountValues(resp))
+
+    # Total row handling when
+    @setTotals(resp)
+
+    @container.trigger('discount-updated.glysellin', [discount])
+
+  update: (action, options, callback) ->
+    $.post(
+      "#{ @cart_path }/#{ action }",
+      $.extend({}, @defaultPostOptions, options),
+      callback,
+      'json'
+    )
+
+  setDiscountValues: (totals) ->
+    @adjustment.name.text(totals.discount_name)
+    @adjustment.value.text(totals.discount_value)
+
+  setTotals: (totals) ->
+    @subtotals.eot.text(totals.eot_subtotal)
+    @subtotals.total.text(totals.subtotal)
+    @totals.eot.text(totals.total_eot_price)
+    @totals.total.text(totals.total_price)
+
+$.fn.glysellinAsyncCart = (options = {})->
+  @each ->
+    $cart = $(this)
+    data = $cart.data('glysellin.async-cart')
+    $cart.data('glysellin.async-cart', new AsyncCart $cart, options) unless data

data/app/assets/javascripts/glysellin/base.js

@@ -0,0 +1,6 @@
+//= require ./cart
+//= require ./async-cart
+//= require ./address
+//= require ./product
+//= require ./main
+

data/app/assets/javascripts/glysellin/cart.coffee

@@ -0,0 +1,54 @@
+class GlysellinCart
+  defaults =
+    onUpdated: null
+
+  constructor: (@container, options) ->
+    @options = $.extend({}, defaults, options)
+    @add_to_cart_forms = $('[data-add-to-cart-form]')
+    @bindAll()
+
+  bindAll: ->
+    @add_to_cart_forms.on 'ajax:success', (e, resp) =>
+      @update(resp)
+
+  update: (markup) ->
+    $markup = $(markup)
+    $cart = $markup.find('.cart-container')
+    $warning = $markup.find('.added-to-cart-warning').remove()
+
+    @container.html($cart.html())
+
+    if $warning.length > 0
+      $warning.prependTo('body')
+      if ($default_modal = $warning.filter("[data-warning]"))
+        @handleDefaultModal($default_modal)
+
+    @updated()
+
+  updated: ->
+    # Allow app to update cart handlers when content updated
+    @container.trigger('updated.glysellin')
+    # Trigger update callback if passed
+    @options.onUpdated(this) if $.isFunction(@options.onUpdated)
+
+  # Default model handling
+  handleDefaultModal: ($modal) ->
+    $body = $('body')
+
+    closeFromBody = (e) ->
+      if $(e.target).closest("[data-warning]").length == 0
+        close()
+
+    close = ->
+      $modal.fadeOut(200, -> $modal.remove());
+      $body.off "click", closeFromBody
+      false
+
+    $modal.on "click", "[data-dismiss=warning]", close
+    $body.on "click", closeFromBody
+
+$.fn.glysellinCart = (options) ->
+  @each ->
+    $cart = $(this)
+    data = $cart.data('glysellin.cart')
+    $cart.data('glysellin.cart', new GlysellinCart($cart, options)) unless data

data/app/assets/stylesheets/glysellin/application.css

@@ -0,0 +1,13 @@
+/*
+ * 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 top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+*/

data/app/assets/stylesheets/glysellin/orders.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/glysellin/products.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/glysellin/cart/addresses_controller.rb

@@ -0,0 +1,17 @@
+module Glysellin
+  module Cart
+    class AddressesController < CartController
+      def update
+        current_cart.update(params[:glysellin_cart_basket])
+
+        if current_cart.valid?
+          current_cart.addresses_filled!
+          redirect_to cart_path
+        else
+          current_cart.state = "addresses"
+          render "glysellin/cart/show"
+        end
+      end
+    end
+  end
+end