piggybak_giftcerts 0.0.1

data/db/migrate/20121026200953_piggybak_giftcert_setup.rb

@@ -0,0 +1,45 @@
+class PiggybakGiftcertSetup < ActiveRecord::Migration
+  def up
+    create_table :giftcerts do |t|
+      t.string :code, :null => false
+      t.decimal :amount, :null => false
+      t.date :expiration_date
+      t.references :order
+      t.timestamps
+    end
+    create_table :buyable_giftcerts do |t|
+    end
+    create_table :giftcert_applications do |t|
+      t.references :line_item
+      t.references :giftcert
+      t.timestamps
+    end
+
+    gc_vals = [10, 20, 40]
+
+    option = ::PiggybakVariants::Option.new({ :name => "Amount", :position => 1 })
+    option.option_configurations << ::PiggybakVariants::OptionConfiguration.new({ :klass => "PiggybakGiftcerts::BuyableGiftcert" })
+    gc_vals.each { |val| option.option_values << ::PiggybakVariants::OptionValue.new({ :name => "$#{val}", :position => 1 }) }
+    option.save
+
+    bg = ::PiggybakGiftcerts::BuyableGiftcert.new
+    gc_vals.each do |val|
+      s = ::Piggybak::Sellable.new({ :sku => "giftcert-#{val}", :description => "$#{val} Gift Certificate", :price => val, :active => true, :unlimited_inventory => true }) 
+      v = ::PiggybakVariants::Variant.new
+      v.piggybak_sellable = s
+      v.option_values << ::PiggybakVariants::OptionValue.find_by_name("$#{val}")
+      bg.variants << v
+    end
+
+    bg.save
+  end
+
+  def down
+    drop_table :giftcerts
+    drop_table :buyable_giftcerts
+    drop_table :giftcert_applications
+
+    option = ::PiggybakVariants::Option.find_by_name("Amount")
+    ::PiggybakVariants::Option.destroy(option)
+  end
+end

data/lib/piggybak_giftcerts/engine.rb

@@ -0,0 +1,89 @@
+require 'piggybak_giftcerts/line_item_decorator'
+require 'piggybak_giftcerts/order_decorator'
+require 'piggybak_giftcerts/percent_decorator'
+
+module PiggybakGiftcerts
+  class Engine < ::Rails::Engine
+    isolate_namespace PiggybakGiftcerts
+
+    config.to_prepare do
+      Piggybak::LineItem.send(:include, ::PiggybakGiftcerts::LineItemDecorator)
+      Piggybak::Order.send(:include, ::PiggybakGiftcerts::OrderDecorator)
+      Piggybak::TaxCalculator::Percent.send(:include, ::PiggybakGiftcerts::PercentDecorator)
+    end
+
+    config.before_initialize do
+      Piggybak.config do |config|
+        config.line_item_types[:giftcert_application] = { :visible => true,
+                                                        :nested_attrs => true,
+                                                        :fields => ["giftcert_application"],
+                                                        :allow_destroy => true,
+                                                        :class_name => "::PiggybakGiftcerts::GiftcertApplication",
+                                                        :display_in_cart => "Gift Certificate",
+                                                        :sort => config.line_item_types[:payment][:sort]
+                                                      }
+        config.line_item_types[:payment][:sort] += 1
+      end
+    end
+
+    initializer "piggybak_variants.add_helper" do |app|
+      ApplicationController.class_eval do
+        helper :piggybak_variants
+      end
+    end
+
+    initializer "piggybak_giftcerts.precompile_hook" do |app|
+      app.config.assets.precompile += ['piggybak_giftcerts/piggybak_giftcerts.js']
+    end
+
+    initializer "piggybak_giftcerts.rails_admin_config" do |app|
+      RailsAdmin.config do |config|
+        config.model PiggybakGiftcerts::BuyableGiftcert do
+          navigation_label "Orders"
+          label "Gift Certificate Configuration"
+          list do
+            # Hide filter, search, etc
+            field :variants
+          end
+        end
+
+        config.model PiggybakGiftcerts::Giftcert do
+          navigation_label "Orders"
+          label "Gift Certificates"
+
+          list do
+            field :code
+            field :amount do
+              formatted_value do
+                "$%.2f" % value
+              end
+            end
+            field :expiration_date
+            field :application_detail
+          end
+          edit do
+            field :code
+            field :amount
+            field :expiration_date
+          end
+        end
+
+        config.model PiggybakGiftcerts::GiftcertApplication do
+          label "Giftcert"
+          visible false
+
+          edit do
+            field :code do
+              read_only do
+                !bindings[:object].new_record?
+              end
+              pretty_value do
+                bindings[:object].giftcert ? bindings[:object].giftcert.code : ""
+              end 
+            end
+          end
+        end
+      end
+    end 
+  end
+end

data/lib/piggybak_giftcerts/line_item_decorator.rb

@@ -0,0 +1,21 @@
+module PiggybakGiftcerts
+  module LineItemDecorator
+    extend ActiveSupport::Concern
+
+    def preprocess_giftcert_application
+      self.description = "Giftcert"
+      self.giftcert_application.order = self.order
+      if !self.new_record?
+        valid_giftcert = ::PiggybakGiftcerts::Giftcert.valid_giftcert(self.giftcert_application.giftcert.code, self.order, true)
+        if !valid_giftcert.is_a?(::PiggybakGiftcerts::Giftcert)
+          self.mark_for_destruction
+        end
+      end
+    end
+
+    def postprocess_giftcert_application
+      self.price = ::PiggybakGiftcerts::Giftcert.apply_giftcert(self.giftcert_application.giftcert.code, self.order, nil, -1*self.price)
+      true
+    end
+  end
+end

data/lib/piggybak_giftcerts/order_decorator.rb

@@ -0,0 +1,41 @@
+module PiggybakGiftcerts
+  module OrderDecorator
+    extend ActiveSupport::Concern
+
+    included do
+      alias :piggybak_create_payment_shipment :create_payment_shipment
+      def create_payment_shipment; giftcert_create_payment_shipment; end
+
+      after_create :create_and_send_giftcert_email, :if => Proc.new { |order| order.user_agent != "admin" }
+
+      has_many :giftcerts, :class_name => "::PiggybakGiftcerts::Giftcert"
+    end
+
+    def giftcert_create_payment_shipment
+      piggybak_create_payment_shipment
+
+      # Deleting Piggybak line item if gift certificate coverage 
+      payment_line_item = self.line_items.detect { |li| li.line_item_type == "payment" }
+      if payment_line_item && payment_line_item.payment.number == "giftcert"
+        self.line_items.delete(payment_line_item)
+      end
+    end
+
+    def create_and_send_giftcert_email
+      begin
+        self.line_items.sellables.each do |li| 
+          next if !(li.sellable.item.is_a?(::PiggybakVariants::Variant) && li.sellable.item.item_type == "PiggybakGiftcerts::BuyableGiftcert")
+          li.quantity.times do
+            # TODO: Replace 2.years with configurable interval
+            gc = ::PiggybakGiftcerts::Giftcert.new({ :amount => li.unit_price, :order_id => self.id, :expiration_date => Date.today + 2.years })
+            if !gc.save
+              Rails.logger.warn "Could not create gift certificate: #{gc.errors.full_messages}"
+            end
+          end
+        end
+        ::PiggybakGiftcerts::GiftcertMailer.info(self).deliver
+      rescue
+      end
+    end 
+  end
+end

data/lib/piggybak_giftcerts/percent_decorator.rb

@@ -0,0 +1,23 @@
+module PiggybakGiftcerts
+  module PercentDecorator
+    extend ActiveSupport::Concern
+
+    included do
+      def self.rate(method, object)
+        taxable_total = 0
+        if object.is_a?(::Piggybak::Cart)
+          object.sellables.each do |i|
+            next if (i[:sellable].item.is_a?(::PiggybakVariants::Variant) && i[:sellable].item.item_type == "PiggybakGiftcerts::BuyableGiftcert")
+            taxable_total += i[:quantity]*i[:sellable].price
+          end
+        else
+          object.line_items.sellables.each do |li|
+            next if (li.sellable.item.is_a?(::PiggybakVariants::Variant) && li.sellable.item.item_type == "PiggybakGiftcerts::BuyableGiftcert")
+            taxable_total += li.quantity*li.sellable.price
+          end
+        end
+        (method.metadata.detect { |m| m.key == "rate" }.value.to_f * taxable_total).to_c
+      end
+    end
+  end
+end

data/lib/piggybak_giftcerts/version.rb

@@ -0,0 +1,3 @@
+module PiggybakGiftcerts
+  VERSION = "0.0.1"
+end

data/lib/piggybak_giftcerts.rb

@@ -0,0 +1,4 @@
+require "piggybak_giftcerts/engine"
+
+module PiggybakGiftcerts
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,15 @@
+// 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
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/test/dummy/app/assets/stylesheets/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/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", :media => "all" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/config/application.rb

@@ -0,0 +1,59 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require
+require "piggybak_giftcerts"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+
+    # Enable escaping HTML in JSON.
+    config.active_support.escape_html_entities_in_json = true
+
+    # Use SQL instead of Active Record's schema dumper when creating the database.
+    # This is necessary if your schema can't be completely dumped by the schema dumper,
+    # like if you have constraints or database-specific column types
+    # config.active_record.schema_format = :sql
+
+    # Enforce whitelist mode for mass assignment.
+    # This will create an empty whitelist of attributes available for mass-assignment for all models
+    # in your app. As such, your models will need to explicitly whitelist or blacklist accessible
+    # parameters by using an attr_accessible or attr_protected declaration.
+    config.active_record.whitelist_attributes = true
+
+    # Enable the asset pipeline
+    config.assets.enabled = true
+
+    # Version of your assets, change this if you want to expire all your assets
+    config.assets.version = '1.0'
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!