Initial commit

Author: lucaferri

.gitignore

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

.rspec

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

Gemfile

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

LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2014 Alessandro Lepore
+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.

README.md

@@ -0,0 +1,62 @@
+SpreeNewsletterSubscription
+===========================
+
+Allow simple newsletter subscription on Spree stores.
+Uses mailchimp.
+
+Installation
+------------
+
+Add spree_newsletter_subscription to your Gemfile:
+
+```ruby
+gem 'spree_newsletter_subscription'
+```
+
+Bundle your dependencies and run the installation generator:
+
+```shell
+bundle
+bundle exec rails g spree_newsletter_subscription:install
+```
+
+Configuration
+-------------
+
+Add your credentials to `config/initializers/spree.rb`:
+
+```ruby
+SpreeNewsletterSubscription::Config.tap do |config|
+  config.api_key = {
+    default: 'xxxxxxxxxxxxx-us9',
+  }
+
+  config.list_id = {
+    default: 'xxxxxxxxx',
+    en: 'yyyyyyyy' # use a different list for locale == :en
+  }
+end
+```
+
+You can have different list ids (and even api keys) for each locale.
+If missing, default is always used.
+
+
+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_newsletter_subscription/factories'
+```
+
+Copyright (c) 2014 Alessandro Lepore, released under the New BSD License

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_newsletter_subscription'
+  Rake::Task['extension:test_app'].invoke
+end

app/assets/javascripts/spree/backend/spree_newsletter_subscription.js

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

app/assets/javascripts/spree/frontend/spree_newsletter_subscription.js

@@ -0,0 +1,5 @@
+$(function(){
+  $('form#newsletter-subscription').submit(function() {
+    $(this).addClass('submitted');
+  });
+});

app/assets/stylesheets/spree/backend/spree_newsletter_subscription.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'
+*/

app/assets/stylesheets/spree/frontend/spree_newsletter_subscription.css

@@ -0,0 +1,3 @@
+#newsletter-subscription-errors {
+  color: red;
+}

app/controllers/spree/newsletter_subscriptions_controller.rb

@@ -0,0 +1,8 @@
+module Spree
+  class NewsletterSubscriptionsController < StoreController
+    def create
+      @subscription = Spree::NewsletterSubscription.new(params[:newsletter_subscription])
+      @success = @subscription.save!
+    end
+  end
+end

app/models/spree/newsletter_subscription.rb

@@ -0,0 +1,33 @@
+module Spree
+  class NewsletterSubscription
+    extend ActiveModel::Naming
+    include ActiveModel::Conversion
+    include ActiveModel::Validations
+
+    attr_accessor :email, :terms, :locale
+
+    validates :email, presence: true
+    validates :terms, acceptance: true
+
+    def initialize(attributes = {})
+      attributes.each do |name, value|
+        send("#{name}=", value)
+      end
+    end
+
+    def save!
+      return unless valid?
+
+      result = SpreeNewsletterSubscription::MailchimpSubscriber.new(email, locale).subscribe!
+      if !result[:success] && result[:error].present?
+        errors.add(:base, result[:error])
+      end
+
+      result[:success]
+    end
+
+    def persisted?
+      false
+    end
+  end
+end

app/models/spree/user_decorator.rb

@@ -0,0 +1,17 @@
+Spree.user_class.class_eval do
+  after_save :newsletter_subscription
+
+  private
+
+  def newsletter_subscription
+    if id_changed? || subscribed_to_mailing_list_changed?
+      if subscribed_to_mailing_list
+        params = { email: email,
+                   terms: '1' }
+        Spree::NewsletterSubscription.new(params).save!
+      else
+        # TODO unsubscribe?
+      end
+    end
+  end
+end

app/views/spree/newsletter_subscriptions/create.js.erb

@@ -0,0 +1,9 @@
+$('div#newsletter-subscription-errors').remove();
+
+<% if @success %>
+  content = '<%= Spree.t(:success_html, scope: :newsletter_subscription) %>'
+  $('#newsletter-subscription.submitted').hide().html(content).fadeIn(400);
+<% else %>
+  content = '<div id="newsletter-subscription-errors"><%= raw @subscription.errors.full_messages.join("<br>") %></div>'
+  $('#newsletter-subscription.submitted').before(content);
+<% end %>

app/views/spree/shared/_newsletter_subscription.html.erb

@@ -0,0 +1,9 @@
+<%= form_for :newsletter_subscription, url: newsletter_subscriptions_path,
+             remote: true , html: { id: 'newsletter-subscription' } do |f| %>
+
+  <%= f.hidden_field :locale, value: I18n.locale %>
+  <%= f.email_field :email %>
+  <%= f.check_box :terms %>
+  <%= button_tag :submit %>
+
+<% end %>

bin/rails

@@ -0,0 +1,7 @@
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/spree_newsletter_subscription/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

config/locales/en.yml

@@ -0,0 +1,8 @@
+en:
+  activemodel:
+    attributes:
+      spree/newsletter_subscription:
+        terms: Terms and Conditions
+  spree:
+    newsletter_subscription:
+      success_html: <h3>Successfully subscribed to our newsletter</h3>

config/locales/it.yml

@@ -0,0 +1,8 @@
+it:
+  activemodel:
+    attributes:
+      spree/newsletter_subscription:
+        terms: Termini e Condizioni
+  spree:
+    newsletter_subscription:
+      success_html: <h3>Sei stato iscritto alla nostra newsletter!</h3>

config/routes.rb

@@ -0,0 +1,3 @@
+Spree::Core::Engine.routes.draw do
+  resources :newsletter_subscriptions, only: [:create]
+end

db/migrate/20141118145038_add_subscribed_to_mailing_list_to_spree_users.rb

@@ -0,0 +1,5 @@
+class AddSubscribedToMailingListToSpreeUsers < ActiveRecord::Migration
+  def change
+    add_column Spree.user_class.table_name, :subscribed_to_mailing_list, :boolean, null: false, default: false
+  end
+end

lib/generators/spree_newsletter_subscription/install/install_generator.rb

@@ -0,0 +1,31 @@
+module SpreeNewsletterSubscription
+  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_newsletter_subscription\n"
+        append_file 'vendor/assets/javascripts/spree/backend/all.js', "//= require spree/backend/spree_newsletter_subscription\n"
+      end
+
+      def add_stylesheets
+        inject_into_file 'vendor/assets/stylesheets/spree/frontend/all.css', " *= require spree/frontend/spree_newsletter_subscription\n", :before => /\*\//, :verbose => true
+        inject_into_file 'vendor/assets/stylesheets/spree/backend/all.css', " *= require spree/backend/spree_newsletter_subscription\n", :before => /\*\//, :verbose => true
+      end
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=spree_newsletter_subscription'
+      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

lib/spree_newsletter_subscription.rb

@@ -0,0 +1,2 @@
+require 'spree_core'
+require 'spree_newsletter_subscription/engine'

lib/spree_newsletter_subscription/configuration.rb

@@ -0,0 +1,10 @@
+module SpreeNewsletterSubscription
+  class Configuration < Spree::Preferences::Configuration
+    preference :api_key, :hash
+    preference :list_id, :hash
+    # preference :double_opt_in, :boolean, default: true
+    # preference :send_welcome,  :boolean, default: true
+    # preference :send_notify,   :boolean, default: true
+    # preference :merge_vars,    :string, default: ''
+  end
+end

lib/spree_newsletter_subscription/engine.rb

@@ -0,0 +1,27 @@
+module SpreeNewsletterSubscription
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'spree_newsletter_subscription'
+
+    config.autoload_paths += %W(#{config.root}/lib)
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    initializer 'spree_newsletter_subscription.environment', before: :load_config_initializers do |app|
+      SpreeNewsletterSubscription::Config = SpreeNewsletterSubscription::Configuration.new
+      Spree::PermittedAttributes.user_attributes.push :subscribed_to_mailing_list
+    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

lib/spree_newsletter_subscription/factories.rb

@@ -0,0 +1,6 @@
+FactoryGirl.define do
+  # Define your Spree extensions Factories within this file to enable applications, and other extensions to use and override them.
+  #
+  # Example adding this to your spec_helper will load these Factories for use:
+  # require 'spree_newsletter_subscription/factories'
+end

lib/spree_newsletter_subscription/mailchimp_subscriber.rb

@@ -0,0 +1,35 @@
+require 'mailchimp'
+
+module SpreeNewsletterSubscription
+  class MailchimpSubscriber
+    def initialize(email, locale = nil)
+      @email = email
+      @locale = locale
+      @list = get_config(:list_id)
+      @mailchimp = Mailchimp::API.new(get_config(:api_key))
+      @logger = Logger.new(Rails.root.join('log/newsletter_subscription.log'))
+    end
+
+    def subscribe!
+      @logger.debug("#subscribe!(#{@email})")
+      begin
+        result = @mailchimp.lists.subscribe(@list, { email: @email })
+        { success: true }
+      rescue Exception => e
+        @logger.debug(e.message)
+        { success: false, error: e.message }
+      end
+    end
+
+    private
+
+    def config
+      @config ||= SpreeNewsletterSubscription::Config
+    end
+
+    def get_config(key)
+      conf = config[key][@locale.to_sym] if @locale
+      conf ||= config[key][:default]
+    end
+  end
+end