├── .gitignore
├── .tool-versions
├── .travis.yml
├── Appraisals
├── Gemfile
├── Gemfile.lock
├── MIT-LICENSE
├── README.md
├── Rakefile
├── app
├── assets
│ ├── images
│ │ └── pointless_feedback
│ │ │ └── .gitkeep
│ ├── javascripts
│ │ └── pointless_feedback
│ │ │ └── application.js
│ └── stylesheets
│ │ └── pointless_feedback
│ │ └── application.css
├── controllers
│ └── pointless_feedback
│ │ └── messages_controller.rb
├── helpers
│ └── pointless_feedback
│ │ └── application_helper.rb
├── mailers
│ └── pointless_feedback
│ │ └── feedback_mailer.rb
├── models
│ └── pointless_feedback
│ │ └── message.rb
└── views
│ ├── layouts
│ └── pointless_feedback
│ │ └── application.html.erb
│ └── pointless_feedback
│ ├── feedback_mailer
│ └── feedback.html.erb
│ └── messages
│ └── new.html.erb
├── config
├── locales
│ └── en.yml
└── routes.rb
├── db
└── migrate
│ ├── 20130501182659_create_pointless_feedback_messages.rb
│ └── 20220518205500_add_url_to_pointless_feedback_messages.rb
├── gemfiles
├── rails_40.gemfile
├── rails_40.gemfile.lock
├── rails_41.gemfile
├── rails_41.gemfile.lock
├── rails_42.gemfile
└── rails_42.gemfile.lock
├── lib
├── generators
│ ├── pointless_feedback
│ │ ├── install_generator.rb
│ │ └── views_generator.rb
│ └── templates
│ │ └── pointless_feedback.rb
├── pointless_feedback.rb
├── pointless_feedback
│ ├── captcha.rb
│ ├── controllers
│ │ └── helpers.rb
│ ├── engine.rb
│ └── version.rb
└── tasks
│ └── pointless_feedback_tasks.rake
├── pointless_feedback.gemspec
├── script
└── rails
└── test
├── dummy
├── README.rdoc
├── Rakefile
├── app
│ ├── assets
│ │ ├── javascripts
│ │ │ └── application.js
│ │ └── stylesheets
│ │ │ └── application.css
│ ├── controllers
│ │ ├── application_controller.rb
│ │ └── home_controller.rb
│ ├── helpers
│ │ └── application_helper.rb
│ ├── mailers
│ │ └── .gitkeep
│ ├── models
│ │ └── .gitkeep
│ └── views
│ │ ├── home
│ │ └── index.html.erb
│ │ └── layouts
│ │ └── application.html.erb
├── config.ru
├── config
│ ├── application.rb
│ ├── boot.rb
│ ├── database.yml
│ ├── environment.rb
│ ├── environments
│ │ ├── development.rb
│ │ ├── production.rb
│ │ └── test.rb
│ ├── initializers
│ │ ├── backtrace_silencers.rb
│ │ ├── filter_parameter_logging.rb
│ │ ├── inflections.rb
│ │ ├── mime_types.rb
│ │ ├── secret_token.rb
│ │ ├── session_store.rb
│ │ └── wrap_parameters.rb
│ ├── locales
│ │ └── en.yml
│ └── routes.rb
├── db
│ └── schema.rb
├── lib
│ └── assets
│ │ └── .gitkeep
├── log
│ └── .gitkeep
├── public
│ ├── 404.html
│ ├── 422.html
│ ├── 500.html
│ └── favicon.ico
└── script
│ └── rails
├── factories
└── messages.rb
├── functional
└── pointless_feedback
│ ├── feedback_mailer_test.rb
│ └── messages_controller_test.rb
├── generators
├── install_generator_test.rb
└── views_generator_test.rb
├── integration
└── pointless_feedback
│ ├── feedback_submission_test.rb
│ └── main_app_root_url_test.rb
├── pointless_feedback_test.rb
├── test_helper.rb
└── unit
├── helpers
└── pointless_feedback
│ └── application_helper_test.rb
└── pointless_feedback
├── captcha_test.rb
└── message_test.rb
/.gitignore:
--------------------------------------------------------------------------------
1 | .ruby-version
2 | .bundle/
3 | log/*.log
4 | pkg/
5 | test/dummy/db/*.sqlite3
6 | test/dummy/log/*.log
7 | test/dummy/tmp/
8 | test/dummy/.sass-cache
9 | test/tmp
10 |
--------------------------------------------------------------------------------
/.tool-versions:
--------------------------------------------------------------------------------
1 | ruby 2.3.0
2 |
--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | language: ruby
2 | rvm:
3 | - 2.0.0
4 | - 2.1.0
5 | - 2.2.0
6 |
7 | gemfile:
8 | - gemfiles/rails_40.gemfile
9 | - gemfiles/rails_41.gemfile
10 | - gemfiles/rails_42.gemfile
11 |
12 | before_script:
13 | - bundle exec rake db:migrate
14 | - bundle exec rake app:db:test:prepare
15 |
16 | script: bundle exec rake
17 |
--------------------------------------------------------------------------------
/Appraisals:
--------------------------------------------------------------------------------
1 | appraise "rails-40" do
2 | gem "rails", "~> 4.0.0"
3 | end
4 |
5 | appraise "rails-41" do
6 | gem "rails", "~> 4.1.0"
7 | end
8 |
9 | appraise "rails-42" do
10 | gem "rails", "~> 4.2.0"
11 | end
12 |
--------------------------------------------------------------------------------
/Gemfile:
--------------------------------------------------------------------------------
1 | source "http://rubygems.org"
2 |
3 | # Declare your gem's dependencies in pointless_feedback.gemspec.
4 | # Bundler will treat runtime dependencies like base dependencies, and
5 | # development dependencies will be added by default to the :development group.
6 | gemspec
7 |
8 | group :test do
9 | gem 'test-unit'
10 | gem 'pry'
11 | gem 'minitest-spec-rails'
12 | gem 'mocha', require: false
13 | end
14 |
--------------------------------------------------------------------------------
/Gemfile.lock:
--------------------------------------------------------------------------------
1 | PATH
2 | remote: .
3 | specs:
4 | pointless_feedback (4.1.5)
5 | airrecord (~> 1.0)
6 | jquery-rails (>= 4.0)
7 | rails (>= 4.0)
8 | typhoeus (~> 0.7, >= 0.7.3)
9 |
10 | GEM
11 | remote: http://rubygems.org/
12 | specs:
13 | actionmailer (4.2.2)
14 | actionpack (= 4.2.2)
15 | actionview (= 4.2.2)
16 | activejob (= 4.2.2)
17 | mail (~> 2.5, >= 2.5.4)
18 | rails-dom-testing (~> 1.0, >= 1.0.5)
19 | actionpack (4.2.2)
20 | actionview (= 4.2.2)
21 | activesupport (= 4.2.2)
22 | rack (~> 1.6)
23 | rack-test (~> 0.6.2)
24 | rails-dom-testing (~> 1.0, >= 1.0.5)
25 | rails-html-sanitizer (~> 1.0, >= 1.0.1)
26 | actionview (4.2.2)
27 | activesupport (= 4.2.2)
28 | builder (~> 3.1)
29 | erubis (~> 2.7.0)
30 | rails-dom-testing (~> 1.0, >= 1.0.5)
31 | rails-html-sanitizer (~> 1.0, >= 1.0.1)
32 | activejob (4.2.2)
33 | activesupport (= 4.2.2)
34 | globalid (>= 0.3.0)
35 | activemodel (4.2.2)
36 | activesupport (= 4.2.2)
37 | builder (~> 3.1)
38 | activerecord (4.2.2)
39 | activemodel (= 4.2.2)
40 | activesupport (= 4.2.2)
41 | arel (~> 6.0)
42 | activesupport (4.2.2)
43 | i18n (~> 0.7)
44 | json (~> 1.7, >= 1.7.7)
45 | minitest (~> 5.1)
46 | thread_safe (~> 0.3, >= 0.3.4)
47 | tzinfo (~> 1.1)
48 | addressable (2.3.8)
49 | airrecord (1.0.8)
50 | faraday (>= 0.10, < 3.0)
51 | net-http-persistent
52 | appraisal (2.0.1)
53 | activesupport (>= 3.2.21)
54 | bundler
55 | rake
56 | thor (>= 0.14.0)
57 | arel (6.0.0)
58 | builder (3.2.2)
59 | capybara (2.4.4)
60 | mime-types (>= 1.16)
61 | nokogiri (>= 1.3.3)
62 | rack (>= 1.0.0)
63 | rack-test (>= 0.5.4)
64 | xpath (~> 2.0)
65 | coderay (1.1.0)
66 | connection_pool (2.2.5)
67 | erubis (2.7.0)
68 | ethon (0.15.0)
69 | ffi (>= 1.15.0)
70 | factory_girl (4.5.0)
71 | activesupport (>= 3.0.0)
72 | factory_girl_rails (4.5.0)
73 | factory_girl (~> 4.5.0)
74 | railties (>= 3.0.0)
75 | faraday (1.0.1)
76 | multipart-post (>= 1.2, < 3)
77 | ffi (1.15.5)
78 | globalid (0.3.5)
79 | activesupport (>= 4.1.0)
80 | i18n (0.7.0)
81 | jquery-rails (4.4.0)
82 | rails-dom-testing (>= 1, < 3)
83 | railties (>= 4.2.0)
84 | thor (>= 0.14, < 2.0)
85 | json (1.8.6)
86 | launchy (2.4.3)
87 | addressable (~> 2.3)
88 | loofah (2.0.2)
89 | nokogiri (>= 1.5.9)
90 | mail (2.6.3)
91 | mime-types (>= 1.16, < 3)
92 | metaclass (0.0.4)
93 | method_source (0.8.2)
94 | mime-types (2.6.1)
95 | mini_portile (0.6.2)
96 | minitest (5.7.0)
97 | minitest-spec-rails (5.2.2)
98 | minitest (~> 5.0)
99 | rails (~> 4.1)
100 | mocha (1.1.0)
101 | metaclass (~> 0.0.1)
102 | multipart-post (2.1.1)
103 | net-http-persistent (4.0.1)
104 | connection_pool (~> 2.2)
105 | nokogiri (1.6.6.2)
106 | mini_portile (~> 0.6.0)
107 | power_assert (0.2.3)
108 | pry (0.10.1)
109 | coderay (~> 1.1.0)
110 | method_source (~> 0.8.1)
111 | slop (~> 3.4)
112 | rack (1.6.4)
113 | rack-test (0.6.3)
114 | rack (>= 1.0)
115 | rails (4.2.2)
116 | actionmailer (= 4.2.2)
117 | actionpack (= 4.2.2)
118 | actionview (= 4.2.2)
119 | activejob (= 4.2.2)
120 | activemodel (= 4.2.2)
121 | activerecord (= 4.2.2)
122 | activesupport (= 4.2.2)
123 | bundler (>= 1.3.0, < 2.0)
124 | railties (= 4.2.2)
125 | sprockets-rails
126 | rails-deprecated_sanitizer (1.0.3)
127 | activesupport (>= 4.2.0.alpha)
128 | rails-dom-testing (1.0.6)
129 | activesupport (>= 4.2.0.beta, < 5.0)
130 | nokogiri (~> 1.6.0)
131 | rails-deprecated_sanitizer (>= 1.0.1)
132 | rails-html-sanitizer (1.0.2)
133 | loofah (~> 2.0)
134 | railties (4.2.2)
135 | actionpack (= 4.2.2)
136 | activesupport (= 4.2.2)
137 | rake (>= 0.8.7)
138 | thor (>= 0.18.1, < 2.0)
139 | rake (10.4.2)
140 | slop (3.6.0)
141 | sprockets (3.2.0)
142 | rack (~> 1.0)
143 | sprockets-rails (2.3.1)
144 | actionpack (>= 3.0)
145 | activesupport (>= 3.0)
146 | sprockets (>= 2.8, < 4.0)
147 | sqlite3 (1.3.10)
148 | test-unit (3.1.2)
149 | power_assert
150 | thor (0.19.1)
151 | thread_safe (0.3.5)
152 | typhoeus (0.8.0)
153 | ethon (>= 0.8.0)
154 | tzinfo (1.2.2)
155 | thread_safe (~> 0.1)
156 | xpath (2.0.0)
157 | nokogiri (~> 1.3)
158 |
159 | PLATFORMS
160 | ruby
161 |
162 | DEPENDENCIES
163 | appraisal (~> 2.0)
164 | capybara (~> 2.4)
165 | factory_girl_rails (~> 4.5)
166 | launchy (~> 2.4)
167 | minitest-spec-rails
168 | mocha
169 | pointless_feedback!
170 | pry
171 | sqlite3 (~> 1.3)
172 | test-unit
173 |
174 | BUNDLED WITH
175 | 1.17.3
176 |
--------------------------------------------------------------------------------
/MIT-LICENSE:
--------------------------------------------------------------------------------
1 | Copyright 2013 Viget
2 |
3 | Permission is hereby granted, free of charge, to any person obtaining
4 | a copy of this software and associated documentation files (the
5 | "Software"), to deal in the Software without restriction, including
6 | without limitation the rights to use, copy, modify, merge, publish,
7 | distribute, sublicense, and/or sell copies of the Software, and to
8 | permit persons to whom the Software is furnished to do so, subject to
9 | the following conditions:
10 |
11 | The above copyright notice and this permission notice shall be
12 | included in all copies or substantial portions of the Software.
13 |
14 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 | EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16 | MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17 | NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18 | LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19 | OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20 | WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Pointless Feedback
2 |
3 | [](https://codeclimate.com/github/vigetlabs/pointless-feedback) [](https://travis-ci.org/vigetlabs/pointless-feedback)
4 |
5 | A Rails engine that provides a platform for your app to submit user feedback to
6 | a specified service. Messages are stored in your database as a fail-safe when
7 | the specified service is unavailable. Currently, only email, Unfuddle, and
8 | Github Issues are supported.
9 |
10 | *Brought to you by the fine folks at [Viget](http://viget.com) and commissioned
11 | under [Pointless Corp](http://www.pointlesscorp.com/).*
12 |
13 | ## Contents
14 |
15 | 1. [Versions](#versions)
16 | 2. [Installation](#installation)
17 | 3. [Configuration](#configuration)
18 | 4. [Customization](#customization)
19 | 5. [Development](#development)
20 | 6. [Roadmap](#roadmap)
21 | 7. [Contributors](#contributors)
22 |
23 | ## Versions
24 |
25 | For Rails 3.x support, use Pointless Feedback version 1.x.
26 |
27 | For Rails 4.x and greater, use Pointless Feedback version 4.x.
28 |
29 | Additionally, Pointless 4.x will only support Ruby 2.x.
30 |
31 | ## Installation
32 |
33 | To install, simply add the following to your Gemfile:
34 |
35 | ```ruby
36 | gem 'pointless_feedback'
37 | ```
38 |
39 | After you install Pointless Feedback and add it to your Gemfile, you need to
40 | run the generator and install the engine migrations:
41 |
42 | ```
43 | bundle exec rails generate pointless_feedback:install
44 | bundle exec rake pointless_feedback:install:migrations
45 | bundle exec rake db:migrate
46 | ```
47 |
48 | The generator will install an initializer which describes ALL Pointless
49 | Feedback's configuration options and you MUST take a look at it. When you are
50 | done, you are ready to mount the routes in your `config/routes.rb` file.
51 |
52 | ```ruby
53 | mount PointlessFeedback::Engine, :at => '/feedback'
54 | ```
55 |
56 | Pointless Feedback uses flash messages to let users know if feedback was
57 | successfully sent. Pointless Feedback expects your application to call
58 | `flash[:notice]` as appropriate.
59 |
60 | After submitting feedback, Pointless Feedback will use your application's
61 | default `root_path`. This means that you need to set the root inside your
62 | routes:
63 |
64 | ```ruby
65 | root :to => 'home#index'
66 | ```
67 |
68 | That's it! Start your Rails server and navigate to `/feedback` to see a basic
69 | feedback form that users can submit.
70 |
71 | ## Configuration
72 |
73 | There are a number of configuration variables you can set in the initializer generated by `rails generate pointless_feedback:install`
74 |
75 | #### Email Configuration
76 |
77 | **email_feedback:**
78 | Defaults to `false`. If set to `true` will send feedback as an email.
79 |
80 | **message_topics:**
81 | Defaults to `['Error on page', 'Other']`. Populates the "Topic" dropdown for feedback submissions.
82 |
83 | **send_from_submitter:**
84 | Defaults to `false`. If set to `true` will use the submitted email address as the from address for feedback emails.
85 |
86 | **to_emails:**
87 | Specifies to what addresses feedback email is sent to.
88 |
89 | **from_email:**
90 | Specifies what address the feedback email is sent from.
91 |
92 | **table_name:**
93 | Defaults to engine's namespace, e.g. `pointless_feedback_messages`. Change to any desired table for `PointlessFeedback::Message` model.
94 |
95 | **invalid_words:**
96 | List of words in the feedback description that would prevent an email from sending.
97 |
98 | **show_url_field:**
99 | Defaults to `false`. If set to `true`, will show an additional URL field in the form.
100 |
101 | **url_label:**
102 | Defaults to `URL`. The label for the URL field that will be shown if `show_url_field` is `true`.
103 |
104 | **google_captcha_site_key & google_captcha_secret_key:**
105 | If you'd like to block out the robots, set up a Google Captcha instance:
106 |
107 | Do so here - http://www.google.com/recaptcha/admin. Be sure to configure it with the reCAPTCHA v2 `"I'm not a robot" Checkbox`. Then copy the site_key and secret_key into these config variables and PointlessFeedback will handle the rest!
108 |
109 | #### Airtable Configuration
110 |
111 | **airtable_api_key:**
112 | Self explanatory, required if you want to export submitted feedback contents into an Airtable database.
113 |
114 | **airtable_app_key:**
115 | Self explanatory
116 |
117 | **airtable_table_name:**
118 | Self explanatory
119 |
120 | ## Customization
121 |
122 | Pointless Feedback provides you with a simple setup that should cover most
123 | cases. However, certain things are customizable to suit your app's needs.
124 |
125 | #### Views
126 |
127 | Since Pointless Feedback is an engine, all its views are packaged inside the
128 | gem. These views will help you get started, but after some time you may want
129 | to change them. If this is the case, you just need to invoke the following
130 | generator, and it will copy all views to your application:
131 |
132 | ```
133 | bundle exec rails generate pointless_feedback:views
134 | ```
135 |
136 | After doing so, you will find the views at `app/views/pointless_feedback/`
137 | within your application.
138 |
139 | **Note: Any url helpers used while on the feedback form page will need to prefaced with `main_app`.**
140 |
141 | #### I18n
142 |
143 | Most of the messaging in the Pointless Feedback engine uses I18n and can be
144 | customized within your respective localization file.
145 |
146 | To customize the flash notification upon successful submission, add the
147 | following to your `config/locales/en.yml` file:
148 |
149 | ```yml
150 | pointless_feedback:
151 | messages:
152 | saved: "Thanks for your feedback!"
153 | ```
154 |
155 | The error messages output defaults to the following:
156 |
157 | ```yml
158 | activerecord:
159 | errors:
160 | header: "Invalid Fields"
161 | message: "Correct the following errors and try again."
162 | ```
163 |
164 | To customize the subject of the feedback email, add the following to your
165 | `config/locales/en.yml` file as well:
166 |
167 | ```yml
168 | pointless_feedback:
169 | email:
170 | subject: "Pointless Feedback"
171 | ```
172 |
173 | #### Controllers
174 |
175 | You can overwrite `after_message_create_path` in your `ApplicationController`
176 | to customize your redirect hook.
177 |
178 | ## Development
179 |
180 | 1. Clone the repo: `git clone git://github.com/vigetlabs/pointless-feedback.git`
181 | 2. Install dependencies: `bundle install`
182 | 3. Setup databases: `bundle exec rake db:migrate && rake app:db:test:prepare`
183 | 4. Run the test suite: `bundle exec rake test`
184 | 5. Make your changes in a feature branch
185 | 6. Make sure the test suite passes before submitting a Pull Request
186 |
187 | ## Roadmap
188 |
189 | - [ ] Add service to send to Github
190 | - [ ] Add admin view for messages with comments
191 |
192 | ## Contributors
193 |
194 | * [@zporter](http://github.com/zporter)
195 | * [@efatsi](http://github.com/efatsi)
196 | * [@reagent](http://github.com/reagent)
197 |
198 | This project rocks and uses MIT-LICENSE.
199 |
200 | ***
201 |
202 |
203 | 
204 |
205 |
206 | Visit [code.viget.com](http://code.viget.com) to see more projects from [Viget.](https://viget.com)
207 |
--------------------------------------------------------------------------------
/Rakefile:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env rake
2 | begin
3 | require 'bundler/setup'
4 | rescue LoadError
5 | puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
6 | end
7 | begin
8 | require 'rdoc/task'
9 | rescue LoadError
10 | require 'rdoc/rdoc'
11 | require 'rake/rdoctask'
12 | RDoc::Task = Rake::RDocTask
13 | end
14 |
15 | RDoc::Task.new(:rdoc) do |rdoc|
16 | rdoc.rdoc_dir = 'rdoc'
17 | rdoc.title = 'PointlessFeedback'
18 | rdoc.options << '--line-numbers'
19 | rdoc.rdoc_files.include('README.rdoc')
20 | rdoc.rdoc_files.include('lib/**/*.rb')
21 | end
22 |
23 | APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
24 | load 'rails/tasks/engine.rake'
25 |
26 |
27 |
28 | Bundler::GemHelper.install_tasks
29 |
30 | require 'rake/testtask'
31 |
32 | Rake::TestTask.new(:test) do |t|
33 | t.libs << 'lib'
34 | t.libs << 'test'
35 | t.pattern = 'test/**/*_test.rb'
36 | t.verbose = false
37 | end
38 |
39 |
40 | task :default => :test
41 |
--------------------------------------------------------------------------------
/app/assets/images/pointless_feedback/.gitkeep:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vigetlabs/pointless-feedback/9b3363237b316e5fe0511c86624f71c3235f7ded/app/assets/images/pointless_feedback/.gitkeep
--------------------------------------------------------------------------------
/app/assets/javascripts/pointless_feedback/application.js:
--------------------------------------------------------------------------------
1 | // This is a manifest file that'll be compiled into application.js, which will include all the files
2 | // listed below.
3 | //
4 | // Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
5 | // or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
6 | //
7 | // It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
8 | // the compiled file.
9 | //
10 | // WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
11 | // GO AFTER THE REQUIRES BELOW.
12 | //
13 | //= require jquery
14 | //= require jquery_ujs
15 | //= require_tree .
16 |
--------------------------------------------------------------------------------
/app/assets/stylesheets/pointless_feedback/application.css:
--------------------------------------------------------------------------------
1 | /*
2 | * This is a manifest file that'll be compiled into application.css, which will include all the files
3 | * listed below.
4 | *
5 | * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
6 | * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
7 | *
8 | * You're free to add application-wide styles to this file and they'll appear at the top of the
9 | * compiled file, but it's generally better to create a new file per style scope.
10 | *
11 | *= require_self
12 | *= require_tree .
13 | */
14 |
--------------------------------------------------------------------------------
/app/controllers/pointless_feedback/messages_controller.rb:
--------------------------------------------------------------------------------
1 | module PointlessFeedback
2 | class MessagesController < PointlessFeedback.parent_controller.constantize
3 | helper PointlessFeedback::ApplicationHelper
4 |
5 | def new
6 | @message = Message.new
7 | end
8 |
9 | def create
10 | @message = Message.new(message_params)
11 |
12 | if pass_captcha? && @message.save
13 | flash[:notice] = I18n.t('pointless_feedback.messages.saved',
14 | :default => 'Thanks for your feedback!')
15 |
16 | redirect_to after_message_create_path
17 | else
18 | flash[:alert] = I18n.t('pointless_feedback.messages.invalid_captcha',
19 | :default => 'Are you a robot? Please check the box at the bottom of the page and try again.')
20 | render :new
21 | end
22 | end
23 |
24 | private
25 |
26 | def message_params
27 | params.require(:message).permit([
28 | :description,
29 | :email_address,
30 | :name,
31 | :topic,
32 | :contact_info,
33 | :url
34 | ])
35 | end
36 |
37 | def pass_captcha?
38 | if PointlessFeedback.using_captcha?
39 | PointlessFeedback::Captcha.pass?(params["g-recaptcha-response"])
40 | else
41 | true
42 | end
43 | end
44 | end
45 | end
46 |
--------------------------------------------------------------------------------
/app/helpers/pointless_feedback/application_helper.rb:
--------------------------------------------------------------------------------
1 | module PointlessFeedback
2 | module ApplicationHelper
3 | delegate :root_url, :root_path, :to => :main_app
4 |
5 | # Can search for named routes directly in the main app, omitting
6 | # the "main_app." prefix
7 | def method_missing(method, *args, &block)
8 | if main_app_url_helper?(method)
9 | main_app.send(method, *args)
10 | else
11 | super
12 | end
13 | end
14 |
15 | def respond_to_missing?(method, include_all)
16 | main_app_url_helper?(method) || super
17 | end
18 |
19 |
20 | private
21 |
22 | def main_app_url_helper?(method)
23 | /\A\w+(_path|_url)\z/ === method.to_s && main_app.respond_to?(method)
24 | end
25 | end
26 | end
27 |
--------------------------------------------------------------------------------
/app/mailers/pointless_feedback/feedback_mailer.rb:
--------------------------------------------------------------------------------
1 | module PointlessFeedback
2 | class FeedbackMailer < ActionMailer::Base
3 | def feedback(message)
4 | @message = message
5 |
6 | mail(:to => to_emails, :subject => feedback_subject, :from => from_address)
7 | end
8 |
9 | private
10 |
11 | def from_address
12 | if PointlessFeedback.send_from_submitter
13 | @message.email_address
14 | else
15 | PointlessFeedback.from_email
16 | end
17 | end
18 |
19 | def to_emails
20 | Array(PointlessFeedback.to_emails)
21 | end
22 |
23 | def feedback_subject
24 | I18n.t('pointless_feedback.email.subject', :default => 'Feedback')
25 | end
26 | end
27 | end
28 |
--------------------------------------------------------------------------------
/app/models/pointless_feedback/message.rb:
--------------------------------------------------------------------------------
1 | module PointlessFeedback
2 | class Message < ActiveRecord::Base
3 | if PointlessFeedback.table_name.present?
4 | self.table_name = PointlessFeedback.table_name
5 | end
6 |
7 | attr_accessor :contact_info
8 |
9 | validates :name, :email_address, :topic, :description, :presence => true
10 | validates :topic, :inclusion => PointlessFeedback.message_topics
11 | validates :email_address, :format => /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\z/i
12 | validate :is_not_spam
13 |
14 | after_save :export_feedback, :unless => :ignore_feedback?
15 |
16 | private
17 |
18 | def export_feedback
19 | if PointlessFeedback.email_feedback
20 | # Support Rails < 4.2 and >= 4.2 delivery options
21 | mailer = FeedbackMailer.feedback(self)
22 | mailer.respond_to?(:deliver_now) ? mailer.deliver_now : mailer.deliver
23 | end
24 |
25 | if PointlessFeedback.airtable_api_key
26 | feedback_table = Airrecord.table(
27 | PointlessFeedback.airtable_api_key,
28 | PointlessFeedback.airtable_app_key,
29 | PointlessFeedback.airtable_table_name
30 | )
31 |
32 | begin
33 | feedback_table.create(
34 | "Name" => name,
35 | "Email" => email_address,
36 | "Topic" => topic,
37 | "Description" => description,
38 | "Date" => created_at.strftime("%m/%d/%y"),
39 | "URL" => url
40 | )
41 | rescue => e
42 | # ignore errors in production, last thing you want is a 500
43 | # when someone's trying to complain about your site.
44 | raise(e) if Rails.env.development?
45 | end
46 | end
47 | end
48 |
49 | def ignore_feedback?
50 | honeypot_filled_in? || contains_invalid_words?
51 | end
52 |
53 | def honeypot_filled_in?
54 | contact_info.present?
55 | end
56 |
57 | def contains_invalid_words?
58 | PointlessFeedback.invalid_words.each do |word|
59 | if description.downcase.include? word.downcase
60 | return true
61 | end
62 | end
63 |
64 | false
65 | end
66 |
67 | def is_not_spam
68 | if URI.extract(description || "").count >= 3
69 | errors.add(:description, "can not contain more than 2 http links (often a sign of spam)")
70 | end
71 | end
72 | end
73 | end
74 |
--------------------------------------------------------------------------------
/app/views/layouts/pointless_feedback/application.html.erb:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | PointlessFeedback
5 | <%= stylesheet_link_tag "pointless_feedback/application", :media => "all" %>
6 | <%= javascript_include_tag "pointless_feedback/application" %>
7 | <%= csrf_meta_tags %>
8 |
9 |
10 |
11 | <%= yield %>
12 |
13 |
14 |
15 |
--------------------------------------------------------------------------------
/app/views/pointless_feedback/feedback_mailer/feedback.html.erb:
--------------------------------------------------------------------------------
1 | You've got feedback!
2 |
3 | Name: <%= @message.name %>
4 | Email Address: <%= @message.email_address %>
5 | Topic: <%= @message.topic %>
6 | <% if PointlessFeedback.show_url_field %>
7 | <%= PointlessFeedback.url_label %>: <%= @message.url %>
8 | <% end %>
9 | Description: <%= @message.description %>
10 |
--------------------------------------------------------------------------------
/app/views/pointless_feedback/messages/new.html.erb:
--------------------------------------------------------------------------------
1 | <% if PointlessFeedback.using_captcha? %>
2 |
3 |
4 |
5 | <% end %>
6 |
7 | <%= form_for @message do |f| %>
8 | <% if @message.errors.any? %>
9 |
10 |
11 | <%= I18n.t('activerecord.errors.header', :default => 'Invalid Fields') %>
12 |
13 |
14 |
15 | <%= I18n.t('activerecord.errors.message', :default => 'Correct the following errors and try again.') %>
16 |
17 |
18 |
19 | <% @message.errors.full_messages.each do |message| %>
20 | - <%= message.html_safe %>
21 | <% end %>
22 |
23 |
22 |
The page you were looking for doesn't exist.
23 |
You may have mistyped the address or the page may have moved.
24 |
22 |
The change you wanted was rejected.
23 |
Maybe you tried to change something you didn't have access to.
24 |
22 |
We're sorry, but something went wrong.
23 |
24 |
25 |
26 |
--------------------------------------------------------------------------------
/test/dummy/public/favicon.ico:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/vigetlabs/pointless-feedback/9b3363237b316e5fe0511c86624f71c3235f7ded/test/dummy/public/favicon.ico
--------------------------------------------------------------------------------
/test/dummy/script/rails:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env ruby
2 | # This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
3 |
4 | APP_PATH = File.expand_path('../../config/application', __FILE__)
5 | require File.expand_path('../../config/boot', __FILE__)
6 | require 'rails/commands'
7 |
--------------------------------------------------------------------------------
/test/factories/messages.rb:
--------------------------------------------------------------------------------
1 | FactoryGirl.define do
2 | factory :message, :class => PointlessFeedback::Message do
3 | name 'A Developer'
4 | email_address 'developer@pointlesscorp.com'
5 | description 'Site is broke'
6 | topic 'Other'
7 | url 'https://www.viget.com/'
8 | end
9 | end
10 |
--------------------------------------------------------------------------------
/test/functional/pointless_feedback/feedback_mailer_test.rb:
--------------------------------------------------------------------------------
1 | require 'test_helper'
2 |
3 | module PointlessFeedback
4 | class FeedbackMailerTest < ActionMailer::TestCase
5 | before do
6 | PointlessFeedback.to_emails = 'to@example.com'
7 |
8 | @message = FactoryGirl.create(:message)
9 | @mail = FeedbackMailer.feedback(@message)
10 | end
11 |
12 | test "feedback email" do
13 | assert_equal "Feedback", @mail.subject
14 | assert_equal ["to@example.com"], @mail.to
15 | assert_equal ["feedback@pointlesscorp.com"], @mail.from
16 | end
17 |
18 | test "feedback email body" do
19 | assert_match "You've got feedback!", @mail.body.encoded
20 | assert_match "Name: #{@message.name}", @mail.body.encoded
21 | assert_match "Email Address: #{@message.email_address}", @mail.body.encoded
22 | assert_match "Topic: #{@message.topic}", @mail.body.encoded
23 | assert_match "Description: #{@message.description}", @mail.body.encoded
24 | end
25 |
26 | test "feedback email body with URL field" do
27 | PointlessFeedback.show_url_field = true
28 | PointlessFeedback.url_label = "Story URL"
29 |
30 | assert_match "You've got feedback!", @mail.body.encoded
31 | assert_match "Name: #{@message.name}", @mail.body.encoded
32 | assert_match "Email Address: #{@message.email_address}", @mail.body.encoded
33 | assert_match "Topic: #{@message.topic}", @mail.body.encoded
34 | assert_match "Description: #{@message.description}", @mail.body.encoded
35 | assert_match "Story URL: #{@message.url}", @mail.body.encoded
36 | end
37 |
38 | test "feedback from email when set" do
39 | PointlessFeedback.from_email = 'from@example.com'
40 | @mail = FeedbackMailer.feedback(@message)
41 |
42 | assert_equal 'from@example.com', @mail.from.first
43 | end
44 |
45 | test "feedback from email when set as the sender" do
46 | PointlessFeedback.send_from_submitter = true
47 | @mail = FeedbackMailer.feedback(@message)
48 |
49 | assert_equal @message.email_address, @mail.from.first
50 | end
51 |
52 | end
53 | end
54 |
--------------------------------------------------------------------------------
/test/functional/pointless_feedback/messages_controller_test.rb:
--------------------------------------------------------------------------------
1 | require 'test_helper'
2 |
3 | module PointlessFeedback
4 | class MessagesControllerTest < ActionController::TestCase
5 | setup do
6 | @routes = Engine.routes
7 | end
8 |
9 | describe "getting new" do
10 | setup { get :new }
11 |
12 | it { assert_response :success }
13 | it { assert_template :new }
14 | it { assigns(:message).must_be_instance_of Message }
15 | end
16 |
17 | describe "posting to create" do
18 | setup do
19 | @valid_params = {
20 | :message => {
21 | :name => 'Some Guy',
22 | :email_address => 'some_guy@web.com',
23 | :topic => 'Other',
24 | :description => 'Yo website bork'
25 | }
26 | }
27 | end
28 |
29 | describe "with invalid params" do
30 | setup do
31 | post :create, @valid_params.merge(:message => { :name => ''})
32 | end
33 |
34 | it { assert_response :success }
35 | it { assert_template :new }
36 |
37 | it { assigns(:message).must_be :invalid? }
38 | end
39 |
40 | describe "with valid params" do
41 | describe "with default after_message_create_path" do
42 | setup do
43 | post :create, @valid_params
44 | end
45 |
46 | it { assert_response :redirect }
47 | it { assert_redirected_to '/' }
48 | it { flash[:notice].must_equal 'Thanks for your feedback!' }
49 | end
50 |
51 | describe "with overridden after_message_create_path" do
52 | setup do
53 | @controller.instance_eval "def after_message_create_path; '/dashboard'; end"
54 | post :create, @valid_params
55 | end
56 |
57 | it { assert_response :redirect }
58 | it { assert_redirected_to '/dashboard' }
59 | it { flash[:notice].must_equal 'Thanks for your feedback!' }
60 | end
61 | end
62 | end
63 | end
64 | end
65 |
--------------------------------------------------------------------------------
/test/generators/install_generator_test.rb:
--------------------------------------------------------------------------------
1 | require "test_helper"
2 | require "rails/generators/test_case"
3 | require "generators/pointless_feedback/install_generator"
4 |
5 | class InstallGeneratorTest < Rails::Generators::TestCase
6 | tests PointlessFeedback::Generators::InstallGenerator
7 | destination File.expand_path("../../tmp", __FILE__)
8 | setup :prepare_destination
9 |
10 | test "Assert all files are properly created" do
11 | run_generator
12 | assert_file "config/initializers/pointless_feedback.rb"
13 | end
14 | end
15 |
--------------------------------------------------------------------------------
/test/generators/views_generator_test.rb:
--------------------------------------------------------------------------------
1 | require "test_helper"
2 | require "rails/generators/test_case"
3 | require "generators/pointless_feedback/views_generator"
4 |
5 | class ViewsGeneratorTest < Rails::Generators::TestCase
6 | tests PointlessFeedback::Generators::ViewsGenerator
7 | destination File.expand_path("../../tmp", __FILE__)
8 | setup :prepare_destination
9 |
10 | test "Assert all views are properly created" do
11 | run_generator
12 | assert_file 'app/views/pointless_feedback/messages/new.html.erb'
13 | end
14 | end
15 |
--------------------------------------------------------------------------------
/test/integration/pointless_feedback/feedback_submission_test.rb:
--------------------------------------------------------------------------------
1 | require 'test_helper'
2 |
3 | class FeedbackSubmissionTest < ActionDispatch::IntegrationTest
4 | fixtures :all
5 |
6 | describe "submitting feedback" do
7 | before do
8 | visit "/pointless_feedback"
9 |
10 | fill_in_fields
11 |
12 | click_on "Submit"
13 | end
14 |
15 | test "redirects to the root path" do
16 | assert_equal current_path, "/"
17 | end
18 |
19 | test "thanks message is displayed" do
20 | within('body') do
21 | assert_match 'Thanks for your feedback!', text
22 | end
23 | end
24 | end
25 |
26 | describe "submitting feedback with the honeypot field filled in" do
27 | before do
28 | visit "/pointless_feedback"
29 |
30 | fill_in_fields
31 | fill_in "message_contact_info", :with => "I'm a spam bot!"
32 |
33 | click_on "Submit"
34 | end
35 |
36 | test "redirects to the root path" do
37 | assert_equal current_path, "/"
38 | end
39 |
40 | test "thanks message is displayed" do
41 | within('body') do
42 | assert_match 'Thanks for your feedback!', text
43 | end
44 | end
45 | end
46 |
47 | describe "submitting feedback with the invalid word in description" do
48 | before do
49 | PointlessFeedback.invalid_words = ['nymphomania']
50 |
51 | visit "/pointless_feedback"
52 |
53 | fill_in_fields
54 | fill_in "Description", :with => "I got nymphomania."
55 |
56 | click_on "Submit"
57 | end
58 |
59 | test "redirects to the root path" do
60 | assert_equal current_path, "/"
61 | end
62 |
63 | test "thanks message is displayed" do
64 | within('body') do
65 | assert_match 'Thanks for your feedback!', text
66 | end
67 | end
68 | end
69 |
70 | def fill_in_fields
71 | fill_in "Name", :with => "Eli"
72 | fill_in "Email address", :with => "eli@example.com"
73 | select "Other", :from => "Topic"
74 | fill_in "Description", :with => "This site is awful"
75 | end
76 |
77 | end
78 |
--------------------------------------------------------------------------------
/test/integration/pointless_feedback/main_app_root_url_test.rb:
--------------------------------------------------------------------------------
1 | require 'test_helper'
2 |
3 | class MainAppRootUrlTest < ActionDispatch::IntegrationTest
4 | test "root_url link points to main_app.root_url" do
5 | visit "/pointless_feedback"
6 |
7 | assert page.has_link?("Homepage", :href => current_host + "/")
8 | end
9 | end
10 |
--------------------------------------------------------------------------------
/test/pointless_feedback_test.rb:
--------------------------------------------------------------------------------
1 | require 'test_helper'
2 |
3 | class PointlessFeedbackTest < ActiveSupport::TestCase
4 | test "truth" do
5 | assert_kind_of Module, PointlessFeedback
6 | end
7 | end
8 |
--------------------------------------------------------------------------------
/test/test_helper.rb:
--------------------------------------------------------------------------------
1 | # Configure Rails Environment
2 | ENV["RAILS_ENV"] = "test"
3 |
4 | require File.expand_path("../dummy/config/environment.rb", __FILE__)
5 | require "rails/test_help"
6 | require "capybara/rails"
7 | require "factory_girl"
8 | require "test/unit"
9 | require "mocha/setup"
10 |
11 | require File.expand_path("../factories/messages.rb", __FILE__)
12 |
13 | Rails.backtrace_cleaner.remove_silencers!
14 |
15 | # Load support files
16 | Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
17 |
18 | # Load fixtures from the engine
19 | if ActiveSupport::TestCase.method_defined?(:fixture_path=)
20 | ActiveSupport::TestCase.fixture_path = File.expand_path("../fixtures", __FILE__)
21 | end
22 |
23 | class ActionDispatch::IntegrationTest
24 | # Make the Capybara DSL available in all integration tests
25 | include Capybara::DSL
26 | end
27 |
--------------------------------------------------------------------------------
/test/unit/helpers/pointless_feedback/application_helper_test.rb:
--------------------------------------------------------------------------------
1 | require 'test_helper'
2 |
3 | module PointlessFeedback
4 | class ApplicationHelperTest < ActionDispatch::IntegrationTest
5 | describe "main app's named routes" do
6 | class MainAppApplicationHelperMock
7 | def foo_path
8 | '/foo'
9 | end
10 |
11 | def foo_url
12 | 'http://host/foo'
13 | end
14 | end
15 |
16 | class PointlessFeedbackApplicationHelperMock
17 | include PointlessFeedback::ApplicationHelper
18 |
19 | def main_app
20 | MainAppApplicationHelperMock.new
21 | end
22 | end
23 |
24 | let(:raw_helper) { PointlessFeedbackApplicationHelperMock.new }
25 |
26 | it "outputs named path from the main app" do
27 | raw_helper.foo_path.must_equal '/foo'
28 | end
29 |
30 | it "outputs named url from the main app" do
31 | raw_helper.foo_url.must_equal 'http://host/foo'
32 | end
33 |
34 | it "raises exception with other routes" do
35 | proc{ raw_helper.lolwut_path }.must_raise NoMethodError
36 | end
37 | end
38 | end
39 | end
40 |
--------------------------------------------------------------------------------
/test/unit/pointless_feedback/captcha_test.rb:
--------------------------------------------------------------------------------
1 | require 'test_helper'
2 |
3 | module PointlessFeedback
4 | class CaptchaTest < ActiveSupport::TestCase
5 |
6 | describe ".pass?" do
7 | setup do
8 | PointlessFeedback.google_captcha_secret_key = "super-secret"
9 | @url = "https://www.google.com/recaptcha/api/siteverify"
10 | @body = {
11 | secret: "super-secret",
12 | response: "fake-response"
13 | }
14 | end
15 |
16 | teardown do
17 | PointlessFeedback.google_captcha_secret_key = nil
18 | @url = nil
19 | @body = nil
20 | end
21 |
22 | subject { PointlessFeedback::Captcha }
23 |
24 | it "returns true if Google response is true" do
25 | success = { "success" => true }
26 | response = stub(body: success.to_json)
27 |
28 | Typhoeus.expects(:post).with(@url, body: @body).returns(response)
29 |
30 | assert subject.pass?("fake-response")
31 | end
32 |
33 | it "returns false if Google response is true" do
34 | failure = { "success" => false }
35 | response = stub(body: failure.to_json)
36 |
37 | Typhoeus.expects(:post).with(@url, body: @body).returns(response)
38 |
39 | refute subject.pass?("fake-response")
40 | end
41 | end
42 |
43 | end
44 | end
45 |
--------------------------------------------------------------------------------
/test/unit/pointless_feedback/message_test.rb:
--------------------------------------------------------------------------------
1 | require 'test_helper'
2 |
3 | module PointlessFeedback
4 | class MessageTest < ActiveSupport::TestCase
5 | subject { PointlessFeedback::Message.new }
6 |
7 | %w(name email_address topic description).each do |field|
8 | it "requires #{field}" do
9 | subject.send("#{field}=", '')
10 | subject.save
11 |
12 | subject.errors[field.to_sym].must_include "can't be blank"
13 | end
14 | end
15 |
16 | describe "validating topics" do
17 | subject { FactoryGirl.build(:message) }
18 |
19 | it "allows valid topic" do
20 | subject.topic = 'Other'
21 |
22 | assert subject.valid?
23 | end
24 |
25 | it "does not allow invalid topic" do
26 | subject.topic = 'lolwut'
27 |
28 | assert subject.invalid?
29 | subject.errors[:topic].must_include "is not included in the list"
30 | end
31 | end
32 |
33 | describe "validating email" do
34 | subject { FactoryGirl.build(:message) }
35 |
36 | it "allows a valid email address" do
37 | subject.email_address = 'test@example.com'
38 |
39 | assert subject.valid?
40 | end
41 |
42 | it "does not allow invalid emails address" do
43 | subject.email_address = 'test@example'
44 | assert subject.invalid?
45 |
46 | subject.email_address = 'test.com'
47 | assert subject.invalid?
48 |
49 | subject.email_address = 'come on'
50 | assert subject.invalid?
51 | end
52 | end
53 |
54 | describe "validating against spam" do
55 | subject { FactoryGirl.build(:message) }
56 |
57 | it "allows descriptions with no links" do
58 | subject.description = "I have no links!"
59 |
60 | assert subject.valid?
61 | end
62 |
63 | it "does not allow descriptions with 3 or more links" do
64 | subject.description = 'CXYz73 kniuzeqqywrg, [url=http://kdvfwnevgkcq.com/]kdvfwnevgkcq[/url], [link=http://fibhlwzwvxjr.com/]fibhlwzwvxjr[/link], http://pebecsefhsmz.com/'
65 |
66 | assert subject.invalid?
67 | end
68 | end
69 |
70 | describe "export_feedback" do
71 | describe "when PointlessFeedback.email_feedback is true" do
72 | before do
73 | PointlessFeedback.email_feedback = true
74 | PointlessFeedback.to_emails = ['test1@example.com', 'test2@example.com']
75 | end
76 |
77 | subject { FactoryGirl.build(:message) }
78 |
79 | it "sends mail after create" do
80 | mailer = stub(:deliver_now => true)
81 | FeedbackMailer.expects(:feedback).with(subject).returns(mailer)
82 |
83 | subject.save
84 | end
85 |
86 | describe "when the honeypot field is not nil" do
87 | it "does not send mail after create" do
88 | subject.contact_info = "I'm a spam bot!"
89 | FeedbackMailer.expects(:feedback).never
90 |
91 | subject.save
92 | end
93 | end
94 |
95 | describe "when the description contains an invalid word" do
96 | it "does not send mail after create" do
97 | PointlessFeedback.invalid_words = ['nymphomania']
98 |
99 | subject.description = "I have nymphomania."
100 | FeedbackMailer.expects(:feedback).never
101 |
102 | subject.save
103 | end
104 | end
105 | end
106 |
107 | describe "when PointlessFeedback.email_feedback is false" do
108 | before do
109 | PointlessFeedback.email_feedback = false
110 | end
111 | subject { FactoryGirl.build(:message) }
112 |
113 | it "does not send any mail" do
114 | FeedbackMailer.expects(:feedback).times(0)
115 |
116 | subject.save
117 | end
118 | end
119 | end
120 | end
121 | end
122 |
--------------------------------------------------------------------------------