rails_tracker 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f389e145f8a5aa19620763f32f5227fce63acff0
+  data.tar.gz: 77d4c1b3ee06cfdd563e2646c08d25a03fc7a285
+SHA512:
+  metadata.gz: e0636f371052cfa90a505945a6318ca25060812335c3afb3389115972f751ca939a97751c7196d960b9d77f906c0ba22a78959b867d63c16b50085eccef7e872
+  data.tar.gz: e7e4928f5660c8b16a165d77068b5c43832afad01cee75ae0931af475704b10fe2271d8fd5ed76c96319d3ab27dc66da9db467304e638aa8bc933f1dba23d408

data/.yardoc/checksums

@@ -0,0 +1,13 @@
+lib/rails_tracker.rb b7508ca84f1c16d035c7a0f05e11e0db4b27ef32
+lib/tasks/test_seed.rb 51cb934d156ae8f564767811cf3d432065090131
+lib/rails_tracker/engine.rb 6234433545fbd2425895431cad46cc0392b37139
+lib/rails_tracker/version.rb e94502d96a1aa530fc10a1a18391fcafc201babf
+app/models/rails_tracker/issue.rb 9e51ec99eb2e325facef9b717fa45cc53428a60c
+app/models/rails_tracker/users_issues.rb 1bd6704c6c22ab7547685a62ac3264c93903d7e0
+app/mailers/rails_tracker/issue_mailer.rb 5ffd1e0666cb9cf4dd082dcc73629958ab0af595
+app/helpers/rails_tracker/issues_helper.rb 1c28434d60fe39d77e19f93079b295e3fc0052a9
+app/helpers/rails_tracker/application_helper.rb 604b9f8e62dd868fec43604e8abd20c7692b1f7d
+lib/generators/rails_tracker/templates/install.rb 1fed48fbcb5415a6f86a3ef94e8d4f7f91e71401
+lib/generators/rails_tracker/install_generator.rb 3081b4cc5329fe9c84ea7f64a2e698068c7eb140
+app/controllers/rails_tracker/issues_controller.rb 4ad2f7284fb02c62744a62a6e86dc664d6a176a4
+app/controllers/rails_tracker/application_controller.rb 66a549bbc507159d217319a2b553049e481e2de8

data/Gemfile

@@ -0,0 +1,31 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "jquery-rails"
+gem "rails"
+gem "github_api"
+gem "faraday-http-cache"
+gem 'delayed_job_active_record'
+gem 'gem-this'
+
+group :development do
+  gem "better_errors",     "~> 0.9.0" # Web UI to debug exceptions. Go to /__better_errors to access the latest one
+  gem "binding_of_caller", "~> 0.7.1" # Retrieve the binding of a method's caller in MRI Ruby >= 1.9.2
+  gem "debugger"
+  gem "sextant" # Web UI to display application route paths
+  gem "i18n"
+end
+
+group :test do
+  gem "factory_girl_rails", "~> 4.0"
+  gem "sqlite3"
+  gem "faker"
+  gem "devise"
+end
+
+group :development, :test do
+  gem "rspec-rails", "~> 2.12.2"
+  gem "slim"
+end
+

data/Gemfile.lock

@@ -0,0 +1,207 @@
+PATH
+  remote: .
+  specs:
+    rails_tracker (0.3.0)
+      delayed_job_active_record
+      faraday-http-cache
+      github_api
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (3.2.14)
+      actionpack (= 3.2.14)
+      mail (~> 2.5.4)
+    actionpack (3.2.14)
+      activemodel (= 3.2.14)
+      activesupport (= 3.2.14)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.5)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.14)
+      activesupport (= 3.2.14)
+      builder (~> 3.0.0)
+    activerecord (3.2.14)
+      activemodel (= 3.2.14)
+      activesupport (= 3.2.14)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.14)
+      activemodel (= 3.2.14)
+      activesupport (= 3.2.14)
+    activesupport (3.2.14)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    addressable (2.3.5)
+    arel (3.0.2)
+    atomic (1.1.14)
+    bcrypt-ruby (3.1.2)
+    better_errors (0.9.0)
+      coderay (>= 1.0.0)
+      erubis (>= 2.6.6)
+    binding_of_caller (0.7.2)
+      debug_inspector (>= 0.0.1)
+    builder (3.0.4)
+    coderay (1.1.0)
+    columnize (0.3.6)
+    debug_inspector (0.0.2)
+    debugger (1.6.1)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.2.0)
+      debugger-ruby_core_source (~> 1.2.3)
+    debugger-linecache (1.2.0)
+    debugger-ruby_core_source (1.2.3)
+    delayed_job (4.0.0)
+      activesupport (>= 3.0, < 4.1)
+    delayed_job_active_record (4.0.0)
+      activerecord (>= 3.0, < 4.1)
+      delayed_job (>= 3.0, < 4.1)
+    devise (3.1.1)
+      bcrypt-ruby (~> 3.0)
+      orm_adapter (~> 0.1)
+      railties (>= 3.2.6, < 5)
+      thread_safe (~> 0.1)
+      warden (~> 1.2.3)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    factory_girl (4.2.0)
+      activesupport (>= 3.0.0)
+    factory_girl_rails (4.2.1)
+      factory_girl (~> 4.2.0)
+      railties (>= 3.0.0)
+    faker (1.2.0)
+      i18n (~> 0.5)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    faraday-http-cache (0.2.1)
+      activesupport (>= 3.0)
+      faraday (~> 0.8)
+      multi_json (~> 1.3)
+    gem-this (0.3.7)
+    github_api (0.10.2)
+      addressable
+      faraday (~> 0.8.7)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.6.0)
+      oauth2
+    hashie (2.0.5)
+    hike (1.2.3)
+    httpauth (0.2.0)
+    i18n (0.6.5)
+    journey (1.0.4)
+    jquery-rails (3.0.4)
+      railties (>= 3.0, < 5.0)
+      thor (>= 0.14, < 2.0)
+    json (1.8.0)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.25)
+    mini_portile (0.5.1)
+    multi_json (1.8.0)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (1.6.0)
+      mini_portile (~> 0.5.0)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    orm_adapter (0.4.0)
+    polyglot (0.3.3)
+    rack (1.4.5)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.3)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (3.2.14)
+      actionmailer (= 3.2.14)
+      actionpack (= 3.2.14)
+      activerecord (= 3.2.14)
+      activeresource (= 3.2.14)
+      activesupport (= 3.2.14)
+      bundler (~> 1.0)
+      railties (= 3.2.14)
+    railties (3.2.14)
+      actionpack (= 3.2.14)
+      activesupport (= 3.2.14)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (10.1.0)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.2)
+    rspec-rails (2.12.2)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    sextant (0.2.4)
+      rails (>= 3.2)
+    slim (2.0.1)
+      temple (~> 0.6.6)
+      tilt (>= 1.3.3, < 2.1)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.8)
+    temple (0.6.6)
+    thor (0.18.1)
+    thread_safe (0.1.3)
+      atomic
+    tilt (1.4.1)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.37)
+    warden (1.2.3)
+      rack (>= 1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  better_errors (~> 0.9.0)
+  binding_of_caller (~> 0.7.1)
+  debugger
+  delayed_job_active_record
+  devise
+  factory_girl_rails (~> 4.0)
+  faker
+  faraday-http-cache
+  gem-this
+  github_api
+  i18n
+  jquery-rails
+  rails
+  rails_tracker!
+  rspec
+  rspec-rails (~> 2.12.2)
+  sextant
+  slim
+  sqlite3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 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.rdoc

@@ -0,0 +1,88 @@
+= Rails Tracker
+Rails Tracker is a mountable Rails engine that enables your users with a web UI
+to track development progress through Github Issues.
+
+Rails Tracker is a valuable tool for services/products that see value in providing transparency with
+their bug/issue progress directly to the end user.
+
+![ScreenShot](https://raw.github.com/mcifani/active_progress/master/screenshot1.png)
+
+== Current Requirements(important)
+Rails Tracker currently requires Active Record and will only work on applications which use Devise
+as their user authentication system. Rails Tracker utitlizes various Devise helpers to faciliate
+the interactions for your users to track development tickets & issues.
+
+== Getting Started
+Add Rails Tracker as a Ruby Gem.
+
+    gem 'rails_tracker'
+
+After you install Rails Tracker and add it to your Gemfile, you need to run the generator:
+
+    rails generate rails_tracker:install
+
+The generator will install an initializer which describes ALL Active Progress's configuration options and you MUST take a look at it.
+
+Copy the migrations which will create tables to store issue/user associations.  Make sure to run your migrations after.
+
+    rake rails_tracker:install:migrations
+
+You will need to mount the engine and set the namespace you want to your routes.rb.
+
+    mount ActiveProgress::Engine => "/rails_tracker"
+
+"/rails_tracker" can be anything you like. This is where you can now direct users to track your Github issues.
+
+You will need to extend  Rails Tracker in your particular User Model. You need to do this by including the module
+directly in your User Model class.
+
+    class User < ActiveRecord::Base
+      include RailsTracker
+      # The rest of your User Model
+    end
+
+== Set a hook in your GitHub Repo to handle closed issues
+
+These next steps will help incorporate your repo hooks and configure the hook to trigger on issues. Rails Tracker has mailers built in that will
+alert your users when issues have been closed.
+
+Github webhooks for a URL by default only fire on repo pushes.  There is currently no way in the web UI to set up webhooks for other events.
+You must set your repo to the issue event via the API directly. Follow this example to create a new hook and set the event support with issues
+
+Make sure to pass this URL when you are creating the hook. By default Rails Tracker uses the listen namespace to respond to post updates sent from github.
+Be sure to name the new hook "web".
+
+    curl -u 'username' -v -H "Content-Type: application/json" \
+    -X POST -d '{"name": "web", "active": true, "events": ["issues"], \
+    "config": {"url": "example.com/tracker/listen", "content_type": "json"}}' \
+    https://api.github.com/repos/:username/:repo/hooks
+
+    example.com/rails_tracker/listen
+
+You can confirm the hook was created correctly by either viewing directly in the admin section of the repo or with a get request
+
+    curl -u 'username' https://api.github.com/repos/:username/:repo/hooks
+
+== Configure delayed job for Rails Tracker closed status emails
+
+Rails Tracker utitlizes delayed job to help process your alert emails. When a callback from Github is sent
+to the listener that a issue has been closed, Rails Tracker marks the issue as closed for your user and also
+sends an email to update the user of the status.  Since you could potentially have thousands of users to send a
+status update we move this into a background process.
+
+If you already have delayed job working jobs you won't need to follow this setup.  Otherwise make sure to run
+the installation with
+
+    rails generate delayed_job:active_record
+
+Delayed job is a dependency of Rails Tracker so it is already made available for your project. Next run your migrations
+
+   rake db:migrate
+
+You can familiarize yourself with delayed job and insuring your workers are running by reading more at
+
+    https://github.com/collectiveidea/delayed_job
+
+
+== License
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,113 @@
+#!/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    = 'Active Progress'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+
+require "rubygems"
+require "rubygems/package_task"
+require "rdoc/task"
+
+require "rspec-rails"
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = %w(--format documentation --colour)
+end
+
+
+task :default => ["test", "spec"]
+
+# This builds the actual gem. For details of what all these options
+# mean, and other ones you can add, check the documentation here:
+#
+#   http://rubygems.org/read/chapter/20
+#
+spec = Gem::Specification.new do |s|
+
+  # Change these as appropriate
+  s.name              = "rails_tracker"
+  s.version           = "0.3.0"
+  s.summary           = "An elegant Rails solution for issue tracking"
+  s.description       = "An elegant Rails solution for issue tracking"
+  s.author            = "Mike Cifani"
+  s.email             = "mike@railstracker.com"
+  s.homepage          = "http://www.railstracker.com"
+
+  s.has_rdoc          = true
+  s.extra_rdoc_files  = %w(README.rdoc)
+  s.rdoc_options      = %w(--main README.rdoc)
+
+  # Add any extra files to include in the gem
+  s.files             = %w(rails_tracker.gemspec Gemfile Gemfile.lock issues} MIT-LICENSE Rakefile README.rdoc screenshot1.png) + Dir.glob("{test,spec,lib,app,db,config,.yardoc}/**/*")
+  s.require_paths     = ["lib"]
+
+  # If you want to depend on other gems, add them here, along with any
+  # relevant versions
+  # s.add_dependency("some_other_gem", "~> 0.1.0")
+  s.add_dependency "github_api"
+  s.add_dependency "faraday-http-cache"
+  s.add_dependency "delayed_job_active_record"
+
+  # If your tests use any gems, include them here
+  s.add_development_dependency("rspec")
+end
+
+# This task actually builds the gem. We also regenerate a static
+# .gemspec file, which is useful if something (i.e. GitHub) will
+# be automatically building a gem for this project. If you're not
+# using GitHub, edit as appropriate.
+#
+# To publish your gem online, install the 'gemcutter' gem; Read more 
+# about that here: http://gemcutter.org/pages/gem_docs
+Gem::PackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "Build the gemspec file #{spec.name}.gemspec"
+task :gemspec do
+  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
+  File.open(file, "w") {|f| f << spec.to_ruby }
+end
+
+# If you don't want to generate the .gemspec file, just remove this line. Reasons
+# why you might want to generate a gemspec:
+#  - using bundler with a git source
+#  - building the gem without rake (i.e. gem build blah.gemspec)
+#  - maybe others?
+task :package => :gemspec
+
+# Generate documentation
+RDoc::Task.new do |rd|
+  rd.main = "README.rdoc"
+  rd.rdoc_files.include("README.rdoc", "lib/**/*.rb")
+  rd.rdoc_dir = "rdoc"
+end
+
+desc 'Clear out RDoc and generated packages'
+task :clean => [:clobber_rdoc, :clobber_package] do
+  rm "#{spec.name}.gemspec"
+end

data/app/assets/javascripts/rails_tracker/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_tree .

data/app/assets/javascripts/rails_tracker/issues.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

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

@@ -0,0 +1,14 @@
+/*
+ * 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 bootstrap
+ *= require_tree .
+ */