bcms_contact_us_module 1.0.1

data/LICENSE.txt

@@ -0,0 +1,165 @@
+		   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions. 
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version. 
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.markdown

@@ -0,0 +1,33 @@
+# Browser CMS Contact Us Module
+
+Contact Us module for BrowserCMS gives you a portlet to put on a contact us page. It will save the submitted question and send an email to a pre-configured email address.
+
+## Getting Started
+
+### Installation
+Have a look here to see how BrowserCMS modules installs in BrowserCMS (http://guides.browsercms.org/installing_modules.html)
+
+	gem install bcms_contact_us_module
+
+### Configuration changes
+
+Edit config/environment.rb
+
+	config.gem "browsercms"
+	config.gem "bcms_contact_us_module"
+	
+Run this
+
+	script/generate browser_cms
+	rake db:migrate
+	
+Add this to config/routes.rb
+
+	map.routes_for_bcms_questions
+	map.routes_for_browser_cms
+
+## License
+Contact Us is released under a LGPL license, and is copyright 1998-2009 Freddy Andersen, Zerolimits Technology. The complete copyright can be found in COPYRIGHT.txt, and copy of the license can be found in LICENSE.txt.
+
+## Support
+If you have problems with this module add a new issue under the issues tab on github

data/app/controllers/application_controller.rb

@@ -0,0 +1,10 @@
+# Filters added to this controller apply to all controllers in the application.
+# Likewise, all the methods added will be available for all controllers.
+
+class ApplicationController < ActionController::Base
+  helper :all # include all helpers, all the time
+  protect_from_forgery # See ActionController::RequestForgeryProtection for details
+
+  # Scrub sensitive parameters from your log
+  # filter_parameter_logging :password
+end

data/app/controllers/cms/questions_controller.rb

@@ -0,0 +1,2 @@
+class Cms::QuestionsController < Cms::ContentBlockController
+end

data/app/helpers/application_helper.rb

@@ -0,0 +1,3 @@
+# Methods added to this helper will be available to all templates in the application.
+module ApplicationHelper
+end

data/app/models/notifications.rb

@@ -0,0 +1,12 @@
+class Notifications < ActionMailer::Base
+  
+
+  def new_question_notification(question, recipients, from_email="no_reply@bcms-site.com", subject="New question submitted")
+    subject    subject
+    recipients recipients
+    from       from_email
+    
+    body       "Question Subject: " + question.subject + "\n\n" + question.message
+  end
+
+end

data/app/models/question.rb

@@ -0,0 +1,23 @@
+class Question < ActiveRecord::Base
+  acts_as_content_block
+  
+  # Pattern used to find real emails
+  EMAIL_PATTERN = /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\Z/i  
+  
+  # i18n messages stored in config/locales/en.yml
+  validates_presence_of   :email
+  validates_format_of     :email, :with => EMAIL_PATTERN
+
+  # display_name is used in the admin secton of the cms to give our
+  # content block a readable name
+  def self.display_name
+    "Submitted Questions"
+  end
+  
+  # When the question is saved make sure it is also published does not make
+  # sens to publish a question right?
+  def before_create
+    self.published = true
+  end
+  
+end

data/app/portlets/contact_us_portlet.rb

@@ -0,0 +1,35 @@
+class ContactUsPortlet < Portlet
+
+  # Mark this as 'true' to allow the portlet's template to be editable via the CMS admin UI.
+  enable_template_editor false
+     
+  def render
+    pmap = flash[instance_name] || params
+    @question = Question.new pmap[:question]
+    @question.errors.add_from_hash flash["#{instance_name}_errors"]
+  end
+  
+  def action
+    question = Question.new(params[:question] || {})
+    
+    if question.save
+      
+      if self.notify_me
+        begin
+          Notifications.deliver_new_question_notification(question, self.notify_emails)
+        rescue => e
+          logger.error "[ERROR] in ContactUsPortlet => #{e}"
+        end
+      end
+      
+      flash[:notice] = "We have received your message and will get intouch with you within 48 hours."
+      url_for_success
+    else
+      flash[:error] = "There was a problem with your question, please check the contact us form and resubmit."
+      store_params_in_flash
+      store_errors_in_flash(question.errors)
+      url_for_failure
+    end
+  end
+    
+end

data/app/portlets/helpers/contact_us_portlet_helper.rb

@@ -0,0 +1,5 @@
+##
+# All methods from this helper will be available in the render.html.erb for ContactUsPortlet
+module ContactUsPortletHelper
+  
+end

data/app/views/cms/questions/_form.html.erb

@@ -0,0 +1,6 @@
+<%= f.cms_text_field :name %>
+<%= f.cms_text_field :email %>
+<%= f.cms_text_field :subject %>
+<%= f.cms_text_area  :message %>
+
+

data/app/views/cms/questions/render.html.erb

@@ -0,0 +1,19 @@
+
+<div class="nv_pair">
+	<div class="header">Name</div> 
+	<div><%= @content_block.name %></div>
+</div>
+<div class="nv_pair">
+	<div class="header">E-mail</div> 
+	<div><%= @content_block.email %></div>
+</div>
+<div class="nv_pair">
+	<div class="header">Subject</div> 
+	<div><%= @content_block.subject %></div>
+</div>
+
+<div class="header">Question</div> 
+<div class="content">
+	<p><%= @content_block.message %></p>
+</div>
+

data/app/views/layouts/templates/default.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
+	<title><%= page_title %></title>
+	<%= yield :html_head %>
+  </head>
+  <body>
+    <%= cms_toolbar %>
+	<%= flash_messages %>
+	<%= render_breadcrumbs %>
+	<%= container :default %>
+  </body>
+</html>

data/app/views/portlets/contact_us/_form.html.erb

@@ -0,0 +1,13 @@
+<%= f.cms_text_field :name %>
+<%= f.cms_check_box :notify_me, :instructions => 'To enable email notification put a check mark here.' %>
+<%= f.cms_text_field :notify_emails, 
+		:instructions => 'Email addresses to notify after a successful submitted question; emails separated by a comma' %>
+<%= f.cms_drop_down :success_url, 
+   	[["Default url",""]] + Page.all(:order => "name").map{|c| ["#{c.name} - [#{c.path}]", c.path]},
+	:label => "Success url",
+    :instructions => "Determines which page to forward to after a successful submitted question." %>
+<%= f.cms_drop_down :failure_url, 
+	[["Default url",""]] + Page.all(:order => "name").map{|c| ["#{c.name} - [#{c.path}]", c.path]},
+	:label => "Failure url",
+    :instructions => "Determines which page to forward to after a failed submitted question." %>
+<%= f.cms_template_editor :template %>

data/app/views/portlets/contact_us/render.html.erb

@@ -0,0 +1,37 @@
+<h1><%= @portlet.name %></h1>
+
+<div class="contact_us_form">
+	
+  <% form_for @question, :url => cms_handler_path(@portlet, "action") do |f| %>
+	<%= error_messages_for :question %>
+
+	<fieldset>
+		
+		<p>
+			<%= f.label :name %>
+		    <%= f.text_field :name %>
+		</p>
+
+		<p>
+			<%= f.label :email %>
+	    	<%= f.text_field :email %>
+		</p>
+
+		<p>
+			<%= f.label :subject %>
+	    	<%= f.text_field :subject %>
+		</p>
+
+		<p>
+	    	<%= f.text_area :message %>
+		</p>
+
+		<p>
+	    	<%= f.submit "Submit" %>
+		</p>
+
+	</fieldset>
+
+  <% end %>
+
+</div>

data/db/migrate/20101030141654_create_questions.rb

@@ -0,0 +1,21 @@
+class CreateQuestions < ActiveRecord::Migration
+  def self.up
+    create_content_table :questions do |t|
+      t.string :name
+      t.string :email
+      t.string :subject
+      t.text :message
+    end
+    
+    
+    ContentType.create!(:name => "Question", :group_name => "Administration")
+  end
+
+  def self.down
+    ContentType.delete_all(['name = ?', 'Question'])
+    CategoryType.all(:conditions => ['name = ?', 'Question']).each(&:destroy)
+    #If you aren't creating a versioned table, be sure to comment this out.
+    drop_table :question_versions
+    drop_table :questions
+  end
+end

data/lib/bcms_contact_us_module/routes.rb

@@ -0,0 +1,7 @@
+module Cms::Routes
+  def routes_for_bcms_contact_us_module
+    namespace(:cms) do |cms|
+      cms.content_blocks :questions
+    end  
+  end
+end

data/lib/bcms_contact_us_module.rb

@@ -0,0 +1 @@
+require 'bcms_contact_us_module/routes'

data/rails/init.rb

@@ -0,0 +1,5 @@
+gem_root = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+Cms.add_to_rails_paths gem_root
+Cms.add_generator_paths gem_root, "db/migrate/[0-9]*_*.rb"
+Cms.add_generator_paths gem_root, "public/bcms/contact_us_module/**/*"
+

data/test/functional/cms/questions_controller_test.rb

@@ -0,0 +1,11 @@
+require File.join(File.dirname(__FILE__), '/../../test_helper')
+
+class Cms::QuestionsControllerTest < ActionController::TestCase
+
+  test "Add_test_here" do
+
+  end
+
+
+
+end

data/test/performance/browsing_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+require 'performance_test_help'
+
+# Profiling results for each test method are written to tmp/performance.
+class BrowsingTest < ActionController::PerformanceTest
+  def test_homepage
+    get '/'
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,38 @@
+ENV["RAILS_ENV"] = "test"
+require File.expand_path(File.dirname(__FILE__) + "/../config/environment")
+require 'test_help'
+
+class ActiveSupport::TestCase
+  # Transactional fixtures accelerate your tests by wrapping each test method
+  # in a transaction that's rolled back on completion.  This ensures that the
+  # test database remains unchanged so your fixtures don't have to be reloaded
+  # between every test method.  Fewer database queries means faster tests.
+  #
+  # Read Mike Clark's excellent walkthrough at
+  #   http://clarkware.com/cgi/blosxom/2005/10/24#Rails10FastTesting
+  #
+  # Every Active Record database supports transactions except MyISAM tables
+  # in MySQL.  Turn off transactional fixtures in this case; however, if you
+  # don't care one way or the other, switching from MyISAM to InnoDB tables
+  # is recommended.
+  #
+  # The only drawback to using transactional fixtures is when you actually 
+  # need to test transactions.  Since your test is bracketed by a transaction,
+  # any transactions started in your code will be automatically rolled back.
+  self.use_transactional_fixtures = true
+
+  # Instantiated fixtures are slow, but give you @david where otherwise you
+  # would need people(:david).  If you don't want to migrate your existing
+  # test cases which use the @david style and don't mind the speed hit (each
+  # instantiated fixtures translates to a database query per test method),
+  # then set this back to true.
+  self.use_instantiated_fixtures  = false
+
+  # Setup all fixtures in test/fixtures/*.(yml|csv) for all tests in alphabetical order.
+  #
+  # Note: You'll currently still have to declare fixtures explicitly in integration tests
+  # -- they do not yet inherit this setting
+  fixtures :all
+
+  # Add more helper methods to be used by all tests here...
+end

data/test/unit/models/question_test.rb

@@ -0,0 +1,9 @@
+require File.join(File.dirname(__FILE__), '/../../test_helper')
+
+class QuestionTest < ActiveSupport::TestCase
+
+  test "should be able to create new block" do
+    assert Question.create!
+  end
+  
+end

data/test/unit/notifications_test.rb

@@ -0,0 +1,12 @@
+require 'test_helper'
+
+class NotificationsTest < ActionMailer::TestCase
+  test "new_question" do
+    @expected.subject = 'Notifications#new_question'
+    @expected.body    = read_fixture('new_question')
+    @expected.date    = Time.now
+
+    assert_equal @expected.encoded, Notifications.create_new_question(@expected.date).encoded
+  end
+
+end

data/test/unit/portlets/contact_us_portlet_test.rb

@@ -0,0 +1,9 @@
+require File.join(File.dirname(__FILE__), '/../../test_helper')
+
+class ContactUsTest < ActiveSupport::TestCase
+
+  test "Should be able to create new instance of a portlet" do
+    assert ContactUsPortlet.create!(:name => "New Portlet")
+  end
+  
+end

data/test/unit/question_observer_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class QuestionObserverTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification 
+name: bcms_contact_us_module
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 1
+  version: 1.0.1
+platform: ruby
+authors: 
+- Freddy Andersen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-01 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: A BrowserCMS module that gives you a contact us portlet
+email: freddy@zerolimitstech.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.markdown
+files: 
+- app/controllers/application_controller.rb
+- app/controllers/cms/questions_controller.rb
+- app/helpers/application_helper.rb
+- app/models/notifications.rb
+- app/models/question.rb
+- app/portlets/contact_us_portlet.rb
+- app/portlets/helpers/contact_us_portlet_helper.rb
+- app/views/cms/questions/_form.html.erb
+- app/views/cms/questions/render.html.erb
+- app/views/layouts/templates/default.html.erb
+- app/views/portlets/contact_us/_form.html.erb
+- app/views/portlets/contact_us/render.html.erb
+- db/migrate/20101030141654_create_questions.rb
+- lib/bcms_contact_us_module.rb
+- lib/bcms_contact_us_module/routes.rb
+- rails/init.rb
+- LICENSE.txt
+- README.markdown
+- test/functional/cms/questions_controller_test.rb
+- test/performance/browsing_test.rb
+- test/test_helper.rb
+- test/unit/models/question_test.rb
+- test/unit/notifications_test.rb
+- test/unit/portlets/contact_us_portlet_test.rb
+- test/unit/question_observer_test.rb
+has_rdoc: true
+homepage: http://github.com/heimdull/bcms_contact_us_module
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Contact Us portlet in BrowserCMS
+test_files: 
+- test/functional/cms/questions_controller_test.rb
+- test/performance/browsing_test.rb
+- test/test_helper.rb
+- test/unit/models/question_test.rb
+- test/unit/notifications_test.rb
+- test/unit/portlets/contact_us_portlet_test.rb
+- test/unit/question_observer_test.rb