spree_waiting_list 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 94ce597e1f1cb22e6ccc49eb75a4d95dfe2cfa53
+  data.tar.gz: 8d70c57816a1554c80e8a0c18f128317a45d61e9
+SHA512:
+  metadata.gz: 0e73e4207bacaac4a20dbc6d0e8d0493732a504718ffd13c3f8bd214f78c00e95dab0850a9686094b6df2d9f796c0e927ae718e37addaf653cce6be6ccc8d898
+  data.tar.gz: 614634f1c4c94def5e48a2b2258ff19403c55f5f0b88055ecd33ea8d2524e3044fd15bdaf106f35b2298cdc0fdca44ffc238f754db1e36b757eebfcbdd7a81de

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,44 @@
+Spree Waiting List
+================
+[![Code Climate](https://codeclimate.com/github/DynamoMTL/spree_waiting_list/badges/gpa.svg)](https://codeclimate.com/github/DynamoMTL/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 can be regenerated by using `rake test_app`.
+
+```shell
+bundle
+bundle exec rake
+```
+
+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) 2011 Joshua Nussbaum, released under the New BSD License

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

@@ -0,0 +1,10 @@
+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,32 @@
+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
+        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,16 @@
+Spree::PermittedAttributes.class_eval do
+  @@stock_request_attributes = [:email, :product_id, :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/product_decorator.rb

@@ -0,0 +1,7 @@
+Spree::Product.class_eval do
+  has_many :stock_requests
+
+  def notify_waiting_list
+    stock_requests.without_variant.notified(false).each &:notify!
+  end
+end

data/app/models/spree/stock_item_decorator.rb

@@ -0,0 +1,20 @@
+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,29 @@
+module Spree
+  class StockRequest < ActiveRecord::Base
+    belongs_to :product
+    belongs_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') }
+    scope :without_variant, -> { where(:variant_id => nil) }
+
+    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,12 @@
+module Spree
+
+  Variant.class_eval do
+    has_many :stock_requests
+
+    def notify_waiting_list
+      stock_requests.notified(false).each &:notify!
+      product.notify_waiting_list
+    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 ? request.variant.sku : request.product.sku,
+       request.product.name,
+       request.variant ? 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,12 @@
+%h1= Spree.t(:new_stock_request)
+  = render "spree/shared/error_messages", :target => @stock_request
+  = form_for @stock_request do |f|
+    = f.hidden_field :product_id
+    = 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/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,9 @@
+FactoryGirl.define do
+
+  factory :stock_request, class: Spree::StockRequest do
+    product
+    variant {product.master}
+    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

@@ -0,0 +1,232 @@
+--- !ruby/object:Gem::Specification
+name: spree_waiting_list
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Joshua Nussbaum
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: spree_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.6
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: coffee-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+- !ruby/object:Gem::Dependency
+  name: ffaker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: sass-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The waiting list allows users to signup to be notified via email when
+  an items comes back into stock
+email: joshnuss@gmail.com
+executables: []
+extensions: []
+extra_rdoc_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/product_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
+- 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: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- none
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Add a waiting list to your spree store
+test_files: []