workarea-gift_cards 3.4.6

data/config/routes.rb

@@ -0,0 +1,31 @@
+Workarea::Admin::Engine.routes.draw do
+  scope '(:locale)', constraints: Workarea::I18n.routes_constraint do
+    resources :payment_gift_cards do
+      get :redemptions
+    end
+  end
+end
+
+Workarea::Storefront::Engine.routes.draw do
+  scope '(:locale)', constraints: Workarea::I18n.routes_constraint do
+    get 'gift_cards/balance', to: 'gift_cards#index'
+    get 'gift_cards/lookup', to: 'gift_cards#lookup'
+    patch 'checkout/add_gift_card', to: 'checkouts#add_gift_card'
+  end
+end
+
+if Workarea::Plugin.installed?(:api)
+  Workarea::Api::Admin::Engine.routes.draw do
+    resources :payment_gift_cards
+  end
+
+  Workarea::Api::Storefront::Engine.routes.draw do
+    resources :checkouts, only: [] do
+      member do
+        patch 'add_gift_card'
+      end
+    end
+
+    get 'gift_cards/balance', to: 'gift_cards#balance'
+  end
+end

data/lib/workarea/gift_cards/engine.rb

@@ -0,0 +1,19 @@
+module Workarea
+  module GiftCards
+    class Engine < ::Rails::Engine
+      include Workarea::Plugin
+      isolate_namespace Workarea::GiftCards
+
+      config.to_prepare do
+        [
+          Storefront::OrderViewModel,
+          Storefront::Checkout::SummaryViewModel,
+          Storefront::Checkout::PaymentViewModel,
+          Storefront::CartViewModel
+        ].each do |klass|
+          klass.send(:include, Workarea::Storefront::GiftCardOrderPricing)
+        end
+      end
+    end
+  end
+end

data/lib/workarea/gift_cards/version.rb

@@ -0,0 +1,5 @@
+module Workarea
+  module GiftCards
+    VERSION = '3.4.6'.freeze
+  end
+end

data/lib/workarea/gift_cards.rb

@@ -0,0 +1,11 @@
+require 'workarea'
+require 'workarea/storefront'
+require 'workarea/admin'
+
+module Workarea
+  module GiftCards
+  end
+end
+
+require 'workarea/gift_cards/version'
+require 'workarea/gift_cards/engine'

data/lib/workarea/mailer_previews/storefront/gift_card_mailer_preview.rb

@@ -0,0 +1,18 @@
+module Workarea
+  module Storefront
+    class GiftCardMailerPreview < ActionMailer::Preview
+      def created
+        card = Payment::GiftCard.create!(
+          amount: '100',
+          order_id: 'WL-123456',
+          to: 'to@example.com',
+          from: 'from@example.com',
+          message: 'Gift card message body',
+          notify: true,
+          purchased: true
+        )
+        GiftCardMailer.created(card.id)
+      end
+    end
+  end
+end

data/test/documentation/workarea/api/admin/gift_cards_documentation_test.rb

@@ -0,0 +1,82 @@
+require 'test_helper'
+require 'workarea/api/documentation_test' if Workarea::Plugin.installed?(:api)
+
+module Workarea
+  if Plugin.installed?(:api)
+    module Api
+      module Admin
+        class GiftCardsDocumentationTest < DocumentationTest
+          include Workarea::Admin::IntegrationTest
+
+          def sample_attributes
+            @sample_attributes = create_gift_card.as_json.except('_id')
+          end
+
+          resource 'Payment Gift Cards'
+
+          def test_and_document_index
+            description 'Listing payment gift cards'
+            route admin.payment_gift_cards_path
+            parameter :page, 'Current page'
+            parameter :sort_by, 'Field on which to sort (see responses for possible values)'
+            parameter :sort_direction, 'Direction to sort (asc or desc)'
+            2.times { |i| create_gift_card(to: "#{i}@weblinc.com") }
+
+            record_request do
+              get admin_api.payment_gift_cards_path,
+                  params: { page: 1, sort_by: 'created_at', sort_direction: 'desc' }
+
+              assert_equal(200, response.status)
+            end
+          end
+
+          def test_and_document_create
+            description 'Creating a gift card'
+            route admin_api.payment_gift_cards_path
+
+            record_request do
+              post admin_api.payment_gift_cards_path,
+                   params: { gift_card: sample_attributes.merge('token' => 'foobar') },
+                   as: :json
+
+              assert_equal(201, response.status)
+            end
+          end
+
+          def test_and_document_show
+            description 'Showing a gift card'
+            route admin_api.payment_gift_card_path(':id')
+
+            record_request do
+              get admin_api.payment_gift_card_path(create_gift_card.id)
+              assert_equal(200, response.status)
+            end
+          end
+
+          def test_and_document_update
+            description 'Updating a gift card'
+            route admin_api.payment_gift_card_path(':id')
+
+            record_request do
+              patch admin_api.payment_gift_card_path(create_gift_card.id),
+                    params: { gift_card: { to: 'test@weblinc.com' } },
+                    as: :json
+
+              assert_equal(204, response.status)
+            end
+          end
+
+          def test_and_document_destroy
+            description 'Removing a gift card'
+            route admin_api.payment_gift_card_path(':id')
+
+            record_request do
+              delete admin_api.payment_gift_card_path(create_gift_card.id)
+              assert_equal(204, response.status)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/test/documentation/workarea/api/storefront/gift_cards_documentation_test.rb

@@ -0,0 +1,107 @@
+require 'test_helper'
+require 'workarea/api/documentation_test' if Workarea::Plugin.installed?(:api)
+
+module Workarea
+  if Plugin.installed?(:api)
+    module Api
+      module Storefront
+        class GiftCardsDocumentationTest < DocumentationTest
+          resource 'Gift Cards'
+
+          def test_checking_gift_card_balance
+            description 'Checking gift card balance'
+            route storefront_api.gift_cards_balance_path
+            parameter 'email', 'The to address on the gift card'
+            parameter 'token', 'The gift card token to check the balance'
+            explanation <<-EOS
+              Use this endpoint to help a customer check the balance for one of
+              their gift cards. The email and token params are required.
+            EOS
+
+            gift_card = create_gift_card(
+              to: 'bcrouse@weblinc.com',
+              amount: 5.to_m
+            )
+
+            record_request do
+              get storefront_api.gift_cards_balance_path,
+                  params: { email: 'bcrouse@weblinc.com', token: gift_card.token }
+
+              assert_equal(200, response.status)
+            end
+          end
+
+          def test_paying_with_a_gift_card
+            description 'Checking out with a gift card'
+            route storefront_api.add_gift_card_checkout_path(':order_id')
+            explanation <<-EOS
+              This endpoint adds a gift card to the payment to pay for this
+              order. The amount will be taken from the gift card balance upon
+              checkout completion.
+            EOS
+
+            product = create_product(
+              name: 'Integration Product',
+              variants: [
+                { sku: 'SKU1',
+                  regular: 6.to_m,
+                  tax_code: '001',
+                  on_sale: true,
+                  sale: 5.to_m }
+              ]
+            )
+
+            create_shipping_service(
+              name: 'Ground',
+              tax_code: '001',
+              rates: [{ price: 7.to_m }]
+            )
+
+            gift_card = create_gift_card(amount: 5.to_m)
+
+            order = Order.create!
+
+            post storefront_api.cart_items_path(order),
+                 params: {
+                   product_id: product.id,
+                   sku: product.skus.first,
+                   quantity: 2
+                 }
+
+            patch storefront_api.checkout_path(order),
+                  params: {
+                    email: 'bcrouse@workarea.com',
+                    billing_address: {
+                      first_name:   'Ben',
+                      last_name:    'Crouse',
+                      street:       '12 N. 3rd St.',
+                      city:         'Philadelphia',
+                      region:       'PA',
+                      postal_code:  '19106',
+                      country:      'US',
+                      phone_number: '2159251800'
+                    },
+                    shipping_address: {
+                      first_name:   'Ben',
+                      last_name:    'Crouse',
+                      street:       '22 S. 3rd St.',
+                      city:         'Philadelphia',
+                      region:       'PA',
+                      postal_code:  '19106',
+                      country:      'US',
+                      phone_number: '2159251800'
+                    }
+                  }
+
+            record_request do
+              patch storefront_api.add_gift_card_checkout_path(order),
+                    params: { gift_card_number: gift_card.token }
+
+              assert_equal(200, response.status)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# 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_relative 'config/application'
+
+Rails.application.load_tasks

data/test/dummy/app/assets/config/manifest.js

@@ -0,0 +1,4 @@
+
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/test/dummy/app/assets/javascripts/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 any plugin's vendor/assets/javascripts directory 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. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/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 any plugin's vendor/assets/stylesheets directory 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 other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

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

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

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

data/test/dummy/app/jobs/application_job.rb

@@ -0,0 +1,2 @@
+class ApplicationJob < ActiveJob::Base
+end

data/test/dummy/app/mailers/application_mailer.rb

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

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

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

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

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/test/dummy/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/bin/setup

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+require 'pathname'
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../', __FILE__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?('config/database.yml')
+  #   cp 'config/database.yml.sample', 'config/database.yml'
+  # end
+
+  puts "\n== Preparing database =="
+  system! 'bin/rails db:setup'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/test/dummy/bin/update

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../', __FILE__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a way to update your development environment automatically.
+  # Add necessary update steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  puts "\n== Updating database =="
+  system! 'bin/rails db:migrate'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/test/dummy/config/application.rb

@@ -0,0 +1,24 @@
+require_relative 'boot'
+
+require 'action_controller/railtie'
+require 'action_view/railtie'
+require 'action_mailer/railtie'
+require 'rails/test_unit/railtie'
+require 'sprockets/railtie'
+
+# Workarea must be required before other gems to ensure control over Rails.env
+# for running tests
+require 'workarea/core'
+require 'workarea/admin'
+require 'workarea/storefront'
+
+Bundler.require(*Rails.groups)
+require 'workarea/gift_cards'
+
+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.
+  end
+end

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../Gemfile', __dir__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../lib', __dir__)

data/test/dummy/config/cable.yml

@@ -0,0 +1,9 @@
+development:
+  adapter: async
+
+test:
+  adapter: async
+
+production:
+  adapter: redis
+  url: redis://localhost:6379/1

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require_relative 'application'
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,54 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports.
+  config.consider_all_requests_local = true
+
+  # Enable/disable caching. By default caching is disabled.
+  if Rails.root.join('tmp/caching-dev.txt').exist?
+    config.action_controller.perform_caching = true
+
+    config.cache_store = :memory_store
+    config.public_file_server.headers = {
+      'Cache-Control' => 'public, max-age=172800'
+    }
+  else
+    config.action_controller.perform_caching = false
+
+    config.cache_store = :null_store
+  end
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  config.action_mailer.perform_caching = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations.
+  # config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+
+  # Suppress logger output for asset requests.
+  config.assets.quiet = true
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+
+  # Use an evented file watcher to asynchronously detect changes in source code,
+  # routes, locales, etc. This feature depends on the listen gem.
+  # config.file_watcher = ActiveSupport::EventedFileUpdateChecker
+end

data/test/dummy/config/environments/production.rb

@@ -0,0 +1,86 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both threaded web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Disable serving static files from the `/public` folder by default since
+  # Apache or NGINX already handles this.
+  config.public_file_server.enabled = ENV['RAILS_SERVE_STATIC_FILES'].present?
+
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
+
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+
+  # `config.assets.precompile` and `config.assets.version` have moved to config/initializers/assets.rb
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = 'http://assets.example.com'
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = 'X-Sendfile' # for Apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for NGINX
+
+  # Mount Action Cable outside main process or domain
+  # config.action_cable.mount_path = nil
+  # config.action_cable.url = 'wss://example.com/cable'
+  # config.action_cable.allowed_request_origins = [ 'http://example.com', /http:\/\/example.*/ ]
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Use the lowest log level to ensure availability of diagnostic information
+  # when problems arise.
+  config.log_level = :debug
+
+  # Prepend all log lines with the following tags.
+  config.log_tags = [:request_id]
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Use a real queuing backend for Active Job (and separate queues per environment)
+  # config.active_job.queue_adapter     = :resque
+  # config.active_job.queue_name_prefix = "dummy_#{Rails.env}"
+  config.action_mailer.perform_caching = false
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation cannot be found).
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+
+  # Use a different logger for distributed setups.
+  # require 'syslog/logger'
+  # config.logger = ActiveSupport::TaggedLogging.new(Syslog::Logger.new 'app-name')
+
+  if ENV['RAILS_LOG_TO_STDOUT'].present?
+    logger           = ActiveSupport::Logger.new(STDOUT)
+    logger.formatter = config.log_formatter
+    config.logger = ActiveSupport::TaggedLogging.new(logger)
+  end
+
+  # Do not dump schema after migrations.
+  # config.active_record.dump_schema_after_migration = false
+end