problem_child 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e282b0323f0d971146fde3f02147126f0438a506
-  data.tar.gz: 3b16247f802e2e3f03ce29f8ca6168fe155b9ddd
+  metadata.gz: bba9a9faf97164a454765c969947cdd01c0483f8
+  data.tar.gz: c6dc44c535d6cd7e83ccad88c078dfa593b82029
 SHA512:
-  metadata.gz: f9fea889ff77fccd9640e02f278ca3399a5ca00629773c1b3954f661ccc20af84c3e6505f79cf516904a5a32f1ca568025f80d1e4bb18c85509d271dbbbe4bda
-  data.tar.gz: 37edf7116f0aaa52c0e0e83dc073b1faf7621d72617d5581920a0308ea342cca047329145940be156324e1a241175da0accdd808d5373f8b8064e80c4b266ffe
+  metadata.gz: 9fb22eb689fc603aad6e6ca036bdf258faf5fbaf3ec7b167145f8ae89ad6ef0cb0a341eb36af97fb223a2b77c8873b6942d29f29a0452da04f230ad4fd46b542
+  data.tar.gz: cd2d71646e61d08cd32ab36a9aa5e5d65372a2f9338f96c3822423f3c240e73d2625475d04bed3a6b672b66aeb07f6bf8f1befea0f12a55be3aafdd30424f1a0

data/README.md

@@ -2,7 +2,7 @@
 
 Allows authenticated or anonymous users to fill out a standard web form to create GitHub issues.
 
-[![Build Status](https://travis-ci.org/benbalter/problem_child.svg)](https://travis-ci.org/benbalter/problem_child)
+[![Build Status](https://travis-ci.org/benbalter/problem_child.svg)](https://travis-ci.org/benbalter/problem_child) [![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy)
 
 ## How it works
 
@@ -14,11 +14,13 @@ Allows authenticated or anonymous users to fill out a standard web form to creat
 
 1. Create a `Gemfile` and add `gem "problem_child"`
 2. Create a `config.ru` file and add the following:
-  ```ruby
-  require "problem_child"
-  run ProblemChild::App
-  ```
-3. Follow the configuration options below
+
+```ruby
+require "problem_child"
+run ProblemChild::App
+```
+
+Then, follow the configuration options below.
 
 ## Requirements
 
@@ -41,13 +43,19 @@ You must also set **one** of the following:
 * `GITHUB_ORG_ID` - The GitHub Org ID e.g, `@whitehouse` if you'd like all users to authenticate against a GitHub Org prior to being presented the form
 * `GITHUB_TEAM_ID` - The numeric Team ID (e.g., 1234) if you'd like all users to authenticate against a GitHub Team prior to being presented the form
 
+You can also set a variable to enable Google reCAPTCHA support:
+
+* `REACAPTCHA_SITE_KEY` - The key created for your reCAPTCHA site via https://www.google.com/recaptcha/admin
+
+If set, the Problem child default form will include a bit of JavaScript to test if the reCAPTCHA test was passed before submitting.
+
 *Pro-tip*: When developing locally, you can add these values to a `.env` file in the project root, and they will be automatically read in on load
 
 ## Customizing
 
 By default, Problem Child will prompt the user with a simple form that contains only the title and body. If you'd like to customize the form, you must do the following:
 
-1. Create a new folder called `views`
+1. Create a new directory called `views`
 2. Create a `layout.erb` and `form.erb`
 3. Customize both the layout and form as a standard HTML form. Check out [these examples](lib/problem_child/views) to get started.
 4. Add the following (middle) line to your `config.ru` file:
@@ -73,9 +81,37 @@ or as a checkbox:
 <input type="checkbox" name="labels[]" value="suggestion" />
 ```
 
+*Pro-tip III*: Set the public directory
+
+By default Problem child points to an internal public directory which includes jQuery and Twitter Bootstrap. You can add them to your custom layout.erb:
+
+```html
+<link href="/vendor/bootstrap/dist/css/bootstrap.min.css" rel="stylesheet">
+
+<script src="/vender/jquery/dist/jquery.min.js"></script>
+```
+
+However, if you would like to add more files to your form app (e.g., favicon, custom CSS & JS files, etc.), you can redefine where the public directory points:
+
+```ruby
+require "problem_child"
+ProblemChild.views_dir = "/path/to/your/views/directory"
+ProblemChild.public_dir = Rails.public_path
+run ProblemChild::App
+```
+
+Note that you will lose access to the bundled jQuery & Bootstrap libraries and will have to put copies into your new public directory to use them.
+
 ## Creating pull requests
 
-Problem child can also be used to create pull requests. Simply add one or more file inputs to your form. The uploaded files will be committed to a newly created feature branch, and a pull request will be created against the repo's primary branch with the rest of the form content.
+Problem child can also be used to create pull requests. Simply add one or more file inputs to your form. The uploaded files will be committed to a newly created feature branch, and a pull request will be created against the repo's primary branch with the rest of the form content. You'll also want to change the form type to `enctype="multipart/form-data"`.
+
+```html
+<form method="post" enctype="multipart/form-data">
+  <input type="file" name="file" />
+  <input type="submit" />
+</form>
+```
 
 ## Contributing
 
@@ -84,3 +120,4 @@ Problem child can also be used to create pull requests. Simply add one or more f
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+

data/app.json

@@ -0,0 +1,34 @@
+{
+  "name": "Problem Child",
+  "description": "Allows authenticated or anonymous users to fill out a standard web form to creat GitHub issues.",
+  "repository": "https://github.com/benbalter/problem_child",
+  "addons": [
+    "heroku-redis:hobby-dev"
+  ],
+  "env": {
+    "GITHUB_CLIENT_ID": {
+      "description": "The ID of your GitHub OAuth application, created via https://github.com/settings/applications/new",
+      "required": "true"
+    },
+    "GITHUB_CLIENT_SECRET": {
+      "description": "The secret key of your GitHub OAuth application, created via https://github.com/settings/applications/new",
+      "required": "true"
+    },
+    "GITHUB_REPO": {
+      "description": "The repository against which to open issues submitted via Problem Child",
+      "required": "true"
+    },
+    "GITHUB_TOKEN": {
+      "description": "A personal access token for a bot account with the ability to create an issue in the GITHUB_REPO if you would like all submissions to be anonymous",
+      "required": "false"
+    },
+    "GITHUB_TEAM_ID": {
+      "description": "The GitHub Org ID e.g, @whitehouse if you'd like all users to authenticate against a GitHub Org prior to being presented the form",
+      "required": "false"
+    },
+    "GITHUB_ORG_ID": {
+      "description": "The numeric Team ID (e.g., 1234) if you'd like all users to authenticate against a GitHub Team prior to being presented the form",
+      "required": "false"
+    }
+  }
+}

data/lib/problem_child/helpers.rb

@@ -17,6 +17,10 @@ module ProblemChild
       end
     end
 
+    def recaptcha
+      ENV["RECAPTCHA_SITE_KEY"] unless ENV["RECAPTCHA_SITE_KEY"].nil? || ENV["RECAPTCHA_SITE_KEY"].to_s.empty?
+    end
+
     def client
       @client ||= Octokit::Client.new :access_token => token
     end
@@ -25,8 +29,16 @@ module ProblemChild
       halt erb template, :layout => :layout, :locals => locals.merge({ :template => template })
     end
 
+    def issue_title
+      form_data["title"]
+    end
+
     def issue_body
-      form_data.reject { |key, value| key == "title" || value.empty? || key == "labels" || value.is_a?(Hash) }.map { |key,value| "* **#{key.humanize}**: #{value}"}.join("\n")
+      form_data.reject { |key, value|
+        key == "title" || value.empty? || key == "labels" || value.is_a?(Hash)
+      }.except( "g-recaptcha-response" ).map { |key, value|
+        "* **#{key.humanize}**: #{value}"
+      }.join("\n")
     end
 
     # abstraction to allow cached form data to be used in place of default params

data/lib/problem_child/version.rb

@@ -1,3 +1,3 @@
 module ProblemChild
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

data/lib/problem_child/views/form.erb

@@ -5,12 +5,22 @@
 <% end %>
 </h1>
 
+<div class="alert alert-warning alert-recaptcha hidden" role="alert">
+  Please verify that you are not a robot.
+</div>
+
 <% if issue %>
   <div class="alert alert-success" role="alert">
     Your issue was successfully submitted<% if access %> as <a href="http://github.com/<%= repo %>/issues/<%= issue %>"><%= repo %>#<%= issue %></a><% end %>.
   </div>
 <% end %>
 
+<% if flash %>
+  <div class="alert alert-info" role="alert">
+    <%= flash %>
+  </div>
+<% end %>
+
 <form method="post">
   <div class="form-group">
     <label for="title">Title</label>
@@ -21,5 +31,9 @@
     <textarea class="form-control" rows="10" id="body" name="body"></textarea>
   </div>
 
+  <% if recaptcha.present? %>
+    <div class="g-recaptcha" data-sitekey="<%= recaptcha %>"></div>
+  <% end %>
+
   <button type="submit" class="btn btn-default">Submit</button>
 </form>

data/lib/problem_child/views/layout.erb

@@ -16,6 +16,13 @@
   <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
   <script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script>
   <![endif]-->
+
+  <% if recaptcha.present? %>
+    <script src='https://www.google.com/recaptcha/api.js'></script>
+  <% end %>
+
+  <script src='https://www.google.com/recaptcha/api.js'></script>
+
 </head>
 <body>
   <div class="container">
@@ -23,5 +30,25 @@
     <%= yield %>
 
   </div>
+
+  <% if recaptcha.present? %>
+    <script src="/vendor/jquery/dist/jquery.min.js"></script>
+
+    <script>
+  $( 'form' ).submit( function( e ) {
+    var prevent = false;
+
+    if ( !grecaptcha.getResponse() ) {
+      $( '.alert-recaptcha' ).removeClass( 'hidden' );
+      prevent = true;
+    }
+
+    if ( prevent ) {
+      e.preventDefault();
+      return false;
+    }
+  } );
+    </script>
+  <% end %>
 </body>
 </html>

data/lib/problem_child.rb

@@ -24,6 +24,14 @@ module ProblemChild
     @views_dir = dir
   end
 
+  def self.public_dir
+    @public_dir ||= File.expand_path "public", ProblemChild.root
+  end
+
+  def self.public_dir=(dir)
+    @public_dir = dir
+  end
+
   class App < Sinatra::Base
 
     include ProblemChild::Helpers
@@ -44,19 +52,26 @@ module ProblemChild
 
     set :views, Proc.new { ProblemChild.views_dir }
     set :root,  Proc.new { ProblemChild.root }
-    set :public_folder, Proc.new { File.expand_path "public", ProblemChild.root }
+    set :public_folder, Proc.new { ProblemChild.public_dir }
 
     get "/" do
+      flash = nil
+      issue = nil
+      access = false
+
       if session[:form_data]
-        issue = uploads.empty? ? create_issue : create_pull_request
-        session[:form_data] = nil
-        access = repo_access?
+        if issue_title.empty?
+          flash = 'Please enter a title.'
+        else
+          issue = uploads.empty? ? create_issue : create_pull_request
+          session[:form_data] = nil
+          access = repo_access?
+        end
       else
-        issue = nil
-        access = false
         auth!
       end
-      halt erb :form, :layout => :layout, :locals => { :repo => repo, :anonymous => anonymous_submissions?, :issue => issue, :access => access }
+
+      halt erb :form, :layout => :layout, :locals => { :repo => repo, :anonymous => anonymous_submissions?, :flash => flash, :issue => issue, :access => access }
     end
 
     post "/" do

data/problem_child.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "rack-ssl-enforcer", "~> 0.2"
   spec.add_dependency "sinatra_auth_github", "~> 1.0"
   spec.add_dependency "activesupport", "~> 4.2"
-  spec.add_dependency "rack", "1.5.2"
+  spec.add_dependency "rack", "1.6"
   spec.add_dependency "redis", "~> 3.2"
   spec.add_dependency "moneta", "~> 0.8"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: problem_child
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Ben Balter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-29 00:00:00.000000000 Z
+date: 2015-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.5.2
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.5.2
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
@@ -249,6 +249,7 @@ files:
 - Procfile
 - README.md
 - Rakefile
+- app.json
 - bower.json
 - config.ru
 - lib/problem_child.rb
@@ -329,7 +330,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.3
+rubygems_version: 2.5.0
 signing_key: 
 specification_version: 4
 summary: Allows authenticated or anonymous users to fill out a standard web form to
@@ -339,3 +340,4 @@ test_files:
 - spec/problem_child_helpers_spec.rb
 - spec/problem_child_spec.rb
 - spec/spec_helper.rb
+has_rdoc: