spree_waiting_list 2.3.2 → 2.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6428996ed78ef117f6e7b97f3199967bfe716a4
-  data.tar.gz: 68d879b9d928998cb64337b474c6fe9befbe0d23
+  metadata.gz: c305dc7d9b374eed545dfb74cc2ec7b630bddea3
+  data.tar.gz: 31fd58246479ab7448db7f0ff48096b742efde37
 SHA512:
-  metadata.gz: d5cff40a9ffbc90d2aa505b1ec3eb7378deb53abe165408223396406e2590ef555959ac3b35fb8103517abd6d72e1d61a131a60e589b83e44a305024acb14225
-  data.tar.gz: 12b89d1444d8a21df61e1179d64dbc754c9b1383b18b55f13e0523c63a5d537a7ff02171fcc37fba1dcc26d554d20749df3e33d76e5f5df8a9585ea816d63618
+  metadata.gz: 47caac25c7b726b29deddc3579db3d19efd7e4154004c535790e7b18c57bdf48722fa1d71ad529512a670a07f5ea0eef9dd9a13a30b9481f00a802fa5d6cd7f9
+  data.tar.gz: 6270a821a131de2968679931ac39fcad60c3c1b7dd01313a8df99621b7e0393bfaa6a0a9d0531ca7c9167bccbfa87f9565aea602df38baabbb9ccba2a06e62c8

data/LICENSE

@@ -0,0 +1,23 @@
+Redistribution and use in source and binary forms, with or without modification, 
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice, 
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice, 
+      this list of conditions and the following disclaimer in the documentation 
+      and/or other materials provided with the distribution.
+    * Neither the name of the Rails Dog LLC nor the names of its 
+      contributors may be used to endorse or promote products derived from this 
+      software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,45 @@
+Spree Waiting List
+================
+[![Build Status](https://travis-ci.org/DynamoMTL/spree_waiting_list.svg?branch=master)](https://travis-ci.org/DynamoMTL/spree_waiting_list) [![Code Climate](https://codeclimate.com/github/DynamoMTL/spree_waiting_list/badges/gpa.svg)](https://codeclimate.com/github/DynamoMTL/spree_waiting_list) [![Test Coverage](https://codeclimate.com/github/DynamoMTL/spree_waiting_list/badges/coverage.svg)](https://codeclimate.com/github/DynamoMTL/spree_waiting_list) [![Gem Version](https://badge.fury.io/rb/spree_waiting_list.svg)](http://badge.fury.io/rb/spree_waiting_list)
+
+A waiting list extension for Spree.
+
+Users and guests can request to be notified via email when a product/variant comes back in stock.
+
+
+Installation
+------------
+
+Add spree_waiting_list to your Gemfile:
+
+```ruby
+gem 'spree_waiting_list'
+```
+
+Bundle your dependencies and run the installation generator:
+
+```shell
+bundle
+bundle exec rails g spree_waiting_list:install
+```
+
+Testing
+-------
+
+First bundle your dependencies, then run `rake`. `rake` will default to building the dummy app if it does not exist, then it will run specs. The dummy app should be regenerated by using `rake test_app`.
+
+```shell
+bundle
+bundle exec rake test_app
+bundle exec rspec spec
+```
+
+When testing your applications integration with this extension you may use it's factories.
+Simply add this require statement to your spec_helper:
+
+```ruby
+require 'spree_waiting_list/factories'
+```
+
+
+Copyright (c) 2015 Joshua Nussbaum, released under the New BSD License

data/app/controllers/spree/admin/reports_controller_decorator.rb

@@ -0,0 +1,8 @@
+Spree::Admin::ReportsController.class_eval do
+  add_available_report! :stock_requests
+
+  def stock_requests
+    @search = Spree::StockRequest.ransack(params[:q])
+    @stock_requests = @search.result
+  end
+end

data/app/controllers/spree/stock_requests_controller.rb

@@ -0,0 +1,31 @@
+module Spree
+  class StockRequestsController < StoreController
+    layout false
+
+    def new
+      @stock_request = StockRequest.new(stock_request_params)
+    end
+
+    def create
+      @stock_request = StockRequest.new(stock_request_params)
+      @stock_request.email = try_spree_current_user.email if try_spree_current_user
+
+      respond_to do |format|
+        if @stock_request.save
+          format.html { redirect_to root_path, notice: Spree.t(:successful_stock_request) }
+          format.js
+          format.json { render json: { status: 201, message: Spree.t(:successful_stock_request) } }
+        else
+          format.html { render action: 'new'}
+          format.json { render json: @stock_request.errors, status: :unprocessable_entity }
+        end
+      end
+    end
+
+    private
+
+    def stock_request_params
+      params.require(:stock_request).permit(permitted_attributes.stock_request_attributes)
+    end
+  end
+end

data/app/mailers/spree/user_mailer_decorator.rb

@@ -0,0 +1,11 @@
+Spree::UserMailer.class_eval do
+  def back_in_stock(stock_request)
+    @request = stock_request
+    @product = stock_request.product
+    @variant = stock_request.variant
+
+    mail(:subject => Spree.t(:back_in_stock_subject, :product_name => @product.name),
+         :from    => from_address,
+         :to      => stock_request.email)
+  end
+end

data/app/models/spree/permitted_attributes_decorator.rb

@@ -0,0 +1,13 @@
+Spree::PermittedAttributes.class_eval do
+  @@stock_request_attributes = [:email, :variant_id]
+end
+
+module Spree
+  module PermittedAttributes
+    class << self
+      mattr_reader :stock_request_attributes
+
+      ATTRIBUTES << :stock_request_attributes
+    end
+  end
+end

data/app/models/spree/stock_item_decorator.rb

@@ -0,0 +1,16 @@
+module Spree
+  StockItem.class_eval do
+    around_save :notify_availability
+
+    private
+    def notify_availability
+      available = count_on_hand_was <= 0 && count_on_hand > 0 && count_on_hand_changed?
+
+      yield
+
+      if available
+        variant.notify_waiting_list
+      end
+    end
+  end
+end

data/app/models/spree/stock_request.rb

@@ -0,0 +1,28 @@
+module Spree
+  class StockRequest < ActiveRecord::Base
+    belongs_to :variant
+    delegate :product, :to => :variant
+
+    validates :email, :presence => true,
+              :format => {with: /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\z/i}
+
+    default_scope { order('created_at desc') }
+
+    scope :notified, lambda { |is_notified| where(:status => is_notified ? 'notified' : 'new') }
+
+    state_machine :status, :initial => 'new' do
+      event :notify do
+        transition :from => 'new', :to => 'notified'
+      end
+
+      after_transition :to => 'notified', :do => :send_email
+    end
+
+    private
+
+    def send_email
+      UserMailer.back_in_stock(self).deliver
+    end
+
+  end
+end

data/app/models/spree/variant_decorator.rb

@@ -0,0 +1,13 @@
+module Spree
+  Variant.class_eval do
+    has_many :stock_requests
+
+    def waiting_list
+      stock_requests.notified(false)
+    end
+
+    def notify_waiting_list
+      waiting_list.each &:notify!
+    end
+  end
+end

data/app/views/spree/admin/reports/stock_requests.csv.erb

@@ -0,0 +1,9 @@
+<%= %w(email sku product variant status requested).collect{|h| "\"#{t(h)}\""}.join(',').html_safe %>
+<% @stock_requests.each do |request| %>
+  <%= [request.email,
+       request.variant.sku,
+       request.product.name,
+       request.variant.options_text,
+       request.status.titleize,
+       request.created_at.to_s(:short)].collect{|cell| "\"#{cell}\"" }.join(",").html_safe %>
+<% end %>

data/app/views/spree/admin/reports/stock_requests.html.haml

@@ -0,0 +1,27 @@
+- content_for :page_title do
+  = Spree.t(:stock_requests)
+- content_for :page_actions do
+  %li= link_to_with_icon 'icon-arrow-left', Spree.t(:back_to_reports_list), spree.admin_reports_url, :class => 'button'
+- content_for :table_filter_title do
+  = Spree.t(:date_range)
+- content_for :table_filter do
+  = render :partial => 'spree/admin/shared/stock_report_criteria', :locals => {}
+%table.admin-report{"data-hook" => "stock_requests"}
+  %thead
+    %tr
+      %th= sort_link @search, :email
+      %th= Spree.t(:product)
+      %th= Spree.t(:variant)
+      %th= sort_link @search, :status
+      %th= sort_link @search, :created_at, Spree.t(:requested)
+  %tbody
+    - @stock_requests.each do |stock_request|
+      - next if stock_request.product.nil?
+      %tr{:class => "cycle('even', 'odd')"}
+        %td= stock_request.email
+        %td= link_to stock_request.product.name, edit_admin_product_path(stock_request.product)
+        %td= stock_request.variant.options_text if stock_request.variant
+        %td= stock_request.status.titleize
+        %td
+          = time_ago_in_words(stock_request.created_at)
+          = Spree.t(:ago)

data/app/views/spree/admin/shared/_stock_report_criteria.html.haml

@@ -0,0 +1,10 @@
+= search_form_for @search, :url => spree.stock_requests_admin_reports_path  do |s|
+  .date-range-filter.field.align-center
+    = label_tag nil, Spree.t(:start), :class => 'inline'
+    = s.text_field :created_at_gt, :class => 'datepicker datepicker-from'
+    %span.range-divider
+      %i.icon-arrow-right
+    = s.text_field :created_at_lt, :class => 'datepicker datepicker-to'
+    = label_tag nil, Spree.t(:end), :class => 'inline'
+  .actions.filter-actions
+    = button Spree.t(:search), 'icon-search'

data/app/views/spree/stock_requests/create.js.erb

@@ -0,0 +1 @@
+alert('You have been added to the waiting list!');

data/app/views/spree/stock_requests/new.html.haml

@@ -0,0 +1,11 @@
+%h1= Spree.t(:new_stock_request)
+  = render "spree/shared/error_messages", :target => @stock_request
+  = form_for @stock_request do |f|
+    = f.hidden_field :variant_id
+    %p
+      = f.label :email
+      - if spree_current_user
+        = spree_current_user.email
+      - else
+        = f.text_field :email
+    = f.submit Spree.t(:submit_stock_request)

data/app/views/spree/user_mailer/back_in_stock.text.erb

@@ -0,0 +1 @@
+<%= link_to @product.name, @product %> is back in stock

data/config/locales/en.yml

@@ -0,0 +1,16 @@
+---
+en:
+  out_of_stock_product_requests: Requests for out of stock products
+  spree:
+    stock_requests: Stock Requests
+    created_at: Created
+    ago: ago
+    show_all: Show all
+    download: Download
+    variant: Variant
+    back_in_stock_subject: Hey! %{product_name} is back in stock
+    successful_stock_request: Thanks! we will notify you as soon as the item is back in stock
+    stock_requests_description: 'Out of stock product requests'
+    new_stock_request: Request New Stock Notification
+    submit_stock_request: Send Request
+    requested: requested

data/config/locales/pt-BR.yml

@@ -0,0 +1,16 @@
+---
+pt-BR:
+  out_of_stock_product_requests: Solicitações para produtos sem estoque
+  spree:
+    stock_requests: Solicitações de Produtos Indisponíveis
+    created_at: Criado
+    ago: atrás
+    show_all: Mostrar todos
+    download: Download
+    variant: Variante
+    back_in_stock_subject: Olá! %{product_name} está disponível novamente
+    successful_stock_request: Obrigado! Nós o notificaremos assim que o produto estiver disponível
+    stock_requests_description: Solicitações de Produtos não disponíveis
+    new_stock_request: Nova Solicitação de Produto Indisponível
+    submit_stock_request: Enviar Solicitação
+    requested: solicitado

data/config/routes.rb

@@ -0,0 +1,9 @@
+Spree::Core::Engine.routes.draw do
+  resources :stock_requests
+
+  namespace :admin do
+    resources :reports, :only => [:index, :show] do
+      get 'stock_requests', :on => :collection
+    end
+  end
+end

data/db/migrate/20091127192645_create_waiting_lists.rb

@@ -0,0 +1,16 @@
+class CreateWaitingLists < ActiveRecord::Migration
+  def self.up
+    create_table :waiting_lists do |t|
+      t.string :email
+      t.integer :product_id
+      t.integer :variant_id
+      t.string :status, :default => 'new' 
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :waiting_lists
+  end
+end

data/db/migrate/20110406120000_change_waiting_lists_to_stock_requests.rb

@@ -0,0 +1,9 @@
+class ChangeWaitingListsToStockRequests < ActiveRecord::Migration
+  def self.up
+    rename_table :waiting_lists, :stock_requests
+  end
+
+  def self.down
+    rename_table :stock_requests, :waiting_lists
+  end
+end

data/db/migrate/20141210144427_change_waiting_list_to_spree_waiting_list.rb

@@ -0,0 +1,15 @@
+class ChangeWaitingListToSpreeWaitingList < ActiveRecord::Migration
+  def self.up
+    rename_table :stock_requests, :spree_stock_requests
+
+    add_index :spree_stock_requests, :variant_id
+    add_index :spree_stock_requests, :product_id
+  end
+
+  def self.down
+    remove_index :spree_stock_requests, column: :variant_id
+    remove_index :spree_stock_requests, column: :product_id
+
+    rename_table :spree_stock_requests, :stock_requests
+  end
+end

data/db/migrate/20150131180156_remove_product_from_stock_request.rb

@@ -0,0 +1,5 @@
+class RemoveProductFromStockRequest < ActiveRecord::Migration
+  def change
+    remove_column :spree_stock_requests, :product_id
+  end
+end

data/lib/generators/spree_waiting_list/install/install_generator.rb

@@ -0,0 +1,31 @@
+module SpreeWaitingList
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+
+      class_option :auto_run_migrations, :type => :boolean, :default => false
+
+      def add_javascripts
+        # append_file 'vendor/assets/javascripts/spree/frontend/all.js', "//= require spree/frontend/spree_waiting_list\n"
+        # append_file 'vendor/assets/javascripts/spree/backend/all.js', "//= require spree/backend/spree_waiting_list\n"
+      end
+
+      def add_stylesheets
+        # inject_into_file 'vendor/assets/stylesheets/spree/frontend/all.css', " *= require spree/frontend/spree_waiting_list\n", :before => /\*\//, :verbose => true
+        # inject_into_file 'vendor/assets/stylesheets/spree/backend/all.css', " *= require spree/backend/spree_waiting_list\n", :before => /\*\//, :verbose => true
+      end
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=spree_waiting_list'
+      end
+
+      def run_migrations
+        run_migrations = options[:auto_run_migrations] || ['', 'y', 'Y'].include?(ask 'Would you like to run the migrations now? [Y/n]')
+        if run_migrations
+          run 'bundle exec rake db:migrate'
+        else
+          puts 'Skipping rake db:migrate, don\'t forget to run it!'
+        end
+      end
+    end
+  end
+end

data/lib/spree_waiting_list/engine.rb

@@ -0,0 +1,21 @@
+module SpreeWaitingList
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'spree_waiting_list'
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), '../../app/**/*_decorator*.rb')) do |c|
+        Rails.configuration.cache_classes ? require(c) : load(c)
+      end
+    end
+
+    config.to_prepare &method(:activate).to_proc
+
+  end
+end

data/lib/spree_waiting_list/factories.rb

@@ -0,0 +1,8 @@
+FactoryGirl.define do
+
+  factory :stock_request, class: Spree::StockRequest do
+    variant { |s| s.association(:base_variant) }
+    email 'test@home.org'
+  end
+
+end

data/lib/spree_waiting_list.rb

@@ -0,0 +1,3 @@
+require 'spree_core'
+require 'spree_waiting_list/engine'
+require 'haml'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spree_waiting_list
 version: !ruby/object:Gem::Version
-  version: 2.3.2
+  version: 2.3.3
 platform: ruby
 authors:
 - Joshua Nussbaum
@@ -184,7 +184,33 @@ email: joshnuss@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- LICENSE
+- README.md
+- app/controllers/spree/admin/reports_controller_decorator.rb
+- app/controllers/spree/stock_requests_controller.rb
+- app/mailers/spree/user_mailer_decorator.rb
+- app/models/spree/permitted_attributes_decorator.rb
+- app/models/spree/stock_item_decorator.rb
+- app/models/spree/stock_request.rb
+- app/models/spree/variant_decorator.rb
+- app/views/spree/admin/reports/stock_requests.csv.erb
+- app/views/spree/admin/reports/stock_requests.html.haml
+- app/views/spree/admin/shared/_stock_report_criteria.html.haml
+- app/views/spree/stock_requests/create.js.erb
+- app/views/spree/stock_requests/new.html.haml
+- app/views/spree/user_mailer/back_in_stock.text.erb
+- config/locales/en.yml
+- config/locales/pt-BR.yml
+- config/routes.rb
+- db/migrate/20091127192645_create_waiting_lists.rb
+- db/migrate/20110406120000_change_waiting_lists_to_stock_requests.rb
+- db/migrate/20141210144427_change_waiting_list_to_spree_waiting_list.rb
+- db/migrate/20150131180156_remove_product_from_stock_request.rb
+- lib/generators/spree_waiting_list/install/install_generator.rb
+- lib/spree_waiting_list.rb
+- lib/spree_waiting_list/engine.rb
+- lib/spree_waiting_list/factories.rb
 homepage: http://www.godynamo.com
 licenses: []
 metadata: {}
@@ -205,7 +231,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - none
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Add a waiting list to your spree store