pivotal_db 0.1.0.pre

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in pivotal_db.gemspec
+gemspec

data/README.md

@@ -0,0 +1,27 @@
+
+# Pivotal DB
+
+Pull Pivotal Tracker stories into a local SQLite database.  No changes to the local DB will be reflected in Pivotal Tracker (this is not sync).
+
+This provides a basic CLI (pivotal-db) along with a Ruby library.
+
+## Installation
+
+    gem install pivotal_db
+
+## Configuration
+
+Before starting, you'll have to add a configuration file at ~/.pivotal_db/config.yml like the following:
+
+    default:
+      project_id: 123
+      api_token: secret
+      db_file: ~/.pivotal_db/pivotal.db
+
+Your API token can be found on Pivotal Tracker at https://www.pivotaltracker.com/profile.
+
+## Usage
+
+To see usage, run (without any arguments)
+
+    pivotal-db

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/pivotal-db

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+
+require 'pivotal_db'
+require 'configliere'
+
+pivotal_db_dir = File.expand_path("~/.pivotal_db/")
+
+Settings.use :commandline
+Settings({
+           :config_file => pivotal_db_dir + '/config.yml',
+           :project => :default,
+           :default => {
+             :project_id => nil,
+             :api_token => nil,
+             :db_file => pivotal_db_dir + '/pivotal.db'
+           }
+         })
+Settings.resolve!
+
+unless File.exist?(Settings[:config_file])
+  puts "The configuration file #{Settings[:config_file]} does not exist."
+  puts "Please create one like the following example."
+  puts
+  puts "default:"
+  puts "  project_id: 123"
+  puts "  api_token: secret"
+  puts "  db_file: ~/.pivotal_db/pivotal.db"
+  puts
+  puts "The API token can be found on Pivotal Tracker at"
+  puts "  https://www.pivotaltracker.com/profile"
+  Process.exit
+end
+
+Settings.use :commandline
+Settings.read Settings[:config_file]
+Settings.resolve!
+
+PivotalDb::CLI.start
+

data/lib/pivotal_db/cli.rb

@@ -0,0 +1,55 @@
+require 'thor'
+
+module PivotalDb
+  class CLI < Thor
+
+    desc "stats", "stats"
+    def stats
+      tracker = Tracker.new(Settings[Settings[:project]])
+      puts "Projects: #{Project.all.count}"
+      puts "Stories: #{Story.all.count}"
+      puts "Notes: #{Note.all.count}"
+    end
+
+    desc "pull", "pull all stories from Pivotal Tracker (this may take a while)"
+    def pull
+      begin
+        Tracker.new(Settings[Settings[:project]]).pull
+      rescue DataMapper::SaveFailureError => e
+          p e.resource.errors
+      end
+    end
+
+    desc "random", "return a random incomplete story for review"
+    def random
+      tracker = Tracker.new(Settings[Settings[:project]])
+      puts
+      puts tracker.random
+      puts
+    end
+
+    desc "search", "search for the given term in the stories"
+    def search(term)
+      found = Tracker.new(Settings[Settings[:project]]).search(term)
+      puts "#{found.count} Results"
+      found.each do |story|
+        puts
+        puts story.to_s(:brief)
+        puts
+      end
+    end
+
+    desc "show", "show a particular story by ID or URL"
+    def show(story_id)
+      tracker = Tracker.new(Settings[Settings[:project]])
+      story_id = story_id.gsub(/.*\//, "")
+      story = Story.get(story_id)
+      if story
+        puts story.to_s(:detailed)
+      else
+        puts "No story found"
+      end
+    end
+      
+  end
+end

data/lib/pivotal_db/label.rb

@@ -0,0 +1,15 @@
+module PivotalDb
+  class Label
+    
+    include DataMapper::Resource
+    
+    property :id, Serial
+    property :name, String
+    property :created_at, DateTime
+    property :updated_at, DateTime
+    
+    has n, :labelings, :constraint => :destroy
+    has n, :stories, :through => :labelings
+    
+  end
+end

data/lib/pivotal_db/labeling.rb

@@ -0,0 +1,14 @@
+module PivotalDb
+  class Labeling
+    
+    include DataMapper::Resource
+    
+    property :id, Serial
+    property :created_at, DateTime
+    property :updated_at, DateTime
+
+    belongs_to :story
+    belongs_to :label
+
+  end
+end

data/lib/pivotal_db/membership.rb

@@ -0,0 +1,36 @@
+module PivotalDb
+  class Membership
+    
+    include DataMapper::Resource
+    include PivotalSource
+    
+    property :id, Serial
+    property :created_at, DateTime
+    property :updated_at, DateTime
+    
+    belongs_to :role
+    belongs_to :project
+    belongs_to :person
+
+    def find_datasource
+      self.project.datasource.memberships.all.find{|membership_ds| membership_ds == self.id}
+    end
+
+    def update_from_datasource
+
+      role = Role.first_or_create(:name => datasource.role)
+
+      person = Person.first(:email => datasource.email) || Person.new
+      person.datasource = datasource
+      person.pull
+
+      self.attributes = {
+        :id => datasource.id,
+        :role => role,
+        :person => person
+      }
+      self.save
+    end
+
+  end
+end

data/lib/pivotal_db/note.rb

@@ -0,0 +1,43 @@
+module PivotalDb
+  class Note
+    
+    include DataMapper::Resource
+    include PivotalSource
+    
+    property :id, Serial
+    property :noted_at, DateTime
+    property :text, Text
+    property :created_at, DateTime
+    property :updated_at, DateTime
+
+    belongs_to :story
+    belongs_to :author, 'Person', :required => false
+
+    def find_datasource
+      self.story.datasource.notes.all.find{|note_ds| note_ds.id == self.id}
+    end
+
+    def update_from_datasource
+
+      project = Project.first(datasource.project_id)
+      author = project.people.first(:name => datasource.author)
+      self.attributes = {
+        :id => datasource.id,
+        :story_id => datasource.story_id,
+        :author => author,
+        :noted_at => datasource.noted_at,
+        :text => datasource.text
+      }
+      self.save
+
+    end
+
+    def to_s
+      str = ""
+      str += "#{self.author.name}, #{self.noted_at.to_s}:\n"
+      str += "\n#{self.text}\n"
+      str
+    end
+
+  end
+end

data/lib/pivotal_db/person.rb

@@ -0,0 +1,28 @@
+module PivotalDb
+  class Person
+    
+    include DataMapper::Resource
+    include PivotalSource
+    
+    property :id, Serial
+    property :name, String
+    property :email, String, :unique => true
+    property :initials, String
+    property :created_at, DateTime
+    property :updated_at, DateTime
+    
+    has n, :notes, :child_key => [ :author_id ]
+    has n, :requested_stories, :model => 'Story', :child_key => [ :requested_by_id ]
+    has n, :owned_stories, :model => 'Story', :child_key => [ :owned_by_id ]
+
+    def update_from_datasource
+      self.attributes = {
+        :name => datasource.name,
+        :email => datasource.email,
+        :initials => datasource.initials
+      }
+      self.save
+    end
+
+  end
+end

data/lib/pivotal_db/pivotal_source.rb

@@ -0,0 +1,42 @@
+module PivotalDb
+
+  module PivotalSource
+
+    def self.included(base)
+      base.extend(ClassMethods)
+      
+      base.class_eval do
+        property :updated_from_datasource_at, DateTime
+      end
+    end
+
+    def find_datasource
+      raise NotImplementedError
+    end
+    
+    def datasource
+      @datasource ||= find_datasource
+    end
+
+    def datasource=(ds)
+      @datasource = ds
+    end
+
+    def pull
+      update_from_datasource
+      self.updated_from_datasource_at = Time.now
+      self.save
+    end
+    
+    private
+
+    def update_from_datasource
+      raise NotImplementedError      
+    end
+
+    module ClassMethods
+    end
+
+  end
+
+end

data/lib/pivotal_db/project.rb

@@ -0,0 +1,61 @@
+module PivotalDb
+
+  class Project
+    
+    include DataMapper::Resource
+    include PivotalSource
+
+    property :id, Serial
+    property :name, String
+    property :created_at, DateTime
+    property :updated_at, DateTime
+
+    has n, :stories, :constraint => :destroy
+    has n, :notes, :through => :stories
+    has n, :memberships, :constraint => :destroy
+    has n, :people, :through => :memberships
+
+    def find_datasource
+      PivotalTracker::Project.find(self.id)
+    end
+
+    def update_from_datasource
+
+      self.attributes = {
+        :name => datasource.name
+      }
+      self.save
+
+      pull_memberships
+      pull_stories
+      
+    end
+
+    private
+
+    def pull_memberships
+      datasource.memberships.all.each do |membership_ds|
+        membership = self.memberships.first(:id => membership_ds.id, :project => self) || Membership.new(:id => membership_ds.id, :project => self)
+        membership.datasource = membership_ds
+        membership.pull
+      end
+    end
+
+    def pull_stories
+      limit = 1000
+      offset = 0
+      while true
+        found_stories = false
+        datasource.stories.all(:offset => offset, :limit => limit).each do |story_ds|
+          found_stories = true
+          story = self.stories.first(:id => story_ds.id) || Story.new
+          story.datasource = story_ds
+          story.pull
+        end
+        break unless found_stories
+        offset += limit
+      end
+    end
+
+  end
+end

data/lib/pivotal_db/role.rb

@@ -0,0 +1,10 @@
+module PivotalDb
+  class Role
+    
+    include DataMapper::Resource
+    
+    property :id, Serial
+    property :name, String
+
+  end
+end

data/lib/pivotal_db/story.rb

@@ -0,0 +1,101 @@
+module PivotalDb
+  class Story
+    
+    include DataMapper::Resource
+    include PivotalSource
+    
+    property :id, Serial
+    property :name, Text
+    property :description, Text
+    property :estimate, Integer
+    property :story_created_at, DateTime
+    property :updated_from_pivotal_source, Boolean
+    property :created_at, DateTime
+    property :updated_at, DateTime
+
+    belongs_to :project
+    belongs_to :story_state
+    belongs_to :story_type
+    belongs_to :requested_by, 'Person', :required => false
+    belongs_to :owned_by, 'Person', :required => false
+
+    has n, :notes, :constraint => :destroy
+    has n, :labelings, :constraint => :destroy
+    has n, :labels, :through => :labelings
+    
+    def find_datasource
+      PivotalTracker::Story.find(self.id, self.project_id)
+    end
+
+    def update_from_datasource
+
+      self.project ||= Project.first(:id => datasource.project_id)
+
+      requested_by = self.project.people.first(:name => datasource.requested_by)
+      owned_by = datasource.owned_by.nil? ? nil : self.project.people.first(:name => datasource.requested_by)
+          
+      labels = (datasource.labels || "").split(",").map{|label| Label.first_or_create(:name => label.strip)}
+          
+      story_state = StoryState.first_or_create(:name => datasource.current_state)
+      story_type = StoryType.first_or_create(:name => datasource.story_type)
+          
+      self.attributes = {
+        :id => datasource.id,
+        :project_id => datasource.project_id,
+        :requested_by => requested_by,
+        :owned_by => owned_by,
+        :story_type => story_type,
+        :story_state => story_state,
+        :labels => labels,
+        :name => datasource.name, 
+        :description => datasource.description, 
+        :estimate => datasource.estimate,
+        :story_created_at => datasource.created_at
+      }
+      self.save
+      
+      pull_notes
+    end
+
+    def pull_notes
+      datasource.notes.all.each do |note_ds|
+        note = self.notes.first(:id => note_ds.id) || self.notes.new(:id => note_ds.id)
+        note.datasource = note_ds
+        note.pull
+      end
+    end
+
+    def to_s(detail_level = :summary)
+      detail_levels = {:brief => 1, :summary => 2, :detailed => 3}
+      detail = detail_levels[detail_level]
+
+      requested_by_name = self.requested_by ? self.requested_by.name : ""
+      owned_by_name = self.owned_by ? " => " + self.owned_by.name : ""
+      str = ""
+      str += "https://www.pivotaltracker.com/story/show/#{self.id}\n"
+      str += "#{self.name}\n"
+      str += self.story_type.name + ": " + self.labels.map{|label| label.name}.join(", ") + "\n"
+      str += requested_by_name + owned_by_name + ": " + self.story_created_at.to_s + "\n"
+      
+      if detail_levels[:summary] <= detail
+        str += "\n#{self.description}\n"
+      end
+
+      sorted_notes = self.notes.all(:order => [:noted_at.asc])
+      if detail_levels[:detailed] <= detail
+        sorted_notes.each do |note|
+          str += note.to_s + "\n"
+        end
+      elsif detail_levels[:summary] <= detail
+        unless sorted_notes.blank?
+          str += "\n#{sorted_notes.count} Notes\n"
+          note = sorted_notes.last
+          str += "\nLatest Note:\n"
+          str += note.to_s
+        end
+      end
+      str
+    end
+
+  end
+end

data/lib/pivotal_db/story_state.rb

@@ -0,0 +1,14 @@
+module PivotalDb
+  class StoryState
+    
+    include DataMapper::Resource
+    
+    property :id, Serial
+    property :name, String
+    property :created_at, DateTime
+    property :updated_at, DateTime
+
+    has n, :stories
+    
+  end
+end

data/lib/pivotal_db/story_type.rb

@@ -0,0 +1,14 @@
+module PivotalDb
+  class StoryType
+    
+    include DataMapper::Resource
+    
+    property :id, Serial
+    property :name, String
+    property :created_at, DateTime
+    property :updated_at, DateTime
+    
+    has n, :stories
+    
+  end
+end

data/lib/pivotal_db/tracker.rb

@@ -0,0 +1,61 @@
+require 'data_mapper'
+require 'pivotal_tracker'
+
+module PivotalDb
+  class Tracker
+    
+    def initialize(options = {})
+
+      @api_token = options[:api_token]
+      @project_id = options[:project_id]
+      @db_file = File.expand_path(options[:db_file])
+
+      raise ArgumentError, "requires api_token, project_id, and db_file" unless @api_token && @project_id && @db_file
+
+      DataMapper::Model.raise_on_save_failure = true
+
+      DataMapper.setup(:default, 'sqlite://' + @db_file)
+
+      DataMapper.repository(:default).adapter.resource_naming_convention =
+        DataMapper::NamingConventions::Resource::UnderscoredAndPluralizedWithoutModule
+      DataMapper.finalize
+      DataMapper.auto_upgrade!
+      
+    end
+
+    def pull
+
+      pull_start = Time.now
+      PivotalTracker::Client.token = @api_token
+      PivotalTracker::Client.use_ssl = true
+      project_ds = PivotalTracker::Project.find(@project_id)
+      project = Project.first_or_create(:id => project_ds.id)
+      
+      project.datasource = project_ds
+      project.pull
+      
+      # destroy stale records
+      project.stories.all(:updated_from_datasource_at.lt => pull_start).destroy
+      project.notes.all(:updated_from_datasource_at.lt => pull_start).destroy
+    end
+
+    def random
+      project = Project.first(:id => @project_id)
+      state_ids = StoryState.all(:name => ["unstarted", "unscheduled", "rejected"]).map{|state| state.id}
+      story_id = DataMapper.repository(:default).adapter.select('SELECT id FROM stories WHERE story_state_id IN ? ORDER BY RANDOM() LIMIT 1', state_ids).first
+      Story.get(story_id)
+    end
+
+    def search(term, states = nil)
+      project = Project.first(:id => @project_id)
+      if states.nil?
+        state_ids = StoryState.all.map{|state| state.id}
+      else
+        state_ids = StoryState.all(:name => states).map{|state| state.id}
+      end
+      story_ids = DataMapper.repository(:default).adapter.select('SELECT stories.id FROM stories LEFT JOIN notes ON stories.id = notes.story_id WHERE story_state_id IN ? AND (name LIKE ? OR description LIKE ? OR notes.text LIKE ?)', state_ids, "%#{term}%", "%#{term}%", "%#{term}%")
+      Story.all(:id => story_ids)
+    end
+
+  end
+end

data/lib/pivotal_db/version.rb

@@ -0,0 +1,3 @@
+module PivotalDb
+  VERSION = "0.1.0.pre"
+end

data/lib/pivotal_db.rb

@@ -0,0 +1,15 @@
+require "pivotal_db/version"
+require "pivotal_db/pivotal_source"
+require "pivotal_db/tracker"
+require "pivotal_db/cli"
+require "pivotal_db/project"
+require "pivotal_db/person"
+require "pivotal_db/membership"
+require "pivotal_db/role"
+require "pivotal_db/story"
+require "pivotal_db/note"
+require "pivotal_db/label"
+require "pivotal_db/labeling"
+require "pivotal_db/story_type"
+require "pivotal_db/story_state"
+

data/pivotal_db.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "pivotal_db/version"
+
+Gem::Specification.new do |s|
+  s.name        = "pivotal_db"
+  s.version     = PivotalDb::VERSION
+  s.authors     = ["Fraser Newton"]
+  s.email       = ["fraser@goclio.com"]
+  s.homepage    = ""
+  s.summary     = %q{Offline Access to Pivotal Tracker projects}
+  s.description = %q{Pull a Pivotal Tracker project into an sqlite DB and provides basic search functionality through a CLI}
+
+  s.rubyforge_project = "pivotal_db"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec"
+  s.add_dependency "pivotal-tracker", "~>0.4"
+  s.add_dependency "sqlite3", "~>1.3"
+  s.add_dependency "data_mapper"
+  s.add_dependency "dm-sqlite-adapter"
+  s.add_dependency "thor"
+  s.add_dependency "configliere"
+end

data/spec/pivotal_db_spec.rb

@@ -0,0 +1,8 @@
+require 'pivotal_db/tracker'
+
+describe PivotalDb::Tracker do
+  it "example test" do
+    PivotalDb::Tracker.example.should eql("example")
+  end
+
+end

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification 
+name: pivotal_db
+version: !ruby/object:Gem::Version 
+  hash: 961915980
+  prerelease: 6
+  segments: 
+  - 0
+  - 1
+  - 0
+  - pre
+  version: 0.1.0.pre
+platform: ruby
+authors: 
+- Fraser Newton
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-07 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: pivotal-tracker
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        - 4
+        version: "0.4"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 1
+        - 3
+        version: "1.3"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: data_mapper
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: dm-sqlite-adapter
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: thor
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: configliere
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id007
+description: Pull a Pivotal Tracker project into an sqlite DB and provides basic search functionality through a CLI
+email: 
+- fraser@goclio.com
+executables: 
+- pivotal-db
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- bin/pivotal-db
+- lib/pivotal_db.rb
+- lib/pivotal_db/cli.rb
+- lib/pivotal_db/label.rb
+- lib/pivotal_db/labeling.rb
+- lib/pivotal_db/membership.rb
+- lib/pivotal_db/note.rb
+- lib/pivotal_db/person.rb
+- lib/pivotal_db/pivotal_source.rb
+- lib/pivotal_db/project.rb
+- lib/pivotal_db/role.rb
+- lib/pivotal_db/story.rb
+- lib/pivotal_db/story_state.rb
+- lib/pivotal_db/story_type.rb
+- lib/pivotal_db/tracker.rb
+- lib/pivotal_db/version.rb
+- pivotal_db.gemspec
+- spec/pivotal_db_spec.rb
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      hash: 25
+      segments: 
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
+requirements: []
+
+rubyforge_project: pivotal_db
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Offline Access to Pivotal Tracker projects
+test_files: 
+- spec/pivotal_db_spec.rb