pivotal_doc 1.1.0

data/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+lib/generators/*.html
+lib/generators/*.txt
+lib/generators/*.default
+pkg/*

data/README

@@ -0,0 +1,37 @@
+Automated release notes for apps hosted on pivotaltracker.com.  Allows release notes to be generated for any project on pivotaltracker.com by retrieving the latest iteration for the specified project and displaying the completed features, bugs, and chores.
+
+Usage:
+Either a file path (absolute) or a settings hash are supported for specifying your Pivotal Tracker credentials.
+
+Supported formats: [:html, :text]
+There is also a 'fancy' template for the html generator.  Supporting custom templates is planned soon.  Until then this is just a sample to get you started.  To make use of the fancy html you need to specify the template_name in your .yml file or settings hash (see sample below.)
+
+PivotalDoc::Generator.generate(format, 'absolut_path_to_my_file')
+
+PivotalDoc::Generator.generate(format, {
+  'username'    => 'my_name',
+  'password'    => 'my_password',
+  'token'       => 'my_token' #Not needed if you specify username/password,
+  'template_name'=>'fancy.html',
+  'projects'    => {'github'=>
+    {
+      'id'        =>1, #This is the project_id from Pivotal Tracker
+      'members'   =>['cyclone'],
+    }
+  }
+})
+
+Also see the configs.yml sample file under spec/fixtures.
+
+Note: The string keys are required (Using YAML to load file if specified.)
+Note: It's recommended you define a story of type 'release' for each iteration to properly show the title,start/end dates, and points on the release notes.
+
+Planned:
+ Custom templates
+ Attachment support
+ Comment support for stories
+ Parsable descriptions for more granular descriptions on stories
+ PDF ?
+
+
+LASTLY, a big shout out to @jsmestad, author of the pivotal-tracker gem.  This gem provides a beautiful Active Record style DSL for interacting with Pivotal Tracker's API.

data/Rakefile

@@ -0,0 +1,49 @@
+require 'spec/rake/spectask'
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+    gem.name = "pivotal_doc"
+    gem.summary = %Q{A release documentation generator for pivotaltracker.com}
+    gem.description = %Q{
+        Automated release notes for apps hosted on pivotaltracker.com.  
+        Allows release notes to be generated for any project on pivotaltracker.com by retrieving the latest iteration for the specified project and displaying the completed features, bugs, and chores.
+      }
+    gem.email = "tim.linquist@gmail.com"
+    gem.homepage = "http://github.com/timo3377/pivotal_doc"
+    gem.authors = ["Tim Linquist"]
+    gem.files.include %w(templates/ .gitignore assets/ ext/ lib/pivotal_doc/)
+
+    gem.add_dependency "pivotal-tracker", ">= 0.2.1"
+    gem.add_dependency "haml"
+    gem.add_development_dependency "rspec"
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end
+
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+

data/VERSION

@@ -0,0 +1 @@
+1.1.0