pivotal_shell 0.1.0 → 0.2.0

data/.gitignore

@@ -2,3 +2,4 @@ pkg/*
 *.gem
 .bundle
 .pivotalrc
+.pivotal_cache

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    pivotal_shell (0.1.0)
-      pivotal-tracker (= 0.3)
+    pivotal_shell (0.2.0)
+      pivotal-tracker (> 0.3)
+      sqlite3
 
 GEM
   remote: http://rubygems.org/
@@ -13,17 +14,17 @@ GEM
     libxml-ruby (1.1.4)
     mime-types (1.16)
     nokogiri (1.4.3.1)
-    pivotal-tracker (0.3.0)
+    pivotal-tracker (0.3.1)
       builder
       happymapper (>= 0.3.2)
       nokogiri (~> 1.4.3.1)
       rest-client (~> 1.6.0)
     rest-client (1.6.1)
       mime-types (>= 1.16)
+    sqlite3 (1.3.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  pivotal-tracker (= 0.3)
   pivotal_shell!

data/README.markdown

@@ -1,6 +1,6 @@
 # pivotal_shell
 
-A command-line wrapper for [Pivotal Tracker](http://www.pivotaltracker.com)
+A command-line client for [Pivotal Tracker](http://www.pivotaltracker.com)
 
 ## Installation
 
@@ -58,8 +58,27 @@ Finish story
 
     pivotal finish 123456
 
+## Caching
+
+`pivotal-shell` caches story and user information into a local database. This can greatly speed up execution since Pivotal Tracker can be *slooow* sometimes.
+The database is synchronised with the actual project data each 15 minutes (that is, if you call a `pivotal` command and the database is older that 15 minutes, it's updated).
+To change this interval, use the `refresh_interval` parameter in the global or project `.pivotalrc`; the value is in minutes; set it to `-1` to completely disable updating, which can be
+useful if you're going to do it by `cron`.
+
+There are two commands related to caching:
+
+    pivotal update # update stories from the server
+
+    pivotal reload # completely reinitialize the database; use this in case of bugs
+
+You can add this to your crontab to enable autoupdate:
+
+    0,15,30,45 * * * * cd /your/project/path && pivotal update
+
 ## TODO
 
-Commit (with git, all comments after the story id go to git, story id gets appended to comments)
+* Commit (with git, all comments after the story id go to git, story id gets appended to comments)
 
     pivotal commit 123456 "some more comments"
+
+* Refactor caching code

data/bin/pivotal

@@ -3,6 +3,7 @@
 require 'optparse'
 require 'pivotal_shell'
 require 'pivotal_shell/configuration'
+require 'pivotal_shell/cache'
 #require 'active_support/core_ext'
 
 PivotalShell::Configuration.load
@@ -12,6 +13,8 @@ commands = [
   ['story', 'show information about a specific story'],
   ['start', 'start a story'],
   ['finish', 'finish a story'],
+  ['update', 'update stories status from the server'],
+  ['reload', 'reload entire project from the server'],
 ]
 
 banner = "Pivotal command-line client #{PivotalShell::VERSION}\nUsage: pivotal COMMAND PARAMS\n\nAvailable commands:\n\n#{commands.map{|c, d| "#{c} - #{d}"}.join("\n")}\n\nRun pivotal COMMAND --help for more info on a specific command\n\n"

data/examples/commit-msg

@@ -0,0 +1,3 @@
+#!/usr/bin/env sh
+
+pivotal commit $1

data/lib/pivotal_shell.rb

@@ -4,6 +4,9 @@ module PivotalShell
   class Exception < StandardError; end
 end
 
+require 'pivotal_shell/version'
+require 'pivotal_shell/configuration'
+require 'pivotal_shell/cache'
 require 'pivotal_shell/command'
 
 # fixing pivotal-tracker's options encoding; it did not work with array filters
@@ -14,11 +17,11 @@ module PivotalTracker
       options_strings = []
       # remove options which are not filters, and encode them as such
       [:limit, :offset].each do |o|
-        options_strings << "#{CGI.escape(o.to_s)}=#{CGI.escape(options.delete(o))}" if options[o]
+        options_strings << "#{CGI.escape(o.to_s)}=#{CGI.escape(options.delete(o).to_s)}" if options[o]
       end
       # assume remaining key-value pairs describe filters, and encode them as such.
       filters_string = options.map do |key, value|
-        "#{CGI.escape(key.to_s)}%3A#{CGI.escape([value].flatten.map{|v| v.include?(' ') ? '"'+v+'"' : v}.join(','))}"
+        "#{CGI.escape(key.to_s)}%3A#{CGI.escape([value].flatten.map{|v| v=v.to_s; v.include?(' ') ? '"'+v+'"' : v}.join(','))}"
       end
       options_strings << "filter=#{filters_string.join('+')}" unless filters_string.empty?
       return "?#{options_strings.join('&')}"

data/lib/pivotal_shell/cache.rb

@@ -0,0 +1,145 @@
+require 'sqlite3'
+require 'pivotal_shell/configuration'
+require 'pivotal_shell/cache/story'
+require 'pivotal_shell/cache/user'
+
+class PivotalShell::Cache
+  STORY_ATTRIBUTES=%w(requested_by_id name id current_state accepted_at labels url estimate description created_at owned_by_id story_type)
+  
+  attr_reader :db
+
+  def initialize(filename)
+    @filename = filename
+    @db = SQLite3::Database.new(@filename)
+    @db.results_as_hash = true
+    create_tables
+    refresh_if_needed
+  end
+
+  def inspect
+    "#<PivotalShell::Cache #{@filename}>"
+  end
+
+  def refresh
+    load_stories(:modified_since => self[:last_updated_at])
+  end
+
+  def reload
+    db.execute('DELETE FROM users')
+    db.execute('DELETE FROM stories')
+    @users = nil
+    load_stories
+  end
+
+  def [](key)
+    resultset = db.execute('SELECT value FROM settings WHERE name=?', key.to_s)
+    resultset.empty? ? nil : YAML.load(resultset.first['value'])
+  end
+
+  def []=(key, value)
+    db.execute('REPLACE INTO settings (name, value) VALUES (?,?)', key.to_s, YAML.dump(value))
+    value
+  end
+
+
+protected
+
+  def users
+    @users ||= load_users_from_cache
+  end
+
+  def refresh_if_needed
+    updated_at = self[:last_updated_at]
+    if updated_at.nil?
+      puts 'Retrieving all stories from Pivotal Tracker. This could take a while...'
+      load_stories
+    else
+      refresh if (PivotalShell::Configuration.refresh_interval>0) && (self[:last_updated_at]+PivotalShell::Configuration.refresh_interval*60 < Time.now)
+    end
+  end
+
+  def load_stories(options={})
+    # Pivotal Tracker API limits one stories call to 3000 results. Thus we need to paginate.
+    all_stories = []
+    limit = 3000
+    offset = 0
+    begin
+      new_stories = PivotalShell::Configuration.project.stories.all(options.merge(:limit => limit, :offset => offset))
+      all_stories += new_stories unless new_stories.empty?
+      offset+=limit
+    end until new_stories.empty?
+    save_stories_to_cache(all_stories)
+    self[:last_updated_at] = Time.now
+  end
+
+  def load_users
+    PivotalShell::Configuration.project.memberships.all.each do |membership|
+      if row = db.execute('SELECT id FROM users WHERE name=?', membership.name).first
+        db.execute('UPDATE USERS SET role=?, initials=?, email=? WHERE id=?', membership.role, membership.initials, membership.email, row['id'])
+      else
+        db.execute('INSERT INTO USERS (name, role, initials, email) VALUES(?,?,?,?)', membership.name, membership.role, membership.initials, membership.email)
+      end
+    end
+    @users = load_users_from_cache
+  end
+
+  def load_users_from_cache
+    db.execute('SELECT id,name,role,initials,email FROM users').inject({}) do |hash,row|
+      hash[row['name'].to_s] = row
+      hash
+    end
+  end
+
+  def user_id_by_name(name)
+    name=name.to_s
+    return nil if name==''
+    user = users[name]
+    if user.nil?
+      load_users
+      user = users[name]
+      if user.nil?
+        db.execute('INSERT INTO USERS (name, role, initials, email) VALUES(?,"","","")', name)
+        load_users_from_cache
+        user=users[name]
+      end
+    end
+    user && user['id']
+  end
+
+  def save_stories_to_cache(stories)
+    insert_query = 'INSERT INTO stories (url, name, description, story_type, estimate, labels, current_state, requested_by_id, owned_by_id, created_at, accepted_at, id) VALUES (?,?,?,?,?,?,?,?,?,?,?,?)'
+    update_query = 'UPDATE stories SET url=?, name=?, description=?, story_type=?, estimate=?, labels=?, current_state=?, requested_by_id=?, owned_by_id=?, created_at=?, accepted_at=? WHERE id=?'
+    stories.each do |story|
+      requested_by_id = user_id_by_name(story.requested_by)
+      owned_by_id = user_id_by_name(story.owned_by)
+      created_at = story.created_at && story.created_at.strftime("%Y-%m-%d %H:%M:%S")
+      accepted_at = story.accepted_at && story.accepted_at.strftime("%Y-%m-%d %H:%M:%S")
+      query = db.execute('SELECT id FROM stories WHERE id=?', story.id).first ? update_query : insert_query
+      db.execute query, story.url, story.name, story.description, story.story_type, story.estimate, story.labels, story.current_state, requested_by_id, owned_by_id, created_at, accepted_at, story.id
+    end
+  end
+
+  def create_tables
+    db.execute('CREATE TABLE IF NOT EXISTS settings (name VARCHAR NOT NULL, value VARCHAR)')
+    db.execute('CREATE UNIQUE INDEX IF NOT EXISTS settings_name ON settings(name)')
+    db.execute('CREATE TABLE IF NOT EXISTS users (id INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT, role VARCHAR NOT NULL, name VARCHAR NOT NULL, initials VARCHAR NOT NULL, email VARCHAR NOT NULL)')
+    db.execute('CREATE UNIQUE INDEX IF NOT EXISTS users_name ON users(name)')
+    db.execute(<<SQL
+      CREATE TABLE IF NOT EXISTS stories (
+        id INTEGER NOT NULL PRIMARY KEY,
+        url VARCHAR NOT NULL,
+        name VARCHAR NOT NULL,
+        description TEXT,
+        story_type VARCHAR,
+        estimate INTEGER,
+        labels VARCHAR,
+        current_state VARCHAR,
+        requested_by_id INTEGER,
+        owned_by_id INTEGER,
+        created_at DATETIME,
+        accepted_at DATETIME
+      )
+SQL
+    )
+  end
+end

data/lib/pivotal_shell/cache/story.rb

@@ -0,0 +1,69 @@
+class PivotalShell::Cache
+  class Story
+    ATTRIBUTES=%w(requested_by_id name id current_state accepted_at labels url estimate description created_at owned_by_id story_type)
+    STATUSES = %w(unscheduled unstarted started finished delivered accepted rejected)
+    TYPES = %w(feature bug chore)
+    
+    ATTRIBUTES.each do |attribute|
+      attr_reader attribute
+    end
+
+    def initialize(source={})
+      if source.is_a? PivotalTracker::Story
+        raise 'TODO'
+      elsif source.is_a? Hash
+        create_from_hash(source)
+      end
+    end
+
+    def self.find(id)
+      hash = PivotalShell::Configuration.cache.db.execute("SELECT * FROM stories WHERE id=?", id).first
+      hash && new(hash)
+    end
+
+    def self.all(params)
+      conditions = []
+      query_params = []
+      if params[:unowned]
+        conditions << "owned_by_id IS NULL"
+      elsif params[:owner] && (owner = PivotalShell::Cache::User.find(params[:owner]))
+        conditions << "owned_by_id==?"
+        query_params << owner.id
+      end
+      
+      if params[:state]
+        params[:state] = [params[:state]].flatten
+        conditions << "current_state IN (#{(["?"]*params[:state].length).join(',')})"
+        query_params << params[:state]
+      end
+
+      if params[:type]
+        params[:type] = [params[:type]].flatten
+        conditions << "story_type IN (#{(["?"]*params[:type].length).join(',')})"
+        query_params << params[:type]
+      end
+
+      query = 'SELECT * FROM stories'
+      query << ' WHERE '+conditions.map{|c| "(#{c})"}.join(' AND ') unless conditions.empty?
+      puts query.inspect
+      PivotalShell::Configuration.cache.db.execute(query, query_params).map {|r| new(r)}
+    end
+
+    def owned_by
+      return nil if owned_by_id.nil?
+      @owned_by ||= PivotalShell::Cache::User.find(owned_by_id)
+    end
+
+    def requested_by
+      return nil if requested_by_id.nil?
+      @requested_by ||= PivotalShell::Cache::User.find(requested_by_id)
+    end
+
+  protected
+    def create_from_hash(hash)
+      PivotalShell::Cache::Story::ATTRIBUTES.each do |attribute|
+        self.instance_variable_set("@#{attribute}", hash[attribute])
+      end
+    end
+  end
+end

data/lib/pivotal_shell/cache/user.rb

@@ -0,0 +1,33 @@
+class PivotalShell::Cache
+  class User
+    ATTRIBUTES=%w(name id initials email)
+    
+    ATTRIBUTES.each do |attribute|
+      attr_reader attribute
+    end
+    
+    def initialize(source={})
+      if source.is_a? PivotalTracker::Membership
+        raise 'TODO'
+      elsif source.is_a? Hash
+        create_from_hash(source)
+      end
+    end
+
+    def to_s
+      name
+    end
+    
+    def self.find(id)
+      hash = PivotalShell::Configuration.cache.db.execute("SELECT * FROM users WHERE id=? OR initials=? OR name=? OR email=?", id, id, id, id).first
+      hash && new(hash)
+    end
+
+  protected
+    def create_from_hash(hash)
+      PivotalShell::Cache::User::ATTRIBUTES.each do |attribute|
+        self.instance_variable_set("@#{attribute}", hash[attribute])
+      end
+    end
+  end
+end

data/lib/pivotal_shell/command.rb

@@ -1,4 +1,8 @@
 class PivotalShell::Command
   def initialize(options)
   end
+
+  def execute
+    raise "Override me!"
+  end
 end

data/lib/pivotal_shell/commands/commit.rb

@@ -0,0 +1,16 @@
+module PivotalShell::Commands
+  class PivotalShell::Commands::Commit < PivotalShell::Command
+    def initialize(options)
+      @message = options[0]
+    end
+
+    def execute
+      puts 'Doesnt work yet! Sorry.'
+      #exit 0 if (message =~ /\[#\d+\]/) || (message =~ /merge/i) # there is already a task ID in the message, or it is a merge
+
+      #input = File.open('/dev/tty', 'r')
+      
+      #PivotalShell::Configuration.cache.update
+    end
+  end
+end

data/lib/pivotal_shell/commands/finish.rb

@@ -29,6 +29,7 @@ module PivotalShell::Commands
         puts 'Story is not in a started state: '+@story.name
       else
         @story.update(:current_state => 'started')
+        PivotalShell::Configuration.cache.refresh
       end
     end
   end

data/lib/pivotal_shell/commands/reload.rb

@@ -0,0 +1,19 @@
+module PivotalShell::Commands
+  class PivotalShell::Commands::Reload < PivotalShell::Command
+    def initialize(options)
+      opts = OptionParser.new do |opts|
+        opts.banner = "Completely reload the stories database from Pivotal Tracker"
+        
+        opts.on_tail('--help', 'Show this help') do
+          puts opts
+          exit
+        end
+        opts.parse!(options)
+      end
+    end
+
+    def execute
+      PivotalShell::Configuration.cache.reload
+    end
+  end
+end

data/lib/pivotal_shell/commands/start.rb

@@ -31,6 +31,7 @@ module PivotalShell::Commands
         puts 'Story is already finished: '+@story.name
       else
         @story.update(:current_state => 'started')
+        PivotalShell::Configuration.cache.refresh
       end
     end
   end

data/lib/pivotal_shell/commands/stories.rb

@@ -5,8 +5,6 @@ module PivotalShell::Commands
     def initialize(options)
       @options = {:params => {}}
 
-      available_statuses = %w(unscheduled unstarted started finished delivered accepted rejected)
-      available_types = %w(features bugs chores)
 
       opts = OptionParser.new do |opts|
         opts.banner = "List Pivotal stories\nUsage: pivotal stories [options]\n\nThe default is to show all unfinished stories assigned to yourself\n\nDisplay format:\n  [id]\n  type: Feature/Bug/Chore\n  estimate: * (irrelevant)/0/1/2/3\n  state: . (unscheduled)/Unstarted/Started/Finished/Delivered/Accepted/Rejected\n  title\n\nOptions:"
@@ -16,17 +14,17 @@ module PivotalShell::Commands
           @options[:all] = true
         end
 
-        available_statuses.each do |status|
+        PivotalShell::Cache::Story::STATUSES.each do |status|
           opts.on("--#{status}", "Show #{status} stories") do
             @options[:params][:state] ||= []
             @options[:params][:state] << status
           end
         end
         
-        available_types.each do |type|
-          opts.on("--#{type}", "Show #{type}") do
+        PivotalShell::Cache::Story::TYPES.each do |type|
+          opts.on("--#{type}s", "Show #{type}") do
             @options[:params][:type] ||= []
-            @options[:params][:type] << type[0..-2] # chomp s
+            @options[:params][:type] << type
           end
         end
 
@@ -35,7 +33,7 @@ module PivotalShell::Commands
         end
         
         opts.on('--unowned', 'Show tasks not assigned to anyone') do
-          @options[:unowned] = true
+          @options[:params][:unowned] = true
         end
         
         opts.on('--anyone', 'Show tasks assigned to anyone') do
@@ -58,10 +56,7 @@ module PivotalShell::Commands
     end
 
     def execute
-      stories = PivotalShell::Configuration.project.stories.all(@options[:params])
-      if @options[:unowned]
-        stories.reject!{|s| !s.owned_by.nil?}
-      end
+      stories = PivotalShell::Cache::Story.all(@options[:params])
 
       puts stories.empty? ? 'No stories!' : stories.map{|s| "#{("[#{s.id}]").rjust 12} #{PivotalShell::Configuration.icon(s.story_type, s.current_state, s.estimate)} #{s.name.strip}"}.join("\n")
     end

data/lib/pivotal_shell/commands/story.rb

@@ -22,11 +22,12 @@ module PivotalShell::Commands
     end
 
     def execute
-      @story = PivotalShell::Configuration.project.stories.find(@story_id)
+      @story = PivotalShell::Cache::Story.find(@story_id)
       if @story.nil?
         puts 'Story not found'
       else
         puts ["[#{@story.id}] - #{@story.name}",
+          
               "State: #{@story.current_state}",
               "Owner: #{@story.owned_by}",
               "Creator: #{@story.requested_by}",

data/lib/pivotal_shell/commands/update.rb

@@ -0,0 +1,19 @@
+module PivotalShell::Commands
+  class PivotalShell::Commands::Update < PivotalShell::Command
+    def initialize(options)
+      opts = OptionParser.new do |opts|
+        opts.banner = "Update the stories database from Pivotal Tracker"
+        
+        opts.on_tail('--help', 'Show this help') do
+          puts opts
+          exit
+        end
+        opts.parse!(options)
+      end
+    end
+
+    def execute
+      PivotalShell::Configuration.cache.refresh
+    end
+  end
+end

data/lib/pivotal_shell/configuration.rb

@@ -2,9 +2,13 @@ require 'yaml'
 require 'pivotal_tracker'
 
 module PivotalShell::Configuration
+  DEFAULTS = {
+    'refresh_interval' => 15
+  }
+
   def self.load
     @global_config = YAML.load_file(global_config_path)
-    @project_config = YAML.load_file(project_config_path)
+    @project_config = YAML.load_file(File.join(project_config_path,'.pivotalrc'))
     PivotalTracker::Client.token = @global_config['api_token']
   end
 
@@ -12,10 +16,18 @@ module PivotalShell::Configuration
     @project ||= PivotalTracker::Project.find(@project_config['project_id'])
   end
 
+  def self.cache
+    @cache ||= PivotalShell::Cache.new(File.join(project_config_path,'.pivotal_cache'))
+  end
+
   def self.me
     @me ||= @project_config['me']
   end
 
+  def self.refresh_interval
+    @refresh_interval ||= @project_config['refresh_interval'] || @global_config['refresh_interval'] || DEFAULTS['refresh_interval']
+  end
+
   def self.global_config_path
     @global_config_path ||= File.expand_path('~/.pivotalrc')
   end
@@ -45,7 +57,7 @@ module PivotalShell::Configuration
   end
 
   def self.icon(type, status, estimate)
-    type_icon(type) + ' ' + estimate_icon(estimate) + ' ' + status_icon(status)
+    type_icon(type).to_s + ' ' + estimate_icon(estimate).to_s + ' ' + status_icon(status).to_s
   end
 
 private
@@ -58,7 +70,7 @@ private
     if dirs.empty? || File.join(dirs, '.pivotalrc')==global_config_path
       raise PivotalShell::Exception.new('No project .pivotalrc found')
     else
-      File.join(dirs, '.pivotalrc')
+      File.join(dirs)
     end
   end
 end

data/lib/pivotal_shell/version.rb

@@ -1,3 +1,3 @@
 module PivotalShell
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/pivotal_shell.gemspec

@@ -11,7 +11,8 @@ Gem::Specification.new do |s|
   s.homepage    = "https://github.com/leonid-shevtsov/pivotal_shell"
   s.summary     = %q{A command-line client for Pivotal Tracker}
 
-  s.add_dependency 'pivotal-tracker', '=0.3'
+  s.add_dependency 'pivotal-tracker', '>0.3'
+  s.add_dependency 'sqlite3'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: pivotal_shell
 version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: false
+  hash: 23
+  prerelease: 
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Leonid Shevtsov
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-06 00:00:00 +02:00
+date: 2011-02-12 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -24,7 +24,7 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ">"
       - !ruby/object:Gem::Version 
         hash: 13
         segments: 
@@ -33,6 +33,20 @@ dependencies:
         version: "0.3"
   type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
 description: 
 email: 
 - leonid@shevtsov.me
@@ -49,12 +63,19 @@ files:
 - README.markdown
 - Rakefile
 - bin/pivotal
+- examples/commit-msg
 - lib/pivotal_shell.rb
+- lib/pivotal_shell/cache.rb
+- lib/pivotal_shell/cache/story.rb
+- lib/pivotal_shell/cache/user.rb
 - lib/pivotal_shell/command.rb
+- lib/pivotal_shell/commands/commit.rb
 - lib/pivotal_shell/commands/finish.rb
+- lib/pivotal_shell/commands/reload.rb
 - lib/pivotal_shell/commands/start.rb
 - lib/pivotal_shell/commands/stories.rb
 - lib/pivotal_shell/commands/story.rb
+- lib/pivotal_shell/commands/update.rb
 - lib/pivotal_shell/configuration.rb
 - lib/pivotal_shell/version.rb
 - pivotal_shell.gemspec
@@ -88,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.5.0
 signing_key: 
 specification_version: 3
 summary: A command-line client for Pivotal Tracker