slimtimercli 0.1.1

data/History.txt

@@ -0,0 +1,4 @@
+== 0.1.1 2008-04-03
+
+* Initial Release of the gem
+* started adding tests

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 FIXME full name
+
+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/Manifest.txt

@@ -0,0 +1,21 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/slimtimer
+config/hoe.rb
+config/requirements.rb
+lib/slimtimercli.rb
+lib/slimtimercli/entities.rb
+lib/slimtimercli/slim_timer.rb
+lib/slimtimercli/version.rb
+log/debug.log
+setup.rb
+spec/slimtimercli_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/rspec.rake
+tasks/website.rake

data/README.txt

@@ -0,0 +1,37 @@
+= slimtimercli
+
+== DESCRIPTION:
+
+SlimTimer is a tool to record your time spend on a
+task. SlimTimer CLI allows you to controll your 
+SlimTimer directly from where you spend most of your
+time - on the command line. To use SlimTimer proceed
+with the following steps:
+
+The first time you need to setup SlimTimer CLI with
+
+  slimtimer setup
+
+Now it will ask for your email and password and API key
+to use with your account. These information will be stored
+in ~/.slimtimer/config.yml
+
+To create a task run
+
+  slimtimer create_task my_shiny_task
+
+To spend some time on the task you have to make the timer run
+
+  slimtimer start my_shiny_task
+
+When you finished working on a task, you can call 
+
+  slimtimer end
+
+This will write the time spend back to SlimTimer.com.
+Finally you can run 
+
+  slimtimer tasks
+
+To show all your tasks available.
+

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/bin/slimtimer

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+
+gem 'slimtimercli'
+require 'slimtimercli'
+
+# Run
+if ARGV.size == 0
+  Slimtimercli.__send__(:help)  
+else
+  Slimtimercli.__send__(ARGV[0].to_sym)  
+end

data/config/hoe.rb

@@ -0,0 +1,70 @@
+require 'slimtimercli/version'
+
+AUTHOR = 'Martin Grund'  # can also be an array of Authors
+EMAIL = "grundprinzip@gmail.com"
+DESCRIPTION = "Command line interface to SlimTimer"
+GEM_NAME = 'slimtimercli' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'rug-b' # The unix name for your project
+HOMEPATH = "http://blog.grundprinzip.de"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = Slimtimercli::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'slimtimercli documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  
+end
+
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+$hoe.rsync_args = '-av --delete --ignore-errors'

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/lib/slimtimercli/entities.rb

@@ -0,0 +1,71 @@
+class TimeEntry
+  attr_accessor :id, :start_time, :end_time,
+    :duration_in_seconds, :tags, :in_progress, :updated_at,
+    :created_at, :task
+
+  def self._load(hsh)
+    te = TimeEntry.new
+    hsh.each {|k,v|
+        te.__send__("#{k}=".to_sym, v) if te.respond_to?("#{k}=".to_sym)
+      }
+  end 
+  
+  def _serialize
+    {"time_entry" =>  {
+      "start_time" => @start_time,
+      "duration_in_seconds" => @duration_in_seconds,
+      "task_id" => @task.id}}
+  end
+
+end
+
+class Task
+  attr_accessor :name, :tags, :role, :owners, :hours,
+    :id
+
+  def self._load(hsh)
+    Task.new.__send__(:_load, hsh)
+  end
+
+  def _serialize
+    {"task" => instance_variables.map{ |i|
+        {i.to_s.gsub("@", "") => instance_variable_get(i)}
+       }.inject({}){|m,v| m.merge v}}
+  end
+
+  private
+
+  def _load(hsh)
+    hsh.each do |k,v|
+      self.instance_variable_set("@#{k}", v) if self.respond_to?(k.to_sym) &&
+        !v.kind_of?(Array)
+    end
+
+    @owners = hsh["owners"].map{|o| User._load(o)}
+    @coworkers = hsh["coworkers"].map{|o| User._load(o)}
+
+    self
+  end
+
+end
+
+class User
+  attr_accessor :email, :password, :user_id, :name
+
+  def initialize(e=nil, p=nil)
+    @email = e
+    @password = p
+  end
+
+  def self._load(hsh)
+    u = User.new
+    hsh.each do |k,v|
+      u.send("#{k}=".to_sym, v) if u.respond_to?("#{k}=".to_sym)
+    end
+    u
+  end
+
+  def _serialize
+    {"user" => {"email" => email, "password" => password}}
+  end
+end

data/lib/slimtimercli/slim_timer.rb

@@ -0,0 +1,139 @@
+class SlimTimer
+
+  DATE_FORMAT = "%Y-%m-%d %H-%M-%S"
+
+  @@host = "slimtimer.com"
+  @@port = 80
+  #@@api_key = ""
+
+  attr_accessor :tasks, :time_entries
+
+  def initialize(user, pass, api)
+    @user = user; @pass = pass
+    @api_key = api
+  end
+
+  # Performs the login to the system, and stores
+  # the user id and the access token in the local
+  # class for reusse
+  def login
+    data = post_request("/users/token", User.new(@user, @pass)._serialize)
+    @token = data["access_token"]
+    @user_id = data["user_id"]
+  end
+
+  # Lists all tasks for the user logged in the system
+  # ==== Parameters
+  # show_completed<String>:: yes | no | only Include completed tasks (yes/no)
+  #                          or show only completed tasks Default: yes
+  # role<String>:: owner,coworker,reporter Include tasks where the user's role
+  #                is one of the roles given (comma delimited) Default:
+  #                 owner,coworker
+  def tasks(show_completed = "yes", role="owner,coworker")
+    list = get_request("/users/#{@user_id}/tasks",
+      {"show_completed" => show_completed,
+        "role" => role})
+
+    list.map{ |t|
+        Task._load(t)
+      }
+
+  end
+
+  # Create a new task for this user
+  # ==== Parameters
+  # name<String>:: name for the new task
+  # tags<String>:: comma separated list of tags for the task
+  def create_task(name, tags= "", coworker_emails = "", reporter_emails = "")
+
+    t = Task.new
+    t.name = name
+    t.tags = tags
+
+    t._serialize
+
+
+    Task._load(post_request("/users/#{@user_id}/tasks", t._serialize))
+  end
+
+  def find_task_by_name(name)
+    tasks("no").find {|t| t.name == name}
+  end
+
+  def delete_task(name)
+    t = find_task_by_name(name)
+    delete_request("/users/#{@user_id}/tasks/#{t.id}")
+  end
+
+  # List all time entries for the user logged in
+  # ==== Parameters
+  # range_start<Time>:: start of the range
+  # range_end<Time>:: end of the range
+  def time_entries(range_start = nil, range_end = nil)
+    options = {}
+
+    options = {"range_start" =>
+      range_start.strftime(DATE_FORMAT)} if range_start
+    options = {"range_end" =>
+      range_end.strftime(DATE_FORMAT)} if range_end
+
+    # do the actual request
+    get_request("/users/#{@user_id}/time_entries", options)
+  end
+
+  def create_time_entry(task, start_time = Time.now, duration = 0)
+    te = TimeEntry.new
+    te.task = task; te.start_time = start_time
+    te.duration_in_seconds = duration
+    
+    post_request("/users/#{@user_id}/time_entries", te._serialize)
+  end
+
+  protected
+
+  def handle_error(object)
+    if object.kind_of?(ActiveRecord::Errors)
+      raise "ActiveRecord::Errors " + object.map{|k,v| k + " " + v}.join("\n")
+    else
+      object
+    end
+  end
+
+  def get_request(path, params = {})
+    post_request(path, {"_method" => "get"}.merge(params))
+  end
+
+  def put_request(path, params = {})
+    post_request(path, {"_method" => "put"}.merge(params))
+  end
+
+  def delete_request(path, params = {})
+    post_request(path, {"_method" => "delete"}.merge(params))
+  end
+
+  def post_request(path, params = {})
+    request(Net::HTTP::Post.new(path, default_header), params)
+  end
+
+  def request(method, params = {})
+    
+    puts "Start Request" if $DEBUG
+    # merge api key
+    params = {"api_key" => @api_key}.merge(params)
+    # If token there merge it
+    params = {"access_token" => @token}.merge(params) if @token
+    res, body = Net::HTTP.start(@@host,@@port) {|http|     
+          p params if $DEBUG
+          method.body = params.to_yaml
+          http.request(method)
+        }              
+    puts "Finished Request" if $DEBUG
+    handle_error(YAML.load(body))
+  end
+
+  def default_header
+    {"Accept" => "application/x-yaml",
+      "Content-Type" => "application/x-yaml"}
+  end
+
+end

data/lib/slimtimercli/version.rb

@@ -0,0 +1,9 @@
+module Slimtimercli #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 1
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/slimtimercli.rb

@@ -0,0 +1,215 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'fileutils'
+require 'net/http'
+require 'rubygems'
+require 'active_record'
+require 'active_support'
+require 'yaml'    
+
+require "slimtimercli/entities"
+require "slimtimercli/slim_timer"
+require "slimtimercli/version"
+
+module Slimtimercli
+  module Helper
+    def self.login
+      config = Helper::load_config
+      st = SlimTimer.new(config["email"], config["password"],
+        config["api_key"])
+      st.login
+
+      st  
+    end
+
+    def self.root
+      File.join(ENV["HOME"], ".slimtimer")
+    end
+
+    def self.config_file
+      File.join(root, "config.yml")
+    end
+
+    def self.tasks_file
+      File.join(root, "tasks.yml")
+    end
+
+    def self.current_file
+      File.join(root, "current.yml")
+    end
+
+    def self.check_and_create_dir
+      raise "Home DIR not set!" unless ENV["HOME"]
+
+      unless File.directory?(root)
+        FileUtils.mkdir(root)
+      end
+    end
+
+    def self.load_config
+      check_and_create_dir
+
+      unless File.exists?(File.join(root, "config.yml"))
+        File.open( File.join(root, "config.yml"), 'w' ) do |out|
+          YAML.dump({}, out )
+        end
+      end
+      load_file("config.yml")
+    end
+
+    def self.save_config(config)
+      dump_to_file(config, "config.yml")
+    end
+
+    def self.load_file(file)
+      File.open( File.join(root, file) ) { |yf| YAML::load( yf ) }
+    end
+
+    def self.dump_to_file(object, file)
+      check_and_create_dir
+      File.open( File.join(root, file), 'w' ) do |out|
+        YAML.dump(object, out )
+      end
+    end
+  end
+    
+  def self.create_task
+    name = ARGV[1]
+
+    st = Helper::login
+    if st.create_task(name)                    
+      Helper::dump_to_file(st.tasks, "tasks.yml")
+      puts "Task #{name} successfully created."
+    end            
+  end
+
+  def self.tasks(show= true)
+    config = Helper::load_config
+    st = SlimTimer.new(config["email"], config["password"],
+      config["api_key"])
+
+    if !File.exists?(Helper::tasks_file) ||
+       File.mtime(Helper::tasks_file) < (Time.now - 60 * 60 *24)
+
+      st.login
+      Helper::dump_to_file(st.tasks, "tasks.yml")
+    end
+
+    tasks = Helper::load_file("tasks.yml")
+
+    return tasks unless show
+
+    tasks.each do |t|
+      puts t.name
+    end
+  end
+
+  def self.force_reload
+    config = Helper::load_config
+    st = SlimTimer.new(config["email"], config["password"],
+      config["api_key"])
+
+    st.login
+    Helper::dump_to_file(st.tasks, "tasks.yml")
+    tasks = Helper::load_file("tasks.yml")
+
+    tasks.each do |t|
+      puts t.name
+    end
+  end
+
+  # This method stores the credentials in the necessary directoyr
+  def self.setup
+    config = Helper::load_config
+
+    puts "Slimtimer Login Credentials\n"
+    print "E-Mail: "
+    config["email"] = STDIN.gets.gsub("\n", "")
+
+    print "Password: "
+    config["password"] = STDIN.gets.gsub("\n", "")
+
+    print "API Key: "
+    config["api_key"] = STDIN.gets.gsub("\n", "")
+
+    Helper::save_config(config)
+
+    # clear the screen
+    system("clear")
+  end
+
+  def self.help
+    puts <<-HELP
+SlimTimer is a tool to record your time spend on a
+task. SlimTimer CLI allows you to controll your 
+SlimTimer directly from where you spend most of your
+time - on the command line. To use SlimTimer proceed
+with the following steps:
+
+The first time you need to setup SlimTimer CLI with
+
+  slimtimer setup
+
+Now it will ask for your email and password and API key
+to use with your account. These information will be stored
+in ~/.slimtimer/config.yml
+
+To create a task run
+
+  slimtimer create_task my_shiny_task
+
+To spend some time on the task you have to make the timer run
+
+  slimtimer start my_shiny_task
+
+When you finished working on a task, you can call 
+
+  slimtimer end
+
+This will write the time spend back to SlimTimer.com.
+Finally you can run 
+
+  slimtimer tasks
+
+To show all your tasks available.
+HELP
+  end
+
+  def self.start
+    info = {"task" =>  ARGV[1],
+      "start_time" => Time.now}
+
+    # dum curent task to file
+    Helper::dump_to_file(info, "current.yml")
+  end
+
+  def self.end 
+    begin
+    info = Helper::load_file("current.yml")
+    rescue                                 
+      puts "You must start a task before you finish it"
+      return
+    end
+
+
+    #Find task in tasks yml
+    t = tasks(false).find {|t| t.name == info["task"]}
+
+    raise "Task not found in list. Reload List?" unless t
+
+    st = Helper::login
+    result = st.create_time_entry(t, info["start_time"],
+      (Time.now - info["start_time"]).to_i)
+
+    # Delete yml file
+    if result
+      FileUtils.rm(Helper::current_file)
+    end                            
+
+    # Output
+    puts "Wrote new Entry for #{t.name}, duration #{result["duration_in_seconds"] / 60}m"
+
+  end
+     
+end