problem_child 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6b194f981f4da29f466015a0147e28f2ea7f98fe
-  data.tar.gz: a8fca157ebe6c7718ba59b46692c63d103c690ab
+  metadata.gz: e282b0323f0d971146fde3f02147126f0438a506
+  data.tar.gz: 3b16247f802e2e3f03ce29f8ca6168fe155b9ddd
 SHA512:
-  metadata.gz: b1202f58aef1959d41fb1cba180e127e389ddf26148af0ef42ac53036f18abf3eb64ed7a8c9d21cca833baf8f5e9e04143192921500f493fa03b865a272670f4
-  data.tar.gz: b472d792040dd8e939461402c16ca3e3bd4a40b9258734e62846440c2e4c5f087f42873bd09e78601bd2d987a552898e68c5f37680ad144de56fc350a27888bf
+  metadata.gz: f9fea889ff77fccd9640e02f278ca3399a5ca00629773c1b3954f661ccc20af84c3e6505f79cf516904a5a32f1ca568025f80d1e4bb18c85509d271dbbbe4bda
+  data.tar.gz: 37edf7116f0aaa52c0e0e83dc073b1faf7621d72617d5581920a0308ea342cca047329145940be156324e1a241175da0accdd808d5373f8b8064e80c4b266ffe

data/.travis.yml

@@ -7,8 +7,8 @@ rvm:
 sudo: false
 cache: bundler
 services:
-  - memcached
-  
+  - redis
+
 env:
   global:
     GITHUB_CLIENT_ID: "1234"

data/README.md

@@ -22,11 +22,11 @@ Allows authenticated or anonymous users to fill out a standard web form to creat
 
 ## Requirements
 
-You'll need to have [Memcache](http://memcached.org/) running.
+You'll need to have [Redis](http://redis.io/) running.
 
-On OS X, run `brew install memcached` to install, followed by `memcached` to run the memcache server.
+On OS X, run `brew install redis` to install, followed by `redis-server` to run the redis server.
 
-On Heroku you'll want to run `heroku addons:add memcachier:dev` to add a free Memecache instance to your app.
+On Heroku you'll want to run `heroku addons:create heroku-redis:hobby-dev` to add a free Redis instance to your app.
 
 ## Configuring
 
@@ -73,6 +73,10 @@ or as a checkbox:
 <input type="checkbox" name="labels[]" value="suggestion" />
 ```
 
+## 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.
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/problem_child/fork )

data/lib/problem_child/helpers.rb

@@ -26,7 +26,7 @@ module ProblemChild
     end
 
     def issue_body
-      form_data.reject { |key, value| key == "title" || value.empty? || key == "labels" }.map { |key,value| "* **#{key.humanize}**: #{value}"}.join("\n")
+      form_data.reject { |key, value| key == "title" || value.empty? || key == "labels" || value.is_a?(Hash) }.map { |key,value| "* **#{key.humanize}**: #{value}"}.join("\n")
     end
 
     # abstraction to allow cached form data to be used in place of default params
@@ -38,11 +38,71 @@ module ProblemChild
       form_data["labels"].join(",") if form_data["labels"]
     end
 
+    def uploads
+      form_data.select do |key, value|
+        value.is_a?(Hash) && ( value.has_key?("filename") || value.has_key?(:filename) )
+      end
+    end
+
     def create_issue
       issue = client.create_issue(repo, form_data["title"], issue_body, :labels => labels)
       issue["number"] if issue
     end
 
+    # Returns array of Octokit branch objects
+    def branches
+      client.branches(repo)
+    end
+
+    # Head SHA of default branch, used for creating new branches
+    def base_sha
+      default_branch = client.repo(repo)[:default_branch]
+      branches.find { |branch| branch[:name] == default_branch }[:commit][:sha]
+    end
+
+    def branch_exists?(branch)
+      branches.any? { |b| b.name == branch }
+    end
+
+    # Name of branch to submit pull request from
+    # Starts with patch-1 and keeps going until it finds one not taken
+    def patch_branch
+      num = 1
+      branch_name = form_data["title"].parameterize
+      return branch_name unless branch_exists?(branch_name)
+      branch = "#{branch_name}-#{num}"
+      while branch_exists?(branch) do
+        num = num + 1
+        branch = "#{branch_name}-#{num}"
+      end
+      branch
+    end
+
+    # Create a branch with the given name, based off of HEAD of the defautl branch
+    def create_branch(branch)
+      client.create_ref repo, "heads/#{branch}", base_sha
+    end
+
+    # Create a pull request with the form contents
+    def create_pull_request
+      unless uploads.empty?
+        branch = patch_branch
+        create_branch(branch)
+        uploads.each do |key, upload|
+          client.create_contents(
+            repo,
+            upload["filename"],
+            "Create #{upload["filename"]}",
+            session["file_#{key}"],
+            :branch => branch
+          )
+          session["file_#{key}"] = nil
+        end
+      end
+      pr = client.create_pull_request(repo, "master", branch, form_data["title"], issue_body, :labels => labels)
+      pr["number"] if pr
+    end
+
     def repo_access?
       return true unless anonymous_submissions?
       !client.repository(repo)["private"]
@@ -50,6 +110,13 @@ module ProblemChild
       false
     end
 
+    def cache_form_data
+      uploads.each do |key, upload|
+        session["file_#{key}"] = File.open(upload[:tempfile]).read
+      end
+      session[:form_data] = params.to_json
+    end
+
     def auth!
       if anonymous_submissions?
         true

data/lib/problem_child/version.rb

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

data/lib/problem_child/views/form.erb

@@ -20,6 +20,6 @@
     <label for="body">Body</label>
     <textarea class="form-control" rows="10" id="body" name="body"></textarea>
   </div>
-  
+
   <button type="submit" class="btn btn-default">Submit</button>
 </form>

data/lib/problem_child.rb

@@ -3,13 +3,12 @@ require 'sinatra'
 require 'sinatra_auth_github'
 require 'dotenv'
 require 'json'
-require 'dalli'
-require 'rack/session/dalli'
+require 'redis'
+require 'rack/session/moneta'
 require 'active_support'
 require 'active_support/core_ext/string'
 require "problem_child/version"
 require "problem_child/helpers"
-require "problem_child/memcache"
 
 module ProblemChild
 
@@ -29,35 +28,27 @@ module ProblemChild
 
     include ProblemChild::Helpers
 
-    configure do
-      use Rack::Session::Dalli, cache: ProblemChild::Memcache.client
-    end
-
     set :github_options, {
       :scopes => "repo,read:org"
     }
 
-    ENV['WARDEN_GITHUB_VERIFIER_SECRET'] ||= SecureRandom.hex
-    register Sinatra::Auth::Github
-
-    enable :sessions
-    use Rack::Session::Cookie, {
-      :http_only => true,
-      :secret    => ENV['SESSION_SECRET'] || SecureRandom.hex
-    }
+    use Rack::Session::Moneta, store: :Redis, url: ENV["REDIS_URL"]
 
     configure :production do
       require 'rack-ssl-enforcer'
       use Rack::SslEnforcer
     end
 
+    ENV['WARDEN_GITHUB_VERIFIER_SECRET'] ||= SecureRandom.hex
+    register Sinatra::Auth::Github
+
     set :views, Proc.new { ProblemChild.views_dir }
     set :root,  Proc.new { ProblemChild.root }
     set :public_folder, Proc.new { File.expand_path "public", ProblemChild.root }
 
     get "/" do
       if session[:form_data]
-        issue = create_issue
+        issue = uploads.empty? ? create_issue : create_pull_request
         session[:form_data] = nil
         access = repo_access?
       else
@@ -69,7 +60,7 @@ module ProblemChild
     end
 
     post "/" do
-      session[:form_data] = params.to_json
+      cache_form_data
       auth! unless anonymous_submissions?
       halt redirect "/"
     end

data/problem_child.gemspec

@@ -24,7 +24,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency "sinatra_auth_github", "~> 1.0"
   spec.add_dependency "activesupport", "~> 4.2"
   spec.add_dependency "rack", "1.5.2"
-  spec.add_dependency "dalli", "~> 2.7"
+  spec.add_dependency "redis", "~> 3.2"
+  spec.add_dependency "moneta", "~> 0.8"
 
   spec.add_development_dependency "rspec", "~> 3.1"
   spec.add_development_dependency "rack-test", "~> 0.6"

data/spec/fixtures/file.txt

@@ -0,0 +1 @@
+FOO

data/spec/problem_child_helpers_spec.rb

@@ -57,6 +57,12 @@ describe "ProblemChild::Helpers" do
     end
   end
 
+  it "caches the form data" do
+    @helper.params = {"title" => "title", "foo" => "bar"}
+    @helper.cache_form_data
+    expect(@helper.form_data["foo"]).to eql("bar")
+  end
+
   it "grabs the form data from the session" do
     expected = {"title" => "title", "foo" => "bar"}
     @helper.session["form_data"] = expected.to_json
@@ -127,4 +133,124 @@ describe "ProblemChild::Helpers" do
     @helper.params["labels"] = ["foo", "bar"]
     expect(@helper.labels).to eql("foo,bar")
   end
+
+  context "uploads" do
+    it "can identify uploads" do
+      @helper.params = {"title" => "title", "file" => { :filename => "foo.md"} }
+      expect(@helper.uploads.first[0]).to eql("file")
+    end
+
+    it "fetches the branches" do
+      stub_request(:get, "https://api.github.com/repos/benbalter/test-repo-ignore-me/branches").
+         to_return(:status => 200, :body => [{ :name => "master", :commit => { :sha => "1" } }])
+
+      with_env "GITHUB_TOKEN", "1234" do
+        with_env "GITHUB_REPO", "benbalter/test-repo-ignore-me" do
+          expect(@helper.branches[0][:name]).to eql("master")
+        end
+      end
+    end
+
+    it "fetches the base sha" do
+      stub_request(:get, "https://api.github.com/repos/benbalter/test-repo-ignore-me/branches").
+         to_return(:status => 200, :body => [{ :name => "master", :commit => { :sha => "123" } }])
+
+         stub_request(:get, "https://api.github.com/repos/benbalter/test-repo-ignore-me").
+            to_return(:status => 200, :body => {:default_branch => "master"}.to_json,
+            :headers => { "Content-Type" => "application/json" })
+
+      with_env "GITHUB_TOKEN", "1234" do
+        with_env "GITHUB_REPO", "benbalter/test-repo-ignore-me" do
+          expect(@helper.base_sha).to eql("123")
+        end
+      end
+    end
+
+    it "knows if a branch exists" do
+      stub_request(:get, "https://api.github.com/repos/benbalter/test-repo-ignore-me/branches").
+         to_return(:status => 200, :body => [{ :name => "master", :commit => { :sha => "123" } }].to_json,
+         :headers => { "Content-Type" => "application/json" })
+
+      with_env "GITHUB_TOKEN", "1234" do
+        with_env "GITHUB_REPO", "benbalter/test-repo-ignore-me" do
+          expect(@helper.branch_exists?("master")).to eql(true)
+          expect(@helper.branch_exists?("master2")).to eql(false)
+        end
+      end
+    end
+
+    it "creates the branch name" do
+      stub_request(:get, "https://api.github.com/repos/benbalter/test-repo-ignore-me/branches").
+         to_return(:status => 200, :body => [{ :name => "master", :commit => { :sha => "123" } }].to_json,
+         :headers => { "Content-Type" => "application/json" })
+
+      with_env "GITHUB_TOKEN", "1234" do
+        with_env "GITHUB_REPO", "benbalter/test-repo-ignore-me" do
+          @helper.params = {"title" => "My title" }
+          expect(@helper.patch_branch).to eql("my-title")
+
+          @helper.params = {"title" => "master" }
+          expect(@helper.patch_branch).to eql("master-1")
+        end
+      end
+    end
+
+    it "creates a branch" do
+      stub_request(:get, "https://api.github.com/repos/benbalter/test-repo-ignore-me").
+         to_return(:status => 200, :body => {:default_branch => "master"}.to_json,
+         :headers => { "Content-Type" => "application/json" })
+
+       stub_request(:get, "https://api.github.com/repos/benbalter/test-repo-ignore-me/branches").
+          to_return(:status => 200, :body => [{ :name => "master", :commit => { :sha => "123" } }].to_json,
+          :headers => { "Content-Type" => "application/json" })
+
+      stub = stub_request(:post, "https://api.github.com/repos/benbalter/test-repo-ignore-me/git/refs").
+         with(:body => "{\"ref\":\"refs/heads/my-branch\",\"sha\":\"123\"}")
+
+      with_env "GITHUB_TOKEN", "1234" do
+        with_env "GITHUB_REPO", "benbalter/test-repo-ignore-me" do
+          @helper.create_branch("my-branch")
+          expect(stub).to have_been_requested
+        end
+      end
+    end
+
+    it "caches uploads" do
+      path = File.expand_path "./fixtures/file.txt", File.dirname(__FILE__)
+      @helper.params = { "title" => "title", "some_file" => { :filename => "file.txt", :tempfile => path } }
+      @helper.cache_form_data
+      expect(@helper.session["file_some_file"]).to eql("FOO\n")
+    end
+
+    it "creates the pull request" do
+      stub_request(:get, "https://api.github.com/repos/benbalter/test-repo-ignore-me").
+         to_return(:status => 200, :body => {:default_branch => "master"}.to_json,
+         :headers => { "Content-Type" => "application/json" })
+
+       stub_request(:get, "https://api.github.com/repos/benbalter/test-repo-ignore-me/branches").
+          to_return(:status => 200, :body => [{ :name => "master", :commit => { :sha => "123" } }].to_json,
+          :headers => { "Content-Type" => "application/json" })
+
+      stub_request(:post, "https://api.github.com/repos/benbalter/test-repo-ignore-me/git/refs").
+         with(:body => "{\"ref\":\"refs/heads/title\",\"sha\":\"123\"}").
+         to_return(:status => 200)
+
+      push = stub_request(:put, "https://api.github.com/repos/benbalter/test-repo-ignore-me/contents/").
+         with(:body => "{\"branch\":\"title\",\"content\":\"Rk9PCg==\",\"message\":\"Create \"}")
+
+      pr = stub_request(:post, "https://api.github.com/repos/benbalter/test-repo-ignore-me/pulls").
+         with(:body => "{\"labels\":null,\"base\":\"master\",\"head\":\"title\",\"title\":\"title\",\"body\":\"* **Foo**: bar\"}")
+         
+      with_env "GITHUB_TOKEN", "1234" do
+        with_env "GITHUB_REPO", "benbalter/test-repo-ignore-me" do
+          path = File.expand_path "./fixtures/file.txt", File.dirname(__FILE__)
+          @helper.params = { "title" => "title", "some_file" => { :filename => "file.txt", :tempfile => path }, "foo" => "bar" }
+          @helper.cache_form_data
+          @helper.create_pull_request
+          expect(push).to have_been_requested
+          expect(pr).to have_been_requested
+        end
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: problem_child
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Ben Balter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-26 00:00:00.000000000 Z
+date: 2015-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -109,19 +109,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.5.2
 - !ruby/object:Gem::Dependency
-  name: dalli
+  name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: moneta
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -239,7 +253,6 @@ files:
 - config.ru
 - lib/problem_child.rb
 - lib/problem_child/helpers.rb
-- lib/problem_child/memcache.rb
 - lib/problem_child/public/vendor/bootstrap/.bower.json
 - lib/problem_child/public/vendor/bootstrap/Gruntfile.js
 - lib/problem_child/public/vendor/bootstrap/LICENSE
@@ -292,8 +305,8 @@ files:
 - script/console
 - script/release
 - script/server
+- spec/fixtures/file.txt
 - spec/problem_child_helpers_spec.rb
-- spec/problem_child_memcache_spec.rb
 - spec/problem_child_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/benbalter/problem_child
@@ -316,13 +329,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.3
 signing_key: 
 specification_version: 4
 summary: Allows authenticated or anonymous users to fill out a standard web form to
   creat GitHub issues.
 test_files:
+- spec/fixtures/file.txt
 - spec/problem_child_helpers_spec.rb
-- spec/problem_child_memcache_spec.rb
 - spec/problem_child_spec.rb
 - spec/spec_helper.rb

data/lib/problem_child/memcache.rb

@@ -1,22 +0,0 @@
-module ProblemChild
-  class Memcache
-
-    def self.client
-      Dalli::Client.new(server, options)
-    end
-
-    def self.options
-      {
-       :username => ENV["MEMCACHIER_USERNAME"],
-       :password => ENV["MEMCACHIER_PASSWORD"],
-       :failover => true,
-       :socket_timeout => 1.5,
-       :socket_failure_delay => 0.2
-      }
-    end
-
-    def self.server
-      ENV["MEMCACHIER_SERVERS"].split(",") unless ENV["MEMCACHIER_SERVERS"].to_s.blank?
-    end
-  end
-end

data/spec/problem_child_memcache_spec.rb

@@ -1,35 +0,0 @@
-require "spec_helper"
-
-describe "ProblemChild::MemcacheHelper" do
-
-  it "knows the server" do
-    with_env "MEMCACHIER_SERVERS", "localhost:1234" do
-      expect(ProblemChild::Memcache.server).to eql(["localhost:1234"])
-    end
-  end
-
-  it "can process multiple servers" do
-    with_env "MEMCACHIER_SERVERS", "localhost:1234, localhost:4567" do
-      expect(ProblemChild::Memcache.server).to eql(["localhost:1234", " localhost:4567"])
-    end
-  end
-
-  it "pulls the username and password" do
-    with_env "MEMCACHIER_USERNAME", "user" do
-      with_env "MEMCACHIER_PASSWORD", "pass" do
-        expected = {
-                     :username => "user",
-                     :password => "pass",
-                     :failover => true,
-                     :socket_timeout => 1.5,
-                     :socket_failure_delay => 0.2
-                   }
-        expect(ProblemChild::Memcache.options).to eql(expected)
-      end
-    end
-  end
-
-  it "returns the client" do
-    expect(ProblemChild::Memcache.client.class).to eql(Dalli::Client)
-  end
-end