problem_child 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 89ffeb15ad0f753317aaa3f2f19dd64e94972443
-  data.tar.gz: 179d480027eed558ae74e810c1c700efc4ee414f
+  metadata.gz: 57eaad2eea8f2a2c3531c5e454eba665a65197e1
+  data.tar.gz: 97958f47536e64388b3fb9862dcfdeeb235b66fc
 SHA512:
-  metadata.gz: 223bef3364e7c6d68ddea4a314cb538a1bb378c502ab1725a06d5895b86e785af4bd52bdbb11bb8fa17db5291039c711a18da78ff8452989c84b56c4c086a406
-  data.tar.gz: cf47ab4bbf372e5280382e787f00c17bf87d0b60fde4dd2046737121fb3ec148709dc7d6b26ca79d172ec0ed31876a2d2b76f9534079d9054ba1b3c345beff36
+  metadata.gz: ff66d7eadeff9293a116e1ec1472d259670871ee7cbd2ff761046fc0e7318999504935b95c3fd05f90946fb62e1aa702a2e9098a1c4dd1708cca9fc208eb2b89
+  data.tar.gz: bcbdb1d8839888435faa0a78352682526542eb06e91e1409637fb09b60742cb763b8562506cf8d75f83c52df131f22c3155b7062689d3c9e54e80b4e7add05d8

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+script: "./script/cibuild"
+
+rvm:
+  - 2.1
+
+sudo: false
+cache: bundler
+
+env:
+  global:
+    GITHUB_CLIENT_ID: "1234"
+    GITHUB_CLIENT_SECRET: "1234"

data/README.md

@@ -2,6 +2,8 @@
 
 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)
+
 ## How it works
 
 1. You create a standard HTML form, defining what fields you'd like a given authenticated or anonymous user to fill out

data/Rakefile

@@ -1,8 +1,8 @@
 require "bundler/gem_tasks"
-require 'rake/testtask'
+require 'rspec/core/rake_task'
 
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_problem_child*.rb'
-  test.verbose = true
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.rspec_opts = ["--order", "rand", "--color"]
 end

data/lib/problem_child/helpers.rb

@@ -0,0 +1,54 @@
+module ProblemChild
+  module Helpers
+
+    def repo
+      ENV["GITHUB_REPO"]
+    end
+
+    def anonymous_submissions?
+      !!(ENV["GITHUB_TOKEN"] && !ENV["GITHUB_TOKEN"].to_s.empty?)
+    end
+
+    def token
+      if anonymous_submissions?
+        ENV["GITHUB_TOKEN"]
+      elsif !github_user.nil?
+        github_user.token
+      end
+    end
+
+    def client
+      @client ||= Octokit::Client.new :access_token => token
+    end
+
+    def render_template(template, locals={})
+      halt erb template, :layout => :layout, :locals => locals.merge({ :template => template })
+    end
+
+    def issue_body
+      form_data.reject { |key, value| key == "title" || value.empty? }.map { |key,value| "* **#{key.humanize}**: #{value}"}.join("\n")
+    end
+
+    # abstraction to allow cached form data to be used in place of default params
+    def form_data
+      session["form_data"].nil? ? params : JSON.parse(session["form_data"])
+    end
+
+    def create_issue
+      client.create_issue(repo, form_data["title"], issue_body)
+    end
+
+    def auth!
+      if anonymous_submissions?
+        true
+      elsif ENV['GITHUB_TEAM_ID']
+        github_team_authenticate!(ENV['GITHUB_TEAM_ID'])
+      elsif ENV['GITHUB_ORG_ID']
+        github_organization_authenticate!(ENV['GITHUB_ORG_ID'])
+      else
+        raise "Must define GITHUB_TEAM_ID, GITHUB_ORG_ID, OR GITHUB_TOKEN"
+        halt 401
+      end
+    end
+  end
+end

data/lib/problem_child/version.rb

@@ -1,3 +1,3 @@
 module ProblemChild
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/problem_child.rb

@@ -6,6 +6,7 @@ require 'json'
 require 'active_support'
 require 'active_support/core_ext/string'
 require "problem_child/version"
+require "problem_child/helpers"
 
 module ProblemChild
 
@@ -23,16 +24,15 @@ module ProblemChild
 
   class App < Sinatra::Base
 
-    enable :sessions
+    include ProblemChild::Helpers
 
     set :github_options, {
-      :scopes    => "repo",
-      :secret    => ENV['GITHUB_CLIENT_SECRET'],
-      :client_id => ENV['GITHUB_CLIENT_ID'],
+      :scopes    => "repo"
     }
 
     register Sinatra::Auth::Github
 
+    enable :sessions
     use Rack::Session::Cookie, {
       :http_only => true,
       :secret    => SecureRandom.hex
@@ -44,63 +44,9 @@ module ProblemChild
     end
 
     set :views, Proc.new { ProblemChild.views_dir }
-    set :root, Proc.new { ProblemChild.root }
+    set :root,  Proc.new { ProblemChild.root }
     set :public_folder, Proc.new { File.expand_path "public", ProblemChild.root }
 
-    def repo
-      ENV["GITHUB_REPO"]
-    end
-
-    def user
-      env['warden'].user unless env['warden'].nil?
-    end
-
-    def anonymous_submissions?
-      ENV["GITHUB_TOKEN"] && !ENV["GITHUB_TOKEN"].empty?
-    end
-
-    def token
-      if anonymous_submissions?
-        ENV["GITHUB_TOKEN"]
-      elsif !user.nil?
-        user.token
-      end
-    end
-
-    def client
-      @client ||= Octokit::Client.new :access_token => token
-    end
-
-    def render_template(template, locals={})
-      halt erb template, :layout => :layout, :locals => locals.merge({ :template => template })
-    end
-
-    def issue_body
-      form_data.reject { |key, value| key == "title" || value.empty? }.map { |key,value| "* **#{key.humanize}**: #{value}"}.join("\n")
-    end
-
-    # abstraction to allow cached form data to be used in place of default params
-    def form_data
-      session["form_data"].nil? ? params : JSON.parse(session["form_data"])
-    end
-
-    def create_issue
-      client.create_issue(repo, form_data["title"], issue_body)
-    end
-
-    def auth!
-      if anonymous_submissions?
-        true
-      elsif ENV['GITHUB_TEAM_ID']
-        github_team_authenticate!(ENV['GITHUB_TEAM_ID'])
-      elsif ENV['GITHUB_ORG_ID']
-        github_organization_authenticate!(ENV['GITHUB_ORG_ID'])
-      else
-        raise "Must define GITHUB_TEAM_ID, GITHUB_ORG_ID, OR GITHUB_TOKEN"
-        halt 401
-      end
-    end
-
     get "/" do
       if session[:form_data]
         flash = :success if create_issue
@@ -113,12 +59,9 @@ module ProblemChild
     end
 
     post "/" do
-      if anonymous_submissions?
-        create_issue
-      else
-        session[:form_data] = params.to_json
-        auth!
-      end
+      session[:form_data] = params.to_json
+      auth! unless anonymous_submissions?      
+      halt redirect "/"
     end
   end
 end

data/problem_child.gemspec

@@ -25,6 +25,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency "activesupport", "~> 4.2"
   spec.add_dependency "rack", "1.5.2"
 
+  spec.add_development_dependency "rspec", "~> 3.1"
+  spec.add_development_dependency "rack-test", "~> 0.6"
+  spec.add_development_dependency "webmock", "~> 1.2 "
   spec.add_development_dependency "foreman", "~> 0.77"
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake", "~> 10.4"

data/script/cibuild

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+set -e
+bundle exec rake spec
+bundle exec gem build problem_child.gemspec

data/spec/problem_child_helpers_spec.rb

@@ -0,0 +1,93 @@
+require "spec_helper"
+
+describe "ProblemChild::Helpers" do
+
+  class TestHelper
+    include ProblemChild::Helpers
+
+    attr_accessor :session, :params
+
+    def initialize(path=nil)
+      @path = path
+    end
+
+    def request
+      Rack::Request.new("PATH_INFO" => @path)
+    end
+  end
+
+  before(:each) do
+   @helper = TestHelper.new
+   @helper.session = {}
+   @helper.params = {}
+  end
+
+  it "knows the github repo" do
+    with_env "GITHUB_REPO", "foo/bar" do
+      expect(@helper.repo).to eql("foo/bar")
+    end
+  end
+
+  it "knows to allow anonymous submisssions when a token is passed" do
+    with_env "GITHUB_TOKEN", "asdf" do
+      expect(@helper.anonymous_submissions?).to be(true)
+    end
+  end
+
+  it "knows not to allow anonymous submisssions when no token is passed" do
+    with_env "GITHUB_TOKEN", "" do
+      expect(@helper.anonymous_submissions?).to be(false)
+    end
+
+    with_env "GITHUB_TOKEN", nil do
+      expect(@helper.anonymous_submissions?).to be(false)
+    end
+  end
+
+  it "uses a token if passed" do
+    with_env "GITHUB_TOKEN", "asdf" do
+      expect(@helper.token).to eql("asdf")
+    end
+  end
+
+  it "inits the octokit client" do
+    with_env "GITHUB_TOKEN", "asdf" do
+      expect(@helper.client.class).to eql(Octokit::Client)
+      expect(@helper.client.access_token).to eql("asdf")
+    end
+  end
+
+  it "grabs the form data from the session" do
+    expected = {"title" => "title", "foo" => "bar"}
+    @helper.session["form_data"] = expected.to_json
+    expect(@helper.form_data).to eql(expected)
+  end
+
+  it "grabs the form data when posted" do
+    expected = {"title" => "title", "foo" => "bar"}
+    @helper.params = expected
+    expect(@helper.form_data).to eql(expected)
+  end
+
+  it "builds the issue body" do
+    expected = {"title" => "title", "foo" => "bar"}
+    @helper.params = expected
+    expect(@helper.issue_body).to eql("* **Foo**: bar")
+  end
+
+  it "submits the issue" do
+    expected = {"title" => "title", "foo" => "bar"}
+    @helper.params = expected
+    with_env "GITHUB_TOKEN", "1234" do
+      with_env "GITHUB_REPO", "benbalter/test-repo-ignore-me" do
+
+        stub = stub_request(:post, "https://api.github.com/repos/benbalter/test-repo-ignore-me/issues").
+          with(:body => "{\"labels\":[],\"title\":\"title\",\"body\":\"* **Foo**: bar\"}").
+          to_return(:status => 200)
+
+        @helper.create_issue
+        expect(stub).to have_been_requested
+      end
+    end
+  end
+end

data/spec/problem_child_spec.rb

@@ -0,0 +1,140 @@
+require "spec_helper"
+
+describe "ProblemChild" do
+  it "knows the root" do
+   expected = File.expand_path "../lib/problem_child", File.dirname(__FILE__)
+   expect(ProblemChild.root).to eql(expected)
+  end
+
+  it "knows the views dir" do
+   expected = File.expand_path "../lib/problem_child/views", File.dirname(__FILE__)
+   expect(ProblemChild.views_dir).to eql(expected)
+  end
+
+  it "allows users to set the views dir" do
+   old = ProblemChild.views_dir
+   ProblemChild.views_dir = "./foo"
+   expect(ProblemChild.views_dir).to eql("./foo")
+   ProblemChild.views_dir = old
+  end
+end
+
+describe "logged in user" do
+
+  before(:each) do
+    @user = make_user('login' => 'benbaltertest')
+    login_as @user
+
+    ENV["GITHUB_TEAM_ID"] = nil
+    ENV["GITHUB_ORG_ID"]  = nil
+    ENV["GITHUB_TOKEN"]   = nil
+    ENV["GITHUB_REPO"]    = nil
+  end
+
+  include Rack::Test::Methods
+
+  def app
+    ProblemChild::App
+  end
+
+  it "shows the securocat when github returns an oauth error" do
+    with_env "GITHUB_ORG_ID", "balter-test-org" do
+      get "/auth/github/callback?error=redirect_uri_mismatch"
+      follow_redirect!
+      expect(last_response.body).to match(%r{securocat\.png})
+    end
+  end
+
+  it "shows the form when properly org auth'd" do
+    with_env "GITHUB_ORG_ID", "balter-test-org" do
+      stub_request(:get, "https://api.github.com/orgs/balter-test-org/members/benbaltertest").
+      to_return(:status => 204)
+
+      get "/"
+      expect(last_response.status).to eql(200)
+      expect(last_response.body).to match(/Submit an issue/)
+    end
+  end
+
+  it "shows the form when properly team auth'd" do
+    with_env "GITHUB_TEAM_ID", "1234" do
+      stub_request(:get, "https://api.github.com/teams/1234/members/benbaltertest").
+      to_return(:status => 204)
+
+      get "/"
+      expect(last_response.status).to eql(200)
+      expect(last_response.body).to match(/Submit an issue/)
+    end
+  end
+
+  it "refuses to show the site with no auth strategy" do
+    with_env "GITHUB_TEAM_ID", nil do
+      with_env "GITHUB_ORG_ID", nil do
+        with_env "GITHUB_TOKEN", nil do
+          expect{get "/"}.to raise_error(/Must define GITHUB_TEAM_ID, GITHUB_ORG_ID, OR GITHUB_TOKEN/)
+        end
+      end
+    end
+  end
+
+  it "allows the user to create an issue" do
+    with_env "GITHUB_ORG_ID", "balter-test-org" do
+      with_env "GITHUB_REPO", "benbalter/test-repo-ignore-me" do
+
+        stub_request(:get, "https://api.github.com/orgs/balter-test-org/members/benbaltertest").
+        to_return(:status => 204)
+
+        stub_request(:post, "https://api.github.com/repos/benbalter/test-repo-ignore-me/issues").
+          with(:body => "{\"labels\":[],\"title\":\"title\",\"body\":\"* **Foo**: bar\"}").
+          to_return(:status => 200)
+
+        post "/", :title => "title", :foo => "bar"
+        follow_redirect!
+
+        expect(last_response.status).to eql(200)
+        expect(last_response.body).to match(/Your issue was successfully submitted/)
+      end
+    end
+  end
+end
+
+describe "logged out user" do
+  include Rack::Test::Methods
+
+  def app
+    ProblemChild::App
+  end
+
+  it "asks the user to log in" do
+    with_env "GITHUB_ORG_ID", "balter-test-org" do
+      get "/"
+      expect(last_response.status).to eql(302)
+      expect(last_response.headers['Location']).to match(%r{^https://github\.com/login/oauth/authorize})
+    end
+  end
+
+  it "allows anonymous users to see the form" do
+    with_env "GITHUB_TOKEN", "1234" do
+      get "/"
+      expect(last_response.status).to eql(200)
+      expect(last_response.body).to match(/Submit an issue/)
+    end
+  end
+
+  it "allows anonymous submissions" do
+    with_env "GITHUB_TOKEN", "1234" do
+      with_env "GITHUB_REPO", "benbalter/test-repo-ignore-me" do
+
+        stub_request(:post, "https://api.github.com/repos/benbalter/test-repo-ignore-me/issues").
+          with(:body => "{\"labels\":[],\"title\":\"title\",\"body\":\"* **Foo**: bar\"}").
+          to_return(:status => 200)
+
+        post "/", :title => "title", :foo => "bar"
+        follow_redirect!
+
+        expect(last_response.status).to eql(200)
+        expect(last_response.body).to match(/Your issue was successfully submitted/)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+require "bundler/setup"
+
+ENV['RACK_ENV'] = 'test'
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'rack/test'
+require 'sinatra/auth/github'
+require 'sinatra/auth/github/test/test_helper'
+require 'webmock/rspec'
+
+require_relative "../lib/problem_child"
+WebMock.disable_net_connect!
+
+RSpec.configure do |config|
+  config.include(Sinatra::Auth::Github::Test::Helper)
+end
+
+def with_env(key, value)
+  old_env = ENV[key]
+  ENV[key] = value
+  yield
+  ENV[key] = old_env
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: problem_child
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Ben Balter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-09 00:00:00.000000000 Z
+date: 2015-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -108,6 +108,48 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.5.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: foreman
   requirement: !ruby/object:Gem::Requirement
@@ -173,6 +215,7 @@ extra_rdoc_files: []
 files:
 - ".bowerrc"
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - Procfile
@@ -181,6 +224,7 @@ files:
 - bower.json
 - config.ru
 - lib/problem_child.rb
+- lib/problem_child/helpers.rb
 - lib/problem_child/public/vendor/bootstrap/.bower.json
 - lib/problem_child/public/vendor/bootstrap/Gruntfile.js
 - lib/problem_child/public/vendor/bootstrap/LICENSE
@@ -229,9 +273,13 @@ files:
 - lib/problem_child/views/layout.erb
 - problem_child.gemspec
 - script/bootstrap
+- script/cibuild
 - script/console
 - script/release
 - script/server
+- spec/problem_child_helpers_spec.rb
+- spec/problem_child_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/benbalter/problem_child
 licenses:
 - MIT
@@ -257,4 +305,7 @@ signing_key:
 specification_version: 4
 summary: Allows authenticated or anonymous users to fill out a standard web form to
   creat GitHub issues.
-test_files: []
+test_files:
+- spec/problem_child_helpers_spec.rb
+- spec/problem_child_spec.rb
+- spec/spec_helper.rb