peaty 0.3.0

data/Gemfile

@@ -0,0 +1,24 @@
+source "http://rubygems.org"
+
+gem 'activesupport', '~> 3.0.1'
+
+gem 'nokogiri'
+gem 'nokogiri-happymapper'
+
+gem 'rest-client'
+gem 'xml_to_json', '0.0.1'
+gem 'yajl-ruby'
+
+group :development do
+  gem 'yajl-ruby'
+  gem 'builder'
+
+  gem "rspec", "2.1.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.0.pre6"
+  gem "rails_code_qa", ">= 0"
+end
+
+group :test do
+  gem "fakeweb", "1.3.0"
+end

data/Gemfile.lock

@@ -0,0 +1,62 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.0.1)
+    builder (3.0.0)
+    diff-lcs (1.1.2)
+    fakeweb (1.3.0)
+    flay (1.4.1)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    flog (2.5.0)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    git (1.2.5)
+    jeweler (1.5.1)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    mime-types (1.16)
+    nokogiri (1.4.3.1)
+    nokogiri-happymapper (0.3.4)
+      nokogiri (>= 1.4.0)
+    rails_code_qa (0.4.1)
+      flay (= 1.4.1)
+      flog (= 2.5.0)
+      rcov (= 0.9.9)
+    rake (0.8.7)
+    rcov (0.9.9)
+    rest-client (1.6.1)
+      mime-types (>= 1.16)
+    rspec (2.1.0)
+      rspec-core (~> 2.1.0)
+      rspec-expectations (~> 2.1.0)
+      rspec-mocks (~> 2.1.0)
+    rspec-core (2.1.0)
+    rspec-expectations (2.1.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.1.0)
+    ruby_parser (2.0.5)
+      sexp_processor (~> 3.0)
+    sexp_processor (3.0.5)
+    xml_to_json (0.0.1)
+      nokogiri
+      nokogiri (= 1.4.3.1)
+    yajl-ruby (0.7.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (~> 3.0.1)
+  builder
+  bundler (~> 1.0.0)
+  fakeweb (= 1.3.0)
+  jeweler (~> 1.5.0.pre6)
+  nokogiri
+  nokogiri-happymapper
+  rails_code_qa
+  rest-client
+  rspec (= 2.1.0)
+  xml_to_json (= 0.0.1)
+  yajl-ruby

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "peaty"
+  gem.homepage = "http://github.com/mtodd/peaty"
+  gem.license = "MIT"
+  gem.summary = %Q{Pivotal Tracker API Implementation}
+  gem.description = %Q{Just another Pivotal Tracker API Implementation}
+  gem.email = "chiology@gmail.com"
+  gem.authors = ["Matt Todd"]
+  
+  gem.add_runtime_dependency 'nokogiri', '1.4.3.1'
+  
+  gem.add_development_dependency 'yajl-ruby', '0.7.8'
+  gem.add_development_dependency 'activesupport', '~> 3.0.1'
+  gem.add_development_dependency 'builder', '2.1.2'
+  
+  gem.add_development_dependency 'rspec', '2.1.0'
+  gem.add_development_dependency 'bundler', '~> 1.0.0'
+  gem.add_development_dependency 'jeweler', '~> 1.5.0.pre6'
+  gem.add_development_dependency 'rails_code_qa', '>= 0'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+
+Rake::TestTask.new("test") do |t|
+  t.libs << "test"
+  t.pattern = 'test/*_test.rb'
+  t.verbose = true
+  t.warning = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "xml_to_json #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/Readme.textile

@@ -0,0 +1,67 @@
+h1. Peaty
+
+Peaty (PT, 'pee-tee'): A PivotalTracker API Client
+
+h2. Usage
+
+NOTE: This is not live and only reference while development is still early.
+
+<pre>
+class User < ActiveRecord::Base
+  pivotal_tracker_for :pivotal_tracker_api_key, :method_prefix => :pt, :table_prefix => :pt
+end
+
+u = User.first
+
+team = []
+releases = []
+
+u.pt_projects.each do |project|
+  project.stories.all
+  project.releases.all
+  project.stories(:type => :release)
+  
+  # add team members to team list
+  team.concat project.users # but ensure uniqueness later
+  
+  # collect our releases
+  releases.concat project.releases
+end
+</pre>
+
+See how current API works for selecting types of stories (chores, bugs, releases, and features)
+
+h2. Contributing
+
+Step 1: Submit a failing test.
+Step 2: ???
+Step 3: Profit.
+
+h2. Other PivotalTracker RubyGems
+
+* https://github.com/joslynesser/pivotal_tracker
+* https://github.com/jsmestad/pivotal-tracker
+
+h2. License
+
+The MIT License
+
+Copyright (c) 2010 Matt Todd, Highgroove Studios.
+
+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/VERSION

@@ -0,0 +1 @@
+0.3.0

data/lib/peaty/base.rb

@@ -0,0 +1,104 @@
+module Peaty
+  
+  class Base
+    attr_accessor :attributes, :connection
+    
+    FILTERS = [
+      :id, :type, :state, :label, :has_attachment,
+      :created_since, :modified_since,
+      :requester, :owner,
+      :mywork,
+      :integration, :external_id, :has_external_id,
+      :includedone
+    ]
+    
+    def initialize(attrs)
+      raise ArgumentError unless attrs.is_a?(Hash)
+      @connection = self.class.connection
+      # if we get a hash like {"item"=>{...}}, pull out the attributes
+      @attributes = if attrs.key?(self.class.element);  attrs.dup.delete(self.class.element) 
+                    else                                attrs.dup
+                    end
+    end
+    
+    def method_missing(method, *args)
+      return self.attributes[method.to_s] if respond_to?(method)
+      super
+    end
+    def respond_to?(method)
+      super or self.attributes.key?(method.to_s)
+    end
+    
+    def id
+      self.attributes["id"]
+    end
+    
+    class << self
+      attr_accessor :connection
+      
+      def with_connection(connection)
+        @connection = connection
+        self # chaining
+      end
+      
+      # Takes the XML result, transforms to JSON, parses to objects, and
+      # returns an array of results, regardless of one or many results.
+      def parse(response, element)
+        result = JSON.parse(XmlToJson.transform(response))
+        Array.wrap(result[element] || result[element.pluralize]).map{ |r| new(r) }
+      end
+      
+      def find(*args)
+        options = args.extract_options!
+        selection = args.shift
+        case selection
+        when :first;  self.first(options)
+        when :all;    self.all(options)
+        when Array;   selection.map{ |s| self.find_by_id(s, options) }
+        when Numeric; self.find_by_id(selection, options)
+        else          self.find_by_id(selection, options)
+        end
+      end
+      
+      def find_by_id(id, options = {})
+        self.parse(self.connection[self.member_path(id, options)].get(:params => self.filter_options(options)).body, self.element).
+          first.
+          tap{ |e| e.connection = self.connection }
+      end
+      
+      def all(options = {})
+        self.parse(self.connection[self.collection_path(options)].get(:params => self.filter_options(options)).body, self.element).
+          each { |e| e.connection = self.connection }
+      end
+      
+      def first(options = {})
+        self.all(options).first
+      end
+      
+      def filter_options(options = {}, filter = [])
+        options = options.dup # make sure we're working on a copy
+        # and delete any keys not supported for queries
+        options.each { |(k,_)| options.delete(k) unless FILTERS.include?(k.to_sym) }
+        
+        FILTERS.each do |term|
+          value = Array.wrap(options.delete(term))
+          filter << "%s:%s" % [ term,
+                                value.map do |v|
+                                  v = %("%s") % v if v.to_s =~ /\s/
+                                  v
+                                end.join(',') ] unless value.empty?
+        end
+        
+        # handle the rest of the filter strings
+        Array.wrap(options.delete(:rest)).each do |value|
+          value = %("%s") % value if value.to_s =~ /\s/
+          filter << value
+        end
+        
+        return options if filter.empty?
+        options.merge(:filter => filter.join(" "))
+      end
+    end
+  end
+  
+end

data/lib/peaty/integration.rb

@@ -0,0 +1,37 @@
+module Peaty
+  
+  module Integration
+    extend ActiveSupport::Concern
+    
+    included do
+      self.__pivotal_tracker_options.tap do |opts|
+        alias_method [opts[:method_prefix], :projects].compact.map(&:to_s).join('_').to_sym, :__pivotal_tracker_projects
+      end
+    end
+    
+    module InstanceMethods
+      def __pivotal_tracker_connection
+        @__pivotal_tracker_connection ||= begin
+          RestClient.log ||= STDOUT
+          RestClient::Resource.new("http://www.pivotaltracker.com/services/v3", :headers => {"X-TrackerToken" => self.send(self.class.__pivotal_tracker_options[:attribute])})
+        end
+      end
+      def __pivotal_tracker_projects
+        Proxy.new(Project, self.__pivotal_tracker_connection, :user => self)
+      end
+    end
+  end
+  
+end
+
+class Object
+  def self.pivotal_tracker_for(attribute, options = {})
+    options = options.with_indifferent_access
+    options.reverse_merge!( :attribute => attribute,
+                            :method_prefix => :pivotal_tracker )
+    
+    class << self; attr_accessor :__pivotal_tracker_options; end
+    self.__pivotal_tracker_options = options
+    self.send(:include, Peaty::Integration)
+  end
+end

data/lib/peaty/iteration.rb

@@ -0,0 +1,25 @@
+module Peaty
+  
+  class Iteration < Base
+    
+    def stories(options = {})
+      Array.wrap(self.attributes["stories"]).map do |story|
+        Story.with_connection(self.connection).new(story)
+      end
+    end
+    
+    class << self
+      def element
+        "iteration"
+      end
+      def collection_path(options = {})
+        "/projects/%i/iterations" % options[:project_id].to_i
+      end
+      def member_path(group, options = {})
+        "/projects/%i/iterations/%s" % [options[:project_id].to_i, group]
+      end
+    end
+    
+  end
+  
+end

data/lib/peaty/project.rb

@@ -0,0 +1,47 @@
+module Peaty
+  
+  class Project < Base
+    
+    def users(options = {})
+      Array.wrap(self.memberships).map do |membership|
+        membership = membership["membership"] if membership.key?("membership")
+        User.with_connection(self.connection).new(membership["person"])
+      end
+    end
+    
+    def stories(options = {})
+      Proxy.new(Story, self.class.connection, options.merge(:project_id => self.id))
+    end
+    
+    def iterations(options = {})
+      Proxy.new(Iteration, self.class.connection, options.merge(:project_id => self.id))
+    end
+    
+    def features(options = {})
+      self.stories.filter(:type => :feature)
+    end
+    def releases(options = {})
+      self.stories.filter(:type => :release)
+    end
+    def chores(options = {})
+      self.stories.filter(:type => :chore)
+    end
+    def bugs(options = {})
+      self.stories.filter(:type => :bug)
+    end
+    
+    class << self
+      def element
+        "project"
+      end
+      def collection_path(options = {})
+        "/projects"
+      end
+      def member_path(id, options = {})
+        "/projects/%i" % id
+      end
+    end
+    
+  end
+  
+end

data/lib/peaty/proxy.rb

@@ -0,0 +1,29 @@
+module Peaty
+  
+  class Proxy
+    attr_accessor :target, :connection, :options
+    
+    def initialize(target, connection, options = {})
+      @target, @connection, @options = target, connection, options
+    end
+    
+    def method_missing(method, *args)
+      return @target.method(method).unbind.bind(self).call(*args) if @target.class.respond_to?(method)
+      options = args.extract_options!
+      args << @options.merge(options)
+      @target.with_connection(@connection).send(method, *args)
+    end
+    
+    def filter(*args)
+      options = args.extract_options!
+      options.each do |(key, value)|
+        @options[key] = Array.wrap(@options.delete(:key)).concat(Array.wrap(value))
+      end
+      
+      @options[:rest] = Array.wrap(@options.delete(:rest)).concat(args)
+      
+      self
+    end
+  end
+  
+end

data/lib/peaty/story.rb

@@ -0,0 +1,39 @@
+module Peaty
+  
+  class Story < Base
+    
+    def story_type
+      self.attributes["story_type"].to_sym
+    end
+    alias type story_type
+    
+    # chores, bugs, releases may or may not have estimates
+    def estimate
+      self.attributes["estimate"].to_i
+    end
+    
+    def project
+      Project.with_connection(self.class.connection).find(self.project_id)
+    end
+    
+    class << self
+      def element
+        "story"
+      end
+      def collection_path(options = {})
+        "/projects/%i/stories" % options[:project_id].to_i
+      end
+      def member_path(id, options = {})
+        "/projects/%i/stories/%i" % [options[:project_id].to_i, id]
+      end
+      
+      ### Filters
+      
+      def releases(options = {})
+        self.filter(:type => :release)
+      end
+    end
+    
+  end
+  
+end

data/lib/peaty/user.rb

@@ -0,0 +1,15 @@
+module Peaty
+  
+  class User < Base
+    
+    class << self
+      
+      def element
+        "person"
+      end
+      
+    end
+    
+  end
+  
+end

data/lib/peaty.rb

@@ -0,0 +1,33 @@
+require 'logger'
+
+require 'active_support/concern'
+require 'active_support/inflector'
+require 'active_support/core_ext/benchmark'
+require 'active_support/core_ext/array/extract_options'
+require 'active_support/core_ext/array/wrap'
+require 'active_support/core_ext/hash/indifferent_access'
+require 'active_support/core_ext/hash/reverse_merge'
+
+require 'rest-client'
+require 'nokogiri'
+require 'xml_to_json'
+require 'yajl/json_gem'
+
+$:.unshift Pathname.new(__FILE__).dirname
+require 'peaty/integration'
+require 'peaty/proxy'
+require 'peaty/base'
+require 'peaty/project'
+require 'peaty/iteration'
+require 'peaty/story'
+require 'peaty/user'
+
+module Peaty
+  
+  VERSION = "0.0.0"
+  
+  def self.root
+    @root ||= Pathname.new(__FILE__).dirname.parent
+  end
+  
+end

data/peaty.gemspec

@@ -0,0 +1,126 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{peaty}
+  s.version = "0.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Matt Todd"]
+  s.date = %q{2010-12-01}
+  s.description = %q{Just another Pivotal Tracker API Implementation}
+  s.email = %q{chiology@gmail.com}
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "Rakefile",
+    "Readme.textile",
+    "VERSION",
+    "lib/peaty.rb",
+    "lib/peaty/base.rb",
+    "lib/peaty/integration.rb",
+    "lib/peaty/iteration.rb",
+    "lib/peaty/project.rb",
+    "lib/peaty/proxy.rb",
+    "lib/peaty/story.rb",
+    "lib/peaty/user.rb",
+    "peaty.gemspec",
+    "test/.gitignore",
+    "test/fixtures/bugs.xml",
+    "test/fixtures/chores.xml",
+    "test/fixtures/features.xml",
+    "test/fixtures/iterations.xml",
+    "test/fixtures/iterations_done.xml",
+    "test/fixtures/project.xml",
+    "test/fixtures/projects.xml",
+    "test/fixtures/release.xml",
+    "test/fixtures/releases.xml",
+    "test/fixtures/stories.xml",
+    "test/fixtures/stories_with_done.xml",
+    "test/fixtures/story.xml",
+    "test/peaty_test.rb",
+    "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/mtodd/peaty}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Pivotal Tracker API Implementation}
+  s.test_files = [
+    "test/peaty_test.rb",
+    "test/test_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::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, ["~> 3.0.1"])
+      s.add_runtime_dependency(%q<nokogiri>, [">= 0"])
+      s.add_runtime_dependency(%q<nokogiri-happymapper>, [">= 0"])
+      s.add_runtime_dependency(%q<rest-client>, [">= 0"])
+      s.add_runtime_dependency(%q<xml_to_json>, ["= 0.0.1"])
+      s.add_runtime_dependency(%q<yajl-ruby>, [">= 0"])
+      s.add_development_dependency(%q<yajl-ruby>, [">= 0"])
+      s.add_development_dependency(%q<builder>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["= 2.1.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.0.pre6"])
+      s.add_development_dependency(%q<rails_code_qa>, [">= 0"])
+      s.add_runtime_dependency(%q<nokogiri>, ["= 1.4.3.1"])
+      s.add_development_dependency(%q<yajl-ruby>, ["= 0.7.8"])
+      s.add_development_dependency(%q<activesupport>, ["~> 3.0.1"])
+      s.add_development_dependency(%q<builder>, ["= 2.1.2"])
+      s.add_development_dependency(%q<rspec>, ["= 2.1.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.0.pre6"])
+      s.add_development_dependency(%q<rails_code_qa>, [">= 0"])
+    else
+      s.add_dependency(%q<activesupport>, ["~> 3.0.1"])
+      s.add_dependency(%q<nokogiri>, [">= 0"])
+      s.add_dependency(%q<nokogiri-happymapper>, [">= 0"])
+      s.add_dependency(%q<rest-client>, [">= 0"])
+      s.add_dependency(%q<xml_to_json>, ["= 0.0.1"])
+      s.add_dependency(%q<yajl-ruby>, [">= 0"])
+      s.add_dependency(%q<yajl-ruby>, [">= 0"])
+      s.add_dependency(%q<builder>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["= 2.1.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.0.pre6"])
+      s.add_dependency(%q<rails_code_qa>, [">= 0"])
+      s.add_dependency(%q<nokogiri>, ["= 1.4.3.1"])
+      s.add_dependency(%q<yajl-ruby>, ["= 0.7.8"])
+      s.add_dependency(%q<activesupport>, ["~> 3.0.1"])
+      s.add_dependency(%q<builder>, ["= 2.1.2"])
+      s.add_dependency(%q<rspec>, ["= 2.1.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.0.pre6"])
+      s.add_dependency(%q<rails_code_qa>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, ["~> 3.0.1"])
+    s.add_dependency(%q<nokogiri>, [">= 0"])
+    s.add_dependency(%q<nokogiri-happymapper>, [">= 0"])
+    s.add_dependency(%q<rest-client>, [">= 0"])
+    s.add_dependency(%q<xml_to_json>, ["= 0.0.1"])
+    s.add_dependency(%q<yajl-ruby>, [">= 0"])
+    s.add_dependency(%q<yajl-ruby>, [">= 0"])
+    s.add_dependency(%q<builder>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["= 2.1.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.0.pre6"])
+    s.add_dependency(%q<rails_code_qa>, [">= 0"])
+    s.add_dependency(%q<nokogiri>, ["= 1.4.3.1"])
+    s.add_dependency(%q<yajl-ruby>, ["= 0.7.8"])
+    s.add_dependency(%q<activesupport>, ["~> 3.0.1"])
+    s.add_dependency(%q<builder>, ["= 2.1.2"])
+    s.add_dependency(%q<rspec>, ["= 2.1.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.0.pre6"])
+    s.add_dependency(%q<rails_code_qa>, [">= 0"])
+  end
+end
+

data/test/.gitignore

@@ -0,0 +1 @@
+*.log