slimtimercli 0.1.4 → 0.1.6

data/History.txt

@@ -1,3 +1,11 @@
+== 0.1.5 2008-04-07
+* Under-the-hood changes, now it's easier to maintain and is probably a tad faster
+
+== 0.1.4 2008-04-07
+* Ruby 1.9 compatibility
+* use the XDG specification for configuration file storage location, but keep
+  compatibility with the older model.
+
 == 0.1.3 2008-04-07
 * fixed bug that allows starting a nonexisting task
 * refactored options to start slimtimer

data/bin/slimtimer

@@ -1,10 +1,10 @@
 #!/usr/bin/env ruby
 require 'rubygems'
 
-gem 'slimtimercli'
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
 require 'slimtimercli'
 
 include Slimtimercli
 
 c = CommandLine.new(ARGV)
-c.run
+c.run

data/config/hoe.rb

@@ -10,7 +10,7 @@ DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
 
 @config_file = "~/.rubyforge/user-config.yml"
 @config = nil
-RUBYFORGE_USERNAME = "unknown"
+RUBYFORGE_USERNAME = "grundprinzip"
 def rubyforge_username
   unless @config
     begin
@@ -67,4 +67,4 @@ 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'
+$hoe.rsync_args = '-av --delete --ignore-errors'

data/lib/slimtimercli/slim_timer.rb

@@ -2,15 +2,13 @@ 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
+    @host = "slimtimer.com"
+    @port = 80
   end
 
   # Performs the login to the system, and stores
@@ -122,7 +120,7 @@ class SlimTimer
     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|     
+    res, body = Net::HTTP.start(@host,@port) {|http|     
           p params if $DEBUG
           method.body = params.to_yaml
           http.request(method)

data/lib/slimtimercli/version.rb

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

data/lib/slimtimercli.rb

@@ -1,204 +1,41 @@
-$:.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 'yaml'
 require 'optparse'
 require 'ostruct'
 
 require "slimtimercli/entities"
 require "slimtimercli/slim_timer"
 require "slimtimercli/version"
+require "slimtimercli/helper"
 
 module Slimtimercli
-  module Helper
-    def login
-      config = load_config
-      st = SlimTimer.new(config["email"], config["password"],
-        config["api_key"])
-      st.login
-
-      st  
-    end
-
-    def root
-      File.join(ENV["HOME"], ".slimtimer")
-    end
-
-    def config_file
-      File.join(root, "config.yml")
-    end
-
-    def tasks_file
-      File.join(root, "tasks.yml")
-    end
-
-    def current_file
-      File.join(root, "current.yml")
-    end
-
-    def check_and_create_dir
-      raise "Home DIR not set!" unless ENV["HOME"]
-
-      unless File.directory?(root)
-        FileUtils.mkdir(root)
-      end
-    end
-
-    def 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 save_config(config)
-      dump_to_file(config, "config.yml")
-    end
-
-    def load_file(file)
-      File.open( File.join(root, file) ) { |yf| YAML::load( yf ) }
-    end
-
-    def dump_to_file(object, file)
-      check_and_create_dir
-      File.open( File.join(root, file), 'w' ) do |out|
-        YAML.dump(object, out )
-      end
-    end
-
-    def rm_current
-      FileUtils.rm(current_file) if
-        File.exists?(current_file)
-    end
-
-    def parse(args)  
-      
-      if !args || args.empty?
-        raise "Need to specify arguments, run slimtimer -h for help"
-        
-      end
-      
-      options = OpenStruct.new
-      options.force = false
-      
-      opts = OptionParser.new do |opts|
-        
-        opts.banner = "Usage: slimtimer [options]"
-        
-        opts.on("-s TASK", "--start TASK", 
-          "Start a TASK given by the task name") do |t|
-            
-          options.run = "start"
-          options.task_name = t
-        end 
-        
-        opts.on("-c TASK", "--create TASK", 
-          "Create a ne task by the given name") do |t|
-          options.run = "create"
-          options.task_name = t
-        end
-        
-        opts.on("-e", "--end" ,"Stops time recording for the given task") do
-          options.run = "stop"
-        end       
-        
-        opts.on("-t", "--tasks", "Prints all available tasks") do
-          options.run = "tasks"
-        end
-        
-        opts.on("-f", "--force", "Force deletion of tasks") do
-          options.force = true
-        end     
-        
-        opts.on("--setup", "Setup your account") do
-          options.run = "setup"
-        end
-        
-        opts.on_tail("-h", "Shows this note") do
-          puts opts
-          exit
-        end
-        
-        opts.on("--help", "Show verbose help") do
-          @out.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 -c my_shiny_task
-
-To spend some time on the task you have to make the timer run
-
-  slimtimer -s my_shiny_task
-
-When you finished working on a task, you can call 
-
-  slimtimer -e
-
-This will write the time spend back to SlimTimer.com.
-Finally you can run 
-
-  slimtimer -t
-
-To show all your tasks available.
-HELP
-          exit
-        end
-      end   
-      
-      begin
-        opts.parse!(args)
-      rescue
-        puts $!.message
-        exit
-      end
-      options
-    end
-  end
 
   class CommandLine
-                  
+
     # Include Helper module
     include Helper
-    
+
     def initialize(args, output = $stdout)
       @args = args
-      @out = output       
-      
+      @out = output
+
       deprecated_calls
-      
+
       @options = parse(args)
     end
-                                          
-    def create      
+
+    def create
       st = login
-      if st.create_task(@options.task_name)                    
-        dump_to_file(st.tasks, "tasks.yml")
+      if st.create_task(@options.task_name)
+        dump_to_file(st.tasks, tasks_file)
         @out.puts "Task #{name} successfully created."
       end
     end
-    
+
     def tasks(show = true)
       tasks = load_tasks
       return tasks unless show
@@ -207,35 +44,38 @@ HELP
         @out.puts t.name
       end
     end
-    
+
     def setup
       config = load_config
 
       @out.puts "Slimtimer Login Credentials\n"
       @out.print "E-Mail: "
-      config["email"] = STDIN.gets.gsub("\n", "")
+      config["email"] = $stdin.gets.strip
 
-      @out.print "Password: "
-      config["password"] = STDIN.gets.gsub("\n", "")
+      begin
+        @out.print "Password: "
+        system("stty -echo")
+        config["password"] = $stdin.gets.strip
+      ensure
+        system("stty echo")
+      end
 
-      @out.print "API Key: "
-      config["api_key"] = STDIN.gets.gsub("\n", "")
+      # Include the newline here so that both prompts are on the same line
+      @out.print "\nAPI Key: "
+      config["api_key"] = $stdin.gets.strip
 
       save_config(config)
-
-      # clear the screen
-      system("clear")
     end
-    
-    def start                      
+
+    def start
       if File.exists?(current_file)
         @out.puts "Need to stop the other task first"
-        return false                     
+        return false
       end
-      
+
       info = {"task" =>  @options.task_name,
         "start_time" => Time.now}
-      
+
       #Find task in tasks yml
       t = load_tasks.find {|t| t.name == info["task"]}
       unless t
@@ -243,22 +83,20 @@ HELP
         return false
       end
 
-      dump_to_file(info, "current.yml")
+      dump_to_file(info, current_file)
       return true
     end
-    
-    def stop   
 
+    def stop
       if @options.force
-        rm_current 
+        rm_current
         @out.puts "Forced ending of task, no entry to slimtimer.com written"
         return true
       end
-      
-      
+
       begin
-        info = load_file("current.yml")
-      rescue                                 
+        info = load_file(current_file)
+      rescue
         puts "You must start a task before you finish it"
         return false
       end
@@ -269,7 +107,6 @@ HELP
         @out.puts "Task not found in list. Reload List?"
         return false
       end
-      raise  unless t
 
       st = login
       result = st.create_time_entry(t, info["start_time"],
@@ -278,36 +115,39 @@ HELP
       # Delete yml file
       if result
         rm_current
-        
+
         # Output
         @out.puts "Wrote new Entry for #{t.name}, duration #{result["duration_in_seconds"] / 60}m"
         return true
-      else          
+      else
         @out.puts "Coult not write new entry, please try again"
         return false
-      end                            
+      end
     end
-    
+
     def run
       send(@options.run.to_sym)
     end
-    
+
     alias_method :end, :stop
-    
+
     private
-    
+
     # This method checks if the first parameter in args needs to
     # be transformed to the new one
     def deprecated_calls
       case @args[0]
-      when "start": @args[0] = "-s"
-      when "end": @args[0] = "-e"
-      when "create_task": @args[0] = "-c"
-      when "tasks": @args[0] = "-t"
-      when "setup": @args[0] = "--setup"  
+      when "start" then @args[0] = "-s"
+      when "end" then @args[0] = "-e"
+      when "create_task" then @args[0] = "-c"
+      when "tasks" then @args[0] = "-t"
+      when "setup" then @args[0] = "--setup"
+      else
+        puts "Unknown command, listing tasks..."
+        @args[0] = "-t"
       end
     end
-    
+
     def load_tasks(force = false)
       config = load_config
       st = SlimTimer.new(config["email"], config["password"],
@@ -318,11 +158,11 @@ HELP
          File.mtime(tasks_file) < (Time.now - 60 * 60 *24) || force
         st.login
         tasks = st.tasks
-        dump_to_file(tasks, "tasks.yml")
+        dump_to_file(tasks, tasks_file)
       else
-        tasks = load_file("tasks.yml")
+        tasks = load_file(tasks_file)
       end
       tasks
     end
   end
-end         
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: slimtimercli
 version: !ruby/object:Gem::Version 
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors: 
 - Martin Grund
@@ -9,10 +9,39 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-04-07 00:00:00 +02:00
+date: 2010-02-05 00:00:00 +01:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rubyforge
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: gemcutter
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.5.0
+    version: 
 description: Command line interface to SlimTimer
 email: 
 - grundprinzip@gmail.com
@@ -49,6 +78,8 @@ files:
 - tasks/website.rake
 has_rdoc: true
 homepage: http://blog.grundprinzip.de
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --main
@@ -70,9 +101,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: rug-b
-rubygems_version: 1.1.0
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Command line interface to SlimTimer
 test_files: []