softwear 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d715e0759e33a014c97ab25bdd01db678ab666d3
+  data.tar.gz: 66ad37169e8051c909ca91c326dba79f1fb20bb3
+SHA512:
+  metadata.gz: 4100ed66d9ea3b8c838efd51d85a33fe9c9fba334b02145e12003329d8b503c27476b7831cc8e8ba38a60ca40344a9f6a24252701cac8448e55d506c75587fb5
+  data.tar.gz: aa8d8df330bb7564b5a0203758c67024bfa62f65b644633e9f7d9a18d45769c147693c772be87c8af7e3329aeb6482ccf8ac6967075d9aa8dcdce6a852ba0083

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Stefan Gale
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Softwear'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/javascripts/softwear/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/javascripts/softwear/error_utils.js.coffee

@@ -0,0 +1,82 @@
+# Handy little module for ajax error handling!
+# Doesn't actually do the ajaxing for you; just 
+# adds and removes error content from the page.
+@ErrorHandler = (resourceName, $form, resourceId) ->
+  handler = {}
+  capitalize = (str) -> (str.charAt(0).toUpperCase() + str.substr(1)).replace('_id', '').replace('_', ' ')
+  contains = (array, thing) -> 
+    return true if entry == thing for entry in array
+    false
+  getParamName = (field) ->
+    if resourceName is null
+      field
+    else
+      if resourceId
+        "#{resourceName}[#{resourceId}][#{field}]"
+      else
+        "#{resourceName}[#{field}]"
+  findFieldElementFor = (field) ->
+    $field = $form.find("*[name^='#{getParamName(field)}']")
+    $field = $form.find("*[name^='#{getParamName(field.replace('_id', ''))}']") if $field.length == 0
+    $field = $form.find("*[name^='#{getParamName(field + '_id')}']") if $field.length == 0
+    $field
+
+  handler.errorFields = []
+
+  handler.handleErrors = (errors, modal) ->
+    handler.clear() if handler.errorFields.length > 0
+    # Add modal
+    $modal = null
+    unless modal is null
+      $modal = $(modal)
+      $('body').append $modal
+      $modal.on 'hidden.bs.modal', (e) -> $modal.remove()
+    # Mark fields
+    for field, fieldErrors of errors
+      continue if fieldErrors.length == 0
+      handler.errorFields.push(field)
+      # Grab the input field element
+      $field = findFieldElementFor field
+      
+      if $field.length == 0
+        console.log "Couldn't find field #{field} (name #{getParamName(field)})"
+        continue
+      
+      # Create the error message div
+      $errorMsgDiv = $ '<div/>',
+        class: 'error'
+        for:   getParamName(field)
+
+      # Place it before the input field
+      $field.before $errorMsgDiv
+
+      # Wrap the input field to make it red
+      $field.wrap $('<div/>', class: 'field_with_errors') unless $field.data('no-wrap')
+
+      # Populate error message div with messages
+      for error in fieldErrors
+        $errorMsgDiv.append $ '<p/>',
+          class: 'text-danger'
+          text:  "#{capitalize field} #{error}"
+
+    # Show the modal
+    $modal.modal 'show' unless $modal is null
+
+  handler.clear = () ->
+    for field in handler.errorFields
+      $field = findFieldElementFor field
+      $errorMsgDiv = $form.find(".error[for='#{getParamName(field)}']")
+      $errorMsgDiv.remove()
+      $field.unwrap() if $field.parent().hasClass('field_with_errors') and not $field.data('no-wrap')
+    handler.errorFields = []
+
+  return handler
+
+@errorHandlerFrom = (element, resourceName, $form, resourceId) ->
+  $element = $(element)
+  handler = $element.data 'error-handler'
+  if handler is undefined
+    handler = ErrorHandler(resourceName, $form, resourceId)
+    $element.data 'error-handler', handler
+
+  handler

data/app/assets/javascripts/softwear/modals.js.coffee

@@ -0,0 +1,171 @@
+$(document).ready ->
+  $contentModal = $('#contentModal')
+
+  $contentModal.DEFAULTS
+
+  storeClassFor = ($elem) ->
+    $elem.data 'original-class', $elem.attr('class')
+  retrieveClassFor = ($elem) ->
+    unless typeof $elem.data('original-class') is 'undefined'
+      $elem.attr 'class', $elem.data('original-class')
+
+  storeClassFor $contentModal
+  $('#contentModal *').each (index) ->
+    storeClassFor $(this)
+
+  # When the content modal is closed, clean up any alterations
+  # to classes/content.
+  $contentModal.on 'hidden.bs.modal', ->
+    retrieveClassFor $contentModal
+    $('#contentModal *').each ->
+      retrieveClassFor $(this)
+    $contentModal.find('.modal-content-area').empty()
+    $contentModal.data 'open', false
+
+  $contentModal.on 'show.bs.modal', ->
+    $contentModal.data 'open', true
+
+##
+# Quick and easy way to show the content modal!
+#
+# Valid options include: 'title', 'body', 'footer', and 'force'
+#
+# Example (in coffeescript):
+# ===============================
+# setupContentModal ($contentModal) ->
+#   $contentModal.find('.modal-dialog').addClass 'modal-lg'
+# showContentModal
+#   title: $('<strong>Test Content Modal!</strong>')
+#   body: "This is a large modal! These options allow strings or jQueries."
+#   footer: $('<button data-dismiss="modal">Close</button>')
+#   backdrop: 'static'
+# ===============================
+#
+# TODO backdrop is permanent until new page/reload - fix that.
+#
+# Calling setupContentModal is not neccessary if you are fine
+# with the default look of the contentModal. However, if you
+# want to add classes to the modal's innards, I recommend you
+# make those adjustments within setupContentModal to avoid
+# potential conflicts if the modal is already open.
+#
+# By default, calling showContentModal will close the content
+# modal if it is already open. If for some reason you don't
+# want that to happen, you can also pass force: false.
+##
+@setupContentModal = (setupFunc) ->
+  $contentModal = $('#contentModal')
+  wasOpen = false
+  doSetup = ->
+    $contentModal.off 'hidden.bs.modal', doSetup if wasOpen
+    setupFunc($contentModal)
+
+  if $contentModal.data('open')
+    wasOpen = true
+    $contentModal.on 'hidden.bs.modal', doSetup
+  else
+    doSetup()
+
+@showContentModal = (options) ->
+  options.force = true unless options.force is false
+  $contentModal = $('#contentModal')
+
+  wasOpen = false
+  showIt = ->
+    $contentModal.off 'hidden.bs.modal', showIt if wasOpen
+    setSection = ($section, option) ->
+      if typeof option is 'string'
+        $section.text option
+      else
+        $section.append option
+
+    setSection $('#contentTitle'),  options.title
+    setSection $('#contentBody'),   options.body
+    setSection $('#contentFooter'), options.footer
+
+    options.title = null
+    options.body = null
+    options.footer = null
+
+    $contentModal.modal options
+    options.then($contentModal) if options.then
+
+  if $contentModal.data('open')
+    if options.force is true
+      wasOpen = true
+      $contentModal.on 'hidden.bs.modal', showIt
+      $contentModal.modal 'hide'
+  else
+    showIt()
+
+@hideContentModal = -> $('#contentModal').modal 'hide'
+
+# Call this to invoke an error modal, sort of like alert
+# body parameter is optional, title will default to "Error"
+@errorModal = (body, options) ->
+  options = {} unless typeof options is 'object'
+
+  options.title ||= 'Error'
+  options.body ||= body
+  options.footer ||= $('<button class="btn btn-danger" data-dismiss="modal">OK</button>')
+
+  setupContentModal ($contentModal) ->
+    $contentModal.find('.modal-content').addClass 'modal-content-error'
+    $contentModal.find('.modal-body').addClass 'centered'
+  showContentModal options
+
+# Opens a modal that looks just like the flash modal when
+# the flash contains a success message.
+@successModal = (titleOrBody, body, setup) ->
+  title =
+    if body
+      titleOrBody
+    else
+      body = titleOrBody
+      "Success"
+
+  setupContentModal ($contentModal) ->
+    $contentModal.find('.modal-content').addClass 'modal-content-success'
+    $contentModal.find('.modal-body').addClass 'centered'
+    setup($contentModal) if setup
+  showContentModal
+    title: title
+    body: body
+    footer: $("<button class='btn btn-default' data-dismiss='modal'>OK</button>")
+
+# Modal alternative to confirm() except you pass a function
+# rather than call as a conditional.
+#
+# With the callback, you can either pass a parameterless
+# function that will only be called when 'confirm' is clicked,
+# or a single-parameter function where the parameter will
+# be true or false depending on the user's response.
+@confirmModal = (question, callback) ->
+  $modal = $('#contentModal')
+
+  $yesBtn = $ '<a class="btn btn-primary" id="modal-confirm-btn">Confirm</a>'
+  $noBtn  = $ '<a class="btn btn-default" id="modal-cancel-btn">Cancel</a>'
+
+  $footer = $('#contentFooter')
+  $footer.children().remove()
+  $footer.append $yesBtn
+  $footer.append $noBtn
+
+  $yesBtn.click ->
+    $modal.modal 'hide'
+    if callback.length is 0
+      callback()
+    else
+      callback(true)
+  $noBtn.click ->
+    $modal.modal 'hide'
+    if callback.length >= 1
+      callback(false)
+
+  setupContentModal ($contentModal) ->
+    $contentModal.find('.modal-dialog').addClass 'modal-sm'
+    $contentModal.find('.modal-body').addClass 'centered'
+  showContentModal
+    title: 'Confirm'
+    body: question
+    footer: $footer

data/app/assets/stylesheets/softwear/application.css

@@ -0,0 +1,33 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */
+
+.full-content-center{
+  width: 100%;
+  max-width: 500px;
+  margin: 5% auto;
+  text-align: center;
+}
+
+.box-info{
+        position:relative;
+        padding: 15px;
+        background: #fff;
+        color: #5b5b5b;
+        margin-bottom: 20px;
+        -webkit-transition:All 0.4s ease;
+        -moz-transition:All 0.4s ease;
+        -o-transition:All 0.4s ease;
+}

data/app/controllers/softwear/application_controller.rb

@@ -0,0 +1,4 @@
+module Softwear
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/softwear/error_reports_controller.rb

@@ -0,0 +1,37 @@
+module Softwear
+  class ErrorReportsController < ApplicationController
+    skip_before_filter :authenticate_user!
+
+    helper Softwear::Engine.helpers do
+      def method_missing(name, *args, &block)
+        if main_app.respond_to?(name)   
+          main_app.send(name, *args, &block)
+        else                   
+          super                
+        end                    
+      end
+    end
+
+    def email_report
+      if current_user
+        user = current_user
+      else
+        begin
+          user = User.find(params[:user_id]) unless params[:user_id].blank?
+        rescue StandardError => _e
+        end
+      end
+
+      ErrorReportMailer.send_report(user, params).deliver
+      flash[:success] = 'Sent error report. Sorry about that.'
+
+      if user
+        redirect_to '/'
+      elsif params[:order_id] && (key = Order.where(id: params[:order_id]).pluck(:customer_key).first)
+        redirect_to customer_order_path(key)
+      else
+        render inline: "<%= flash[:success] %>"
+      end
+    end
+  end
+end

data/app/helpers/softwear/application_helper.rb

@@ -0,0 +1,4 @@
+module Softwear
+  module ApplicationHelper
+  end
+end

data/app/helpers/softwear/emails_helper.rb

@@ -0,0 +1,9 @@
+module Softwear
+  module EmailsHelper
+    def backtrace_is_from_app?(line)
+      !(line.include?('/gems/') || /^kernel\// =~ line || line.include?('/vendor_ruby/'))
+    end
+
+    extend self
+  end
+end

data/app/mailers/error_report_mailer.rb

@@ -0,0 +1,53 @@
+class ErrorReportMailer < ActionMailer::Base
+  default to: 'devteam@annarbortees.com'
+
+  def send_report(user, params)
+    @order = Order.find_by(id: params[:order_id])
+    @user  = user || User.find_by(id: params[:user_id])
+
+    if @user.nil?
+      from_customer = true
+
+      if @order.nil?
+        @user = OpenStruct.new(
+          email:     'unknown-user@annarbortees.com',
+          full_name: 'Unknown Customer'
+        )
+      else
+        @user = OpenStruct.new(
+          email:     @order.email,
+          full_name: "(Customer) #{@order.full_name}"
+        )
+      end
+    end
+
+    @error_class     = params[:error_class]
+    @error_message   = params[:error_message]
+    @backtrace       = params[:backtrace]
+    @user_message    = params[:user_message]
+    @additional_info = params[:additional_info]
+
+    mail(
+      from:     from_customer ? 'customer-report@softwearcrm.com' : @user.email,
+      reply_to: @user.email,
+      to:       'devteam@annarbortees.com',
+      subject:  "Softwear CRM Error Report From #{@user.full_name}"
+    )
+  end
+
+  def auth_server_down(at)
+    mail(
+      from:    'noreply@softwearcrm.com',
+      subject: 'Authentication server is down!',
+      body:    at.strftime("Lost contact on %m/%d/%Y at %I:%M%p. We're running on cache!")
+    )
+  end
+
+  def auth_server_up(at)
+    mail(
+      from:    'noreply@softwearcrm.com',
+      subject: 'Authentication server back up!',
+      body:    at.strftime("Just got a response at %I:%M%p")
+    )
+  end
+end

data/app/views/error_report_mailer/send_report.html.erb

@@ -0,0 +1,30 @@
+<h1> <%= @user.full_name %>'s report: </h1>
+<div>
+  <%= @user.email %>:
+</div>
+<p> <%= @user_message %> </p>
+<h1> Error details: </h1>
+<div>
+  <%= @error_class %>: <%= @error_message %>
+</div>
+<div>
+  <h4>Additional information:</h4>
+  <ul>
+    <% @additional_info.split("|||").each do |info| %>
+      <li><%= info %></li>
+    <% end %>
+  </ul>
+</div>
+<div>
+  <ul>
+    <% @backtrace.split("\n").each do |line| %>
+      <li>
+        <% if Softwear::EmailsHelper.backtrace_is_from_app?(line) %>
+          <strong><%= line %></strong><br />
+        <% else %>
+          <%= line %><br />
+        <% end %>
+      </li>
+    <% end %>
+  </ul>
+</div>

data/app/views/layouts/softwear/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Softwear</title>
+  <%= stylesheet_link_tag    "softwear/application", media: "all" %>
+  <%= javascript_include_tag "softwear/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/softwear/errors/_error.html.erb

@@ -0,0 +1,35 @@
+<div>
+  Fortunately, a report of this error can be sent to the dev team.
+</div>
+
+<% if current_user || !Rails.env.production? %>
+  <div>
+    <%= link_to 'Show error details', '#', id: 'show-error-details-btn', onclick: '$("#error-details").toggle(); return false;', class: 'btn btn-info' %>
+    <div id='error-details' style='<%= "display: none;" if Rails.env.production? %>'>
+      <p><%= error.class.name %>: <%= error.message %></p>
+      <% error.backtrace.each do |line| %>
+        <% if backtrace_is_from_app?(line) %>
+          <strong><%= line %></strong><br />
+        <% else %>
+          <%= line %><br />
+        <% end %>
+      <% end %>
+    </div>
+  </div>
+<% end %>
+
+<%= form_tag softwear.error_report_path, method: :post do %>
+  <%= hidden_field_tag 'error_class', error.class.name %>
+  <%= hidden_field_tag 'error_message', error.message %>
+  <%= hidden_field_tag 'backtrace', error.backtrace.join("\n") %>
+  <%= hidden_field_tag 'user_id', current_user.try(:id) %>
+  <%= hidden_field_tag 'additional_info', additional_info %>
+  <%= hidden_field_tag 'order_id', @order.try(:id) %>
+
+  <div class='form-group'>
+    <%= label_tag 'user_message', 'Describe how you reached this error.' %>
+    <%= text_area_tag 'user_message', '', class: 'form-control' %>
+  </div>
+
+  <%= submit_tag 'Send', class: 'btn btn-info' %>
+<% end %>

data/app/views/softwear/errors/internal_server_error.html.erb

@@ -0,0 +1,6 @@
+<div class="full-content-center animated fadeInDownBig">
+  <div class='box-info'>
+    <h2 class='text-center'>You have encountered an error!</h2>
+    <%= render 'softwear/errors/error', error: @error, additional_info: @additional_info %>
+  </div>
+</div>

data/app/views/softwear/errors/internal_server_error.js.erb

@@ -0,0 +1,10 @@
+<% if current_user %>
+setupContentModal(function(modal) {
+  modal.find('.modal-content').addClass('modal-content-error');
+  modal.find('.modal-body').addClass('centered');
+});
+showContentModal({
+  title: 'You have encountered an error!',
+  body: $("<%=j render 'softwear/errors/error', error: @error, additional_info: @additional_info %>")
+});
+<% end %>

data/bin/rails

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 4 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/softwear/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 'rails/all'
+require 'rails/engine/commands'

data/config/routes.rb

@@ -0,0 +1,3 @@
+Softwear::Engine.routes.draw do
+  post '/error-report', to: 'error_reports#email_report'
+end

data/lib/softwear/auth/belongs_to_user.rb

@@ -0,0 +1,43 @@
+module Softwear
+  module Auth
+    module BelongsToUser
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        def belongs_to_user_called(name, options = {})
+          foreign_key = "#{name}_id"
+
+          # Create an anonymous module and include it, so that we can
+          # override the generated association methods and call `super`
+          # in the method body.
+          association_methods = Module.new
+          association_methods.module_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def #{name}
+              @#{name} ||= User.find(#{name}_id)
+            end
+
+            def #{name}=(new)
+              self.#{foreign_key} = new.id
+              @#{name} = new
+            end
+          RUBY
+
+          self.user_associations ||= []
+          user_associations << name.to_sym
+
+          send(:include, association_methods)
+        end
+
+        def belongs_to_user
+          belongs_to_user_called(:user)
+        end
+      end
+
+      included do
+        extend ClassMethods
+
+        cattr_accessor :user_associations
+      end
+    end
+  end
+end