pivotal_reporter 0.7.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,101 @@
+Pivotal Reporter
+==============
+
+Pivotal Reporter is a Rails Mountable Engine that injects a reporting overlay for rails applications that ties into
+PivotalTracker in order to provide in-app bug reporting and feature requests.
+
+Installation
+============
+
+## Install the Gem
+
+    gem 'pivotal_reporter', :git => 'git://github.com/7eyesllc/pivotal_reporter.git'
+
+    bundle install
+
+## Set Up Route
+
+In routes.rb:
+
+```ruby
+    mount PivotalReporter::Engine => "/tracker" # can be mounted at whatever endpoint you want, not just /tracker
+```
+
+If you want to limit the engine to logged in users with devise then:
+
+```ruby
+authenticated :user do
+    mount PivotalReporter::Engine => "/tracker" # can be mounted at whatever endpoint you want, not just /tracker
+end
+```
+
+## Configure
+
+Add the top of the /config/application.rb:
+
+    require "pivotal_reporter"
+
+Inside the application class definition in /config/application.rb:
+
+```ruby
+PivotalReporter.config do |config|
+  config.token = '<your_api_token>'
+  config.project_id = <your_project_id>
+  config.mount_point = '/tracker'
+  config.request_user = '<your_request_user>'
+  config.enabled = true
+end
+```
+
+**API Token** can be found by visiting https://www.pivotaltracker.com/profile (logged in to your PivotalTracker account),
+then scrolling all the way to the bottom.
+
+**Project ID** is a large integer like `625931`. The idea behind this engine is that users can submit bugs and features
+to a specific PivotalTracker project that corresponds to the rails application into which the engine is mounted. To find
+your project ID, go to the project page in PivotalTracker and look at the url. The number in that URL is the Project ID.
+
+**Mount Point** should match the endpoint you specified in your routes file in the previous step
+
+**Request User** is the name of the PivotalTracker user under whom you will submit the bugs and features. The name is
+literally just a name like "Pete Michaud" and should correspond exactly to the name of a project member who has access
+to the project in PivotalTracker (otherwise the report submission will fail). Ideally this will be a generic "API user".
+
+Alternatively, you can choose not to specify a request_user. What happens in that case is PivotalReporter will look for a
+variable called current_user (the devise gem, for example, would define current_user), and it calls the full_name method
+on current_user. So instead of using "Pete Michaud" it would use `current_user.full_name`.
+
+The only way that will work is if:
+    1) You have authentication set up so that current_user.full_name is defined
+    2) All users who access the reporting tool are authenticated
+    3) All users of your application correspond to PivotalTracker users who have access to the PivotalTracker project
+    4) All those users use the exact same names across the application and PivotalTracker
+
+## Including the Widget
+
+At this point the engine is mounted and accessible via the endpoint you specified. But the idea here is that the
+reporting tool should be available at all times, on all pages. To make that happen:
+
+1) Add `//= require pivotal_reporter/report_button` to your application.js manifest
+
+2) Add `*= require pivotal_reporter/report_button` to your application.css manifest
+
+The button should now appear.
+
+## Customizing the Widget
+
+If you want to change the style of the widget, add these definitions to your application css files:
+
+```css
+a#pt_report_button { } /* The Report button itself */
+
+div#pivotal_reporter { } /* The frame that appears after clicking the Report button */
+```
+
+If you want to style the report form or report list you'll have to fork and edit the engine repo. If that sounds
+daunting, it's probably not worth the effort.
+
+License
+=======
+
+MIT
+

data/Rakefile

@@ -0,0 +1,40 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'PivotalReporter'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/assets/javascripts/pivotal_reporter/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require ./stories

data/app/assets/javascripts/pivotal_reporter/report_button.js.erb

@@ -0,0 +1,47 @@
+$(document).ready(function(){
+
+    if(!PivotalReporter::Engine.config.enabled) return;
+
+    ar slide_action    = -1;
+    var container_width = -1;
+
+    $pr_toggle = $('<a href="#" id="pr_report_button" title="Report Bug or Request Feature">!</a>');
+    $pr_container = $('<div id="pivotal_reporter">');
+    $pr_frame = $('<iframe id="pivotal_reporter_window" border="0" >').attr('src', '<%= PivotalReporter::Engine.config.mount_point %>');
+    $pr_container.append($pr_frame).hide();
+
+    $pr_toggle.click(function(e){
+        h_slide_toggle($pr_container)
+    });
+
+    $pr_container
+        .mouseover(function(e) {
+            clearTimeout(slide_action);
+        })
+        .mouseout(function(e) {
+            slide_action = setTimeout(toggle_report_window, 500);
+        });
+
+    $('body').prepend($pr_container).prepend($pr_toggle);
+
+    var container_width = $pr_container.width();
+
+    $pr_container.css('width', 0).css('top', $pr_toggle.css('top')).show();
+
+    function toggle_report_window()
+    {
+        h_slide_toggle($pr_container);
+    }
+    function h_slide_toggle($obj)
+    {
+        var new_w = $obj.css('width') == '0px' ? container_width : 0;
+
+        $obj.animate(
+            {
+                width: new_w
+            },
+            250,
+            'swing');
+    }
+
+});

data/app/assets/javascripts/pivotal_reporter/stories.js

@@ -0,0 +1,20 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.
+
+$(document).ready(function(){
+    $('.reject-btn').click(function(e){
+        var msg = '';
+        while (msg == '' || msg == null)
+        {
+            msg = prompt("Reason for Rejection:");
+            if (msg == null)
+            {
+                alert("You must enter a reason for your rejection.");
+            }
+        }
+
+        window.location = $(this).data('reject-path') + "?reject_message=" + encodeURI(msg);
+
+        return false;
+    });
+});

data/app/assets/stylesheets/pivotal_reporter/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require ./stories
+ */

data/app/assets/stylesheets/pivotal_reporter/report_button.css

@@ -0,0 +1,80 @@
+#pr_report_button {
+    display:block;
+    width:25px;
+    height:100px;
+
+    font-size:3em;
+    text-align: center;
+    line-height:100px;
+    text-decoration: none;
+    color: #fff;
+
+    position:absolute;
+    top:100px;
+    right:0;
+    z-index:2000;
+
+    border-left:2px solid #a0421c;
+
+    -webkit-border-top-left-radius: 5px;
+    -webkit-border-bottom-left-radius: 5px;
+    -moz-border-radius-topleft: 5px;
+    -moz-border-radius-bottomleft: 5px;
+    border-top-left-radius: 5px;
+    border-bottom-left-radius: 5px;
+
+    background: #ce3a00; /* Old browsers */
+    background: -moz-linear-gradient(45deg, #ce3a00 0%, #fe6a2c 100%); /* FF3.6+ */
+    background: -webkit-gradient(linear, left bottom, right top, color-stop(0%,#ce3a00), color-stop(100%,#fe6a2c)); /* Chrome,Safari4+ */
+    background: -webkit-linear-gradient(45deg, #ce3a00 0%,#fe6a2c 100%); /* Chrome10+,Safari5.1+ */
+    background: -o-linear-gradient(45deg, #ce3a00 0%,#fe6a2c 100%); /* Opera 11.10+ */
+    background: -ms-linear-gradient(45deg, #ce3a00 0%,#fe6a2c 100%); /* IE10+ */
+    background: linear-gradient(45deg, #ce3a00 0%,#fe6a2c 100%); /* W3C */
+    filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#ce3a00', endColorstr='#fe6a2c',GradientType=1 ); /* IE6-9 fallback on horizontal gradient */
+}
+#pr_report_button:hover {
+    background: #cc7a00; /* Old browsers */
+    background: -moz-linear-gradient(45deg, #cc7a00 0%, #ff8b2d 100%); /* FF3.6+ */
+    background: -webkit-gradient(linear, left bottom, right top, color-stop(0%,#cc7a00), color-stop(100%,#ff8b2d)); /* Chrome,Safari4+ */
+    background: -webkit-linear-gradient(45deg, #cc7a00 0%,#ff8b2d 100%); /* Chrome10+,Safari5.1+ */
+    background: -o-linear-gradient(45deg, #cc7a00 0%,#ff8b2d 100%); /* Opera 11.10+ */
+    background: -ms-linear-gradient(45deg, #cc7a00 0%,#ff8b2d 100%); /* IE10+ */
+    background: linear-gradient(45deg, #cc7a00 0%,#ff8b2d 100%); /* W3C */
+    filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#cc7a00', endColorstr='#ff8b2d',GradientType=1 ); /* IE6-9 fallback on horizontal gradient */
+}
+
+
+#pivotal_reporter {
+    width:380px;
+    height:450px;
+    position:absolute;
+    top:0;
+    right:0;
+
+    background: #ce3a00; /* Old browsers */
+    background: -moz-linear-gradient(45deg, #ce3a00 0%, #fe6a2c 100%); /* FF3.6+ */
+    background: -webkit-gradient(linear, left bottom, right top, color-stop(0%,#ce3a00), color-stop(100%,#fe6a2c)); /* Chrome,Safari4+ */
+    background: -webkit-linear-gradient(45deg, #ce3a00 0%,#fe6a2c 100%); /* Chrome10+,Safari5.1+ */
+    background: -o-linear-gradient(45deg, #ce3a00 0%,#fe6a2c 100%); /* Opera 11.10+ */
+    background: -ms-linear-gradient(45deg, #ce3a00 0%,#fe6a2c 100%); /* IE10+ */
+    background: linear-gradient(45deg, #ce3a00 0%,#fe6a2c 100%); /* W3C */
+    filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#ce3a00', endColorstr='#fe6a2c',GradientType=1 ); /* IE6-9 fallback on horizontal gradient */
+
+    -webkit-border-top-left-radius: 5px;
+    -webkit-border-bottom-left-radius: 5px;
+    -moz-border-radius-topleft: 5px;
+    -moz-border-radius-bottomleft: 5px;
+    border-top-left-radius: 5px;
+    border-bottom-left-radius: 5px;
+
+    z-index:2000;
+    overflow:hidden;
+}
+
+#pivotal_reporter_window {
+    width:360px;
+    height:430px;
+    margin:10px;
+    border:0;
+    overflow:hidden;
+}

data/app/assets/stylesheets/pivotal_reporter/stories.css

@@ -0,0 +1,107 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/
+
+body {
+    background: #fff;
+}
+
+table {
+    margin:15px auto;
+    width:95%;
+}
+
+thead {
+    font-weight:900;
+    background: #cce8ff;
+}
+
+td {
+    padding:5px;
+}
+
+tr {
+    border-bottom:1px solid #ddd;
+}
+
+.status, .type {
+    width:50px;
+    text-align: center;
+}
+
+.type a {
+    display:block;
+    width:25px;
+    height:25px;
+    line-height:25px;
+    border-radius: 5px;
+    background:#eee;
+    margin:0 auto;
+    color:#fff;
+    text-decoration: none;
+}
+
+.type a.bug {
+    background:#900;
+}
+
+.type a.feature {
+    background: #009;
+}
+
+label {
+    float:left;
+    width:100px;
+    text-align: right;
+    margin:0 10px 0 0
+}
+
+select, input, textarea {
+    width:200px
+}
+
+textarea {
+    height:100px;
+}
+
+input[type="submit"] {
+    margin-left:110px;
+}
+
+.success {
+    width:85%;
+    padding:10px;
+    margin:15px auto;
+    border:1px solid #090;
+    border-radius: 5px;
+    background:#dbffb7;
+}
+
+a.accept-btn, a.reject-btn {
+    display:block;
+    height:25px;
+    line-height:25px;
+    border-radius: 5px;
+    background:#eee;
+    margin:0 auto;
+    color:#fff;
+    text-decoration: none;
+}
+
+a.accept-btn {
+    background:#090;
+    margin-bottom:5px;
+}
+
+a.accept-btn:hover{
+    background:#0e0;
+}
+
+a.reject-btn {
+    background:#900;
+}
+
+a.reject-btn:hover{
+    background:#e00;
+}

data/app/controllers/pivotal_reporter/application_controller.rb

@@ -0,0 +1,16 @@
+module PivotalReporter
+  class ApplicationController < ActionController::Base
+
+    PivotalTracker::Client.token = PivotalReporter::Engine.config.token
+
+    def pivotal_project
+      PivotalTracker::Project.find(PivotalReporter::Engine.config.project_id)
+    end
+
+    def pivotal_unique_label
+      "pivotal_reporter_#{PivotalReporter::Engine.config.project_id}"
+    end
+
+  end
+
+end

data/app/controllers/pivotal_reporter/stories_controller.rb

@@ -0,0 +1,46 @@
+require_dependency "pivotal_reporter/application_controller"
+
+module PivotalReporter
+  class StoriesController < ApplicationController
+    def index
+      @stories = pivotal_project.stories.all(label: pivotal_unique_label)
+    end
+
+    def show
+      @story = pivotal_project.stories.find(params[:id])
+    end
+
+    def new
+      @pivotal_unique_label = pivotal_unique_label
+    end
+  
+    def create
+      story = PivotalTracker::Story.new(params[:story]).create
+
+      if story.errors.count > 0
+        flash[:error] = "Report Submission Failed: #{story.errors}"
+      else
+        flash[:success] = 'Report Submitted!'
+      end
+
+      redirect_to new_story_path
+    end
+
+    def accept
+      @story = pivotal_project.stories.find(params[:id])
+      @story.update({current_state: 'accepted'})
+
+      redirect_to stories_path
+    end
+
+    def reject
+      @story = pivotal_project.stories.find(params[:id])
+      @story.update({current_state: 'rejected'})
+      @story.notes.create(:text => URI.decode(params[:reject_message]))
+
+      redirect_to stories_path
+    end
+
+
+  end
+end

data/app/helpers/pivotal_reporter/application_helper.rb

@@ -0,0 +1,14 @@
+module PivotalReporter
+  module ApplicationHelper
+
+    def pivotal_labels
+      "#{@pivotal_unique_label}, remote_user_#{requested_by.gsub(' ', '').underscore}"
+    end
+
+    def requested_by
+      PivotalReporter::Engine.config.request_user || current_user.full_name
+    end
+
+
+  end
+end

data/app/helpers/pivotal_reporter/stories_helper.rb

@@ -0,0 +1,4 @@
+module PivotalReporter
+  module StoriesHelper
+  end
+end

data/app/views/layouts/pivotal_reporter/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>PivotalReporter</title>
+  <%= stylesheet_link_tag    "pivotal_reporter/application", :media => "all" %>
+  <%= javascript_include_tag "pivotal_reporter/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/pivotal_reporter/stories/index.html.erb

@@ -0,0 +1,27 @@
+<%= link_to "Submit New Report", new_story_path  %>
+<table>
+  <thead>
+  <tr>
+    <th class="type">Type</th>
+    <th class="status">Status</th>
+    <th>Description</th>
+  </tr>
+  </thead>
+  <tbody>
+  <% @stories.each do |story| %>
+    <tr>
+      <td class="type"><a href="<%= story.url %>" class="<%= story.story_type %>" title="<%= story.story_type %> <%= story.id %>"><%= story.story_type[0].capitalize %></a></td>
+      <td class="status">
+        <%= story.current_state.capitalize %>
+        <% if story.current_state == 'delivered' %>
+            <%= link_to 'Accept', accept_story_path(story.id), class: 'accept-btn' %>
+            <%= link_to 'Reject', '#', class: 'reject-btn', :'data-reject-path' => reject_story_path(story.id) %>
+        <% end %>
+      </td>
+      <td><%= story.name %></td>
+    </tr>
+  <% end %>
+  </tbody>
+</table>
+
+<%= link_to "Submit New Report", new_story_path  %>

data/app/views/pivotal_reporter/stories/new.html.erb

@@ -0,0 +1,29 @@
+<% if flash[:success] %>
+    <div class="success"><%= flash[:success] %></div>
+<% end %>
+
+<form method="post" action="<%= PivotalReporter::Engine.config.mount_point %>/stories">
+    <label for="story[story_type]">Type</label>
+    <select name="story[story_type]">
+      <option value="bug">Bug</option>
+      <option value="feature">Feature</option>
+    </select>
+    <br />
+
+    <label for="story[name]">Title</label>
+    <input type="text" name="story[name]" />
+    <br />
+
+    <label for="story[description]">Description</label>
+    <textarea name="story[description]"></textarea>
+    <br />
+
+    <input type="hidden" name="story[labels]" value="<%= pivotal_labels %>" />
+    <input type="hidden" name="story[project_id]" value="<%= PivotalReporter::Engine.config.project_id %>" />
+    <input type="hidden" name="story[requested_by]" value="<%= requested_by %>" />
+
+    <input type="submit" value="Report" />
+
+</form>
+
+<%= link_to "View Your Active Submissions", stories_path %>

data/config/routes.rb

@@ -0,0 +1,12 @@
+PivotalReporter::Engine.routes.draw do
+
+  resources :stories do
+    member do
+      get 'accept' => 'stories#accept', to: :accept_story
+      get 'reject' => 'stories#reject', to: :reject_story
+    end
+  end
+
+  root :to => 'stories#new'
+
+end

data/lib/pivotal_reporter/engine.rb

@@ -0,0 +1,5 @@
+module PivotalReporter
+  class Engine < ::Rails::Engine
+    isolate_namespace PivotalReporter
+  end
+end

data/lib/pivotal_reporter/version.rb

@@ -0,0 +1,3 @@
+module PivotalReporter
+  VERSION = "0.7.0"
+end

data/lib/pivotal_reporter.rb

@@ -0,0 +1,21 @@
+require "pivotal_reporter/engine"
+require 'pivotal-tracker'
+
+module PivotalReporter
+  class Engine < Rails::Engine
+
+    initializer "pivotal_reporter.configure_rails_initialization" do |app|
+      #
+    end
+
+  end
+
+  # This is what I was trying to figure out
+  def self.config(&block)
+    @@config ||= Engine::Configuration.new
+
+    yield @@config if block
+
+    return @@config
+  end
+end

data/lib/tasks/pivotal_reporter_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :pivotal_reporter do
+#   # Task goes here
+# end