pivotal_tracker 0.1.0

data/.document

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

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Joslyn Esser
+
+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,18 @@
+= pivotal_tracker
+
+This is a simple ruby wrapper for the Pivotal Tracker API.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Joslyn Esser. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "pivotal_tracker"
+    gem.summary = %Q{Simple ruby wrapper for the Pivotal Tracker API}
+    gem.email = "joslyn.esser@gmail.com"
+    gem.homepage = "http://github.com/joslynesser/pivotal_tracker"
+    gem.authors = ["Joslyn Esser"]
+    
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "fakeweb", ">= 1.2.7"
+    
+    gem.add_dependency "httparty", ">= 0.4.5"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+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 :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "pivotal_tracker #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/pivotal_tracker/data.rb

@@ -0,0 +1,18 @@
+require 'ostruct'
+
+class PivotalTracker
+  class Data < OpenStruct
+    def initialize(data)
+      @table = {}
+      if data
+        for key, value in data
+          @table[key.to_sym] = value.instance_of?(Hash) ? Data.new(value) : value
+          new_ostruct_member(key)
+        end
+      end
+    end
+  end
+  
+  class Project < Data; end
+  class Membership < Data; end
+end

data/lib/pivotal_tracker.rb

@@ -0,0 +1,29 @@
+require 'rubygems'
+require 'httparty'
+
+class PivotalTracker
+  include HTTParty
+  base_uri 'www.pivotaltracker.com/services/v2'
+  format :xml
+  
+  def initialize(api_token)
+    self.class.headers 'X-TrackerToken' => api_token
+  end
+  
+  def create_project(name, options = {})
+    data = self.class.post('/projects/', :body => {:project => options.merge(:name => name)})
+    project = PivotalTracker::Project.new(data['project'])
+  end
+  
+  def add_member_to_project(project_id, role, email, person_options = {})
+    data = self.class.post("/projects/#{project_id}/memberships/", :body => {:membership => {:role => role, :person => person_options.merge(:email => email)}})
+    membership = PivotalTracker::Membership.new(data['membership'])
+  end
+  
+  def remove_member_from_project(project_id, membership_id)
+    data = self.class.delete("/projects/#{project_id}/memberships/#{membership_id}/")
+    membership = PivotalTracker::Membership.new(data['membership']) if data['membership']
+  end
+end
+
+require File.dirname(__FILE__) + '/pivotal_tracker/data'

data/pivotal_tracker.gemspec

@@ -0,0 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{pivotal_tracker}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Joslyn Esser"]
+  s.date = %q{2009-11-05}
+  s.email = %q{joslyn.esser@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/pivotal_tracker.rb",
+     "lib/pivotal_tracker/data.rb",
+     "pivotal_tracker.gemspec",
+     "spec/fixtures/membership.xml",
+     "spec/fixtures/project.xml",
+     "spec/pivotal_tracker_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/joslynesser/pivotal_tracker}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Simple ruby wrapper for the Pivotal Tracker API}
+  s.test_files = [
+    "spec/pivotal_tracker_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<fakeweb>, [">= 1.2.7"])
+      s.add_runtime_dependency(%q<httparty>, [">= 0.4.5"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<fakeweb>, [">= 1.2.7"])
+      s.add_dependency(%q<httparty>, [">= 0.4.5"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<fakeweb>, [">= 1.2.7"])
+    s.add_dependency(%q<httparty>, [">= 0.4.5"])
+  end
+end
+

data/spec/fixtures/membership.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<membership>
+  <id>15007</id>
+  <person>
+    <email>jadzia@trill.ufp</email>
+    <name>Jadzia Dax</name>
+    <initials>JD</initials>
+  </person>
+  <role>Member</role>
+  <project>
+    <id>1</id>
+    <name>Warp Engine Upgrades</name>
+  </project>
+</membership>

data/spec/fixtures/project.xml

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project>
+  <id>27</id>
+  <name>Cardassian War Plans</name>
+  <iteration_length type="integer">2</iteration_length>
+  <week_start_day>Monday</week_start_day>
+  <point_scale>0,1,2,3</point_scale>
+  <velocity_scheme>Average of 4 iterations</velocity_scheme>
+  <initial_velocity>10</initial_velocity>
+  <number_of_done_iterations_to_show>12</number_of_done_iterations_to_show>
+  <allow_attachments>true</allow_attachments>
+  <public>false</public>
+  <use_https>true</use_https>
+  <bugs_and_chores_are_estimatable>false</bugs_and_chores_are_estimatable>
+  <commit_mode>false</commit_mode>
+  <memberships>
+  </memberships>
+</project>

data/spec/pivotal_tracker_spec.rb

@@ -0,0 +1,65 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "PivotalTracker" do
+  
+  describe "Initialization" do
+    it "should require an API token" do
+      lambda { PivotalTracker.new }.should raise_error(ArgumentError)
+    end
+    
+    it "should assign the token to the HTTParty request headers" do
+      @tracker = PivotalTracker.new('12345')
+      PivotalTracker.default_options[:headers].should include('X-TrackerToken' => '12345')
+    end
+  end
+  
+  describe "Data" do
+    before(:each) do
+      @data = PivotalTracker::Data.new({'foo' => 'bar'})
+    end
+    
+    it "should resemble a nested OpenStruct" do
+      @data.foo.should == 'bar'
+    end
+    
+    it "should return nil for missing keys" do
+      @data.foobar.should be_nil
+    end
+  end
+  
+  describe "Projects" do
+    before(:each) do
+      @tracker = PivotalTracker.new('12345')
+    end
+    
+    it "should create projects" do
+      stub_post('/projects/', 'project.xml')
+      project = @tracker.create_project('Cardassian War Plans')
+      project.name.should == 'Cardassian War Plans'
+    end
+  end
+  
+  describe "Memberships" do
+    before(:each) do
+      @tracker = PivotalTracker.new('12345')
+    end
+    
+    it "should add members to a given project" do
+      stub_post('/projects/12345/memberships/', 'membership.xml')
+      membership = @tracker.add_member_to_project(12345, 'Member', 'jadzia@trill.ufp')
+      membership.person.name.should == 'Jadzia Dax'
+    end
+    
+    it "should remove members from a given project" do
+      stub_delete('/projects/12345/memberships/15007/', 'membership.xml')
+      membership = @tracker.remove_member_from_project(12345, 15007)
+      membership.person.name.should == 'Jadzia Dax'
+    end
+  end
+  
+  describe "Error Handling" do
+    it "should be handled" do
+      pending
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,44 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'pivotal_tracker'
+require 'spec'
+require 'spec/autorun'
+require 'rubygems'
+require 'fakeweb'
+require 'ruby-debug'
+
+Spec::Runner.configure do |config|
+  
+end
+
+FakeWeb.allow_net_connect = false
+
+def fixture_file(filename)
+  return '' if filename == ''
+  file_path = File.expand_path(File.dirname(__FILE__) + '/fixtures/' + filename)
+  File.read(file_path)
+end
+
+def pivotal_tracker_url(url)
+  url =~ /^http/ ? url : "http://www.pivotaltracker.com/services/v2#{url}"
+end
+ 
+def stub_get(url, filename, status=nil)
+  options = {:body => fixture_file(filename)}
+  options.merge!({:status => status}) unless status.nil?
+  
+  FakeWeb.register_uri(:get, pivotal_tracker_url(url), options)
+end
+ 
+def stub_post(url, filename)
+  FakeWeb.register_uri(:post, pivotal_tracker_url(url), :body => fixture_file(filename))
+end
+ 
+def stub_put(url, filename)
+  FakeWeb.register_uri(:put, pivotal_tracker_url(url), :body => fixture_file(filename))
+end
+ 
+def stub_delete(url, filename)
+  FakeWeb.register_uri(:delete, pivotal_tracker_url(url), :body => fixture_file(filename))
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification 
+name: pivotal_tracker
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Joslyn Esser
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-05 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.7
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.4.5
+    version: 
+description: 
+email: joslyn.esser@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/pivotal_tracker.rb
+- lib/pivotal_tracker/data.rb
+- pivotal_tracker.gemspec
+- spec/fixtures/membership.xml
+- spec/fixtures/project.xml
+- spec/pivotal_tracker_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/joslynesser/pivotal_tracker
+licenses: []
+
+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.3.5
+signing_key: 
+specification_version: 3
+summary: Simple ruby wrapper for the Pivotal Tracker API
+test_files: 
+- spec/pivotal_tracker_spec.rb
+- spec/spec_helper.rb