workarea-inventory_notifications 2.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6ba4d6ca31b9f2266d0c3c0631bd42f697a3fb42985178f069a0384b2c0f4a02
+  data.tar.gz: e836462072d65e2343d22b34b44dfefe4a9b57f83a16521e311d3a092221166a
+SHA512:
+  metadata.gz: ea57e300a4e529f958e7105826555e5055a4debd215cfb45935299c52184206bb7279c709fec1e0a006ed305479128a5e01e4baefa808333780f767c4ac7c038
+  data.tar.gz: a0d89f8e017a97f9ad5d91a24c39ebe7a77ea574a0f0fd5595cc674eab08a2663b0c8ce94637dc09c954af776803a559ccbfdd44b506c5085bb570e74928aa46

data/.editorconfig

@@ -0,0 +1,15 @@
+# editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+end_of_line = lf
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[{*.rb,*.haml,*.scss}]
+indent_size = 2
+
+[{*.js,*.jst,*.ejs}]
+indent_size = 4

data/.eslintrc

@@ -0,0 +1,24 @@
+{
+    "extends": "eslint:recommended",
+    "rules": {
+      "semi": [1, "always"]
+    },
+    "globals": {
+      "window": true,
+      "document": true,
+      "WORKAREA": true,
+      "$": true,
+      "jQuery": true,
+      "_": true,
+      "feature": true,
+      "JST": true,
+      "Turbolinks": true,
+      "I18n": true,
+      "Chart": true,
+      "Dropzone": true,
+      "strftime": true,
+      "Waypoint": true,
+      "wysihtml": true,
+      "LocalTime": true,
+    }
+}

data/.gitignore

@@ -0,0 +1,12 @@
+.DS_Store
+.bundle/
+Gemfile.lock
+.sass-cache/
+log/*.log
+pkg/
+coverage/
+test/dummy/public/system/*
+test/dummy/db/*.sqlite3
+test/dummy/log/*.log
+test/dummy/tmp/
+test/dummy/.sass-cache

data/.jshintrc

@@ -0,0 +1,31 @@
+{
+    "bitwise": true,
+    "camelcase": false,
+    "curly": true,
+    "eqeqeq": true,
+    "forin": true,
+    "immed": true,
+    "indent": 4,
+    "latedef": true,
+    "newcap": true,
+    "noarg": true,
+    "noempty": true,
+    "nonew": true,
+    "plusplus": true,
+    "quotmark": true,
+    "undef": true,
+    "unused": true,
+    "strict": true,
+    "trailing": true,
+    "browser": true,
+    "jquery": true,
+    "onevar": true,
+    "white": true,
+    "globals": {
+        "_": false,
+        "_gaq": false,
+        "JST": false,
+        "Modernizr": false,
+        "WEBLINC": false
+    }
+}

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_gem:
+  workarea-ci: rubocop.yml

data/CHANGELOG.md

@@ -0,0 +1,99 @@
+Workarea Inventory Notifications 2.1.2 (2019-08-21)
+--------------------------------------------------------------------------------
+
+*   Open Source!
+
+
+
+Workarea Inventory Notifications 2.1.1 (2019-03-05)
+--------------------------------------------------------------------------------
+
+*   INVENNOTIF-19: Remove unused view
+
+    Andy Sides
+
+
+
+Workarea Inventory Notifications 2.1.0 (2019-02-05)
+--------------------------------------------------------------------------------
+
+*   Update test to be decorated
+
+    Update Storefront::ProductViewModelTest and require Workarea >= 3.3.0
+
+    INVENNOTIF-18
+    Andy Sides
+
+
+
+Workarea Inventory Notifications 2.0.2 (2019-02-05)
+--------------------------------------------------------------------------------
+
+*   INVENNOTIF-17: Fix system test file name and location
+
+    Andy Sides
+
+
+
+Workarea Inventory Notifications 2.0.1 (2019-01-08)
+--------------------------------------------------------------------------------
+
+*   Fix displaying notification on option set product templates
+
+    Fixes a bug around the notification link on the option selects or option
+    thumbnails product templates
+
+    INVENNOTIF-15
+    Andy Sides
+
+*   Fix failing tests
+
+    Update tests to use correct syntax for specifying inventory
+    policy and to temporarily adjust Workarea.config.send_email
+    when testing email sends.
+
+    INVENNOTIF-14
+    gharnly
+
+
+
+Workarea Inventory Notifications 2.0.0 (2017-05-26)
+--------------------------------------------------------------------------------
+
+*   Fix bug where inventory notification is displayed before sku is selected
+
+    Have to use sku from options, rather than current_sku to determine
+    whether the current_sku_available? This is because current_sku will
+    default to the first sku if no sku is selected.
+
+    INVENNOTIF-10
+    Beresford, Jake
+
+*   Upgrade for v3
+
+    * Added new inventory policy AllowNotify for notifications
+    * Change logic for unavailable skus in the view model to be specific to current_sku
+    * Update UI to show inventory notification link if sku is unavailable
+    * rename everything
+    * Update decorators to .decorator files
+    * Update dependencies
+    * Remove JS module that was specific to clothing template
+    * Remove add_form controller action, this is now redundant as JS module for clothing was removed
+    * storefront translations
+    * Update appends and move to initializer
+    * Combine listener and worker
+    * use ApplicationDocument in model and add index to sku
+    * remove unused view models
+    * Convert mailer templates to haml and add translations
+    * Convert Rspec to minitest
+    * Update .gitignore for minitest
+    * Install rubocop and clean up code styles
+
+    INVENNOTIF-9
+    Beresford, Jake
+
+*   INVENNOTIF-7: Add product image to inventory mailer view
+    Beresford, Jake
+
+
+

data/Gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+source 'https://gems.weblinc.com'
+
+# Declare your gem's dependencies in api.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'debugger'
+
+gem "workarea", source: 'https://gems.weblinc.com'

data/README.md

@@ -0,0 +1,65 @@
+Workarea Inventory Notifications
+================================================================================
+
+Plugin to add back in stock notifications to the storefront.
+
+If a product is out of stock, and has the 'allow notify' inventory policy, consumers will see a link
+to request a back in stock notification.
+
+When the Inventory::Sku save method is called the restock_notifier checks if the sku is
+now purchasable, checks for unsent inventory notifications on that sku, and sends the mailer.
+
+The notify inventory policy behaves the same ways as Inventory::Policy::Standard except
+it will always display a product, even when it is out of stock.
+
+
+Compatibility with workarea-clothing
+--------------------------------------------------------------------------------
+
+Due to changes in how Clothing works, as of workarea v3, the inventory notifications gem
+is only compatible with Clothing >= v2.1.0.
+
+
+Getting Started
+--------------------------------------------------------------------------------
+
+This gem contains a rails engine that must be mounted onto a host Rails application.
+
+You must have access to a WebLinc gems server to use this gem. Add your gems server credentials to Bundler:
+
+    bundle config gems.weblinc.com my_username:my_password
+
+Or set the appropriate environment variable in a shell startup file:
+
+    export BUNDLE_GEMS__WEBLINC__COM='my_username:my_password'
+
+Then add the gem to your application's Gemfile specifying the source:
+
+    # ...
+    gem 'workarea-inventory_notifications', source: 'https://gems.weblinc.com'
+    # ...
+
+Or use a source block:
+
+    # ...
+    source 'https://gems.weblinc.com' do
+      gem 'workarea-inventory_notifications'
+    end
+    # ...
+
+Update your application's bundle.
+
+    cd path/to/application
+    bundle
+
+Workarea Platform Documentation
+--------------------------------------------------------------------------------
+
+See [http://developer.weblinc.com](http://developer.weblinc.com) for Workarea platform documentation.
+
+Copyright & Licensing
+--------------------------------------------------------------------------------
+
+Copyright WebLinc 2017. All rights reserved.
+
+For licensing, contact sales@workarea.com.

data/Rakefile

@@ -0,0 +1,43 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path('../test/dummy/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'
+load 'rails/tasks/statistics.rake'
+load 'workarea/changelog.rake'
+
+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
+
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'workarea/inventory_notifications/version'
+
+desc "Release version #{Workarea::InventoryNotifications::VERSION} of the gem"
+task :release do
+  host = "https://#{ENV['BUNDLE_GEMS__WEBLINC__COM']}@gems.weblinc.com"
+
+  #Rake::Task['workarea:changelog'].execute
+  #system 'git add CHANGELOG.md'
+  #system 'git commit -m "Update CHANGELOG"'
+  #system 'git push origin HEAD'
+
+  system "git tag -a v#{Workarea::InventoryNotifications::VERSION} -m 'Tagging #{Workarea::InventoryNotifications::VERSION}'"
+  system 'git push --tags'
+
+  system 'gem build workarea-inventory_notifications.gemspec'
+  system "gem push workarea-inventory_notifications-#{Workarea::InventoryNotifications::VERSION}.gem"
+  system "gem push workarea-inventory_notifications-#{Workarea::InventoryNotifications::VERSION}.gem --host #{host}"
+  system "rm workarea-inventory_notifications-#{Workarea::InventoryNotifications::VERSION}.gem"
+end

data/app/assets/stylesheets/workarea/storefront/inventory_notifications/components/_inventory_notifications.scss

@@ -0,0 +1,14 @@
+/*------------------------------------*\
+    #INVENTORY-NOTIFICATIONS
+\*------------------------------------*/
+
+
+.inventory-notifications {}
+
+    .inventory-notifications__signup {
+        display: none;
+
+        .js & {
+            display: block;
+        }
+    }

data/app/controllers/workarea/storefront/inventory_notifications_controller.rb

@@ -0,0 +1,30 @@
+module Workarea
+  class Storefront::InventoryNotificationsController < Storefront::ApplicationController
+    before_action :set_product
+
+    def new; end
+
+    def create
+      @notification = InventoryNotification.new(notification_params)
+
+      if @notification.save
+        flash[:success] = t('workarea.storefront.inventory_notifications.flash_messages.saved')
+        redirect_to storefront.product_path(@product)
+      else
+        flash[:error] = t('workarea.storefront.inventory_notifications.flash_messages.error')
+        render :new
+      end
+    end
+
+    private
+
+      def set_product
+        model = Catalog::Product.find_by(slug: params[:product_id])
+        @product = Storefront::ProductViewModel.wrap(model, view_model_options)
+      end
+
+      def notification_params
+        params[:notification].permit(:product_id, :sku, :email)
+      end
+  end
+end

data/app/mailers/workarea/storefront/inventory_update_mailer.rb

@@ -0,0 +1,17 @@
+module Workarea
+  class Storefront::InventoryUpdateMailer < Storefront::ApplicationMailer
+    def notify(product_id, sku, email)
+      product = Catalog::Product.find(product_id)
+      @product = Storefront::ProductViewModel.wrap(product, sku: sku)
+      @variant = product.variants.where(sku: sku).first
+
+      mail(to: email, from: Workarea.config.email_from, subject: subject)
+    end
+
+    private
+
+      def subject
+        I18n.t('workarea.storefront.restock_mailer.subject')
+      end
+  end
+end

data/app/models/workarea/inventory/policies/allow_notify.rb

@@ -0,0 +1,11 @@
+module Workarea
+  module Inventory
+    module Policies
+      class AllowNotify < Standard
+        def displayable?
+          true
+        end
+      end
+    end
+  end
+end

data/app/models/workarea/inventory_notification.rb

@@ -0,0 +1,23 @@
+module Workarea
+  class InventoryNotification
+    include ApplicationDocument
+
+    field :product_id,  type: String
+    field :sku,         type: String
+    field :email,       type: String
+    field :sent_at,     type: DateTime
+
+    validates :product_id, presence: true
+    validates :sku, presence: true
+    validates :email, presence: true,
+                      email: true
+
+    index(sku: 1)
+
+    scope :unsent, -> { where(sent_at: nil) }
+
+    def mark_as_sent!
+      update_attributes(sent_at: Time.now)
+    end
+  end
+end

data/app/view_models/product_view_model.decorator

@@ -0,0 +1,45 @@
+module Workarea
+  decorate(Storefront::ProductViewModel, with: :inventory_notifications) do
+
+    def unavailable_sku_options
+      @unavailable_sku_options ||= format_variant_options(unavailable_skus)
+    end
+
+    def unavailable_skus
+      @unavailable_skus ||= variants.select do |variant|
+        !inventory.for_sku(variant.sku).purchasable?
+      end
+    end
+
+    def current_sku_unavailable?
+      unavailable_skus.any? { |sku| sku.sku == current_sku }
+    end
+
+    def purchasable?
+      super && !current_sku_unavailable?
+    end
+
+    private
+
+    def format_variant_options variants
+      variant_options = variants.map do |variant|
+        text = if variant.details.blank?
+                 variant.sku
+               else
+                  sku = variant.sku
+                   details = variant.details.map do |k, v|
+                     "#{k.titleize}: #{[v].flatten.join(', ')}"
+                   end.join(", ")
+                   "#{sku} - #{details}"
+               end
+        [ text, variant.sku ]
+      end
+
+      if variant_options.one?
+        variant_options
+      else
+        [['Please select options', nil ]] + variant_options
+      end
+    end
+  end
+end

data/app/views/workarea/storefront/inventory_notifications/new.html.haml

@@ -0,0 +1,19 @@
+- @title = t('workarea.storefront.inventory_notifications.new.title', product: @product.browser_title)
+
+.signup-notification.view
+
+  %h1= t('workarea.storefront.inventory_notifications.new.title', product: @product.browser_title)
+
+  = form_tag create_product_inventory_notification_path(@product), method: 'post', id: 'inventory_notification_form' do
+
+    %p= t('workarea.storefront.inventory_notifications.new.instruction')
+
+    = hidden_field_tag "notification[product_id]", @product.id
+    .property
+      = label_tag "notification_sku", t('workarea.storefront.inventory_notifications.new.select_options'), class: 'property__name'
+      .value= select_tag "notification[sku]", options_for_select(@product.unavailable_sku_options, params.fetch(:notification, {})[:sku]), required: true
+    .property
+      = label_tag "notification_email", t('workarea.admin.fields.email'), class: 'property__name'
+      .value= email_field_tag "notification[email]", current_user.try(:email), class: 'text-box', required: true, placeholder: t('workarea.storefront.forms.email_placeholder')
+
+    %p.add-to-notify-action= button_tag t('workarea.storefront.inventory_notifications.notify_me'), value: 'add_notification', class: 'button button--large'

data/app/views/workarea/storefront/inventory_update_mailer/notify.html.haml

@@ -0,0 +1,32 @@
+%tr
+  %td{ :colspan => "3", :valign => "top" }
+    %table{ :border => "0", :cellpadding => "10", :cellspacing => "0", :width => "100%" }
+      %tr
+        %td{ :valign => "top" }
+          %h1{ :style => "margin: 0 0 6px; font: bold 20px arial; color: #{@config.heading_color};" }
+            = t('workarea.storefront.restock_mailer.heading', product_name: @product.name)
+          %p{ :style => "margin: 0 0 6px; font: 13px/1.5 arial; color: #{@config.text_color};" }
+            = t('workarea.storefront.restock_mailer.message')
+%tr
+  %td{ :colspan => "3" }
+    %table{ :border => "0", :cellpadding => "10", :cellspacing => "0", :style => "color: #{@config.text_color}; font: 13px/1.5 arial; text-align: left; border-collapse: collapse;", :width => "600" }
+      %tbody
+        %tr
+          %td{ :style => "border: 1px solid #{@config.table_border_color};", :width => "150" }
+            %table{ :border => "0", :cellpadding => "10", :cellspacing => "0", :style => "color: #{@config.text_color}; font: 13px/1.5 arial; text-align: left; border-collapse: collapse;", :width => "200" }
+              %tr
+                %td
+                  = link_to product_url(@product) do
+                    = image_tag(product_image_url(@product.primary_image, :medium_thumb), alt: @product.name)
+          %td{ :style => "border: 1px solid #{@config.table_border_color};", :width => "450" }
+            %p{ :style => "margin: 0 0 6px; font: 13px/1.5 arial; color: #{@config.text_color};" }
+              %a{ :href => "#{storefront.product_url(@product, sku: @variant.sku)}", :style => "color: #{@link_color};", :target => "_blank" }
+                = @product.name
+            %p{ :style => "margin: 0 0 6px; font: 13px/1.5 arial; color: #{@config.text_color};" }
+              = @variant.name
+            - @variant.details.each do |name, value|
+              %p{ :style => "margin: 0 0 6px; font: 13px/1.5 arial; color: #{@config.text_color};" }
+                %strong
+                  = name.titleize
+                  \:
+                = value.first

data/app/views/workarea/storefront/inventory_update_mailer/notify.text.haml

@@ -0,0 +1,14 @@
+= t('workarea.storefront.restock_mailer.heading', product_name: @product.name)
+\===========================================
+
+= "\r\n"
+
+= t('workarea.storefront.restock_mailer.message')
+= product_url(@product)
+
+= "\r\n"
+
+= t('workarea.storefront.restock_mailer.product')
+\=======
+= @product.name
+\- #{@variant.sku}

data/app/views/workarea/storefront/products/_inventory_notifications.html.haml

@@ -0,0 +1,8 @@
+- if product.current_sku_unavailable?
+  #inventory_notifications.inventory-notifications
+    .inventory-notifications__signup
+      %p
+        %strong= t('workarea.storefront.products.this_item_is_out_of_stock')
+      %p
+        = t('workarea.storefront.products.inventory_notification_prompt')
+        = link_to t('workarea.storefront.products.sign_up_for_email_notification'),  storefront.new_product_inventory_notification_path(product), data: { dialog_button: '' }

data/app/workers/workarea/restock_notifier.rb

@@ -0,0 +1,27 @@
+module Workarea
+  class RestockNotifier
+    include Sidekiq::Worker
+    include Sidekiq::CallbacksWorker
+
+    sidekiq_options(
+      enqueue_on: { Inventory::Sku => :save },
+      queue: 'low',
+      retry: false
+    )
+
+    def perform(id)
+      sku = Inventory::Sku.find(id)
+
+      return unless sku.purchasable?
+
+      InventoryNotification.unsent.where(sku: sku.id).each do |notification|
+        send_notification(notification);
+      end
+    end
+
+    def send_notification(notification)
+      attrs = notification.attributes.values_at('product_id', 'sku', 'email')
+      notification.mark_as_sent! if Storefront::InventoryUpdateMailer.notify(*attrs).deliver
+    end
+  end
+end

data/bin/rails

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run 'rails' with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/inventory_notifications/engine', __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'action_controller/railtie'
+require 'action_view/railtie'
+require 'action_mailer/railtie'
+require 'rails/test_unit/railtie'
+require 'sprockets/railtie'
+
+require 'rails/engine/commands'

data/config/initializers/appends.rb

@@ -0,0 +1,11 @@
+module Workarea
+  Plugin.append_partials(
+    'storefront.product_details',
+    'workarea/storefront/products/inventory_notifications'
+  )
+
+  Plugin.append_stylesheets(
+    'storefront.components',
+    'workarea/storefront/inventory_notifications/components/inventory_notifications'
+  )
+end

data/config/initializers/inventory_policies.rb

@@ -0,0 +1,3 @@
+Workarea.configure do |config|
+  config.inventory_policies.insert(-1, 'Workarea::Inventory::Policies::AllowNotify')
+end

data/config/locales/en.yml

@@ -0,0 +1,22 @@
+en:
+  workarea:
+    storefront:
+      inventory_notifications:
+        flash_messages:
+          saved: You will be notified when this item becomes available.
+          error: Notification sign up failed. Please try again.
+        new:
+          instruction: To receive a notification of when the item comes back in stock, select an option and enter your email address below
+          select_options: Select options
+          title: "Sign up to be notified when %{product} comes back in stock"
+        notify_me: Notify Me
+      products:
+        this_item_is_out_of_stock: This item is out of stock.
+        inventory_notification_prompt: To receive a notification of when the item comes back in stock
+        enter_email_address_below: enter your email address below.
+        sign_up_for_email_notification: sign up for an email notification
+      restock_mailer:
+        heading: "%{product_name} is back in stock."
+        message: Get yours today!
+        product: Product
+        subject: Product back in stock

data/config/routes.rb

@@ -0,0 +1,10 @@
+# Add routes for your plugin, like so:
+#
+# Workarea::Admin::Engine.routes.draw do
+#   resources :inventory_notifications
+# end
+#
+Workarea::Storefront::Engine.routes.draw do
+  get 'inventory_notifications/:product_id/new' => 'inventory_notifications#new', as: :new_product_inventory_notification
+  post 'inventory_notifications/:product_id' => 'inventory_notifications#create', as: :create_product_inventory_notification
+end

data/lib/workarea/inventory_notifications/engine.rb

@@ -0,0 +1,8 @@
+module Workarea
+  module InventoryNotifications
+    class Engine < ::Rails::Engine
+      include Workarea::Plugin
+      isolate_namespace Workarea::InventoryNotifications
+    end
+  end
+end

data/lib/workarea/inventory_notifications/version.rb

@@ -0,0 +1,5 @@
+module Workarea
+  module InventoryNotifications
+    VERSION = '2.1.2'
+  end
+end