cms-inquiries 1.0.1

data/db/migrate/20110719082646_drop_inquiry_settings_table.rb

@@ -0,0 +1,11 @@
+class DropInquirySettingsTable < ActiveRecord::Migration
+  def self.up
+    if ::InquirySetting.table_exists?
+      drop_table ::InquirySetting.table_name
+    end
+  end
+
+  def self.down
+    # we don't want to restore inquiry settings table
+  end
+end

data/db/seeds/pages_for_inquiries.rb

@@ -0,0 +1,55 @@
+::User.all.each do |user|
+  if user.plugins.where(:name => 'refinery_inquiries').blank?
+    user.plugins.create(:name => "refinery_inquiries",
+                        :position => (user.plugins.maximum(:position) || -1) +1)
+  end
+end if defined?(::User)
+
+if defined?(::Page)
+  page_position = (::Page.maximum(:position, :conditions => {:parent_id => nil}) || -1)
+
+  contact_us_page = ::Page.create({
+    :title => "Contact",
+    :link_url => "/contact",
+    :menu_match => "^/(inquiries|contact).*$",
+    :deletable => false,
+    :position => (page_position += 1)
+  })
+  contact_us_page.parts.create({
+    :title => "Body",
+    :body => "<p>Get in touch with us. Just use the form below and we'll get back to you as soon as we can.</p>",
+    :position => 0
+  })
+  contact_us_page.parts.create({
+    :title => "Side Body",
+    :body => "<p>163 Evergreen Terrace<br/>Happyville<br/>USA.<br/>Phone: 1-800 CALLUSNOW</p>",
+    :position => 1
+  })
+  contact_us_page_position = -1
+
+  thank_you_page = contact_us_page.children.create({
+    :title => "Thank You",
+    :link_url => "/contact/thank_you",
+    :menu_match => "^/(inquiries|contact)/thank_you$",
+    :show_in_menu => false,
+    :deletable => false,
+    :position => (contact_us_page_position += 1)
+  })
+  thank_you_page.parts.create({
+    :title => "Body",
+    :body => "<p>We've received your inquiry and will get back to you with a response shortly.</p><p><a href='/'>Return to the home page</a></p>",
+    :position => 0
+  })
+
+  privacy_policy_page = contact_us_page.children.create({
+    :title => "Privacy Policy",
+    :deletable => true,
+    :show_in_menu => false,
+    :position => (contact_us_page_position += 1)
+  })
+  privacy_policy_page.parts.create({
+    :title => "Body",
+    :body => "<p>We respect your privacy. We do not market, rent or sell our email list to any outside parties.</p><p>We need your e-mail address so that we can ensure that the people using our forms are bona fide. It also allows us to send you e-mail newsletters and other communications, if you opt-in. Your postal address is required in order to send you information and pricing, if you request it.</p><p>Please call us at 123 456 7890 if you have any questions or concerns.</p>",
+    :position => 0
+  })
+end

data/features/create_inquiries.feature

@@ -0,0 +1,38 @@
+@refinerycms @inquiries @inquiries-create
+Feature: Create Inquiries
+  In order to contact the website owner
+  I want to create an inquiry
+
+  Background:
+    Given A Refinery user exists
+    And I have no inquiries
+    And I have a page titled "Contact Us" with a custom url "/contact"
+    And I have a page titled "Thank You" with a custom url "/contact/thank_you"
+
+  Scenario: Contact page
+    When I go to the contact page
+    Then I should see "Name *"
+    And I should see "Email *"
+    And I should see "Phone"
+    And I should see "Message *"
+
+  Scenario: Create a valid inquiry
+    When I go to the contact page
+    And I fill in "Name *" with "Philip"
+    And I fill in "Email *" with "phil@refinerycms.com"
+    And I fill in "Message *" with "It sure is good to have a functional test coverage."
+    And I press "Send"
+    Then I should be on the contact thank you page
+    And I should see "Thank You"
+    And I should have 1 inquiries
+
+  Scenario: Create an invalid inquiry
+    When I go to the contact page
+    And I press "Send"
+    Then I should be on the contact create page
+    And I should see "Name can't be blank"
+    And I should not see "Email can't be blank"
+    And I should see "Email is invalid"
+    And I should not see "Phone can't be blank"
+    And I should see "Message can't be blank"
+    And I should have 0 inquiries

data/features/manage_inquiries.feature

@@ -0,0 +1,57 @@
+@refinerycms @inquiries @inquiries-manage
+Feature: Manage Inquiries
+  In order to see inquiries left for me on my website
+  As an Administrator
+  I want to manage inquiries
+
+  Background:
+    Given I am a logged in refinery user
+    And I have no inquiries
+    And I have an inquiry from "David Jones" with email "dave@refinerycms.com" and message "Hello, I really like your website.  Was it hard to build and maintain or could anyone do it?"
+
+  Scenario: Inquiries List
+    When I go to the list of inquiries
+    Then I should see "David Jones said Hello, I really like your website. Was it hard to build ..."
+    And I should have 1 inquiries
+    And I should not see "Add"
+
+  Scenario: Spam List
+    When I go to the list of inquiries
+    And I follow "Spam"
+    Then I should see "Hooray! You don't have any spam."
+
+  @inquiry-settings
+  Scenario: Updating who gets notified
+    When I go to the list of inquiries
+    And I follow "Update who gets notified"
+    And I fill in "Send notifications to" with "phil@refinerycms.com"
+    And I press "Save"
+    Then I should be redirected back to "the list of inquiries"
+    And I should see "'Notification Recipients' was successfully updated."
+    And I should be on the list of inquiries
+
+  @inquiry-settings
+  Scenario: Updating confirmation email copy
+    When I go to the list of inquiries
+    And I follow "Edit confirmation email"
+    And I fill in "Message" with "Thanks %name%! We'll never get back to you!"
+    And I press "Save"
+    Then I should be redirected back to "the list of inquiries"
+    And I should see "'Confirmation Body' was successfully updated."
+    And I should be on the list of inquiries
+
+  Scenario: Inquiries Show
+    When I go to the list of inquiries
+    And I follow "Read the inquiry"
+    Then I should see "From David Jones [dave@refinerycms.com]"
+    And I should see "Hello, I really like your website. Was it hard to build and maintain or could anyone do it?"
+    And I should see "Age"
+    And I should see "Back to all Inquiries"
+    And I should see "Remove this inquiry forever"
+
+  Scenario: Inquiries Delete
+    When I go to the list of inquiries
+    And I follow "Read the inquiry"
+    And I follow "Remove this inquiry forever"
+    Then I should see "'David Jones' was successfully removed."
+    And I should have 0 inquiries

data/features/step_definitions/inquiry_steps.rb

@@ -0,0 +1,25 @@
+Given /^I have no inquiries$/ do
+  Inquiry.delete_all
+end
+
+Then /^I should have ([0-9]+) inquiries?$/ do |count|
+  Inquiry.count.should == count.to_i
+end
+
+Given /^I have an? inquiry from "([^"]*)" with email "([^\"]*)" and message "([^\"]*)"$/ do |name, email, message|
+  Inquiry.create(:name => name,
+                 :email => email,
+                 :message => message)
+end
+
+Given /^I have an? inquiry titled "([^"]*)"$/ do |title|
+  Inquiry.create(:name => title,
+                 :email => 'test@cukes.com',
+                 :message => 'cuking ...',
+                 :spam => false)
+
+  Inquiry.create(:name => title,
+                 :email => 'test@cukes.com',
+                 :message => 'cuking ...',
+                 :spam => true)
+end

data/features/support/factories.rb

@@ -0,0 +1,7 @@
+require 'factory_girl'
+
+Factory.define :inquiry do |i|
+  i.name "Refinery"
+  i.email "refinery@cms.com"
+  i.message "Hello..."
+end

data/features/support/paths.rb

@@ -0,0 +1,26 @@
+module NavigationHelpers
+  module Refinery
+    module Inquiries
+      def path_to(page_name)
+        case page_name
+        when /the contact page/
+          new_inquiry_path
+
+        when /the contact thank you page/
+          thank_you_inquiries_path
+
+        when /the contact create page/
+          inquiries_path
+
+        when /the list of inquiries/
+          admin_inquiries_path
+
+        when /the list of spam inquiries/
+          spam_admin_inquiries_path
+        else
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/gemspec.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+version = '1.0.1'
+raise "Could not get version so gemspec can not be built" if version.nil?
+files = Dir.glob("**/*").flatten.reject do |file|
+  file =~ /\.gem$/
+end
+
+gemspec = <<EOF
+Gem::Specification.new do |s|
+  s.name              = %q{refinerycms-inquiries}
+  s.version           = %q{#{version}}
+  s.date              = %q{#{Time.now.strftime('%Y-%m-%d')}}
+  s.summary           = %q{Inquiry handling functionality for the Refinery CMS project.}
+  s.description       = %q{Inquiry handling functionality extracted from Refinery CMS to allow you to have a contact form and manage inquiries in the Refinery backend.}
+  s.homepage          = %q{http://refinerycms.com}
+  s.email             = %q{info@refinerycms.com}
+  s.authors           = ["Resolve Digital"]
+  s.require_paths     = %w(lib)
+
+  s.files             = [
+    '#{files.join("',\n    '")}'
+  ]
+  s.require_path = 'lib'
+
+  s.add_dependency('filters_spam', '~> 0.2')
+end
+EOF
+
+File.open(File.expand_path("../../refinerycms-inquiries.gemspec", __FILE__), 'w').puts(gemspec)

data/lib/generators/refinerycms_inquiries_generator.rb

@@ -0,0 +1,6 @@
+class RefinerycmsInquiries < Refinery::Generators::EngineInstaller
+
+  source_root File.expand_path('../../../', __FILE__)
+  engine_name "refinery_inquiries"
+
+end

data/lib/inquiries.rb

@@ -0,0 +1,2 @@
+require 'refinery'
+require 'filters_spam'

data/lib/refinerycms-inquiries.rb

@@ -0,0 +1,24 @@
+require File.expand_path('../inquiries', __FILE__)
+
+module Refinery
+  module Inquiries
+    class Engine < Rails::Engine
+      config.to_prepare do
+        require 'filters_spam'
+      end
+
+      config.after_initialize do
+        Refinery::Plugin.register do |plugin|
+          plugin.pathname = root
+          plugin.name = "refinery_inquiries"
+          plugin.directory = "inquiries"
+          plugin.menu_match = /(refinery|admin)\/inquir(ies|y_settings)$/
+          plugin.activity = {
+            :class => InquirySetting,
+            :title => 'name'
+          }
+        end
+      end
+    end
+  end
+end

data/license.md

@@ -0,0 +1,21 @@
+# MIT License
+ 
+Copyright (c) 2005-2010 [Resolve Digital Ltd.](http://www.resolvedigital.co.nz)
+ 
+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,49 @@
+# Inquiries
+
+![Refinery Inquiries](http://refinerycms.com/system/images/BAhbBlsHOgZmSSIqMjAxMS8wNS8wMS8wNF81MF8wMV81MDlfaW5xdWlyaWVzLnBuZwY6BkVU/inquiries.png)
+
+### Gem Installation using Bundler (The very best way)
+
+Include the latest [gem](http://rubygems.org/gems/refinerycms-inquiries) into your Refinery CMS application's Gemfile:
+
+    gem 'refinerycms-inquiries', '~> 1.0.0'
+
+Then type the following at command line inside your Refinery CMS application's root directory:
+
+    bundle install
+
+#### Installation on Refinery 0.9.9 or above.
+
+To install the migrations, run:
+
+    rails generate refinerycms_inquiries
+
+Next migrate your database and you're done:
+
+    rake db:migrate
+
+## About
+
+__Add a simple contact form to Refinery that notifies you and the customer when an inquiry is made.__
+
+In summary you can:
+
+* Collect and manage inquiries
+* Specify who is notified when a new inquiry comes in
+* Customise an auto responder email that is sent to the person making the inquiry
+
+When inquiries come in, you and the customer are generally notified. As we implemented spam filtering through the [filters_spam plugin](https://github.com/resolve/filters_spam#readme) you will not get notified if an inquiry is marked as 'spam'.
+
+## How do I get Notified?
+
+Go into your 'Inquiries' tab in the Refinery admin area and click on "Update who gets notified"
+
+## How do I Edit the Automatic Confirmation Email
+
+Go into your 'Inquiries' tab in the Refinery admin area and click on "Edit confirmation email"
+
+## How do I change the from address from no-reply@com.au to no-reply@[mydomain].com.au
+
+Simply change the Refinery setting 'Tld Length' in the admin section from 1 to 2 and your domain name will be added.
+
+Note: This only affects top level domains that are two deep (ie: not .com or .org, but does affect .com.au etc).

data/spec/models/inquiry_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+Dir[File.expand_path('../../../features/support/factories.rb', __FILE__)].each {|f| require f}
+
+describe Inquiry do
+  describe "validations" do
+    before(:each) do
+      @attr = {
+        :name => "rspec",
+        :email => "rspec@refinery.com",
+        :message => "test"
+      }
+    end
+
+    it "rejects empty name" do
+      Inquiry.new(@attr.merge(:name => "")).should_not be_valid
+    end
+
+    it "rejects empty message" do
+      Inquiry.new(@attr.merge(:message => "")).should_not be_valid
+    end
+
+    it "rejects invalid email format" do
+      ["", "@refinerycms.com", "refinery@cms", "refinery@cms.123"].each do |email|
+        Inquiry.new(@attr.merge(:email => email)).should_not be_valid
+      end
+    end
+  end
+
+  describe "default scope" do
+    it "orders by created_at in desc" do
+      inquiry1 = Factory(:inquiry, :created_at => 1.hour.ago)
+      inquiry2 = Factory(:inquiry, :created_at => 2.hours.ago)
+      inquiries = Inquiry.all
+      inquiries.first.should == inquiry1
+      inquiries.second.should == inquiry2
+    end
+  end
+
+  describe ".latest" do
+    it "returns latest 7 non-spam inquiries by default" do
+      8.times { Factory(:inquiry) }
+      Inquiry.last.toggle!(:spam)
+      Inquiry.latest.length.should == 7
+    end
+
+    it "returns latest 7 inquiries including spam ones" do
+      4.times { Factory(:inquiry) }
+      3.times { Factory(:inquiry) }
+      Inquiry.all[0..2].each { |inquiry| inquiry.toggle!(:spam) }
+      Inquiry.latest(7, true).length.should == 7
+    end
+
+    it "returns latest n inquiries" do
+      4.times { Factory(:inquiry) }
+      Inquiry.latest(3).length.should == 3
+    end
+  end
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification 
+name: cms-inquiries
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 1
+  version: 1.0.1
+platform: ruby
+authors: 
+- Mutalis LLC
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-02-06 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: filters_spam
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 2
+        version: "0.2"
+  type: :runtime
+  version_requirements: *id001
+description: Inquiry handling functionality that allow you to have a contact form and manage inquiries in the CMS backend.
+email: services_info@mutalis.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- cms-inquiries.gemspec
+- app/controllers/inquiries_controller.rb
+- app/controllers/admin/inquiries_controller.rb
+- app/controllers/admin/inquiry_settings_controller.rb
+- app/views/inquiries/thank_you.html.erb
+- app/views/inquiries/new.html.erb
+- app/views/inquiry_mailer/confirmation.html.erb
+- app/views/inquiry_mailer/notification.html.erb
+- app/views/admin/inquiries/show.html.erb
+- app/views/admin/inquiries/_submenu.html.erb
+- app/views/admin/inquiries/index.html.erb
+- app/views/admin/inquiries/_inquiry.html.erb
+- app/views/admin/inquiry_settings/_notification_recipients_form.html.erb
+- app/views/admin/inquiry_settings/_confirmation_email_form.html.erb
+- app/views/admin/inquiry_settings/edit.html.erb
+- app/helpers/inquiries_helper.rb
+- app/models/inquiry_setting.rb
+- app/models/inquiry.rb
+- app/mailers/inquiry_mailer.rb
+- spec/models/inquiry_spec.rb
+- features/support/paths.rb
+- features/support/factories.rb
+- features/manage_inquiries.feature
+- features/create_inquiries.feature
+- features/step_definitions/inquiry_steps.rb
+- lib/gemspec.rb
+- lib/inquiries.rb
+- lib/generators/refinerycms_inquiries_generator.rb
+- lib/refinerycms-inquiries.rb
+- db/migrate/20101208082840_create_inquiries.rb
+- db/migrate/20110719082646_drop_inquiry_settings_table.rb
+- db/migrate/20101208082841_remove_position_and_open_from_inquiries.rb
+- db/seeds/pages_for_inquiries.rb
+- readme.md
+- license.md
+- config/locales/sk.yml
+- config/locales/cs.yml
+- config/locales/bg.yml
+- config/locales/nl.yml
+- config/locales/sl.yml
+- config/locales/sv.yml
+- config/locales/ru.yml
+- config/locales/pt-BR.yml
+- config/locales/zh-CN.yml
+- config/locales/lt.yml
+- config/locales/da.yml
+- config/locales/en-GB.yml
+- config/locales/it.yml
+- config/locales/lolcat.yml
+- config/locales/nb.yml
+- config/locales/en.yml
+- config/locales/lv.yml
+- config/locales/fr.yml
+- config/locales/de.yml
+- config/locales/es.yml
+- config/locales/pl.yml
+- config/routes.rb
+homepage: http://www.mutalis.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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.8.11
+signing_key: 
+specification_version: 3
+summary: Inquiry handling functionality for the CMS project.
+test_files: []
+