lrd-pivotal-tracker 0.5.14

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4f675f418e736a47d94ed4b17e7287199703f3d1
+  data.tar.gz: f4cf28bb95fae0a1703504a4c28fa640894a7ed7
+SHA512:
+  metadata.gz: b252a7d31d5f589a563c22e18db527cb23c3be615b3f675f6a278048023f7b35745b977cd0966ed8a53228849fe0a5ad34327cfe9eac7393484d45373a3027c1
+  data.tar.gz: cb21073ac4d5347f5b2cca5299dc785fecab1542d1a13388fe1dc7ef8443da97121ffbc93699283fc028fce662fece0dad8d93051c539d28dc9986110276c202

data/Gemfile

@@ -0,0 +1,10 @@
+source 'http://rubygems.org'
+
+gem 'corundum'
+gem 'rspec'
+gem 'rake'
+gem 'jeweler'
+gem 'vcr'
+gem 'fakeweb'
+
+gemspec :name => "lrd-pivotal-tracker"

data/Gemfile.lock

@@ -0,0 +1,94 @@
+PATH
+  remote: .
+  specs:
+    lrd-pivotal-tracker (0.5.14)
+      builder
+      crack
+      happymapper (>= 0.3.2)
+      nokogiri (>= 1.5.5)
+      nokogiri-happymapper (>= 0.5.4)
+      rest-client (~> 1.6.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    builder (3.2.2)
+    calibrate (0.0.1)
+    caliph (0.3.1)
+    corundum (0.6.0)
+      bundler
+      caliph (~> 0.3)
+      mattock (~> 0.9)
+      paint (~> 0.8.7)
+      rspec (>= 2.0)
+      simplecov (>= 0.5.4)
+      simplecov-json (>= 0.2)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.1.3)
+    docile (1.1.5)
+    fakeweb (1.3.0)
+    git (1.2.5)
+    happymapper (0.4.1)
+      libxml-ruby (~> 2.0)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.5)
+    libxml-ruby (2.8.0)
+    mattock (0.10.0)
+      calibrate (~> 0.0.1)
+      caliph (~> 0.3.1)
+      rake (~> 10.0)
+      tilt (> 0)
+      valise (~> 1.1.1)
+    mime-types (1.25.1)
+    mini_portile (0.6.2)
+    multi_json (1.11.2)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    nokogiri-happymapper (0.5.9)
+      nokogiri (~> 1.5)
+    paint (0.8.7)
+    rake (10.0.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rest-client (1.6.9)
+      mime-types (~> 1.16)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.0)
+    rspec-expectations (2.12.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.0)
+    safe_yaml (1.0.4)
+    simplecov (0.9.2)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.9.0)
+    simplecov-html (0.9.0)
+    simplecov-json (0.2)
+      json
+      simplecov
+    tilt (2.0.1)
+    valise (1.1.4)
+    vcr (2.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  corundum
+  fakeweb
+  jeweler
+  lrd-pivotal-tracker!
+  rake
+  rspec
+  vcr
+
+BUNDLED WITH
+   1.10.6

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2009 Justin Smestad
+Copyright (c) 2015 Hannah Howard, Judson Lester
+
+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,82 @@
+= pivotal-tracker.rb
+
+Ruby wrapper for Pivotal Tracker API, no frameworks required. Simply Ruby.
+
+{<img src="https://secure.travis-ci.org/jsmestad/pivotal-tracker.png" />}[http://travis-ci.org/jsmestad/pivotal-tracker]
+{<img src="https://badge.fury.io/rb/pivotal-tracker.png" alt="Gem Version" />}[http://rubygems.org/gems/pivotal-tracker]
+
+== Features
+
+* Compatible with Pivotal Tracker API version 3
+* ActiveRecord-style Wrapper API
+* Support for SSL protected repositories
+
+== Overview
+
+    PivotalTracker::Client.token('myusername@email.com', 'secretpassword')        # Automatically fetch API Token
+    PivotalTracker::Client.token = 'jkfduisj97823974j2kl24899234'                 # Manually set API Token
+
+    @projects = PivotalTracker::Project.all                                       # return all projects
+    @a_project = PivotalTracker::Project.find(84739)                              # find project with a given ID
+
+    @a_project.stories.all                                                        # return all stories for "a_project"
+    @a_project.stories.all(:label => 'overdue', :story_type => ['bug', 'chore'])  # return all stories that match the passed filters
+    @a_project.stories.find(847762630)                                            # find story with a given ID
+
+    @a_project.stories.create(:name => 'My Story', :story_type => 'feature')      # create a story for this project
+
+    # all tracker defined filters are allowed, as well as :limit & :offset for pagination
+
+    # The below pattern below is planned to be added to the final release:
+
+    @a_project.stories << PivotalTracker::Story.new(84739, :name => 'Ur Story')   # same as earlier story creation, useful for copying/cloning from proj
+
+
+    @story = @a_project.stories.find(847762630)
+    @story.notes.all                                                              # return all notes (comments) for a story
+    @story.notes.create(:text => 'A new comment', :noted_at => '06/29/2010 05:00 EST')  # add a new note
+
+
+    @story.attachments                                                            # return an array of all attachment items (data only, not the files)
+    @story.upload_attachment(file_path)                                           # add a file attachment to @story that can be found at file_path
+
+
+    # All 4 examples below return a PivotalTracker::Story from the new project, with the same story ID
+
+    @story.move_to_project(123456)                                                # move @story to the project with ID 123456
+    @story.move_to_project('123456')                                              # same as above
+    @story.move_to_project(@project)                                              # move @story to @project
+    @story.move_to_project(@another_story)                                        # move @story into the same project as @another_story
+
+
+    # Connect to custom API endpoint
+    PivotalTracker::Client.tracker_host = 'www.my-pivotal-tracker.com'
+
+The API is based on the following this gist: http://gist.github.com/283120
+
+== Getting Started
+
+* Installing:
+
+    $ gem install pivotal-tracker
+
+* Contributing (requires Bundler >= 0.9.7):
+
+    $ git clone git://github.com/jsmestad/pivotal-tracker
+    $ cd pivotal-tracker
+    $ bundle install
+    $ bundle exec rake
+
+== Additional Information
+
+* Wiki: http://wiki.github.com/jsmestad/pivotal-tracker
+* Documentation: http://rdoc.info/projects/jsmestad/pivotal-tracker
+* Pivotal API v3 Docs: http://www.pivotaltracker.com/help/api?version=v3
+
+== Contributors along the way
+
+* Justin Smestad (http://github.com/jsmestad)
+* Josh Nichols (http://github.com/technicalpickles)
+* Terence Lee (http://github.com/hone)
+* Jon Mischo (http://github.com/supertaz)
+* Gabor Ratky (http://github.com/rgabo)

data/Rakefile

@@ -0,0 +1,42 @@
+require 'corundum/tasklibs'
+
+module Corundum
+  Corundum::register_project(__FILE__)
+
+  core = Core.new
+
+  core.in_namespace do
+    GemspecFiles.new(core)
+
+    ["debug", "profanity", "ableism", "racism"].each do |type|
+      QuestionableContent.new(core) do |content|
+        content.type = type
+      end
+    end
+
+    rspec = RSpec.new(core)
+
+    SimpleCov.new(core, rspec) do |cov|
+      cov.threshold = 90
+    end
+
+    gem = GemBuilding.new(core)
+
+    GemCutter.new(core,gem)
+
+    Git.new(core) do |vc|
+      vc.branch = "master"
+    end
+  end
+end
+
+task :default => [:release]
+
+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

data/VERSION

@@ -0,0 +1 @@
+0.5.11

data/lib/pivotal-tracker.rb

@@ -0,0 +1,49 @@
+require 'cgi'
+require 'rest_client'
+require 'happymapper'
+require 'nokogiri'
+
+HappyMapper::SupportedTypes.types.unshift(HappyMapper::SupportedTypes::CastWhenType.new (DateTime) { |value|
+  begin
+    DateTime.parse(value,&:to_s)
+  rescue TypeError, ArgumentError => ex
+    nil
+  end
+})
+
+require File.join(File.dirname(__FILE__), 'pivotal-tracker', 'validation')
+require File.join(File.dirname(__FILE__), 'pivotal-tracker', 'extensions')
+require File.join(File.dirname(__FILE__), 'pivotal-tracker', 'proxy')
+require File.join(File.dirname(__FILE__), 'pivotal-tracker', 'client')
+require File.join(File.dirname(__FILE__), 'pivotal-tracker', 'project')
+require File.join(File.dirname(__FILE__), 'pivotal-tracker', 'attachment')
+require File.join(File.dirname(__FILE__), 'pivotal-tracker', 'story')
+require File.join(File.dirname(__FILE__), 'pivotal-tracker', 'task')
+require File.join(File.dirname(__FILE__), 'pivotal-tracker', 'author')
+require File.join(File.dirname(__FILE__), 'pivotal-tracker', 'membership')
+require File.join(File.dirname(__FILE__), 'pivotal-tracker', 'activity')
+require File.join(File.dirname(__FILE__), 'pivotal-tracker', 'iteration')
+require File.join(File.dirname(__FILE__), 'pivotal-tracker', 'note')
+
+
+module PivotalTracker
+
+  # define error types
+  class ProjectNotSpecified < StandardError; end
+
+  def self.encode_options(options)
+    options_strings = options.inject({}) do |m, (k,v)|
+      if [:limit, :offset].include?(k.to_sym)
+        m.update k => v
+      elsif k.to_sym == :search
+        m.update :filter => v
+      else
+        filter_query = %{#{k}:#{[v].flatten.join(",")}}
+        m.update :filter => (m[:filter] ? "#{m[:filter]} #{filter_query}" : filter_query)
+      end
+    end.map {|k,v| "#{k}=#{CGI.escape(v.to_s)}"}
+
+    %{?#{options_strings.join("&")}} unless options_strings.empty?
+  end
+
+end

data/lib/pivotal-tracker/activity.rb

@@ -0,0 +1,68 @@
+module PivotalTracker
+  class Activity
+    include HappyMapper
+    class << self
+
+      MAX_PIVOTAL_ACTIVITY = 100
+
+      def all(project=nil, options={})
+        options[:limit] ||= MAX_PIVOTAL_ACTIVITY
+        per_page = options[:limit]
+        auto_page = options[:auto_page]
+
+        params = self.encode_options(options)
+
+        if project
+          if auto_page && Client.api_version >= 4
+            page_through_activities(project, params, per_page)
+          else
+            parse(Client.connection["/projects/#{project.id}/activities#{params}"].get)
+          end
+        else
+          parse(Client.connection["/activities#{params}"].get)
+        end
+      end
+
+      protected
+
+        def encode_options(options)
+          return nil if !options.is_a?(Hash) || options.empty?
+
+          options_string = []
+          options_string << "limit=#{options.delete(:limit)}" 
+          options_string << "newer_than_version=#{options.delete(:newer_than_version)}" if options[:newer_than_version]
+
+          if options[:occurred_since]
+            options_string << "occurred_since_date=\"#{options[:occurred_since].utc}\""
+          elsif options[:occurred_since_date]
+            options_string << "occurred_since_date=#{URI.escape options[:occurred_since_date].strftime("%Y/%m/%d %H:%M:%S %Z")}"
+          end
+
+          return "?#{options_string.join('&')}"
+        end
+
+        def page_through_activities(project, params, per_page)
+            collections = []
+            page = 1
+            begin
+              collections << parse(Client.connection["/projects/#{project.id}/activities#{params}&page=#{page}"].get)
+              returned = collections.last.size
+              page += 1
+            end while returned == per_page
+            collections.flatten
+        end
+
+    end
+
+    element :id, Integer
+    element :version, Integer
+    element :event_type, String
+    element :occurred_at, DateTime
+    has_one :author, Author
+    element :project_id, Integer
+    element :description, String
+
+    has_many :stories, Story, :tag => "story"
+
+  end
+end

data/lib/pivotal-tracker/attachment.rb

@@ -0,0 +1,16 @@
+module PivotalTracker
+  class Attachment
+    include HappyMapper
+
+    tag 'attachment'
+
+    element :id, Integer
+    element :filename, String
+    element :description, String
+    element :uploaded_by, String
+    element :uploaded_at, DateTime
+    element :url, String
+    element :status, String
+
+  end
+end

data/lib/pivotal-tracker/author.rb

@@ -0,0 +1,16 @@
+module PivotalTracker
+  class Person
+    include HappyMapper
+    element :id, Integer
+    element :email, String
+    element :name, String
+    element :initials, String
+  end
+
+  class Author
+    include HappyMapper
+    has_one :person, Person
+  end
+
+
+end

data/lib/pivotal-tracker/client.rb

@@ -0,0 +1,84 @@
+module PivotalTracker
+
+  class Client
+
+    class NoToken < StandardError; end
+
+    class << self
+      attr_writer :use_ssl, :token, :tracker_host, :api_version
+      def use_ssl
+        @use_ssl || false
+      end
+
+      def token(username, password, method='post')
+        response = if method == 'post'
+          RestClient.post api_ssl_url + '/tokens/active', :username => username, :password => password
+        else
+          RestClient.get "#{api_ssl_url(username, password)}/tokens/active"
+        end
+        @token= Nokogiri::XML(response.body).search('guid').inner_html
+      end
+
+      # this is your connection for the entire module
+      def connection(options={})
+        raise NoToken if @token.to_s.empty?
+
+        @connections ||= {}
+
+        cached_connection? && !protocol_changed? ? cached_connection : new_connection
+      end
+
+      def clear_connections
+        @connections = nil
+      end
+
+      def tracker_host
+        @tracker_host ||= "www.pivotaltracker.com"
+      end
+
+      def api_ssl_url(user=nil, password=nil)
+        user_password = (user && password) ? "#{user}:#{password}@" : ''
+        "https://#{user_password}#{tracker_host}#{api_path}"
+      end
+
+      def api_url
+        "http://#{tracker_host}#{api_path}"
+      end
+
+      def api_version
+        @api_version ||= 3
+      end
+
+      protected
+
+        def protocol
+          use_ssl ? 'https' : 'http'
+        end
+
+        def cached_connection?
+          !@connections[@token].nil?
+        end
+
+        def cached_connection
+          @connections[@token]
+        end
+
+        def new_connection
+          @connections[@token] = RestClient::Resource.new("#{use_ssl ? api_ssl_url : api_url}", :headers => {'X-TrackerToken' => @token, 'Content-Type' => 'application/xml'})
+        end
+
+        def protocol_changed?
+          cached_connection? ? (cached_connection_protocol != protocol) : false
+        end
+
+        def cached_connection_protocol
+          cached_connection.url.match(/^(.*):\/\//).captures.first
+        end
+
+        def api_path
+          '/services/v' + api_version.to_s
+        end
+    end
+
+  end
+end