jsmestad-pivotal-tracker 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Josh Nichols
+
+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

@@ -0,0 +1,13 @@
+Ruby Pivotal Tracker
+http://www.evalcode.com
+
+=========================
+Notes
+=========================
+There are a few areas that need to be modified in order for this code to work correctly.
+You must set the Token key in the initialize method as well as project_id.
+  
+=========================
+Contributers
+=========================
+Justin Smestad

data/Rakefile

@@ -0,0 +1,58 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "pivotal-tracker"
+    gem.summary = %Q{Ruby wrapper for the Pivotal Tracker API}
+    gem.email = "justin.smestad@gmail.com"
+    gem.homepage = "http://github.com/jsmestad/pivotal-tracker"
+    gem.authors = ["Justin Smestad", "Josh Nichols"]
+    gem.add_dependency "restclient"
+    gem.add_dependency "happymapper", ">= 0.2.4"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ruby-pivotal-tracker #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/pivotal-tracker/extensions.rb

@@ -0,0 +1,12 @@
+# TODO make these conditional on to_param not existing...
+class String
+  def to_param
+    self
+  end
+end
+
+class Integer
+  def to_param
+    to_s
+  end
+end

data/lib/pivotal-tracker/project.rb

@@ -0,0 +1,7 @@
+class Project
+  include HappyMapper
+  element :name, String
+  element :iteration_length, String
+  element :week_start_day, String
+  element :point_scale, String
+end

data/lib/pivotal-tracker/story.rb

@@ -0,0 +1,25 @@
+class Story
+  include HappyMapper
+  element :id, Integer
+  element :type, String
+  element :name, String
+
+  def initialize(attributes = {})
+    attributes.each do |key, value|
+      send("#{key}=", value)
+    end
+  end
+
+  def to_xml(options = {})
+    builder = Builder::XmlMarkup.new(options)
+    builder.story do |story|
+      story.id   id.to_s   if id
+      story.type type.to_s if type
+      story.name name.to_s if name
+    end
+  end
+
+  def to_param
+    id.to_s
+  end
+end

data/lib/pivotal-tracker.rb

@@ -0,0 +1,76 @@
+require 'restclient'
+require 'happymapper'
+require 'builder'
+
+
+require 'pivotal-tracker/extensions'
+require 'pivotal-tracker/project'
+require 'pivotal-tracker/story'
+
+class PivotalTracker
+  def initialize(project_id, token)
+    @project_id, @token = project_id, token
+  end
+  
+  def project
+    response = project_resource.get 'Token' => @token
+    Project.parse(response).first
+  end
+  
+  def stories
+    response = project_resource['stories'].get 'Token' => @token
+    Story.parse(response)
+  end
+  
+  # would ideally like to pass a size, aka :all to limit search
+  def find(filters = {})
+    unless filters.empty?
+      filter_string = "?filter=" 
+      filters.each do |key, value|
+        filter_string << CGI::escape("#{key}:\"#{value}\"")
+      end
+    else
+      filter_string = ""
+    end
+
+    response = stories_resource[filter_string].get
+    
+    Story.parse(response)
+  end
+  
+  def find_story(id)
+    story_resource(id).get 'Token' => @token, 'Content-Type' => 'application/xml'
+
+    Story.parse(response).first
+  end
+  
+  def create_story(story)
+    stories_resource.post story.to_xml, 'Token' => @token, 'Content-Type' => 'application/xml'
+  end
+  
+  def update_story(story)
+    story_resource(story).put story.to_xml, 'Token' => @token, 'Content-Type' => 'application/xml'
+  end
+  
+  def delete_story(story)
+    story_resource(story).delete 'Token' => @token
+  end
+
+  protected
+
+  def projects_resource
+    RestClient::Resource.new "http://www.pivotaltracker.com/services/v1/projects"
+  end
+
+  def project_resource(project = @project_id)
+    projects_resource["/#{@project_id}"]
+  end
+
+  def stories_resource
+    project_resource['/stories']
+  end
+
+  def story_resource(story)
+    stories_resource["/#{story.to_param}"]
+  end
+end

data/pivotal-tracker.gemspec

@@ -0,0 +1,56 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{pivotal-tracker}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Justin Smestad", "Josh Nichols"]
+  s.date = %q{2009-05-27}
+  s.email = %q{justin.smestad@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README",
+     "Rakefile",
+     "VERSION",
+     "lib/pivotal-tracker.rb",
+     "lib/pivotal-tracker/extensions.rb",
+     "lib/pivotal-tracker/project.rb",
+     "lib/pivotal-tracker/story.rb",
+     "pivotal-tracker.gemspec",
+     "test/pivotal_tracker_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/jsmestad/pivotal-tracker}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Ruby wrapper for the Pivotal Tracker API}
+  s.test_files = [
+    "test/pivotal_tracker_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<restclient>, [">= 0"])
+      s.add_runtime_dependency(%q<happymapper>, [">= 0.2.4"])
+    else
+      s.add_dependency(%q<restclient>, [">= 0"])
+      s.add_dependency(%q<happymapper>, [">= 0.2.4"])
+    end
+  else
+    s.add_dependency(%q<restclient>, [">= 0"])
+    s.add_dependency(%q<happymapper>, [">= 0.2.4"])
+  end
+end

data/test/pivotal_tracker_test.rb

@@ -0,0 +1,56 @@
+require 'test_helper'
+
+class PivotalTrackerTest < Test::Unit::TestCase
+  
+  def setup
+    @tracker = Tracker.new
+  end
+  
+  def test_assert_stories_return
+    assert_equal 3, @tracker.stories.size
+  end
+  
+  def test_assert_project_response
+    project = @tracker.project
+    assert_equal "Factory Test", project[:name]
+    assert_equal "1", project[:iteration_length]
+  end
+  
+  def test_find_without_filters
+    result = @tracker.find
+    assert_equal @tracker.stories.size, result.size
+  end
+  
+  def test_find_with_filters
+    result = @tracker.find :name => 'Create another one'
+    assert_equal result[0][:name], 'Create another one'
+  end
+  
+  def test_assert_story_creation
+    current_size = @tracker.stories.size
+    story = {
+      :name => 'Create another one',
+      :story_type => "feature",
+      :requested_by => "Justin Smestad"
+    }
+    @tracker.create_story(story)
+    assert_equal (current_size + 1), @tracker.stories.size
+  end
+  
+  def test_story_updates
+    story = {
+      :id => 272626,
+      :name => 'This has changed'
+    }
+    @tracker.update_story(story)
+    assert_equal @tracker.find_story(story[:id])[:name], story[:name]
+  end
+  
+  def test_story_deletion
+    current_size = @tracker.stories.size
+    id = @tracker.stories[0][:id]
+    @tracker.delete_story(id)
+    assert_equal (current_size - 1), @tracker.stories.size
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'pivotal-tracker'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: jsmestad-pivotal-tracker
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Justin Smestad
+- Josh Nichols
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-27 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: restclient
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: happymapper
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.4
+    version: 
+description: 
+email: justin.smestad@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README
+- Rakefile
+- VERSION
+- lib/pivotal-tracker.rb
+- lib/pivotal-tracker/extensions.rb
+- lib/pivotal-tracker/project.rb
+- lib/pivotal-tracker/story.rb
+- pivotal-tracker.gemspec
+- test/pivotal_tracker_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/jsmestad/pivotal-tracker
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Ruby wrapper for the Pivotal Tracker API
+test_files: 
+- test/pivotal_tracker_test.rb
+- test/test_helper.rb