pivit 0.1.0

data/lib/pivit/error.rb

@@ -0,0 +1,6 @@
+module Pivit
+  class Error < StandardError
+    #Raised when there is an error with authentication 
+    class AuthenticationError < Error; end
+  end
+end

data/lib/pivit/request.rb

@@ -0,0 +1,56 @@
+module Pivit
+  module Request
+    def get(path, options = {})
+      response = request(:get, path, options)
+      response.body
+    end
+
+    def post(path, options = {})
+      request(:post, path, options).body
+    end
+
+    def put(path, options={})
+      request(:put, path, options).body
+    end
+
+    def delete(path, options={})
+      request(:delete, path, options).body
+    end
+
+    # Builds the api endpoint to reach the Pivotal Api
+    #the api endpoint to reach the Pivotal Api
+    #
+    # @return [String] Endpoint
+    #
+    # @author Jason Truluck
+    def build_endpoint
+      endpoint = ssl || self.api_token.nil? ? "https://" : "http://"
+      endpoint << "#{self.username}:#{self.password}@" unless self.authenticated?
+      endpoint << "www.pivotaltracker.com/services/v3/"
+      self.api_endpoint = endpoint
+    end
+
+    private
+    def request(method, path, options = {})
+      url     = options.delete(:endpoint) || build_endpoint
+      payload = options.delete(:payload)  || nil
+      payload = Faraday::UploadIO.new(payload, "application/octet-stream") unless payload.nil?
+
+      connection_options = {}.merge!(:url => url)
+
+      response = connection(connection_options).send(method) do |request|
+        case method
+        when :get
+          request.url(path, options)
+        when :post, :put
+          request.url(path, options)
+          request.body = { :Filedata => payload } unless payload.nil?
+        when :delete
+          request.url(path, options)
+        end
+      end
+
+      response
+    end
+  end
+end

data/lib/pivit/version.rb

@@ -0,0 +1,3 @@
+module Pivit
+  VERSION = "0.1.0"
+end

data/pivit.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pivit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pivit"
+  spec.version       = Pivit::VERSION
+  spec.authors       = ["Jason Truluck"]
+  spec.email         = ["jason.truluck@gmail.com"]
+  spec.description   = %q{Pivit is a wrapper for the Pivotal Tracker API}
+  spec.summary       = spec.description
+  spec.homepage      = "https://github.com/jasontruluck/pivit"
+  spec.license       = "MIT"
+
+  spec.add_dependency "faraday"
+  spec.add_dependency "faraday_middleware"
+  spec.add_dependency "hashie"
+  spec.add_dependency "multi_xml"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "mocha"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "capybara"
+  spec.add_development_dependency "yard"
+  spec.add_development_dependency "redcarpet"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/spec/fixtures/authentications.yml.sample

@@ -0,0 +1,11 @@
+#spec/fixtures/authentications.yml
+USERNAME:   myusername
+PASSWORD:   supersecret
+TOKEN:      supersecret
+PROJECT:    "12345"                      # ID of a project
+STORY:      "12345"                      # ID of a story
+STORY_B:    "12345"                      # ID of an alternate story
+MEMBERSHIP: "12345"                      # a id of a membership of a user in your project
+NOTE:       "This some note text"        # Some test text
+TASK:       "12345"                      # ID of a task within your pivotal tracker project 
+FILE:       "../../../fixtures/test.png" # File locatin of the image/doc/text you would like to use to test with

data/spec/fixtures/stubs/iteration.xml

@@ -0,0 +1,77 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<iterations type="array">
+  <iteration>
+    <id type="integer">2</id>
+    <number type="integer">2</number>
+    <start type="datetime">2013/05/01 00:00:00 EDT</start>
+    <finish type="datetime">2013/05/08 00:00:00 EDT</finish>
+    <team_strength type="float">1</team_strength>
+    <stories type="array">
+      <story>
+        <id type="integer">48862635</id>
+        <project_id type="integer">795721</project_id>
+        <story_type>feature</story_type>
+        <url>http://www.pivotaltracker.com/story/show/48862635</url>
+        <estimate type="integer">2</estimate>
+        <current_state>unstarted</current_state>
+        <description></description>
+        <name>Awesome Test story</name>
+        <requested_by>Jason Truluck</requested_by>
+        <created_at type="datetime">2013/04/28 00:24:00 UTC</created_at>
+        <updated_at type="datetime">2013/04/30 01:21:40 UTC</updated_at>
+      </story>
+      <story>
+        <id type="integer">48860219</id>
+        <project_id type="integer">795721</project_id>
+        <story_type>feature</story_type>
+        <url>http://www.pivotaltracker.com/story/show/48860219</url>
+        <estimate type="integer">2</estimate>
+        <current_state>unstarted</current_state>
+        <description></description>
+        <name>Awesome Test story</name>
+        <requested_by>Jason Truluck</requested_by>
+        <created_at type="datetime">2013/04/27 20:45:48 UTC</created_at>
+        <updated_at type="datetime">2013/04/30 01:21:41 UTC</updated_at>
+      </story>
+      <story>
+        <id type="integer">48962157</id>
+        <project_id type="integer">795721</project_id>
+        <story_type>feature</story_type>
+        <url>http://www.pivotaltracker.com/story/show/48962157</url>
+        <estimate type="integer">2</estimate>
+        <current_state>unstarted</current_state>
+        <description></description>
+        <name>Awesome Test story</name>
+        <requested_by>Jason Truluck</requested_by>
+        <created_at type="datetime">2013/04/30 01:18:10 UTC</created_at>
+        <updated_at type="datetime">2013/04/30 01:21:44 UTC</updated_at>
+      </story>
+      <story>
+        <id type="integer">48879093</id>
+        <project_id type="integer">795721</project_id>
+        <story_type>feature</story_type>
+        <url>http://www.pivotaltracker.com/story/show/48879093</url>
+        <estimate type="integer">2</estimate>
+        <current_state>unstarted</current_state>
+        <description></description>
+        <name>Awesome Test story</name>
+        <requested_by>Jason Truluck</requested_by>
+        <created_at type="datetime">2013/04/29 00:53:47 UTC</created_at>
+        <updated_at type="datetime">2013/04/30 01:21:46 UTC</updated_at>
+      </story>
+      <story>
+        <id type="integer">48877603</id>
+        <project_id type="integer">795721</project_id>
+        <story_type>feature</story_type>
+        <url>http://www.pivotaltracker.com/story/show/48877603</url>
+        <estimate type="integer">-1</estimate>
+        <current_state>unstarted</current_state>
+        <description></description>
+        <name>Awesome Test story</name>
+        <requested_by>Jason Truluck</requested_by>
+        <created_at type="datetime">2013/04/28 22:44:55 UTC</created_at>
+        <updated_at type="datetime">2013/04/30 01:21:38 UTC</updated_at>
+      </story>
+    </stories>
+  </iteration>
+</iterations>

data/spec/fixtures/stubs/membership.xml

@@ -0,0 +1,15 @@
+<?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/stubs/note.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<note>
+  <id type="integer">NOTE_ID</id>
+  <text>new note via API</text>
+  <author>Spock (young)</author>
+  <noted_at type="datetime">2009/01/16 18:53:51 UTC</noted_at>
+</note>

data/spec/fixtures/stubs/project/project.xml

@@ -0,0 +1,29 @@
+<?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 type="array">
+    <membership>
+      <id>1</id>
+      <person>
+        <email>picard@earth.ufp</email>
+        <name>Jean-Luc Picard</name>
+        <initials>jlp</initials>
+      </person>
+      <role>Owner</role>
+    </membership>
+  </memberships>
+  <integrations type="array">
+  </integrations>
+</project>

data/spec/fixtures/stubs/story/delete_story.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<story>
+  <id type="integer">48859617</id>
+  <project_id type="integer">795721</project_id>
+  <story_type>feature</story_type>
+  <url>https://www.pivotaltracker.com/story/show/48859617</url>
+  <estimate type="integer">2</estimate>
+  <current_state>started</current_state>
+  <description></description>
+  <name>Make it so</name>
+  <requested_by>Picard</requested_by>
+  <created_at type="datetime">2008/12/10 00:00:00 UTC</created_at>
+</story>

data/spec/fixtures/stubs/task.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<task>
+  <id type="integer">14216257</id>
+  <description>find shields</description>
+  <position>1</position>
+  <complete>false</complete>
+  <created_at type="datetime">2008/12/10 00:00:00 UTC</created_at>
+</task>

data/spec/fixtures/stubs/task_update.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<task>
+  <id type="integer">$TASK_ID</id>
+  <description>awesome new description</description>
+  <position>1</position>
+  <complete>false</complete>
+  <created_at type="datetime">2008/12/10 00:00:00 UTC</created_at>
+</task>

data/spec/pivit/client/activity_spec.rb

@@ -0,0 +1,26 @@
+require "spec_helper"
+
+# Activity Spec
+describe Pivit::Client do
+  before do
+    Pivit.reset!
+  end
+
+  let!(:pivit) { Pivit::Client.new(:token => ENV["TOKEN"]) }
+
+  describe ".activity", :vcr => {:cassette_name => "activity/activities"} do
+    let(:current_response) { pivit.activity }
+
+    it "returns an array of activities" do
+      current_response.should be_a(Array)
+    end
+
+    it "returns the version" do
+      current_response.each{ |x| x.should respond_to(:version) }
+    end
+
+    it "returns the activities" do
+      current_response.should_not be_nil
+    end
+  end
+end

data/spec/pivit/client/iteration_spec.rb

@@ -0,0 +1,104 @@
+require "spec_helper"
+
+# Client Spec
+describe Pivit::Client do
+  before do
+    Pivit.reset!
+  end
+  let!(:pivit) { Pivit::Client.new(:token => ENV["TOKEN"]) }
+
+  describe ".iterations", :vcr => {:cassette_name => "iteration/iterations"} do
+    let(:current_response) { pivit.iterations(ENV["PROJECT"]) }
+
+    it "returns a array of projects" do
+      current_response.should be_a(Array)
+    end
+
+    it "responds to iteration" do
+      current_response.each{ |x| x.should respond_to(:stories) }
+    end 
+
+    it "returns the iterations" do
+      current_response.should_not be_nil
+    end
+  end
+
+  describe ".done_iterations", :type => :webmock  do
+    let(:current_response) { pivit.done_iterations(ENV["PROJECT"]) }
+
+    it "returns a array of projects" do
+      stub_request(:get, "https://www.pivotaltracker.com/services/v3/projects/795721/iterations/done").
+        to_return(:status => 200, 
+                  :body => File.open(File.expand_path("../../../fixtures/stubs/iteration.xml", __FILE__)),
+                  :headers => {"Accept" => "application/xml", "Content-type" => "application/xml"})
+
+      current_response.should be_a(Array)
+    end
+
+    it "responds to iteration" do
+      stub_request(:get, "https://www.pivotaltracker.com/services/v3/projects/795721/iterations/done").
+        to_return(:status => 200, 
+                  :body => File.open(File.expand_path("../../../fixtures/stubs/iteration.xml", __FILE__)),
+                  :headers => {"Accept" => "application/xml", "Content-type" => "application/xml"})
+
+      current_response.each{ |x| x.should respond_to(:stories) }
+    end 
+
+    it "returns the iterations" do
+      stub_request(:get, "https://www.pivotaltracker.com/services/v3/projects/795721/iterations/done").
+        to_return(:status => 200, 
+                  :body => File.open(File.expand_path("../../../fixtures/stubs/iteration.xml", __FILE__)),
+                  :headers => {"Accept" => "application/xml", "Content-type" => "application/xml"})
+
+      current_response.should_not be_nil
+    end
+  end
+
+  describe ".iteration_backlog", :vcr => {:cassette_name => "iteration/iteration_backlog"} do
+    let(:current_response) { pivit.iteration_backlog(ENV["PROJECT"]) }
+
+    it "returns a array of projects" do
+      current_response.should be_a(Array)
+    end
+
+    it "responds to iteration" do
+      current_response.each{ |x| x.should respond_to(:stories) }
+    end 
+
+    it "returns the iterations" do
+      current_response.should_not be_nil
+    end
+  end
+
+  describe ".iteration_current", :vcr => {:cassette_name => "iteration/iteration_current"} do
+    let(:current_response) { pivit.iteration_current(ENV["PROJECT"]) }
+
+    it "returns a array of projects" do
+      current_response.should be_a(Array)
+    end
+
+    it "responds to iteration" do
+      current_response.each{ |x| x.should respond_to(:stories) }
+    end 
+
+    it "returns the iterations" do
+      current_response.should_not be_nil
+    end
+  end
+
+  describe ".iteration_current_and_backlog", :vcr => {:cassette_name => "iteration/iteration_current_and_backlog"} do
+    let(:current_response) { pivit.iteration_current_and_backlog(ENV["PROJECT"]) }
+
+    it "returns a array of projects" do
+      current_response.should be_a(Array)
+    end
+
+    it "responds to iteration" do
+      current_response.each{ |x| x.should respond_to(:stories) }
+    end 
+
+    it "returns the iterations" do
+      current_response.should_not be_nil
+    end
+  end
+end

data/spec/pivit/client/membership_spec.rb

@@ -0,0 +1,91 @@
+require "spec_helper"
+
+# Membership Spec
+describe Pivit::Client::Membership do
+  before do
+    Pivit.reset!
+  end
+
+  let!(:pivit) { Pivit::Client.new(:token=> ENV["TOKEN"]) }
+
+  describe ".membership", :vcr => {:cassette_name => "membership/membership"} do
+    let(:current_response) { pivit.membership(ENV["PROJECT"], ENV["membership"]) }
+
+    it "should return the membership response" do
+      current_response.should_not be_nil
+    end
+
+    it "should return the person of the membership" do
+      current_response.should respond_to(:person)
+    end
+
+    it "should return the role of the membership" do
+      current_response.should respond_to(:role)
+    end
+  end
+
+  describe ".memberships", :vcr => {:cassette_name => "membership/memberships"} do
+    let(:current_response) { pivit.memberships(ENV["PROJECT"]) }
+
+    it "should return an array of memberships" do
+      current_response.should be_a(Array)
+      current_response.each{ |x| x.should respond_to(:person) }
+    end
+
+    it "should return the memberships" do
+      current_response.should_not be_nil
+    end
+  end
+
+  describe ".create_membership", :type => :webmock  do
+    let(:current_response) { 
+      pivit.create_membership(ENV["PROJECT"], "jason@woofound.com", "Member") 
+    }
+
+    it "returns the person of the membership that was created" do
+      stub_request(:post, "https://www.pivotaltracker.com/services/v3/projects/795721/memberships?membership%5Bperson%5D%5Bemail%5D=jason@woofound.com&membership%5Brole%5D=Member").
+        to_return(:status => 200,
+                  :body => File.open(File.expand_path("../../../fixtures/stubs/membership.xml", __FILE__)),
+                  :headers => {'Accept' => 'application/xml', 'Content-type' => 'application/xml',})
+      current_response.should respond_to(:person)
+    end
+
+    it "returns the role of the membership that was created" do
+      stub_request(:post, "https://www.pivotaltracker.com/services/v3/projects/795721/memberships?membership%5Bperson%5D%5Bemail%5D=jason@woofound.com&membership%5Brole%5D=Member").
+        to_return(:status => 200,
+                  :body => File.open(File.expand_path("../../../fixtures/stubs/membership.xml", __FILE__)),
+                  :headers => {'Accept' => 'application/xml', 'Content-type' => 'application/xml',})
+      current_response.should respond_to(:role)
+    end
+
+    it "should be a hashie" do
+      stub_request(:post, "https://www.pivotaltracker.com/services/v3/projects/795721/memberships?membership%5Bperson%5D%5Bemail%5D=jason@woofound.com&membership%5Brole%5D=Member").
+        to_return(:status => 200,
+                  :body => File.open(File.expand_path("../../../fixtures/stubs/membership.xml", __FILE__)),
+                  :headers => {'Accept' => 'application/xml', 'Content-type' => 'application/xml',})
+      current_response.should be_a(Hashie::Mash)
+    end
+  end
+
+  describe ".delete_membership", :type => :webmock do
+    let(:current_response) { pivit.delete_membership(ENV["PROJECT"], ENV["MEMBERSHIP"]) }
+
+    it "returns the membership that was deleted" do
+      stub_request(:delete, "https://www.pivotaltracker.com/services/v3/projects/795721/memberships/534713").
+        to_return(:status => 200,
+                  :body => File.open(File.expand_path("../../../fixtures/stubs/membership.xml", __FILE__)),
+                  :headers => {'Accept' => 'application/xml', 'Content-type' => 'application/xml',})
+
+      current_response.id.should == 15007.to_s
+    end
+
+    it "should be a hashie" do
+      stub_request(:delete, "https://www.pivotaltracker.com/services/v3/projects/795721/memberships/534713").
+        to_return(:status => 200,
+                  :body => File.open(File.expand_path("../../../fixtures/stubs/membership.xml", __FILE__)),
+                  :headers => {'Accept' => 'application/xml', 'Content-type' => 'application/xml',})
+
+      current_response.should be_a(Hashie::Mash)
+    end
+  end
+end