workarea-share 1.2.4

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

@@ -0,0 +1,42 @@
+module Workarea
+  module Storefront
+    class SharesController < Storefront::ApplicationController
+      before_action :find_share
+
+      def new
+      end
+
+      def create
+        if verify_recaptcha(model: @share, env: Rails.env) && @share.save
+          flash[:success] = t(
+            'workarea.storefront.flash_messages.share_message_sent',
+            recipient: @share.friendly_to
+          )
+          ShareMailer.share(@share.id.to_s).deliver_later
+          redirect_to @share.url
+        else
+          render :new
+        end
+      end
+
+      private
+
+      def find_share
+        model = Email::Share.new(share_params)
+        @share = ShareViewModel.wrap(model, view_model_options)
+      end
+
+      def share_params
+        params.permit(
+          :url,
+          :title,
+          :to_email,
+          :to_name,
+          :from_email,
+          :from_name,
+          :message
+        )
+      end
+    end
+  end
+end

data/app/helpers/workarea/storefront/shares_helper.rb

@@ -0,0 +1,39 @@
+module Workarea
+  module Storefront
+    module SharesHelper
+      def share_product_url(product, options = {})
+        product_url(product, options.merge(host: Workarea.config.host))
+      end
+
+      def facebook_query_string(url)
+        hash_without_blanks_to_query(u: url)
+      end
+
+      def twitter_query_string(url, message = nil)
+        hash_without_blanks_to_query(url: url, text: message)
+      end
+
+      def share_query_string(url, message = nil, image = nil)
+        hash_without_blanks_to_query(
+          url: url,
+          description: message,
+          media: image
+        )
+      end
+
+      def share_analytics_data(type, url)
+        {
+          event: 'share',
+          domEvent: 'click',
+          payload: { type: type, url: url }
+        }
+      end
+
+      private
+
+      def hash_without_blanks_to_query(hash)
+        hash.delete_if { |_k, v| v.blank? }.to_query
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Workarea
+  module Storefront
+    class ShareMailer < ApplicationMailer
+      def share(id)
+        @share = ShareViewModel.wrap(Email::Share.find(id))
+        @content = Content::Email.find_content('share')
+
+        mail(
+          to: @share.to,
+          from: Workarea.config.email_from,
+          reply_to: @share.from,
+          subject: t('workarea.storefront.email.share.subject', from: @share.friendly_from)
+        )
+      end
+    end
+  end
+end

data/app/models/workarea/email/share.rb

@@ -0,0 +1,39 @@
+module Workarea
+  class Email::Share
+    include ApplicationDocument
+
+    field :to_name, type: String
+    field :to_email, type: String
+    field :from_name, type: String
+    field :from_email, type: String
+    field :message, type: String
+    field :title, type: String
+    field :url, type: String
+
+    validates :to_email, presence: true, email: true
+    validates :from_email, presence: true, email: true
+    validates :message, length: {
+      maximum: Workarea.config.max_email_share_message_length
+    }
+    validates :url, presence: true
+
+    after_initialize :sanitize_url
+    before_validation :sanitize_url
+
+    private
+
+    def uri
+      URI.parse(url)
+    end
+
+    def sanitize_url
+      return unless url.present?
+      self.url =
+        if uri.query.present?
+          [uri.path, uri.query].join('?')
+        else
+          uri.path
+        end
+    end
+  end
+end

data/app/seeds/shares_seeds.rb

@@ -0,0 +1,22 @@
+module Workarea
+  class SharesSeeds
+    def perform
+      puts 'Adding email shares...'
+
+      product = Catalog::Product.sample
+
+      Email::Share.create!(
+        to_name: Faker::Name.name,
+        to_email: Faker::Internet.email,
+        from_name: Faker::Name.name,
+        from_email: Faker::Internet.email,
+        message: Faker::Lorem.sentence,
+        title: product.name,
+        url: "/products/#{product.to_param}"
+      )
+
+      puts 'Adding content emails for product sharing...'
+      Content::Email.create!(type: 'share', content: "You've Got a Message!")
+    end
+  end
+end

data/app/view_models/workarea/storefront/share_view_model.rb

@@ -0,0 +1,43 @@
+module Workarea
+  class Storefront::ShareViewModel < ApplicationViewModel
+    def to
+      if to_name.present?
+        "#{to_name} <#{to_email}>"
+      else
+        to_email
+      end
+    end
+
+    def from
+      if from_name.present?
+        "#{from_name} <#{from_email}>"
+      else
+        from_email
+      end
+    end
+
+    def from_name
+      model.from_name || options[:user].try(:name)
+    end
+
+    def from_email
+      model.from_email || options[:user].try(:email)
+    end
+
+    def friendly_from
+      if from_name.blank?
+        from_email
+      else
+        from_name
+      end
+    end
+
+    def friendly_to
+      if to_name.present?
+        "#{to_name} (#{to_email})"
+      else
+        to_email
+      end
+    end
+  end
+end

data/app/views/workarea/storefront/pages/_shares_robots.text

@@ -0,0 +1 @@
+Disallow: /share

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

@@ -0,0 +1 @@
+= render 'workarea/storefront/shares/share_buttons', share_url: share_product_url(product, sku: product.options[:sku]), image: product_image_url(product.primary_image, :detail), message: t('workarea.storefront.products.share_message', title: product.browser_title, site: Workarea.config.site_name)

data/app/views/workarea/storefront/share_mailer/share.html.haml

@@ -0,0 +1,21 @@
+= append_partials('storefront.share_mailer.top')
+
+- content_for :preheader_text do
+  = @content
+
+%tr
+  %td
+    %h1= @content
+    %p
+      %strong= @share.from
+    %p= t('workarea.storefront.email.share.from_info_html')
+
+    %p= link_to @share.title, path_to_url(@share.url)
+
+    - if @share.message.present?
+      %p 
+        %strong #{@share.from} #{t('workarea.storefront.email.share.from_message_html')}
+      %p= @share.message
+
+
+= append_partials('storefront.share_mailer.bottom')

data/app/views/workarea/storefront/shares/_share_buttons.html.haml

@@ -0,0 +1,16 @@
+- if share_url.present?
+  %ul.share-buttons
+    - if share_url.present?
+      %li.share-buttons__item
+        = link_to "https://www.facebook.com/sharer/sharer.php?#{facebook_query_string(share_url)}", class: 'share-buttons__button', title: t('workarea.storefront.shares.share_on_facebook'), target: '_blank', data: { popup_button: '', analytics: share_analytics_data('facebook', share_url).to_json } do
+          = inline_svg('workarea/storefront/icons/facebook.svg', class: 'svg-icon svg-icon--blue')
+      %li.share-buttons__item
+        = link_to "https://twitter.com/intent/tweet?#{twitter_query_string(share_url, message)}", class: 'share-buttons__button', title: t('workarea.storefront.shares.share_on_twitter'), target: '_blank', data: { popup_button: '', analytics: share_analytics_data('twitter', share_url).to_json } do
+          = inline_svg('workarea/storefront/icons/twitter.svg', class: 'svg-icon svg-icon--blue')
+      %li.share-buttons__item
+        = link_to "https://pinterest.com/pin/create/button/?#{share_query_string(share_url, message, local_assigns[:image])}", class: 'share-buttons__button', title: t('workarea.storefront.shares.share_on_pinterest'), target: '_blank', data: { popup_button: '', analytics: share_analytics_data('pinterest', share_url).to_json } do
+          = inline_svg('workarea/storefront/icons/pinterest.svg', class: 'svg-icon svg-icon--blue')
+    - if message.present?
+      %li.share-buttons__item
+        = link_to new_share_path(url: share_url, title: message), class: 'share-buttons__button', rel: 'nofollow', title: t('workarea.storefront.shares.share_by_email'), data: { dialog_button: '', analytics: share_analytics_data('email', share_url).to_json } do
+          = inline_svg('workarea/storefront/share/icons/email.svg', class: 'svg-icon svg-icon--blue')

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

@@ -0,0 +1,50 @@
+- @title = t('workarea.storefront.shares.share_by_email')
+
+.view
+  %h1= t('workarea.storefront.shares.share_by_email')
+  - if @share.errors.any?
+    - @share.errors.full_messages.each do |message|
+      = render_message 'error', message, data: { analytics: validation_error_analytics_data('share').to_json }
+
+  = form_tag shares_path, method: 'post', id: 'email_friend_form' do
+    = hidden_field_tag 'title', @share.title
+    = hidden_field_tag 'url', @share.url
+
+    %fieldset
+      %legend
+        %span.heading.heading--2= t('workarea.storefront.shares.from')
+      .property-group
+        .property
+          = label_tag 'from_name', nil, class: 'property__name' do
+            %span.property__text= t('workarea.storefront.shares.name')
+            %span.property__requirement.property__requirement--optional= t('workarea.storefront.forms.optional')
+          .value= text_field_tag 'from_name', @share.from_name, class: 'text-box', placeholder: t('workarea.storefront.shares.from_name_placeholder')
+        .property
+          = label_tag 'from_email', nil, class: 'property__name' do
+            %span.property__text= t('workarea.storefront.shares.email')
+          .value= email_field_tag 'from_email', @share.from_email, class: 'text-box', required: true, autocapitalize: 'off', autocorrect: 'off', placeholder: t('workarea.storefront.shares.from_email_placeholder')
+
+    %fieldset
+      %legend
+        %span.heading.heading--2= t('workarea.storefront.shares.to')
+      .property-group
+        .property
+          = label_tag 'to_name', nil, class: 'property__name' do
+            %span.property__text= t('workarea.storefront.shares.name')
+            %span.property__requirement.property__requirement--optional= t('workarea.storefront.forms.optional')
+          .value= text_field_tag 'to_name', @share.to_name, class: 'text-box', placeholder: t('workarea.storefront.shares.to_name_placeholder')
+        .property
+          = label_tag 'to_email', nil, class: 'property__name' do
+            %span.property__text= t('workarea.storefront.shares.email')
+          .value= email_field_tag 'to_email', @share.to_email, class: 'text-box', required: true, autocapitalize: 'off', autocorrect: 'off', placeholder: t('workarea.storefront.shares.to_email_placeholder')
+    .property
+      = label_tag 'message', nil, class: 'property__name' do
+        %span.property__text= t('workarea.storefront.shares.message')
+        %span.property__requirement.property__requirement--optional= t('workarea.storefront.forms.optional')
+      .value= text_area_tag 'message', @share.message, class: 'text-box text-box--multi-line text-box--wide', placeholder: t('workarea.storefront.shares.message_placeholder'), maxlength: Workarea.config.max_email_share_message_length
+
+    .property= recaptcha_tags
+
+    .grid.grid--auto
+      %p.grid__cell= button_tag t('workarea.storefront.forms.send'), value: 'email_friend', class: 'button'
+      %p.grid__cell= link_to t('workarea.storefront.forms.cancel'), @share.url, class: 'text-button', data: { dialog_close_button: '' }

data/app/views/workarea/storefront/style_guides/components/_share_buttons.html.haml

@@ -0,0 +1,14 @@
+#share-buttons.style-guide__subsection
+
+  %h3= link_to_style_guide('components', 'share_buttons')
+
+  %p Displays a list of sharing links as a row of icons that reflow to fit the container width.
+
+  %p Link actions progressively enhanced by the <code>WORKAREA.popupButtons</code> module.
+
+  .style-guide__example-block
+    %ul.share-buttons
+      %li.share-buttons__item= link_to 'Share on Facebook', 'https://www.facebook.com/sharer/sharer.php', class: 'share-buttons__button icon icon--facebook', title: 'Share on Facebook', target: '_blank', data: { popup_button: '' }
+      %li.share-buttons__item= link_to 'Tweet on Twitter', 'https://twitter.com/intent/tweet', class: 'share-buttons__button icon icon--twitter', title: 'Tweet on Twitter', target: '_blank', data: { popup_button: '' }
+      %li.share-buttons__item= link_to 'Pin It on Pinterest', 'https://pinterest.com/pin/create/button/', class: 'share-buttons__button icon icon--pinterest', title: 'Pin It on Pinterest', target: '_blank', data: { popup_button: '' }
+      %li.share-buttons__item= link_to 'Share by Email', new_share_url(url: root_url, title: 'This is the message.'), class: 'share-buttons__button icon icon--envelope', rel: 'nofollow', title: 'Share by Email', data: { dialog_button: '' }

data/bin/rails

@@ -0,0 +1,17 @@
+#!/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/share/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_mailer/railtie'
+require 'sprockets/railtie'
+require 'rails/test_unit/railtie'
+
+require 'rails/engine/commands'

data/config/initializers/appends.rb

@@ -0,0 +1,14 @@
+Workarea.append_partials(
+  'storefront.product_details',
+  'workarea/storefront/products/share'
+)
+
+Workarea.append_partials(
+  'storefront.robots_txt',
+  'workarea/storefront/pages/shares_robots'
+)
+
+Workarea.append_stylesheets(
+  'storefront.components',
+  'workarea/storefront/share/components/share_buttons'
+)

data/config/initializers/configuration.rb

@@ -0,0 +1,6 @@
+Workarea.config.seeds.push('Workarea::SharesSeeds')
+
+# The maximum message length (in characters) that an email share
+# can contain. Used in +Workarea::Email::Share+ and the 'Share by
+# Email' form in +app/views/workarea/storefront/shares/new+.
+Workarea.config.max_email_share_message_length = 2000

data/config/initializers/rack_attack.rb

@@ -0,0 +1,10 @@
+class Rack::Attack
+  # Throttle POST requests to /shares by IP Address
+  #
+  # Key: "rack::attack:#{Time.now.to_i/:period}:shares/ip:#{req.ip}"
+  throttle('shares/ip', limit: 6, period: 60.seconds) do |request|
+    if request.path == '/shares' && request.post?
+      request.ip
+    end
+  end
+end

data/config/initializers/recaptcha.rb

@@ -0,0 +1,9 @@
+if Rails.application.secrets.recaptcha.present?
+  recaptcha = Rails.application.secrets.recaptcha.symbolize_keys
+
+  Recaptcha.configure do |config|
+    config.site_key = recaptcha[:site_key]
+    config.secret_key = recaptcha[:secret_key]
+    config.proxy = recaptcha[:proxy] if recaptcha[:proxy].present?
+  end
+end

data/config/locales/en.yml

@@ -0,0 +1,30 @@
+en:
+  workarea:
+    storefront:
+      email:
+        share:
+          subject: A Message from %{from}
+          from_info_html: thought you might be interested in this.
+          from_info_text: thought you might be interested in this.
+          from_message_html: says
+          from_message_text: says
+      flash_messages:
+        share_message_sent: Thanks for sharing! An email has been sent to %{recipient}.
+      products:
+        share_message: Check out %{title} from %{site}
+      shares:
+        share_on_facebook: Share on Facebook
+        share_on_twitter: Tweet on Twitter
+        share_on_pinterest: Pin it on Pinterest
+        share_by_email: Share by Email
+        from: From
+        to: To
+        name: Name
+        email: Email
+        from_name_placeholder: Your Name
+        from_email_placeholder: Your Email
+        to_name_placeholder: Friend's Name
+        to_email_placeholder: Friend's Email
+        message: Message
+        message_placeholder: Add a personal message
+        send_email: Send Email

data/config/routes.rb

@@ -0,0 +1,5 @@
+Workarea::Storefront::Engine.routes.draw do
+  scope '(:locale)', constraints: Workarea::I18n.routes_constraint do
+    resources :shares, only: [:new, :create]
+  end
+end

data/lib/tasks/share_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :share do
+#   # Task goes here
+# end

data/lib/workarea/mailer_previews/storefront/share_mailer_preview.rb

@@ -0,0 +1,10 @@
+module Workarea
+  module Storefront
+    class ShareMailerPreview < ActionMailer::Preview
+      def share
+        share = Email::Share.first
+        ShareMailer.share(share.id)
+      end
+    end
+  end
+end