mirror of
https://github.com/TracksApp/tracks.git
synced 2026-01-21 16:36:08 +01:00
add two example scripts to add a todo or a project template with todos from the command line. Thanks Vitalie and Popsch!
This commit is contained in:
Reinier Balt
parent
0b88c72570
commit
e7c0f6c3d2
3 changed files with 431 additions and 0 deletions
|
|
@ -28,12 +28,16 @@ New and changed features:
|
|||
3. You can star an action right from the form to add a new action
|
||||
4. redesign of preferences page
|
||||
5. You can now mark an action complete from the tickler
|
||||
6. project names can now contain comma (',') in it name
|
||||
7. There are two example ruby scripts in /doc to use the REST API to add a todo
|
||||
or a project template with todos from the command line
|
||||
|
||||
Under the hood:
|
||||
1. Upgraded rails to 2.3.12, jquery to 1.6.2 and jquery-ui to 1.8.14
|
||||
2. fixed several issues with the REST API
|
||||
3. upgraded the act_as_statemachine plugin. This change requires a
|
||||
migration, see note above!
|
||||
4. migated to bundler for gem dependencies
|
||||
|
||||
See https://github.com/tracksapp/tracks/compare/v2.0...master for all
|
||||
detailled changes
|
||||
|
|
|
|||
138
doc/tracks_cli_client.rb
Normal file
138
doc/tracks_cli_client.rb
Normal file
|
|
@ -0,0 +1,138 @@
|
|||
#!/usr/bin/env ruby
|
||||
|
||||
#
|
||||
# Author: Vitalie Lazu <vitalie.lazu@gmail.com>
|
||||
# Date: Sat, 10 Jan 2009 19:12:43 +0200
|
||||
#
|
||||
|
||||
# CLI ruby client for Tracks: rails application for GTD methodology
|
||||
# http://www.getontracks.org/development/
|
||||
# You need to set ENV['GTD_LOGIN'], ENV['GTD_PASSWORD']
|
||||
# and set GTD_TODOS_URL to your tracks install. It defaults to 'http://localhost:3000/todos.xml'
|
||||
|
||||
require 'net/https'
|
||||
require 'optparse'
|
||||
require 'cgi'
|
||||
require 'time'
|
||||
|
||||
class Hash
|
||||
def to_query_string
|
||||
map { |k, v|
|
||||
if v.instance_of?(Hash)
|
||||
v.map { |sk, sv|
|
||||
"#{k}[#{sk}]=#{sv}"
|
||||
}.join('&')
|
||||
else
|
||||
"#{k}=#{v}"
|
||||
end
|
||||
}.join('&')
|
||||
end
|
||||
end
|
||||
|
||||
module Gtd
|
||||
class API
|
||||
GTD_URI = ENV['GTD_TODOS_URL'] || 'http://localhost:3000/todos.xml'
|
||||
|
||||
def post(lines, options = {})
|
||||
uri = URI.parse(GTD_URI)
|
||||
http = Net::HTTP.new(uri.host, uri.port)
|
||||
|
||||
if uri.scheme == "https" # enable SSL/TLS
|
||||
http.use_ssl = true
|
||||
http.ca_path = "/etc/ssl/certs/" # Debian based path
|
||||
http.verify_mode = OpenSSL::SSL::VERIFY_PEER
|
||||
http.verify_depth = 5
|
||||
end
|
||||
|
||||
lines.each_line do |l|
|
||||
l.chomp!
|
||||
next if l.strip.empty?
|
||||
|
||||
description = CGI.escapeHTML(l)
|
||||
context_id = options[:context_id] ? options[:context_id].to_i : 1
|
||||
project_id = options[:project_id] ? options[:project_id].to_i : 1
|
||||
props = "<description>#{description}</description><project_id>#{project_id}</project_id><context_id>#{context_id}</context_id>"
|
||||
|
||||
if options[:show_from]
|
||||
props << "<show-from type=\"datetime\">#{Time.at(options[:show_from]).xmlschema}</show-from>"
|
||||
end
|
||||
|
||||
req = Net::HTTP::Post.new(uri.path, "Content-Type" => "text/xml")
|
||||
req.basic_auth ENV['GTD_LOGIN'], ENV['GTD_PASSWORD']
|
||||
req.body = "<todo>#{props}</todo>"
|
||||
|
||||
resp = http.request(req)
|
||||
|
||||
if resp.code == '302' || resp.code == '201'
|
||||
puts resp['location']
|
||||
else
|
||||
p resp.body
|
||||
raise Gtd::Error
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
class Error < StandardError; end
|
||||
class InvalidParser < StandardError; end
|
||||
|
||||
class ConsoleOptions
|
||||
attr_reader :parser, :options
|
||||
|
||||
def initialize
|
||||
@options = {}
|
||||
|
||||
@parser = OptionParser.new do |cmd|
|
||||
cmd.banner = "Ruby Gtd CLI - takes todos input from STDIN"
|
||||
|
||||
cmd.separator ''
|
||||
|
||||
cmd.on('-h', '--help', 'Displays this help message') do
|
||||
puts @parser
|
||||
exit
|
||||
end
|
||||
|
||||
cmd.on('-p [N]', Integer, "project id to set for new todo") do |v|
|
||||
@options[:project_id] = v
|
||||
end
|
||||
|
||||
cmd.on('-c [N]', Integer, 'context id to set') do |v|
|
||||
@options[:context_id] = v
|
||||
end
|
||||
|
||||
cmd.on('-w [N]', Integer, 'Postpone task for N weeks') do |v|
|
||||
@options[:show_from] = Time.now.to_i + 24 * 3600 * 7 * (v || 1)
|
||||
end
|
||||
|
||||
cmd.on('-m [N]', Integer, 'Postpone task for N months') do |v|
|
||||
@options[:show_from] = Time.now.to_i + 24 * 3600 * 7 * 4 * (v || 1)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
def run(args)
|
||||
@parser.parse!(args)
|
||||
lines = STDIN.read
|
||||
|
||||
if lines.strip.empty?
|
||||
puts "Please pipe in some content to tracks on STDIN."
|
||||
exit 1
|
||||
end
|
||||
|
||||
gtd = API.new
|
||||
gtd.post(lines, @options)
|
||||
exit 0
|
||||
rescue InvalidParser
|
||||
puts "Please specify a valid format parser."
|
||||
exit 1
|
||||
rescue Error
|
||||
puts "An unknown error occurred"
|
||||
exit 1
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
if $0 == __FILE__
|
||||
app = Gtd::ConsoleOptions.new
|
||||
app.run(ARGV)
|
||||
end
|
||||
289
doc/tracks_template_cli.rb
Normal file
289
doc/tracks_template_cli.rb
Normal file
|
|
@ -0,0 +1,289 @@
|
|||
#!/usr/bin/env ruby
|
||||
|
||||
# Version 0.1 (Sept 4, 2011)
|
||||
|
||||
#
|
||||
# Based on the tracks_cli by Vitalie Lazu (https://gist.github.com/45537)
|
||||
#
|
||||
|
||||
# CLI ruby template client for Tracks: rails application for GTD methodology
|
||||
# https://github.com/TracksApp/tracks
|
||||
|
||||
# Usage:
|
||||
# * You need to set ENV['GTD_LOGIN'], ENV['GTD_PASSWORD']
|
||||
# * You need to pipe a file with new projets and actions to the script
|
||||
# * You can use the -k option to customize templates. See the example below.
|
||||
#
|
||||
# Default URLs are:
|
||||
# ENV['GTD_TODOS_URL'] --> 'http://localhost:3000/todos.xml'
|
||||
# ENV['GTD_PROJECTS_URL'] --> 'http://localhost:3000/projects.xml'
|
||||
# ENV['GTD_CONTEXT_URL_PREFIX'] --> 'http://localhost:3000/contexts/'
|
||||
# ENV['GTD_CONTEXT_URL'] --> 'http://localhost:3000/contexts.xml'
|
||||
|
||||
# Format of input file:
|
||||
# - New Projects start at the beginning of the line
|
||||
# - New actions start with a '.' at the beginning of the line. To add a note to an action, separate the action from its note by using '|'. You have to stay in the same line.
|
||||
# - Comments start with '#'
|
||||
|
||||
# Example of an input file. Remove the '# ' string at the beginning and save it in a file.
|
||||
# Book trip to [location]
|
||||
# .Check visa requirements for [location]|instantiate template_visa, if visa required
|
||||
# .Book flight to [location]|starting trip around [start], returning around [end]
|
||||
# .Print flight details to [location]
|
||||
# .Book hotel in [location]|checking around [start], leaving around [end]
|
||||
# .Book rental car in [location]|starting [start], returning [end]
|
||||
# .Print hotel booking details to [location]
|
||||
# .Set email vacation reminder|starting [start], returning [end]; Text: I'm off for a vacation. I'll respond to emails after returning ([end]).
|
||||
# .Mail others that I'll be away|starting [start], returning [end]
|
||||
# Pack stuff for trip to [location]
|
||||
# .Pack projector laptop adapter
|
||||
# .Pack socket adapter for country ([location])
|
||||
# .Pack passport
|
||||
# .Pack flight and hotel detail printout
|
||||
# Get trip reimbursement for [location]
|
||||
# .Collect all [location] receipts in a clear plastic folder
|
||||
# .Set a reminder to check for reimbursement for [location]
|
||||
# .Mail folder to secretary
|
||||
|
||||
# Instantiate this template: cat template | ./tracks_template_cli -c 1 -k '[location]=Dublin' -k '[start]=Oct 10' -k '[end]=Oct 16'
|
||||
|
||||
require 'net/https'
|
||||
require 'optparse'
|
||||
require 'cgi'
|
||||
require 'time'
|
||||
|
||||
class Hash
|
||||
def to_query_string
|
||||
map { |k, v|
|
||||
if v.instance_of?(Hash)
|
||||
v.map { |sk, sv|
|
||||
"#{k}[#{sk}]=#{sv}"
|
||||
}.join('&')
|
||||
else
|
||||
"#{k}=#{v}"
|
||||
end
|
||||
}.join('&')
|
||||
end
|
||||
end
|
||||
|
||||
module Gtd
|
||||
class API
|
||||
GTD_URI_TODOS = ENV['GTD_TODOS_URL'] || 'http://localhost:3000/todos.xml'
|
||||
GTD_URI_PROJECTS = ENV['GTD_PROJECTS_URL'] || 'http://localhost:3000/projects.xml'
|
||||
GTD_URI_CONTEXTS_PREFIX = ENV['GTD_CONTEXT_URL_PREFIX'] || 'http://localhost:3000/contexts/'
|
||||
GTD_URI_CONTEXTS = ENV['GTD_CONTEXT_URL'] || 'http://localhost:3000/contexts.xml'
|
||||
|
||||
def post(l, options = {})
|
||||
uri = URI.parse(GTD_URI_TODOS)
|
||||
http = Net::HTTP.new(uri.host, uri.port)
|
||||
|
||||
if uri.scheme == "https" # enable SSL/TLS
|
||||
http.use_ssl = true
|
||||
http.ca_path = "/etc/ssl/certs/" # Debian based path
|
||||
http.verify_mode = OpenSSL::SSL::VERIFY_PEER
|
||||
http.verify_depth = 5
|
||||
end
|
||||
|
||||
l.chomp!
|
||||
|
||||
description = CGI.escapeHTML(l)
|
||||
context_id = options[:context_id] ? options[:context_id].to_i : 1
|
||||
project_id = options[:project_id] ? options[:project_id].to_i : 1
|
||||
starred = options[:starred] ? 1 : 0
|
||||
props = "<description>#{description}</description><project_id>#{project_id}</project_id><context_id>#{context_id}</context_id>"
|
||||
|
||||
if options[:show_from]
|
||||
props << "<show-from type=\"datetime\">#{Time.at(options[:show_from]).xmlschema}</show-from>"
|
||||
end
|
||||
|
||||
if options[:note]
|
||||
props << "<notes>#{options[:note]}</notes>"
|
||||
end
|
||||
|
||||
req = Net::HTTP::Post.new(uri.path, "Content-Type" => "text/xml")
|
||||
req.basic_auth ENV['GTD_LOGIN'], ENV['GTD_PASSWORD']
|
||||
req.body = "<todo>#{props}</todo>"
|
||||
|
||||
resp = http.request(req)
|
||||
|
||||
if resp.code == '302' || resp.code == '201'
|
||||
puts resp['location']
|
||||
else
|
||||
p resp.body
|
||||
raise Gtd::Error
|
||||
end
|
||||
end
|
||||
|
||||
def postProject(l, options = {})
|
||||
uri = URI.parse(GTD_URI_PROJECTS)
|
||||
http = Net::HTTP.new(uri.host, uri.port)
|
||||
|
||||
if uri.scheme == "https" # enable SSL/TLS
|
||||
http.use_ssl = true
|
||||
http.ca_path = "/etc/ssl/certs/" # Debian based path
|
||||
http.verify_mode = OpenSSL::SSL::VERIFY_PEER
|
||||
http.verify_depth = 5
|
||||
end
|
||||
|
||||
l.chomp!
|
||||
|
||||
description = CGI.escapeHTML(l)
|
||||
props = "<name>#{l}</name><default-context-id>#{options[:context_id]}</default-context-id>"
|
||||
|
||||
req = Net::HTTP::Post.new(uri.path, "Content-Type" => "text/xml")
|
||||
req.basic_auth ENV['GTD_LOGIN'], ENV['GTD_PASSWORD']
|
||||
req.body = "<project>#{props}</project>"
|
||||
|
||||
resp = http.request(req)
|
||||
|
||||
if resp.code == '302' || resp.code == '201'
|
||||
puts resp['location']
|
||||
|
||||
# return the project id
|
||||
return resp['location'].split("/").last
|
||||
else
|
||||
p resp.body
|
||||
raise Gtd::Error
|
||||
end
|
||||
end
|
||||
|
||||
def queryContext(contextID)
|
||||
return false unless contextID.is_a? Integer
|
||||
|
||||
uri = URI.parse(GTD_URI_CONTEXTS_PREFIX + contextID.to_s + ".xml")
|
||||
http = Net::HTTP.new(uri.host, uri.port)
|
||||
|
||||
if uri.scheme == "https" # enable SSL/TLS
|
||||
http.use_ssl = true
|
||||
http.ca_path = "/etc/ssl/certs/" # Debian based path
|
||||
http.verify_mode = OpenSSL::SSL::VERIFY_PEER
|
||||
http.verify_depth = 5
|
||||
end
|
||||
|
||||
req = Net::HTTP::Get.new(uri.path)
|
||||
req.basic_auth ENV['GTD_LOGIN'], ENV['GTD_PASSWORD']
|
||||
resp = http.request(req)
|
||||
|
||||
case resp
|
||||
when Net::HTTPSuccess
|
||||
return true
|
||||
else
|
||||
return false
|
||||
end
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
|
||||
class Error < StandardError; end
|
||||
class InvalidParser < StandardError; end
|
||||
|
||||
class ConsoleOptions
|
||||
attr_reader :parser, :options, :keywords
|
||||
|
||||
def initialize
|
||||
@options = {}
|
||||
@keywords = {}
|
||||
|
||||
@parser = OptionParser.new do |cmd|
|
||||
cmd.banner = "Ruby Gtd CLI - takes todos input from STDIN"
|
||||
|
||||
cmd.separator ''
|
||||
|
||||
cmd.on('-h', '--help', 'Displays this help message') do
|
||||
puts @parser
|
||||
exit
|
||||
end
|
||||
|
||||
cmd.on('-p [N]', Integer, "project id to set for new todo") do |v|
|
||||
@options[:project_id] = v
|
||||
end
|
||||
|
||||
cmd.on('-k [S]', "keyword to be replaced") do |v|
|
||||
@keywords[v.split("=")[0]] = v.split("=")[1]
|
||||
end
|
||||
|
||||
cmd.on('-c [N]', Integer, 'default context id to set for new projects') do |v|
|
||||
@options[:context_id] = v
|
||||
end
|
||||
|
||||
cmd.on('-w [N]', Integer, 'Postpone task for N weeks') do |v|
|
||||
@options[:show_from] = Time.now.to_i + 24 * 3600 * 7 * (v || 1)
|
||||
end
|
||||
|
||||
cmd.on('-m [N]', Integer, 'Postpone task for N months') do |v|
|
||||
@options[:show_from] = Time.now.to_i + 24 * 3600 * 7 * 4 * (v || 1)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
def run(args)
|
||||
@parser.parse!(args)
|
||||
lines = STDIN.read
|
||||
gtd = API.new
|
||||
|
||||
if lines.strip.empty?
|
||||
puts "Please pipe in some content to tracks on STDIN."
|
||||
exit 1
|
||||
end
|
||||
|
||||
## check for existence of the context
|
||||
if !@options[:context_id]
|
||||
puts "Error: need to specify a context_id with -c option. Go here to find one: #{API::GTD_URI_CONTEXTS}"
|
||||
exit 1
|
||||
end
|
||||
|
||||
if !gtd.queryContext(@options[:context_id])
|
||||
puts "Error: context_id #{options[:context_id]} doesn't exist"
|
||||
exit 1
|
||||
end
|
||||
|
||||
lines.each_line do |line|
|
||||
next if (line.strip.empty? || line[0].chr == "#")
|
||||
|
||||
# replace tokens
|
||||
@keywords.each do |key,val|
|
||||
line=line.sub(key,val)
|
||||
end
|
||||
|
||||
# decide whether project or task
|
||||
|
||||
if (line[0].chr == "." ) || (line[0].chr == "*")
|
||||
@options[:starred]= line[0].chr == "*" ? true : false;
|
||||
line = line[1..line.length]
|
||||
|
||||
# find notes
|
||||
tmp= line.split("|")
|
||||
if tmp.length > 2
|
||||
puts "Formatting error: found multiple |"
|
||||
exit 1
|
||||
end
|
||||
|
||||
line=tmp[0]
|
||||
@options[:note]=tmp[1]
|
||||
|
||||
if !@options[:project_id]
|
||||
puts "Warning: no project specified for task \"#{line}\". Using default project."
|
||||
end
|
||||
|
||||
gtd.post(line, @options)
|
||||
else
|
||||
@options[:project_id]=gtd.postProject(line, @options)
|
||||
end
|
||||
end
|
||||
|
||||
exit 0
|
||||
rescue InvalidParser
|
||||
puts "Please specify a valid format parser."
|
||||
exit 1
|
||||
rescue Error
|
||||
puts "An unknown error occurred"
|
||||
exit 1
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
if $0 == __FILE__
|
||||
app = Gtd::ConsoleOptions.new
|
||||
app.run(ARGV)
|
||||
end
|
||||
Loading…
Add table
Add a link
Reference in a new issue