spree_bronto 3.pre.0.pre.stable

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a3b281282ef7df4d0775cc2f3976816056a08299
+  data.tar.gz: c79c53d0d2365adb45ccaa4bdeb28f1303e1af75
+SHA512:
+  metadata.gz: 3a7f38114418ee73de73409ab38df5912de2a61c1f0138be74801d4c0ce7abe92de5c6985dc66c66539d1189865f8e641f2563087185f16ff493bd113d84f772
+  data.tar.gz: 88c9f9674a8036d3bfc5ef1625cef6227ce3713d870ad7948a38f08bc1912e62e105b737bf5f98c375d74d07ac8174bcea9f4488ff9c2df84c8fb1b98e0373df

data/.gitignore

@@ -0,0 +1,14 @@
+\#*
+*~
+.#*
+.DS_Store
+.idea
+.project
+.sass-cache
+coverage
+Gemfile.lock
+tmp
+nbproject
+pkg
+*.swp
+spec/dummy

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'spree', github: 'spree/spree', branch: '3-0-stable'
+gem 'savon', github: 'savonrb/savon'
+# Provides basic authentication functionality for testing parts of your engine
+gem 'spree_auth_devise', github: 'spree/spree_auth_devise', branch: '3-0-stable'
+
+gemspec

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2015 [name of plugin creator]
+All rights reserved.
+
+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 Spree 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,73 @@
+SpreeBronto
+===========
+
+Spree_bronto is one extension for spree to use Bronto mailing services and cart recovery tagging. Bronto API call code is basically one copy
+from Wombat Bronto End_point.
+
+This extension's older version is used in your Spree 0.11 web site.
+This new spree 3.0 compatible version is brand new, please give any feedback to us: albertliu at naturalwellbeing.com
+
+
+Yaml file to config your bronto acccount and email api id for order/shipment confirmation emails.
+This extension support multi-domain, and can confiture at store level with identity with store code. if no store level config found, it fall to use the default
+
+Put your own bronto.yml in your application's config folder. Its content should include following:
+##################
+disable_cart_recovery: false
+# if this option is false, the tagkey must be present in your yaml file
+
+handle_asynchronously: true
+# if this option is true, delayed_job must be configured.
+
+default:
+   token: YOUR_BRONTO_TOKEN_TO_ACCESS_API
+   from_name: EMAIL_FROM NAME
+   tagkey: YOUR_BRONTO_CART_RECOVERY_KEY_IF_CART_RECOVERY_IS_ENABLED
+   order_shipped: EMAIL_API_ID_FOR_ORDER_SHIPPED_NOTIFICATION
+   order_received: EMAIL_API_ID_FOR_ORDER_CONFIRMATION
+   new_account: EMAIL_API_ID_FOR_ACCOUNT_CREATED
+   password_reset: EMAIL_API_ID_FOR_PASSWORD_RESET
+   order_canceled: EMAIL_API_ID_FOR_ORDER_CANCELED
+#######################
+
+
+Delayed_job is supposed to handle the asynch event here.
+
+In bronto's configuration, you need create the email templates specified in bronto.yml. You also need create two content tags with name as
+SENDTIME__CONTENT1 and SENDTIME__CONTENT2 .
+
+
+Installation
+------------
+
+Add spree_bronto to your Gemfile:
+
+```ruby
+gem 'spree_bronto'
+```
+
+Bundle your dependencies and run the installation generator:
+
+```shell
+bundle
+bundle exec rails g spree_bronto: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_bronto/factories'
+```
+
+Copyright (c) 2015 Naturalwellbeing distribution, released under the New BSD License

data/Rakefile

@@ -0,0 +1,21 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+require 'spree/testing_support/extension_rake'
+
+RSpec::Core::RakeTask.new
+
+task :default do
+  if Dir["spec/dummy"].empty?
+    Rake::Task[:test_app].invoke
+    Dir.chdir("../../")
+  end
+  Rake::Task[:spec].invoke
+end
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = 'spree_bronto'
+  Rake::Task['extension:test_app'].invoke
+end

data/app/assets/javascripts/spree/backend/spree_bronto.js

@@ -0,0 +1,4 @@
+// Placeholder manifest file.
+// the installer will append this file to the app vendored assets here: vendor/assets/javascripts/spree/backend/all.js'
+
+Spree.routes.bronto_list = Spree.pathFor('admin/bronto_lists/get_list')

data/app/assets/javascripts/spree/frontend/bronto_list.js.coffee

@@ -0,0 +1,8 @@
+$(document).ready $('#retrieve_bronto_list').click(->
+  $.getScript '/admin/bronto_lists/get_lists?list_id=' + $('#bronto_list_list_id').val() + '&store_id=' + $('#bronto_list_store_id').val()
+  return
+)
+$(document).ready $('#bronto_list_store_id').change(->
+  $.getScript '/admin/bronto_lists/get_lists?list_id=' + $('#bronto_list_list_id').val() + '&store_id=' + $('#bronto_list_store_id').val()
+  return
+)

data/app/assets/javascripts/spree/frontend/spree_bronto.js

@@ -0,0 +1,2 @@
+// Placeholder manifest file.
+// the installer will append this file to the app vendored assets here: vendor/assets/javascripts/spree/frontend/all.js'

data/app/assets/stylesheets/spree/backend/spree_bronto.css

@@ -0,0 +1,4 @@
+/*
+Placeholder manifest file.
+the installer will append this file to the app vendored assets here: 'vendor/assets/stylesheets/spree/backend/all.css'
+*/

data/app/assets/stylesheets/spree/frontend/spree_bronto.css

@@ -0,0 +1,4 @@
+/*
+Placeholder manifest file.
+the installer will append this file to the app vendored assets here: 'vendor/assets/stylesheets/spree/frontend/all.css'
+*/

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

@@ -0,0 +1,24 @@
+class Spree::Admin::BrontoListsController < Spree::Admin::ResourceController
+  before_action :find_stores, only: [:edit, :new]
+
+  def get_lists
+    @lists = []
+    @list_id = params[:list_id] if params.key? :list_id
+    @store_id = params[:store_id] if params.key? :store_id
+    @site= Spree::Store.find(@store_id)
+    bronto=Bronto.new(Spree::BrontoConfiguration.account[@site.code]['token'])
+    et_lists=bronto.read_lists
+    #et_list = ET::List.new(Spree::Config.get(:exact_target_user), Spree::Config.get(:exact_target_password))
+    et_lists.each do |etl|
+      #list = et_list.retrieve_by_id etl[:id]
+      @lists << ["#{etl[:name]}", etl[:id]]
+    end
+    render :partial => "get_lists", :layout => false
+  end
+
+  private
+
+  def find_stores
+    @stores=Spree::Store.all
+  end
+end

data/app/controllers/spree/checkout_controller_decorator.rb

@@ -0,0 +1,23 @@
+Spree::CheckoutController.class_eval do
+  include Spree::Lists
+  before_action :check_newsletter
+
+  def load_order_with_lock
+    @order = current_order(lock: true)
+    @bronto_lists=current_store.bronto_lists.select{|l| l.visible && !l.subscribe_all_new_users}
+    redirect_to spree.cart_path and return unless @order
+  end
+
+  private
+  def check_newsletter
+     if params['bronto_list']
+       params['bronto_list'].each do |k,v|
+         list=Spree::BrontoList.find(k)
+         if k && v && @order.email
+           subscribe_to_list(@order.email, list)
+         end
+       end
+     end
+  end
+
+end

data/app/controllers/spree/home_controller_decorator.rb

@@ -0,0 +1,120 @@
+Spree::HomeController.class_eval do
+
+  def subscribenewsletter
+    name=params[:name] || ''
+    email=params[:email]
+    receipt=params[:receipt] || ''
+    subject=params[:subject] || 'Customer Record'
+    if receipt.length>0
+      external_key = Spree::BrontoConfiguration.account[current_store.code]["ET_simple_send"]
+      params.delete('action')
+      params.delete('receipt')
+      params.delete('authenticity_token')
+      params.delete('controller')
+      params.delete('subject')
+      params.delete('cc_receipt')
+      the_content=''
+      ks=[]
+      vs=[]
+      params.each do |k,v|
+        ks << k
+        vs << v
+      end
+      the_content = ks.join(',') + '<br/>' + vs.join(',')
+      et_a={:SENDTIME__CONTENT2 => the_content, :SENDTIME__CONTENT1 => subject}
+      #et_a={:SENDTIME__CONTENT2 => 'Name: ' + name +'<br/>Email: ' + email + '<br/>Address: ' + params[:address]  + '<br/>City: ' + params[:city] + '<br/>State: ' + params[:state]  +'<br/>Zip: ' + params[:zip]  +'<br/>Phone: ' + params[:phone]  +'<br/>Credentials: ' + params[:credentials]}
+      Delayed::Job.enqueue DelayedSimpleSend.new(current_store.code, receipt, external_key, et_a,'html')
+      cc_receipt= params[:cc_receipt] || ''
+      if cc_receipt.length>0
+        Delayed::Job.enqueue DelayedSimpleSend.new(current_store.code, cc_receipt, external_key, et_a,'html')
+      end
+    end
+    if email.length>0
+      if current_store.code == 'pwb'
+        title='Pets & Products Newsletter'
+      elsif current_store.code == 'he'
+        title='HairEssentials Products Newsletter'
+      else
+        title='Natural Products Newsletter'
+      end
+      campaign= Spree::BrontoList.find_by_title(title)
+      if !!campaign
+        Delayed::Job.enqueue DelayedSubscriberAdd.new(current_store.code, email, campaign, {:First_Name => name})
+      end
+      render :json => ({
+                 :success => true,
+                 :message => t( :subscription_sent )
+             }).to_json
+    else
+      render :json => ({
+                 :success => false,
+                 :message => t( :subscription_notsent )
+             }).to_json
+    end
+    #redirect_to "/meetexperts"
+    #render :js =>'alert("Our server temperarily busy, please try again later.")'
+
+  end
+
+  # sign up compaign flexible form, like the one for newsletter.
+  def subscribecampaign
+    name=params[:name] || ''
+    email=params[:email]
+    campaign_id=params[:campaign_id] || ''
+    if email.length>0
+      campaign=Spree::BrontoList.find_by_list_id(campaign_id)
+      if !!campaign
+        options=cookies[:campaign_options] || '{}'
+        options=Hash[JSON.parse(options).map{|(k,v)| [k.to_sym,v]}]
+        Rails.logger.info "find campaign_options cookie: #{cookies.inspect}"
+        Delayed::Job.enqueue DelayedSubscriberAdd.new(current_store.code, email, campaign, {:First_Name => name})
+      end
+
+      drop_email_key=params[:drop_email_key] || ''
+      unless drop_email_key.blank?
+        Delayed::Job.enqueue DelayedSimpleSend.new(current_store.code, email, drop_email_key, {},'html')
+      end
+      render :json => ({
+                 :success => true,
+                 :message => t( :subscription_sent )
+             }).to_json
+    else
+      render :json => ({
+                 :success => false,
+                 :message => t( :subscription_notsent )
+             }).to_json
+    end
+
+  end
+
+
+  # sign up compaign flexible form, like the one for newsletter.
+  def subscribecampaign_with_ops
+    email=params[:email]
+    campaign_id=params[:campaign_id] || ''
+    ops=params[:ops]
+    if email.length>0
+      campaign=Spree::BrontoList.find_by_list_id(campaign_id)
+      if !!campaign
+        Delayed::Job.enqueue DelayedSubscriberAdd.new(current_store.code, email, campaign,ops)
+      end
+
+      drop_email_key=params[:drop_email_key] || ''
+      unless drop_email_key.blank?
+        Delayed::Job.enqueue DelayedSimpleSend.new(current_store.code, email, drop_email_key, {},'html')
+      end
+
+      render :json => ({
+                 :success => true,
+                 :message => t( :subscription_sent )
+             }).to_json
+    else
+      render :json => ({
+                 :success => false,
+                 :message => t( :subscription_notsent )
+             }).to_json
+    end
+
+  end
+
+end

data/app/controllers/spree/lists.rb

@@ -0,0 +1,152 @@
+module Spree
+   module Lists
+     extend ActiveSupport::Concern
+
+    def autosubscribe_list(store)
+      Spree::BrontoList.where(:store_id =>store.id,:subscribe_all_new_users =>true)
+    end
+
+    def create_subscriber(user)
+      if user.is_a? String
+        order = Spree::Order.find_by_email(user, :order => "updated_at desc")
+        store= current_order.store
+        list = autosubscribe_list(store) if checkout
+      else
+        store=current_store
+        list = autosubscribe_list(store)
+      end
+
+      subscribe_to_list(user, list) unless !list
+
+      # synchronize the subscription list from bronto this customer subscribed before registration
+      unless user.is_a? String
+        begin
+          user.reload
+          bronto=Bronto.new(Spree::BrontoConfiguration.account[store.code]['bronto_token'])
+          contact=bronto.read_contacts(user.email,true)
+          list_ids=contact[:list_ids]
+          if list_ids
+            unless list_ids.class == Array
+              list_ids=[list_ids]
+            end
+            list_ids.each do |l|
+              list=Spree::BrontoList.find_by_list_id(l)
+              if !!list && (!user.bronto_lists.map(&:list_id).include? l )
+                user.exact_target_subscriber_id = contact[:id]  #seems we do not need this
+                user.bronto_lists << list
+                user.save!
+              end
+            end
+          end
+
+        rescue
+          # do nothing here at this moment
+        end
+      end
+
+    end
+
+    def subscribe_to_list(user, list)
+
+      order=current_order
+
+      pwb_cat=''
+      pwbCat = lambda{|order|
+        iscat=false
+        order.line_items.each do |item|
+          if item.variant.product.taxons.map{|t| t.id}.include?(3002)
+            iscat=true
+          end
+        end
+        if iscat
+          'cat'
+        else
+          'dog'
+        end
+      }
+      if order
+        #logger.debug 'call subscribe_to_list there is a order'
+        store=order.store
+        store_code=store.code
+        pwb_cat= (store_code=="pwb" ? pwbCat.call(order) : '')
+      else
+        store_code=current_store.code
+        pwb_cat=''
+      end
+      #logger.debug '-- found the pwb_cat: ' + pwb_cat
+      Delayed::Job.enqueue( DelayedSubscriberAdd.new(store_code, user, list, {:C_or_D => pwb_cat}), -20 )
+
+      unless user.is_a? String
+        user.bronto_lists << list
+        user.save!
+      end
+
+    end
+
+    def unsubscribe_from_list(user, list)
+
+      store = current_store
+      Delayed::Job.enqueue( DelayedSubscriberDelete.new(store.code, user, list), -20 )
+
+      unless user.is_a? String    # update  exact_target_lists
+        begin
+          list_del=user.bronto_lists.select{|l| l.id== list.id}
+          if list_del.length>0
+            user.bronto_lists.delete(list_del)
+          end
+          user.save!
+        rescue
+          #raise exception
+        end
+      end
+
+    end
+
+    #private
+    #CONTROLLER Actions
+    def get_bronto_lists
+      @bronto_lists = Spree::BrontoList.where(:visible => true)
+    end
+
+    def update_bronto_lists
+      return unless params.key? :bronto_list
+
+      unless @checkout.nil?
+        session[ :bronto_list ] = []
+      end
+
+      @user = @checkout.order.user if @user.nil? && !@checkout.nil?
+
+      params[:bronto_list].each do |id, do_subscribe|
+        do_subscribe = (do_subscribe == "true")
+        list = Spree::BrontoList.find(id)
+        if !@checkout.nil? &&  do_subscribe
+          session[ :bronto_list ] << id
+        end
+
+        if @user.nil? && !@checkout.nil? #guest checkout
+          if do_subscribe
+            #subscribe
+            subscribe_to_list(@checkout.email, list)
+          else
+            #unsubscribe
+            unsubscribe_from_list(@checkout.email, list)
+          end
+        else #normal checkout
+          if do_subscribe
+            #subscribe
+            unless @user.bronto_lists.include? list
+              subscribe_to_list(@user, list)
+            end
+          else
+            #unsubscribe
+            if @user.bronto_lists.include? list
+              unsubscribe_from_list(@user, list)
+            end
+          end
+        end
+      end
+
+    end
+  end
+end

data/app/controllers/spree/orders_controller_decorator.rb

@@ -0,0 +1,56 @@
+Spree::OrdersController.class_eval do
+  include Spree::Lists
+
+  def subscribe
+    @order = Spree::Order.find_by_number!(params[:id])
+    list = Spree::BrontoList.find( params[ :list ] )
+    unless list.nil?
+      unless @order.user.nil?
+        dest = @order.user
+      else
+        dest = @order.email
+      end
+      unless dest.nil?
+        subscribe_to_list(dest, list)
+        respond_to do |format|
+          format.html {
+            flash[:notice] = Spree.t( :subscription_sent ) unless session[ :return_to ]
+            redirect_to checkout_state_path(@order.state)
+          }
+          format.js {
+            render :json => ({
+                       :success => true,
+                       :message => Spree.t( :subscription_sent )
+                   }).to_json
+          }
+        end
+      else
+        respond_to do |format|
+          format.html {
+            flash[:error] = Spree.t( :subscription_notsent ) unless session[ :return_to ]
+            redirect_to checkout_state_path(@order.state)
+          }
+          format.js {
+            render :json => ({
+                       :success => false,
+                       :message => Spree.t( :subscription_notsent )
+                   }).to_json
+          }
+        end
+      end
+    else
+      respond_to do |format|
+        format.html {
+          flash[:error] = Spree.t( :no_such_list ) unless session[ :return_to ]
+          redirect_to checkout_state_path(@order.state)
+        }
+        format.js {
+          render :json => ({
+                     :success => false,
+                     :message => Spree.t( :no_such_list )
+                 }).to_json
+        }
+      end
+    end
+  end
+end

data/app/controllers/spree/users_controller_decorator.rb

@@ -0,0 +1,27 @@
+Spree::UsersController.class_eval do
+  include Spree::Lists
+
+  before_action :load_bronto_lists
+  before_action :check_newsletter
+
+private
+  def load_bronto_lists
+      @bronto_lists=current_store.bronto_lists
+  end
+
+  def check_newsletter
+    if params['user'] && params['user']['bronto_list_attributes']
+      params['user']['bronto_list_attributes'].each do|k,v|
+        list=Spree::BrontoList.find(k)
+        if k && @user && v=="true"
+          subscribe_to_list(@user, list)
+        end
+
+        if k && @user && v=="false"
+          unsubscribe_from_list(@user, list)
+        end
+
+      end
+    end
+  end
+end

data/app/mailers/spree/order_mailer/_order_cancel_html.html.erb

@@ -0,0 +1,4 @@
+<p>This email is to inform you that your order has been <strong>cancelled</strong> on <%= Time.now.strftime("%B %d %Y at %I:%M %p") %>.</p>
+<p>Your order number is <strong class="pink"><%= order.number %></strong> Please keep it for reference if you speak to a customer service representative.</p>
+<p>Your <%= order.store.name %> order included the following item(s):</p>
+<%= render "order_mailer/order_details_html", :order => order %>

data/app/mailers/spree/order_mailer/_order_cancel_plain.erb

@@ -0,0 +1,7 @@
+This email is to inform you that your order has been CANCELLED on <%= Time.now.strftime("%B %d %Y at %I:%M %p") %>.
+
+Your order number is <%= order.number %> Please keep it for reference if you speak to a customer service  representative.
+
+Your <%= order.store.name %> order included the following item(s):
+
+<%= render "order_mailer/order_details_plain", :order => order %>

data/app/mailers/spree/order_mailer/_order_confirm_html.html.erb

@@ -0,0 +1,5 @@
+<p>Here are the details of your order received on <%= order.completed_at.strftime("%B %d %Y at %I:%M %p") %>.</p>
+<p>Your order number is <strong class="pink"><%= order.number %></strong> Please keep it for reference if you speak to a customer service representative.</p>
+
+<p>Your <%= order.store.name %> order includes the following item(s):</p>
+<%= render "order_mailer/order_details_html", :order => order %>

data/app/mailers/spree/order_mailer/_order_confirm_plain.erb

@@ -0,0 +1,7 @@
+Here are the details of your order received on <%= order.completed_at.strftime("%B %d %Y at %I:%M %p") %>.
+
+Your order number is <%= order.number %> Please keep it for reference if you speak to a customer service  representative.
+
+Your <%= order.store.name %> order includes the following item(s):
+
+<%= render "order_mailer/order_details_plain", :order => order %>