cmor_contact 0.0.1.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bd3e49ab47604a45fe4cb0f00be068df69227366bd31c385fbf077dd900f7149
+  data.tar.gz: d7caba59cf0a2466bedbda67cd6bd4481d44f2980d6b434fe76e23aac99762e9
+SHA512:
+  metadata.gz: c900d3e78299ee87150cfd62ba8048cabdb5b04da36ea96807df20c9be6aed00dee07bc3a2f185eeed7246b678e7277adb4765c01ea6d26e229baa3ac62b2b21
+  data.tar.gz: 9cfb94b37103c387e77438ba7a0e6d53d1e2c390f13d351ea731e34842b27a8ac944d8ff1104b4e2304695b21f9cba7c465756342d2f0250a53ca2cfbad89d74

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Roberto Vasquez Angel
+
+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/README.md

@@ -0,0 +1,32 @@
+# Cmor::Contact
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cmor_contact'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install cmor_contact
+```
+
+## Configuration
+
+You can use the environment variable CMOR_CONTACT_RECIPIENTS to override the recipients in config/initializers/cmor_contact.rb
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,19 @@
+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    = 'Cmor::Contact'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rails/dummy/tasks'

data/app/assets/config/cmor_contact_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/cmor/contact .js
+//= link_directory ../stylesheets/cmor/contact .css

data/app/assets/javascripts/cmor/contact/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. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree ./application

data/app/assets/stylesheets/cmor/contact/application.css

@@ -0,0 +1,15 @@
+/*
+ * 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 other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree ./application
+ *= require_self
+ */

data/app/controllers/cmor/contact/application_controller.rb

@@ -0,0 +1,7 @@
+module Cmor
+  module Contact
+    class ApplicationController < ActionController::Base
+      protect_from_forgery with: :exception
+    end
+  end
+end

data/app/controllers/cmor/contact/contact_requests_controller.rb

@@ -0,0 +1,57 @@
+module Cmor
+  module Contact
+    class ContactRequestsController < Cmor::Contact::Configuration.base_controller.constantize
+      before_action :initialize_resource, only: [:index, :new]
+      before_action :initialize_resource_for_create, only: [:create]
+
+      respond_to :html
+      responders :flash
+
+      def self.resource_class
+        Cmor::Contact::ContactRequest
+      end
+
+      def index
+        new
+        render :new
+      end
+
+      def new; end
+
+      def create
+        @resource.ip_address = request.remote_ip
+        if @resource.save
+          respond_with @resource, location: after_create_url
+        else
+          respond_with @resource
+        end
+      end
+
+      private
+
+      def initialize_resource_for_create
+        @resource = initialize_scope.new(permitted_params)
+      end
+
+      def initialize_resource
+        @resource = initialize_scope.new
+      end
+
+      def initialize_scope
+        resource_class
+      end
+
+      def resource_class
+        self.class.resource_class
+      end
+
+      def permitted_params
+        params.require(:contact_request).permit(:nickname, :name, :email, :phone, :message, :accept_terms_of_service)
+      end
+
+      def after_create_url
+        Cmor::Contact::Configuration.after_create_url.call(self)
+      end
+    end
+  end
+end

data/app/helpers/cmor/contact/application_helper.rb

@@ -0,0 +1,6 @@
+module Cmor
+  module Contact
+    module ApplicationHelper
+    end
+  end
+end

data/app/jobs/cmor/contact/application_job.rb

@@ -0,0 +1,6 @@
+module Cmor
+  module Contact
+    class ApplicationJob < ActiveJob::Base
+    end
+  end
+end

data/app/jobs/cmor/contact/notify_new_contact_request_job.rb

@@ -0,0 +1,25 @@
+module Cmor::Contact
+  class NotifyNewContactRequestJob < ApplicationJob
+    queue_as :contact_requests
+
+    def perform(contact_request_id)
+      load_contact_request(contact_request_id)
+      deliver
+      mark_as_notified
+    end
+
+    private
+
+    def load_contact_request(id)
+      @contact_request = ContactRequest.find(id)
+    end
+
+    def deliver
+      ContactRequestMailer.notify(@contact_request).deliver_now
+    end
+
+    def mark_as_notified
+      @contact_request.update(notified_at: Time.zone.now)
+    end
+  end
+end

data/app/mailers/cmor/contact/application_mailer.rb

@@ -0,0 +1,8 @@
+module Cmor
+  module Contact
+    class ApplicationMailer < ActionMailer::Base
+      default from: 'from@example.com'
+      layout 'mailer'
+    end
+  end
+end

data/app/mailers/cmor/contact/contact_request_mailer.rb

@@ -0,0 +1,31 @@
+module Cmor::Contact
+  class ContactRequestMailer < ApplicationMailer
+
+    # Subject can be set in your I18n file at config/locales/en.yml
+    # with the following lookup:
+    #
+    #   en.contact_request_mailer.notify.subject
+    #
+    def notify(contact_request)
+      @contact_request = contact_request
+
+      mail to: notification_recipients,
+           from: notification_sender(contact_request),
+           subject: notification_subject
+    end
+
+    private
+
+    def notification_subject
+      default_i18n_subject(application_name: Rails.application.class.to_s.split('::').first.underscore.humanize.titleize)
+    end
+
+    def notification_sender(contact_request)
+      "#{contact_request.name} <#{contact_request.email}>"
+    end
+
+    def notification_recipients
+      ENV.fetch('CMOR_CONTACT_RECIPIENTS') { Cmor::Contact::Configuration.recipients[Rails.env] }
+    end
+  end
+end

data/app/models/cmor/contact/application_record.rb

@@ -0,0 +1,7 @@
+module Cmor
+  module Contact
+    class ApplicationRecord < ActiveRecord::Base
+      self.abstract_class = true
+    end
+  end
+end

data/app/models/cmor/contact/contact_request.rb

@@ -0,0 +1,36 @@
+module Cmor::Contact
+  class ContactRequest < ApplicationRecord
+    validates :name, presence: true
+    validates :email, presence: true
+    validates :phone, presence: true
+    validates :ip_address, presence: true
+    validates :message, presence: true
+    validates :accept_terms_of_service, acceptance: true
+
+    module SpamProtection
+      attr_accessor :nickname
+
+      def save
+        if nickname.present?
+          valid?
+          return true
+        else
+          super
+        end
+      end
+    end
+
+    module Notification
+      def self.included(base)
+        base.after_save :notify, if: -> { notified_at.nil? }
+      end
+
+      def notify
+        NotifyNewContactRequestJob.perform_later(id)
+      end
+    end
+
+    prepend SpamProtection
+    include Notification
+  end
+end

data/app/views/cmor/contact/contact_request_mailer/notify.html.haml

@@ -0,0 +1,7 @@
+%h1= t('.title')
+
+%ul
+  - @contact_request.attributes.each do |attribute, value|
+    %li
+      %span.key= @contact_request.class.human_attribute_name(attribute)
+      %span.value= value

data/app/views/cmor/contact/contact_request_mailer/notify.text.erb

@@ -0,0 +1,5 @@
+<%= t('.title') %>
+
+<% @contact_request.attributes.each do |attribute, value| %>
+    <%= @contact_request.class.human_attribute_name(attribute) %>: <%= value %>
+<% end %>

data/app/views/cmor/contact/contact_requests/_form.haml

@@ -0,0 +1,6 @@
+= form.input :name
+= form.input :email
+= form.input :nickname, input_html: { style: 'display: none;' }, label_html: { style: 'display: none;' }
+= form.input :phone
+= form.input :message, as: :text
+= form.input :accept_terms_of_service

data/app/views/cmor/contact/contact_requests/_form_errors.haml

@@ -0,0 +1,6 @@
+- if resource.errors.any?
+  .error-explanation.alert.alert-danger
+    .error-heading= t('errors.template.header', count: resource.errors.count, model: resource.model_name.human)
+    %ul
+      - resource.errors.full_messages.each do |msg|
+        %li= msg

data/app/views/cmor/contact/contact_requests/new.haml

@@ -0,0 +1,8 @@
+%h1= t('.title')
+
+= Cmor::Contact::Configuration.additional_contact_information.call(self) if Cmor::Contact::Configuration.additional_contact_information.respond_to?(:call)
+
+= simple_form_for(@resource) do |f|
+  = render 'form_errors', resource: f.object
+  = render 'form', form: f
+  = f.submit class: 'btn btn-primary'

data/app/views/layouts/cmor/contact/application.html.erb

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

data/app/views/layouts/cmor/contact/mailer.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/app/views/layouts/cmor/contact/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/config/locales/de.yml

@@ -0,0 +1,50 @@
+de:
+  classes:
+    cmor/contact/engine: Kontakt
+  activerecord:
+    models:
+      cmor/contact/contact_request:
+        one: Kontaktanfrage
+        other: Kontaktanfragen
+    attributes:
+      cmor/contact/contact_request:
+        id: ID
+        accept_terms_of_service: 'Hiermit erlaube ich dem Seitenbetreiber die Nutzung meiner Daten zwecks Beantwortung dieser Kontaktanfrage.'
+        name: Name
+        email: E-Mail
+        phone: Telefonnummer
+        ip_address: IP Adresse
+        message: Nachricht
+        notified_at: Benachrichtigt am
+        created_at: Erstellt am
+        updated_at: Aktualisiert am
+        additional_actions: Zusatzliche Aktionen
+  cmor:
+    contact:
+      contact_requests:
+        new:
+          title: "Kontaktanfrage"
+      contact_request_mailer:
+        notify:
+          subject: "[%{application_name}] Neue Kontaktanfrage"
+          title: "Neue Kontaktanfrage"
+  flash:
+    cmor:
+      contact:
+        contact_requests:
+          create:
+            notice: "Ihre Kontaktanfrage wurde versandt."
+  helpers:
+    submit:
+      contact_request:
+        create: Absenden
+  routes:
+    cmor_contact_engine: kontakt
+    contact_requests: anfrage
+  simple_form:
+    placeholders:
+      contact_request:
+        name: "Max Mustermann"
+        email: "max.mustermann@example.com"
+        message: "Meine Nachricht"
+        phone: "+49 69 12345678"